VSF Documented
Macros
vsf_usbd_HID_desc.h File Reference

Go to the source code of this file.

Macros

#define USB_HID_SUBCLASS_NONE   0
 
#define USB_HID_SUBCLASS_BOOT   1
 
#define USB_HID_PROTOCOL_NONE   0
 
#define USB_HID_PROTOCOL_KEYBOARD   1
 
#define USB_HID_PROTOCOL_MOUSE   2
 
#define USB_DT_HID_SIZE   9
 
#define USB_DESC_HID(__IFS, __I_FUNC, __SUBCLASS, __PROTOCOL, __VERSION_BCD, __COUNTRY_CODE, __REPORT_DESC_LEN, __EP_IN, __EP_IN_SIZE, __EP_IN_INTERVAL, __EP_OUT, __EP_OUT_SIZE, __EP_OUT_INTERVAL)
 
#define USB_DESC_HID_LEN   (USB_DESC_IFS_LEN + USB_DT_HID_SIZE + 2 * USB_DESC_EP_LEN)
 
#define USB_DESC_HID_IAD(__IFS, __I_FUNC, __SUBCLASS, __PROTOCOL, __VERSION_BCD, __COUNTRY_CODE, __REPORT_DESC_LEN, __EP_IN, __EP_IN_SIZE, __EP_IN_INTERVAL, __EP_OUT, __EP_OUT_SIZE, __EP_OUT_INTERVAL)
 
#define USB_DESC_HID_IAD_LEN   (USB_DESC_IAD_LEN + USB_DESC_HID_LEN)
 

Macro Definition Documentation

◆ USB_HID_SUBCLASS_NONE

#define USB_HID_SUBCLASS_NONE   0

◆ USB_HID_SUBCLASS_BOOT

#define USB_HID_SUBCLASS_BOOT   1

◆ USB_HID_PROTOCOL_NONE

#define USB_HID_PROTOCOL_NONE   0

◆ USB_HID_PROTOCOL_KEYBOARD

#define USB_HID_PROTOCOL_KEYBOARD   1

◆ USB_HID_PROTOCOL_MOUSE

#define USB_HID_PROTOCOL_MOUSE   2

◆ USB_DT_HID_SIZE

#define USB_DT_HID_SIZE   9

◆ USB_DESC_HID

#define USB_DESC_HID (   __IFS,
  __I_FUNC,
  __SUBCLASS,
  __PROTOCOL,
  __VERSION_BCD,
  __COUNTRY_CODE,
  __REPORT_DESC_LEN,
  __EP_IN,
  __EP_IN_SIZE,
  __EP_IN_INTERVAL,
  __EP_OUT,
  __EP_OUT_SIZE,
  __EP_OUT_INTERVAL 
)
Value:
USB_DESC_IFS((__IFS), 0, 2, USB_CLASS_HID, (__SUBCLASS), (__PROTOCOL), (__I_FUNC))\
USB_DESC_WORD(__VERSION_BCD), /* bcdHID: HID Class Specification release in BCD */\
(__COUNTRY_CODE), /* bCountryCode */ \
(1), /* bNumDescriptor: number of class descriptors */\
USB_DT_REPORT, /* bDescriptorType */ \
USB_DESC_WORD(__REPORT_DESC_LEN), /* wDescriptorLen */ \
USB_DESC_EP(USB_DIR_IN | (__EP_IN), USB_ENDPOINT_XFER_INT, __EP_IN_SIZE, __EP_IN_INTERVAL)\
USB_DESC_EP(USB_DIR_OUT | (__EP_OUT), USB_ENDPOINT_XFER_INT, __EP_OUT_SIZE, __EP_OUT_INTERVAL)
@ USB_DT_REPORT
Definition usb_common.h:169
@ USB_DT_HID
Definition usb_common.h:168
@ USB_ENDPOINT_XFER_INT
Definition usb_common.h:289
@ USB_CLASS_HID
Definition usb_common.h:130
@ USB_DIR_OUT
Definition usb_common.h:81
@ USB_DIR_IN
Definition usb_common.h:82
#define USB_DESC_IFS(__IFS_NUM, __ALT_SETTING, __EP_NUM, __CLASS, __SUBCLASS, __PROTOCOL, __I_IFS)
Definition usb_desc.h:48
#define USB_DT_HID_SIZE
Definition vsf_usbd_HID_desc.h:35

◆ USB_DESC_HID_LEN

#define USB_DESC_HID_LEN   (USB_DESC_IFS_LEN + USB_DT_HID_SIZE + 2 * USB_DESC_EP_LEN)

◆ USB_DESC_HID_IAD

#define USB_DESC_HID_IAD (   __IFS,
  __I_FUNC,
  __SUBCLASS,
  __PROTOCOL,
  __VERSION_BCD,
  __COUNTRY_CODE,
  __REPORT_DESC_LEN,
  __EP_IN,
  __EP_IN_SIZE,
  __EP_IN_INTERVAL,
  __EP_OUT,
  __EP_OUT_SIZE,
  __EP_OUT_INTERVAL 
)
Value:
USB_DESC_IAD((__IFS), 1, USB_CLASS_HID, (__SUBCLASS), (__PROTOCOL), (__I_FUNC))\
USB_DESC_HID((__IFS), (__I_FUNC), (__SUBCLASS), (__PROTOCOL), (__VERSION_BCD), (__COUNTRY_CODE), (__REPORT_DESC_LEN),\
(__EP_IN), (__EP_IN_SIZE), (__EP_IN_INTERVAL), \
(__EP_OUT), (__EP_OUT_SIZE), (__EP_OUT_INTERVAL))
#define USB_DESC_IAD(__IFS_START, __IFS_NUM, __CLASS, __SUBCLASS, __PROTOCOL, __I_FUNC)
Definition usb_desc.h:81

◆ USB_DESC_HID_IAD_LEN

#define USB_DESC_HID_IAD_LEN   (USB_DESC_IAD_LEN + USB_DESC_HID_LEN)