]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS/Demo/CORTEX_MPU_M23_Nuvoton_NuMaker_PFM_M2351_IAR_GCC/Nuvoton_Code/StdDriver/inc/usbd.h
Add Cortex M23 GCC and IAR ports. Add demo projects for Nuvoton NuMaker-PFM-2351.
[freertos] / FreeRTOS / Demo / CORTEX_MPU_M23_Nuvoton_NuMaker_PFM_M2351_IAR_GCC / Nuvoton_Code / StdDriver / inc / usbd.h
diff --git a/FreeRTOS/Demo/CORTEX_MPU_M23_Nuvoton_NuMaker_PFM_M2351_IAR_GCC/Nuvoton_Code/StdDriver/inc/usbd.h b/FreeRTOS/Demo/CORTEX_MPU_M23_Nuvoton_NuMaker_PFM_M2351_IAR_GCC/Nuvoton_Code/StdDriver/inc/usbd.h
new file mode 100644 (file)
index 0000000..eedcd3c
--- /dev/null
@@ -0,0 +1,727 @@
+/******************************************************************************\r
+ * @file     usbd.h\r
+ * @version  V3.00\r
+ * @brief    M2351 series USBD driver header file\r
+ *\r
+ * @copyright (C) 2018 Nuvoton Technology Corp. All rights reserved.\r
+ ******************************************************************************/\r
+#ifndef __USBD_H__\r
+#define __USBD_H__\r
+\r
+//#define SUPPORT_LPM     // define to support LPM\r
+\r
+#ifdef __cplusplus\r
+extern "C"\r
+{\r
+#endif\r
+\r
+\r
+/** @addtogroup Standard_Driver Standard Driver\r
+  @{\r
+*/\r
+\r
+/** @addtogroup USBD_Driver USBD Driver\r
+  @{\r
+*/\r
+\r
+/** @addtogroup USBD_EXPORTED_STRUCTS USBD Exported Structs\r
+  @{\r
+*/\r
+typedef struct s_usbd_info\r
+{\r
+    uint8_t *gu8DevDesc;            /*!< Pointer for USB Device Descriptor          */\r
+    uint8_t *gu8ConfigDesc;         /*!< Pointer for USB Configuration Descriptor   */\r
+    uint8_t **gu8StringDesc;        /*!< Pointer for USB String Descriptor pointers */\r
+    uint8_t **gu8HidReportDesc;     /*!< Pointer for USB HID Report Descriptor      */\r
+    uint8_t *gu8BosDesc;            /*!< Pointer for USB BOS Descriptor             */\r
+    uint32_t *gu32HidReportSize;    /*!< Pointer for HID Report descriptor Size */\r
+    uint32_t *gu32ConfigHidDescIdx; /*!< Pointer for HID Descriptor start index */\r
+\r
+} S_USBD_INFO_T;  /*!< Device description structure */\r
+\r
+extern const S_USBD_INFO_T gsInfo;\r
+\r
+/*@}*/ /* end of group USBD_EXPORTED_STRUCTS */\r
+\r
+\r
+\r
+\r
+/** @addtogroup USBD_EXPORTED_CONSTANTS USBD Exported Constants\r
+  @{\r
+*/\r
+#define USBD_BUF_BASE      (uint32_t)(((__PC() & NS_OFFSET) == NS_OFFSET)? (USBD_BASE+NS_OFFSET+0x100UL):(USBD_BASE+0x100UL))  /*!< USBD buffer base address */\r
+#define USBD_MAX_EP        12UL  /*!< Total EP number */\r
+\r
+#define EP0     0UL       /*!< Endpoint 0 */\r
+#define EP1     1UL       /*!< Endpoint 1 */\r
+#define EP2     2UL       /*!< Endpoint 2 */\r
+#define EP3     3UL       /*!< Endpoint 3 */\r
+#define EP4     4UL       /*!< Endpoint 4 */\r
+#define EP5     5UL       /*!< Endpoint 5 */\r
+#define EP6     6UL       /*!< Endpoint 6 */\r
+#define EP7     7UL       /*!< Endpoint 7 */\r
+#define EP8     8UL       /*!< Endpoint 8 */\r
+#define EP9     9UL       /*!< Endpoint 9 */\r
+#define EP10    10UL      /*!< Endpoint 10 */\r
+#define EP11    11UL      /*!< Endpoint 11 */\r
+\r
+/** @cond HIDDEN_SYMBOLS */\r
+/* USB Request Type */\r
+#define REQ_STANDARD        0x00UL\r
+#define REQ_CLASS           0x20UL\r
+#define REQ_VENDOR          0x40UL\r
+\r
+/* USB Standard Request */\r
+#define GET_STATUS          0x00UL\r
+#define CLEAR_FEATURE       0x01UL\r
+#define SET_FEATURE         0x03UL\r
+#define SET_ADDRESS         0x05UL\r
+#define GET_DESCRIPTOR      0x06UL\r
+#define SET_DESCRIPTOR      0x07UL\r
+#define GET_CONFIGURATION   0x08UL\r
+#define SET_CONFIGURATION   0x09UL\r
+#define GET_INTERFACE       0x0AUL\r
+#define SET_INTERFACE       0x0BUL\r
+#define SYNC_FRAME          0x0CUL\r
+\r
+/* USB Descriptor Type */\r
+#define DESC_DEVICE         0x01UL\r
+#define DESC_CONFIG         0x02UL\r
+#define DESC_STRING         0x03UL\r
+#define DESC_INTERFACE      0x04UL\r
+#define DESC_ENDPOINT       0x05UL\r
+#define DESC_QUALIFIER      0x06UL\r
+#define DESC_OTHERSPEED     0x07UL\r
+#define DESC_IFPOWER        0x08UL\r
+#define DESC_OTG            0x09UL\r
+#define DESC_BOS            0x0FUL\r
+#define DESC_CAPABILITY     0x10UL\r
+\r
+/* USB Device Capability Type */\r
+#define CAP_WIRELESS        0x01UL\r
+#define CAP_USB20_EXT       0x02UL\r
+\r
+/*!<USB HID Descriptor Type */\r
+#define DESC_HID            0x21UL\r
+#define DESC_HID_RPT        0x22UL\r
+\r
+/* USB Descriptor Length */\r
+#define LEN_DEVICE          18UL\r
+#define LEN_QUALIFIER       10UL\r
+#define LEN_CONFIG          9UL\r
+#define LEN_INTERFACE       9UL\r
+#define LEN_ENDPOINT        7UL\r
+#define LEN_OTG             5UL\r
+#define LEN_BOS             5UL\r
+#define LEN_HID             9UL\r
+#define LEN_CCID            0x36UL\r
+#define LEN_BOSCAP          7UL\r
+\r
+/* USB Endpoint Type */\r
+#define EP_ISO              0x01\r
+#define EP_BULK             0x02\r
+#define EP_INT              0x03\r
+\r
+#define EP_INPUT            0x80\r
+#define EP_OUTPUT           0x00\r
+\r
+/* USB Feature Selector */\r
+#define FEATURE_DEVICE_REMOTE_WAKEUP    0x01UL\r
+#define FEATURE_ENDPOINT_HALT           0x00UL\r
+/** @endcond HIDDEN_SYMBOLS */\r
+\r
+/******************************************************************************/\r
+/*                USB Specific Macros                                         */\r
+/******************************************************************************/\r
+\r
+#define USBD_WAKEUP_EN          USBD_INTEN_WKEN_Msk         /*!< USB Wake-up Enable */\r
+#define USBD_DRVSE0             USBD_SE0_SE0_Msk            /*!< Drive SE0 */\r
+\r
+#define USBD_LPMACK             USBD_ATTR_LPMACK_Msk        /*!< LPM Enable */\r
+#define USBD_BYTEM              USBD_ATTR_BYTEM_Msk         /*!< Access Size Mode Selection */\r
+#define USBD_DPPU_EN            USBD_ATTR_DPPUEN_Msk        /*!< USB D+ Pull-up Enable */\r
+#define USBD_USB_EN             USBD_ATTR_USBEN_Msk         /*!< USB Enable */\r
+#define USBD_RWAKEUP            USBD_ATTR_RWAKEUP_Msk       /*!< Remote Wake-Up */\r
+#define USBD_PHY_EN             USBD_ATTR_PHYEN_Msk         /*!< PHY Enable */\r
+\r
+#define USBD_INT_BUS            USBD_INTEN_BUSIEN_Msk       /*!< USB Bus Event Interrupt */\r
+#define USBD_INT_USB            USBD_INTEN_USBIEN_Msk       /*!< USB Event Interrupt */\r
+#define USBD_INT_FLDET          USBD_INTEN_VBDETIEN_Msk     /*!< USB VBUS Detection Interrupt */\r
+#define USBD_INT_WAKEUP         (USBD_INTEN_NEVWKIEN_Msk | USBD_INTEN_WKEN_Msk)     /*!< USB No-Event-Wake-Up Interrupt */\r
+\r
+#define USBD_INTSTS_WAKEUP      USBD_INTSTS_NEVWKIF_Msk     /*!< USB No-Event-Wake-Up Interrupt Status */\r
+#define USBD_INTSTS_FLDET       USBD_INTSTS_VBDETIF_Msk     /*!< USB Float Detect Interrupt Status */\r
+#define USBD_INTSTS_BUS         USBD_INTSTS_BUSIF_Msk       /*!< USB Bus Event Interrupt Status */\r
+#define USBD_INTSTS_USB         USBD_INTSTS_USBIF_Msk       /*!< USB Event Interrupt Status */\r
+#define USBD_INTSTS_SETUP       USBD_INTSTS_SETUP_Msk       /*!< USB Setup Event */\r
+#define USBD_INTSTS_EP0         USBD_INTSTS_EPEVT0_Msk      /*!< USB Endpoint 0 Event */\r
+#define USBD_INTSTS_EP1         USBD_INTSTS_EPEVT1_Msk      /*!< USB Endpoint 1 Event */\r
+#define USBD_INTSTS_EP2         USBD_INTSTS_EPEVT2_Msk      /*!< USB Endpoint 2 Event */\r
+#define USBD_INTSTS_EP3         USBD_INTSTS_EPEVT3_Msk      /*!< USB Endpoint 3 Event */\r
+#define USBD_INTSTS_EP4         USBD_INTSTS_EPEVT4_Msk      /*!< USB Endpoint 4 Event */\r
+#define USBD_INTSTS_EP5         USBD_INTSTS_EPEVT5_Msk      /*!< USB Endpoint 5 Event */\r
+#define USBD_INTSTS_EP6         USBD_INTSTS_EPEVT6_Msk      /*!< USB Endpoint 6 Event */\r
+#define USBD_INTSTS_EP7         USBD_INTSTS_EPEVT7_Msk      /*!< USB Endpoint 7 Event */\r
+#define USBD_INTSTS_EP8         USBD_INTSTS_EPEVT8_Msk      /*!< USB Endpoint 8 Event */\r
+#define USBD_INTSTS_EP9         USBD_INTSTS_EPEVT9_Msk      /*!< USB Endpoint 9 Event */\r
+#define USBD_INTSTS_EP10        USBD_INTSTS_EPEVT10_Msk     /*!< USB Endpoint 10 Event */\r
+#define USBD_INTSTS_EP11        USBD_INTSTS_EPEVT11_Msk     /*!< USB Endpoint 11 Event */\r
+\r
+#define USBD_STATE_USBRST       USBD_ATTR_USBRST_Msk        /*!< USB Bus Reset */\r
+#define USBD_STATE_SUSPEND      USBD_ATTR_SUSPEND_Msk       /*!< USB Bus Suspend */\r
+#define USBD_STATE_RESUME       USBD_ATTR_RESUME_Msk        /*!< USB Bus Resume */\r
+#define USBD_STATE_TIMEOUT      USBD_ATTR_TOUT_Msk          /*!< USB Bus Timeout */\r
+#define USBD_STATE_L1SUSPEND    USBD_ATTR_L1SUSPEND_Msk     /*!< USB Bus L1SUSPEND  */\r
+#define USBD_STATE_L1RESUME     USBD_ATTR_L1RESUME_Msk      /*!< USB Bus L1RESUME   */\r
+\r
+#define USBD_CFGP_SSTALL        USBD_CFGP_SSTALL_Msk        /*!< Set Stall */\r
+#define USBD_CFG_CSTALL         USBD_CFG_CSTALL_Msk         /*!< Clear Stall */\r
+\r
+#define USBD_CFG_EPMODE_DISABLE (0UL << USBD_CFG_STATE_Pos)/*!< Endpoint Disable */\r
+#define USBD_CFG_EPMODE_OUT     (1UL << USBD_CFG_STATE_Pos)/*!< Out Endpoint */\r
+#define USBD_CFG_EPMODE_IN      (2UL << USBD_CFG_STATE_Pos)/*!< In Endpoint */\r
+#define USBD_CFG_TYPE_ISO       (1UL << USBD_CFG_ISOCH_Pos)/*!< Isochronous */\r
+\r
+\r
+/*@}*/ /* end of group USBD_EXPORTED_CONSTANTS */\r
+\r
+\r
+/** @addtogroup USBD_EXPORTED_FUNCTIONS USBD Exported Functions\r
+  @{\r
+*/\r
+\r
+/**\r
+  * @brief      Compare two input numbers and return maximum one.\r
+  *\r
+  * @param[in]  a   First number to be compared.\r
+  * @param[in]  b   Second number to be compared.\r
+  *\r
+  * @return     Maximum value between a and b.\r
+  *\r
+  * @details    If a > b, then return a. Otherwise, return b.\r
+  */\r
+#define USBD_Maximum(a,b)        ((a)>(b) ? (a) : (b))\r
+\r
+\r
+/**\r
+  * @brief      Compare two input numbers and return minimum one\r
+  *\r
+  * @param[in]  a   First number to be compared\r
+  * @param[in]  b   Second number to be compared\r
+  *\r
+  * @return     Minimum value between a and b\r
+  *\r
+  * @details    If a < b, then return a. Otherwise, return b.\r
+  */\r
+#define USBD_Minimum(a,b)        ((a)<(b) ? (a) : (b))\r
+\r
+\r
+/**\r
+  * @brief    Enable USB\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  To set USB ATTR control register to enable USB and PHY.\r
+  *\r
+  */\r
+#define USBD_ENABLE_USB()           (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->ATTR |= 0x7D0)):((uint32_t)(USBD->ATTR |= 0x7D0)))\r
+\r
+/**\r
+  * @brief    Disable USB\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  To set USB ATTR control register to disable USB.\r
+  *\r
+  */\r
+#define USBD_DISABLE_USB()          (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->ATTR &= ~USBD_USB_EN)):((uint32_t)(USBD->ATTR &= ~USBD_USB_EN)))\r
+\r
+/**\r
+  * @brief    Enable USB PHY\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  To set USB ATTR control register to enable USB PHY.\r
+  *\r
+  */\r
+#define USBD_ENABLE_PHY()           (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->ATTR |= USBD_PHY_EN)):((uint32_t)(USBD->ATTR |= USBD_PHY_EN)))\r
+\r
+/**\r
+  * @brief    Disable USB PHY\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  To set USB ATTR control register to disable USB PHY.\r
+  *\r
+  */\r
+#define USBD_DISABLE_PHY()          (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->ATTR &= ~USBD_PHY_EN)):((uint32_t)(USBD->ATTR &= ~USBD_PHY_EN)))\r
+\r
+/**\r
+  * @brief    Enable SE0. Force USB PHY transceiver to drive SE0.\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  Set DRVSE0 bit of USB_DRVSE0 register to enable software-disconnect function. Force USB PHY transceiver to drive SE0 to bus.\r
+  *\r
+  */\r
+#define USBD_SET_SE0()              (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->SE0 |= USBD_DRVSE0)):((uint32_t)(USBD->SE0 |= USBD_DRVSE0)))\r
+\r
+/**\r
+  * @brief    Disable SE0\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   None\r
+  *\r
+  * @details  Clear DRVSE0 bit of USB_DRVSE0 register to disable software-disconnect function.\r
+  *\r
+  */\r
+#define USBD_CLR_SE0()              (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->SE0 &= ~USBD_DRVSE0)):((uint32_t)(USBD->SE0 &= ~USBD_DRVSE0)))\r
+\r
+/**\r
+  * @brief       Set USB device address\r
+  *\r
+  * @param[in]   addr The USB device address.\r
+  *\r
+  * @return      None\r
+  *\r
+  * @details     Write USB device address to USB_FADDR register.\r
+  *\r
+  */\r
+#define USBD_SET_ADDR(addr)         (((__PC() & NS_OFFSET) == NS_OFFSET)? (USBD_NS->FADDR = (addr)):(USBD->FADDR = (addr)))\r
+\r
+/**\r
+  * @brief    Get USB device address\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   USB device address\r
+  *\r
+  * @details  Read USB_FADDR register to get USB device address.\r
+  *\r
+  */\r
+#define USBD_GET_ADDR()             (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->FADDR)):((uint32_t)(USBD->FADDR)))\r
+\r
+/**\r
+  * @brief      Enable USB interrupt function\r
+  *\r
+  * @param[in]  intr The combination of the specified interrupt enable bits.\r
+  *             Each bit corresponds to a interrupt enable bit.\r
+  *             This parameter decides which interrupts will be enabled.\r
+  *             (USBD_INT_WAKEUP, USBD_INT_FLDET, USBD_INT_USB, USBD_INT_BUS)\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    Enable USB related interrupt functions specified by intr parameter.\r
+  *\r
+  */\r
+#define USBD_ENABLE_INT(intr)       (((__PC() & NS_OFFSET) == NS_OFFSET)? (USBD_NS->INTEN |= (intr)):(USBD->INTEN |= (intr)))\r
+\r
+/**\r
+  * @brief    Get interrupt status\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   The value of USB_INTSTS register\r
+  *\r
+  * @details  Return all interrupt flags of USB_INTSTS register.\r
+  *\r
+  */\r
+#define USBD_GET_INT_FLAG()         (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->INTSTS)):((uint32_t)(USBD->INTSTS)))\r
+\r
+/**\r
+  * @brief      Clear USB interrupt flag\r
+  *\r
+  * @param[in]  flag The combination of the specified interrupt flags.\r
+  *             Each bit corresponds to a interrupt source.\r
+  *             This parameter decides which interrupt flags will be cleared.\r
+  *             (USBD_INTSTS_WAKEUP, USBD_INTSTS_FLDET, USBD_INTSTS_BUS, USBD_INTSTS_USB)\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    Clear USB related interrupt flags specified by flag parameter.\r
+  *\r
+  */\r
+#define USBD_CLR_INT_FLAG(flag)     (((__PC() & NS_OFFSET) == NS_OFFSET)? (USBD_NS->INTSTS = (flag)):(USBD->INTSTS = (flag)))\r
+\r
+/**\r
+  * @brief    Get endpoint status\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   The value of USB_EPSTS register.\r
+  *\r
+  * @details  Return all endpoint status.\r
+  *\r
+  */\r
+#define USBD_GET_EP_FLAG()          (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->EPSTS)):((uint32_t)(USBD->EPSTS)))\r
+\r
+/**\r
+  * @brief    Get USB bus state\r
+  *\r
+  * @param    None\r
+  *\r
+  * @return   The value of USB_ATTR[13:12] and USB_ATTR[3:0].\r
+  *           Bit 0  indicates USB bus reset status.\r
+  *           Bit 1  indicates USB bus suspend status.\r
+  *           Bit 2  indicates USB bus resume status.\r
+  *           Bit 3  indicates USB bus time-out status.\r
+  *           Bit 12 indicates USB bus LPM L1 suspend status.\r
+  *           Bit 13 indicates USB bus LPM L1 resume status.\r
+  *\r
+  * @details  Return USB_ATTR[13:12] and USB_ATTR[3:0] for USB bus events.\r
+  *\r
+  */\r
+#define USBD_GET_BUS_STATE()        (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->ATTR & 0x300F)):((uint32_t)(USBD->ATTR & 0x300F)))\r
+\r
+/**\r
+  * @brief    Check cable connection state\r
+  *\r
+  * @param    None\r
+  *\r
+  * @retval   0 USB cable is not attached.\r
+  * @retval   1 USB cable is attached.\r
+  *\r
+  * @details  Check the connection state by FLDET bit of USB_FLDET register.\r
+  *\r
+  */\r
+#define USBD_IS_ATTACHED()          (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)(USBD_NS->VBUSDET & USBD_VBUSDET_VBUSDET_Msk)):((uint32_t)(USBD->VBUSDET & USBD_VBUSDET_VBUSDET_Msk)))\r
+\r
+/**\r
+  * @brief      Stop USB transaction of the specified endpoint ID\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    Write 1 to CLRRDY bit of USB_CFGPx register to stop USB transaction of the specified endpoint ID.\r
+  *\r
+  */\r
+#define USBD_STOP_TRANSACTION(ep)      (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_CLRRDY_Msk):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_CLRRDY_Msk))\r
+\r
+/**\r
+  * @brief      Set USB DATA1 PID for the specified endpoint ID\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    Set DSQ_SYNC bit of USB_CFGx register to specify the DATA1 PID for the following IN token transaction.\r
+  *             Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions.\r
+  *\r
+  */\r
+#define USBD_SET_DATA1(ep)          (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQSYNC_Msk):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) |= USBD_CFG_DSQSYNC_Msk))\r
+\r
+/**\r
+  * @brief      Set USB DATA0 PID for the specified endpoint ID\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    Clear DSQ_SYNC bit of USB_CFGx register to specify the DATA0 PID for the following IN token transaction.\r
+  *             Base on this setting, hardware will toggle PID between DATA0 and DATA1 automatically for IN token transactions.\r
+  *\r
+  */\r
+#define USBD_SET_DATA0(ep)          (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk)):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) &= (~USBD_CFG_DSQSYNC_Msk)))\r
+\r
+/**\r
+  * @brief      Set USB payload size (IN data)\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @param[in]  size The transfer length.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    This macro will write the transfer length to USB_MXPLDx register for IN data transaction.\r
+  *\r
+  */\r
+#define USBD_SET_PAYLOAD_LEN(ep, size)  (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size)):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4))) = (size)))\r
+\r
+/**\r
+  * @brief      Get USB payload size (OUT data)\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return     The value of USB_MXPLDx register.\r
+  *\r
+  * @details    Get the data length of OUT data transaction by reading USB_MXPLDx register.\r
+  *\r
+  */\r
+#define USBD_GET_PAYLOAD_LEN(ep)        (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].MXPLD + (uint32_t)((ep) << 4)))):((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].MXPLD + (uint32_t)((ep) << 4)))))\r
+\r
+/**\r
+  * @brief      Configure endpoint\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @param[in]  config The USB configuration.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    This macro will write config parameter to USB_CFGx register of specified endpoint ID.\r
+  *\r
+  */\r
+#define USBD_CONFIG_EP(ep, config)      (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFG + (uint32_t)((ep) << 4))) = (config)):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFG + (uint32_t)((ep) << 4))) = (config)))\r
+\r
+/**\r
+  * @brief      Set USB endpoint buffer\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @param[in]  offset The SRAM offset.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    This macro will set the SRAM offset for the specified endpoint ID.\r
+  *\r
+  */\r
+#define USBD_SET_EP_BUF_ADDR(ep, offset)    (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset)):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4))) = (offset)))\r
+\r
+/**\r
+  * @brief      Get the offset of the specified USB endpoint buffer\r
+  *\r
+  * @param[in]  ep The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return     The offset of the specified endpoint buffer.\r
+  *\r
+  * @details    This macro will return the SRAM offset of the specified endpoint ID.\r
+  *\r
+  */\r
+#define USBD_GET_EP_BUF_ADDR(ep)        (((__PC() & NS_OFFSET) == NS_OFFSET)? ((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].BUFSEG + (uint32_t)((ep) << 4)))):((uint32_t)*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].BUFSEG + (uint32_t)((ep) << 4)))))\r
+\r
+/**\r
+  * @brief       Set USB endpoint stall state\r
+  *\r
+  * @param[in]   ep  The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return      None\r
+  *\r
+  * @details     Set USB endpoint stall state for the specified endpoint ID. Endpoint will respond STALL token automatically.\r
+  *\r
+  */\r
+#define USBD_SET_EP_STALL(ep)        (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_SSTALL_Msk):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) |= USBD_CFGP_SSTALL_Msk))\r
+\r
+/**\r
+  * @brief       Clear USB endpoint stall state\r
+  *\r
+  * @param[in]   ep  The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @return      None\r
+  *\r
+  * @details     Clear USB endpoint stall state for the specified endpoint ID. Endpoint will respond ACK/NAK token.\r
+  */\r
+#define USBD_CLR_EP_STALL(ep)        (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) &= ~USBD_CFGP_SSTALL_Msk))\r
+\r
+/**\r
+  * @brief       Get USB endpoint stall state\r
+  *\r
+  * @param[in]   ep  The USB endpoint ID. M2351 Series supports 12 hardware endpoint ID. This parameter could be 0 ~ 11.\r
+  *\r
+  * @retval      0      USB endpoint is not stalled.\r
+  * @retval      Others USB endpoint is stalled.\r
+  *\r
+  * @details     Get USB endpoint stall state of the specified endpoint ID.\r
+  *\r
+  */\r
+#define USBD_GET_EP_STALL(ep)        (((__PC() & NS_OFFSET) == NS_OFFSET)? (*((__IO uint32_t *) ((uint32_t)&USBD_NS->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk):(*((__IO uint32_t *) ((uint32_t)&USBD->EP[0].CFGP + (uint32_t)((ep) << 4))) & USBD_CFGP_SSTALL_Msk))\r
+\r
+/**\r
+  * @brief      To support byte access between USB SRAM and system SRAM\r
+  *\r
+  * @param[in]  dest Destination pointer.\r
+  *\r
+  * @param[in]  src  Source pointer.\r
+  *\r
+  * @param[in]  size Byte count.\r
+  *\r
+  * @return     None\r
+  *\r
+  * @details    This function will copy the number of data specified by size and src parameters to the address specified by dest parameter.\r
+  *\r
+  */\r
+__STATIC_INLINE void USBD_MemCopy(uint8_t dest[], uint8_t src[], uint32_t size)\r
+{\r
+    uint32_t volatile i = 0UL;\r
+\r
+    while(size--)\r
+    {\r
+        dest[i] = src[i];\r
+        i++;\r
+    }\r
+}\r
+\r
+\r
+/**\r
+  * @brief       Set USB endpoint stall state\r
+  *\r
+  * @param[in]   epnum  USB endpoint number\r
+  *\r
+  * @return      None\r
+  *\r
+  * @details     Set USB endpoint stall state. Endpoint will respond STALL token automatically.\r
+  *\r
+  */\r
+__STATIC_INLINE void USBD_SetStall(uint8_t epnum)\r
+{\r
+    uint32_t u32CfgAddr;\r
+    uint32_t u32Cfg;\r
+    uint32_t i;\r
+    USBD_T *pUSBD;\r
+\r
+    if((__PC() & NS_OFFSET) == NS_OFFSET)\r
+    {\r
+        pUSBD = USBD_NS;\r
+    }\r
+    else\r
+    {\r
+        pUSBD = USBD;\r
+    }\r
+\r
+    for(i = 0UL; i < USBD_MAX_EP; i++)\r
+    {\r
+        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */\r
+        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));\r
+\r
+        if((u32Cfg & 0xFUL) == epnum)\r
+        {\r
+            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */\r
+            u32Cfg = *((__IO uint32_t *)(u32CfgAddr));\r
+\r
+            *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg | USBD_CFGP_SSTALL);\r
+            break;\r
+        }\r
+    }\r
+}\r
+\r
+/**\r
+  * @brief       Clear USB endpoint stall state\r
+  *\r
+  * @param[in]   epnum  USB endpoint number\r
+  *\r
+  * @return      None\r
+  *\r
+  * @details     Clear USB endpoint stall state. Endpoint will respond ACK/NAK token.\r
+  */\r
+__STATIC_INLINE void USBD_ClearStall(uint8_t epnum)\r
+{\r
+    uint32_t u32CfgAddr;\r
+    uint32_t u32Cfg;\r
+    uint32_t i;\r
+    USBD_T *pUSBD;\r
+\r
+    if((__PC() & NS_OFFSET) == NS_OFFSET)\r
+    {\r
+        pUSBD = USBD_NS;\r
+    }\r
+    else\r
+    {\r
+        pUSBD = USBD;\r
+    }\r
+\r
+    for(i = 0UL; i < USBD_MAX_EP; i++)\r
+    {\r
+        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */\r
+        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));\r
+\r
+        if((u32Cfg & 0xFUL) == epnum)\r
+        {\r
+            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */\r
+            u32Cfg = *((__IO uint32_t *)(u32CfgAddr));\r
+\r
+            *((__IO uint32_t *)(u32CfgAddr)) = (u32Cfg & ~USBD_CFGP_SSTALL);\r
+            break;\r
+        }\r
+    }\r
+}\r
+\r
+/**\r
+  * @brief       Get USB endpoint stall state\r
+  *\r
+  * @param[in]   epnum  USB endpoint number\r
+  *\r
+  * @retval      0      USB endpoint is not stalled.\r
+  * @retval      Others USB endpoint is stalled.\r
+  *\r
+  * @details     Get USB endpoint stall state.\r
+  *\r
+  */\r
+__STATIC_INLINE uint32_t USBD_GetStall(uint8_t epnum)\r
+{\r
+    uint32_t u32CfgAddr;\r
+    uint32_t u32Cfg;\r
+    uint32_t i;\r
+    USBD_T *pUSBD;\r
+\r
+    if((__PC() & NS_OFFSET) == NS_OFFSET)\r
+    {\r
+        pUSBD = USBD_NS;\r
+    }\r
+    else\r
+    {\r
+        pUSBD = USBD;\r
+    }\r
+\r
+    for(i = 0UL; i < USBD_MAX_EP; i++)\r
+    {\r
+        u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFG; /* USBD_CFG0 */\r
+        u32Cfg = *((__IO uint32_t *)(u32CfgAddr));\r
+\r
+        if((u32Cfg & 0xFUL) == epnum)\r
+        {\r
+            u32CfgAddr = (uint32_t)(i << 4) + (uint32_t)&pUSBD->EP[0].CFGP; /* USBD_CFGP0 */\r
+            break;\r
+        }\r
+    }\r
+\r
+    return ((*((__IO uint32_t *)(u32CfgAddr))) & USBD_CFGP_SSTALL);\r
+}\r
+\r
+extern volatile uint8_t g_USBD_u8RemoteWakeupEn;\r
+\r
+\r
+typedef void (*VENDOR_REQ)(void);           /*!< Functional pointer type definition for Vendor class */\r
+typedef void (*CLASS_REQ)(void);            /*!< Functional pointer type declaration for USB class request callback handler */\r
+typedef void (*SET_INTERFACE_REQ)(uint32_t u32AltInterface);    /*!< Functional pointer type declaration for USB set interface request callback handler */\r
+typedef void (*SET_CONFIG_CB)(void);       /*!< Functional pointer type declaration for USB set configuration request callback handler */\r
+\r
+\r
+/*--------------------------------------------------------------------*/\r
+void USBD_Open(const S_USBD_INFO_T *param, CLASS_REQ pfnClassReq, SET_INTERFACE_REQ pfnSetInterface);\r
+void USBD_Start(void);\r
+void USBD_GetSetupPacket(uint8_t *buf);\r
+void USBD_ProcessSetupPacket(void);\r
+void USBD_StandardRequest(void);\r
+void USBD_PrepareCtrlIn(uint8_t pu8Buf[], uint32_t u32Size);\r
+void USBD_CtrlIn(void);\r
+void USBD_PrepareCtrlOut(uint8_t *pu8Buf, uint32_t u32Size);\r
+void USBD_CtrlOut(void);\r
+void USBD_SwReset(void);\r
+void USBD_SetVendorRequest(VENDOR_REQ pfnVendorReq);\r
+void USBD_SetConfigCallback(SET_CONFIG_CB pfnSetConfigCallback);\r
+void USBD_LockEpStall(uint32_t u32EpBitmap);\r
+\r
+/*@}*/ /* end of group USBD_EXPORTED_FUNCTIONS */\r
+\r
+/*@}*/ /* end of group USBD_Driver */\r
+\r
+/*@}*/ /* end of group Standard_Driver */\r
+\r
+#ifdef __cplusplus\r
+}\r
+#endif\r
+\r
+#endif /* __USBD_H__ */\r
+\r
+/*** (C) COPYRIGHT 2018 Nuvoton Technology Corp. ***/\r