lib/main/STM32H7/Middlewares/ST/STM32_USB_Device_Library/Class/HID/Inc/usbd_hid.h

   1 /**
   2   ******************************************************************************
   3   * @file    usbd_hid.h
   4   * @author  MCD Application Team
   5   * @brief   Header file for the usbd_hid_core.c file.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2015 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under Ultimate Liberty license
  13   * SLA0044, the "License"; You may not use this file except in compliance with
  14   * the License. You may obtain a copy of the License at:
  15   *                      www.st.com/SLA0044
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef __USB_HID_H
  22 #define __USB_HID_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include  "usbd_ioreq.h"
  30
  31 /** @addtogroup STM32_USB_DEVICE_LIBRARY
  32   * @{
  33   */
  34
  35 /** @defgroup USBD_HID
  36   * @brief This file is the Header file for usbd_hid.c
  37   * @{
  38   */
  39
  40
  41 /** @defgroup USBD_HID_Exported_Defines
  42   * @{
  43   */
  44 #define HID_EPIN_ADDR                 0x83U
  45 #define HID_EPIN_SIZE                 0x08U
  46
  47 #define USB_HID_CONFIG_DESC_SIZ       34U
  48 #define USB_HID_DESC_SIZ              9U
  49 #define HID_MOUSE_REPORT_DESC_SIZE    38U
  50
  51 #define HID_DESCRIPTOR_TYPE           0x21U
  52 #define HID_REPORT_DESC               0x22U
  53
  54 #ifndef HID_HS_BINTERVAL
  55 #define HID_HS_BINTERVAL            0x07U
  56 #endif /* HID_HS_BINTERVAL */
  57
  58 #ifndef HID_FS_BINTERVAL
  59 #define HID_FS_BINTERVAL            0x0AU
  60 #endif /* HID_FS_BINTERVAL */
  61
  62 #define HID_REQ_SET_PROTOCOL          0x0BU
  63 #define HID_REQ_GET_PROTOCOL          0x03U
  64
  65 #define HID_REQ_SET_IDLE              0x0AU
  66 #define HID_REQ_GET_IDLE              0x02U
  67
  68 #define HID_REQ_SET_REPORT            0x09U
  69 #define HID_REQ_GET_REPORT            0x01U
  70 /**
  71   * @}
  72   */
  73
  74
  75 /** @defgroup USBD_CORE_Exported_TypesDefinitions
  76   * @{
  77   */
  78 typedef enum
  79 {
  80   HID_IDLE = 0,
  81   HID_BUSY,
  82 }
  83 HID_StateTypeDef;
  84
  85
  86 typedef struct
  87 {
  88   uint32_t             Protocol;
  89   uint32_t             IdleState;
  90   uint32_t             AltSetting;
  91   HID_StateTypeDef     state;
  92 }
  93 USBD_HID_HandleTypeDef;
  94 /**
  95   * @}
  96   */
  97
  98
  99
 100 /** @defgroup USBD_CORE_Exported_Macros
 101   * @{
 102   */
 103
 104 /**
 105   * @}
 106   */
 107
 108 /** @defgroup USBD_CORE_Exported_Variables
 109   * @{
 110   */
 111
 112 extern USBD_ClassTypeDef  USBD_HID;
 113 #define USBD_HID_CLASS    &USBD_HID
 114 /**
 115   * @}
 116   */
 117
 118 /** @defgroup USB_CORE_Exported_Functions
 119   * @{
 120   */
 121 uint8_t USBD_HID_SendReport(USBD_HandleTypeDef *pdev,
 122                             uint8_t *report,
 123                             uint16_t len);
 124
 125 uint32_t USBD_HID_GetPollingInterval(USBD_HandleTypeDef *pdev);
 126
 127 /**
 128   * @}
 129   */
 130
 131 #ifdef __cplusplus
 132 }
 133 #endif
 134
 135 #endif  /* __USB_HID_H */
 136 /**
 137   * @}
 138   */
 139
 140 /**
 141   * @}
 142   */
 143
 144 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/