/** ************************************************************************** * @file hid_iap_class.c * @brief usb hid iap class type ************************************************************************** * * Copyright (c) 2025, Artery Technology, All rights reserved. * * The software Board Support Package (BSP) that is made available to * download from Artery official website is the copyrighted work of Artery. * Artery authorizes customers to use, copy, and distribute the BSP * software and its related documentation for the purpose of design and * development in conjunction with Artery microcontrollers. Use of the * software is governed by this copyright notice and the following disclaimer. * * THIS SOFTWARE IS PROVIDED ON "AS IS" BASIS WITHOUT WARRANTIES, * GUARANTEES OR REPRESENTATIONS OF ANY KIND. ARTERY EXPRESSLY DISCLAIMS, * TO THE FULLEST EXTENT PERMITTED BY LAW, ALL EXPRESS, IMPLIED OR * STATUTORY OR OTHER WARRANTIES, GUARANTEES OR REPRESENTATIONS, * INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. * ************************************************************************** */ #include "usbd_core.h" #include "hid_iap_class.h" #include "hid_iap_desc.h" /** @addtogroup AT32F403A_407_middlewares_usbd_class * @{ */ /** @defgroup USB_hid_iap_class * @brief usb device class hid iap demo * @{ */ /** @defgroup USB_hid_iap_class_private_functions * @{ */ static usb_sts_type class_init_handler(void *udev); static usb_sts_type class_clear_handler(void *udev); static usb_sts_type class_setup_handler(void *udev, usb_setup_type *setup); static usb_sts_type class_ept0_tx_handler(void *udev); static usb_sts_type class_ept0_rx_handler(void *udev); static usb_sts_type class_in_handler(void *udev, uint8_t ept_num); static usb_sts_type class_out_handler(void *udev, uint8_t ept_num); static usb_sts_type class_sof_handler(void *udev); static usb_sts_type class_event_handler(void *udev, usbd_event_type event); iap_info_type iap_info; /* usb device class handler */ usbd_class_handler hid_iap_class_handler = { class_init_handler, class_clear_handler, class_setup_handler, class_ept0_tx_handler, class_ept0_rx_handler, class_in_handler, class_out_handler, class_sof_handler, class_event_handler, &iap_info }; /** * @brief initialize usb custom hid endpoint * @param udev: to the structure of usbd_core_type * @retval status of usb_sts_type */ static usb_sts_type class_init_handler(void *udev) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; iap_info_type *piap = (iap_info_type *)pudev->class_handler->pdata; /* open hid iap in endpoint */ usbd_ept_open(pudev, USBD_HIDIAP_IN_EPT, EPT_INT_TYPE, USBD_HIDIAP_IN_MAXPACKET_SIZE); /* open hid iap out endpoint */ usbd_ept_open(pudev, USBD_HIDIAP_OUT_EPT, EPT_INT_TYPE, USBD_HIDIAP_OUT_MAXPACKET_SIZE); /* set out endpoint to receive status */ usbd_ept_recv(pudev, USBD_HIDIAP_OUT_EPT, piap->g_rxhid_buff, USBD_HIDIAP_OUT_MAXPACKET_SIZE); return status; } /** * @brief clear endpoint or other state * @param udev: to the structure of usbd_core_type * @retval status of usb_sts_type */ static usb_sts_type class_clear_handler(void *udev) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; /* close hid iap in endpoint */ usbd_ept_close(pudev, USBD_HIDIAP_IN_EPT); /* close hid iap out endpoint */ usbd_ept_close(pudev, USBD_HIDIAP_OUT_EPT); return status; } /** * @brief usb device class setup request handler * @param udev: to the structure of usbd_core_type * @param setup: setup packet * @retval status of usb_sts_type */ static usb_sts_type class_setup_handler(void *udev, usb_setup_type *setup) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; iap_info_type *piap = (iap_info_type *)pudev->class_handler->pdata; uint16_t len; uint8_t *buf; switch(setup->bmRequestType & USB_REQ_TYPE_RESERVED) { /* class request */ case USB_REQ_TYPE_CLASS: switch(setup->bRequest) { case HID_REQ_SET_PROTOCOL: piap->hid_protocol = (uint8_t)setup->wValue; break; case HID_REQ_GET_PROTOCOL: usbd_ctrl_send(pudev, (uint8_t *)&piap->hid_protocol, 1); break; case HID_REQ_SET_IDLE: piap->hid_set_idle = (uint8_t)(setup->wValue >> 8); break; case HID_REQ_GET_IDLE: usbd_ctrl_send(pudev, (uint8_t *)&piap->hid_set_idle, 1); break; case HID_REQ_SET_REPORT: piap->hid_state = HID_REQ_SET_REPORT; usbd_ctrl_recv(pudev, piap->hid_set_report, setup->wLength); break; default: usbd_ctrl_unsupport(pudev); break; } break; /* standard request */ case USB_REQ_TYPE_STANDARD: switch(setup->bRequest) { case USB_STD_REQ_GET_DESCRIPTOR: if(setup->wValue >> 8 == HID_REPORT_DESC) { len = MIN(USBD_HIDIAP_SIZ_REPORT_DESC, setup->wLength); buf = (uint8_t *)g_usbd_hidiap_report; usbd_ctrl_send(pudev, (uint8_t *)buf, len); } else if(setup->wValue >> 8 == HID_DESCRIPTOR_TYPE) { len = MIN(9, setup->wLength); buf = (uint8_t *)g_hidiap_usb_desc; usbd_ctrl_send(pudev, (uint8_t *)buf, len); } else { usbd_ctrl_unsupport(pudev); } break; case USB_STD_REQ_GET_INTERFACE: usbd_ctrl_send(pudev, (uint8_t *)&piap->alt_setting, 1); break; case USB_STD_REQ_SET_INTERFACE: piap->alt_setting = setup->wValue; break; case USB_STD_REQ_CLEAR_FEATURE: break; case USB_STD_REQ_SET_FEATURE: break; default: usbd_ctrl_unsupport(pudev); break; } break; default: usbd_ctrl_unsupport(pudev); break; } return status; } /** * @brief usb device endpoint 0 in status stage complete * @param udev: to the structure of usbd_core_type * @retval status of usb_sts_type */ static usb_sts_type class_ept0_tx_handler(void *udev) { usb_sts_type status = USB_OK; /* ...user code... */ return status; } /** * @brief usb device endpoint 0 out status stage complete * @param udev: to the structure of usbd_core_type * @retval status of usb_sts_type */ static usb_sts_type class_ept0_rx_handler(void *udev) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; iap_info_type *piap = (iap_info_type *)pudev->class_handler->pdata; uint32_t recv_len = usbd_get_recv_len(pudev, 0); /* ...user code... */ if( piap->hid_state == HID_REQ_SET_REPORT) { /* hid buffer process */ piap->hid_state = 0; } return status; } /** * @brief usb device transmision complete handler * @param udev: to the structure of usbd_core_type * @param ept_num: endpoint number * @retval status of usb_sts_type */ static usb_sts_type class_in_handler(void *udev, uint8_t ept_num) { usb_sts_type status = USB_OK; /* ...user code... trans next packet data */ usbd_hid_iap_in_complete(udev); return status; } /** * @brief usb device endpoint receive data * @param udev: to the structure of usbd_core_type * @param ept_num: endpoint number * @retval status of usb_sts_type */ static usb_sts_type class_out_handler(void *udev, uint8_t ept_num) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; iap_info_type *piap = (iap_info_type *)pudev->class_handler->pdata; /* get endpoint receive data length */ uint32_t recv_len = usbd_get_recv_len(pudev, ept_num); /* hid iap process */ usbd_hid_iap_process(udev, piap->g_rxhid_buff, recv_len); /* start receive next packet */ usbd_ept_recv(pudev, USBD_HIDIAP_OUT_EPT, piap->g_rxhid_buff, USBD_HIDIAP_OUT_MAXPACKET_SIZE); return status; } /** * @brief usb device sof handler * @param udev: to the structure of usbd_core_type * @retval status of usb_sts_type */ static usb_sts_type class_sof_handler(void *udev) { usb_sts_type status = USB_OK; /* ...user code... */ return status; } /** * @brief usb device event handler * @param udev: to the structure of usbd_core_type * @param event: usb device event * @retval status of usb_sts_type */ static usb_sts_type class_event_handler(void *udev, usbd_event_type event) { usb_sts_type status = USB_OK; switch(event) { case USBD_RESET_EVENT: /* ...user code... */ break; case USBD_SUSPEND_EVENT: /* ...user code... */ break; case USBD_WAKEUP_EVENT: /* ...user code... */ break; default: break; } return status; } /** * @brief usb device class send report * @param udev: to the structure of usbd_core_type * @param report: report buffer * @param len: report length * @retval status of usb_sts_type */ usb_sts_type usb_iap_class_send_report(void *udev, uint8_t *report, uint16_t len) { usb_sts_type status = USB_OK; usbd_core_type *pudev = (usbd_core_type *)udev; if(usbd_connect_state_get(pudev) == USB_CONN_STATE_CONFIGURED) usbd_ept_send(pudev, USBD_HIDIAP_IN_EPT, report, len); return status; } /** * @} */ /** * @} */ /** * @} */