path: root/stmhal/usbdev/class/cdc_msc/src/usbd_cdc_msc.c

#include "usbd_ioreq.h"
#include "usbd_cdc_msc.h"

#define USB_DESC_TYPE_ASSOCIATION (0x0b)

#define CDC_CMD_PACKET_SIZE                  8  // Control Endpoint Packet size
#define CDC_DATA_FS_IN_PACKET_SIZE                CDC_DATA_FS_MAX_PACKET_SIZE
#define CDC_DATA_FS_OUT_PACKET_SIZE               CDC_DATA_FS_MAX_PACKET_SIZE

#define BOT_GET_MAX_LUN              0xFE
#define BOT_RESET                    0xFF
#define USB_MSC_CONFIG_DESC_SIZ      32

#define MSC_MAX_FS_PACKET            0x40

static USBD_CDC_ItfTypeDef *CDC_fops;
static USBD_StorageTypeDef *MSC_fops;

static USBD_CDC_HandleTypeDef CDC_ClassData;
static USBD_MSC_BOT_HandleTypeDef MSC_BOT_ClassData;

// I don't think we can make these descriptors constant because they are
// modified (perhaps unnecessarily) by the USB driver.

// USB Standard Device Descriptor
__ALIGN_BEGIN static uint8_t USBD_CDC_MSC_DeviceQualifierDesc[USB_LEN_DEV_QUALIFIER_DESC] __ALIGN_END = {
    USB_LEN_DEV_QUALIFIER_DESC,
    USB_DESC_TYPE_DEVICE_QUALIFIER,
    0x00,
    0x02,
    0x00,
    0x00,
    0x00,
    0x40, // same for CDC and MSC (latter being MSC_MAX_FS_PACKET)
    0x01,
    0x00,
};

