USBH_MSC_BOT_Exported_FunctionsPrototype

Collaboration diagram for USBH_MSC_BOT_Exported_FunctionsPrototype:

Functions
USBH_StatusTypeDef	USBH_MSC_BOT_REQ_Reset (USBH_HandleTypeDef *phost)
	USBH_MSC_BOT_REQ_Reset The function the MSC BOT Reset request. More...
USBH_StatusTypeDef	USBH_MSC_BOT_REQ_GetMaxLUN (USBH_HandleTypeDef *phost, uint8_t *Maxlun)
	USBH_MSC_BOT_REQ_GetMaxLUN The function the MSC BOT GetMaxLUN request. More...
USBH_StatusTypeDef	USBH_MSC_BOT_Init (USBH_HandleTypeDef *phost)
	USBH_MSC_BOT_Init The function Initializes the BOT protocol. More...
USBH_StatusTypeDef	USBH_MSC_BOT_Process (USBH_HandleTypeDef *phost, uint8_t lun)
	USBH_MSC_BOT_Process The function handle the BOT protocol. More...
USBH_StatusTypeDef	USBH_MSC_BOT_Error (USBH_HandleTypeDef *phost, uint8_t lun)

Detailed Description

Function Documentation

USBH_MSC_BOT_REQ_Reset()

USBH_StatusTypeDef USBH_MSC_BOT_REQ_Reset

(

USBH_HandleTypeDef *

phost

)

USBH_MSC_BOT_REQ_Reset The function the MSC BOT Reset request.

Parameters

phost

Host handle

Return values

USBH

Status

