USB Component  Version 6.9
MDK Middleware for USB Device and Host Communication
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
rl_usb.h
1 /*------------------------------------------------------------------------------
2  * MDK Middleware - Component ::USB
3  * Copyright (c) 2004-2016 ARM Germany GmbH. All rights reserved.
4  *------------------------------------------------------------------------------
5  * Name: rl_usb.h
6  * Purpose: USB User API
7  * Rev.: V6.9.0
8  *----------------------------------------------------------------------------*/
9 
10 #ifndef __RL_USB_H__
11 #define __RL_USB_H__
12 
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 #include <stdint.h>
19 #include <stdbool.h>
20 
21 #include "cmsis_os.h"
22 
23 #include "usb_compiler.h"
24 #include "usb_def.h"
25 #include "usb_cdc.h"
26 #include "usb_hid.h"
27 #include "usb_msc.h"
28 
29 
31 
33 typedef enum {
34  usbOK = 0,
35 
38 
39  usbThreadError = 0x10,
43 
56 
59 
61 } usbStatus;
62 
64 #ifdef __BIG_ENDIAN
65  #define U32_LE(v) (uint32_t)(__REV(v))
66  #define U16_LE(v) (uint16_t)(__REV(v) >> 16)
67  #define U32_BE(v) (uint32_t)(v)
68  #define U16_BE(v) (uint16_t)(v)
69 #else
70  #define U32_BE(v) (uint32_t)(__REV(v))
71  #define U16_BE(v) (uint16_t)(__REV(v) >> 16)
72  #define U32_LE(v) (uint32_t)(v)
73  #define U16_LE(v) (uint16_t)(v)
74 #endif
75 
76 // ==== USB Device Constants and Defines ====
77 
79 typedef enum {
85 
87 #define USBD_MSC_MEDIA_READY (1U)
88 #define USBD_MSC_MEDIA_PROTECTED (1U<<1)
89 
90 typedef enum {
96 
97 /* USB Device State structure */
99 typedef struct {
100  uint32_t vbus : 1;
101  uint32_t speed : 2;
102  uint32_t active : 1;
103  uint32_t reserved : 28;
104 } USBD_STATE;
106 
107 /* USB Host Constants and Defines */
108 
110 typedef enum {
111  USBH_NOTIFY_CONNECT = 0,
112  USBH_NOTIFY_DISCONNECT,
113  USBH_NOTIFY_READY,
114  USBH_NOTIFY_OVERCURRENT,
115  USBH_NOTIFY_REMOTE_WAKEUP,
116  USBH_NOTIFY_UNKNOWN_DEVICE,
117  USBH_NOTIFY_INSUFFICIENT_POWER,
118  USBH_NOTIFY_CONFIGURATION_FAILED,
119  USBH_NOTIFY_INITIALIZATION_FAILED
120 } USBH_NOTIFY;
121 
122 /* USB Host Pipe settings structure */
124 typedef struct {
125  uint32_t hw_handle;
126  uint8_t dev_addr;
127  uint8_t dev_speed;
128  uint8_t hub_addr;
129  uint8_t hub_port;
130  uint8_t bEndpointAddress;
131  uint8_t bmAttributes;
132  uint16_t wMaxPacketSize;
133  uint8_t bInterval;
134  uint8_t active;
135  uint16_t pad0;
136  uint32_t transferred;
137 } USBH_PIPE;
139 
140 /* USB Host Device Instance (DEV) structure */
142 typedef struct {
143  uint8_t ctrl;
144  uint8_t dev_addr;
145  uint8_t dev_speed;
146  uint8_t hub_addr;
147  uint8_t hub_port;
148  struct {
149  uint8_t configured : 1;
150  uint8_t initialized : 1;
151  uint8_t reserved : 6;
152  } state;
153  uint16_t max_packet_size;
154  uint16_t vid;
155  uint16_t pid;
156 
157  uint8_t class_custom;
158  uint8_t class_instance;
159  uint8_t class_driver;
160  uint8_t dev_desc_len;
161  uint16_t cfg_desc_len;
162  uint16_t pad0;
163  osThreadId recovery_thread_id;
164 } USBH_DEV;
166 
167 
168 /* USB Host externally defined variables */
169 
170 /* USB Host number of Custom Class (CLS) instances as defined in USBH_Config_Class.h file */
172 extern const uint8_t usbh_cls_num;
174 
175 
176 // ==== USB Device Functions ====
177 
178 
182 extern usbStatus USBD_Initialize (uint8_t device);
183 
187 extern usbStatus USBD_Uninitialize (uint8_t device);
188 
192 extern usbStatus USBD_Connect (uint8_t device);
193 
197 extern usbStatus USBD_Disconnect (uint8_t device);
198 
203 extern bool USBD_Configured (uint8_t device);
204 
208 extern USBD_STATE USBD_GetState (uint8_t device);
209 
210 #ifdef __DOXYGEN__
211 
212 // following functions are available for each instance of a Device.
213 // generic prefix USBD_Devicen is USBD_Device0 for Device instance 0.
214 
217 void USBD_Devicen_Initialize (void);
218 
221 void USBD_Devicen_Uninitialize (void);
222 
228 void USBD_Devicen_VbusChanged (bool level);
229 
232 void USBD_Devicen_Reset (void);
233 
237 
240 void USBD_Devicen_Suspended (void);
241 
244 void USBD_Devicen_Resumed (void);
245 
251 void USBD_Devicen_ConfigurationChanged (uint8_t val);
252 
256 
260 
269 usbdRequestStatus USBD_Devicen_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
270 
275 
283 usbdRequestStatus USBD_Devicen_Endpoint0_OutDataReceived (uint32_t len);
284 
292 usbdRequestStatus USBD_Devicen_Endpoint0_InDataSent (uint32_t len);
293 
294 #endif // __DOXYGEN
295 
296 // ==== USB Device Audio Device Functions ====
297 
298 #ifdef __DOXYGEN__
299 
300 // following functions are available for each instance of a ADC class.
301 // generic prefix USBD_ADCn is USBD_ADC0 for ADC class instance 0.
302 
305 void USBD_ADCn_Initialize (void);
306 
309 void USBD_ADCn_Uninitialize (void);
310 
313 void USBD_ADCn_PlayStart (void);
314 
317 void USBD_ADCn_PlayStop (void);
318 
328 void USBD_ADCn_SetSpeakerMute (uint8_t ch, bool on);
329 
337 void USBD_ADCn_SetSpeakerVolume (uint8_t ch, uint16_t vol);
338 
341 void USBD_ADCn_RecordStart (void);
342 
345 void USBD_ADCn_RecordStop (void);
346 
356 void USBD_ADCn_SetMicrophoneMute (uint8_t ch, bool on);
357 
365 void USBD_ADCn_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
366 
369 void USBD_ADCn_ReceivedSamples (void);
370 
371 #endif // __DOXYGEN
372 
373 // Rename deprecated functions
374 #define USBD_ADC_SpeakerSetVolumeRange USBD_ADC_SetSpeakerVolumeRange
375 #define USBD_ADC_MicrophoneSetVolumeRange USBD_ADC_SetMicrophoneVolumeRange
376 
388 extern usbStatus USBD_ADC_SetSpeakerVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur);
389 
401 extern usbStatus USBD_ADC_SetMicrophoneVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur);
402 
406 extern uint32_t USBD_ADC_ReceivedSamplesAvailable (uint8_t instance);
407 
411 extern uint32_t USBD_ADC_WrittenSamplesPending (uint8_t instance);
412 
420 extern int32_t USBD_ADC_ReadSamples (uint8_t instance, void *buf, int32_t num);
421 
429 extern int32_t USBD_ADC_WriteSamples (uint8_t instance, const void *buf, int32_t num);
430 
431 
432 // ==== USB Device Communication Device (Abstract Control Model) Functions ====
433 
434 #ifdef __DOXYGEN__
435 
436 // following functions are available for each instance of a CDC class.
437 // generic prefix USBD_CDCn is USBD_CDC0 for CDC class instance 0.
438 
441 void USBD_CDCn_ACM_Initialize (void);
442 
445 void USBD_CDCn_ACM_Uninitialize (void);
446 
449 void USBD_CDCn_ACM_Reset (void);
450 
455 bool USBD_CDCn_ACM_SetLineCoding (const CDC_LINE_CODING *line_coding);
456 
461 bool USBD_CDCn_ACM_GetLineCoding (CDC_LINE_CODING *line_coding);
462 
469 bool USBD_CDCn_ACM_SetControlLineState (uint16_t state);
470 
474 void USBD_CDCn_ACM_DataReceived (uint32_t len);
475 
478 void USBD_CDCn_ACM_DataSent (void);
479 
482 void USBD_CDCn_NCM_Initialize (void);
483 
486 void USBD_CDCn_NCM_Uninitialize (void);
487 
490 void USBD_CDCn_NCM_Reset (void);
491 
494 void USBD_CDCn_NCM_Start (void);
495 
498 void USBD_CDCn_NCM_Stop (void);
499 
505 bool USBD_CDCn_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
506 
513 bool USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
514 
520 bool USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
521 
526 bool USBD_CDCn_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
527 
533 bool USBD_CDCn_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
534 
539 bool USBD_CDCn_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
540 
545 bool USBD_CDCn_NCM_GetNetAddress (uint8_t *net_addr);
546 
551 bool USBD_CDCn_NCM_SetNetAddress (const uint8_t *net_addr);
552 
557 bool USBD_CDCn_NCM_GetNtbFormat (uint16_t *ntb_format);
558 
565 bool USBD_CDCn_NCM_SetNtbFormat (uint16_t ntb_format);
566 
571 bool USBD_CDCn_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
572 
577 bool USBD_CDCn_NCM_SetNtbInputSize (uint32_t ntb_input_size);
578 
583 bool USBD_CDCn_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
584 
589 bool USBD_CDCn_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
590 
595 bool USBD_CDCn_NCM_GetCrcMode (uint16_t *crc_mode);
596 
603 bool USBD_CDCn_NCM_SetCrcMode (uint16_t crc_mode);
604 
607 void USBD_CDCn_NCM_NTB_IN_Sent (void);
608 
612 
613 #endif // __DOXYGEN
614 
620 extern int USBD_CDC_ACM_GetChar (uint8_t instance);
621 
628 extern int USBD_CDC_ACM_PutChar (uint8_t instance, int ch);
629 
637 extern int32_t USBD_CDC_ACM_ReadData (uint8_t instance, uint8_t *buf, int32_t len);
638 
646 extern int32_t USBD_CDC_ACM_WriteData (uint8_t instance, const uint8_t *buf, int32_t len);
647 
652 extern int32_t USBD_CDC_ACM_DataAvailable (uint8_t instance);
653 
665 extern usbStatus USBD_CDC_ACM_Notify (uint8_t instance, uint16_t state);
666 
671 extern int32_t USBD_CDC_NCM_NTB_IN_Initialize (uint8_t instance);
672 
673 
679 extern int32_t USBD_CDC_NCM_NTB_IN_CreateNDP (uint8_t instance, uint8_t num_datagrams);
680 
687 extern int32_t USBD_CDC_NCM_NTB_IN_WriteDatagram (uint8_t instance, const uint8_t *buf, uint32_t len);
688 
693 extern int32_t USBD_CDC_NCM_NTB_IN_Send (uint8_t instance);
694 
700 extern int32_t USBD_CDC_NCM_NTB_IN_IsSent (uint8_t instance);
701 
707 extern int32_t USBD_CDC_NCM_NTB_OUT_IsReceived (uint8_t instance);
708 
713 extern int32_t USBD_CDC_NCM_NTB_OUT_Release (uint8_t instance);
714 
719 extern int32_t USBD_CDC_NCM_NTB_OUT_ProcessNDP (uint8_t instance);
720 
724 extern uint32_t USBD_CDC_NCM_NTB_OUT_GetDatagramSize (uint8_t instance);
725 
732 extern int32_t USBD_CDC_NCM_NTB_OUT_ReadDatagram (uint8_t instance, uint8_t *buf, uint32_t max_len);
733 
740 extern int32_t USBD_CDC_NCM_NTB_IN_RawSend (uint8_t instance, const uint8_t *buf, uint32_t len);
741 
745 extern uint32_t USBD_CDC_NCM_NTB_OUT_RawGetSize (uint8_t instance);
746 
753 extern int32_t USBD_CDC_NCM_NTB_OUT_RawReceive (uint8_t instance, uint8_t *buf, uint32_t max_len);
754 
762 extern int32_t USBD_CDC_NCM_Notify_NetworkConnection (uint8_t instance, uint16_t status);
763 
770 extern int32_t USBD_CDC_NCM_Notify_ConnectionSpeedChange (uint8_t instance, uint32_t us_bitrate, uint32_t ds_bitrate);
771 
772 // ==== USB Device Human Interface Device Functions ====
773 
774 #ifdef __DOXYGEN__
775 
776 // following functions are available for each instance of a HID class.
777 // generic prefix USBD_HIDn is USBD_HID0 for HID class instance 0.
778 
781 void USBD_HIDn_Initialize (void);
782 
785 void USBD_HIDn_Uninitialize (void);
786 
800 int32_t USBD_HIDn_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
801 
814 bool USBD_HIDn_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
815 
816 #endif // __DOXYGEN
817 
824 extern usbStatus USBD_HID_GetReportTrigger (uint8_t instance, uint8_t rid, const uint8_t *buf, uint32_t len);
825 
826 
827 #ifdef __DOXYGEN__
828 
829 // ==== USB Device Mass Storage Device Functions ====
830 
831 // following functions are available for each instance of a MSC class.
832 // generic prefix USBD_MSCn is USBD_MSC0 for MSC class instance 0.
833 
836 void USBD_MSCn_Initialize (void);
837 
840 void USBD_MSCn_Uninitialize (void);
841 
847 bool USBD_MSCn_GetCacheInfo (uint32_t *buffer, uint32_t *size);
848 
854 bool USBD_MSCn_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
855 
862 bool USBD_MSCn_Read (uint32_t lba, uint32_t cnt, uint8_t *buf);
863 
870 bool USBD_MSCn_Write (uint32_t lba, uint32_t cnt, const uint8_t *buf);
871 
880 uint32_t USBD_MSCn_CheckMedia (void);
881 
882 #endif // __DOXYGEN
883 
884 
885 // ==== USB Device Custom Class Functions ====
886 
887 #ifdef __DOXYGEN__
888 
889 // following functions are available for each instance of a Custom class.
890 // generic prefix USBD_CustomClassn is USBD_CustomClass0 for Custom class instance 0.
891 
894 void USBD_CustomClassn_Initialize (void);
895 
899 
902 void USBD_CustomClassn_Reset (void);
903 
909 void USBD_CustomClassn_EndpointStart (uint8_t ep_addr);
910 
916 void USBD_CustomClassn_EndpointStop (uint8_t ep_addr);
917 
926 usbdRequestStatus USBD_CustomClassn_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
927 
932 
940 usbdRequestStatus USBD_CustomClassn_Endpoint0_OutDataReceived (uint32_t len);
941 
949 usbdRequestStatus USBD_CustomClassn_Endpoint0_InDataSent (uint32_t len);
950 
955 void USBD_CustomClassn_Endpoint1_Event (uint32_t event);
956 void USBD_CustomClassn_Endpoint2_Event (uint32_t event);
957 void USBD_CustomClassn_Endpoint3_Event (uint32_t event);
958 void USBD_CustomClassn_Endpoint4_Event (uint32_t event);
959 void USBD_CustomClassn_Endpoint5_Event (uint32_t event);
960 void USBD_CustomClassn_Endpoint6_Event (uint32_t event);
961 void USBD_CustomClassn_Endpoint7_Event (uint32_t event);
962 void USBD_CustomClassn_Endpoint8_Event (uint32_t event);
963 void USBD_CustomClassn_Endpoint9_Event (uint32_t event);
964 void USBD_CustomClassn_Endpoint10_Event (uint32_t event);
965 void USBD_CustomClassn_Endpoint11_Event (uint32_t event);
966 void USBD_CustomClassn_Endpoint12_Event (uint32_t event);
967 void USBD_CustomClassn_Endpoint13_Event (uint32_t event);
968 void USBD_CustomClassn_Endpoint14_Event (uint32_t event);
969 void USBD_CustomClassn_Endpoint15_Event (uint32_t event);
970 
971 #endif // __DOXYGEN
972 
981 extern usbStatus USBD_EndpointRead (uint8_t device, uint8_t ep_addr, uint8_t *buf, uint32_t len);
982 
989 extern uint32_t USBD_EndpointReadGetResult (uint8_t device, uint8_t ep_addr);
990 
999 extern usbStatus USBD_EndpointWrite (uint8_t device, uint8_t ep_addr, const uint8_t *buf, uint32_t len);
1000 
1007 extern uint32_t USBD_EndpointWriteGetResult (uint8_t device, uint8_t ep_addr);
1008 
1016 extern usbStatus USBD_EndpointStall (uint8_t device, uint8_t ep_addr, bool stall);
1017 
1024 extern usbStatus USBD_EndpointAbort (uint8_t device, uint8_t ep_addr);
1025 
1026 
1027 // ==== USB Host Functions ====
1028 
1029 // Rename deprecated functions
1030 #define USBH_GetDeviceStatus USBH_Device_GetStatus
1031 
1035 extern usbStatus USBH_Initialize (uint8_t ctrl);
1036 
1040 extern usbStatus USBH_Uninitialize (uint8_t ctrl);
1041 
1046 extern usbStatus USBH_Port_Suspend (uint8_t ctrl, uint8_t port);
1047 
1052 extern usbStatus USBH_Port_Resume (uint8_t ctrl, uint8_t port);
1053 
1058 extern uint8_t USBH_Device_GetController (uint8_t device);
1059 
1064 extern uint8_t USBH_Device_GetPort (uint8_t device);
1065 
1069 extern usbStatus USBH_Device_GetStatus (uint8_t device);
1070 
1077 extern int32_t USBH_Device_GetSpeed (uint8_t device);
1078 
1083 extern uint8_t USBH_Device_GetAddress (uint8_t device);
1084 
1088 extern uint16_t USBH_Device_GetVID (uint8_t device);
1089 
1093 extern uint16_t USBH_Device_GetPID (uint8_t device);
1094 
1108 extern void USBH_Port_Notify (uint8_t ctrl, uint8_t port, USBH_NOTIFY notify);
1109 
1110 
1111 // ==== USB Host Mass Storage Functions ====
1112 
1113 // Rename deprecated functions
1114 #define USBH_MSC_GetDeviceStatus USBH_MSC_GetStatus
1115 
1119 extern void USBH_MSC_Initialize (uint8_t instance);
1120 
1124 extern void USBH_MSC_Uninitialize (uint8_t instance);
1125 
1130 extern uint8_t USBH_MSC_GetDevice (uint8_t instance);
1131 
1135 extern usbStatus USBH_MSC_GetStatus (uint8_t instance);
1136 
1143 extern usbStatus USBH_MSC_Read (uint8_t instance, uint32_t lba, uint32_t cnt, uint8_t *buf);
1144 
1151 extern usbStatus USBH_MSC_Write (uint8_t instance, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1152 
1158 extern usbStatus USBH_MSC_ReadCapacity (uint8_t instance, uint32_t *block_count, uint32_t *block_size);
1159 
1160 
1161 // ==== USB Host Human Interface Device Functions ====
1162 
1163 // Rename deprecated functions
1164 #define USBH_HID_GetDeviceStatus USBH_HID_GetStatus
1165 
1169 extern void USBH_HID_Initialize (uint8_t instance);
1170 
1174 extern void USBH_HID_Uninitialize (uint8_t instance);
1175 
1180 extern uint8_t USBH_HID_GetDevice (uint8_t instance);
1181 
1185 extern usbStatus USBH_HID_GetStatus (uint8_t instance);
1186 
1194 extern int32_t USBH_HID_Read (uint8_t instance, uint8_t *buf, int32_t len);
1195 
1203 extern int32_t USBH_HID_Write (uint8_t instance, const uint8_t *buf, int32_t len);
1204 
1210 extern int USBH_HID_GetKeyboardKey (uint8_t instance);
1211 
1213 typedef struct _usbHID_MouseState {
1214  uint8_t reserved;
1215  uint8_t button;
1216  int16_t x;
1217  int16_t y;
1219 
1224 extern usbStatus USBH_HID_GetMouseState (uint8_t instance, usbHID_MouseState *state);
1225 
1231 extern void USBH_HID_ParseReportDescriptor (uint8_t instance, const uint8_t *ptr_hid_report_desc, uint32_t len);
1232 
1237 extern void USBH_HID_DataReceived (uint8_t instance, uint32_t len);
1238 
1239 
1240 // ==== USB Host Communication Device Class (Abstract Control Model) Functions ====
1241 
1242 // Rename deprecated functions
1243 #define USBH_CDC_ACM_GetDeviceStatus USBH_CDC_ACM_GetStatus
1244 
1248 extern void USBH_CDC_ACM_Initialize (uint8_t instance);
1249 
1253 extern void USBH_CDC_ACM_Uninitialize (uint8_t instance);
1254 
1259 extern uint8_t USBH_CDC_ACM_GetDevice (uint8_t instance);
1260 
1264 extern usbStatus USBH_CDC_ACM_GetStatus (uint8_t instance);
1265 
1271 extern usbStatus USBH_CDC_ACM_Send (uint8_t instance, const uint8_t *data, uint32_t num);
1272 
1276 extern uint32_t USBH_CDC_ACM_GetTxCount (uint8_t instance);
1277 
1283 extern usbStatus USBH_CDC_ACM_Receive (uint8_t instance, uint8_t *data, uint32_t num);
1284 
1288 extern uint32_t USBH_CDC_ACM_GetRxCount (uint8_t instance);
1289 
1294 extern usbStatus USBH_CDC_ACM_SetLineCoding (uint8_t instance, const CDC_LINE_CODING *line_coding);
1295 
1300 extern usbStatus USBH_CDC_ACM_GetLineCoding (uint8_t instance, CDC_LINE_CODING *line_coding);
1301 
1308 extern usbStatus USBH_CDC_ACM_SetControlLineState (uint8_t instance, uint16_t state);
1309 
1322 extern void USBH_CDC_ACM_Notify (uint8_t instance, uint16_t status);
1323 
1330 extern usbStatus USBH_CDC_ACM_SendBreak (uint8_t instance, uint16_t duration);
1331 
1332 
1333 // ==== USB Host Custom Class Functions ====
1334 
1335 // Rename deprecated functions
1336 #define USBH_CustomClass_GetDeviceStatus USBH_CustomClass_GetStatus
1337 
1342 extern uint8_t USBH_CustomClass_GetDevice (uint8_t instance);
1343 
1347 extern usbStatus USBH_CustomClass_GetStatus (uint8_t instance);
1348 
1356 extern uint8_t USBH_CustomClass_Configure (const USBH_DEV *ptr_dev, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
1357 
1362 extern usbStatus USBH_CustomClass_Unconfigure (uint8_t instance);
1363 
1368 extern usbStatus USBH_CustomClass_Initialize (uint8_t instance);
1369 
1374 extern usbStatus USBH_CustomClass_Uninitialize (uint8_t instance);
1375 
1391 extern USBH_PIPE *USBH_PipeCreate (uint8_t ctrl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval);
1392 
1402 extern usbStatus USBH_PipeModify (uint8_t ctrl, USBH_PIPE *ptr_pipe, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size);
1403 
1408 extern usbStatus USBH_PipeDelete (uint8_t ctrl, USBH_PIPE *ptr_pipe);
1409 
1414 extern usbStatus USBH_PipeReset (uint8_t ctrl, USBH_PIPE *ptr_pipe);
1415 
1422 extern usbStatus USBH_PipeReceive (uint8_t ctrl, USBH_PIPE *ptr_pipe, uint8_t *buf, uint32_t len);
1423 
1428 extern uint32_t USBH_PipeReceiveGetResult (uint8_t ctrl, const USBH_PIPE *ptr_pipe);
1429 
1436 extern usbStatus USBH_PipeSend (uint8_t ctrl, USBH_PIPE *ptr_pipe, const uint8_t *buf, uint32_t len);
1437 
1442 extern uint32_t USBH_PipeSendGetResult (uint8_t ctrl, const USBH_PIPE *ptr_pipe);
1443 
1448 extern usbStatus USBH_PipeAbort (uint8_t ctrl, const USBH_PIPE *ptr_pipe);
1449 
1455 extern usbStatus USBH_DefaultPipeReceive (uint8_t ctrl, uint8_t *buf, uint32_t len);
1456 
1460 extern uint32_t USBH_DefaultPipeReceiveGetResult (uint8_t ctrl);
1461 
1466 extern usbStatus USBH_DefaultPipeSendSetup (uint8_t ctrl, const USB_SETUP_PACKET *setup_packet);
1467 
1473 extern usbStatus USBH_DefaultPipeSend (uint8_t ctrl, const uint8_t *buf, uint32_t len);
1474 
1478 extern uint32_t USBH_DefaultPipeSendGetResult (uint8_t ctrl);
1479 
1483 extern usbStatus USBH_DefaultPipeAbort (uint8_t ctrl);
1484 
1491 extern usbStatus USBH_ControlTransfer (uint8_t ctrl, const USB_SETUP_PACKET *setup_packet, uint8_t *data, uint32_t len);
1492 
1499 extern usbStatus USBH_DeviceRequest_GetStatus (uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t *ptr_stat_dat);
1500 
1507 extern usbStatus USBH_DeviceRequest_ClearFeature (uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t feature_selector);
1508 
1515 extern usbStatus USBH_DeviceRequest_SetFeature (uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t feature_selector);
1516 
1521 extern usbStatus USBH_DeviceRequest_SetAddress (uint8_t ctrl, uint8_t device_address);
1522 
1532 extern usbStatus USBH_DeviceRequest_GetDescriptor (uint8_t ctrl, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, uint8_t *descriptor_data, uint16_t descriptor_length);
1533 
1543 extern usbStatus USBH_DeviceRequest_SetDescriptor (uint8_t ctrl, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, const uint8_t *descriptor_data, uint16_t descriptor_length);
1544 
1549 extern usbStatus USBH_DeviceRequest_GetConfiguration (uint8_t ctrl, uint8_t *ptr_configuration);
1550 
1555 extern usbStatus USBH_DeviceRequest_SetConfiguration (uint8_t ctrl, uint8_t configuration);
1556 
1562 extern usbStatus USBH_DeviceRequest_GetInterface (uint8_t ctrl, uint8_t index, uint8_t *ptr_alternate);
1563 
1569 extern usbStatus USBH_DeviceRequest_SetInterface (uint8_t ctrl, uint8_t index, uint8_t alternate);
1570 
1576 extern usbStatus USBH_DeviceRequest_SynchFrame (uint8_t ctrl, uint8_t index, uint8_t *ptr_frame_number);
1577 
1578 
1579 // USB Device OS abstraction functions
1580 extern osThreadId USBD_osThreadCreate (const osThreadDef_t *thread_def, void *argument);
1581 extern osThreadId USBD_osThreadGetId (void);
1582 extern osStatus USBD_osThreadTerminate (osThreadId thread_id);
1583 extern osStatus USBD_osThreadSetPriority (osThreadId thread_id, osPriority priority);
1584 extern osPriority USBD_osThreadGetPriority (osThreadId thread_id);
1585 extern osStatus USBD_osThreadYield (void);
1586 
1587 extern osStatus USBD_osDelay (uint32_t millisec);
1588 
1589 extern osTimerId USBD_osTimerCreate (const osTimerDef_t *timer_def, os_timer_type type, void *argument);
1590 extern osStatus USBD_osTimerStart (osTimerId timer_id, uint32_t millisec);
1591 extern osStatus USBD_osTimerStop (osTimerId timer_id);
1592 extern osStatus USBD_osTimerDelete (osTimerId timer_id);
1593 
1594 extern int32_t USBD_osSignalSet (osThreadId thread_id, int32_t signals);
1595 extern int32_t USBD_osSignalClear (osThreadId thread_id, int32_t signals);
1596 extern osEvent USBD_osSignalWait (int32_t signals, uint32_t millisec);
1597 
1598 extern osSemaphoreId USBD_osSemaphoreCreate (const osSemaphoreDef_t *semaphore_def, int32_t count);
1599 extern int32_t USBD_osSemaphoreWait (osSemaphoreId semaphore_id, uint32_t millisec);
1600 extern osStatus USBD_osSemaphoreRelease (osSemaphoreId semaphore_id);
1601 extern osStatus USBD_osSemaphoreDelete (osSemaphoreId semaphore_id);
1602 
1603 
1604 // USB Device user callback function prototypes
1605 extern void USBD_Device0_Initialize (void);
1606 extern void USBD_Device0_Uninitialize (void);
1607 extern void USBD_Device0_VbusChanged (bool level);
1608 extern void USBD_Device0_Reset (void);
1609 extern void USBD_Device0_HighSpeedActivated (void);
1610 extern void USBD_Device0_Suspended (void);
1611 extern void USBD_Device0_Resumed (void);
1612 extern void USBD_Device0_ConfigurationChanged (uint8_t val);
1613 extern void USBD_Device0_EnableRemoteWakeup (void);
1614 extern void USBD_Device0_DisableRemoteWakeup (void);
1615 extern usbdRequestStatus USBD_Device0_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1616 extern void USBD_Device0_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1617 extern usbdRequestStatus USBD_Device0_Endpoint0_OutDataReceived (uint32_t len);
1618 extern usbdRequestStatus USBD_Device0_Endpoint0_InDataSent (uint32_t len);
1619 
1620 extern void USBD_Device1_Initialize (void);
1621 extern void USBD_Device1_Uninitialize (void);
1622 extern void USBD_Device1_VbusChanged (bool level);
1623 extern void USBD_Device1_Reset (void);
1624 extern void USBD_Device1_HighSpeedActivated (void);
1625 extern void USBD_Device1_Suspended (void);
1626 extern void USBD_Device1_Resumed (void);
1627 extern void USBD_Device1_ConfigurationChanged (uint8_t val);
1628 extern void USBD_Device1_EnableRemoteWakeup (void);
1629 extern void USBD_Device1_DisableRemoteWakeup (void);
1630 extern usbdRequestStatus USBD_Device1_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1631 extern void USBD_Device1_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1632 extern usbdRequestStatus USBD_Device1_Endpoint0_OutDataReceived (uint32_t len);
1633 extern usbdRequestStatus USBD_Device1_Endpoint0_InDataSent (uint32_t len);
1634 
1635 extern void USBD_Device2_Initialize (void);
1636 extern void USBD_Device2_Uninitialize (void);
1637 extern void USBD_Device2_VbusChanged (bool level);
1638 extern void USBD_Device2_Reset (void);
1639 extern void USBD_Device2_HighSpeedActivated (void);
1640 extern void USBD_Device2_Suspended (void);
1641 extern void USBD_Device2_Resumed (void);
1642 extern void USBD_Device2_ConfigurationChanged (uint8_t val);
1643 extern void USBD_Device2_EnableRemoteWakeup (void);
1644 extern void USBD_Device2_DisableRemoteWakeup (void);
1645 extern usbdRequestStatus USBD_Device2_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1646 extern void USBD_Device2_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1647 extern usbdRequestStatus USBD_Device2_Endpoint0_OutDataReceived (uint32_t len);
1648 extern usbdRequestStatus USBD_Device2_Endpoint0_InDataSent (uint32_t len);
1649 
1650 extern void USBD_Device3_Initialize (void);
1651 extern void USBD_Device3_Uninitialize (void);
1652 extern void USBD_Device3_VbusChanged (bool level);
1653 extern void USBD_Device3_Reset (void);
1654 extern void USBD_Device3_HighSpeedActivated (void);
1655 extern void USBD_Device3_Suspended (void);
1656 extern void USBD_Device3_Resumed (void);
1657 extern void USBD_Device3_ConfigurationChanged (uint8_t val);
1658 extern void USBD_Device3_EnableRemoteWakeup (void);
1659 extern void USBD_Device3_DisableRemoteWakeup (void);
1660 extern usbdRequestStatus USBD_Device3_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1661 extern void USBD_Device3_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1662 extern usbdRequestStatus USBD_Device3_Endpoint0_OutDataReceived (uint32_t len);
1663 extern usbdRequestStatus USBD_Device3_Endpoint0_InDataSent (uint32_t len);
1664 
1665 extern void USBD_ADC0_Initialize (void);
1666 extern void USBD_ADC0_Uninitialize (void);
1667 extern void USBD_ADC0_PlayStart (void);
1668 extern void USBD_ADC0_PlayStop (void);
1669 extern void USBD_ADC0_SetSpeakerMute (uint8_t ch, bool on);
1670 extern void USBD_ADC0_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1671 extern void USBD_ADC0_RecordStart (void);
1672 extern void USBD_ADC0_RecordStop (void);
1673 extern void USBD_ADC0_SetMicrophoneMute (uint8_t ch, bool on);
1674 extern void USBD_ADC0_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1675 extern void USBD_ADC0_ReceivedSamples (void);
1676 
1677 extern void USBD_ADC1_Initialize (void);
1678 extern void USBD_ADC1_Uninitialize (void);
1679 extern void USBD_ADC1_PlayStart (void);
1680 extern void USBD_ADC1_PlayStop (void);
1681 extern void USBD_ADC1_SetSpeakerMute (uint8_t ch, bool on);
1682 extern void USBD_ADC1_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1683 extern void USBD_ADC1_RecordStart (void);
1684 extern void USBD_ADC1_RecordStop (void);
1685 extern void USBD_ADC1_SetMicrophoneMute (uint8_t ch, bool on);
1686 extern void USBD_ADC1_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1687 extern void USBD_ADC1_ReceivedSamples (void);
1688 
1689 extern void USBD_ADC2_Initialize (void);
1690 extern void USBD_ADC2_Uninitialize (void);
1691 extern void USBD_ADC2_PlayStart (void);
1692 extern void USBD_ADC2_PlayStop (void);
1693 extern void USBD_ADC2_SetSpeakerMute (uint8_t ch, bool on);
1694 extern void USBD_ADC2_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1695 extern void USBD_ADC2_RecordStart (void);
1696 extern void USBD_ADC2_RecordStop (void);
1697 extern void USBD_ADC2_SetMicrophoneMute (uint8_t ch, bool on);
1698 extern void USBD_ADC2_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1699 extern void USBD_ADC2_ReceivedSamples (void);
1700 
1701 extern void USBD_ADC3_Initialize (void);
1702 extern void USBD_ADC3_Uninitialize (void);
1703 extern void USBD_ADC3_PlayStart (void);
1704 extern void USBD_ADC3_PlayStop (void);
1705 extern void USBD_ADC3_SetSpeakerMute (uint8_t ch, bool on);
1706 extern void USBD_ADC3_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1707 extern void USBD_ADC3_RecordStart (void);
1708 extern void USBD_ADC3_RecordStop (void);
1709 extern void USBD_ADC3_SetMicrophoneMute (uint8_t ch, bool on);
1710 extern void USBD_ADC3_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1711 extern void USBD_ADC3_ReceivedSamples (void);
1712 
1713 extern void USBD_CDC0_ACM_Initialize (void);
1714 extern void USBD_CDC0_ACM_Uninitialize (void);
1715 extern void USBD_CDC0_ACM_Reset (void);
1716 extern bool USBD_CDC0_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1717 extern bool USBD_CDC0_ACM_SetControlLineState (uint16_t state);
1718 extern void USBD_CDC0_ACM_DataReceived (uint32_t len);
1719 extern void USBD_CDC0_ACM_DataSent (void);
1720 extern void USBD_CDC0_NCM_Initialize (void);
1721 extern void USBD_CDC0_NCM_Uninitialize (void);
1722 extern void USBD_CDC0_NCM_Reset (void);
1723 extern void USBD_CDC0_NCM_Start (void);
1724 extern void USBD_CDC0_NCM_Stop (void);
1725 extern bool USBD_CDC0_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1726 extern bool USBD_CDC0_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1727 extern bool USBD_CDC0_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1728 extern bool USBD_CDC0_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1729 extern bool USBD_CDC0_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1730 extern bool USBD_CDC0_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1731 extern bool USBD_CDC0_NCM_GetNetAddress (uint8_t *net_addr);
1732 extern bool USBD_CDC0_NCM_SetNetAddress (const uint8_t *net_addr);
1733 extern bool USBD_CDC0_NCM_GetNtbFormat (uint16_t *ntb_format);
1734 extern bool USBD_CDC0_NCM_SetNtbFormat (uint16_t ntb_format);
1735 extern bool USBD_CDC0_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1736 extern bool USBD_CDC0_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1737 extern bool USBD_CDC0_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1738 extern bool USBD_CDC0_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1739 extern bool USBD_CDC0_NCM_GetCrcMode (uint16_t *crc_mode);
1740 extern bool USBD_CDC0_NCM_SetCrcMode (uint16_t crc_mode);
1741 extern void USBD_CDC0_NCM_NTB_IN_Sent (void);
1742 extern void USBD_CDC0_NCM_NTB_OUT_Received (void);
1743 
1744 extern void USBD_CDC1_ACM_Initialize (void);
1745 extern void USBD_CDC1_ACM_Uninitialize (void);
1746 extern void USBD_CDC1_ACM_Reset (void);
1747 extern bool USBD_CDC1_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1748 extern bool USBD_CDC1_ACM_SetControlLineState (uint16_t state);
1749 extern void USBD_CDC1_ACM_DataReceived (uint32_t len);
1750 extern void USBD_CDC1_ACM_DataSent (void);
1751 extern void USBD_CDC1_NCM_Initialize (void);
1752 extern void USBD_CDC1_NCM_Uninitialize (void);
1753 extern void USBD_CDC1_NCM_Reset (void);
1754 extern void USBD_CDC1_NCM_Start (void);
1755 extern void USBD_CDC1_NCM_Stop (void);
1756 extern bool USBD_CDC1_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1757 extern bool USBD_CDC1_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1758 extern bool USBD_CDC1_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1759 extern bool USBD_CDC1_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1760 extern bool USBD_CDC1_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1761 extern bool USBD_CDC1_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1762 extern bool USBD_CDC1_NCM_GetNetAddress (uint8_t *net_addr);
1763 extern bool USBD_CDC1_NCM_SetNetAddress (const uint8_t *net_addr);
1764 extern bool USBD_CDC1_NCM_GetNtbFormat (uint16_t *ntb_format);
1765 extern bool USBD_CDC1_NCM_SetNtbFormat (uint16_t ntb_format);
1766 extern bool USBD_CDC1_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1767 extern bool USBD_CDC1_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1768 extern bool USBD_CDC1_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1769 extern bool USBD_CDC1_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1770 extern bool USBD_CDC1_NCM_GetCrcMode (uint16_t *crc_mode);
1771 extern bool USBD_CDC1_NCM_SetCrcMode (uint16_t crc_mode);
1772 extern void USBD_CDC1_NCM_NTB_IN_Sent (void);
1773 extern void USBD_CDC1_NCM_NTB_OUT_Received (void);
1774 
1775 extern void USBD_CDC2_ACM_Initialize (void);
1776 extern void USBD_CDC2_ACM_Uninitialize (void);
1777 extern void USBD_CDC2_ACM_Reset (void);
1778 extern bool USBD_CDC2_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1779 extern bool USBD_CDC2_ACM_SetControlLineState (uint16_t state);
1780 extern void USBD_CDC2_ACM_DataReceived (uint32_t len);
1781 extern void USBD_CDC2_ACM_DataSent (void);
1782 extern void USBD_CDC2_NCM_Initialize (void);
1783 extern void USBD_CDC2_NCM_Uninitialize (void);
1784 extern void USBD_CDC2_NCM_Reset (void);
1785 extern void USBD_CDC2_NCM_Start (void);
1786 extern void USBD_CDC2_NCM_Stop (void);
1787 extern bool USBD_CDC2_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1788 extern bool USBD_CDC2_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1789 extern bool USBD_CDC2_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1790 extern bool USBD_CDC2_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1791 extern bool USBD_CDC2_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1792 extern bool USBD_CDC2_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1793 extern bool USBD_CDC2_NCM_GetNetAddress (uint8_t *net_addr);
1794 extern bool USBD_CDC2_NCM_SetNetAddress (const uint8_t *net_addr);
1795 extern bool USBD_CDC2_NCM_GetNtbFormat (uint16_t *ntb_format);
1796 extern bool USBD_CDC2_NCM_SetNtbFormat (uint16_t ntb_format);
1797 extern bool USBD_CDC2_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1798 extern bool USBD_CDC2_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1799 extern bool USBD_CDC2_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1800 extern bool USBD_CDC2_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1801 extern bool USBD_CDC2_NCM_GetCrcMode (uint16_t *crc_mode);
1802 extern bool USBD_CDC2_NCM_SetCrcMode (uint16_t crc_mode);
1803 extern void USBD_CDC2_NCM_NTB_IN_Sent (void);
1804 extern void USBD_CDC2_NCM_NTB_OUT_Received (void);
1805 
1806 extern void USBD_CDC3_ACM_Initialize (void);
1807 extern void USBD_CDC3_ACM_Uninitialize (void);
1808 extern void USBD_CDC3_ACM_Reset (void);
1809 extern bool USBD_CDC3_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1810 extern bool USBD_CDC3_ACM_SetControlLineState (uint16_t state);
1811 extern void USBD_CDC3_ACM_DataReceived (uint32_t len);
1812 extern void USBD_CDC3_ACM_DataSent (void);
1813 extern void USBD_CDC3_NCM_Initialize (void);
1814 extern void USBD_CDC3_NCM_Uninitialize (void);
1815 extern void USBD_CDC3_NCM_Reset (void);
1816 extern void USBD_CDC3_NCM_Start (void);
1817 extern void USBD_CDC3_NCM_Stop (void);
1818 extern bool USBD_CDC3_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1819 extern bool USBD_CDC3_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1820 extern bool USBD_CDC3_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1821 extern bool USBD_CDC3_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1822 extern bool USBD_CDC3_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1823 extern bool USBD_CDC3_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1824 extern bool USBD_CDC3_NCM_GetNetAddress (uint8_t *net_addr);
1825 extern bool USBD_CDC3_NCM_SetNetAddress (const uint8_t *net_addr);
1826 extern bool USBD_CDC3_NCM_GetNtbFormat (uint16_t *ntb_format);
1827 extern bool USBD_CDC3_NCM_SetNtbFormat (uint16_t ntb_format);
1828 extern bool USBD_CDC3_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1829 extern bool USBD_CDC3_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1830 extern bool USBD_CDC3_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1831 extern bool USBD_CDC3_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1832 extern bool USBD_CDC3_NCM_GetCrcMode (uint16_t *crc_mode);
1833 extern bool USBD_CDC3_NCM_SetCrcMode (uint16_t crc_mode);
1834 extern void USBD_CDC3_NCM_NTB_IN_Sent (void);
1835 extern void USBD_CDC3_NCM_NTB_OUT_Received (void);
1836 
1837 extern void USBD_HID0_Initialize (void);
1838 extern void USBD_HID0_Uninitialize (void);
1839 extern int32_t USBD_HID0_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1840 extern bool USBD_HID0_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1841 
1842 extern void USBD_HID1_Initialize (void);
1843 extern void USBD_HID1_Uninitialize (void);
1844 extern int32_t USBD_HID1_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1845 extern bool USBD_HID1_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1846 
1847 extern void USBD_HID2_Initialize (void);
1848 extern void USBD_HID2_Uninitialize (void);
1849 extern int32_t USBD_HID2_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1850 extern bool USBD_HID2_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1851 
1852 extern void USBD_HID3_Initialize (void);
1853 extern void USBD_HID3_Uninitialize (void);
1854 extern int32_t USBD_HID3_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1855 extern bool USBD_HID3_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1856 
1857 extern void USBD_MSC0_Initialize (void);
1858 extern void USBD_MSC0_Uninitialize (void);
1859 extern bool USBD_MSC0_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1860 extern bool USBD_MSC0_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1861 extern bool USBD_MSC0_StartStop (bool start);
1862 extern uint32_t USBD_MSC0_CheckMedia (void);
1863 
1864 extern void USBD_MSC1_Initialize (void);
1865 extern void USBD_MSC1_Uninitialize (void);
1866 extern bool USBD_MSC1_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1867 extern bool USBD_MSC1_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1868 extern bool USBD_MSC1_StartStop (bool start);
1869 extern uint32_t USBD_MSC1_CheckMedia (void);
1870 
1871 extern void USBD_MSC2_Initialize (void);
1872 extern void USBD_MSC2_Uninitialize (void);
1873 extern bool USBD_MSC2_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1874 extern bool USBD_MSC2_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1875 extern bool USBD_MSC2_StartStop (bool start);
1876 extern uint32_t USBD_MSC2_CheckMedia (void);
1877 
1878 extern void USBD_MSC3_Initialize (void);
1879 extern void USBD_MSC3_Uninitialize (void);
1880 extern bool USBD_MSC3_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1881 extern bool USBD_MSC3_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1882 extern bool USBD_MSC3_StartStop (bool start);
1883 extern uint32_t USBD_MSC3_CheckMedia (void);
1884 
1885 extern void USBD_CustomClass0_Initialize (void);
1886 extern void USBD_CustomClass0_Uninitialize (void);
1887 extern void USBD_CustomClass0_Reset (void);
1888 extern void USBD_CustomClass0_EndpointStart (uint8_t ep_addr);
1889 extern void USBD_CustomClass0_EndpointStop (uint8_t ep_addr);
1890 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1891 extern void USBD_CustomClass0_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1892 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_OutDataReceived (uint32_t len);
1893 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_InDataSent (uint32_t len);
1894 extern void USBD_CustomClass0_Endpoint1_Event (uint32_t event);
1895 extern void USBD_CustomClass0_Endpoint2_Event (uint32_t event);
1896 extern void USBD_CustomClass0_Endpoint3_Event (uint32_t event);
1897 extern void USBD_CustomClass0_Endpoint4_Event (uint32_t event);
1898 extern void USBD_CustomClass0_Endpoint5_Event (uint32_t event);
1899 extern void USBD_CustomClass0_Endpoint6_Event (uint32_t event);
1900 extern void USBD_CustomClass0_Endpoint7_Event (uint32_t event);
1901 extern void USBD_CustomClass0_Endpoint8_Event (uint32_t event);
1902 extern void USBD_CustomClass0_Endpoint9_Event (uint32_t event);
1903 extern void USBD_CustomClass0_Endpoint10_Event (uint32_t event);
1904 extern void USBD_CustomClass0_Endpoint11_Event (uint32_t event);
1905 extern void USBD_CustomClass0_Endpoint12_Event (uint32_t event);
1906 extern void USBD_CustomClass0_Endpoint13_Event (uint32_t event);
1907 extern void USBD_CustomClass0_Endpoint14_Event (uint32_t event);
1908 extern void USBD_CustomClass0_Endpoint15_Event (uint32_t event);
1909 
1910 extern void USBD_CustomClass1_Initialize (void);
1911 extern void USBD_CustomClass1_Uninitialize (void);
1912 extern void USBD_CustomClass1_Reset (void);
1913 extern void USBD_CustomClass1_EndpointStart (uint8_t ep_addr);
1914 extern void USBD_CustomClass1_EndpointStop (uint8_t ep_addr);
1915 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1916 extern void USBD_CustomClass1_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1917 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_OutDataReceived (uint32_t len);
1918 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_InDataSent (uint32_t len);
1919 extern void USBD_CustomClass1_Endpoint1_Event (uint32_t event);
1920 extern void USBD_CustomClass1_Endpoint2_Event (uint32_t event);
1921 extern void USBD_CustomClass1_Endpoint3_Event (uint32_t event);
1922 extern void USBD_CustomClass1_Endpoint4_Event (uint32_t event);
1923 extern void USBD_CustomClass1_Endpoint5_Event (uint32_t event);
1924 extern void USBD_CustomClass1_Endpoint6_Event (uint32_t event);
1925 extern void USBD_CustomClass1_Endpoint7_Event (uint32_t event);
1926 extern void USBD_CustomClass1_Endpoint8_Event (uint32_t event);
1927 extern void USBD_CustomClass1_Endpoint9_Event (uint32_t event);
1928 extern void USBD_CustomClass1_Endpoint10_Event (uint32_t event);
1929 extern void USBD_CustomClass1_Endpoint11_Event (uint32_t event);
1930 extern void USBD_CustomClass1_Endpoint12_Event (uint32_t event);
1931 extern void USBD_CustomClass1_Endpoint13_Event (uint32_t event);
1932 extern void USBD_CustomClass1_Endpoint14_Event (uint32_t event);
1933 extern void USBD_CustomClass1_Endpoint15_Event (uint32_t event);
1934 
1935 extern void USBD_CustomClass2_Initialize (void);
1936 extern void USBD_CustomClass2_Uninitialize (void);
1937 extern void USBD_CustomClass2_Reset (void);
1938 extern void USBD_CustomClass2_EndpointStart (uint8_t ep_addr);
1939 extern void USBD_CustomClass2_EndpointStop (uint8_t ep_addr);
1940 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1941 extern void USBD_CustomClass2_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1942 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_OutDataReceived (uint32_t len);
1943 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_InDataSent (uint32_t len);
1944 extern void USBD_CustomClass2_Endpoint1_Event (uint32_t event);
1945 extern void USBD_CustomClass2_Endpoint2_Event (uint32_t event);
1946 extern void USBD_CustomClass2_Endpoint3_Event (uint32_t event);
1947 extern void USBD_CustomClass2_Endpoint4_Event (uint32_t event);
1948 extern void USBD_CustomClass2_Endpoint5_Event (uint32_t event);
1949 extern void USBD_CustomClass2_Endpoint6_Event (uint32_t event);
1950 extern void USBD_CustomClass2_Endpoint7_Event (uint32_t event);
1951 extern void USBD_CustomClass2_Endpoint8_Event (uint32_t event);
1952 extern void USBD_CustomClass2_Endpoint9_Event (uint32_t event);
1953 extern void USBD_CustomClass2_Endpoint10_Event (uint32_t event);
1954 extern void USBD_CustomClass2_Endpoint11_Event (uint32_t event);
1955 extern void USBD_CustomClass2_Endpoint12_Event (uint32_t event);
1956 extern void USBD_CustomClass2_Endpoint13_Event (uint32_t event);
1957 extern void USBD_CustomClass2_Endpoint14_Event (uint32_t event);
1958 extern void USBD_CustomClass2_Endpoint15_Event (uint32_t event);
1959 
1960 extern void USBD_CustomClass3_Initialize (void);
1961 extern void USBD_CustomClass3_Uninitialize (void);
1962 extern void USBD_CustomClass3_Reset (void);
1963 extern void USBD_CustomClass3_EndpointStart (uint8_t ep_addr);
1964 extern void USBD_CustomClass3_EndpointStop (uint8_t ep_addr);
1965 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1966 extern void USBD_CustomClass3_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1967 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_OutDataReceived (uint32_t len);
1968 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_InDataSent (uint32_t len);
1969 extern void USBD_CustomClass3_Endpoint1_Event (uint32_t event);
1970 extern void USBD_CustomClass3_Endpoint2_Event (uint32_t event);
1971 extern void USBD_CustomClass3_Endpoint3_Event (uint32_t event);
1972 extern void USBD_CustomClass3_Endpoint4_Event (uint32_t event);
1973 extern void USBD_CustomClass3_Endpoint5_Event (uint32_t event);
1974 extern void USBD_CustomClass3_Endpoint6_Event (uint32_t event);
1975 extern void USBD_CustomClass3_Endpoint7_Event (uint32_t event);
1976 extern void USBD_CustomClass3_Endpoint8_Event (uint32_t event);
1977 extern void USBD_CustomClass3_Endpoint9_Event (uint32_t event);
1978 extern void USBD_CustomClass3_Endpoint10_Event (uint32_t event);
1979 extern void USBD_CustomClass3_Endpoint11_Event (uint32_t event);
1980 extern void USBD_CustomClass3_Endpoint12_Event (uint32_t event);
1981 extern void USBD_CustomClass3_Endpoint13_Event (uint32_t event);
1982 extern void USBD_CustomClass3_Endpoint14_Event (uint32_t event);
1983 extern void USBD_CustomClass3_Endpoint15_Event (uint32_t event);
1984 
1985 
1986 // USB Device library function prototypes for configuration generation
1987 extern usbStatus USBD_CustomClass_Initialize (uint8_t instance);
1988 extern usbStatus USBD_CustomClass_Uninitialize (uint8_t instance);
1989 extern void USBD_CustomClass_Reset (uint8_t instance);
1990 extern void USBD_CustomClass_EndpointStart (uint8_t instance, uint8_t ep_addr);
1991 extern void USBD_CustomClass_EndpointStop (uint8_t instance, uint8_t ep_addr);
1992 
1993 extern usbStatus USBD_ADC_Initialize (uint8_t instance);
1994 extern usbStatus USBD_ADC_Uninitialize (uint8_t instance);
1995 extern void USBD_ADC_Reset (uint8_t instance);
1996 extern void USBD_ADC_EndpointStart (uint8_t instance, uint8_t ep_addr);
1997 extern void USBD_ADC_EndpointStop (uint8_t instance, uint8_t ep_addr);
1998 
1999 extern usbStatus USBD_CDC_Initialize (uint8_t instance);
2000 extern usbStatus USBD_CDC_Uninitialize (uint8_t instance);
2001 extern void USBD_CDC_Reset (uint8_t instance);
2002 extern void USBD_CDC_EndpointStart (uint8_t instance, uint8_t ep_addr);
2003 extern void USBD_CDC_EndpointStop (uint8_t instance, uint8_t ep_addr);
2004 
2005 extern usbStatus USBD_HID_Initialize (uint8_t instance);
2006 extern usbStatus USBD_HID_Uninitialize (uint8_t instance);
2007 extern void USBD_HID_Reset (uint8_t instance);
2008 extern void USBD_HID_SetConfiguration (uint8_t instance);
2009 extern void USBD_HID_EndpointStart (uint8_t instance, uint8_t ep_addr);
2010 extern void USBD_HID_Timer (void const *argument);
2011 
2012 
2013 extern usbStatus USBD_MSC_Initialize (uint8_t instance);
2014 extern usbStatus USBD_MSC_Uninitialize (uint8_t instance);
2015 extern void USBD_MSC_Reset (uint8_t instance);
2016 extern void USBD_MSC_EndpointStart (uint8_t instance, uint8_t ep_addr);
2017 
2018 
2019 // USB Device library configuration generated function prototypes
2020 extern usbStatus USBD_ClassInitialize (uint8_t device);
2021 extern usbStatus USBD_ClassUninitialize (uint8_t device);
2022 extern void USBD_Reset (uint8_t device);
2023 extern void USBD_SetConfiguration (uint8_t device, uint8_t configuration);
2024 extern void USBD_EndpointStart (uint8_t device, uint8_t ep_addr);
2025 extern void USBD_EndpointStop (uint8_t device, uint8_t ep_addr);
2026 
2027 
2028 // USB Device thread function prototypes
2029 extern void USBD0_Core_Thread (void const *arg);
2030 extern void USBD1_Core_Thread (void const *arg);
2031 extern void USBD2_Core_Thread (void const *arg);
2032 extern void USBD3_Core_Thread (void const *arg);
2033 
2034 extern void USBD_ADC0_Thread (void const *arg);
2035 extern void USBD_ADC1_Thread (void const *arg);
2036 extern void USBD_ADC2_Thread (void const *arg);
2037 extern void USBD_ADC3_Thread (void const *arg);
2038 
2039 extern void USBD_CDC0_Int_Thread (void const *arg);
2040 extern void USBD_CDC1_Int_Thread (void const *arg);
2041 extern void USBD_CDC2_Int_Thread (void const *arg);
2042 extern void USBD_CDC3_Int_Thread (void const *arg);
2043 
2044 extern void USBD_CDC0_Bulk_Thread (void const *arg);
2045 extern void USBD_CDC1_Bulk_Thread (void const *arg);
2046 extern void USBD_CDC2_Bulk_Thread (void const *arg);
2047 extern void USBD_CDC3_Bulk_Thread (void const *arg);
2048 
2049 extern void USBD_HID0_Thread (void const *arg);
2050 extern void USBD_HID1_Thread (void const *arg);
2051 extern void USBD_HID2_Thread (void const *arg);
2052 extern void USBD_HID3_Thread (void const *arg);
2053 
2054 extern void USBD_MSC0_Thread (void const *arg);
2055 extern void USBD_MSC1_Thread (void const *arg);
2056 extern void USBD_MSC2_Thread (void const *arg);
2057 extern void USBD_MSC3_Thread (void const *arg);
2058 
2059 extern void USBD_CustomClass_EP_Thread (uint8_t instance);
2060 
2061 // USB Host OS abstraction functions
2062 extern osThreadId USBH_osThreadCreate (const osThreadDef_t *thread_def, void *argument);
2063 extern osThreadId USBH_osThreadGetId (void);
2064 extern osStatus USBH_osThreadTerminate (osThreadId thread_id);
2065 extern osStatus USBH_osThreadSetPriority (osThreadId thread_id, osPriority priority);
2066 extern osPriority USBH_osThreadGetPriority (osThreadId thread_id);
2067 extern osStatus USBH_osThreadYield (void);
2068 
2069 extern osStatus USBH_osDelay (uint32_t millisec);
2070 
2071 extern osTimerId USBH_osTimerCreate (const osTimerDef_t *timer_def, os_timer_type type, void *argument);
2072 extern osStatus USBH_osTimerStart (osTimerId timer_id, uint32_t millisec);
2073 extern osStatus USBH_osTimerStop (osTimerId timer_id);
2074 extern osStatus USBH_osTimerDelete (osTimerId timer_id);
2075 
2076 extern int32_t USBH_osSignalSet (osThreadId thread_id, int32_t signals);
2077 extern int32_t USBH_osSignalClear (osThreadId thread_id, int32_t signals);
2078 extern osEvent USBH_osSignalWait (int32_t signals, uint32_t millisec);
2079 
2080 extern osSemaphoreId USBH_osSemaphoreCreate (const osSemaphoreDef_t *semaphore_def, int32_t count);
2081 extern int32_t USBH_osSemaphoreWait (osSemaphoreId semaphore_id, uint32_t millisec);
2082 extern osStatus USBH_osSemaphoreRelease (osSemaphoreId semaphore_id);
2083 extern osStatus USBH_osSemaphoreDelete (osSemaphoreId semaphore_id);
2084 
2085 // USB Host thread function prototypes
2086 extern void USBH0_Core_Thread (void const *arg);
2087 extern void USBH1_Core_Thread (void const *arg);
2088 extern void USBH2_Core_Thread (void const *arg);
2089 extern void USBH3_Core_Thread (void const *arg);
2090 
2091 extern void USBH_CDC_IntIn_Thread (void const *arg);
2092 
2093 extern void USBH_HID_IntIn_Thread (void const *arg);
2094 
2095 #ifdef __cplusplus
2096 }
2097 #endif
2098 
2099 #endif
void USBD_CustomClassn_Endpoint9_Event(uint32_t event)
Request processed but busy.
Definition: rl_usb.h:83
Mass Storage Device (MSC) error (no device or device produced error)
Definition: rl_usb.h:53
bool USBD_CDCn_NCM_SetNtbInputSize(uint32_t ntb_input_size)
Callback function called upon USB Host request to select the maximum size of NTB that is permitted to...
void USBD_ADCn_PlayStop(void)
Callback function called when play stopped.
bool USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter(uint16_t filter_number, uint16_t *pattern_active)
Callback function called upon USB Host request to retrieve the status of the specified Ethernet power...
Function completed; time-out occurred.
Definition: rl_usb.h:36
usbStatus USBH_PipeDelete(uint8_t ctrl, USBH_PIPE *ptr_pipe)
Delete Pipe.
usbStatus USBD_CDC_ACM_Notify(uint8_t instance, uint16_t state)
Send notification of Communication Device status and line states to USB Host.
USB Setup Packet.
Definition: usb_structs.txt:7
uint32_t USBH_CDC_ACM_GetTxCount(uint8_t instance)
Get result of send data to Communication Device Class device.
uint8_t USBH_Device_GetPort(uint8_t device)
Get index of USB Host Root HUB port to which USB Device is connected.
void USBD_CDCn_ACM_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB CDC class instance (ACM) ...
CDC Line Coding structure.
Definition: usb_structs.txt:15
void USBH_MSC_Uninitialize(uint8_t instance)
Callback function called when Mass Storage Device was disconnected.
void USBD_MSCn_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB MSC class instance.
uint32_t USBD_ADC_WrittenSamplesPending(uint8_t instance)
Number of audio samples written and pending to be sent to USB Host.
usbStatus USBH_PipeAbort(uint8_t ctrl, const USBH_PIPE *ptr_pipe)
Abort send/receive operation on Pipe.
usbStatus USBH_PipeReceive(uint8_t ctrl, USBH_PIPE *ptr_pipe, uint8_t *buf, uint32_t len)
Receive data on Pipe.
uint32_t USBH_CDC_ACM_GetRxCount(uint8_t instance)
Get result of receive data from Communication Device Class device.
void USBD_CustomClassn_Endpoint12_Event(uint32_t event)
void USBD_Devicen_Reset(void)
Callback function called upon USB Bus Reset signaling.
void USBD_CustomClassn_Endpoint15_Event(uint32_t event)
void USBD_ADCn_SetSpeakerVolume(uint8_t ch, uint16_t vol)
Callback function called when speaker volume setting changed.
void USBD_Devicen_Suspended(void)
Callback function called when USB Bus goes into suspend mode (no bus activity for 3 ms) ...
void USBH_Port_Notify(uint8_t ctrl, uint8_t port, USBH_NOTIFY notify)
Callback function called when some event has happened on corresponding controller and port...
Invalid Parameter error: a mandatory parameter was missing or specified an incorrect object...
Definition: rl_usb.h:37
usbStatus USBH_Initialize(uint8_t ctrl)
Initialize USB Host stack and controller.
void USBD_CDCn_NCM_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB CDC class instance (NCM) ...
void USBD_HIDn_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB HID class instance...
int32_t USBD_CDC_NCM_NTB_IN_IsSent(uint8_t instance)
Check if NTB was sent and new NTB can be prepared.
Function completed with no error.
Definition: rl_usb.h:34
usbStatus USBH_CDC_ACM_SetLineCoding(uint8_t instance, const CDC_LINE_CODING *line_coding)
Change communication settings of Communication Device Class device.
uint32_t USBD_CDC_NCM_NTB_OUT_RawGetSize(uint8_t instance)
Get size of the received NTB.
int32_t USBD_CDC_NCM_NTB_OUT_IsReceived(uint8_t instance)
Check if NTB was received and is available for processing.
void USBD_CustomClassn_Endpoint0_SetupPacketProcessed(const USB_SETUP_PACKET *setup_packet)
Callback function called when a SETUP PACKET was processed by USB library.
usbStatus USBH_PipeModify(uint8_t ctrl, USBH_PIPE *ptr_pipe, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint16_t ep_max_packet_size)
Modify Pipe.
usbStatus USBH_DefaultPipeSendSetup(uint8_t ctrl, const USB_SETUP_PACKET *setup_packet)
Send Setup Packet on Default Pipe.
uint8_t USBH_Device_GetAddress(uint8_t device)
Get communication address of USB Device.
void USBD_MSCn_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB MSC class instance...
usbStatus USBH_DefaultPipeSend(uint8_t ctrl, const uint8_t *buf, uint32_t len)
Send data on Default Pipe.
bool USBD_CDCn_NCM_SetEthernetPacketFilter(uint16_t packet_filter_bitmap)
Callback function called upon USB Host request to configure device Ethernet packet filter settings...
bool USBD_CDCn_NCM_GetCrcMode(uint16_t *crc_mode)
Callback function called upon USB Host request to return the currently selected CRC mode...
int USBD_CDC_ACM_GetChar(uint8_t instance)
Read one character received by Communication Device from USB Host.
void USBD_Devicen_HighSpeedActivated(void)
Callback function called when USB Bus speed has changed to high-speed.
uint32_t USBD_EndpointReadGetResult(uint8_t device, uint8_t ep_addr)
Get result of read operation on Endpoint.
int32_t USBD_CDC_NCM_NTB_OUT_ProcessNDP(uint8_t instance)
Process the next NDP in the received NTB.
void USBD_CustomClassn_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB Custom class instance...
usbStatus USBH_DefaultPipeReceive(uint8_t ctrl, uint8_t *buf, uint32_t len)
Receive data on Default Pipe.
usbStatus USBD_Connect(uint8_t device)
Activate pull-up on D+ or D- line to signal USB Device connection on USB Bus.
Controller does not exist.
Definition: rl_usb.h:44
Unspecified USB error.
Definition: rl_usb.h:60
CMSIS-RTOS Semaphore creation failed.
Definition: rl_usb.h:41
void USBD_Devicen_DisableRemoteWakeup(void)
Callback function called when Clear Feature for Remote Wakeup was requested over Control Endpoint 0...
uint32_t USBD_EndpointWriteGetResult(uint8_t device, uint8_t ep_addr)
Get result of write operation on Endpoint.
usbStatus USBH_DeviceRequest_GetConfiguration(uint8_t ctrl, uint8_t *ptr_configuration)
Standard Device Request on Default Pipe - GET_CONFIGURATION.
usbStatus USBH_MSC_GetStatus(uint8_t instance)
Get status of Mass Storage Device.
uint8_t USBH_CustomClass_Configure(const USBH_DEV *ptr_dev, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc)
Callback function called when custom class device is connected and needs to configure resources used ...
void USBD_CustomClassn_Endpoint3_Event(uint32_t event)
void USBH_CDC_ACM_Notify(uint8_t instance, uint16_t status)
Callback function called when Communication Device Class device modem line or error status changes...
void USBD_ADCn_SetMicrophoneVolume(uint8_t ch, uint16_t vol)
Callback function called when microphone volume setting changed.
uint32_t USBH_DefaultPipeSendGetResult(uint8_t ctrl)
Get result of send data operation on Default Pipe.
int32_t USBD_CDC_NCM_NTB_IN_CreateNDP(uint8_t instance, uint8_t num_datagrams)
Create a new NDP in the NTB (datagrams can be added to it)
void USBD_CDCn_ACM_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB CDC class instance (ACM) ...
void USBD_Devicen_EnableRemoteWakeup(void)
Callback function called when Set Feature for Remote Wakeup was requested over Control Endpoint 0...
uint8_t USBH_CustomClass_GetDevice(uint8_t instance)
Get Device instance of Custom Class Device.
usbdRequestStatus USBD_Devicen_Endpoint0_SetupPacketReceived(const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len)
Callback function called when Device received SETUP PACKET on Control Endpoint 0. ...
usbStatus USBH_DeviceRequest_ClearFeature(uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t feature_selector)
Standard Device Request on Default Pipe - CLEAR_FEATURE.
Request from periodic update.
Definition: rl_usb.h:94
void USBH_HID_Uninitialize(uint8_t instance)
Callback function called when Human Interface Device was disconnected.
CMSIS-RTOS Thread creation/termination failed.
Definition: rl_usb.h:39
void USBD_CustomClassn_Endpoint13_Event(uint32_t event)
void USBH_HID_ParseReportDescriptor(uint8_t instance, const uint8_t *ptr_hid_report_desc, uint32_t len)
Callback function called for parsing of the Human Interface Device report descriptor.
int16_t y
Absolute Y position change.
Definition: rl_usb.h:1217
void USBD_Devicen_ConfigurationChanged(uint8_t val)
Callback function called when Device configuration has changed.
void USBD_CustomClassn_Endpoint1_Event(uint32_t event)
Callback function called when DATA was sent or received on Endpoint n.
usbStatus USBD_EndpointStall(uint8_t device, uint8_t ep_addr, bool stall)
Set/Clear stall on Endpoint.
void USBD_CustomClassn_Endpoint14_Event(uint32_t event)
usbStatus USBD_EndpointRead(uint8_t device, uint8_t ep_addr, uint8_t *buf, uint32_t len)
Start reception on Endpoint.
void USBD_CustomClassn_Endpoint10_Event(uint32_t event)
bool USBD_MSCn_Read(uint32_t lba, uint32_t cnt, uint8_t *buf)
Callback function called to read data from media.
void USBD_ADCn_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB ADC class instance.
USBD_STATE USBD_GetState(uint8_t device)
Retrieve USB Device state.
usbStatus USBD_Initialize(uint8_t device)
Initialize USB Device stack and controller.
usbStatus USBH_MSC_Write(uint8_t instance, uint32_t lba, uint32_t cnt, const uint8_t *buf)
Write requested number of blocks to Mass Storage Device.
bool USBD_CDCn_NCM_GetNetAddress(uint8_t *net_addr)
Callback function called upon USB Host request to return the USB Device's current EUI-48 station addr...
usbStatus USBH_MSC_Read(uint8_t instance, uint32_t lba, uint32_t cnt, uint8_t *buf)
Read requested number of blocks from Mass Storage Device.
void USBD_ADCn_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB ADC class instance...
uint8_t USBH_HID_GetDevice(uint8_t instance)
Get Device instance of Human Interface Device.
usbStatus USBH_PipeSend(uint8_t ctrl, USBH_PIPE *ptr_pipe, const uint8_t *buf, uint32_t len)
Send data on Pipe.
usbStatus USBH_CDC_ACM_SetControlLineState(uint8_t instance, uint16_t state)
Set control line states of Communication Device Class device.
USB Host Pipe settings structure.
Definition: usb_structs.txt:23
void USBD_ADCn_SetMicrophoneMute(uint8_t ch, bool on)
Callback function called when microphone mute setting changed.
usbdRequestStatus USBD_CustomClassn_Endpoint0_InDataSent(uint32_t len)
Callback function called when IN DATA was sent on Control Endpoint 0.
Request not processed.
Definition: rl_usb.h:80
int32_t USBD_CDC_NCM_NTB_IN_Send(uint8_t instance)
Send the active NTB.
int32_t USBH_Device_GetSpeed(uint8_t device)
Get communication speed of USB Device.
bool USBD_HIDn_SetReport(uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len)
Callback function called to process received HID Report data.
Audio Device Class (ADC) error (no device or device produced error)
Definition: rl_usb.h:50
void USBD_CDCn_NCM_Start(void)
Callback function called when USB Host changes data interface from alternate 0 to alternate 1 (activa...
bool USBD_MSCn_GetCacheInfo(uint32_t *buffer, uint32_t *size)
Callback function called to get cache information.
void USBD_ADCn_PlayStart(void)
Callback function called when play started.
bool USBD_CDCn_ACM_SetControlLineState(uint16_t state)
Callback function called upon USB Host request to set control line states.
bool USBD_Configured(uint8_t device)
Retrieve USB Device configuration status.
uint8_t USBH_MSC_GetDevice(uint8_t instance)
Get Device instance of Mass Storage Device.
uint32_t USBH_PipeSendGetResult(uint8_t ctrl, const USBH_PIPE *ptr_pipe)
Get result of send data operation on Pipe.
int32_t USBD_CDC_NCM_Notify_ConnectionSpeedChange(uint8_t instance, uint32_t us_bitrate, uint32_t ds_bitrate)
Report a change in upstream or downstream speed of the networking connection to the USB Host...
usbdRequestStatus USBD_CustomClassn_Endpoint0_SetupPacketReceived(const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len)
Callback function called when a SETUP PACKET was received on Control Endpoint 0.
Definition: usb_structs.txt:1
usbStatus USBH_Port_Resume(uint8_t ctrl, uint8_t port)
Resume a root HUB port on specified controller.
usbStatus USBH_HID_GetStatus(uint8_t instance)
Get status of Human Interface Device.
usbStatus USBH_Uninitialize(uint8_t ctrl)
De-initialize USB Host stack and controller.
usbStatus USBH_CustomClass_GetStatus(uint8_t instance)
Get status of Custom Class Device.
void USBH_MSC_Initialize(uint8_t instance)
Callback function called when Mass Storage Device was enumerated and is ready.
uint32_t USBD_CDC_NCM_NTB_OUT_GetDatagramSize(uint8_t instance)
Get size of a datagram from the active NDP of the received NTB.
usbStatus USBH_DeviceRequest_SetAddress(uint8_t ctrl, uint8_t device_address)
Standard Device Request on Default Pipe - SET_ADDRESS.
void USBD_CustomClassn_EndpointStop(uint8_t ep_addr)
Callback function called when Endpoint Stop was requested (by de-activating interface or activating c...
void USBD_CDCn_NCM_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB CDC class instance (NCM) ...
usbStatus USBH_CDC_ACM_Send(uint8_t instance, const uint8_t *data, uint32_t num)
Send data to Communication Device Class device.
usbStatus USBH_CDC_ACM_GetLineCoding(uint8_t instance, CDC_LINE_CODING *line_coding)
Retrieve communication settings of Communication Device Class device.
usbStatus USBD_Disconnect(uint8_t device)
Disconnect USB Device from USB Bus.
int32_t USBD_ADC_ReadSamples(uint8_t instance, void *buf, int32_t num)
Read audio samples received from USB Host.
bool USBD_CDCn_ACM_SetLineCoding(const CDC_LINE_CODING *line_coding)
Callback function called upon USB Host request to change communication settings.
int USBH_HID_GetKeyboardKey(uint8_t instance)
Retrieve first pending pressed keyboard key on HID Keyboard.
void USBD_CDCn_NCM_NTB_OUT_Received(void)
Callback function called when NTB was successfully received.
usbStatus USBD_EndpointAbort(uint8_t device, uint8_t ep_addr)
Abort read/write operation on Endpoint.
usbStatus USBH_Device_GetStatus(uint8_t device)
Get status of USB Device.
CMSIS-RTOS Mutex creation failed.
Definition: rl_usb.h:42
uint16_t USBH_Device_GetPID(uint8_t device)
Get Product ID (PID) of USB Device.
void USBD_ADCn_SetSpeakerMute(uint8_t ch, bool on)
Callback function called when speaker mute setting changed.
void USBH_HID_DataReceived(uint8_t instance, uint32_t len)
Callback function called when data is received from the Human Interface Device.
uint8_t button
Current button states.
Definition: rl_usb.h:1215
void USBD_CustomClassn_Endpoint7_Event(uint32_t event)
bool USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter(uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size)
Callback function called upon USB Host request to set up the specified Ethernet power management patt...
void USBD_CustomClassn_Endpoint11_Event(uint32_t event)
bool USBD_MSCn_Write(uint32_t lba, uint32_t cnt, const uint8_t *buf)
Callback function called to write data to media.
Communication Device Class (CDC) error (no device or device produced error)
Definition: rl_usb.h:51
Request from control endpoint.
Definition: rl_usb.h:92
void USBH_HID_Initialize(uint8_t instance)
Callback function called when Human Interface Device was enumerated and is ready. ...
void USBD_Devicen_Resumed(void)
Callback function called when USB Bus activity has resumed.
void USBD_CDCn_NCM_Reset(void)
Callback function called upon USB Bus Reset signaling.
void USBD_Devicen_VbusChanged(bool level)
Callback function called when VBUS level changes.
usbdRequestStatus
Definition: rl_usb.txt:6511
usbdRequestStatus USBD_Devicen_Endpoint0_InDataSent(uint32_t len)
Callback function called when Device sent IN DATA on Control Endpoint 0.
int32_t USBD_CDC_ACM_ReadData(uint8_t instance, uint8_t *buf, int32_t len)
Read multiple data bytes received by Communication Device from USB Host.
int32_t USBD_CDC_ACM_DataAvailable(uint8_t instance)
Retrieve number of data bytes received by Communication Device from USB Host that are available to re...
bool USBD_CDCn_NCM_SetMaxDatagramSize(uint16_t max_datagram_size)
Callback function called upon USB Host request to select the maximum datagram size that can be sent i...
int32_t USBD_CDC_NCM_Notify_NetworkConnection(uint8_t instance, uint16_t status)
Report whether or not the physical layer (modem, Ethernet PHY, etc.) link is up to the USB Host...
void USBD_CustomClassn_Endpoint6_Event(uint32_t event)
usbStatus USBH_DeviceRequest_SetFeature(uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t feature_selector)
Standard Device Request on Default Pipe - SET_FEATURE.
CMSIS-RTOS Timer creation/deletion failed.
Definition: rl_usb.h:40
bool USBD_MSCn_GetMediaCapacity(uint32_t *block_count, uint32_t *block_size)
Callback function called to get media capacity.
bool USBD_CDCn_NCM_SetNtbFormat(uint16_t ntb_format)
Callback function called upon USB Host request to select the format of NTB to be used for NTBs transm...
usbStatus USBH_CDC_ACM_SendBreak(uint8_t instance, uint16_t duration)
Send break on Communication Device Class device.
usbStatus USBH_CDC_ACM_GetStatus(uint8_t instance)
Get status of Communication Device Class device.
bool USBD_CDCn_NCM_GetMaxDatagramSize(uint16_t *max_datagram_size)
Callback function called upon USB Host request to return the currently effective maximum datagram siz...
void USBD_CustomClassn_Endpoint5_Event(uint32_t event)
void USBD_ADCn_RecordStart(void)
Callback function called when recording started.
int32_t USBH_HID_Write(uint8_t instance, const uint8_t *buf, int32_t len)
Write data to Human Interface Device.
uint32_t USBH_PipeReceiveGetResult(uint8_t ctrl, const USBH_PIPE *ptr_pipe)
Get result of receive data operation on Pipe.
usbStatus USBH_DeviceRequest_GetDescriptor(uint8_t ctrl, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, uint8_t *descriptor_data, uint16_t descriptor_length)
Standard Device Request on Default Pipe - GET_DESCRIPTOR.
bool USBD_CDCn_NCM_GetNtbInputSize(uint32_t *ntb_input_size)
Callback function called upon USB Host request to return NTB input size currently being used...
bool USBD_CDCn_NCM_SetCrcMode(uint16_t crc_mode)
Callback function called upon USB Host request to control CRC mode.
Request processed and OK.
Definition: rl_usb.h:81
usbStatus USBH_DeviceRequest_SetDescriptor(uint8_t ctrl, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, const uint8_t *descriptor_data, uint16_t descriptor_length)
Standard Device Request on Default Pipe - SET_DESCRIPTOR.
void USBD_CDCn_ACM_DataReceived(uint32_t len)
Callback function called when new data was received.
usbStatus USBH_CustomClass_Initialize(uint8_t instance)
Callback function called when custom class device is connected and needs to initialize custom class d...
bool USBD_CDCn_NCM_GetEthernetStatistic(uint16_t feature_selector, uint32_t *data)
Callback function called upon USB Host request to retrieve a statistic based on the feature selector...
void USBD_Devicen_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB Device.
USB Host Device Instance (DEV) structure.
Definition: usb_structs.txt:38
usbStatus USBD_Uninitialize(uint8_t device)
De-initialize USB Device stack and controller.
Device is not configured (is connected)
Definition: rl_usb.h:49
usbStatus USBH_ControlTransfer(uint8_t ctrl, const USB_SETUP_PACKET *setup_packet, uint8_t *data, uint32_t len)
Do a Control Transfer on Default Pipe.
Mouse state information.
Definition: rl_usb.h:1213
uint8_t USBH_Device_GetController(uint8_t device)
Get index of USB Host controller to which USB Device is connected.
usbStatus
Definition: rl_usb.txt:6513
usbdRequestStatus USBD_Devicen_Endpoint0_OutDataReceived(uint32_t len)
Callback function called when Device received OUT DATA on Control Endpoint 0.
void USBH_CDC_ACM_Uninitialize(uint8_t instance)
Callback function called when Communication Device Class device was disconnected. ...
usbStatus USBH_DeviceRequest_GetInterface(uint8_t ctrl, uint8_t index, uint8_t *ptr_alternate)
Standard Device Request on Default Pipe - GET_INTERFACE.
usbStatus USBH_DeviceRequest_SynchFrame(uint8_t ctrl, uint8_t index, uint8_t *ptr_frame_number)
Standard Device Request on Default Pipe - SYNCH_FRAME.
void USBD_CustomClassn_Endpoint4_Event(uint32_t event)
void USBD_CustomClassn_Reset(void)
Callback function called upon USB Bus Reset signaling.
void USBD_CustomClassn_Endpoint8_Event(uint32_t event)
uint32_t USBH_DefaultPipeReceiveGetResult(uint8_t ctrl)
Get result of receive data operation on Default Pipe.
usbStatus USBH_MSC_ReadCapacity(uint8_t instance, uint32_t *block_count, uint32_t *block_size)
Read capacity of Mass Storage Device.
void USBD_ADCn_ReceivedSamples(void)
Callback function called when data in USB buffer for speaker samples reaches half-full from empty...
int32_t USBD_CDC_NCM_NTB_IN_WriteDatagram(uint8_t instance, const uint8_t *buf, uint32_t len)
Add a datagram into the active NDP of the NTB to be sent.
Custom device Class (Class) error (no device or device produced error)
Definition: rl_usb.h:54
Request processed but unsupported.
Definition: rl_usb.h:82
uint32_t USBD_MSCn_CheckMedia(void)
Callback function called to check media presence and write protect status.
void USBD_Devicen_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB Device.
Request from interrupt endpoint.
Definition: rl_usb.h:93
usbdRequestStatus USBD_CustomClassn_Endpoint0_OutDataReceived(uint32_t len)
Callback function called when OUT DATA was received on Control Endpoint 0.
Device does not exist.
Definition: rl_usb.h:45
bool USBD_CDCn_NCM_SetNetAddress(const uint8_t *net_addr)
Callback function called upon USB Host request to set the USB Device's current EUI-48 station address...
usbStatus USBH_PipeReset(uint8_t ctrl, USBH_PIPE *ptr_pipe)
Reset Pipe (reset data toggle)
void USBD_Devicen_Endpoint0_SetupPacketProcessed(const USB_SETUP_PACKET *setup_packet)
Callback function called when SETUP PACKET was processed by USB library.
usbStatus USBD_HID_GetReportTrigger(uint8_t instance, uint8_t rid, const uint8_t *buf, uint32_t len)
Asynchronously prepare HID Report data to send.
usbStatus USBH_CustomClass_Unconfigure(uint8_t instance)
Callback function called when custom class device is disconnected and needs to de-configure resources...
Memory management function produced error.
Definition: rl_usb.h:48
usbStatus USBD_ADC_SetMicrophoneVolumeRange(uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur)
Set range for microphone volume (level) control.
USBD_HID_REQ_t
Definition: rl_usb.txt:6512
usbStatus USBH_DefaultPipeAbort(uint8_t ctrl)
Abort send/receive operation on Default Pipe.
bool USBD_CDCn_NCM_GetNtbFormat(uint16_t *ntb_format)
Callback function called upon USB Host request to return the NTB data format currently being used...
Transfer error.
Definition: rl_usb.h:58
bool USBD_CDCn_NCM_SetEthernetMulticastFilters(const uint8_t *addr_list, uint16_t num_of_filters)
Callback function called upon USB Host request to set the Ethernet device multicast filters...
usbStatus USBH_DeviceRequest_GetStatus(uint8_t ctrl, uint8_t recipient, uint8_t index, uint8_t *ptr_stat_dat)
Standard Device Request on Default Pipe - GET_STATUS.
void USBD_ADCn_RecordStop(void)
Callback function called when recording stopped.
void USBD_CDCn_NCM_NTB_IN_Sent(void)
Callback function called when NTB was successfully sent.
int32_t USBD_CDC_NCM_NTB_IN_RawSend(uint8_t instance, const uint8_t *buf, uint32_t len)
Send already prepared NTB (for this option value of define in configuration USBD_CDCn_NCM_RAW_ENABLE ...
int32_t USBD_HIDn_GetReport(uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf)
Callback function called to prepare HID Report data to send.
void USBD_CustomClassn_EndpointStart(uint8_t ep_addr)
Callback function called when Endpoint Start was requested (by activating interface or configuration)...
void USBD_CDCn_ACM_DataSent(void)
Callback function called when all data was sent.
void USBD_HIDn_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB HID class instance.
bool USBD_CDCn_ACM_GetLineCoding(CDC_LINE_CODING *line_coding)
Callback function called upon USB Host request to retrieve communication settings.
usbStatus USBH_HID_GetMouseState(uint8_t instance, usbHID_MouseState *state)
Retrieve state change since last call of this function.
void USBD_CDCn_ACM_Reset(void)
Callback function called upon USB Bus Reset signaling.
int16_t x
Absolute X position change.
Definition: rl_usb.h:1216
int32_t USBD_CDC_NCM_NTB_OUT_RawReceive(uint8_t instance, uint8_t *buf, uint32_t max_len)
Receive an NDP (for this option value of define in configuration USBD_CDCn_NCM_RAW_ENABLE has to be 1...
uint8_t reserved
Reserved byte (for alignment)
Definition: rl_usb.h:1214
void USBH_CDC_ACM_Initialize(uint8_t instance)
Callback function called when Communication Device Class device was enumerated and is ready...
Driver function produced error.
Definition: rl_usb.h:46
int32_t USBH_HID_Read(uint8_t instance, uint8_t *buf, int32_t len)
Read data received from Human Interface Device.
int32_t USBD_CDC_NCM_NTB_OUT_ReadDatagram(uint8_t instance, uint8_t *buf, uint32_t max_len)
Read a datagram from the active NDP of the received NTB.
Driver function is busy.
Definition: rl_usb.h:47
int32_t USBD_ADC_WriteSamples(uint8_t instance, const void *buf, int32_t num)
Write audio samples to be transferred to USB Host.
uint8_t USBH_CDC_ACM_GetDevice(uint8_t instance)
Get Device instance of Communication Device Class device.
USBH_PIPE * USBH_PipeCreate(uint8_t ctrl, uint8_t dev_addr, uint8_t dev_speed, uint8_t hub_addr, uint8_t hub_port, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)
Create Pipe.
uint32_t USBD_ADC_ReceivedSamplesAvailable(uint8_t instance)
Number of audio samples received from USB Host and available to be read.
Transfer handshake was stall.
Definition: rl_usb.h:57
usbStatus USBH_DeviceRequest_SetInterface(uint8_t ctrl, uint8_t index, uint8_t alternate)
Standard Device Request on Default Pipe - SET_INTERFACE.
usbStatus USBD_ADC_SetSpeakerVolumeRange(uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur)
Set range for speaker volume control.
usbStatus USBH_DeviceRequest_SetConfiguration(uint8_t ctrl, uint8_t configuration)
Standard Device Request on Default Pipe - SET_CONFIGURATION.
int USBD_CDC_ACM_PutChar(uint8_t instance, int ch)
Write a single character from Communication Device to USB Host.
void USBD_CustomClassn_Initialize(void)
Callback function called during USBD_Initialize to initialize the USB Custom class instance...
int32_t USBD_CDC_ACM_WriteData(uint8_t instance, const uint8_t *buf, int32_t len)
Write data from Communication Device to USB Host.
void USBD_CDCn_NCM_Stop(void)
Callback function called when USB Host changes data interface from alternate 1 to alternate 0 (de-act...
Unsupported Class.
Definition: rl_usb.h:55
usbStatus USBH_CustomClass_Uninitialize(uint8_t instance)
Callback function called when custom class device is disconnected and needs to de-initialize custom c...
uint16_t USBH_Device_GetVID(uint8_t device)
Get Vendor ID (VID) of USB Device.
usbStatus USBD_EndpointWrite(uint8_t device, uint8_t ep_addr, const uint8_t *buf, uint32_t len)
Start write on Endpoint.
usbStatus USBH_CDC_ACM_Receive(uint8_t instance, uint8_t *data, uint32_t num)
Receive data from Communication Device Class device.
bool USBD_CDCn_NCM_GetNtbParameters(CDC_NCM_NTB_PARAM *ntb_params)
Callback function called upon USB Host request to retrieve the parameters that describe NTBs for each...
int32_t USBD_CDC_NCM_NTB_OUT_Release(uint8_t instance)
Flush the received NTB and release memory for reception of a new NTB.
void USBD_CustomClassn_Endpoint2_Event(uint32_t event)
usbStatus USBH_Port_Suspend(uint8_t ctrl, uint8_t port)
Suspend a root HUB port on specified controller.
Human Interface Device (HID) error (no device or device produced error)
Definition: rl_usb.h:52
int32_t USBD_CDC_NCM_NTB_IN_Initialize(uint8_t instance)
Clear the active NTB (prepared for sending)