// USB CDC MSC device Configuration Descriptor
__ALIGN_BEGIN static uint8_t USBD_CDC_MSC_CfgFSDesc[USB_CDC_MSC_CONFIG_DESC_SIZ] __ALIGN_END = {
    //--------------------------------------------------------------------------
    // Configuration Descriptor
    0x09,   // bLength: Configuration Descriptor size
    USB_DESC_TYPE_CONFIGURATION, // bDescriptorType: Configuration
    LOBYTE(USB_CDC_MSC_CONFIG_DESC_SIZ), // wTotalLength: no of returned bytes
    HIBYTE(USB_CDC_MSC_CONFIG_DESC_SIZ),
    NUM_INTERFACES, // bNumInterfaces: 3 interfaces
    0x01,   // bConfigurationValue: Configuration value
    0x00,   // iConfiguration: Index of string descriptor describing the configuration
    0x80,   // bmAttributes: bus powered; 0xc0 for self powered
    0xfa,   // bMaxPower: in units of 2mA

#if USE_CDC
    //==========================================================================
    // Interface Association for CDC VCP
    0x08,   // bLength: 8 bytes
    USB_DESC_TYPE_ASSOCIATION, // bDescriptorType: IAD
    CDC_IFACE_NUM, // bFirstInterface: first interface for this association
    0x02,   // bInterfaceCount: nummber of interfaces for this association
    0x00,   // bFunctionClass: ?
    0x00,   // bFunctionSubClass: ?
    0x00,   // bFunctionProtocol: ?
    0x00,   // iFunction: index of string for this function

    //--------------------------------------------------------------------------
    // Interface Descriptor
    0x09,   // bLength: Interface Descriptor size
    USB_DESC_TYPE_INTERFACE, // bDescriptorType: Interface
    CDC_IFACE_NUM, // bInterfaceNumber: Number of Interface
    0x00,   // bAlternateSetting: Alternate setting
    0x01,   // bNumEndpoints: One endpoints used
    0x02,   // bInterfaceClass: Communication Interface Class
    0x02,   // bInterfaceSubClass: Abstract Control Model
    0x01,   // bInterfaceProtocol: Common AT commands
    0x00,   // iInterface:

    // Header Functional Descriptor
    0x05,   // bLength: Endpoint Descriptor size
    0x24,   // bDescriptorType: CS_INTERFACE
    0x00,   // bDescriptorSubtype: Header Func Desc
    0x10,   // bcdCDC: spec release number
    0x01,   // ?

    // Call Management Functional Descriptor
    0x05,   // bFunctionLength
    0x24,   // bDescriptorType: CS_INTERFACE
    0x01,   // bDescriptorSubtype: Call Management Func Desc
    0x00,   // bmCapabilities: D0+D1
    CDC_IFACE_NUM + 1,   // bDataInterface: 1

    // ACM Functional Descriptor
    0x04,   // bFunctionLength
    0x24,   // bDescriptorType: CS_INTERFACE
    0x02,   // bDescriptorSubtype: Abstract Control Management desc
    0x02,   // bmCapabilities

    // Union Functional Descriptor
    0x05,   // bFunctionLength
    0x24,   // bDescriptorType: CS_INTERFACE
    0x06,   // bDescriptorSubtype: Union func desc
    CDC_IFACE_NUM + 0,   // bMasterInterface: Communication class interface
    CDC_IFACE_NUM + 1,   // bSlaveInterface0: Data Class Interface

    // Endpoint 2 Descriptor
    0x07,                           // bLength: Endpoint Descriptor size
    USB_DESC_TYPE_ENDPOINT,         // bDescriptorType: Endpoint
    CDC_CMD_EP,                     // bEndpointAddress
    0x03,                           // bmAttributes: Interrupt
    LOBYTE(CDC_CMD_PACKET_SIZE),    // wMaxPacketSize:
    HIBYTE(CDC_CMD_PACKET_SIZE),
    0x20,                           // bInterval: polling interval in frames of 1ms

    //--------------------------------------------------------------------------
    // Data class interface descriptor
    0x09,   // bLength: Endpoint Descriptor size
    USB_DESC_TYPE_INTERFACE, // bDescriptorType: interface
    CDC_IFACE_NUM + 1,   // bInterfaceNumber: Number of Interface
    0x00,   // bAlternateSetting: Alternate setting
    0x02,   // bNumEndpoints: Two endpoints used
    0x0A,   // bInterfaceClass: CDC
    0x00,   // bInterfaceSubClass: ?
    0x00,   // bInterfaceProtocol: ?
    0x00,   // iInterface:

    // Endpoint OUT Descriptor
    0x07,                               // bLength: Endpoint Descriptor size
    USB_DESC_TYPE_ENDPOINT,             // bDescriptorType: Endpoint
    CDC_OUT_EP,                         // bEndpointAddress
    0x02,                               // bmAttributes: Bulk
    LOBYTE(CDC_DATA_FS_MAX_PACKET_SIZE),// wMaxPacketSize:
    HIBYTE(CDC_DATA_FS_MAX_PACKET_SIZE),
    0x00,                               // bInterval: ignore for Bulk transfer

    // Endpoint IN Descriptor
    0x07,                               // bLength: Endpoint Descriptor size
    USB_DESC_TYPE_ENDPOINT,             // bDescriptorType: Endpoint
    CDC_IN_EP,                          // bEndpointAddress
    0x02,                               // bmAttributes: Bulk
    LOBYTE(CDC_DATA_FS_MAX_PACKET_SIZE),// wMaxPacketSize:
    HIBYTE(CDC_DATA_FS_MAX_PACKET_SIZE),
    0x00,                               // bInterval: ignore for Bulk transfer
#endif

#if USE_MSC
    //==========================================================================
    // MSC only has 1 interface so doesn't need an IAD

    //--------------------------------------------------------------------------
    // Interface Descriptor
    0x09,   // bLength: Interface Descriptor size
    USB_DESC_TYPE_INTERFACE, // bDescriptorType: interface descriptor
    MSC_IFACE_NUM, // bInterfaceNumber: Number of Interface
    0x00,   // bAlternateSetting: Alternate setting
    0x02,   // bNumEndpoints
    0x08,   // bInterfaceClass: MSC Class
    0x06,   // bInterfaceSubClass : SCSI transparent
    0x50,   // nInterfaceProtocol
    0x00,   // iInterface:

    // Endpoint IN descriptor
    0x07,                           // bLength: Endpoint descriptor length
    USB_DESC_TYPE_ENDPOINT,         // bDescriptorType: Endpoint descriptor type
    MSC_IN_EP,                      // bEndpointAddress: IN, address 3
    0x02,                           // bmAttributes: Bulk endpoint type
    LOBYTE(MSC_MAX_FS_PACKET),      // wMaxPacketSize
    HIBYTE(MSC_MAX_FS_PACKET),
    0x00,                           // bInterval: ignore for Bulk transfer

    // Endpoint OUT descriptor
    0x07,                           // bLength: Endpoint descriptor length
    USB_DESC_TYPE_ENDPOINT,         // bDescriptorType: Endpoint descriptor type
    MSC_OUT_EP,                     // bEndpointAddress: OUT, address 3
    0x02,                           // bmAttributes: Bulk endpoint type
    LOBYTE(MSC_MAX_FS_PACKET),      // wMaxPacketSize
    HIBYTE(MSC_MAX_FS_PACKET),
    0x00,                           // bInterval: ignore for Bulk transfer
#endif
};