{
 
  phost->Control.setup.b.bmRequestType = USB_H2D | USB_REQ_TYPE_CLASS | \
                              USB_REQ_RECIPIENT_INTERFACE;
 
  phost->Control.setup.b.bRequest = USB_REQ_BOT_RESET;
  phost->Control.setup.b.wValue.w = 0;
  phost->Control.setup.b.wIndex.w = 0;
  phost->Control.setup.b.wLength.w = 0;
 
  return USBH_CtlReq(phost, 0 , 0 );
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_MSC_BOT_REQ_GetMaxLUN()

USBH_StatusTypeDef USBH_MSC_BOT_REQ_GetMaxLUN	(	USBH_HandleTypeDef *	phost,
		uint8_t *	Maxlun
	)

USBH_MSC_BOT_REQ_GetMaxLUN The function the MSC BOT GetMaxLUN request.

Parameters

phost	Host handle
Maxlun	pointer to Maxlun variable

Return values

USBH

Status

{
  phost->Control.setup.b.bmRequestType = USB_D2H | USB_REQ_TYPE_CLASS | \
                              USB_REQ_RECIPIENT_INTERFACE;
 
  phost->Control.setup.b.bRequest = USB_REQ_GET_MAX_LUN;
  phost->Control.setup.b.wValue.w = 0;
  phost->Control.setup.b.wIndex.w = 0;
  phost->Control.setup.b.wLength.w = 1;
 
  return USBH_CtlReq(phost, Maxlun , 1 );
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_MSC_BOT_Init()

USBH_StatusTypeDef USBH_MSC_BOT_Init

(

USBH_HandleTypeDef *

phost

)

USBH_MSC_BOT_Init The function Initializes the BOT protocol.

Parameters

phost

Host handle

Return values

USBH

Status

{
 
  MSC_HandleTypeDef *MSC_Handle =  (MSC_HandleTypeDef *) phost->pActiveClass->pData;
 
  MSC_Handle->hbot.cbw.field.Signature = BOT_CBW_SIGNATURE;
  MSC_Handle->hbot.cbw.field.Tag = BOT_CBW_TAG;
  MSC_Handle->hbot.state = BOT_SEND_CBW;
  MSC_Handle->hbot.cmd_state = BOT_CMD_SEND;
 
  return USBH_OK;
}

Here is the caller graph for this function:

USBH_MSC_BOT_Process()

USBH_StatusTypeDef USBH_MSC_BOT_Process	(	USBH_HandleTypeDef *	phost,
		uint8_t	lun
	)

USBH_MSC_BOT_Process The function handle the BOT protocol.

Parameters

phost	Host handle
lun	Logical Unit Number

Return values

USBH

Status

{
  USBH_StatusTypeDef   status = USBH_BUSY;
  USBH_StatusTypeDef   error  = USBH_BUSY;
  BOT_CSWStatusTypeDef CSW_Status = BOT_CSW_CMD_FAILED;
  USBH_URBStateTypeDef URB_Status = USBH_URB_IDLE;
  MSC_HandleTypeDef *MSC_Handle =  (MSC_HandleTypeDef *) phost->pActiveClass->pData;
  uint8_t toggle = 0;
 
  switch (MSC_Handle->hbot.state)
  {
  case BOT_SEND_CBW:
    MSC_Handle->hbot.cbw.field.LUN = lun;
    MSC_Handle->hbot.state = BOT_SEND_CBW_WAIT;
    USBH_BulkSendData (phost,
                       MSC_Handle->hbot.cbw.data,
                       BOT_CBW_LENGTH,
                       MSC_Handle->OutPipe,
                       1);
 
    break;
 
  case BOT_SEND_CBW_WAIT:
 
    URB_Status = USBH_LL_GetURBState(phost, MSC_Handle->OutPipe);
 
    if(URB_Status == USBH_URB_DONE)
    {
      if ( MSC_Handle->hbot.cbw.field.DataTransferLength != 0 )
      {
        /* If there is Data Transfer Stage */
        if (((MSC_Handle->hbot.cbw.field.Flags) & USB_REQ_DIR_MASK) == USB_D2H)
        {
          /* Data Direction is IN */
          MSC_Handle->hbot.state = BOT_DATA_IN;
        }
        else
        {
          /* Data Direction is OUT */
          MSC_Handle->hbot.state = BOT_DATA_OUT;
        }
      }
 
      else
      {/* If there is NO Data Transfer Stage */
        MSC_Handle->hbot.state = BOT_RECEIVE_CSW;
      }
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
 
    }
    else if(URB_Status == USBH_URB_NOTREADY)
    {
      /* Re-send CBW */
      MSC_Handle->hbot.state = BOT_SEND_CBW;
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    else if(URB_Status == USBH_URB_STALL)
    {
      MSC_Handle->hbot.state  = BOT_ERROR_OUT;
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    break;
 
  case BOT_DATA_IN:
    /* Send first packet */
    USBH_BulkReceiveData (phost,
                          MSC_Handle->hbot.pbuf,
                          MSC_Handle->InEpSize ,
                          MSC_Handle->InPipe);
 
    MSC_Handle->hbot.state  = BOT_DATA_IN_WAIT;
 
    break;
 
  case BOT_DATA_IN_WAIT:
 
    URB_Status = USBH_LL_GetURBState(phost, MSC_Handle->InPipe);
 
    if(URB_Status == USBH_URB_DONE)
    {
      /* Adjust Data pointer and data length */
      if(MSC_Handle->hbot.cbw.field.DataTransferLength > MSC_Handle->InEpSize)
      {
          MSC_Handle->hbot.pbuf += MSC_Handle->InEpSize;
          MSC_Handle->hbot.cbw.field.DataTransferLength -= MSC_Handle->InEpSize;
      }
      else
      {
        MSC_Handle->hbot.cbw.field.DataTransferLength = 0;
      }
 
      /* More Data To be Received */
      if(MSC_Handle->hbot.cbw.field.DataTransferLength > 0)
      {
        /* Send next packet */
        USBH_BulkReceiveData (phost,
                              MSC_Handle->hbot.pbuf,
                              MSC_Handle->InEpSize ,
                              MSC_Handle->InPipe);
 
      }
      else
      {
        /* If value was 0, and successful transfer, then change the state */
        MSC_Handle->hbot.state  = BOT_RECEIVE_CSW;
#if (USBH_USE_OS == 1)
        osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
      }
    }
    else if(URB_Status == USBH_URB_STALL)
    {
      /* This is Data IN Stage STALL Condition */
      MSC_Handle->hbot.state  = BOT_ERROR_IN;
 
      /* Refer to USB Mass-Storage Class : BOT (www.usb.org)
      6.7.2 Host expects to receive data from the device
      3. On a STALL condition receiving data, then:
      The host shall accept the data received.
      The host shall clear the Bulk-In pipe.
      4. The host shall attempt to receive a CSW.*/
 
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    break;
 
  case BOT_DATA_OUT:
 
    USBH_BulkSendData (phost,
                       MSC_Handle->hbot.pbuf,
                       MSC_Handle->OutEpSize ,
                       MSC_Handle->OutPipe,
                       1);
 
 
    MSC_Handle->hbot.state  = BOT_DATA_OUT_WAIT;
    break;
 
  case BOT_DATA_OUT_WAIT:
    URB_Status = USBH_LL_GetURBState(phost, MSC_Handle->OutPipe);
 
    if(URB_Status == USBH_URB_DONE)
    {
      /* Adjust Data pointer and data length */
      if(MSC_Handle->hbot.cbw.field.DataTransferLength > MSC_Handle->OutEpSize)
      {
          MSC_Handle->hbot.pbuf += MSC_Handle->OutEpSize;
          MSC_Handle->hbot.cbw.field.DataTransferLength -= MSC_Handle->OutEpSize;
      }
      else
      {
        MSC_Handle->hbot.cbw.field.DataTransferLength = 0;
      }
 
      /* More Data To be Sent */
      if(MSC_Handle->hbot.cbw.field.DataTransferLength > 0)
      {
        USBH_BulkSendData (phost,
                           MSC_Handle->hbot.pbuf,
                           MSC_Handle->OutEpSize ,
                           MSC_Handle->OutPipe,
                           1);
      }
      else
      {
        /* If value was 0, and successful transfer, then change the state */
        MSC_Handle->hbot.state  = BOT_RECEIVE_CSW;
      }
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
 
    else if(URB_Status == USBH_URB_NOTREADY)
    {
      /* Resend same data */
      MSC_Handle->hbot.state  = BOT_DATA_OUT;
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
 
    else if(URB_Status == USBH_URB_STALL)
    {
      MSC_Handle->hbot.state  = BOT_ERROR_OUT;
 
      /* Refer to USB Mass-Storage Class : BOT (www.usb.org)
      6.7.3 Ho - Host expects to send data to the device
      3. On a STALL condition sending data, then:
      " The host shall clear the Bulk-Out pipe.
      4. The host shall attempt to receive a CSW.
      */
#if (USBH_USE_OS == 1)
      osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    break;
 
  case BOT_RECEIVE_CSW:
 
    USBH_BulkReceiveData (phost,
                          MSC_Handle->hbot.csw.data,
                          BOT_CSW_LENGTH ,
                          MSC_Handle->InPipe);
 
    MSC_Handle->hbot.state  = BOT_RECEIVE_CSW_WAIT;
    break;
 
  case BOT_RECEIVE_CSW_WAIT:
 
    URB_Status = USBH_LL_GetURBState(phost, MSC_Handle->InPipe);
 
    /* Decode CSW */
    if(URB_Status == USBH_URB_DONE)
    {
      MSC_Handle->hbot.state = BOT_SEND_CBW;
      MSC_Handle->hbot.cmd_state = BOT_CMD_SEND;
      CSW_Status = USBH_MSC_DecodeCSW(phost);
 
      if(CSW_Status == BOT_CSW_CMD_PASSED)
      {
        status = USBH_OK;
      }
      else
      {
        status = USBH_FAIL;
      }
#if (USBH_USE_OS == 1)
      osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    else if(URB_Status == USBH_URB_STALL)
    {
      MSC_Handle->hbot.state  = BOT_ERROR_IN;
#if (USBH_USE_OS == 1)
      osMessagePut ( phost->os_event, USBH_URB_EVENT, 0);
#endif
    }
    break;
 
  case BOT_ERROR_IN:
    error = USBH_MSC_BOT_Abort(phost, lun, BOT_DIR_IN);
 
    if (error == USBH_OK)
    {
      MSC_Handle->hbot.state = BOT_RECEIVE_CSW;
    }
    else if (error == USBH_UNRECOVERED_ERROR)
    {
      /* This means that there is a STALL Error limit, Do Reset Recovery */
      MSC_Handle->hbot.state = BOT_UNRECOVERED_ERROR;
    }
    break;
 
  case BOT_ERROR_OUT:
    error = USBH_MSC_BOT_Abort(phost, lun, BOT_DIR_OUT);
 
    if ( error == USBH_OK)
    {
 
      toggle = USBH_LL_GetToggle(phost, MSC_Handle->OutPipe);
      USBH_LL_SetToggle(phost, MSC_Handle->OutPipe, 1- toggle);
      USBH_LL_SetToggle(phost, MSC_Handle->InPipe, 0);
      MSC_Handle->hbot.state = BOT_ERROR_IN;
    }
    else if (error == USBH_UNRECOVERED_ERROR)
    {
      MSC_Handle->hbot.state = BOT_UNRECOVERED_ERROR;
    }
    break;
 
 
  case BOT_UNRECOVERED_ERROR:
    status = USBH_MSC_BOT_REQ_Reset(phost);
    if ( status == USBH_OK)
    {
      MSC_Handle->hbot.state = BOT_SEND_CBW;
    }
    break;
 
  default:
    break;
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_MSC_BOT_Error()

USBH_StatusTypeDef USBH_MSC_BOT_Error	(	USBH_HandleTypeDef *	phost,
		uint8_t	lun
	)