/****************************************************************************** * @file usbd.h * @version V3.00 * @brief M261 series USBD driver header file * * @copyright (C) 2019 Nuvoton Technology Corp. All rights reserved. * * 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 Nuvoton Technology Corp. 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 __USBD_H__ #define __USBD_H__ //#define SUPPORT_LPM // define to support LPM #ifdef __cplusplus extern "C" { #endif /** @addtogroup Standard_Driver Standard Driver @{ */ /** @addtogroup USBD_Driver USBD Driver @{ */ /** @addtogroup USBD_EXPORTED_STRUCTS USBD Exported Structs @{ */ typedef struct s_usbd_info { uint8_t *gu8DevDesc; /*!< Pointer for USB Device Descriptor */ uint8_t *gu8ConfigDesc; /*!< Pointer for USB Configuration Descriptor */ uint8_t **gu8StringDesc; /*!< Pointer for USB String Descriptor pointers */ uint8_t **gu8HidReportDesc; /*!< Pointer for USB HID Report Descriptor */ uint8_t *gu8BosDesc; /*!< Pointer for USB BOS Descriptor */ uint32_t *gu32HidReportSize; /*!< Pointer for HID Report descriptor Size */ uint32_t *gu32ConfigHidDescIdx; /*!< Pointer for HID Descriptor start index */ } S_USBD_INFO_T; /*!< Device description structure */ extern const S_USBD_INFO_T gsInfo; /*@}*/ /* end of group USBD_EXPORTED_STRUCTS */ /** @addtogroup USBD_EXPORTED_CONSTANTS USBD Exported Constants @{ */ #define USBD_BUF_BASE ((uint32_t)(USBD_BASE+0x100UL)) /*!< USBD buffer base address */ #define USBD_MAX_EP 12UL /*!< Total EP number */ #define EP0 0UL /*!< Endpoint 0 */ #define EP1 1UL /*!< Endpoint 1 */ #define EP2 2UL /*!< Endpoint 2 */ #define EP3 3UL /*!< Endpoint 3 */ #define EP4 4UL /*!< Endpoint 4 */ #define EP5 5UL /*!< Endpoint 5 */ #define EP6 6UL /*!< Endpoint 6 */ #define EP7 7UL /*!< Endpoint 7 */ #define EP8 8UL /*!< Endpoint 8 */ #define EP9 9UL /*!< Endpoint 9 */ #define EP10 10UL /*!< Endpoint 10 */ #define EP11 11UL /*!< Endpoint 11 */ /** @cond HIDDEN_SYMBOLS */ /* USB Request Type */ #define REQ_STANDARD 0x00UL #define REQ_CLASS 0x20UL #define REQ_VENDOR 0x40UL /* USB Standard Request */ #define GET_STATUS 0x00UL #define CLEAR_FEATURE 0x01UL #define SET_FEATURE 0x03UL #define SET_ADDRESS 0x05UL #define GET_DESCRIPTOR 0x06UL #define SET_DESCRIPTOR 0x07UL #define GET_CONFIGURATION 0x08UL #define SET_CONFIGURATION 0x09UL #define GET_INTERFACE 0x0AUL #define SET_INTERFACE 0x0BUL #define SYNC_FRAME 0x0CUL /* USB Descriptor Type */ #define DESC_DEVICE 0x01UL #define DESC_CONFIG 0x02UL #define DESC_STRING 0x03UL #define DESC_INTERFACE 0x04UL #define DESC_ENDPOINT 0x05UL #define DESC_QUALIFIER 0x06UL #define DESC_OTHERSPEED 0x07UL #define DESC_IFPOWER 0x08UL #define DESC_OTG 0x09UL #define DESC_BOS 0x0FUL #define DESC_CAPABILITY 0x10UL /* USB Device Capability Type */ #define CAP_WIRELESS 0x01UL #define CAP_USB20_EXT 0x02UL /*! b, then return a. Otherwise, return b. */ #define USBD_Maximum(a,b) ((a)>(b) ? (a) : (b)) /** * @brief Compare two input numbers and return minimum one * * @param[in] a First number to be compared * @param[in] b Second number to be compared * * @return Minimum value between a and b * * @details If a < b, then return a. Otherwise, return b. */ #define USBD_Minimum(a,b) ((a)<(b) ? (a) : (b)) /** * @brief Enable USB * * @param None * * @return None * * @details To set USB ATTR control register to enable USB and PHY. * */ #define USBD_ENABLE_USB() ((uint32_t)(USBD->ATTR |= 0x7D0)) /** * @brief Disable USB * * @param None * * @return None * * @details To set USB ATTR control register to disable USB. * */ #define USBD_DISABLE_USB() ((uint32_t)(USBD->ATTR &= ~USBD_USB_EN)) /** * @brief Enable USB PHY * * @param None * * @return None * * @details To set USB ATTR control register to enable USB PHY. * */ #define USBD_ENABLE_PHY() ((uint32_t)(USBD->ATTR |= USBD_PHY_EN)) /** * @brief Disable USB PHY * * @param None * * @return None * * @details To set USB ATTR control register to disable USB PHY. * */ #define USBD_DISABLE_PHY() ((uint32_t)(USBD->ATTR &= ~USBD_PHY_EN)) /** * @brief Enable SE0. Force USB PHY transceiver to drive SE0. * * @param None * * @return None * * @details Set DRVSE0 bit of USB_DRVSE0 register to enable software-disconnect function. Force USB PHY transceiver to drive SE0 to bus. * */ #define USBD_SET_SE0() ((uint32_t)(USBD->SE0 |= USBD_DRVSE0)) /** * @brief Disable SE0 * * @param None * * @return None * * @details Clear DRVSE0 bit of USB_DRVSE0 register to disable software-disconnect function. * */ #define USBD_CLR_SE0() ((uint32_t)(USBD->SE0 &= ~USBD_DRVSE0)) /** * @brief Set USB device address * * @param[in] addr The USB device address. * * @return None * * @details Write USB device address to USB_FADDR register. * */ #define USBD_SET_ADDR(addr) (USBD->FADDR = (addr)) /** * @brief Get USB device address * * @param None * * @return USB device address * * @details Read USB_FADDR register to get USB device address. * */ #define USBD_GET_ADDR() ((uint32_t)(USBD->FADDR)) /** * @brief Enable USB interrupt function * * @param[in] intr The combination of the specified interrupt enable bits. * Each bit corresponds to a interrupt enable bit. * This parameter decides which interrupts will be enabled. * (USBD_INT_WAKEUP, USBD_INT_FLDET, USBD_INT_USB, USBD_INT_BUS) * * @return None * * @details Enable USB related interrupt functions specified by intr parameter. * */ #define USBD_ENABLE_INT(intr) (USBD->INTEN |= (intr)) /** * @brief Get interrupt status * * @param None * * @return The value of USB_INTSTS register * * @details Return all interrupt flags of USB_INTSTS register. * */ #define USBD_GET_INT_FLAG() ((uint32_t)(USBD->INTSTS)) /** * @brief Clear USB interrupt flag * * @param[in] flag The combination of the specified interrupt flags. * Each bit corresponds to a interrupt source. * This parameter decides which interrupt flags will be cleared. * (USBD_INTSTS_WAKEUP, USBD_INTSTS_FLDET, USBD_INTSTS_BUS, USBD_INTSTS_USB) * * @return None * * @details Clear USB related interrupt flags specified by flag parameter. * */ #define USBD_CLR_INT_FLAG(flag) (USBD->INTSTS = (flag)) /** * @brief Get endpoint status * * @param None * * @return The value of USB_EPSTS register. * * @details Return all endpoint status. * */ #define USBD_GET_EP_FLAG() ((uint32_t)(USBD->EPSTS)) /** * @brief Get USB bus state * * @param None * * @return The value of USB_ATTR[13:12] and USB_ATTR[3:0]. * Bit 0 indicates USB bus reset status. * Bit 1 indicates USB bus suspend status. * Bit 2 indicates USB bus resume status. * Bit 3 indicates USB bus time-out status. * Bit 12 indicates USB bus LPM L1 suspend status. * Bit 13 indicates USB bus LPM L1 resume status. * * @details Return USB_ATTR[13:12] and USB_ATTR[3:0] for USB bus events. * */ #define USBD_GET_BUS_STATE() ((uint32_t)(USBD->ATTR & 0x300F)) /** * @brief Check cable connection state * * @param None * * @retval 0 USB cable is not attached. * @retval 1 USB cable is attached. * * @details Check the connection state by FLDET bit of USB_FLDET register. * */ #define USBD_IS_ATTACHED() ((uint32_t)(USBD->VBUSDET & USBD_VBUSDET_VBUSDET_Msk)) /** * @brief Stop USB transaction of the specified endpoint ID * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return None * * @details Write 1 to CLRRDY bit of USB_CFGPx register to stop USB transaction of the specified endpoint ID. * */ #define USBD_STOP_TRANSACTION(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_CLRRDY_Msk) /** * @brief Set USB DATA1 PID for the specified endpoint ID * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return None * * @details Set DSQ_SYNC bit of USB_CFGx register to specify the DATA1 PID for the following IN token transaction. * Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions. * */ #define USBD_SET_DATA1(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQSYNC_Msk) /** * @brief Set USB DATA0 PID for the specified endpoint ID * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return None * * @details Clear DSQ_SYNC bit of USB_CFGx register to specify the DATA0 PID for the following IN token transaction. * Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions. * */ #define USBD_SET_DATA0(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk)) /** * @brief Set USB payload size (IN data) * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @param[in] size The transfer length. * * @return None * * @details This macro will write the transfer length to USB_MXPLDx register for IN data transaction. * */ #define USBD_SET_PAYLOAD_LEN(ep, size) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size)) /** * @brief Get USB payload size (OUT data) * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return The value of USB_MXPLDx register. * * @details Get the data length of OUT data transaction by reading USB_MXPLDx register. * */ #define USBD_GET_PAYLOAD_LEN(ep) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4)))) /** * @brief Configure endpoint * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @param[in] config The USB configuration. * * @return None * * @details This macro will write config parameter to USB_CFGx register of specified endpoint ID. * */ #define USBD_CONFIG_EP(ep, config) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config)) /** * @brief Set USB endpoint buffer * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @param[in] offset The SRAM offset. * * @return None * * @details This macro will set the SRAM offset for the specified endpoint ID. * */ #define USBD_SET_EP_BUF_ADDR(ep, offset) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset)) /** * @brief Get the offset of the specified USB endpoint buffer * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return The offset of the specified endpoint buffer. * * @details This macro will return the SRAM offset of the specified endpoint ID. * */ #define USBD_GET_EP_BUF_ADDR(ep) ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4)))) /** * @brief Set USB endpoint stall state * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return None * * @details Set USB endpoint stall state for the specified endpoint ID. Endpoint will respond STALL token automatically. * */ #define USBD_SET_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_SSTALL_Msk) /** * @brief Clear USB endpoint stall state * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @return None * * @details Clear USB endpoint stall state for the specified endpoint ID. Endpoint will respond ACK/NAK token. */ #define USBD_CLR_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk) /** * @brief Get USB endpoint stall state * * @param[in] ep The USB endpoint ID. M261 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11. * * @retval 0 USB endpoint is not stalled. * @retval Others USB endpoint is stalled. * * @details Get USB endpoint stall state of the specified endpoint ID. * */ #define USBD_GET_EP_STALL(ep) (*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk) /** * @brief To support byte access between USB SRAM and system SRAM * * @param[in] dest Destination pointer. * * @param[in] src Source pointer. * * @param[in] size Byte count. * * @return None * * @details This function will copy the number of data specified by size and src parameters to the address specified by dest parameter. * */ __STATIC_INLINE void USBD_MemCopy(uint8_t dest[], uint8_t src[], uint32_t size) { uint32_t volatile i = 0UL; while(size--) { dest[i] = src[i]; i++; } } /** * @brief Set USB endpoint stall state * * @param[in] epnum USB endpoint number * * @return None * * @details Set USB endpoint stall state. Endpoint will respond STALL token automatically. * */ __STATIC_INLINE void USBD_SetStall(uint8_t epnum) { uint32_t u32CfgAddr; uint32_t u32Cfg; uint32_t i; USBD_T *pUSBD; pUSBD = USBD; for(i = 0UL; i < USBD_MAX_EP; i++) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */ u32Cfg = *((__IO uint32_t *)(u32CfgAddr)); if((u32Cfg & 0xFUL) == epnum) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */ u32Cfg = *((__IO uint32_t *)(u32CfgAddr)); *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg | USBD_CFGP_SSTALL); break; } } } /** * @brief Clear USB endpoint stall state * * @param[in] epnum USB endpoint number * * @return None * * @details Clear USB endpoint stall state. Endpoint will respond ACK/NAK token. */ __STATIC_INLINE void USBD_ClearStall(uint8_t epnum) { uint32_t u32CfgAddr; uint32_t u32Cfg; uint32_t i; USBD_T *pUSBD; pUSBD = USBD; for(i = 0UL; i < USBD_MAX_EP; i++) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */ u32Cfg = *((__IO uint32_t *)(u32CfgAddr)); if((u32Cfg & 0xFUL) == epnum) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */ u32Cfg = *((__IO uint32_t *)(u32CfgAddr)); *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg & ~USBD_CFGP_SSTALL); break; } } } /** * @brief Get USB endpoint stall state * * @param[in] epnum USB endpoint number * * @retval 0 USB endpoint is not stalled. * @retval Others USB endpoint is stalled. * * @details Get USB endpoint stall state. * */ __STATIC_INLINE uint32_t USBD_GetStall(uint8_t epnum) { uint32_t u32CfgAddr; uint32_t u32Cfg; uint32_t i; USBD_T *pUSBD; pUSBD = USBD; for(i = 0UL; i < USBD_MAX_EP; i++) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */ u32Cfg = *((__IO uint32_t *)(u32CfgAddr)); if((u32Cfg & 0xFUL) == epnum) { u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */ break; } } return ((*((__IO uint32_t *)(u32CfgAddr))) & USBD_CFGP_SSTALL); } extern volatile uint8_t g_USBD_u8RemoteWakeupEn; typedef void (*VENDOR_REQ)(void); /*!< Functional pointer type definition for Vendor class */ typedef void (*CLASS_REQ)(void); /*!< Functional pointer type declaration for USB class request callback handler */ typedef void (*SET_INTERFACE_REQ)(uint32_t u32AltInterface); /*!< Functional pointer type declaration for USB set interface request callback handler */ typedef void (*SET_CONFIG_CB)(void); /*!< Functional pointer type declaration for USB set configuration request callback handler */ /*--------------------------------------------------------------------*/ void USBD_Open(const S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface); void USBD_Start(void); void USBD_GetSetupPacket(uint8_t *buf); void USBD_ProcessSetupPacket(void); void USBD_StandardRequest(void); void USBD_PrepareCtrlIn(uint8_t pu8Buf[], uint32_t u32Size); void USBD_CtrlIn(void); void USBD_PrepareCtrlOut(uint8_t *pu8Buf, uint32_t u32Size); void USBD_CtrlOut(void); void USBD_SwReset(void); void USBD_SetVendorRequest(VENDOR_REQ pfnVendorReq); void USBD_SetConfigCallback(SET_CONFIG_CB pfnSetConfigCallback); void USBD_LockEpStall(uint32_t u32EpBitmap); /*@}*/ /* end of group USBD_EXPORTED_FUNCTIONS */ /*@}*/ /* end of group USBD_Driver */ /*@}*/ /* end of group Standard_Driver */ #ifdef __cplusplus } #endif #endif /* __USBD_H__ */ /*** (C) COPYRIGHT 2019 Nuvoton Technology Corp. ***/