static uint8_t USBD_CDC_MSC_Init(USBD_HandleTypeDef *pdev, uint8_t cfgidx) {
    if (pdev->dev_speed == USBD_SPEED_HIGH) {
        // can't handle high speed
        return 1;
    }

#if USE_CDC
    //----------------------------------
    // CDC VCP component

    // Open EP IN
    USBD_LL_OpenEP(pdev,
                   CDC_IN_EP,
                   USBD_EP_TYPE_BULK,
                   CDC_DATA_FS_IN_PACKET_SIZE);

    // Open EP OUT
    USBD_LL_OpenEP(pdev,
                   CDC_OUT_EP,
                   USBD_EP_TYPE_BULK,
                   CDC_DATA_FS_OUT_PACKET_SIZE);

    // Open Command IN EP
    USBD_LL_OpenEP(pdev,
                   CDC_CMD_EP,
                   USBD_EP_TYPE_INTR,
                   CDC_CMD_PACKET_SIZE);

    // Init physical Interface components
    CDC_fops->Init();

    // Init Xfer states
    CDC_ClassData.TxState =0;
    CDC_ClassData.RxState =0;

    // Prepare Out endpoint to receive next packet
    USBD_LL_PrepareReceive(pdev, CDC_OUT_EP, CDC_ClassData.RxBuffer, CDC_DATA_FS_OUT_PACKET_SIZE);
#endif

#if USE_MSC
    //----------------------------------
    // MSC component

    // Open EP OUT
    USBD_LL_OpenEP(pdev,
                   MSC_OUT_EP,
                   USBD_EP_TYPE_BULK,
                   MSC_MAX_FS_PACKET);

    // Open EP IN
    USBD_LL_OpenEP(pdev,
                   MSC_IN_EP,
                   USBD_EP_TYPE_BULK,
                   MSC_MAX_FS_PACKET);

    // MSC uses the pClassData pointer because SCSI and BOT reference it
    pdev->pClassData = &MSC_BOT_ClassData;

    // Init the BOT layer
    MSC_BOT_Init(pdev);
#endif

    return 0;
}

