Cypress USB Device Middleware Library 2.0
Macros

General Description

API Reference

 Descriptors
 

Macros

#define CY_USB_DEV_MW_VERSION_MAJOR   (2)
 USB Device Middleware major version.
 
#define CY_USB_DEV_MW_VERSION_MINOR   (0)
 USB Device Middleware minor version.
 
#define CY_USB_DEV_ID   CY_PDL_DRV_ID(0x08U)
 USB Device Middleware identifier.
 
#define CY_USB_DEV_NUM_INTERFACES_MAX   CY_USBFS_DEV_DRV_NUM_EPS_MAX
 Maximum number of interfaces (this equals to the maximum number of hardware endpoints where each interface has at least one endpoint).
 
#define CY_USB_DEV_EP0_PACKET_SIZE   CY_USBFS_DEV_DRV_EP0_BUFFER_SIZE
 USBFS Device endpoint 0 packet size.
 
#define CY_USB_DEV_SN_STRING_LENGTH   (32U)
 Length of serial string number generated from silicon ID.
 
#define CY_USB_DEV_SN_STRING_DESR_LENGTH   (CY_USB_DEV_SN_STRING_LENGTH + 2U)
 Length of serial string number.
 
#define CY_USB_DEV_WAIT_FOREVER   (0)
 Timeout value that defines wait forever.
 
#define CY_USB_DEV_ALLOC_ENDPOINT_BUFFER(buf, size)   CY_USBFS_DEV_DRV_ALLOC_ENDPOINT_BUFFER(buf,size)
 Allocates static buffer for data endpoint. More...
 
#define CY_USB_DEV_DIR_HOST_TO_DEVICE   (0U)
 Transfer direction from Host to Device (setup packet)
 
#define CY_USB_DEV_DIR_DEVICE_TO_HOST   (1U)
 Transfer direction from Device to Host (setup packet)
 
#define CY_USB_DEV_STANDARD_TYPE   (0U)
 Standard request type (setup packet)
 
#define CY_USB_DEV_CLASS_TYPE   (1U)
 Class-specific request type (setup packet)
 
#define CY_USB_DEV_VENDOR_TYPE   (2U)
 Vendor-specific request type (setup packet)
 
#define CY_USB_DEV_RESERVED_TYPE   (3U)
 Reserved request type (setup packet)
 
#define CY_USB_DEV_RECIPIENT_DEVICE   (0U)
 Request recipient device (setup packet)
 
#define CY_USB_DEV_RECIPIENT_INTERFACE   (1U)
 Request recipient interface (setup packet)
 
#define CY_USB_DEV_RECIPIENT_ENDPOINT   (2U)
 Request recipient endpoint (setup packet)
 
#define CY_USB_DEV_RECIPIENT_OTHER   (3U)
 Request recipient other (setup packet)
 
#define CY_USB_DEV_RQST_GET_STATUS   (0U)
 GET_STATUS standard request.
 
#define CY_USB_DEV_RQST_CLEAR_FEATURE   (1U)
 CLEAR_FEATURE standard request.
 
#define CY_USB_DEV_RQST_SET_FEATURE   (3U)
 SET_FEATURE standard request.
 
#define CY_USB_DEV_RQST_SET_ADDRESS   (5U)
 SET_ADDRESS standard request.
 
#define CY_USB_DEV_RQST_GET_DESCRIPTOR   (6U)
 GET_DESCRIPTOR standard request.
 
#define CY_USB_DEV_RQST_SET_DESCRIPTOR   (7U)
 SET_DESCRIPTOR standard request.
 
#define CY_USB_DEV_RQST_GET_CONFIGURATION   (8U)
 GET_CONFIGURATION standard request.
 
#define CY_USB_DEV_RQST_SET_CONFIGURATION   (9U)
 SET_CONFIGURATION standard request.
 
#define CY_USB_DEV_RQST_GET_INTERFACE   (10U)
 GET_INTERFACE standard request.
 
#define CY_USB_DEV_RQST_SET_INTERFACE   (11U)
 SET_INTERFACE standard request.
 
#define CY_USB_DEV_RQST_SYNCH_FRAME   (12U)
 SYNCH_FRAME standard request.
 
#define CY_USB_DEV_DEVICE_REMOTE_WAKEUP   (1U)
 REMOTE_WAKEUP feature selector.
 
#define CY_USB_DEV_ENDPOINT_HALT   (0U)
 ENDPOINT_HALT feature selector.
 
#define CY_USB_DEV_ENDPOINT_STATUS_HALT   (1U)
 ENDPOINT_STATUS_HALT feature selector.
 
#define CY_USB_DEV_TEST_MODE   (2U)
 TEST_MODE feature selector.
 

Macro Definition Documentation

◆ CY_USB_DEV_ALLOC_ENDPOINT_BUFFER

#define CY_USB_DEV_ALLOC_ENDPOINT_BUFFER (   buf,
  size 
)    CY_USBFS_DEV_DRV_ALLOC_ENDPOINT_BUFFER(buf,size)

Allocates static buffer for data endpoint.

The size parameter must be a constant. The allocated buffer is aligned on a 2 byte boundary. An odd buffer size is converted to even consuming 1 extra byte. The application must discard this extra byte. This manipulation is needed to support different 8-bit and 16-bit hardware buffer access types in the driver (See Hardware Buffer Access section of the USBFS driver for more information).