forked from stm/stm32-mw-usb-device
206 lines
5.2 KiB
C
206 lines
5.2 KiB
C
/**
|
|
******************************************************************************
|
|
* @file usbd_customhid.h
|
|
* @author MCD Application Team
|
|
* @brief header file for the usbd_customhid.c file.
|
|
******************************************************************************
|
|
* @attention
|
|
*
|
|
* Copyright (c) 2015 STMicroelectronics.
|
|
* All rights reserved.
|
|
*
|
|
* This software is licensed under terms that can be found in the LICENSE file
|
|
* in the root directory of this software component.
|
|
* If no LICENSE file comes with this software, it is provided AS-IS.
|
|
*
|
|
******************************************************************************
|
|
*/
|
|
|
|
/* Define to prevent recursive inclusion -------------------------------------*/
|
|
#ifndef __USB_CUSTOMHID_H
|
|
#define __USB_CUSTOMHID_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Includes ------------------------------------------------------------------*/
|
|
#include "usbd_ioreq.h"
|
|
|
|
/** @addtogroup STM32_USB_DEVICE_LIBRARY
|
|
* @{
|
|
*/
|
|
|
|
/** @defgroup USBD_CUSTOM_HID
|
|
* @brief This file is the Header file for USBD_customhid.c
|
|
* @{
|
|
*/
|
|
|
|
|
|
/** @defgroup USBD_CUSTOM_HID_Exported_Defines
|
|
* @{
|
|
*/
|
|
#ifndef CUSTOM_HID_EPIN_ADDR
|
|
#define CUSTOM_HID_EPIN_ADDR 0x81U
|
|
#endif /* CUSTOM_HID_EPIN_ADDR */
|
|
|
|
#ifndef CUSTOM_HID_EPIN_SIZE
|
|
#define CUSTOM_HID_EPIN_SIZE 0x02U
|
|
#endif /* CUSTOM_HID_EPIN_SIZE */
|
|
|
|
#ifndef CUSTOM_HID_EPOUT_ADDR
|
|
#define CUSTOM_HID_EPOUT_ADDR 0x01U
|
|
#endif /* CUSTOM_HID_EPOUT_ADDR */
|
|
|
|
#ifndef CUSTOM_HID_EPOUT_SIZE
|
|
#define CUSTOM_HID_EPOUT_SIZE 0x02U
|
|
#endif /* CUSTOM_HID_EPOUT_SIZE*/
|
|
|
|
#define USB_CUSTOM_HID_CONFIG_DESC_SIZ 41U
|
|
#define USB_CUSTOM_HID_DESC_SIZ 9U
|
|
|
|
#ifndef CUSTOM_HID_HS_BINTERVAL
|
|
#define CUSTOM_HID_HS_BINTERVAL 0x05U
|
|
#endif /* CUSTOM_HID_HS_BINTERVAL */
|
|
|
|
#ifndef CUSTOM_HID_FS_BINTERVAL
|
|
#define CUSTOM_HID_FS_BINTERVAL 0x05U
|
|
#endif /* CUSTOM_HID_FS_BINTERVAL */
|
|
|
|
#ifndef USBD_CUSTOMHID_OUTREPORT_BUF_SIZE
|
|
#define USBD_CUSTOMHID_OUTREPORT_BUF_SIZE 0x02U
|
|
#endif /* USBD_CUSTOMHID_OUTREPORT_BUF_SIZE */
|
|
|
|
#ifndef USBD_CUSTOM_HID_REPORT_DESC_SIZE
|
|
#define USBD_CUSTOM_HID_REPORT_DESC_SIZE 163U
|
|
#endif /* USBD_CUSTOM_HID_REPORT_DESC_SIZE */
|
|
|
|
#define CUSTOM_HID_DESCRIPTOR_TYPE 0x21U
|
|
#define CUSTOM_HID_REPORT_DESC 0x22U
|
|
|
|
#define CUSTOM_HID_REQ_SET_PROTOCOL 0x0BU
|
|
#define CUSTOM_HID_REQ_GET_PROTOCOL 0x03U
|
|
|
|
#define CUSTOM_HID_REQ_SET_IDLE 0x0AU
|
|
#define CUSTOM_HID_REQ_GET_IDLE 0x02U
|
|
|
|
#define CUSTOM_HID_REQ_SET_REPORT 0x09U
|
|
#define CUSTOM_HID_REQ_GET_REPORT 0x01U
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
/** @defgroup USBD_CORE_Exported_TypesDefinitions
|
|
* @{
|
|
*/
|
|
typedef enum
|
|
{
|
|
CUSTOM_HID_IDLE = 0U,
|
|
CUSTOM_HID_BUSY,
|
|
} CUSTOM_HID_StateTypeDef;
|
|
|
|
typedef struct _USBD_CUSTOM_HID_Itf
|
|
{
|
|
uint8_t *pReport;
|
|
#ifdef USBD_CUSTOMHID_REPORT_DESC_SIZE_ENABLED
|
|
uint16_t wReportDescLen;
|
|
#endif /* USBD_CUSTOMHID_REPORT_DESC_SIZE_ENABLED */
|
|
int8_t (* Init)(void);
|
|
int8_t (* DeInit)(void);
|
|
#ifdef USBD_CUSTOMHID_REPORT_BUFFER_EVENT_ENABLED
|
|
int8_t (* OutEvent)(uint8_t *report_buffer);
|
|
#else
|
|
int8_t (* OutEvent)(uint8_t event_idx, uint8_t state);
|
|
#endif /* USBD_CUSTOMHID_REPORT_BUFFER_EVENT_ENABLED */
|
|
#ifdef USBD_CUSTOMHID_CTRL_REQ_COMPLETE_CALLBACK_ENABLED
|
|
int8_t (* CtrlReqComplete)(uint8_t request, uint16_t wLength);
|
|
#endif /* USBD_CUSTOMHID_CTRL_REQ_COMPLETE_CALLBACK_ENABLED */
|
|
#ifdef USBD_CUSTOMHID_CTRL_REQ_GET_REPORT_ENABLED
|
|
uint8_t *(* GetReport)(uint16_t *ReportLength);
|
|
#endif /* USBD_CUSTOMHID_CTRL_REQ_GET_REPORT_ENABLED */
|
|
} USBD_CUSTOM_HID_ItfTypeDef;
|
|
|
|
typedef struct
|
|
{
|
|
uint8_t Report_buf[USBD_CUSTOMHID_OUTREPORT_BUF_SIZE];
|
|
uint32_t Protocol;
|
|
uint32_t IdleState;
|
|
uint32_t AltSetting;
|
|
uint32_t IsReportAvailable;
|
|
CUSTOM_HID_StateTypeDef state;
|
|
} USBD_CUSTOM_HID_HandleTypeDef;
|
|
|
|
/*
|
|
* HID Class specification version 1.1
|
|
* 6.2.1 HID Descriptor
|
|
*/
|
|
|
|
typedef struct
|
|
{
|
|
uint8_t bLength;
|
|
uint8_t bDescriptorTypeCHID;
|
|
uint16_t bcdCUSTOM_HID;
|
|
uint8_t bCountryCode;
|
|
uint8_t bNumDescriptors;
|
|
uint8_t bDescriptorType;
|
|
uint16_t wItemLength;
|
|
} __PACKED USBD_DescTypeDef;
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
|
|
|
|
/** @defgroup USBD_CORE_Exported_Macros
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup USBD_CORE_Exported_Variables
|
|
* @{
|
|
*/
|
|
|
|
extern USBD_ClassTypeDef USBD_CUSTOM_HID;
|
|
#define USBD_CUSTOM_HID_CLASS &USBD_CUSTOM_HID
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/** @defgroup USB_CORE_Exported_Functions
|
|
* @{
|
|
*/
|
|
#ifdef USE_USBD_COMPOSITE
|
|
uint8_t USBD_CUSTOM_HID_SendReport(USBD_HandleTypeDef *pdev,
|
|
uint8_t *report, uint16_t len, uint8_t ClassId);
|
|
#else
|
|
uint8_t USBD_CUSTOM_HID_SendReport(USBD_HandleTypeDef *pdev,
|
|
uint8_t *report, uint16_t len);
|
|
#endif /* USE_USBD_COMPOSITE */
|
|
uint8_t USBD_CUSTOM_HID_ReceivePacket(USBD_HandleTypeDef *pdev);
|
|
|
|
uint8_t USBD_CUSTOM_HID_RegisterInterface(USBD_HandleTypeDef *pdev,
|
|
USBD_CUSTOM_HID_ItfTypeDef *fops);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __USB_CUSTOMHID_H */
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|