USBH_CTLREQ_Exported_FunctionsPrototype

Collaboration diagram for USBH_CTLREQ_Exported_FunctionsPrototype:

Functions
USBH_StatusTypeDef	USBH_CtlReq (USBH_HandleTypeDef *phost, uint8_t *buff, uint16_t length)
	USBH_CtlReq USBH_CtlReq sends a control request and provide the status after completion of the request. More...
USBH_StatusTypeDef	USBH_GetDescriptor (USBH_HandleTypeDef *phost, uint8_t req_type, uint16_t value_idx, uint8_t *buff, uint16_t length)
	USBH_GetDescriptor Issues Descriptor command to the device. Once the response received, it parses the descriptor and updates the status. More...
USBH_StatusTypeDef	USBH_Get_DevDesc (USBH_HandleTypeDef *phost, uint8_t length)
	USBH_Get_DevDesc Issue Get Device Descriptor command to the device. Once the response received, it parses the device descriptor and updates the status. More...
USBH_StatusTypeDef	USBH_Get_StringDesc (USBH_HandleTypeDef *phost, uint8_t string_index, uint8_t *buff, uint16_t length)
	USBH_Get_StringDesc Issues string Descriptor command to the device. Once the response received, it parses the string descriptor and updates the status. More...
USBH_StatusTypeDef	USBH_SetCfg (USBH_HandleTypeDef *phost, uint16_t configuration_value)
	USBH_SetCfg The command sets the configuration value to the connected device. More...
USBH_StatusTypeDef	USBH_Get_CfgDesc (USBH_HandleTypeDef *phost, uint16_t length)
	USBH_Get_CfgDesc Issues Configuration Descriptor to the device. Once the response received, it parses the configuration descriptor and updates the status. More...
USBH_StatusTypeDef	USBH_SetAddress (USBH_HandleTypeDef *phost, uint8_t DeviceAddress)
	USBH_SetAddress This command sets the address to the connected device. More...
USBH_StatusTypeDef	USBH_SetInterface (USBH_HandleTypeDef *phost, uint8_t ep_num, uint8_t altSetting)
	USBH_SetInterface The command sets the Interface value to the connected device. More...
USBH_StatusTypeDef	USBH_ClrFeature (USBH_HandleTypeDef *phost, uint8_t ep_num)
	USBH_ClrFeature This request is used to clear or disable a specific feature. More...
USBH_DescHeader_t *	USBH_GetNextDesc (uint8_t *pbuf, uint16_t *ptr)
	USBH_GetNextDesc This function return the next descriptor header. More...

Detailed Description

Function Documentation

USBH_CtlReq()

USBH_StatusTypeDef USBH_CtlReq	(	USBH_HandleTypeDef *	phost,
		uint8_t *	buff,
		uint16_t	length
	)

USBH_CtlReq USBH_CtlReq sends a control request and provide the status after completion of the request.

Parameters

phost	Host Handle
req	Setup Request Structure
buff	data buffer address to store the response
length	length of the response

Return values

USBH

Status

