blob: e21e3155d8a1a60e904bcf2370705656c395dd7b [file] [log] [blame]
Patrick Delaunay759d36c2020-09-04 18:20:51 +02001/*
2 * Copyright (c) 2021, STMicroelectronics - All Rights Reserved
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#ifndef USB_DEVICE_H
8#define USB_DEVICE_H
9
10#include <stdint.h>
11
12#include <lib/utils_def.h>
13
14#define USBD_MAX_NUM_INTERFACES 1U
15#define USBD_MAX_NUM_CONFIGURATION 1U
16
17#define USB_LEN_DEV_QUALIFIER_DESC 0x0AU
18#define USB_LEN_DEV_DESC 0x12U
19#define USB_LEN_CFG_DESC 0x09U
20#define USB_LEN_IF_DESC 0x09U
21#define USB_LEN_EP_DESC 0x07U
22#define USB_LEN_OTG_DESC 0x03U
23#define USB_LEN_LANGID_STR_DESC 0x04U
24#define USB_LEN_OTHER_SPEED_DESC_SIZ 0x09U
25
26#define USBD_IDX_LANGID_STR 0x00U
27#define USBD_IDX_MFC_STR 0x01U
28#define USBD_IDX_PRODUCT_STR 0x02U
29#define USBD_IDX_SERIAL_STR 0x03U
30#define USBD_IDX_CONFIG_STR 0x04U
31#define USBD_IDX_INTERFACE_STR 0x05U
32#define USBD_IDX_USER0_STR 0x06U
33
34#define USB_REQ_TYPE_STANDARD 0x00U
35#define USB_REQ_TYPE_CLASS 0x20U
36#define USB_REQ_TYPE_VENDOR 0x40U
37#define USB_REQ_TYPE_MASK 0x60U
38
39#define USB_REQ_RECIPIENT_DEVICE 0x00U
40#define USB_REQ_RECIPIENT_INTERFACE 0x01U
41#define USB_REQ_RECIPIENT_ENDPOINT 0x02U
42#define USB_REQ_RECIPIENT_MASK 0x1FU
43
44#define USB_REQ_DIRECTION 0x80U
45
46#define USB_REQ_GET_STATUS 0x00U
47#define USB_REQ_CLEAR_FEATURE 0x01U
48#define USB_REQ_SET_FEATURE 0x03U
49#define USB_REQ_SET_ADDRESS 0x05U
50#define USB_REQ_GET_DESCRIPTOR 0x06U
51#define USB_REQ_SET_DESCRIPTOR 0x07U
52#define USB_REQ_GET_CONFIGURATION 0x08U
53#define USB_REQ_SET_CONFIGURATION 0x09U
54#define USB_REQ_GET_INTERFACE 0x0AU
55#define USB_REQ_SET_INTERFACE 0x0BU
56#define USB_REQ_SYNCH_FRAME 0x0CU
57
58#define USB_DESC_TYPE_DEVICE 0x01U
59#define USB_DESC_TYPE_CONFIGURATION 0x02U
60#define USB_DESC_TYPE_STRING 0x03U
61#define USB_DESC_TYPE_INTERFACE 0x04U
62#define USB_DESC_TYPE_ENDPOINT 0x05U
63#define USB_DESC_TYPE_DEVICE_QUALIFIER 0x06U
64#define USB_DESC_TYPE_OTHER_SPEED_CONFIGURATION 0x07U
65#define USB_DESC_TYPE_BOS 0x0FU
66
67#define USB_CONFIG_REMOTE_WAKEUP 2U
68#define USB_CONFIG_SELF_POWERED 1U
69
70#define USB_MAX_EP0_SIZE 64U
71
72/* Device Status */
73#define USBD_STATE_DEFAULT 1U
74#define USBD_STATE_ADDRESSED 2U
75#define USBD_STATE_CONFIGURED 3U
76#define USBD_STATE_SUSPENDED 4U
77
78/* EP0 State */
79#define USBD_EP0_IDLE 0U
80#define USBD_EP0_SETUP 1U
81#define USBD_EP0_DATA_IN 2U
82#define USBD_EP0_DATA_OUT 3U
83#define USBD_EP0_STATUS_IN 4U
84#define USBD_EP0_STATUS_OUT 5U
85#define USBD_EP0_STALL 6U
86
87#define USBD_EP_TYPE_CTRL 0U
88#define USBD_EP_TYPE_ISOC 1U
89#define USBD_EP_TYPE_BULK 2U
90#define USBD_EP_TYPE_INTR 3U
91
92#define USBD_OUT_EPNUM_MASK GENMASK(15, 0)
93#define USBD_OUT_COUNT_MASK GENMASK(31, 16)
94#define USBD_OUT_COUNT_SHIFT 16U
95
96/* Number of EP supported, allow to reduce footprint: default max = 15 */
97#ifndef CONFIG_USBD_EP_NB
98#define USBD_EP_NB 15U
99#else
100#define USBD_EP_NB CONFIG_USBD_EP_NB
101#endif
102
103#define LOBYTE(x) ((uint8_t)((x) & 0x00FF))
104#define HIBYTE(x) ((uint8_t)(((x) & 0xFF00) >> 8))
105
106struct usb_setup_req {
107 uint8_t bm_request;
108 uint8_t b_request;
109 uint16_t value;
110 uint16_t index;
111 uint16_t length;
112};
113
114struct usb_handle;
115
116struct usb_class {
117 uint8_t (*init)(struct usb_handle *pdev, uint8_t cfgidx);
118 uint8_t (*de_init)(struct usb_handle *pdev, uint8_t cfgidx);
119 /* Control Endpoints */
120 uint8_t (*setup)(struct usb_handle *pdev, struct usb_setup_req *req);
121 uint8_t (*ep0_tx_sent)(struct usb_handle *pdev);
122 uint8_t (*ep0_rx_ready)(struct usb_handle *pdev);
123 /* Class Specific Endpoints */
124 uint8_t (*data_in)(struct usb_handle *pdev, uint8_t epnum);
125 uint8_t (*data_out)(struct usb_handle *pdev, uint8_t epnum);
126 uint8_t (*sof)(struct usb_handle *pdev);
127 uint8_t (*iso_in_incomplete)(struct usb_handle *pdev, uint8_t epnum);
128 uint8_t (*iso_out_incomplete)(struct usb_handle *pdev, uint8_t epnum);
129};
130
131/* Following USB Device status */
132enum usb_status {
133 USBD_OK = 0U,
134 USBD_BUSY,
135 USBD_FAIL,
136 USBD_TIMEOUT
137};
138
139/* Action to do after IT handling */
140enum usb_action {
141 USB_NOTHING = 0U,
142 USB_DATA_OUT,
143 USB_DATA_IN,
144 USB_SETUP,
145 USB_ENUM_DONE,
146 USB_READ_DATA_PACKET,
147 USB_READ_SETUP_PACKET,
148 USB_RESET,
149 USB_RESUME,
150 USB_SUSPEND,
151 USB_LPM,
152 USB_SOF,
153 USB_DISCONNECT,
154 USB_WRITE_EMPTY
155};
156
157/* USB Device descriptors structure */
158struct usb_desc {
159 uint8_t *(*get_device_desc)(uint16_t *length);
160 uint8_t *(*get_lang_id_desc)(uint16_t *length);
161 uint8_t *(*get_manufacturer_desc)(uint16_t *length);
162 uint8_t *(*get_product_desc)(uint16_t *length);
163 uint8_t *(*get_serial_desc)(uint16_t *length);
164 uint8_t *(*get_configuration_desc)(uint16_t *length);
165 uint8_t *(*get_interface_desc)(uint16_t *length);
166 uint8_t *(*get_usr_desc)(uint8_t index, uint16_t *length);
167 uint8_t *(*get_config_desc)(uint16_t *length);
168 uint8_t *(*get_device_qualifier_desc)(uint16_t *length);
169};
170
171/* USB Device handle structure */
172struct usb_endpoint {
173 uint32_t status;
174 uint32_t total_length;
175 uint32_t rem_length;
176 uint32_t maxpacket;
177};
178
179/*
180 * EndPoint descriptor
181 * num : Endpoint number, between 0 and 15 (limited by USBD_EP_NB)
182 * is_in: Endpoint direction
183 * type : Endpoint type
184 * maxpacket: Endpoint Max packet size: between 0 and 64KB
185 * xfer_buff: Pointer to transfer buffer
186 * xfer_len: Current transfer lengt
187 * hxfer_count: Partial transfer length in case of multi packet transfer
188 */
189struct usbd_ep {
190 uint8_t num;
191 bool is_in;
192 uint8_t type;
193 uint32_t maxpacket;
194 uint8_t *xfer_buff;
195 uint32_t xfer_len;
196 uint32_t xfer_count;
197};
198
199enum pcd_lpm_state {
200 LPM_L0 = 0x00U, /* on */
201 LPM_L1 = 0x01U, /* LPM L1 sleep */
202 LPM_L2 = 0x02U, /* suspend */
203 LPM_L3 = 0x03U, /* off */
204};
205
206/* USB Device descriptors structure */
207struct usb_driver {
208 enum usb_status (*ep0_out_start)(void *handle);
209 enum usb_status (*ep_start_xfer)(void *handle, struct usbd_ep *ep);
210 enum usb_status (*ep0_start_xfer)(void *handle, struct usbd_ep *ep);
211 enum usb_status (*write_packet)(void *handle, uint8_t *src,
212 uint8_t ch_ep_num, uint16_t len);
213 void *(*read_packet)(void *handle, uint8_t *dest, uint16_t len);
214 enum usb_status (*ep_set_stall)(void *handle, struct usbd_ep *ep);
215 enum usb_status (*start_device)(void *handle);
216 enum usb_status (*stop_device)(void *handle);
217 enum usb_status (*set_address)(void *handle, uint8_t address);
218 enum usb_status (*write_empty_tx_fifo)(void *handle,
219 uint32_t epnum, uint32_t xfer_len,
220 uint32_t *xfer_count,
221 uint32_t maxpacket,
222 uint8_t **xfer_buff);
223 enum usb_action (*it_handler)(void *handle, uint32_t *param);
224};
225
226/* USB Peripheral Controller Drivers */
227struct pcd_handle {
228 void *instance; /* Register base address */
229 struct usbd_ep in_ep[USBD_EP_NB]; /* IN endpoint parameters */
230 struct usbd_ep out_ep[USBD_EP_NB]; /* OUT endpoint parameters */
231 uint32_t setup[12]; /* Setup packet buffer */
232 enum pcd_lpm_state lpm_state; /* LPM State */
233};
234
235/* USB Device handle structure */
236struct usb_handle {
237 uint8_t id;
238 uint32_t dev_config;
239 uint32_t dev_config_status;
240 struct usb_endpoint ep_in[USBD_EP_NB];
241 struct usb_endpoint ep_out[USBD_EP_NB];
242 uint32_t ep0_state;
243 uint32_t ep0_data_len;
244 uint8_t dev_state;
245 uint8_t dev_old_state;
246 uint8_t dev_address;
247 uint32_t dev_remote_wakeup;
248 struct usb_setup_req request;
249 const struct usb_desc *desc;
250 struct usb_class *class;
251 void *class_data;
252 void *user_data;
253 struct pcd_handle *data;
254 const struct usb_driver *driver;
255};
256
257enum usb_status usb_core_handle_it(struct usb_handle *pdev);
258enum usb_status usb_core_receive(struct usb_handle *pdev, uint8_t ep_addr,
259 uint8_t *p_buf, uint32_t len);
260enum usb_status usb_core_transmit(struct usb_handle *pdev, uint8_t ep_addr,
261 uint8_t *p_buf, uint32_t len);
262enum usb_status usb_core_receive_ep0(struct usb_handle *pdev, uint8_t *p_buf,
263 uint32_t len);
264enum usb_status usb_core_transmit_ep0(struct usb_handle *pdev, uint8_t *p_buf,
265 uint32_t len);
266void usb_core_ctl_error(struct usb_handle *pdev);
267enum usb_status usb_core_start(struct usb_handle *pdev);
268enum usb_status usb_core_stop(struct usb_handle *pdev);
269enum usb_status register_usb_driver(struct usb_handle *pdev,
270 struct pcd_handle *pcd_handle,
271 const struct usb_driver *driver,
272 void *driver_handle);
273enum usb_status register_platform(struct usb_handle *pdev,
274 const struct usb_desc *plat_call_back);
275
276#endif /* USB_DEVICE_H */