wenkong_junshi/Firmware/GD32F30x_usbd_library/device/Source/usbd_enum.c

/*!
    \file    usbd_enum.c
    \brief   USB enumeration function

    \version 2023-06-30, V2.1.6, firmware for GD32F30x
*/

/*
    Copyright (c) 2023, 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 "usbd_enum.h"
#include "usbd_transc.h"

/* USB enumeration handle functions */
static usb_reqsta _usb_std_getstatus        (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_clearfeature     (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_setfeature       (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_setaddress       (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_getdescriptor    (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_setdescriptor    (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_getconfiguration (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_setconfiguration (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_reserved         (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_getinterface     (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_setinterface     (usb_dev *udev, usb_req *req);
static usb_reqsta _usb_std_synchframe       (usb_dev *udev, usb_req *req);

static uint8_t* _usb_dev_desc_get      (usb_dev *udev, uint8_t index, uint16_t *len);
static uint8_t* _usb_config_desc_get   (usb_dev *udev, uint8_t index, uint16_t *len);
static uint8_t* _usb_str_desc_get      (usb_dev *udev, uint8_t index, uint16_t *len);
static uint8_t* _usb_bos_desc_get      (usb_dev *udev, uint8_t index, uint16_t *len);

static void int_to_unicode (uint32_t value, uint8_t *pbuf, uint8_t len);

/* standard device request handler */
static usb_reqsta (*_std_dev_req[]) (usb_dev *udev, usb_req *req) = {
    [USB_GET_STATUS]        = _usb_std_getstatus,
    [USB_CLEAR_FEATURE]     = _usb_std_clearfeature,
    [USB_RESERVED2]         = _usb_std_reserved,
    [USB_SET_FEATURE]       = _usb_std_setfeature,
    [USB_RESERVED4]         = _usb_std_reserved,
    [USB_SET_ADDRESS]       = _usb_std_setaddress,
    [USB_GET_DESCRIPTOR]    = _usb_std_getdescriptor,
    [USB_SET_DESCRIPTOR]    = _usb_std_setdescriptor,
    [USB_GET_CONFIGURATION] = _usb_std_getconfiguration,
    [USB_SET_CONFIGURATION] = _usb_std_setconfiguration,
    [USB_GET_INTERFACE]     = _usb_std_getinterface,
    [USB_SET_INTERFACE]     = _usb_std_setinterface,
    [USB_SYNCH_FRAME]       = _usb_std_synchframe,
};

/* get standard descriptor handler */
static uint8_t* (*std_desc_get[])(usb_dev *udev, uint8_t index, uint16_t *len) = {
    [USB_DESCTYPE_DEV - 1U]    = _usb_dev_desc_get,
    [USB_DESCTYPE_CONFIG - 1U] = _usb_config_desc_get,
    [USB_DESCTYPE_STR - 1U]    = _usb_str_desc_get
};

/*!
    \brief      handle USB standard device request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device operation cur_status
*/
usb_reqsta usbd_standard_request (usb_dev *udev, usb_req *req)
{
    /* call device request handle function */
    return (*_std_dev_req[req->bRequest]) (udev, req);
}

/*!
    \brief      handle USB device class request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device class request
    \param[out] none
    \retval     USB device request status
*/
usb_reqsta usbd_class_request (usb_dev *udev, usb_req *req)
{
    if ((uint8_t)USBD_CONFIGURED == udev->cur_status) {
        if (BYTE_LOW(req->wIndex) < USBD_ITF_MAX_NUM) {
            /* call device class handle function */
            return (usb_reqsta)udev->class_core->req_process(udev, req);
        }
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB vendor request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB vendor request
    \param[out] none
    \retval     USB device request status
*/
usb_reqsta usbd_vendor_request (usb_dev *udev, usb_req *req)
{
    (void)udev;
    (void)req;

    /* added by user */

    return REQ_NOTSUPP;
}

/*!
    \brief      no operation, just for reserved
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_reserved (usb_dev *udev, usb_req *req)
{
    (void)udev;
    (void)req;

    /* no operation */
    return REQ_NOTSUPP;
}

/*!
    \brief      get the device descriptor
    \param[in]  udev: pointer to USB device instance
    \param[in]  index: no use
    \param[out] len: data length pointer
    \retval     descriptor buffer pointer
*/
static uint8_t* _usb_dev_desc_get (usb_dev *udev, uint8_t index, uint16_t *len)
{
    (void)index;

    *len = udev->desc->dev_desc[0];

    return udev->desc->dev_desc;
}

/*!
    \brief      get the configuration descriptor
    \brief[in]  udev: pointer to USB device instance
    \brief[in]  index: no use
    \param[out] len: data length pointer
    \retval     descriptor buffer pointer
*/
static uint8_t* _usb_config_desc_get (usb_dev *udev, uint8_t index, uint16_t *len)
{
    (void)index;

    *len = udev->desc->config_desc[2] | (udev->desc->config_desc[3]<< 8);

    return udev->desc->config_desc;
}

/*!
    \brief      get the BOS descriptor
    \brief[in]  udev: pointer to USB device instance
    \brief[in]  index: no use
    \param[out] len: data length pointer
    \retval     descriptor buffer pointer
*/
static uint8_t* _usb_bos_desc_get (usb_dev *udev, uint8_t index, uint16_t *len)
{
    if (NULL != udev->desc->bos_desc) {
        (void)index;

        *len = (uint16_t)udev->desc->bos_desc[2] | (uint16_t)((uint16_t)udev->desc->bos_desc[3] << 8);

        return udev->desc->bos_desc;
    } else {
        *len = 0U;

        return NULL;
    }
}

/*!
    \brief      get string descriptor
    \param[in]  udev: pointer to USB device instance
    \param[in]  index: string descriptor index
    \param[out] len: pointer to string length
    \retval     string descriptor
*/
static uint8_t* _usb_str_desc_get (usb_dev *udev, uint8_t index, uint16_t *len)
{
    uint8_t* desc = udev->desc->strings[index];

    *len = desc[0];

    return desc;
}

/*!
    \brief      handle Get_Status request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_getstatus (usb_dev *udev, usb_req *req)
{
    uint8_t recp = BYTE_LOW(req->wIndex);

    usb_reqsta req_status = REQ_NOTSUPP;

    static uint8_t status[2] = {0U};

    switch(req->bmRequestType & USB_RECPTYPE_MASK) {
    /* handle device get status request */
    case USB_RECPTYPE_DEV:
        switch (udev->cur_status) {
        case USBD_ADDRESSED:
        case USBD_CONFIGURED:
            if (udev->pm.power_mode) {
                status[0] = USB_STATUS_SELF_POWERED;
            } else {
                status[0] = 0U;
            }

            if (udev->pm.remote_wakeup) {
                status[0] |= USB_STATUS_REMOTE_WAKEUP;
            } else {
                status[0] = 0U;
            }

            req_status = REQ_SUPP;
            break;

        default:
            break;
        }
        break;

    /* handle interface get status request */
    case USB_RECPTYPE_ITF:
        if (((uint8_t)USBD_CONFIGURED == udev->cur_status) && (recp < USBD_ITF_MAX_NUM)) {
            req_status = REQ_SUPP;
        }
        break;

    /* handle endpoint get status request */
    case USB_RECPTYPE_EP:
        if ((uint8_t)USBD_CONFIGURED == udev->cur_status) {
            if (0x80U == (recp & 0x80U)) {
                status[0] = udev->transc_in[EP_ID(recp)].ep_stall;
            } else {
                status[0] = udev->transc_out[recp].ep_stall;
            }
            req_status = REQ_SUPP;
        }
        break;

    default:
        break;
    }

    if (REQ_SUPP == req_status) {
        usb_transc_config(&udev->transc_in[0], status, 2U, 2U);
    }

    return req_status;
}

/*!
    \brief      handle USB Clear_Feature request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_clearfeature (usb_dev *udev, usb_req *req)
{
    uint8_t ep = 0U;

    switch (req->bmRequestType & (uint8_t)USB_RECPTYPE_MASK) {
    case USB_RECPTYPE_DEV:
        switch (udev->cur_status) {
        case USBD_ADDRESSED:
        case USBD_CONFIGURED:
            /* clear device remote wakeup feature */
            if ((uint16_t)USB_FEATURE_REMOTE_WAKEUP == req->wValue) {
                udev->pm.remote_wakeup = 0U;

                return REQ_SUPP;
            }
            break;

        default:
            break;
        }
        break;
 
    case USB_RECPTYPE_EP:
        /* get endpoint address */
        ep = BYTE_LOW(req->wIndex);

        if (((uint8_t)USBD_CONFIGURED == udev->cur_status) && (EP_ID(ep) < EP_COUNT)) {
            /* clear endpoint halt feature */
            if (((uint16_t)USB_FEATURE_EP_HALT == req->wValue) && (!CTL_EP(ep))) {
                /* check whether the endpoint status is disabled */
                if(0U != usbd_ep_status_get(udev, ep)){
                    usbd_ep_clear_stall(udev, ep);
                    udev->class_core->req_process(udev, req);

                    return REQ_SUPP;
                }
            }
        }
        break;

    case USB_RECPTYPE_ITF:
        break;

    default:
        break;
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB Set_Feature request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_setfeature (usb_dev *udev, usb_req *req)
{
    uint8_t ep = 0U;

    switch (req->bmRequestType & (uint8_t)USB_RECPTYPE_MASK) {
    case USB_RECPTYPE_DEV:
        switch (udev->cur_status) {
        case USBD_ADDRESSED:
        case USBD_CONFIGURED:
            /* set device remote wakeup feature */
            if ((uint16_t)USB_FEATURE_REMOTE_WAKEUP == req->wValue) {
                udev->pm.remote_wakeup = 1U;

                return REQ_SUPP;
            }
            break;

        default:
            break;
        }
        break;

    case USB_RECPTYPE_EP:
        /* get endpoint address */
        ep = BYTE_LOW(req->wIndex);

        if (((uint8_t)USBD_CONFIGURED == udev->cur_status) && (EP_ID(ep) < EP_COUNT)) {
            /* set endpoint halt feature */
            if (((uint16_t)USB_FEATURE_EP_HALT == req->wValue) && (!CTL_EP(ep))) {
                /* check whether the endpoint status is disabled */
                if(0U != usbd_ep_status_get(udev, ep)){
                    usbd_ep_stall(udev, ep);
                    udev->class_core->req_process(udev, req);

                    return REQ_SUPP;
                }
            }
        }
        break;

    case USB_RECPTYPE_ITF:
        break;

    default:
        break;
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB Set_Address request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_setaddress (usb_dev *udev, usb_req *req)
{
    if ((0U == req->wIndex) && (0U == req->wLength)) {
        udev->dev_addr = (uint8_t)(req->wValue) & 0x7FU;

        if (udev->cur_status != (uint8_t)USBD_CONFIGURED) {
            if (udev->dev_addr) {
                udev->cur_status = (uint8_t)USBD_ADDRESSED;
            } else {
                udev->cur_status = (uint8_t)USBD_DEFAULT;
            }

            return REQ_SUPP;
        }
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB Get_Descriptor request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_getdescriptor (usb_dev *udev, usb_req *req)
{
    uint8_t desc_type = 0U;
    uint8_t desc_index = 0U;

    usb_reqsta status = REQ_NOTSUPP;

    usb_transc *transc = &udev->transc_in[0];

    switch (req->bmRequestType & USB_RECPTYPE_MASK) {
    case USB_RECPTYPE_DEV:
        desc_type = BYTE_HIGH(req->wValue);
        desc_index = BYTE_LOW(req->wValue);

        switch (desc_type) {
        case USB_DESCTYPE_DEV:
            transc->xfer_buf = std_desc_get[desc_type - 1U](udev, desc_index, &transc->xfer_len);
            if (64U == req->wLength) {
                transc->xfer_len = 8U;
            }
            break;

        case USB_DESCTYPE_CONFIG:
            transc->xfer_buf = std_desc_get[desc_type - 1U](udev, desc_index, &transc->xfer_len);
            break;

        case USB_DESCTYPE_STR:
            if (desc_index < STR_IDX_MAX) {
                transc->xfer_buf = std_desc_get[desc_type - 1U](udev, desc_index, &transc->xfer_len);
            }
            break;

        case USB_DESCTYPE_ITF:
        case USB_DESCTYPE_EP:
        case USB_DESCTYPE_DEV_QUALIFIER:
        case USB_DESCTYPE_OTHER_SPD_CONFIG:
        case USB_DESCTYPE_ITF_POWER:
            break;

        case USB_DESCTYPE_BOS:
            transc->xfer_buf = _usb_bos_desc_get(udev, desc_index, &transc->xfer_len);
            break;

        default:
            break;
        }
        break;

    case USB_RECPTYPE_ITF:
        /* get device class special descriptor */
        status = (usb_reqsta)(udev->class_core->req_process(udev, req));
        break;

    case USB_RECPTYPE_EP:
        break;

    default:
        break;
    }

    if ((transc->xfer_len) && (req->wLength)) {
        transc->xfer_len = USB_MIN(transc->xfer_len, req->wLength);

        if ((transc->xfer_len < udev->control.req.wLength) &&
            (0U == transc->xfer_len % transc->max_len)) {
                udev->control.ctl_zlp = 1U;
        }

        status = REQ_SUPP;
    }

    return status;
}

/*!
    \brief      handle USB Set_Descriptor request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_setdescriptor (usb_dev *udev, usb_req *req)
{
    (void)udev;
    (void)req;

    /* no handle */
    return REQ_SUPP;
}

/*!
    \brief      handle USB Get_Configuration request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_getconfiguration (usb_dev *udev, usb_req *req)
{
    (void)req;

    usb_reqsta req_status = REQ_NOTSUPP;

    switch (udev->cur_status) {
    case USBD_ADDRESSED:
        if (0U == udev->config) {
            req_status = REQ_SUPP;
        }
        break;

    case USBD_CONFIGURED:
        if (udev->config) {
            req_status = REQ_SUPP;
        }
        break;

    default:
        break;
    }

    if (REQ_SUPP == req_status) {
        usb_transc_config(&udev->transc_in[0], &(udev->config), 1U, 1U);
    }

    return req_status;
}

/*!
    \brief      handle USB Set_Configuration request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device operation cur_status
*/
static usb_reqsta _usb_std_setconfiguration (usb_dev *udev, usb_req *req)
{
    static uint8_t config;
    usb_reqsta status = REQ_NOTSUPP;

    config = (uint8_t)(req->wValue);

    if (config <= USBD_CFG_MAX_NUM) {
        switch (udev->cur_status) {
        case USBD_ADDRESSED:
            if (config){
                (void)udev->class_core->init(udev, config);

                udev->config = config;
                udev->cur_status = (uint8_t)USBD_CONFIGURED;
            }
            status = REQ_SUPP;
            break; 

        case USBD_CONFIGURED:
            if (0U == config) {
                (void)udev->class_core->deinit(udev, config);

                udev->config = config;
                udev->cur_status = (uint8_t)USBD_ADDRESSED;
            } else if (config != udev->config) {
                /* clear old configuration */
                (void)udev->class_core->deinit(udev, udev->config);

                /* set new configuration */
                udev->config = config;

                (void)udev->class_core->init(udev, config);
            } else {
                /* no operation */
            }
            status = REQ_SUPP;
            break;

        case USBD_DEFAULT:
            break;

        default:
            break;
        }
    }

    return status;
}

/*!
    \brief      handle USB Get_Interface request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_getinterface (usb_dev *udev, usb_req *req)
{
    switch (udev->cur_status) {
    case USBD_DEFAULT:
        break;

    case USBD_ADDRESSED:
        break;

    case USBD_CONFIGURED:
        if (BYTE_LOW(req->wIndex) < USBD_ITF_MAX_NUM) {
            usb_transc_config(&udev->transc_in[0], &(udev->class_core->req_altset), 1U, 1U);

            return REQ_SUPP;
        }
        break;

    default:
        break;
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB Set_Interface request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_setinterface (usb_dev *udev, usb_req *req)
{
    switch (udev->cur_status) {
    case USBD_DEFAULT:
        break;

    case USBD_ADDRESSED:
        break;

    case USBD_CONFIGURED:
        if (BYTE_LOW(req->wIndex) < USBD_ITF_MAX_NUM) {
            udev->class_core->req_altset = (uint8_t)req->wValue;

            udev->class_core->req_process(udev, req);

            return REQ_SUPP;
        }
        break;

    default:
        break;
    }

    return REQ_NOTSUPP;
}

/*!
    \brief      handle USB SynchFrame request
    \param[in]  udev: pointer to USB device instance
    \param[in]  req: pointer to USB device request
    \param[out] none
    \retval     USB device request status
*/
static usb_reqsta _usb_std_synchframe (usb_dev *udev, usb_req *req)
{
    (void)udev;
    (void)req;

    /* no handle */
    return REQ_SUPP;
}

/*!
    \brief      convert hex 32bits value into unicode char
    \param[in]  value: Hex 32bits value
    \param[in]  pbuf: buffer pointer to store unicode char
    \param[in]  len: value length
    \param[out] none
    \retval     none
*/
static void int_to_unicode (uint32_t value, uint8_t *pbuf, uint8_t len)
{
    uint8_t index = 0U;

    for (index = 0U; index < len; index++) {
        if ((value >> 28U) < 0x0AU) {
            pbuf[2U * index] = (uint8_t)((value >> 28) + '0');
        } else {
            pbuf[2U * index] = (uint8_t)((value >> 28) + 'A' - 10U);
        }

        value = value << 4U;

        pbuf[2U * index + 1U] = 0U;
    }
}

/*!
    \brief      convert hex 32bits value into unicode char
    \param[in]  unicode_str: pointer to unicode string
    \param[out] none
    \retval     none
*/
void serial_string_get (uint16_t *unicode_str)
{
    if (6U != (unicode_str[0] & 0x00FFU)) {
        uint32_t DeviceSerial0, DeviceSerial1, DeviceSerial2;

        DeviceSerial0 = *(uint32_t*)DEVICE_ID1;
        DeviceSerial1 = *(uint32_t*)DEVICE_ID2;
        DeviceSerial2 = *(uint32_t*)DEVICE_ID3;

        DeviceSerial0 += DeviceSerial2;

        if (0U != DeviceSerial0) {
            int_to_unicode(DeviceSerial0, (uint8_t*)&(unicode_str[1]), 8U);
            int_to_unicode(DeviceSerial1, (uint8_t*)&(unicode_str[9]), 4U);
        }
    } else {
        uint32_t device_serial = *(uint32_t*)DEVICE_ID;

        if (0U != device_serial) {
            unicode_str[1] = (uint16_t)(device_serial & 0x0000FFFFU);
            unicode_str[2] = (uint16_t)((device_serial & 0xFFFF0000U) >> 16U);

        }
    }
}