USB Component  Version 6.11.0
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-2017 ARM Germany GmbH. All rights reserved.
4  *------------------------------------------------------------------------------
5  * Name: rl_usb.h
6  * Purpose: USB User API
7  *----------------------------------------------------------------------------*/
8 
9 #ifndef __RL_USB_H__
10 #define __RL_USB_H__
11 
12 
13 #ifdef __cplusplus
14 extern "C" {
15 #endif
16 
17 #include <stdint.h>
18 #include <stdbool.h>
19 
20 #include "usb_compiler.h"
21 #include "usb_os.h"
22 #include "usb_def.h"
23 #include "usb_cdc.h"
24 #include "usb_hid.h"
25 #include "usb_msc.h"
26 
27 
29 
31 typedef enum {
32  usbOK = 0U,
33 
36 
37  usbThreadError = 0x10U,
41 
54 
55  usbTransferStall = 0x40U,
57 
58  usbUnknownError = 0xFFU
59 } usbStatus;
60 
62 #ifdef __BIG_ENDIAN
63  #define U32_LE(v) (uint32_t)(__REV(v))
64  #define U16_LE(v) (uint16_t)(__REV(v) >> 16)
65  #define U32_BE(v) (uint32_t)(v)
66  #define U16_BE(v) (uint16_t)(v)
67 #else
68  #define U32_BE(v) (uint32_t)(__REV(v))
69  #define U16_BE(v) (uint16_t)(__REV(v) >> 16)
70  #define U32_LE(v) (uint32_t)(v)
71  #define U16_LE(v) (uint16_t)(v)
72 #endif
73 
74 // ==== USB Device Constants and Defines ====
75 
77 typedef enum {
83 
85 #define USBD_MSC_MEDIA_READY (1UL)
86 #define USBD_MSC_MEDIA_PROTECTED (1UL<<1)
87 
88 typedef enum {
94 
96 typedef enum {
97  usbdThreadCore = 0U,
98  usbdThreadCC,
99  usbdThreadADC,
100  usbdThreadCDC_Int,
101  usbdThreadCDC_Bulk,
102  usbdThreadHID,
103  usbdThreadMSC
104 } usbdThread_t;
105 
107 typedef enum {
108  usbdSemaphoreCore = 0U,
109  usbdSemaphoreEndpoint,
110  usbdSemaphoreHID
111 } usbdSemaphore_t;
112 
113 /* USB Device State structure */
115 typedef struct {
116  uint32_t vbus : 1;
117  uint32_t speed : 2;
118  uint32_t active : 1;
119  uint32_t reserved : 28;
120 } USBD_STATE;
122 
123 /* USB Host Constants and Defines */
124 
126 typedef enum {
127  USBH_NOTIFY_CONNECT = 0U,
128  USBH_NOTIFY_DISCONNECT,
129  USBH_NOTIFY_OVERCURRENT,
130  USBH_NOTIFY_REMOTE_WAKEUP,
131  USBH_NOTIFY_READY,
132  USBH_NOTIFY_UNKNOWN_DEVICE,
133  USBH_NOTIFY_INSUFFICIENT_POWER,
134  USBH_NOTIFY_CONFIGURATION_FAILED,
135  USBH_NOTIFY_INITIALIZATION_FAILED
136 } USBH_NOTIFY;
137 
138 /* USB Host Pipe handle type */
139 typedef uint32_t USBH_PIPE_HANDLE;
140 
142 typedef enum {
143  usbhThreadCore = 0U,
144  usbhThreadCDC,
145  usbhThreadHID
146 } usbhThread_t;
147 
149 typedef enum {
150  usbhMutexCore = 0U
151 } usbhMutex_t;
152 
154 typedef enum {
155  usbhSemaphoreCore = 0U
156 } usbhSemaphore_t;
157 
159 typedef struct {
160  uint8_t reserved;
161  uint8_t button;
162  int16_t x;
163  int16_t y;
165 
166 
167 // ==== USB Device Functions ====
168 
171 extern uint32_t USBD_GetVersion (void);
172 
176 extern usbStatus USBD_Initialize (uint8_t device);
177 
181 extern usbStatus USBD_Uninitialize (uint8_t device);
182 
186 extern usbStatus USBD_Connect (uint8_t device);
187 
191 extern usbStatus USBD_Disconnect (uint8_t device);
192 
198 extern bool USBD_Configured (uint8_t device);
199 
203 extern USBD_STATE USBD_GetState (uint8_t device);
204 
205 #ifdef __DOXYGEN__
206 
207 // following functions are available for each instance of a Device.
208 // generic prefix USBD_Devicen is USBD_Device0 for Device instance 0.
209 
212 void USBD_Devicen_Initialize (void);
213 
216 void USBD_Devicen_Uninitialize (void);
217 
223 void USBD_Devicen_VbusChanged (bool level);
224 
227 void USBD_Devicen_Reset (void);
228 
232 
235 void USBD_Devicen_Suspended (void);
236 
239 void USBD_Devicen_Resumed (void);
240 
246 void USBD_Devicen_ConfigurationChanged (uint8_t val);
247 
251 
255 
264 usbdRequestStatus USBD_Devicen_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
265 
270 
278 usbdRequestStatus USBD_Devicen_Endpoint0_OutDataReceived (uint32_t len);
279 
287 usbdRequestStatus USBD_Devicen_Endpoint0_InDataSent (uint32_t len);
288 
289 #endif // __DOXYGEN
290 
291 // ==== USB Device Audio Device Functions ====
292 
293 #ifdef __DOXYGEN__
294 
295 // following functions are available for each instance of a ADC class.
296 // generic prefix USBD_ADCn is USBD_ADC0 for ADC class instance 0.
297 
300 void USBD_ADCn_Initialize (void);
301 
304 void USBD_ADCn_Uninitialize (void);
305 
308 void USBD_ADCn_PlayStart (void);
309 
312 void USBD_ADCn_PlayStop (void);
313 
323 void USBD_ADCn_SetSpeakerMute (uint8_t ch, bool on);
324 
332 void USBD_ADCn_SetSpeakerVolume (uint8_t ch, uint16_t vol);
333 
336 void USBD_ADCn_RecordStart (void);
337 
340 void USBD_ADCn_RecordStop (void);
341 
351 void USBD_ADCn_SetMicrophoneMute (uint8_t ch, bool on);
352 
360 void USBD_ADCn_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
361 
364 void USBD_ADCn_ReceivedSamples (void);
365 
366 #endif // __DOXYGEN
367 
368 // Rename deprecated functions
369 #define USBD_ADC_SpeakerSetVolumeRange USBD_ADC_SetSpeakerVolumeRange
370 #define USBD_ADC_MicrophoneSetVolumeRange USBD_ADC_SetMicrophoneVolumeRange
371 
383 extern usbStatus USBD_ADC_SetSpeakerVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur);
384 
396 extern usbStatus USBD_ADC_SetMicrophoneVolumeRange (uint8_t instance, uint8_t ch, uint16_t min, uint16_t max, uint16_t res, uint16_t cur);
397 
401 extern uint32_t USBD_ADC_ReceivedSamplesAvailable (uint8_t instance);
402 
406 extern uint32_t USBD_ADC_WrittenSamplesPending (uint8_t instance);
407 
415 extern int32_t USBD_ADC_ReadSamples (uint8_t instance, void *buf, int32_t num);
416 
424 extern int32_t USBD_ADC_WriteSamples (uint8_t instance, const void *buf, int32_t num);
425 
426 
427 // ==== USB Device Communication Device (Abstract Control Model) Functions ====
428 
429 #ifdef __DOXYGEN__
430 
431 // following functions are available for each instance of a CDC class.
432 // generic prefix USBD_CDCn is USBD_CDC0 for CDC class instance 0.
433 
436 void USBD_CDCn_ACM_Initialize (void);
437 
440 void USBD_CDCn_ACM_Uninitialize (void);
441 
444 void USBD_CDCn_ACM_Reset (void);
445 
451 bool USBD_CDCn_ACM_SetLineCoding (const CDC_LINE_CODING *line_coding);
452 
458 bool USBD_CDCn_ACM_GetLineCoding (CDC_LINE_CODING *line_coding);
459 
467 bool USBD_CDCn_ACM_SetControlLineState (uint16_t state);
468 
472 void USBD_CDCn_ACM_DataReceived (uint32_t len);
473 
476 void USBD_CDCn_ACM_DataSent (void);
477 
480 void USBD_CDCn_NCM_Initialize (void);
481 
484 void USBD_CDCn_NCM_Uninitialize (void);
485 
488 void USBD_CDCn_NCM_Reset (void);
489 
492 void USBD_CDCn_NCM_Start (void);
493 
496 void USBD_CDCn_NCM_Stop (void);
497 
504 bool USBD_CDCn_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
505 
513 bool USBD_CDCn_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
514 
521 bool USBD_CDCn_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
522 
528 bool USBD_CDCn_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
529 
536 bool USBD_CDCn_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
537 
543 bool USBD_CDCn_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
544 
550 bool USBD_CDCn_NCM_GetNetAddress (uint8_t *net_addr);
551 
557 bool USBD_CDCn_NCM_SetNetAddress (const uint8_t *net_addr);
558 
564 bool USBD_CDCn_NCM_GetNtbFormat (uint16_t *ntb_format);
565 
573 bool USBD_CDCn_NCM_SetNtbFormat (uint16_t ntb_format);
574 
580 bool USBD_CDCn_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
581 
587 bool USBD_CDCn_NCM_SetNtbInputSize (uint32_t ntb_input_size);
588 
594 bool USBD_CDCn_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
595 
601 bool USBD_CDCn_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
602 
608 bool USBD_CDCn_NCM_GetCrcMode (uint16_t *crc_mode);
609 
617 bool USBD_CDCn_NCM_SetCrcMode (uint16_t crc_mode);
618 
621 void USBD_CDCn_NCM_NTB_IN_Sent (void);
622 
626 
627 #endif // __DOXYGEN
628 
634 extern int USBD_CDC_ACM_GetChar (uint8_t instance);
635 
642 extern int USBD_CDC_ACM_PutChar (uint8_t instance, int ch);
643 
651 extern int32_t USBD_CDC_ACM_ReadData (uint8_t instance, uint8_t *buf, int32_t len);
652 
660 extern int32_t USBD_CDC_ACM_WriteData (uint8_t instance, const uint8_t *buf, int32_t len);
661 
666 extern int32_t USBD_CDC_ACM_DataAvailable (uint8_t instance);
667 
679 extern usbStatus USBD_CDC_ACM_Notify (uint8_t instance, uint16_t state);
680 
686 extern int32_t USBD_CDC_NCM_NTB_IN_Initialize (uint8_t instance);
687 
688 
695 extern int32_t USBD_CDC_NCM_NTB_IN_CreateNDP (uint8_t instance, uint8_t num_datagrams);
696 
704 extern int32_t USBD_CDC_NCM_NTB_IN_WriteDatagram (uint8_t instance, const uint8_t *buf, uint32_t len);
705 
711 extern int32_t USBD_CDC_NCM_NTB_IN_Send (uint8_t instance);
712 
719 extern int32_t USBD_CDC_NCM_NTB_IN_IsSent (uint8_t instance);
720 
727 extern int32_t USBD_CDC_NCM_NTB_OUT_IsReceived (uint8_t instance);
728 
734 extern int32_t USBD_CDC_NCM_NTB_OUT_Release (uint8_t instance);
735 
741 extern int32_t USBD_CDC_NCM_NTB_OUT_ProcessNDP (uint8_t instance);
742 
746 extern uint32_t USBD_CDC_NCM_NTB_OUT_GetDatagramSize (uint8_t instance);
747 
755 extern int32_t USBD_CDC_NCM_NTB_OUT_ReadDatagram (uint8_t instance, uint8_t *buf, uint32_t max_len);
756 
764 extern int32_t USBD_CDC_NCM_NTB_IN_RawSend (uint8_t instance, const uint8_t *buf, uint32_t len);
765 
769 extern uint32_t USBD_CDC_NCM_NTB_OUT_RawGetSize (uint8_t instance);
770 
778 extern int32_t USBD_CDC_NCM_NTB_OUT_RawReceive (uint8_t instance, uint8_t *buf, uint32_t max_len);
779 
788 extern int32_t USBD_CDC_NCM_Notify_NetworkConnection (uint8_t instance, uint16_t status);
789 
797 extern int32_t USBD_CDC_NCM_Notify_ConnectionSpeedChange (uint8_t instance, uint32_t us_bitrate, uint32_t ds_bitrate);
798 
799 // ==== USB Device Human Interface Device Functions ====
800 
801 #ifdef __DOXYGEN__
802 
803 // following functions are available for each instance of a HID class.
804 // generic prefix USBD_HIDn is USBD_HID0 for HID class instance 0.
805 
808 void USBD_HIDn_Initialize (void);
809 
812 void USBD_HIDn_Uninitialize (void);
813 
827 int32_t USBD_HIDn_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
828 
842 bool USBD_HIDn_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
843 
844 #endif // __DOXYGEN
845 
852 extern usbStatus USBD_HID_GetReportTrigger (uint8_t instance, uint8_t rid, const uint8_t *buf, uint32_t len);
853 
854 
855 #ifdef __DOXYGEN__
856 
857 // ==== USB Device Mass Storage Device Functions ====
858 
859 // following functions are available for each instance of a MSC class.
860 // generic prefix USBD_MSCn is USBD_MSC0 for MSC class instance 0.
861 
864 void USBD_MSCn_Initialize (void);
865 
868 void USBD_MSCn_Uninitialize (void);
869 
876 bool USBD_MSCn_GetCacheInfo (uint32_t *buffer, uint32_t *size);
877 
884 bool USBD_MSCn_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
885 
893 bool USBD_MSCn_Read (uint32_t lba, uint32_t cnt, uint8_t *buf);
894 
902 bool USBD_MSCn_Write (uint32_t lba, uint32_t cnt, const uint8_t *buf);
903 
912 uint32_t USBD_MSCn_CheckMedia (void);
913 
921 bool USBD_MSCn_LUN_GetMediaCapacity (uint8_t lun, uint32_t *block_count, uint32_t *block_size);
922 
931 bool USBD_MSCn_LUN_Read (uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf);
932 
941 bool USBD_MSCn_LUN_Write (uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf);
942 
952 uint32_t USBD_MSCn_LUN_CheckMedia (uint8_t lun);
953 
954 #endif // __DOXYGEN
955 
956 
957 // ==== USB Device Custom Class Functions ====
958 
959 #ifdef __DOXYGEN__
960 
961 // following functions are available for each instance of a Custom class.
962 // generic prefix USBD_CustomClassn is USBD_CustomClass0 for Custom class instance 0.
963 
966 void USBD_CustomClassn_Initialize (void);
967 
971 
974 void USBD_CustomClassn_Reset (void);
975 
981 void USBD_CustomClassn_EndpointStart (uint8_t ep_addr);
982 
988 void USBD_CustomClassn_EndpointStop (uint8_t ep_addr);
989 
998 usbdRequestStatus USBD_CustomClassn_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
999 
1004 
1012 usbdRequestStatus USBD_CustomClassn_Endpoint0_OutDataReceived (uint32_t len);
1013 
1021 usbdRequestStatus USBD_CustomClassn_Endpoint0_InDataSent (uint32_t len);
1022 
1028 void USBD_CustomClassn_Endpoint1_Event (uint32_t event);
1029 void USBD_CustomClassn_Endpoint2_Event (uint32_t event);
1030 void USBD_CustomClassn_Endpoint3_Event (uint32_t event);
1031 void USBD_CustomClassn_Endpoint4_Event (uint32_t event);
1032 void USBD_CustomClassn_Endpoint5_Event (uint32_t event);
1033 void USBD_CustomClassn_Endpoint6_Event (uint32_t event);
1034 void USBD_CustomClassn_Endpoint7_Event (uint32_t event);
1035 void USBD_CustomClassn_Endpoint8_Event (uint32_t event);
1036 void USBD_CustomClassn_Endpoint9_Event (uint32_t event);
1037 void USBD_CustomClassn_Endpoint10_Event (uint32_t event);
1038 void USBD_CustomClassn_Endpoint11_Event (uint32_t event);
1039 void USBD_CustomClassn_Endpoint12_Event (uint32_t event);
1040 void USBD_CustomClassn_Endpoint13_Event (uint32_t event);
1041 void USBD_CustomClassn_Endpoint14_Event (uint32_t event);
1042 void USBD_CustomClassn_Endpoint15_Event (uint32_t event);
1043 
1044 #endif // __DOXYGEN
1045 
1054 extern usbStatus USBD_EndpointRead (uint8_t device, uint8_t ep_addr, uint8_t *buf, uint32_t len);
1055 
1062 extern uint32_t USBD_EndpointReadGetResult (uint8_t device, uint8_t ep_addr);
1063 
1072 extern usbStatus USBD_EndpointWrite (uint8_t device, uint8_t ep_addr, const uint8_t *buf, uint32_t len);
1073 
1080 extern uint32_t USBD_EndpointWriteGetResult (uint8_t device, uint8_t ep_addr);
1081 
1091 extern usbStatus USBD_EndpointStall (uint8_t device, uint8_t ep_addr, bool stall);
1092 
1099 extern usbStatus USBD_EndpointAbort (uint8_t device, uint8_t ep_addr);
1100 
1101 
1102 // ==== USB Host Functions ====
1103 
1104 // Rename deprecated functions
1105 #define USBH_GetDeviceStatus USBH_Device_GetStatus
1106 
1109 extern uint32_t USBH_GetVersion (void);
1110 
1114 extern usbStatus USBH_Initialize (uint8_t ctrl);
1115 
1119 extern usbStatus USBH_Uninitialize (uint8_t ctrl);
1120 
1125 extern usbStatus USBH_Port_Suspend (uint8_t ctrl, uint8_t port);
1126 
1131 extern usbStatus USBH_Port_Resume (uint8_t ctrl, uint8_t port);
1132 
1138 extern uint8_t USBH_Device_GetController (uint8_t device);
1139 
1145 extern uint8_t USBH_Device_GetPort (uint8_t device);
1146 
1150 extern usbStatus USBH_Device_GetStatus (uint8_t device);
1151 
1158 extern int32_t USBH_Device_GetSpeed (uint8_t device);
1159 
1165 extern uint8_t USBH_Device_GetAddress (uint8_t device);
1166 
1170 extern uint16_t USBH_Device_GetVID (uint8_t device);
1171 
1175 extern uint16_t USBH_Device_GetPID (uint8_t device);
1176 
1184 extern usbStatus USBH_Device_GetStringDescriptor (uint8_t device, uint8_t index, uint16_t language_id, uint8_t *descriptor_data, uint16_t descriptor_length);
1185 
1202 extern void USBH_Notify (uint8_t ctrl, uint8_t port, uint8_t device, USBH_NOTIFY notify);
1203 
1204 
1205 // ==== USB Host Mass Storage Functions ====
1206 
1207 // Rename deprecated functions
1208 #define USBH_MSC_GetDeviceStatus USBH_MSC_GetStatus
1209 
1213 extern void USBH_MSC_Initialize (uint8_t instance);
1214 
1218 extern void USBH_MSC_Uninitialize (uint8_t instance);
1219 
1225 extern uint8_t USBH_MSC_GetDevice (uint8_t instance);
1226 
1230 extern usbStatus USBH_MSC_GetStatus (uint8_t instance);
1231 
1238 extern usbStatus USBH_MSC_Read (uint8_t instance, uint32_t lba, uint32_t cnt, uint8_t *buf);
1239 
1246 extern usbStatus USBH_MSC_Write (uint8_t instance, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1247 
1253 extern usbStatus USBH_MSC_ReadCapacity (uint8_t instance, uint32_t *block_count, uint32_t *block_size);
1254 
1255 
1256 // ==== USB Host Human Interface Device Functions ====
1257 
1258 // Rename deprecated functions
1259 #define USBH_HID_GetDeviceStatus USBH_HID_GetStatus
1260 
1264 extern void USBH_HID_Initialize (uint8_t instance);
1265 
1269 extern void USBH_HID_Uninitialize (uint8_t instance);
1270 
1276 extern uint8_t USBH_HID_GetDevice (uint8_t instance);
1277 
1281 extern usbStatus USBH_HID_GetStatus (uint8_t instance);
1282 
1290 extern int32_t USBH_HID_Read (uint8_t instance, uint8_t *buf, int32_t len);
1291 
1299 extern int32_t USBH_HID_Write (uint8_t instance, const uint8_t *buf, int32_t len);
1300 
1306 extern int USBH_HID_GetKeyboardKey (uint8_t instance);
1307 
1312 extern usbStatus USBH_HID_GetMouseState (uint8_t instance, usbHID_MouseState *state);
1313 
1319 extern void USBH_HID_ParseReportDescriptor (uint8_t instance, const uint8_t *ptr_hid_report_desc, uint32_t len);
1320 
1325 extern void USBH_HID_DataReceived (uint8_t instance, uint32_t len);
1326 
1327 
1328 // ==== USB Host Communication Device Class (Abstract Control Model) Functions ====
1329 
1330 // Rename deprecated functions
1331 #define USBH_CDC_ACM_GetDeviceStatus USBH_CDC_ACM_GetStatus
1332 
1336 extern void USBH_CDC_ACM_Initialize (uint8_t instance);
1337 
1341 extern void USBH_CDC_ACM_Uninitialize (uint8_t instance);
1342 
1348 extern uint8_t USBH_CDC_ACM_GetDevice (uint8_t instance);
1349 
1353 extern usbStatus USBH_CDC_ACM_GetStatus (uint8_t instance);
1354 
1360 extern usbStatus USBH_CDC_ACM_Send (uint8_t instance, const uint8_t *data, uint32_t num);
1361 
1365 extern uint32_t USBH_CDC_ACM_GetTxCount (uint8_t instance);
1366 
1372 extern usbStatus USBH_CDC_ACM_Receive (uint8_t instance, uint8_t *data, uint32_t num);
1373 
1377 extern uint32_t USBH_CDC_ACM_GetRxCount (uint8_t instance);
1378 
1383 extern usbStatus USBH_CDC_ACM_SetLineCoding (uint8_t instance, const CDC_LINE_CODING *line_coding);
1384 
1389 extern usbStatus USBH_CDC_ACM_GetLineCoding (uint8_t instance, CDC_LINE_CODING *line_coding);
1390 
1397 extern usbStatus USBH_CDC_ACM_SetControlLineState (uint8_t instance, uint16_t state);
1398 
1411 extern void USBH_CDC_ACM_Notify (uint8_t instance, uint16_t status);
1412 
1419 extern usbStatus USBH_CDC_ACM_SendBreak (uint8_t instance, uint16_t duration);
1420 
1421 
1422 // ==== USB Host Custom Class Functions ====
1423 
1424 // Rename deprecated functions
1425 #define USBH_CustomClass_GetDeviceStatus USBH_CustomClass_GetStatus
1426 
1432 extern uint8_t USBH_CustomClass_GetDevice (uint8_t instance);
1433 
1437 extern usbStatus USBH_CustomClass_GetStatus (uint8_t instance);
1438 
1447 extern uint8_t USBH_CustomClass_Configure (uint8_t device, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
1448 
1453 extern usbStatus USBH_CustomClass_Unconfigure (uint8_t instance);
1454 
1459 extern usbStatus USBH_CustomClass_Initialize (uint8_t instance);
1460 
1465 extern usbStatus USBH_CustomClass_Uninitialize (uint8_t instance);
1466 
1478 extern USBH_PIPE_HANDLE USBH_PipeCreate (uint8_t device, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval);
1479 
1483 extern usbStatus USBH_PipeUpdate (USBH_PIPE_HANDLE pipe_hndl);
1484 
1488 extern usbStatus USBH_PipeDelete (USBH_PIPE_HANDLE pipe_hndl);
1489 
1493 extern usbStatus USBH_PipeReset (USBH_PIPE_HANDLE pipe_hndl);
1494 
1500 extern usbStatus USBH_PipeReceive (USBH_PIPE_HANDLE pipe_hndl, uint8_t *buf, uint32_t len);
1501 
1505 extern uint32_t USBH_PipeReceiveGetResult (USBH_PIPE_HANDLE pipe_hndl);
1506 
1512 extern usbStatus USBH_PipeSend (USBH_PIPE_HANDLE pipe_hndl, const uint8_t *buf, uint32_t len);
1513 
1517 extern uint32_t USBH_PipeSendGetResult (USBH_PIPE_HANDLE pipe_hndl);
1518 
1522 extern usbStatus USBH_PipeAbort (USBH_PIPE_HANDLE pipe_hndl);
1523 
1530 extern usbStatus USBH_ControlTransfer (uint8_t device, const USB_SETUP_PACKET *setup_packet, uint8_t *data, uint32_t len);
1531 
1538 extern usbStatus USBH_DeviceRequest_GetStatus (uint8_t device, uint8_t recipient, uint8_t index, uint8_t *ptr_stat_dat);
1539 
1546 extern usbStatus USBH_DeviceRequest_ClearFeature (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature_selector);
1547 
1554 extern usbStatus USBH_DeviceRequest_SetFeature (uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature_selector);
1555 
1560 extern usbStatus USBH_DeviceRequest_SetAddress (uint8_t device, uint8_t device_address);
1561 
1571 extern usbStatus USBH_DeviceRequest_GetDescriptor (uint8_t device, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, uint8_t *descriptor_data, uint16_t descriptor_length);
1572 
1582 extern usbStatus USBH_DeviceRequest_SetDescriptor (uint8_t device, uint8_t recipient, uint8_t descriptor_type, uint8_t descriptor_index, uint16_t language_id, const uint8_t *descriptor_data, uint16_t descriptor_length);
1583 
1588 extern usbStatus USBH_DeviceRequest_GetConfiguration (uint8_t device, uint8_t *ptr_configuration);
1589 
1594 extern usbStatus USBH_DeviceRequest_SetConfiguration (uint8_t device, uint8_t configuration);
1595 
1601 extern usbStatus USBH_DeviceRequest_GetInterface (uint8_t device, uint8_t index, uint8_t *ptr_alternate);
1602 
1608 extern usbStatus USBH_DeviceRequest_SetInterface (uint8_t device, uint8_t index, uint8_t alternate);
1609 
1615 extern usbStatus USBH_DeviceRequest_SynchFrame (uint8_t device, uint8_t index, uint8_t *ptr_frame_number);
1616 
1617 
1618 // USB Device OS abstraction functions
1619 extern void *USBD_ThreadCreate (usbdThread_t thread, uint8_t index);
1620 extern int32_t USBD_ThreadTerminate (void *thread_hndl);
1621 
1622 extern int32_t USBD_Delay (uint32_t millisec);
1623 
1624 extern void *USBD_TimerCreate (uint8_t instance);
1625 extern int32_t USBD_TimerStart (void *timer_hndl, uint32_t millisec);
1626 extern int32_t USBD_TimerStop (void *timer_hndl);
1627 extern int32_t USBD_TimerDelete (void *timer_hndl);
1628 
1629 extern uint32_t USBD_ThreadFlagsSet (void *thread_hndl, uint32_t flags);
1630 extern uint32_t USBD_ThreadFlagsWait (uint32_t millisec);
1631 
1632 extern void *USBD_SemaphoreCreate (usbdSemaphore_t semaphore, uint8_t index1, uint8_t index2);
1633 extern int32_t USBD_SemaphoreAcquire (void *semaphore_hndl, uint32_t millisec);
1634 extern int32_t USBD_SemaphoreRelease (void *semaphore_hndl);
1635 extern int32_t USBD_SemaphoreDelete (void *semaphore_hndl);
1636 
1637 
1638 // USB Device user callback function prototypes
1639 extern void USBD_Device0_Initialize (void);
1640 extern void USBD_Device0_Uninitialize (void);
1641 extern void USBD_Device0_VbusChanged (bool level);
1642 extern void USBD_Device0_Reset (void);
1643 extern void USBD_Device0_HighSpeedActivated (void);
1644 extern void USBD_Device0_Suspended (void);
1645 extern void USBD_Device0_Resumed (void);
1646 extern void USBD_Device0_ConfigurationChanged (uint8_t val);
1647 extern void USBD_Device0_EnableRemoteWakeup (void);
1648 extern void USBD_Device0_DisableRemoteWakeup (void);
1649 extern usbdRequestStatus USBD_Device0_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1650 extern void USBD_Device0_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1651 extern usbdRequestStatus USBD_Device0_Endpoint0_OutDataReceived (uint32_t len);
1652 extern usbdRequestStatus USBD_Device0_Endpoint0_InDataSent (uint32_t len);
1653 
1654 extern void USBD_Device1_Initialize (void);
1655 extern void USBD_Device1_Uninitialize (void);
1656 extern void USBD_Device1_VbusChanged (bool level);
1657 extern void USBD_Device1_Reset (void);
1658 extern void USBD_Device1_HighSpeedActivated (void);
1659 extern void USBD_Device1_Suspended (void);
1660 extern void USBD_Device1_Resumed (void);
1661 extern void USBD_Device1_ConfigurationChanged (uint8_t val);
1662 extern void USBD_Device1_EnableRemoteWakeup (void);
1663 extern void USBD_Device1_DisableRemoteWakeup (void);
1664 extern usbdRequestStatus USBD_Device1_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1665 extern void USBD_Device1_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1666 extern usbdRequestStatus USBD_Device1_Endpoint0_OutDataReceived (uint32_t len);
1667 extern usbdRequestStatus USBD_Device1_Endpoint0_InDataSent (uint32_t len);
1668 
1669 extern void USBD_Device2_Initialize (void);
1670 extern void USBD_Device2_Uninitialize (void);
1671 extern void USBD_Device2_VbusChanged (bool level);
1672 extern void USBD_Device2_Reset (void);
1673 extern void USBD_Device2_HighSpeedActivated (void);
1674 extern void USBD_Device2_Suspended (void);
1675 extern void USBD_Device2_Resumed (void);
1676 extern void USBD_Device2_ConfigurationChanged (uint8_t val);
1677 extern void USBD_Device2_EnableRemoteWakeup (void);
1678 extern void USBD_Device2_DisableRemoteWakeup (void);
1679 extern usbdRequestStatus USBD_Device2_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1680 extern void USBD_Device2_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1681 extern usbdRequestStatus USBD_Device2_Endpoint0_OutDataReceived (uint32_t len);
1682 extern usbdRequestStatus USBD_Device2_Endpoint0_InDataSent (uint32_t len);
1683 
1684 extern void USBD_Device3_Initialize (void);
1685 extern void USBD_Device3_Uninitialize (void);
1686 extern void USBD_Device3_VbusChanged (bool level);
1687 extern void USBD_Device3_Reset (void);
1688 extern void USBD_Device3_HighSpeedActivated (void);
1689 extern void USBD_Device3_Suspended (void);
1690 extern void USBD_Device3_Resumed (void);
1691 extern void USBD_Device3_ConfigurationChanged (uint8_t val);
1692 extern void USBD_Device3_EnableRemoteWakeup (void);
1693 extern void USBD_Device3_DisableRemoteWakeup (void);
1694 extern usbdRequestStatus USBD_Device3_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1695 extern void USBD_Device3_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1696 extern usbdRequestStatus USBD_Device3_Endpoint0_OutDataReceived (uint32_t len);
1697 extern usbdRequestStatus USBD_Device3_Endpoint0_InDataSent (uint32_t len);
1698 
1699 extern void USBD_ADC0_Initialize (void);
1700 extern void USBD_ADC0_Uninitialize (void);
1701 extern void USBD_ADC0_PlayStart (void);
1702 extern void USBD_ADC0_PlayStop (void);
1703 extern void USBD_ADC0_SetSpeakerMute (uint8_t ch, bool on);
1704 extern void USBD_ADC0_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1705 extern void USBD_ADC0_RecordStart (void);
1706 extern void USBD_ADC0_RecordStop (void);
1707 extern void USBD_ADC0_SetMicrophoneMute (uint8_t ch, bool on);
1708 extern void USBD_ADC0_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1709 extern void USBD_ADC0_ReceivedSamples (void);
1710 
1711 extern void USBD_ADC1_Initialize (void);
1712 extern void USBD_ADC1_Uninitialize (void);
1713 extern void USBD_ADC1_PlayStart (void);
1714 extern void USBD_ADC1_PlayStop (void);
1715 extern void USBD_ADC1_SetSpeakerMute (uint8_t ch, bool on);
1716 extern void USBD_ADC1_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1717 extern void USBD_ADC1_RecordStart (void);
1718 extern void USBD_ADC1_RecordStop (void);
1719 extern void USBD_ADC1_SetMicrophoneMute (uint8_t ch, bool on);
1720 extern void USBD_ADC1_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1721 extern void USBD_ADC1_ReceivedSamples (void);
1722 
1723 extern void USBD_ADC2_Initialize (void);
1724 extern void USBD_ADC2_Uninitialize (void);
1725 extern void USBD_ADC2_PlayStart (void);
1726 extern void USBD_ADC2_PlayStop (void);
1727 extern void USBD_ADC2_SetSpeakerMute (uint8_t ch, bool on);
1728 extern void USBD_ADC2_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1729 extern void USBD_ADC2_RecordStart (void);
1730 extern void USBD_ADC2_RecordStop (void);
1731 extern void USBD_ADC2_SetMicrophoneMute (uint8_t ch, bool on);
1732 extern void USBD_ADC2_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1733 extern void USBD_ADC2_ReceivedSamples (void);
1734 
1735 extern void USBD_ADC3_Initialize (void);
1736 extern void USBD_ADC3_Uninitialize (void);
1737 extern void USBD_ADC3_PlayStart (void);
1738 extern void USBD_ADC3_PlayStop (void);
1739 extern void USBD_ADC3_SetSpeakerMute (uint8_t ch, bool on);
1740 extern void USBD_ADC3_SetSpeakerVolume (uint8_t ch, uint16_t vol);
1741 extern void USBD_ADC3_RecordStart (void);
1742 extern void USBD_ADC3_RecordStop (void);
1743 extern void USBD_ADC3_SetMicrophoneMute (uint8_t ch, bool on);
1744 extern void USBD_ADC3_SetMicrophoneVolume (uint8_t ch, uint16_t vol);
1745 extern void USBD_ADC3_ReceivedSamples (void);
1746 
1747 extern void USBD_CDC0_ACM_Initialize (void);
1748 extern void USBD_CDC0_ACM_Uninitialize (void);
1749 extern void USBD_CDC0_ACM_Reset (void);
1750 extern bool USBD_CDC0_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1751 extern bool USBD_CDC0_ACM_SetControlLineState (uint16_t state);
1752 extern void USBD_CDC0_ACM_DataReceived (uint32_t len);
1753 extern void USBD_CDC0_ACM_DataSent (void);
1754 extern void USBD_CDC0_NCM_Initialize (void);
1755 extern void USBD_CDC0_NCM_Uninitialize (void);
1756 extern void USBD_CDC0_NCM_Reset (void);
1757 extern void USBD_CDC0_NCM_Start (void);
1758 extern void USBD_CDC0_NCM_Stop (void);
1759 extern bool USBD_CDC0_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1760 extern bool USBD_CDC0_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1761 extern bool USBD_CDC0_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1762 extern bool USBD_CDC0_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1763 extern bool USBD_CDC0_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1764 extern bool USBD_CDC0_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1765 extern bool USBD_CDC0_NCM_GetNetAddress (uint8_t *net_addr);
1766 extern bool USBD_CDC0_NCM_SetNetAddress (const uint8_t *net_addr);
1767 extern bool USBD_CDC0_NCM_GetNtbFormat (uint16_t *ntb_format);
1768 extern bool USBD_CDC0_NCM_SetNtbFormat (uint16_t ntb_format);
1769 extern bool USBD_CDC0_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1770 extern bool USBD_CDC0_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1771 extern bool USBD_CDC0_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1772 extern bool USBD_CDC0_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1773 extern bool USBD_CDC0_NCM_GetCrcMode (uint16_t *crc_mode);
1774 extern bool USBD_CDC0_NCM_SetCrcMode (uint16_t crc_mode);
1775 extern void USBD_CDC0_NCM_NTB_IN_Sent (void);
1776 extern void USBD_CDC0_NCM_NTB_OUT_Received (void);
1777 
1778 extern void USBD_CDC1_ACM_Initialize (void);
1779 extern void USBD_CDC1_ACM_Uninitialize (void);
1780 extern void USBD_CDC1_ACM_Reset (void);
1781 extern bool USBD_CDC1_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1782 extern bool USBD_CDC1_ACM_SetControlLineState (uint16_t state);
1783 extern void USBD_CDC1_ACM_DataReceived (uint32_t len);
1784 extern void USBD_CDC1_ACM_DataSent (void);
1785 extern void USBD_CDC1_NCM_Initialize (void);
1786 extern void USBD_CDC1_NCM_Uninitialize (void);
1787 extern void USBD_CDC1_NCM_Reset (void);
1788 extern void USBD_CDC1_NCM_Start (void);
1789 extern void USBD_CDC1_NCM_Stop (void);
1790 extern bool USBD_CDC1_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1791 extern bool USBD_CDC1_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1792 extern bool USBD_CDC1_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1793 extern bool USBD_CDC1_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1794 extern bool USBD_CDC1_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1795 extern bool USBD_CDC1_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1796 extern bool USBD_CDC1_NCM_GetNetAddress (uint8_t *net_addr);
1797 extern bool USBD_CDC1_NCM_SetNetAddress (const uint8_t *net_addr);
1798 extern bool USBD_CDC1_NCM_GetNtbFormat (uint16_t *ntb_format);
1799 extern bool USBD_CDC1_NCM_SetNtbFormat (uint16_t ntb_format);
1800 extern bool USBD_CDC1_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1801 extern bool USBD_CDC1_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1802 extern bool USBD_CDC1_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1803 extern bool USBD_CDC1_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1804 extern bool USBD_CDC1_NCM_GetCrcMode (uint16_t *crc_mode);
1805 extern bool USBD_CDC1_NCM_SetCrcMode (uint16_t crc_mode);
1806 extern void USBD_CDC1_NCM_NTB_IN_Sent (void);
1807 extern void USBD_CDC1_NCM_NTB_OUT_Received (void);
1808 
1809 extern void USBD_CDC2_ACM_Initialize (void);
1810 extern void USBD_CDC2_ACM_Uninitialize (void);
1811 extern void USBD_CDC2_ACM_Reset (void);
1812 extern bool USBD_CDC2_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1813 extern bool USBD_CDC2_ACM_SetControlLineState (uint16_t state);
1814 extern void USBD_CDC2_ACM_DataReceived (uint32_t len);
1815 extern void USBD_CDC2_ACM_DataSent (void);
1816 extern void USBD_CDC2_NCM_Initialize (void);
1817 extern void USBD_CDC2_NCM_Uninitialize (void);
1818 extern void USBD_CDC2_NCM_Reset (void);
1819 extern void USBD_CDC2_NCM_Start (void);
1820 extern void USBD_CDC2_NCM_Stop (void);
1821 extern bool USBD_CDC2_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1822 extern bool USBD_CDC2_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1823 extern bool USBD_CDC2_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1824 extern bool USBD_CDC2_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1825 extern bool USBD_CDC2_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1826 extern bool USBD_CDC2_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1827 extern bool USBD_CDC2_NCM_GetNetAddress (uint8_t *net_addr);
1828 extern bool USBD_CDC2_NCM_SetNetAddress (const uint8_t *net_addr);
1829 extern bool USBD_CDC2_NCM_GetNtbFormat (uint16_t *ntb_format);
1830 extern bool USBD_CDC2_NCM_SetNtbFormat (uint16_t ntb_format);
1831 extern bool USBD_CDC2_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1832 extern bool USBD_CDC2_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1833 extern bool USBD_CDC2_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1834 extern bool USBD_CDC2_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1835 extern bool USBD_CDC2_NCM_GetCrcMode (uint16_t *crc_mode);
1836 extern bool USBD_CDC2_NCM_SetCrcMode (uint16_t crc_mode);
1837 extern void USBD_CDC2_NCM_NTB_IN_Sent (void);
1838 extern void USBD_CDC2_NCM_NTB_OUT_Received (void);
1839 
1840 extern void USBD_CDC3_ACM_Initialize (void);
1841 extern void USBD_CDC3_ACM_Uninitialize (void);
1842 extern void USBD_CDC3_ACM_Reset (void);
1843 extern bool USBD_CDC3_ACM_GetLineCoding ( CDC_LINE_CODING *line_coding);
1844 extern bool USBD_CDC3_ACM_SetControlLineState (uint16_t state);
1845 extern void USBD_CDC3_ACM_DataReceived (uint32_t len);
1846 extern void USBD_CDC3_ACM_DataSent (void);
1847 extern void USBD_CDC3_NCM_Initialize (void);
1848 extern void USBD_CDC3_NCM_Uninitialize (void);
1849 extern void USBD_CDC3_NCM_Reset (void);
1850 extern void USBD_CDC3_NCM_Start (void);
1851 extern void USBD_CDC3_NCM_Stop (void);
1852 extern bool USBD_CDC3_NCM_SetEthernetMulticastFilters (const uint8_t *addr_list, uint16_t num_of_filters);
1853 extern bool USBD_CDC3_NCM_SetEthernetPowerManagementPatternFilter (uint16_t filter_number, const uint8_t *pattern_filter, uint16_t pattern_filter_size);
1854 extern bool USBD_CDC3_NCM_GetEthernetPowerManagementPatternFilter (uint16_t filter_number, uint16_t *pattern_active);
1855 extern bool USBD_CDC3_NCM_SetEthernetPacketFilter (uint16_t packet_filter_bitmap);
1856 extern bool USBD_CDC3_NCM_GetEthernetStatistic (uint16_t feature_selector, uint32_t *data);
1857 extern bool USBD_CDC3_NCM_GetNtbParameters (CDC_NCM_NTB_PARAM *ntb_params);
1858 extern bool USBD_CDC3_NCM_GetNetAddress (uint8_t *net_addr);
1859 extern bool USBD_CDC3_NCM_SetNetAddress (const uint8_t *net_addr);
1860 extern bool USBD_CDC3_NCM_GetNtbFormat (uint16_t *ntb_format);
1861 extern bool USBD_CDC3_NCM_SetNtbFormat (uint16_t ntb_format);
1862 extern bool USBD_CDC3_NCM_GetNtbInputSize (uint32_t *ntb_input_size);
1863 extern bool USBD_CDC3_NCM_SetNtbInputSize (uint32_t ntb_input_size);
1864 extern bool USBD_CDC3_NCM_GetMaxDatagramSize (uint16_t *max_datagram_size);
1865 extern bool USBD_CDC3_NCM_SetMaxDatagramSize (uint16_t max_datagram_size);
1866 extern bool USBD_CDC3_NCM_GetCrcMode (uint16_t *crc_mode);
1867 extern bool USBD_CDC3_NCM_SetCrcMode (uint16_t crc_mode);
1868 extern void USBD_CDC3_NCM_NTB_IN_Sent (void);
1869 extern void USBD_CDC3_NCM_NTB_OUT_Received (void);
1870 
1871 extern void USBD_HID0_Initialize (void);
1872 extern void USBD_HID0_Uninitialize (void);
1873 extern int32_t USBD_HID0_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1874 extern bool USBD_HID0_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1875 
1876 extern void USBD_HID1_Initialize (void);
1877 extern void USBD_HID1_Uninitialize (void);
1878 extern int32_t USBD_HID1_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1879 extern bool USBD_HID1_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1880 
1881 extern void USBD_HID2_Initialize (void);
1882 extern void USBD_HID2_Uninitialize (void);
1883 extern int32_t USBD_HID2_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1884 extern bool USBD_HID2_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1885 
1886 extern void USBD_HID3_Initialize (void);
1887 extern void USBD_HID3_Uninitialize (void);
1888 extern int32_t USBD_HID3_GetReport (uint8_t rtype, uint8_t req, uint8_t rid, uint8_t *buf);
1889 extern bool USBD_HID3_SetReport (uint8_t rtype, uint8_t req, uint8_t rid, const uint8_t *buf, int32_t len);
1890 
1891 extern void USBD_MSC0_Initialize (void);
1892 extern void USBD_MSC0_Uninitialize (void);
1893 extern bool USBD_MSC0_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1894 extern bool USBD_MSC0_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1895 extern bool USBD_MSC0_StartStop (bool start);
1896 extern uint32_t USBD_MSC0_CheckMedia (void);
1897 extern bool USBD_MSC0_LUN_GetMediaCapacity (uint8_t lun, uint32_t *block_count, uint32_t *block_size);
1898 extern bool USBD_MSC0_LUN_Read (uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf);
1899 extern bool USBD_MSC0_LUN_Write (uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1900 extern bool USBD_MSC0_LUN_StartStop (uint8_t lun, bool start);
1901 extern uint32_t USBD_MSC0_LUN_CheckMedia (uint8_t lun);
1902 
1903 extern void USBD_MSC1_Initialize (void);
1904 extern void USBD_MSC1_Uninitialize (void);
1905 extern bool USBD_MSC1_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1906 extern bool USBD_MSC1_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1907 extern bool USBD_MSC1_StartStop (bool start);
1908 extern uint32_t USBD_MSC1_CheckMedia (void);
1909 extern bool USBD_MSC1_LUN_GetMediaCapacity (uint8_t lun, uint32_t *block_count, uint32_t *block_size);
1910 extern bool USBD_MSC1_LUN_Read (uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf);
1911 extern bool USBD_MSC1_LUN_Write (uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1912 extern bool USBD_MSC1_LUN_StartStop (uint8_t lun, bool start);
1913 extern uint32_t USBD_MSC1_LUN_CheckMedia (uint8_t lun);
1914 
1915 extern void USBD_MSC2_Initialize (void);
1916 extern void USBD_MSC2_Uninitialize (void);
1917 extern bool USBD_MSC2_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1918 extern bool USBD_MSC2_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1919 extern bool USBD_MSC2_StartStop (bool start);
1920 extern uint32_t USBD_MSC2_CheckMedia (void);
1921 extern bool USBD_MSC2_LUN_GetMediaCapacity (uint8_t lun, uint32_t *block_count, uint32_t *block_size);
1922 extern bool USBD_MSC2_LUN_Read (uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf);
1923 extern bool USBD_MSC2_LUN_Write (uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1924 extern bool USBD_MSC2_LUN_StartStop (uint8_t lun, bool start);
1925 extern uint32_t USBD_MSC2_LUN_CheckMedia (uint8_t lun);
1926 
1927 extern void USBD_MSC3_Initialize (void);
1928 extern void USBD_MSC3_Uninitialize (void);
1929 extern bool USBD_MSC3_GetCacheInfo (uint32_t *buffer, uint32_t *size);
1930 extern bool USBD_MSC3_GetMediaCapacity (uint32_t *block_count, uint32_t *block_size);
1931 extern bool USBD_MSC3_StartStop (bool start);
1932 extern uint32_t USBD_MSC3_CheckMedia (void);
1933 extern bool USBD_MSC3_LUN_GetMediaCapacity (uint8_t lun, uint32_t *block_count, uint32_t *block_size);
1934 extern bool USBD_MSC3_LUN_Read (uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf);
1935 extern bool USBD_MSC3_LUN_Write (uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf);
1936 extern bool USBD_MSC3_LUN_StartStop (uint8_t lun, bool start);
1937 extern uint32_t USBD_MSC3_LUN_CheckMedia (uint8_t lun);
1938 
1939 extern void USBD_CustomClass0_Initialize (void);
1940 extern void USBD_CustomClass0_Uninitialize (void);
1941 extern void USBD_CustomClass0_Reset (void);
1942 extern void USBD_CustomClass0_EndpointStart (uint8_t ep_addr);
1943 extern void USBD_CustomClass0_EndpointStop (uint8_t ep_addr);
1944 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1945 extern void USBD_CustomClass0_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1946 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_OutDataReceived (uint32_t len);
1947 extern usbdRequestStatus USBD_CustomClass0_Endpoint0_InDataSent (uint32_t len);
1948 extern void USBD_CustomClass0_Endpoint1_Event (uint32_t event);
1949 extern void USBD_CustomClass0_Endpoint2_Event (uint32_t event);
1950 extern void USBD_CustomClass0_Endpoint3_Event (uint32_t event);
1951 extern void USBD_CustomClass0_Endpoint4_Event (uint32_t event);
1952 extern void USBD_CustomClass0_Endpoint5_Event (uint32_t event);
1953 extern void USBD_CustomClass0_Endpoint6_Event (uint32_t event);
1954 extern void USBD_CustomClass0_Endpoint7_Event (uint32_t event);
1955 extern void USBD_CustomClass0_Endpoint8_Event (uint32_t event);
1956 extern void USBD_CustomClass0_Endpoint9_Event (uint32_t event);
1957 extern void USBD_CustomClass0_Endpoint10_Event (uint32_t event);
1958 extern void USBD_CustomClass0_Endpoint11_Event (uint32_t event);
1959 extern void USBD_CustomClass0_Endpoint12_Event (uint32_t event);
1960 extern void USBD_CustomClass0_Endpoint13_Event (uint32_t event);
1961 extern void USBD_CustomClass0_Endpoint14_Event (uint32_t event);
1962 extern void USBD_CustomClass0_Endpoint15_Event (uint32_t event);
1963 
1964 extern void USBD_CustomClass1_Initialize (void);
1965 extern void USBD_CustomClass1_Uninitialize (void);
1966 extern void USBD_CustomClass1_Reset (void);
1967 extern void USBD_CustomClass1_EndpointStart (uint8_t ep_addr);
1968 extern void USBD_CustomClass1_EndpointStop (uint8_t ep_addr);
1969 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1970 extern void USBD_CustomClass1_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1971 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_OutDataReceived (uint32_t len);
1972 extern usbdRequestStatus USBD_CustomClass1_Endpoint0_InDataSent (uint32_t len);
1973 extern void USBD_CustomClass1_Endpoint1_Event (uint32_t event);
1974 extern void USBD_CustomClass1_Endpoint2_Event (uint32_t event);
1975 extern void USBD_CustomClass1_Endpoint3_Event (uint32_t event);
1976 extern void USBD_CustomClass1_Endpoint4_Event (uint32_t event);
1977 extern void USBD_CustomClass1_Endpoint5_Event (uint32_t event);
1978 extern void USBD_CustomClass1_Endpoint6_Event (uint32_t event);
1979 extern void USBD_CustomClass1_Endpoint7_Event (uint32_t event);
1980 extern void USBD_CustomClass1_Endpoint8_Event (uint32_t event);
1981 extern void USBD_CustomClass1_Endpoint9_Event (uint32_t event);
1982 extern void USBD_CustomClass1_Endpoint10_Event (uint32_t event);
1983 extern void USBD_CustomClass1_Endpoint11_Event (uint32_t event);
1984 extern void USBD_CustomClass1_Endpoint12_Event (uint32_t event);
1985 extern void USBD_CustomClass1_Endpoint13_Event (uint32_t event);
1986 extern void USBD_CustomClass1_Endpoint14_Event (uint32_t event);
1987 extern void USBD_CustomClass1_Endpoint15_Event (uint32_t event);
1988 
1989 extern void USBD_CustomClass2_Initialize (void);
1990 extern void USBD_CustomClass2_Uninitialize (void);
1991 extern void USBD_CustomClass2_Reset (void);
1992 extern void USBD_CustomClass2_EndpointStart (uint8_t ep_addr);
1993 extern void USBD_CustomClass2_EndpointStop (uint8_t ep_addr);
1994 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
1995 extern void USBD_CustomClass2_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
1996 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_OutDataReceived (uint32_t len);
1997 extern usbdRequestStatus USBD_CustomClass2_Endpoint0_InDataSent (uint32_t len);
1998 extern void USBD_CustomClass2_Endpoint1_Event (uint32_t event);
1999 extern void USBD_CustomClass2_Endpoint2_Event (uint32_t event);
2000 extern void USBD_CustomClass2_Endpoint3_Event (uint32_t event);
2001 extern void USBD_CustomClass2_Endpoint4_Event (uint32_t event);
2002 extern void USBD_CustomClass2_Endpoint5_Event (uint32_t event);
2003 extern void USBD_CustomClass2_Endpoint6_Event (uint32_t event);
2004 extern void USBD_CustomClass2_Endpoint7_Event (uint32_t event);
2005 extern void USBD_CustomClass2_Endpoint8_Event (uint32_t event);
2006 extern void USBD_CustomClass2_Endpoint9_Event (uint32_t event);
2007 extern void USBD_CustomClass2_Endpoint10_Event (uint32_t event);
2008 extern void USBD_CustomClass2_Endpoint11_Event (uint32_t event);
2009 extern void USBD_CustomClass2_Endpoint12_Event (uint32_t event);
2010 extern void USBD_CustomClass2_Endpoint13_Event (uint32_t event);
2011 extern void USBD_CustomClass2_Endpoint14_Event (uint32_t event);
2012 extern void USBD_CustomClass2_Endpoint15_Event (uint32_t event);
2013 
2014 extern void USBD_CustomClass3_Initialize (void);
2015 extern void USBD_CustomClass3_Uninitialize (void);
2016 extern void USBD_CustomClass3_Reset (void);
2017 extern void USBD_CustomClass3_EndpointStart (uint8_t ep_addr);
2018 extern void USBD_CustomClass3_EndpointStop (uint8_t ep_addr);
2019 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_SetupPacketReceived (const USB_SETUP_PACKET *setup_packet, uint8_t **buf, uint32_t *len);
2020 extern void USBD_CustomClass3_Endpoint0_SetupPacketProcessed (const USB_SETUP_PACKET *setup_packet);
2021 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_OutDataReceived (uint32_t len);
2022 extern usbdRequestStatus USBD_CustomClass3_Endpoint0_InDataSent (uint32_t len);
2023 extern void USBD_CustomClass3_Endpoint1_Event (uint32_t event);
2024 extern void USBD_CustomClass3_Endpoint2_Event (uint32_t event);
2025 extern void USBD_CustomClass3_Endpoint3_Event (uint32_t event);
2026 extern void USBD_CustomClass3_Endpoint4_Event (uint32_t event);
2027 extern void USBD_CustomClass3_Endpoint5_Event (uint32_t event);
2028 extern void USBD_CustomClass3_Endpoint6_Event (uint32_t event);
2029 extern void USBD_CustomClass3_Endpoint7_Event (uint32_t event);
2030 extern void USBD_CustomClass3_Endpoint8_Event (uint32_t event);
2031 extern void USBD_CustomClass3_Endpoint9_Event (uint32_t event);
2032 extern void USBD_CustomClass3_Endpoint10_Event (uint32_t event);
2033 extern void USBD_CustomClass3_Endpoint11_Event (uint32_t event);
2034 extern void USBD_CustomClass3_Endpoint12_Event (uint32_t event);
2035 extern void USBD_CustomClass3_Endpoint13_Event (uint32_t event);
2036 extern void USBD_CustomClass3_Endpoint14_Event (uint32_t event);
2037 extern void USBD_CustomClass3_Endpoint15_Event (uint32_t event);
2038 
2039 
2040 // USB Device library function prototypes for configuration generation
2041 extern usbStatus USBD_CustomClass_Initialize (uint8_t instance);
2042 extern usbStatus USBD_CustomClass_Uninitialize (uint8_t instance);
2043 extern void USBD_CustomClass_Reset (uint8_t instance);
2044 extern void USBD_CustomClass_EndpointStart (uint8_t instance, uint8_t ep_addr);
2045 extern void USBD_CustomClass_EndpointStop (uint8_t instance, uint8_t ep_addr);
2046 
2047 extern usbStatus USBD_ADC_Initialize (uint8_t instance);
2048 extern usbStatus USBD_ADC_Uninitialize (uint8_t instance);
2049 extern void USBD_ADC_Reset (uint8_t instance);
2050 extern void USBD_ADC_EndpointStart (uint8_t instance, uint8_t ep_addr);
2051 extern void USBD_ADC_EndpointStop (uint8_t instance, uint8_t ep_addr);
2052 
2053 extern usbStatus USBD_CDC_Initialize (uint8_t instance);
2054 extern usbStatus USBD_CDC_Uninitialize (uint8_t instance);
2055 extern void USBD_CDC_Reset (uint8_t instance);
2056 extern void USBD_CDC_EndpointStart (uint8_t instance, uint8_t ep_addr);
2057 extern void USBD_CDC_EndpointStop (uint8_t instance, uint8_t ep_addr);
2058 
2059 extern usbStatus USBD_HID_Initialize (uint8_t instance);
2060 extern usbStatus USBD_HID_Uninitialize (uint8_t instance);
2061 extern void USBD_HID_Reset (uint8_t instance);
2062 extern void USBD_HID_SetConfiguration (uint8_t instance);
2063 extern void USBD_HID_EndpointStart (uint8_t instance, uint8_t ep_addr);
2064 extern void USBD_HID_Timer (void const *argument);
2065 
2066 
2067 extern usbStatus USBD_MSC_Initialize (uint8_t instance);
2068 extern usbStatus USBD_MSC_Uninitialize (uint8_t instance);
2069 extern void USBD_MSC_Reset (uint8_t instance);
2070 extern void USBD_MSC_EndpointStart (uint8_t instance, uint8_t ep_addr);
2071 
2072 
2073 // USB Device library configuration generated function prototypes
2074 extern usbStatus USBD_ClassInitialize (uint8_t device);
2075 extern usbStatus USBD_ClassUninitialize (uint8_t device);
2076 extern void USBD_Reset (uint8_t device);
2077 extern void USBD_SetConfiguration (uint8_t device, uint8_t configuration);
2078 extern void USBD_EndpointStart (uint8_t device, uint8_t ep_addr);
2079 extern void USBD_EndpointStop (uint8_t device, uint8_t ep_addr);
2080 
2081 
2082 // USB Device thread function prototypes
2083 extern void USBD_Core_Thread (void *arg);
2084 extern void USBD0_Core_Thread (void const *arg);
2085 extern void USBD1_Core_Thread (void const *arg);
2086 extern void USBD2_Core_Thread (void const *arg);
2087 extern void USBD3_Core_Thread (void const *arg);
2088 
2089 extern void USBD_ADC_Thread (void *arg);
2090 extern void USBD_ADC0_Thread (void const *arg);
2091 extern void USBD_ADC1_Thread (void const *arg);
2092 extern void USBD_ADC2_Thread (void const *arg);
2093 extern void USBD_ADC3_Thread (void const *arg);
2094 
2095 extern void USBD_CDC_Int_Thread (void *arg);
2096 extern void USBD_CDC0_Int_Thread (void const *arg);
2097 extern void USBD_CDC1_Int_Thread (void const *arg);
2098 extern void USBD_CDC2_Int_Thread (void const *arg);
2099 extern void USBD_CDC3_Int_Thread (void const *arg);
2100 
2101 extern void USBD_CDC_Bulk_Thread (void *arg);
2102 extern void USBD_CDC0_Bulk_Thread (void const *arg);
2103 extern void USBD_CDC1_Bulk_Thread (void const *arg);
2104 extern void USBD_CDC2_Bulk_Thread (void const *arg);
2105 extern void USBD_CDC3_Bulk_Thread (void const *arg);
2106 
2107 extern void USBD_HID_Thread (void *arg);
2108 extern void USBD_HID0_Thread (void const *arg);
2109 extern void USBD_HID1_Thread (void const *arg);
2110 extern void USBD_HID2_Thread (void const *arg);
2111 extern void USBD_HID3_Thread (void const *arg);
2112 
2113 extern void USBD_MSC_Thread (void *arg);
2114 extern void USBD_MSC0_Thread (void const *arg);
2115 extern void USBD_MSC1_Thread (void const *arg);
2116 extern void USBD_MSC2_Thread (void const *arg);
2117 extern void USBD_MSC3_Thread (void const *arg);
2118 
2119 extern void USBD_CustomClass_EP_Thread (void *arg);
2120 
2121 // USB Host OS abstraction functions
2122 extern void *USBH_ThreadCreate (usbhThread_t thread, uint8_t index);
2123 extern void *USBH_ThreadGetHandle (void);
2124 extern int32_t USBH_ThreadTerminate (void *thread_hndl);
2125 
2126 extern int32_t USBH_Delay (uint32_t millisec);
2127 
2128 extern void *USBH_TimerCreate (uint8_t ctrl);
2129 extern int32_t USBH_TimerStart (void *timer_hndl, uint32_t millisec);
2130 extern int32_t USBH_TimerStop (void *timer_hndl);
2131 extern int32_t USBH_TimerDelete (void *timer_hndl);
2132 
2133 extern uint32_t USBH_ThreadFlagsSet (void *thread_hndl, uint32_t flags);
2134 extern uint32_t USBH_ThreadFlagsWait (uint32_t millisec);
2135 
2136 extern void *USBH_MutexCreate (usbhMutex_t mutex, uint8_t ctrl);
2137 extern int32_t USBH_MutexAcquire (void *mutex_hndl, uint32_t millisec);
2138 extern int32_t USBH_MutexRelease (void *mutex_hndl);
2139 extern int32_t USBH_MutexDelete (void *mutex_hndl);
2140 
2141 extern void *USBH_SemaphoreCreate (usbhSemaphore_t semaphore, uint8_t ctrl);
2142 extern int32_t USBH_SemaphoreAcquire (void *semaphore_hndl, uint32_t millisec);
2143 extern int32_t USBH_SemaphoreRelease (void *semaphore_hndl);
2144 extern int32_t USBH_SemaphoreDelete (void *semaphore_hndl);
2145 
2146 // USB Host library function prototypes
2147 extern uint8_t USBH_CDC_Configure (uint8_t device, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
2148 extern usbStatus USBH_CDC_Unconfigure (uint8_t instance);
2149 extern usbStatus USBH_CDC_Initialize_Lib (uint8_t instance);
2150 extern usbStatus USBH_CDC_Uninitialize_Lib (uint8_t instance);
2151 
2152 extern uint8_t USBH_HID_Configure (uint8_t device, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
2153 extern usbStatus USBH_HID_Unconfigure (uint8_t instance);
2154 extern usbStatus USBH_HID_Initialize_Lib (uint8_t instance);
2155 extern usbStatus USBH_HID_Uninitialize_Lib (uint8_t instance);
2156 
2157 extern uint8_t USBH_MSC_Configure (uint8_t device, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
2158 extern usbStatus USBH_MSC_Unconfigure (uint8_t instance);
2159 extern usbStatus USBH_MSC_Initialize_Lib (uint8_t instance);
2160 extern usbStatus USBH_MSC_Uninitialize_Lib (uint8_t instance);
2161 
2162 extern uint8_t USBH_CustomClass_Configure (uint8_t device, const USB_DEVICE_DESCRIPTOR *ptr_dev_desc, const USB_CONFIGURATION_DESCRIPTOR *ptr_cfg_desc);
2163 extern usbStatus USBH_CustomClass_Unconfigure (uint8_t instance);
2164 extern usbStatus USBH_CustomClass_Initialize (uint8_t instance);
2165 extern usbStatus USBH_CustomClass_Uninitialize (uint8_t instance);
2166 
2167 // USB Host thread function prototypes
2168 extern void USBH_Core_Thread (void *arg);
2169 extern void USBH0_Core_Thread (void const *arg);
2170 extern void USBH1_Core_Thread (void const *arg);
2171 extern void USBH2_Core_Thread (void const *arg);
2172 extern void USBH3_Core_Thread (void const *arg);
2173 
2174 extern void USBH_CDC_IntIn_Thread (void *arg);
2175 
2176 extern void USBH_HID_IntIn_Thread (void *arg);
2177 
2178 // USB Host timer function prototypes
2179 extern void USBH_ConnectDebounce (void const *arg);
2180 
2181 #ifdef __cplusplus
2182 }
2183 #endif
2184 
2185 #endif
void USBD_CustomClassn_Endpoint9_Event(uint32_t event)
Request processed but busy.
Definition: rl_usb.h:81
void USBH_Notify(uint8_t ctrl, uint8_t port, uint8_t device, USBH_NOTIFY notify)
Callback function called when some event has happened on corresponding controller and port...
Mass Storage Device (MSC) error (no device or device produced error)
Definition: rl_usb.h:51
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...
usbStatus USBH_PipeReset(USBH_PIPE_HANDLE pipe_hndl)
Reset Pipe (reset data toggle)
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:34
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 all Logical Units of the USB MSC class ...
uint32_t USBD_ADC_WrittenSamplesPending(uint8_t instance)
Number of audio samples written and pending to be sent to USB Host.
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) ...
Invalid Parameter error: a mandatory parameter was missing or specified an incorrect object...
Definition: rl_usb.h:35
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:32
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.
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 all Logical Units of the USB MSC c...
usbStatus USBH_Device_GetStringDescriptor(uint8_t device, uint8_t index, uint16_t language_id, uint8_t *descriptor_data, uint16_t descriptor_length)
Get String Descriptor of USB Device.
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.
usbStatus USBH_PipeUpdate(USBH_PIPE_HANDLE pipe_hndl)
Update Pipe.
bool USBD_MSCn_LUN_Read(uint8_t lun, uint32_t lba, uint32_t cnt, uint8_t *buf)
Callback function called to read data from media of a logical unit.
void USBD_CustomClassn_Uninitialize(void)
Callback function called during USBD_Uninitialize to de-initialize the USB Custom class instance...
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:42
Unspecified USB error.
Definition: rl_usb.h:58
usbStatus USBH_DeviceRequest_GetDescriptor(uint8_t device, 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.
CMSIS-RTOS Semaphore creation failed.
Definition: rl_usb.h:39
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_SetInterface(uint8_t device, uint8_t index, uint8_t alternate)
Standard Device Request on Default Pipe - SET_INTERFACE.
usbStatus USBH_MSC_GetStatus(uint8_t instance)
Get status of Mass Storage Device.
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.
usbStatus USBH_DeviceRequest_SetConfiguration(uint8_t device, uint8_t configuration)
Standard Device Request on Default Pipe - SET_CONFIGURATION.
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. ...
uint32_t USBH_PipeSendGetResult(USBH_PIPE_HANDLE pipe_hndl)
Get result of send data operation on Pipe.
Request from periodic update.
Definition: rl_usb.h:92
void USBH_HID_Uninitialize(uint8_t instance)
Callback function called when Human Interface Device was disconnected.
USBH_PIPE_HANDLE USBH_PipeCreate(uint8_t device, uint8_t ep_addr, uint8_t ep_type, uint16_t ep_max_packet_size, uint8_t ep_interval)
Create Pipe.
CMSIS-RTOS Thread creation/termination failed.
Definition: rl_usb.h:37
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:163
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 USBH_DeviceRequest_SynchFrame(uint8_t device, uint8_t index, uint8_t *ptr_frame_number)
Standard Device Request on Default Pipe - SYNCH_FRAME.
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_CDC_ACM_SetControlLineState(uint8_t instance, uint16_t state)
Set control line states of Communication Device Class device.
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:78
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.
usbStatus USBH_PipeReceive(USBH_PIPE_HANDLE pipe_hndl, uint8_t *buf, uint32_t len)
Receive data on Pipe.
Audio Device Class (ADC) error (no device or device produced error)
Definition: rl_usb.h:48
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.
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.
uint8_t USBH_CustomClass_Configure(uint8_t device, 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 ...
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.
usbStatus USBH_DeviceRequest_ClearFeature(uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature_selector)
Standard Device Request on Default Pipe - CLEAR_FEATURE.
uint32_t USBD_CDC_NCM_NTB_OUT_GetDatagramSize(uint8_t instance)
Get size of a datagram from the active NDP of the received NTB.
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:40
usbStatus USBH_DeviceRequest_SetAddress(uint8_t device, uint8_t device_address)
Standard Device Request on Default Pipe - SET_ADDRESS.
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:161
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:49
usbStatus USBH_DeviceRequest_SetDescriptor(uint8_t device, 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.
Request from control endpoint.
Definition: rl_usb.h:90
void USBH_HID_Initialize(uint8_t instance)
Callback function called when Human Interface Device was enumerated and is ready. ...
bool USBD_MSCn_LUN_GetMediaCapacity(uint8_t lun, uint32_t *block_count, uint32_t *block_size)
Callback function called to get media capacity of a logical unit.
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:6558
usbdRequestStatus USBD_Devicen_Endpoint0_InDataSent(uint32_t len)
Callback function called when Device sent IN DATA on Control Endpoint 0.
usbStatus USBH_PipeAbort(USBH_PIPE_HANDLE pipe_hndl)
Abort send/receive operation on Pipe.
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)
CMSIS-RTOS Timer creation/deletion failed.
Definition: rl_usb.h:38
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.
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.
bool USBD_MSCn_LUN_Write(uint8_t lun, uint32_t lba, uint32_t cnt, const uint8_t *buf)
Callback function called to write data to media of a logical unit.
uint32_t USBH_PipeReceiveGetResult(USBH_PIPE_HANDLE pipe_hndl)
Get result of receive data operation on Pipe.
Request processed and OK.
Definition: rl_usb.h:79
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.
usbStatus USBD_Uninitialize(uint8_t device)
De-initialize USB Device stack and controller.
uint32_t USBH_GetVersion(void)
Get version of USB Host stack.
Device is not configured (is connected)
Definition: rl_usb.h:47
usbStatus USBH_DeviceRequest_GetStatus(uint8_t device, uint8_t recipient, uint8_t index, uint8_t *ptr_stat_dat)
Standard Device Request on Default Pipe - GET_STATUS.
Mouse state information.
Definition: rl_usb.h:159
uint8_t USBH_Device_GetController(uint8_t device)
Get index of USB Host controller to which USB Device is connected.
usbStatus USBH_PipeDelete(USBH_PIPE_HANDLE pipe_hndl)
Delete Pipe.
usbStatus
Definition: rl_usb.txt:6560
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_SetFeature(uint8_t device, uint8_t recipient, uint8_t index, uint8_t feature_selector)
Standard Device Request on Default Pipe - SET_FEATURE.
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)
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:52
Request processed but unsupported.
Definition: rl_usb.h:80
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:91
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:43
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...
uint32_t USBD_GetVersion(void)
Get version of USB Device stack.
void USBD_Devicen_Endpoint0_SetupPacketProcessed(const USB_SETUP_PACKET *setup_packet)
Callback function called when SETUP PACKET was processed by USB library.
usbStatus USBH_DeviceRequest_GetInterface(uint8_t device, uint8_t index, uint8_t *ptr_alternate)
Standard Device Request on Default Pipe - GET_INTERFACE.
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:46
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:6559
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:56
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...
void USBD_ADCn_RecordStop(void)
Callback function called when recording stopped.
usbStatus USBH_PipeSend(USBH_PIPE_HANDLE pipe_hndl, const uint8_t *buf, uint32_t len)
Send data on Pipe.
void USBD_CDCn_NCM_NTB_IN_Sent(void)
Callback function called when NTB was successfully sent.
usbStatus USBH_DeviceRequest_GetConfiguration(uint8_t device, uint8_t *ptr_configuration)
Standard Device Request on Default Pipe - GET_CONFIGURATION.
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)...
usbStatus USBH_ControlTransfer(uint8_t device, const USB_SETUP_PACKET *setup_packet, uint8_t *data, uint32_t len)
Do a Control Transfer on Default Pipe.
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:162
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:160
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:44
int32_t USBH_HID_Read(uint8_t instance, uint8_t *buf, int32_t len)
Read data received from Human Interface Device.
uint32_t USBD_MSCn_LUN_CheckMedia(uint8_t lun)
Callback function called to check media presence and write protect status of a logical unit...
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:45
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.
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:55
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.
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:53
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:50
int32_t USBD_CDC_NCM_NTB_IN_Initialize(uint8_t instance)
Clear the active NTB (prepared for sending)