static uint8_t USBD_CDC_MSC_DeInit(USBD_HandleTypeDef *pdev, uint8_t cfgidx) {
#if USD_CDC
    //----------------------------------
    // CDC VCP component

    // close endpoints
    USBD_LL_CloseEP(pdev, CDC_IN_EP);
    USBD_LL_CloseEP(pdev, CDC_OUT_EP);
    USBD_LL_CloseEP(pdev, CDC_CMD_EP);

    // DeInit physical Interface components
    CDC_fops->DeInit();
#endif

#if USE_MSC
    //----------------------------------
    // MSC component

    // close endpoints
    USBD_LL_CloseEP(pdev, MSC_OUT_EP);
    USBD_LL_CloseEP(pdev, MSC_IN_EP);

    // DeInit the BOT layer
    MSC_BOT_DeInit(pdev);

    // clear the pointer
    pdev->pClassData = NULL;
#endif

    return 0;
}

static uint8_t USBD_CDC_MSC_Setup(USBD_HandleTypeDef *pdev, USBD_SetupReqTypedef *req) {

    /*
    printf("SU: %x %x %x %x\n", req->bmRequest, req->bRequest, req->wValue, req->wIndex);
    This is what we get when MSC is IFACE=0 and CDC is IFACE=1,2:
        SU: 21 22 0 1 -- USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE; CDC_SET_CONTROL_LINE_STATE
        SU: 21 20 0 1 -- USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE; CDC_SET_LINE_CODING
        SU: a1 fe 0 0 -- 0x80 | USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE; BOT_GET_MAX_LUN; 0; 0
        SU: 21 22 3 1 -- USB_REQ_TYPE_CLASS | USB_REQ_RECIPIENT_INTERFACE; CDC_SET_CONTROL_LINE_STATE
    */

    switch (req->bmRequest & USB_REQ_TYPE_MASK) {

        // Class request
        case USB_REQ_TYPE_CLASS:
            // req->wIndex is the recipient interface number
            if (0) {
#if USE_CDC
            } else if (req->wIndex == CDC_IFACE_NUM) {
                // CDC component
                if (req->wLength) {
                    if (req->bmRequest & 0x80) {
                        // device-to-host request
                        CDC_fops->Control(req->bRequest, (uint8_t*)CDC_ClassData.data, req->wLength);
                        USBD_CtlSendData(pdev, (uint8_t*)CDC_ClassData.data, req->wLength);
                    } else {
                        // host-to-device request
                        CDC_ClassData.CmdOpCode = req->bRequest;
                        CDC_ClassData.CmdLength = req->wLength;
                        USBD_CtlPrepareRx(pdev, (uint8_t*)CDC_ClassData.data, req->wLength);
                    }
                } else {
                    // Not a Data request
                    // Transfer the command to the interface layer
                    return CDC_fops->Control(req->bRequest, NULL, req->wValue);
                }
                break;
#endif
#if USE_MSC
             } else if (req->wIndex == MSC_IFACE_NUM) {
          // MSC component
        switch (req->bRequest) {
        case BOT_GET_MAX_LUN :

          if((req->wValue  == 0) && 
             (req->wLength == 1) &&
             ((req->bmRequest & 0x80) == 0x80))
          {
            MSC_BOT_ClassData.max_lun = MSC_fops->GetMaxLun();
            USBD_CtlSendData (pdev, (uint8_t *)&MSC_BOT_ClassData.max_lun, 1);
          }
          else
          {
             USBD_CtlError(pdev , req);
             return USBD_FAIL; 
          }
          break;
          
        case BOT_RESET :
          if((req->wValue  == 0) && 
             (req->wLength == 0) &&
            ((req->bmRequest & 0x80) != 0x80))
          {      
             MSC_BOT_Reset(pdev);
          }
          else
          {
             USBD_CtlError(pdev , req);
             return USBD_FAIL; 
          }
          break;

        default:
           USBD_CtlError(pdev , req);
           return USBD_FAIL; 
        }
    break;
      }
#endif
      break;

    /* Interface & Endpoint request */
    case USB_REQ_TYPE_STANDARD:
#if USE_MSC
        // MSC only
        switch (req->bRequest) {
            case USB_REQ_GET_INTERFACE :
                USBD_CtlSendData(pdev, (uint8_t *)&MSC_BOT_ClassData.interface, 1);
                break;

            case USB_REQ_SET_INTERFACE :
                MSC_BOT_ClassData.interface = (uint8_t)(req->wValue);
                break;

            case USB_REQ_CLEAR_FEATURE:
                /* Flush the FIFO and Clear the stall status */
                USBD_LL_FlushEP(pdev, (uint8_t)req->wIndex);

                /* Re-activate the EP */
                USBD_LL_CloseEP (pdev , (uint8_t)req->wIndex);
                if((((uint8_t)req->wIndex) & 0x80) == 0x80) {
                    /* Open EP IN */
                    USBD_LL_OpenEP(pdev, MSC_IN_EP, USBD_EP_TYPE_BULK, MSC_MAX_FS_PACKET);
                } else {
                    /* Open EP OUT */
                    USBD_LL_OpenEP(pdev, MSC_OUT_EP, USBD_EP_TYPE_BULK, MSC_MAX_FS_PACKET);
                }
                /* Handle BOT error */
                MSC_BOT_CplClrFeature(pdev, (uint8_t)req->wIndex);
                break;
        }
#endif
        break;
    }
    return USBD_OK;
}