{
  USBH_StatusTypeDef status;
  status = USBH_BUSY;
 
  switch (phost->RequestState)
  {
  case CMD_SEND:
    /* Start a SETUP transfer */
    phost->Control.buff = buff;
    phost->Control.length = length;
    phost->Control.state = CTRL_SETUP;
    phost->RequestState = CMD_WAIT;
    status = USBH_BUSY;
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_CONTROL_EVENT, 0);
#endif
    break;
 
  case CMD_WAIT:
    status = USBH_HandleControl(phost);
     if (status == USBH_OK)
    {
      /* Commands successfully sent and Response Received  */
      phost->RequestState = CMD_SEND;
      phost->Control.state =CTRL_IDLE;
      status = USBH_OK;
    }
    else if  (status == USBH_FAIL)
    {
      /* Failure Mode */
      phost->RequestState = CMD_SEND;
      status = USBH_FAIL;
    }
    break;
 
  default:
    break;
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_GetDescriptor()

USBH_StatusTypeDef USBH_GetDescriptor	(	USBH_HandleTypeDef *	phost,
		uint8_t	req_type,
		uint16_t	value_idx,
		uint8_t *	buff,
		uint16_t	length
	)

USBH_GetDescriptor Issues Descriptor command to the device. Once the response received, it parses the descriptor and updates the status.

Parameters

phost	Host Handle
req_type	Descriptor type
value_idx	Value for the GetDescriptr request
buff	Buffer to store the descriptor
length	Length of the descriptor

Return values

USBH

Status

{
  if(phost->RequestState == CMD_SEND)
  {
    phost->Control.setup.b.bmRequestType = USB_D2H | req_type;
    phost->Control.setup.b.bRequest = USB_REQ_GET_DESCRIPTOR;
    phost->Control.setup.b.wValue.w = value_idx;
 
    if ((value_idx & 0xff00) == USB_DESC_STRING)
    {
      phost->Control.setup.b.wIndex.w = 0x0409;
    }
    else
    {
      phost->Control.setup.b.wIndex.w = 0;
    }
    phost->Control.setup.b.wLength.w = length;
  }
  return USBH_CtlReq(phost, buff , length );
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_Get_DevDesc()

USBH_StatusTypeDef USBH_Get_DevDesc	(	USBH_HandleTypeDef *	phost,
		uint8_t	length
	)

USBH_Get_DevDesc Issue Get Device Descriptor command to the device. Once the response received, it parses the device descriptor and updates the status.

Parameters

phost	Host Handle
length	Length of the descriptor

Return values

USBH

Status

{
  USBH_StatusTypeDef status;
 
  if((status = USBH_GetDescriptor(phost,
                                  USB_REQ_RECIPIENT_DEVICE | USB_REQ_TYPE_STANDARD,
                                  USB_DESC_DEVICE,
                                  phost->device.Data,
                                  length)) == USBH_OK)
  {
    /* Commands successfully sent and Response Received */
    USBH_ParseDevDesc(&phost->device.DevDesc, phost->device.Data, length);
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_Get_StringDesc()

USBH_StatusTypeDef USBH_Get_StringDesc	(	USBH_HandleTypeDef *	phost,
		uint8_t	string_index,
		uint8_t *	buff,
		uint16_t	length
	)

USBH_Get_StringDesc Issues string Descriptor command to the device. Once the response received, it parses the string descriptor and updates the status.

Parameters

phost	Host Handle
string_index	String index for the descriptor
buff	Buffer address for the descriptor
length	Length of the descriptor

Return values

USBH

Status

{
  USBH_StatusTypeDef status;
  if((status = USBH_GetDescriptor(phost,
                                  USB_REQ_RECIPIENT_DEVICE | USB_REQ_TYPE_STANDARD,
                                  USB_DESC_STRING | string_index,
                                  phost->device.Data,
                                  length)) == USBH_OK)
  {
    /* Commands successfully sent and Response Received  */
    USBH_ParseStringDesc(phost->device.Data,buff, length);
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_SetCfg()

USBH_StatusTypeDef USBH_SetCfg	(	USBH_HandleTypeDef *	phost,
		uint16_t	cfg_idx
	)

USBH_SetCfg The command sets the configuration value to the connected device.

Parameters

phost	Host Handle
cfg_idx	Configuration value

Return values

USBH

Status

{
  if(phost->RequestState == CMD_SEND)
  {
    phost->Control.setup.b.bmRequestType = USB_H2D | USB_REQ_RECIPIENT_DEVICE |\
      USB_REQ_TYPE_STANDARD;
    phost->Control.setup.b.bRequest = USB_REQ_SET_CONFIGURATION;
    phost->Control.setup.b.wValue.w = cfg_idx;
    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_Get_CfgDesc()

USBH_StatusTypeDef USBH_Get_CfgDesc	(	USBH_HandleTypeDef *	phost,
		uint16_t	length
	)

USBH_Get_CfgDesc Issues Configuration Descriptor to the device. Once the response received, it parses the configuration descriptor and updates the status.

Parameters

phost	Host Handle
length	Length of the descriptor

Return values

USBH

Status

{
  USBH_StatusTypeDef status;
  uint8_t *pData;
#if (USBH_KEEP_CFG_DESCRIPTOR == 1)
  pData = phost->device.CfgDesc_Raw;
#else
  pData = phost->device.Data;
#endif
  if((status = USBH_GetDescriptor(phost,
                                  USB_REQ_RECIPIENT_DEVICE | USB_REQ_TYPE_STANDARD,
                                  USB_DESC_CONFIGURATION,
                                  pData,
                                  length)) == USBH_OK)
  {
 
    /* Commands successfully sent and Response Received  */
    USBH_ParseCfgDesc (&phost->device.CfgDesc,
                       pData,
                       length);
 
  }
  return status;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_SetAddress()

USBH_StatusTypeDef USBH_SetAddress	(	USBH_HandleTypeDef *	phost,
		uint8_t	DeviceAddress
	)

USBH_SetAddress This command sets the address to the connected device.

Parameters

phost	Host Handle
DeviceAddress	Device address to assign

Return values

USBH

Status

{
  if(phost->RequestState == CMD_SEND)
  {
    phost->Control.setup.b.bmRequestType = USB_H2D | USB_REQ_RECIPIENT_DEVICE | \
      USB_REQ_TYPE_STANDARD;
 
    phost->Control.setup.b.bRequest = USB_REQ_SET_ADDRESS;
 
    phost->Control.setup.b.wValue.w = (uint16_t)DeviceAddress;
    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_SetInterface()

USBH_StatusTypeDef USBH_SetInterface	(	USBH_HandleTypeDef *	phost,
		uint8_t	ep_num,
		uint8_t	altSetting
	)

USBH_SetInterface The command sets the Interface value to the connected device.

Parameters

phost	Host Handle
altSetting	Interface value

Return values

USBH

Status

{
 
  if(phost->RequestState == CMD_SEND)
  {
    phost->Control.setup.b.bmRequestType = USB_H2D | USB_REQ_RECIPIENT_INTERFACE | \
      USB_REQ_TYPE_STANDARD;
 
    phost->Control.setup.b.bRequest = USB_REQ_SET_INTERFACE;
    phost->Control.setup.b.wValue.w = altSetting;
    phost->Control.setup.b.wIndex.w = ep_num;
    phost->Control.setup.b.wLength.w = 0;
  }
  return USBH_CtlReq(phost, 0 , 0 );
}

Here is the call graph for this function:

USBH_ClrFeature()

USBH_StatusTypeDef USBH_ClrFeature	(	USBH_HandleTypeDef *	phost,
		uint8_t	ep_num
	)

USBH_ClrFeature This request is used to clear or disable a specific feature.

Parameters

phost	Host Handle
ep_num	endpoint number
hc_num	Host channel number

Return values

USBH

Status

{
  if(phost->RequestState == CMD_SEND)
  {
    phost->Control.setup.b.bmRequestType = USB_H2D |
      USB_REQ_RECIPIENT_ENDPOINT |
        USB_REQ_TYPE_STANDARD;
 
    phost->Control.setup.b.bRequest = USB_REQ_CLEAR_FEATURE;
    phost->Control.setup.b.wValue.w = FEATURE_SELECTOR_ENDPOINT;
    phost->Control.setup.b.wIndex.w = ep_num;
    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_GetNextDesc()

USBH_DescHeader_t* USBH_GetNextDesc	(	uint8_t *	pbuf,
		uint16_t *	ptr
	)

USBH_GetNextDesc This function return the next descriptor header.

Parameters

buf	Buffer where the cfg descriptor is available
ptr	data pointer inside the cfg descriptor

Return values

next

header

{
  USBH_DescHeader_t  *pnext;
 
  *ptr += ((USBH_DescHeader_t *)pbuf)->bLength;
  pnext = (USBH_DescHeader_t *)((uint8_t *)pbuf + \
         ((USBH_DescHeader_t *)pbuf)->bLength);
 
  return(pnext);
}

Here is the caller graph for this function: