usb_device.h 8.2 KB

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