chentianya/GD32_Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

添加GD32H7的CMake工程

Browse Source
This commit is contained in:
chentianya
2026-07-23 19:44:30 +08:00
commit d07f065b1c
202 changed files with 204039 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Firmware/GD32H7xx_usbhs_library/device/class/hid/Include/custom_hid_core.h
+66
View File
@@ -0,0 +1,66 @@
/*!
\file custom_hid_core.h
\brief definitions for HID core
\version 2025-01-24, V1.4.0, firmware for GD32H7xx
*/
/*
Copyright (c) 2025, GigaDevice Semiconductor Inc.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
#ifndef CUSTOM_HID_CORE_H
#define CUSTOM_HID_CORE_H
#include "usbd_enum.h"
#include "usb_hid.h"
#define DESC_LEN_REPORT 96U /*!< report descriptor length */
#define DESC_LEN_CONFIG 41U /*!< configuration descriptor length */
#define NO_CMD 0xFFU /*!< no command */
#define MAX_PERIPH_NUM 4U /*!< maximum peripheral number */
typedef struct {
__ALIGN_BEGIN uint8_t data[2] __ALIGN_END; /*!< custom HID data packet buff */
uint8_t reportID; /*!< custom HID report id */
uint8_t idlestate; /*!< idle state */
uint8_t protocol; /*!< HID protocol */
} custom_hid_handler;
typedef struct {
void (*periph_config[MAX_PERIPH_NUM])(void);
} hid_fop_handler;
extern usb_desc custom_hid_desc;
extern usb_class_core usbd_custom_hid_cb;
/* function declarations */
/* register HID interface operation functions */
uint8_t custom_hid_itfop_register(usb_dev *udev, hid_fop_handler *hid_fop);
/* send custom HID report */
uint8_t custom_hid_report_send(usb_dev *udev, uint8_t *report, uint32_t len);
#endif /* CUSTOM_HID_CORE_H */
Firmware/GD32H7xx_usbhs_library/device/class/hid/Include/standard_hid_core.h
+70
View File
@@ -0,0 +1,70 @@
/*!
\file standard_hid_core.h
\brief definitions for HID core
\version 2025-01-24, V1.4.0, firmware for GD32H7xx
*/
/*
Copyright (c) 2025, GigaDevice Semiconductor Inc.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
#ifndef STANDARD_HID_CORE_H
#define STANDARD_HID_CORE_H
#include "usbd_enum.h"
#include "usb_hid.h"
#define USB_BOS_DESC_SIZE 0x0CU /*!< HID device bos descriptor size */
#define USB_DEVICE_CAPABITY 0x10U /*!< HID device capabity */
#define USB_HID_CONFIG_DESC_LEN 0x22U /*!< HID device configuration descriptor length */
#define USB_HID_REPORT_DESC_LEN 0x2EU /*!< HID device report descriptor length */
#define NO_CMD 0xFFU /*!< no command */
typedef struct {
uint32_t protocol; /*!< control request protocol */
uint32_t idle_state; /*!< HID device idle state */
__ALIGN_BEGIN uint8_t data[HID_IN_PACKET] __ALIGN_END; /*!< data transfer buff */
__IO uint8_t prev_transfer_complete; /*!< previous transfer complete flag */
} standard_hid_handler;
typedef struct {
void (*hid_itf_config)(void);
void (*hid_itf_data_process)(usb_dev *udev);
} hid_fop_handler;
extern usb_desc hid_desc;
extern usb_class_core usbd_hid_cb;
/* function declarations */
/* register HID interface operation functions */
uint8_t hid_itfop_register(usb_dev *udev, hid_fop_handler *hid_fop);
/* send keyboard report */
uint8_t hid_report_send(usb_dev *udev, uint8_t *report, uint32_t len);
#endif /* STANDARD_HID_CORE_H */
Firmware/GD32H7xx_usbhs_library/device/class/hid/Source/custom_hid_core.c
+463
View File
@@ -0,0 +1,463 @@
/*!
\file custom_hid_core.c
\brief custom HID class driver
\version 2025-01-24, V1.4.0, firmware for GD32H7xx
*/
/*
Copyright (c) 2025, GigaDevice Semiconductor Inc.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
#include "custom_hid_core.h"
#include <string.h>
#define USBD_VID 0x28E9U
#define USBD_PID 0x028AU
/* Note:it should use the C99 standard when compiling the below codes */
/* USB standard device descriptor */
__ALIGN_BEGIN const usb_desc_dev custom_hid_dev_desc __ALIGN_END = {
.header =
{
.bLength = USB_DEV_DESC_LEN,
.bDescriptorType = USB_DESCTYPE_DEV,
},
.bcdUSB = 0x0200U,
.bDeviceClass = 0x00U,
.bDeviceSubClass = 0x00U,
.bDeviceProtocol = 0x00U,
.bMaxPacketSize0 = USB_FS_EP0_MAX_LEN,
.idVendor = USBD_VID,
.idProduct = USBD_PID,
.bcdDevice = 0x0100U,
.iManufacturer = STR_IDX_MFC,
.iProduct = STR_IDX_PRODUCT,
.iSerialNumber = STR_IDX_SERIAL,
.bNumberConfigurations = USBD_CFG_MAX_NUM,
};
/* USB device configuration descriptor */
__ALIGN_BEGIN const usb_hid_desc_config_set custom_hid_config_desc __ALIGN_END = {
.config =
{
.header =
{
.bLength = sizeof(usb_desc_config),
.bDescriptorType = USB_DESCTYPE_CONFIG
},
.wTotalLength = DESC_LEN_CONFIG,
.bNumInterfaces = 0x01U,
.bConfigurationValue = 0x01U,
.iConfiguration = 0x00U,
.bmAttributes = 0x80U,
.bMaxPower = 0x32U
},
.hid_itf =
{
.header =
{
.bLength = sizeof(usb_desc_itf),
.bDescriptorType = USB_DESCTYPE_ITF
},
.bInterfaceNumber = 0x00U,
.bAlternateSetting = 0x00U,
.bNumEndpoints = 0x02U,
.bInterfaceClass = USB_HID_CLASS,
.bInterfaceSubClass = 0x00U,
.bInterfaceProtocol = 0x00U,
.iInterface = 0x00U
},
.hid_vendor =
{
.header =
{
.bLength = sizeof(usb_desc_hid),
.bDescriptorType = USB_DESCTYPE_HID
},
.bcdHID = 0x0111U,
.bCountryCode = 0x00U,
.bNumDescriptors = 0x01U,
.bDescriptorType = USB_DESCTYPE_REPORT,
.wDescriptorLength = DESC_LEN_REPORT,
},
.hid_epin =
{
.header =
{
.bLength = sizeof(usb_desc_ep),
.bDescriptorType = USB_DESCTYPE_EP
},
.bEndpointAddress = CUSTOMHID_IN_EP,
.bmAttributes = USB_EP_ATTR_INT,
.wMaxPacketSize = CUSTOMHID_IN_PACKET,
.bInterval = 0x02U
},
.hid_epout =
{
.header =
{
.bLength = sizeof(usb_desc_ep),
.bDescriptorType = USB_DESCTYPE_EP
},
.bEndpointAddress = CUSTOMHID_OUT_EP,
.bmAttributes = USB_EP_ATTR_INT,
.wMaxPacketSize = CUSTOMHID_OUT_PACKET,
.bInterval = 0x02U
}
};
/* USB language ID descriptor */
__ALIGN_BEGIN static const usb_desc_LANGID usbd_language_id_desc __ALIGN_END = {
.header =
{
.bLength = sizeof(usb_desc_LANGID),
.bDescriptorType = USB_DESCTYPE_STR
},
.wLANGID = ENG_LANGID
};
/* USB manufacture string */
__ALIGN_BEGIN static const usb_desc_str manufacturer_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(10U),
.bDescriptorType = USB_DESCTYPE_STR,
},
.unicode_string = {'G', 'i', 'g', 'a', 'D', 'e', 'v', 'i', 'c', 'e'}
};
/* USB product string */
__ALIGN_BEGIN static const usb_desc_str product_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(14U),
.bDescriptorType = USB_DESCTYPE_STR,
},
.unicode_string = {'G', 'D', '3', '2', '-', 'C', 'u', 's', 't', 'o', 'm', 'H', 'I', 'D'}
};
/* USB serial string */
__ALIGN_BEGIN static usb_desc_str serial_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(12U),
.bDescriptorType = USB_DESCTYPE_STR,
}
};
/* USB string descriptor set */
void *const usbd_hid_strings[] = {
[STR_IDX_LANGID] = (uint8_t *)&usbd_language_id_desc,
[STR_IDX_MFC] = (uint8_t *)&manufacturer_string,
[STR_IDX_PRODUCT] = (uint8_t *)&product_string,
[STR_IDX_SERIAL] = (uint8_t *)&serial_string
};
usb_desc custom_hid_desc = {
.dev_desc = (uint8_t *)&custom_hid_dev_desc,
.config_desc = (uint8_t *)&custom_hid_config_desc,
.strings = usbd_hid_strings
};
__ALIGN_BEGIN const uint8_t customhid_report_descriptor[DESC_LEN_REPORT] __ALIGN_END = {
0x06U, 0x00U, 0xFFU, /* USAGE_PAGE (Vendor Defined: 0xFF00) */
0x09U, 0x00U, /* USAGE (Custom Device) */
0xa1U, 0x01U, /* COLLECTION (Application) */
/* led 1 */
0x85U, 0x11U, /* REPORT_ID (0x11) */
0x09U, 0x01U, /* USAGE (LED 1) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x95U, 0x01U, /* REPORT_COUNT (1) */
0x91U, 0x82U, /* OUTPUT (Data,Var,Abs,Vol) */
/* led 2 */
0x85U, 0x12U, /* REPORT_ID (0x12) */
0x09U, 0x02U, /* USAGE (LED 2) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x95U, 0x01U, /* REPORT_COUNT (1) */
0x91U, 0x82U, /* OUTPUT (Data,Var,Abs,Vol) */
/* led 3 */
0x85U, 0x13U, /* REPORT_ID (0x13) */
0x09U, 0x03U, /* USAGE (LED 3) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x95U, 0x01U, /* REPORT_COUNT (1) */
0x91U, 0x82U, /* OUTPUT (Data,Var,Abs,Vol) */
/* led 4 */
0x85U, 0x14U, /* REPORT_ID (0x14) */
0x09U, 0x04U, /* USAGE (LED 4) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x95U, 0x01U, /* REPORT_COUNT (1) */
0x91U, 0x82U, /* OUTPUT (Data,Var,Abs,Vol) */
/* wakeup key */
0x85U, 0x15U, /* REPORT_ID (0x15) */
0x09U, 0x05U, /* USAGE (Push Button) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x01U, /* REPORT_SIZE (1) */
0x81U, 0x02U, /* INPUT (Data,Var,Abs,Vol) */
0x75U, 0x07U, /* REPORT_SIZE (7) */
0x81U, 0x03U, /* INPUT (Cnst,Var,Abs,Vol) */
/* tamper key */
0x85U, 0x16U, /* REPORT_ID (0x16) */
0x09U, 0x06U, /* USAGE (Push Button) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x75U, 0x01U, /* REPORT_SIZE (1) */
0x81U, 0x02U, /* INPUT (Data,Var,Abs,Vol) */
0x75U, 0x07U, /* REPORT_SIZE (7) */
0x81U, 0x03U, /* INPUT (Cnst,Var,Abs,Vol) */
0xc0U /* END_COLLECTION */
};
/* local function prototypes ('static') */
static uint8_t custom_hid_init(usb_dev *udev, uint8_t config_index);
static uint8_t custom_hid_deinit(usb_dev *udev, uint8_t config_index);
static uint8_t custom_hid_req_handler(usb_dev *udev, usb_req *req);
static uint8_t custom_hid_data_in(usb_dev *udev, uint8_t ep_num);
static uint8_t custom_hid_data_out(usb_dev *udev, uint8_t ep_num);
usb_class_core usbd_custom_hid_cb = {
.command = NO_CMD,
.alter_set = 0U,
.init = custom_hid_init,
.deinit = custom_hid_deinit,
.req_proc = custom_hid_req_handler,
.data_in = custom_hid_data_in,
.data_out = custom_hid_data_out
};
/*!
\brief register HID interface operation functions
\param[in] udev: pointer to USB device instance
\param[in] hid_fop: HID operation functions structure
\param[out] none
\retval USB device operation status
*/
uint8_t custom_hid_itfop_register(usb_dev *udev, hid_fop_handler *hid_fop)
{
if(NULL != hid_fop) {
udev->dev.user_data = hid_fop;
return USBD_OK;
}
return USBD_FAIL;
}
/*!
\brief send custom HID report
\param[in] udev: pointer to USB device instance
\param[in] report: pointer to HID report
\param[in] len: data length
\param[out] none
\retval USB device operation status
*/
uint8_t custom_hid_report_send(usb_dev *udev, uint8_t *report, uint32_t len)
{
usbd_ep_send(udev, CUSTOMHID_IN_EP, report, len);
return USBD_OK;
}
/*!
\brief initialize the HID device
\param[in] udev: pointer to USB device instance
\param[in] config_index: configuration index
\param[out] none
\retval USB device operation status
*/
static uint8_t custom_hid_init(usb_dev *udev, uint8_t config_index)
{
static custom_hid_handler hid_handler;
memset((void *)&hid_handler, 0U, sizeof(custom_hid_handler));
/* initialize the data TX endpoint */
usbd_ep_setup(udev, &(custom_hid_config_desc.hid_epin));
/* initialize the data RX endpoint */
usbd_ep_setup(udev, &(custom_hid_config_desc.hid_epout));
/* prepare receive data */
usbd_ep_recev(udev, CUSTOMHID_OUT_EP, hid_handler.data, 2U);
udev->dev.class_data[CUSTOM_HID_INTERFACE] = (void *)&hid_handler;
if(NULL != udev->dev.user_data) {
for(uint8_t i = 0U; i < MAX_PERIPH_NUM; i++) {
if(NULL != ((hid_fop_handler *)udev->dev.user_data)->periph_config[i]) {
((hid_fop_handler *)udev->dev.user_data)->periph_config[i]();
}
}
}
return USBD_OK;
}
/*!
\brief de-initialize the HID device
\param[in] udev: pointer to USB device instance
\param[in] config_index: configuration index
\param[out] none
\retval USB device operation status
*/
static uint8_t custom_hid_deinit(usb_dev *udev, uint8_t config_index)
{
/* deinitialize HID endpoints */
usbd_ep_clear(udev, CUSTOMHID_IN_EP);
usbd_ep_clear(udev, CUSTOMHID_OUT_EP);
return USBD_OK;
}
/*!
\brief handle the HID class-specific requests
\param[in] udev: pointer to USB device instance
\param[in] req: device class-specific request
\param[out] none
\retval USB device operation status
*/
static uint8_t custom_hid_req_handler(usb_dev *udev, usb_req *req)
{
usb_transc *transc = &udev->dev.transc_in[0];
custom_hid_handler *hid = (custom_hid_handler *)udev->dev.class_data[CUSTOM_HID_INTERFACE];
switch(req->bRequest) {
case GET_REPORT:
break;
case GET_IDLE:
transc->xfer_buf = (uint8_t *)&hid->idlestate;
transc->remain_len = 1U;
break;
case GET_PROTOCOL:
transc->xfer_buf = (uint8_t *)&hid->protocol;
transc->remain_len = 1U;
break;
case SET_REPORT:
hid->reportID = (uint8_t)(req->wValue);
break;
case SET_IDLE:
hid->idlestate = (uint8_t)(req->wValue >> 8);
break;
case SET_PROTOCOL:
hid->protocol = (uint8_t)(req->wValue);
break;
case USB_GET_DESCRIPTOR:
if(USB_DESCTYPE_REPORT == (req->wValue >> 8)) {
transc->remain_len = USB_MIN(DESC_LEN_REPORT, req->wLength);
transc->xfer_buf = (uint8_t *)customhid_report_descriptor;
}
break;
default:
return USBD_FAIL;
}
return USBD_OK;
}
/*!
\brief handle custom HID data
\param[in] udev: pointer to USB device instance
\param[in] ep_num: endpoint identifier
\param[out] none
\retval USB device operation status
*/
static uint8_t custom_hid_data_in(usb_dev *udev, uint8_t ep_num)
{
return USBD_OK;
}
/*!
\brief handle custom HID data
\param[in] udev: pointer to USB device instance
\param[in] ep_num: endpoint identifier
\param[out] none
\retval USB device operation status
*/
static uint8_t custom_hid_data_out(usb_dev *udev, uint8_t ep_num)
{
custom_hid_handler *hid = (custom_hid_handler *)udev->dev.class_data[CUSTOM_HID_INTERFACE];
/* light the LED */
switch(hid->data[0]) {
case 0x11U:
if(RESET != hid->data[1]) {
gd_eval_led_on(LED1);
} else {
gd_eval_led_off(LED1);
}
break;
case 0x12U:
if(RESET != hid->data[1]) {
gd_eval_led_on(LED2);
} else {
gd_eval_led_off(LED2);
}
break;
default:
break;
}
usbd_ep_recev(udev, CUSTOMHID_OUT_EP, hid->data, 2U);
return USBD_OK;
}
Firmware/GD32H7xx_usbhs_library/device/class/hid/Source/standard_hid_core.c
+491
View File
@@ -0,0 +1,491 @@
/*!
\file standard_hid_core.c
\brief HID class driver
\version 2025-01-24, V1.4.0, firmware for GD32H7xx
*/
/*
Copyright (c) 2025, GigaDevice Semiconductor Inc.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors
may be used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
OF SUCH DAMAGE.
*/
#include "standard_hid_core.h"
#include <string.h>
#define USBD_VID 0x28e9U
#define USBD_PID 0x0380U
/* Note:it should use the C99 standard when compiling the below codes */
/* USB standard device descriptor */
__ALIGN_BEGIN const usb_desc_dev hid_dev_desc __ALIGN_END = {
.header =
{
.bLength = USB_DEV_DESC_LEN,
.bDescriptorType = USB_DESCTYPE_DEV
},
#if (1U == LPM_ENABLED)
.bcdUSB = 0x0201U,
#else
.bcdUSB = 0x0200U,
#endif /* LPM_ENABLED */
.bDeviceClass = 0x00U,
.bDeviceSubClass = 0x00U,
.bDeviceProtocol = 0x00U,
.bMaxPacketSize0 = USB_FS_EP0_MAX_LEN,
.idVendor = USBD_VID,
.idProduct = USBD_PID,
.bcdDevice = 0x0100U,
.iManufacturer = STR_IDX_MFC,
.iProduct = STR_IDX_PRODUCT,
.iSerialNumber = STR_IDX_SERIAL,
.bNumberConfigurations = USBD_CFG_MAX_NUM
};
__ALIGN_BEGIN const usb_hid_desc_config_set hid_config_desc __ALIGN_END = {
.config =
{
.header =
{
.bLength = sizeof(usb_desc_config),
.bDescriptorType = USB_DESCTYPE_CONFIG
},
.wTotalLength = USB_HID_CONFIG_DESC_LEN,
.bNumInterfaces = 0x01U,
.bConfigurationValue = 0x01U,
.iConfiguration = 0x00U,
.bmAttributes = 0xA0U,
.bMaxPower = 0x32U
},
.hid_itf =
{
.header =
{
.bLength = sizeof(usb_desc_itf),
.bDescriptorType = USB_DESCTYPE_ITF
},
.bInterfaceNumber = 0x00U,
.bAlternateSetting = 0x00U,
.bNumEndpoints = 0x01U,
.bInterfaceClass = USB_HID_CLASS,
.bInterfaceSubClass = USB_HID_SUBCLASS_BOOT_ITF,
.bInterfaceProtocol = USB_HID_PROTOCOL_KEYBOARD,
.iInterface = 0x00U
},
.hid_vendor =
{
.header =
{
.bLength = sizeof(usb_desc_hid),
.bDescriptorType = USB_DESCTYPE_HID
},
.bcdHID = 0x0111U,
.bCountryCode = 0x00U,
.bNumDescriptors = 0x01U,
.bDescriptorType = USB_DESCTYPE_REPORT,
.wDescriptorLength = USB_HID_REPORT_DESC_LEN,
},
.hid_epin =
{
.header =
{
.bLength = sizeof(usb_desc_ep),
.bDescriptorType = USB_DESCTYPE_EP
},
.bEndpointAddress = HID_IN_EP,
.bmAttributes = USB_EP_ATTR_INT,
.wMaxPacketSize = HID_IN_PACKET,
.bInterval = 0x01U
}
};
__ALIGN_BEGIN const usb_hid_desc_config_set other_speed_hid_config_desc __ALIGN_END = {
.config =
{
.header =
{
.bLength = sizeof(usb_desc_config),
.bDescriptorType = USB_DESCTYPE_OTHER_SPD_CONFIG
},
.wTotalLength = USB_HID_CONFIG_DESC_LEN,
.bNumInterfaces = 0x01U,
.bConfigurationValue = 0x01U,
.iConfiguration = 0x00U,
.bmAttributes = 0xA0U,
.bMaxPower = 0x32U
},
.hid_itf =
{
.header =
{
.bLength = sizeof(usb_desc_itf),
.bDescriptorType = USB_DESCTYPE_ITF
},
.bInterfaceNumber = 0x00U,
.bAlternateSetting = 0x00U,
.bNumEndpoints = 0x01U,
.bInterfaceClass = USB_HID_CLASS,
.bInterfaceSubClass = USB_HID_SUBCLASS_BOOT_ITF,
.bInterfaceProtocol = USB_HID_PROTOCOL_KEYBOARD,
.iInterface = 0x00U
},
.hid_vendor =
{
.header =
{
.bLength = sizeof(usb_desc_hid),
.bDescriptorType = USB_DESCTYPE_HID
},
.bcdHID = 0x0111U,
.bCountryCode = 0x00U,
.bNumDescriptors = 0x01U,
.bDescriptorType = USB_DESCTYPE_REPORT,
.wDescriptorLength = USB_HID_REPORT_DESC_LEN,
},
.hid_epin =
{
.header =
{
.bLength = sizeof(usb_desc_ep),
.bDescriptorType = USB_DESCTYPE_EP
},
.bEndpointAddress = HID_IN_EP,
.bmAttributes = USB_EP_ATTR_INT,
.wMaxPacketSize = HID_IN_PACKET,
.bInterval = 0x01U
}
};
__ALIGN_BEGIN const uint8_t usbd_qualifier_desc[10] __ALIGN_END = {
0x0AU,
0x06U,
0x00U,
0x02U,
0x00U,
0x00U,
0x00U,
0x40U,
0x01U,
0x00U
};
#if (1U == LPM_ENABLED)
/* USBD BOS descriptor */
__ALIGN_BEGIN uint8_t usbd_bos_desc[USB_BOS_DESC_SIZE] __ALIGN_END = {
0x05U,
USB_DESCTYPE_BOS,
0x0CU,
0x00U,
0x01U, /* 1 device capability descriptor */
/* device capability*/
0x07U,
USB_DEVICE_CAPABITY,
0x02U,
0x06U, /* LPM capability bit set */
0x00U,
0x00U,
0x00U
};
#endif /* LPM_ENABLED */
/* USB language ID descriptor */
__ALIGN_BEGIN const usb_desc_LANGID usbd_language_id_desc __ALIGN_END = {
.header =
{
.bLength = sizeof(usb_desc_LANGID),
.bDescriptorType = USB_DESCTYPE_STR
},
.wLANGID = ENG_LANGID
};
/* USB manufacture string */
__ALIGN_BEGIN static const usb_desc_str manufacturer_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(10U),
.bDescriptorType = USB_DESCTYPE_STR,
},
.unicode_string = {'G', 'i', 'g', 'a', 'D', 'e', 'v', 'i', 'c', 'e'}
};
/* USB product string */
__ALIGN_BEGIN static const usb_desc_str product_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(17U),
.bDescriptorType = USB_DESCTYPE_STR,
},
.unicode_string = {'G', 'D', '3', '2', '-', 'U', 'S', 'B', '_', 'K', 'e', 'y', 'b', 'o', 'a', 'r', 'd'}
};
/* USBD serial string */
__ALIGN_BEGIN static usb_desc_str serial_string __ALIGN_END = {
.header =
{
.bLength = USB_STRING_LEN(12U),
.bDescriptorType = USB_DESCTYPE_STR,
}
};
void *const usbd_hid_strings[] = {
[STR_IDX_LANGID] = (uint8_t *)&usbd_language_id_desc,
[STR_IDX_MFC] = (uint8_t *)&manufacturer_string,
[STR_IDX_PRODUCT] = (uint8_t *)&product_string,
[STR_IDX_SERIAL] = (uint8_t *)&serial_string
};
usb_desc hid_desc = {
.dev_desc = (uint8_t *)&hid_dev_desc,
.config_desc = (uint8_t *)&hid_config_desc,
#if (1 == LPM_ENABLED)
.bos_desc = (uint8_t *)&usbd_bos_desc,
#endif /* LPM_ENABLED */
#ifdef USE_USB_HS
.other_speed_config_desc = (uint8_t *)&other_speed_hid_config_desc,
.qualifier_desc = (uint8_t *)&usbd_qualifier_desc,
#endif
.strings = usbd_hid_strings
};
__ALIGN_BEGIN const uint8_t hid_report_desc[USB_HID_REPORT_DESC_LEN] __ALIGN_END = {
0x05U, 0x01U, /* USAGE_PAGE (Generic Desktop) */
0x09U, 0x06U, /* USAGE (Keyboard) */
0xa1U, 0x01U, /* COLLECTION (Application) */
0x05U, 0x07U, /* USAGE_PAGE (Keyboard/Keypad) */
0x19U, 0xe0U, /* USAGE_MINIMUM (Keyboard LeftControl) */
0x29U, 0xe7U, /* USAGE_MAXIMUM (Keyboard Right GUI) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x25U, 0x01U, /* LOGICAL_MAXIMUM (1) */
0x95U, 0x08U, /* REPORT_COUNT (8) */
0x75U, 0x01U, /* REPORT_SIZE (1) */
0x81U, 0x02U, /* INPUT (Data,Var,Abs) */
0x95U, 0x01U, /* REPORT_COUNT (1) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x81U, 0x03U, /* INPUT (Cnst,Var,Abs) */
0x95U, 0x06U, /* REPORT_COUNT (6) */
0x75U, 0x08U, /* REPORT_SIZE (8) */
0x15U, 0x00U, /* LOGICAL_MINIMUM (0) */
0x26U, 0xFFU, 0x00U, /* LOGICAL_MAXIMUM (255) */
0x05U, 0x07U, /* USAGE_PAGE (Keyboard/Keypad) */
0x19U, 0x00U, /* USAGE_MINIMUM (Reserved (no event indicated)) */
0x29U, 0x65U, /* USAGE_MAXIMUM (Keyboard Application) */
0x81U, 0x00U, /* INPUT (Data,Ary,Abs) */
0xc0U /* END_COLLECTION */
};
/* local function prototypes ('static') */
static uint8_t hid_init(usb_dev *udev, uint8_t config_index);
static uint8_t hid_deinit(usb_dev *udev, uint8_t config_index);
static uint8_t hid_req(usb_dev *udev, usb_req *req);
static uint8_t hid_data_in(usb_dev *udev, uint8_t ep_num);
usb_class_core usbd_hid_cb = {
.command = NO_CMD,
.alter_set = 0U,
.init = hid_init,
.deinit = hid_deinit,
.req_proc = hid_req,
.data_in = hid_data_in
};
/*!
\brief register HID interface operation functions
\param[in] udev: pointer to USB device instance
\param[in] hid_fop: HID operation function structure
\param[out] none
\retval USB device operation status
*/
uint8_t hid_itfop_register(usb_dev *udev, hid_fop_handler *hid_fop)
{
if(NULL != hid_fop) {
udev->dev.user_data = (void *)hid_fop;
return USBD_OK;
}
return USBD_FAIL;
}
/*!
\brief send keyboard report
\param[in] udev: pointer to USB device instance
\param[in] report: pointer to HID report
\param[in] len: data length
\param[out] none
\retval USB device operation status
*/
uint8_t hid_report_send(usb_dev *udev, uint8_t *report, uint32_t len)
{
standard_hid_handler *hid = (standard_hid_handler *)udev->dev.class_data[USBD_HID_INTERFACE];
hid->prev_transfer_complete = 0U;
usbd_ep_send(udev, HID_IN_EP, report, len);
return USBD_OK;
}
/*!
\brief initialize the HID device
\param[in] udev: pointer to USB device instance
\param[in] config_index: configuration index
\param[out] none
\retval USB device operation status
*/
static uint8_t hid_init(usb_dev *udev, uint8_t config_index)
{
static standard_hid_handler hid_handler;
memset((void *)&hid_handler, 0U, sizeof(standard_hid_handler));
/* initialize the data TX endpoint */
usbd_ep_setup(udev, &(hid_config_desc.hid_epin));
hid_handler.prev_transfer_complete = 1U;
udev->dev.class_data[USBD_HID_INTERFACE] = (void *)&hid_handler;
if(NULL != udev->dev.user_data) {
((hid_fop_handler *)udev->dev.user_data)->hid_itf_config();
}
return USBD_OK;
}
/*!
\brief de-initialize the HID device
\param[in] udev: pointer to USB device instance
\param[in] config_index: configuration index
\param[out] none
\retval USB device operation status
*/
static uint8_t hid_deinit(usb_dev *udev, uint8_t config_index)
{
/* deinitialize HID endpoints */
usbd_ep_clear(udev, HID_IN_EP);
return USBD_OK;
}
/*!
\brief handle the HID class-specific requests
\param[in] udev: pointer to USB device instance
\param[in] req: device class-specific request
\param[out] none
\retval USB device operation status
*/
static uint8_t hid_req(usb_dev *udev, usb_req *req)
{
usb_transc *transc = &udev->dev.transc_in[0];
standard_hid_handler *hid = (standard_hid_handler *)udev->dev.class_data[USBD_HID_INTERFACE];
switch(req->bRequest) {
case GET_REPORT:
/* no use for this driver */
break;
case GET_IDLE:
transc->xfer_buf = (uint8_t *)&hid->idle_state;
transc->remain_len = 1U;
break;
case GET_PROTOCOL:
transc->xfer_buf = (uint8_t *)&hid->protocol;
transc->remain_len = 1U;
break;
case SET_REPORT:
/* no use for this driver */
break;
case SET_IDLE:
hid->idle_state = (uint8_t)(req->wValue >> 8);
break;
case SET_PROTOCOL:
hid->protocol = (uint8_t)(req->wValue);
break;
case USB_GET_DESCRIPTOR:
if(USB_DESCTYPE_REPORT == (req->wValue >> 8)) {
transc->remain_len = USB_MIN(USB_HID_REPORT_DESC_LEN, req->wLength);
transc->xfer_buf = (uint8_t *)hid_report_desc;
return REQ_SUPP;
} else if(USB_DESCTYPE_HID == (req->wValue >> 8)) {
transc->remain_len = USB_MIN(9U, req->wLength);
transc->xfer_buf = (uint8_t *)(&(hid_config_desc.hid_vendor));
} else {
/* no operation */
}
break;
default:
break;
}
return USBD_OK;
}
/*!
\brief handle data stage
\param[in] udev: pointer to USB device instance
\param[in] ep_num: endpoint identifier
\param[out] none
\retval USB device operation status
*/
static uint8_t hid_data_in(usb_dev *udev, uint8_t ep_num)
{
standard_hid_handler *hid = (standard_hid_handler *)udev->dev.class_data[USBD_HID_INTERFACE];
if(0U != hid->data[2]) {
hid->data[2] = 0x00U;
usbd_ep_send(udev, HID_IN_EP, hid->data, HID_IN_PACKET);
} else {
hid->prev_transfer_complete = 1U;
}
return USBD_OK;
}