static uint8_t USBD_CDC_MSC_EP0_RxReady(USBD_HandleTypeDef *pdev) {
  if((CDC_fops != NULL) && (CDC_ClassData.CmdOpCode != 0xFF)) {
    CDC_fops->Control(CDC_ClassData.CmdOpCode,
                                                      (uint8_t *)CDC_ClassData.data,
                                                      CDC_ClassData.CmdLength);
      CDC_ClassData.CmdOpCode = 0xFF; 
      
  }
  return USBD_OK;
}

static uint8_t USBD_CDC_MSC_DataIn(USBD_HandleTypeDef *pdev, uint8_t epnum) {
    switch (epnum) {
#if USE_CDC
        case (CDC_IN_EP & 0x7f):
        case (CDC_CMD_EP & 0x7f):
            CDC_ClassData.TxState = 0;
            return USBD_OK;
#endif

        case (MSC_IN_EP & 0x7f):
            MSC_BOT_DataIn(pdev, epnum);
            return USBD_OK;
    }

    return USBD_OK;
}

static uint8_t USBD_CDC_MSC_DataOut(USBD_HandleTypeDef *pdev, uint8_t epnum) {
    switch (epnum) {
#if USE_CDC
        case (CDC_OUT_EP & 0x7f):
            /* Get the received data length */
            CDC_ClassData.RxLength = USBD_LL_GetRxDataSize (pdev, epnum);

            /* USB data will be immediately processed, this allow next USB traffic being
            NAKed till the end of the application Xfer */
            CDC_fops->Receive(CDC_ClassData.RxBuffer, &CDC_ClassData.RxLength);

            return USBD_OK;
#endif

        case (MSC_OUT_EP & 0x7f):
            MSC_BOT_DataOut(pdev, epnum);
            return USBD_OK;
    }

    return USBD_OK;
}

static uint8_t *USBD_CDC_MSC_GetFSCfgDesc(uint16_t *length) {
    *length = sizeof(USBD_CDC_MSC_CfgFSDesc);
    return USBD_CDC_MSC_CfgFSDesc;
}

static uint8_t *USBD_CDC_MSC_GetHSCfgDesc(uint16_t *length) {
    *length = 0;
    return USBD_CDC_MSC_CfgFSDesc; // need to return something because the USB driver writes bytes to the result
}

static uint8_t *USBD_CDC_MSC_GetOtherSpeedCfgDesc (uint16_t *length) {
    *length = 0;
    return USBD_CDC_MSC_CfgFSDesc; // need to return something because the USB driver writes bytes to the result
}

uint8_t *USBD_CDC_MSC_GetDeviceQualifierDescriptor (uint16_t *length) {
    *length = sizeof(USBD_CDC_MSC_DeviceQualifierDesc);
    return USBD_CDC_MSC_DeviceQualifierDesc;
}

