1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*
* Copyright (c) 2020 - 2024 Renesas Electronics Corporation and/or its affiliates
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef R_USB_API_H
#define R_USB_API_H
/***********************************************************************************************************************
* Includes
**********************************************************************************************************************/
/* Includes board and MCU related header files. */
#include "bsp_api.h"
/* Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
FSP_HEADER
/**********************************************************************************************************************
* Macro definitions
**********************************************************************************************************************/
/* Descriptor type Define */
#define USB_DT_DEVICE (0x01U) /* Device Descriptor */
#define USB_DT_CONFIGURATION (0x02U) /* Configuration Descriptor */
#define USB_DT_STRING (0x03U) /* String Descriptor */
#define USB_DT_INTERFACE (0x04U) /* Interface Descriptor */
#define USB_DT_ENDPOINT (0x05U) /* Endpoint Descriptor */
#define USB_DT_DEVICE_QUALIFIER (0x06U) /* Device Qualifier Descriptor */
#define USB_DT_OTHER_SPEED_CONF (0x07U) /* Other Speed Configuration Descriptor */
#define USB_DT_INTERFACE_POWER (0x08U) /* Interface Power Descriptor */
#define USB_DT_OTGDESCRIPTOR (0x09U) /* OTG Descriptor */
#define USB_DT_HUBDESCRIPTOR (0x29U) /* HUB descriptor */
/**********************************************************************************************************************
* Typedef definitions
**********************************************************************************************************************/
/** USB request type */
typedef enum e_usb_request_type
{
USB_REQ_TYPE_STANDARD = 0,
USB_REQ_TYPE_CLASS,
USB_REQ_TYPE_VENDOR,
USB_REQ_TYPE_INVALID
} usb_request_type_t;
/** USB request recipient */
typedef enum e_usb_request_recipient
{
USB_REQ_RCPT_DEVICE = 0,
USB_REQ_RCPT_INTERFACE,
USB_REQ_RCPT_ENDPOINT,
USB_REQ_RCPT_OTHER
} usb_request_recipient_t;
/** USB Endpoint Descriptor */
typedef __PACKED_STRUCT st_usb_desc_endpoint
{
uint8_t bLength; /* Size of this descriptor in bytes */
uint8_t bDescriptorType; /* ENDPOINT Descriptor Type */
uint8_t bEndpointAddress; /* The address of the endpoint */
__PACKED_STRUCT
{
uint8_t xfer : 2; /* Control, ISO, Bulk, Interrupt */
uint8_t sync : 2; /* None, Asynchronous, Adaptive, Synchronous */
uint8_t usage : 2; /* Data, Feedback, Implicit feedback */
uint8_t : 2;
} bmAttributes;
uint16_t wMaxPacketSize; /* Bit 10..0 : max packet size, bit 12..11 additional transaction per highspeed micro-frame */
uint8_t bInterval; /* Polling interval, in frames or microframes depending on the operating speed */
} usb_desc_endpoint_t;
/** USB xfer type */
typedef enum e_usb_xfer_type
{
USB_XFER_CONTROL = 0,
USB_XFER_ISOCHRONOUS,
USB_XFER_BULK,
USB_XFER_INTERRUPT
} usb_xfer_type_t;
/** USB endpoint direction */
typedef enum e_usb_dir
{
USB_DIR_OUT = 0,
USB_DIR_IN = 1,
USB_DIR_IN_MASK = 0x80
} usb_dir_t;
/** USB speed */
typedef enum e_usb_speed
{
USB_SPEED_LS = 0, /* Low speed operation */
USB_SPEED_FS, /* Full speed operation */
USB_SPEED_HS, /* Hi speed operation */
USB_SPEED_INVALID,
} usb_speed_t;
/** USB xfer result */
typedef enum e_usb_xfer_result
{
USB_XFER_RESULT_SUCCESS = 0,
USB_XFER_RESULT_FAILED,
USB_XFER_RESULT_STALLED,
USB_XFER_RESULT_TIMEOUT,
USB_XFER_RESULT_INVALID
} usb_xfer_result_t;
#endif /* R_USB_API_H */
|