uint8_t USBD_CDC_RegisterInterface(USBD_HandleTypeDef *pdev, USBD_CDC_ItfTypeDef *fops) {
    if (fops == NULL) {
        return USBD_FAIL;
    } else {
        CDC_fops = fops;
        return USBD_OK;
    }
}

/**
  * @brief  USBD_CDC_SetTxBuffer
  * @param  pdev: device instance
  * @param  pbuff: Tx Buffer
  * @retval status
  */
uint8_t  USBD_CDC_SetTxBuffer  (USBD_HandleTypeDef   *pdev,
                                uint8_t  *pbuff,
                                uint16_t length)
{
  CDC_ClassData.TxBuffer = pbuff;
  CDC_ClassData.TxLength = length;  
  
  return USBD_OK;  
}


/**
  * @brief  USBD_CDC_SetRxBuffer
  * @param  pdev: device instance
  * @param  pbuff: Rx Buffer
  * @retval status
  */
uint8_t  USBD_CDC_SetRxBuffer  (USBD_HandleTypeDef   *pdev,
                                   uint8_t  *pbuff)
{
  CDC_ClassData.RxBuffer = pbuff;
  
  return USBD_OK;
}

/**
  * @brief  USBD_CDC_DataOut
  *         Data received on non-control Out endpoint
  * @param  pdev: device instance
  * @param  epnum: endpoint number
  * @retval status
  */
uint8_t  USBD_CDC_TransmitPacket(USBD_HandleTypeDef *pdev) {
    if(CDC_ClassData.TxState == 0) {
      
      /* Transmit next packet */
      USBD_LL_Transmit(pdev,
                       CDC_IN_EP,
                       CDC_ClassData.TxBuffer,
                       CDC_ClassData.TxLength);
      
      /* Tx Transfer in progress */
      CDC_ClassData.TxState = 1;
      return USBD_OK;
    }
    else
    {
      return USBD_BUSY;
    }
}


/**
  * @brief  USBD_CDC_ReceivePacket
  *         prepare OUT Endpoint for reception
  * @param  pdev: device instance
  * @retval status
  */
uint8_t USBD_CDC_ReceivePacket(USBD_HandleTypeDef *pdev) {
    // Suspend or Resume USB Out process
    if (pdev->dev_speed == USBD_SPEED_HIGH) {
        return USBD_FAIL;
    }

    // Prepare Out endpoint to receive next packet */
    USBD_LL_PrepareReceive(pdev,
                           CDC_OUT_EP,
                           CDC_ClassData.RxBuffer,
                           CDC_DATA_FS_OUT_PACKET_SIZE);

    return USBD_OK;
}

uint8_t USBD_MSC_RegisterStorage(USBD_HandleTypeDef *pdev, USBD_StorageTypeDef *fops) {
    if (fops == NULL) {
        return USBD_FAIL;
    } else {
        MSC_fops = fops;
        pdev->pUserData = fops; // MSC uses pUserData because SCSI and BOT reference it
        return USBD_OK;
    }
}

// CDC + MSC interface class callbacks structure
USBD_ClassTypeDef USBD_CDC_MSC = {
    USBD_CDC_MSC_Init,
    USBD_CDC_MSC_DeInit,
    USBD_CDC_MSC_Setup,
    NULL, // EP0_TxSent
    USBD_CDC_MSC_EP0_RxReady,
    USBD_CDC_MSC_DataIn,
    USBD_CDC_MSC_DataOut,
    NULL, // SOF
    NULL,
    NULL,
    USBD_CDC_MSC_GetHSCfgDesc,
    USBD_CDC_MSC_GetFSCfgDesc,
    USBD_CDC_MSC_GetOtherSpeedCfgDesc,
    USBD_CDC_MSC_GetDeviceQualifierDescriptor,
};