USBH_CORE_Exported_FunctionsPrototype

Collaboration diagram for USBH_CORE_Exported_FunctionsPrototype:

Functions
USBH_StatusTypeDef	USBH_Init (USBH_HandleTypeDef *phost, void(*pUsrFunc)(USBH_HandleTypeDef *phost, uint8_t), uint8_t id)
	HCD_Init Initialize the HOST Core. More...
USBH_StatusTypeDef	USBH_DeInit (USBH_HandleTypeDef *phost)
	HCD_Init De-Initialize the Host portion of the driver. More...
USBH_StatusTypeDef	USBH_RegisterClass (USBH_HandleTypeDef *phost, USBH_ClassTypeDef *pclass)
	USBH_RegisterClass Link class driver to Host Core. More...
USBH_StatusTypeDef	USBH_SelectInterface (USBH_HandleTypeDef *phost, uint8_t interface)
	USBH_SelectInterface Select current interface. More...
uint8_t	USBH_FindInterface (USBH_HandleTypeDef *phost, uint8_t Class, uint8_t SubClass, uint8_t Protocol)
	USBH_FindInterface Find the interface index for a specific class. More...
uint8_t	USBH_GetActiveClass (USBH_HandleTypeDef *phost)
	USBH_GetActiveClass Return Device Class. More...
uint8_t	USBH_FindInterfaceIndex (USBH_HandleTypeDef *phost, uint8_t interface_number, uint8_t alt_settings)
	USBH_FindInterfaceIndex Find the interface index for a specific class interface and alternate setting number. More...
USBH_StatusTypeDef	USBH_Start (USBH_HandleTypeDef *phost)
	USBH_Start Start the USB Host Core. More...
USBH_StatusTypeDef	USBH_Stop (USBH_HandleTypeDef *phost)
	USBH_Stop Stop the USB Host Core. More...
USBH_StatusTypeDef	USBH_Process (USBH_HandleTypeDef *phost)
	USBH_Process Background process of the USB Core. More...
USBH_StatusTypeDef	USBH_ReEnumerate (USBH_HandleTypeDef *phost)
	HCD_ReEnumerate Perform a new Enumeration phase. More...
USBH_StatusTypeDef	USBH_LL_Init (USBH_HandleTypeDef *phost)
	Initialize the low level portion of the host driver. More...
USBH_StatusTypeDef	USBH_LL_DeInit (USBH_HandleTypeDef *phost)
	De-Initialize the low level portion of the host driver. More...
USBH_StatusTypeDef	USBH_LL_Start (USBH_HandleTypeDef *phost)
	Start the low level portion of the host driver. More...
USBH_StatusTypeDef	USBH_LL_Stop (USBH_HandleTypeDef *phost)
	Stop the low level portion of the host driver. More...
USBH_StatusTypeDef	USBH_LL_Connect (USBH_HandleTypeDef *phost)
	USBH_LL_Connect Handle USB Host connexion event. More...
USBH_StatusTypeDef	USBH_LL_Disconnect (USBH_HandleTypeDef *phost)
	USBH_LL_Disconnect Handle USB Host disconnection event. More...
USBH_SpeedTypeDef	USBH_LL_GetSpeed (USBH_HandleTypeDef *phost)
	Return the USB host speed from the low level driver. More...
USBH_StatusTypeDef	USBH_LL_ResetPort (USBH_HandleTypeDef *phost)
	Reset the Host port of the low level driver. More...
uint32_t	USBH_LL_GetLastXferSize (USBH_HandleTypeDef *phost, uint8_t)
	Return the last transfered packet size. More...
USBH_StatusTypeDef	USBH_LL_DriverVBUS (USBH_HandleTypeDef *phost, uint8_t)
	Drive VBUS. More...
USBH_StatusTypeDef	USBH_LL_OpenPipe (USBH_HandleTypeDef *phost, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint16_t)
	Open a pipe of the low level driver. More...
USBH_StatusTypeDef	USBH_LL_ClosePipe (USBH_HandleTypeDef *phost, uint8_t)
	Close a pipe of the low level driver. More...
USBH_StatusTypeDef	USBH_LL_SubmitURB (USBH_HandleTypeDef *phost, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t *, uint16_t, uint8_t)
	Submit a new URB to the low level driver. More...
USBH_URBStateTypeDef	USBH_LL_GetURBState (USBH_HandleTypeDef *phost, uint8_t)
	Get a URB state from the low level driver. More...
USBH_StatusTypeDef	USBH_LL_SetToggle (USBH_HandleTypeDef *phost, uint8_t, uint8_t)
	Set toggle for a pipe. More...
uint8_t	USBH_LL_GetToggle (USBH_HandleTypeDef *phost, uint8_t)
	Return the current toggle of a pipe. More...
void	USBH_Delay (uint32_t Delay)
	Delay routine for the USB Host Library. More...
void	USBH_LL_SetTimer (USBH_HandleTypeDef *phost, uint32_t)
	USBH_LL_SetTimer Set the initial Host Timer tick. More...
void	USBH_LL_IncTimer (USBH_HandleTypeDef *phost)
	USBH_LL_IncTimer Increment Host Timer tick. More...

Detailed Description

Function Documentation

USBH_Init()

USBH_StatusTypeDef USBH_Init	(	USBH_HandleTypeDef *	phost,
		void(*)(USBH_HandleTypeDef *phost, uint8_t)	pUsrFunc,
		uint8_t	id
	)

HCD_Init Initialize the HOST Core.

Parameters

phost	Host Handle
pUsrFunc	User Callback

Return values

USBH

Status

{
  /* Check whether the USB Host handle is valid */
  if(phost == NULL)
  {
    USBH_ErrLog("Invalid Host handle");
    return USBH_FAIL;
  }
 
  /* Set DRiver ID */
  phost->id = id;
 
  /* Unlink class*/
  phost->pActiveClass = NULL;
  phost->ClassNumber = 0;
 
  /* Restore default states and prepare EP0 */
  DeInitStateMachine(phost);
 
  /* Assign User process */
  if(pUsrFunc != NULL)
  {
    phost->pUser = pUsrFunc;
  }
 
#if (USBH_USE_OS == 1)
 
  /* Create USB Host Queue */
  osMessageQDef(USBH_Queue, 10, uint16_t);
  phost->os_event = osMessageCreate (osMessageQ(USBH_Queue), NULL);
 
  /*Create USB Host Task */
#if defined (USBH_PROCESS_STACK_SIZE)
  osThreadDef(USBH_Thread, USBH_Process_OS, USBH_PROCESS_PRIO, 0, USBH_PROCESS_STACK_SIZE);
#else
  osThreadDef(USBH_Thread, USBH_Process_OS, USBH_PROCESS_PRIO, 0, 8 * configMINIMAL_STACK_SIZE);
#endif
  phost->thread = osThreadCreate (osThread(USBH_Thread), phost);
#endif
 
  /* Initialize low level driver */
  USBH_LL_Init(phost);
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_DeInit()

USBH_StatusTypeDef USBH_DeInit

(

USBH_HandleTypeDef *

phost

)

HCD_Init De-Initialize the Host portion of the driver.

Parameters

phost

Host Handle

Return values

USBH

Status

{
  DeInitStateMachine(phost);
 
  if(phost->pData != NULL)
  {
    phost->pActiveClass->pData = NULL;
    USBH_LL_Stop(phost);
  }
 
  return USBH_OK;
}

Here is the call graph for this function:

USBH_RegisterClass()

USBH_StatusTypeDef USBH_RegisterClass	(	USBH_HandleTypeDef *	phost,
		USBH_ClassTypeDef *	pclass
	)

USBH_RegisterClass Link class driver to Host Core.

Parameters

phost	: Host Handle
pclass	Class handle

Return values

USBH

Status

{
  USBH_StatusTypeDef   status = USBH_OK;
 
  if(pclass != 0)
  {
    if(phost->ClassNumber < USBH_MAX_NUM_SUPPORTED_CLASS)
    {
      /* link the class to the USB Host handle */
      phost->pClass[phost->ClassNumber++] = pclass;
      status = USBH_OK;
    }
    else
    {
      USBH_ErrLog("Max Class Number reached");
      status = USBH_FAIL;
    }
  }
  else
  {
    USBH_ErrLog("Invalid Class handle");
    status = USBH_FAIL;
  }
 
  return status;
}

Here is the caller graph for this function:

USBH_SelectInterface()

USBH_StatusTypeDef USBH_SelectInterface	(	USBH_HandleTypeDef *	phost,
		uint8_t	interface
	)

USBH_SelectInterface Select current interface.

Parameters

phost	Host Handle
interface	Interface number

Return values

USBH

Status

{
  USBH_StatusTypeDef   status = USBH_OK;
 
  if(interface < phost->device.CfgDesc.bNumInterfaces)
  {
    phost->device.current_interface = interface;
    USBH_UsrLog ("Switching to Interface (#%d)", interface);
    USBH_UsrLog ("Class    : %xh", phost->device.CfgDesc.Itf_Desc[interface].bInterfaceClass );
    USBH_UsrLog ("SubClass : %xh", phost->device.CfgDesc.Itf_Desc[interface].bInterfaceSubClass );
    USBH_UsrLog ("Protocol : %xh", phost->device.CfgDesc.Itf_Desc[interface].bInterfaceProtocol );
  }
  else
  {
    USBH_ErrLog ("Cannot Select This Interface.");
    status = USBH_FAIL;
  }
  return status;
}

Here is the caller graph for this function:

USBH_FindInterface()

uint8_t USBH_FindInterface	(	USBH_HandleTypeDef *	phost,
		uint8_t	Class,
		uint8_t	SubClass,
		uint8_t	Protocol
	)

USBH_FindInterface Find the interface index for a specific class.

Parameters

phost	Host Handle
Class	Class code
SubClass	SubClass code
Protocol	Protocol code

Return values

interface

index in the configuration structure

Note

: (1)interface index 0xFF means interface index not found

{
  USBH_InterfaceDescTypeDef    *pif ;
  USBH_CfgDescTypeDef          *pcfg ;
  int8_t                        if_ix = 0;
 
  pif = (USBH_InterfaceDescTypeDef *)0;
  pcfg = &phost->device.CfgDesc;
 
  while (if_ix < USBH_MAX_NUM_INTERFACES)
  {
    pif = &pcfg->Itf_Desc[if_ix];
    if(((pif->bInterfaceClass == Class) || (Class == 0xFF))&&
       ((pif->bInterfaceSubClass == SubClass) || (SubClass == 0xFF))&&
         ((pif->bInterfaceProtocol == Protocol) || (Protocol == 0xFF)))
    {
      return  if_ix;
    }
    if_ix++;
  }
  return 0xFF;
}

Here is the caller graph for this function:

USBH_GetActiveClass()

uint8_t USBH_GetActiveClass

(

USBH_HandleTypeDef *

phost

)

USBH_GetActiveClass Return Device Class.

Parameters

phost	Host Handle
interface	Interface index

Return values

Class

Code

{
   return (phost->device.CfgDesc.Itf_Desc[0].bInterfaceClass);
}

USBH_FindInterfaceIndex()

uint8_t USBH_FindInterfaceIndex	(	USBH_HandleTypeDef *	phost,
		uint8_t	interface_number,
		uint8_t	alt_settings
	)

USBH_FindInterfaceIndex Find the interface index for a specific class interface and alternate setting number.

Parameters

phost	Host Handle
interface_number	interface number
alt_settings	: alternate setting number

Return values

interface

index in the configuration structure

Note

: (1)interface index 0xFF means interface index not found

{
  USBH_InterfaceDescTypeDef    *pif ;
  USBH_CfgDescTypeDef          *pcfg ;
  int8_t                        if_ix = 0;
 
  pif = (USBH_InterfaceDescTypeDef *)0;
  pcfg = &phost->device.CfgDesc;
 
  while (if_ix < USBH_MAX_NUM_INTERFACES)
  {
    pif = &pcfg->Itf_Desc[if_ix];
    if((pif->bInterfaceNumber == interface_number) && (pif->bAlternateSetting == alt_settings))
    {
      return  if_ix;
    }
    if_ix++;
  }
  return 0xFF;
}

USBH_Start()

USBH_StatusTypeDef USBH_Start

(

USBH_HandleTypeDef *

phost

)

USBH_Start Start the USB Host Core.

Parameters

phost

Host Handle

Return values

USBH

Status

{
  /* Start the low level driver  */
  USBH_LL_Start(phost);
 
  /* Activate VBUS on the port */
  USBH_LL_DriverVBUS (phost, TRUE);
 
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_Stop()

USBH_StatusTypeDef USBH_Stop

(

USBH_HandleTypeDef *

phost

)

USBH_Stop Stop the USB Host Core.

Parameters

phost

Host Handle

Return values

USBH

Status

{
  /* Stop and cleanup the low level driver  */
  USBH_LL_Stop(phost);
 
  /* DeActivate VBUS on the port */
  USBH_LL_DriverVBUS (phost, FALSE);
 
  /* FRee Control Pipes */
  USBH_FreePipe  (phost, phost->Control.pipe_in);
  USBH_FreePipe  (phost, phost->Control.pipe_out);
 
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_Process()

USBH_StatusTypeDef USBH_Process

(

USBH_HandleTypeDef *

phost

)

USBH_Process Background process of the USB Core.

Parameters

phost

Host Handle

Return values

USBH

Status

{
  __IO USBH_StatusTypeDef status = USBH_FAIL;
  uint8_t idx = 0;
 
  switch (phost->gState)
  {
  case HOST_IDLE :
 
    if (phost->device.is_connected)
    {
      /* Wait for 200 ms after connection */
      phost->gState = HOST_DEV_WAIT_FOR_ATTACHMENT;
      USBH_Delay(200);
      USBH_LL_ResetPort(phost);
#if (USBH_USE_OS == 1)
      osMessagePut ( phost->os_event, USBH_PORT_EVENT, 0);
#endif
    }
    break;
 
  case HOST_DEV_WAIT_FOR_ATTACHMENT:
    break;
 
  case HOST_DEV_ATTACHED :
 
    USBH_UsrLog("USB Device Attached");
 
    /* Wait for 100 ms after Reset */
    USBH_Delay(100);
 
    phost->device.speed = USBH_LL_GetSpeed(phost);
 
    phost->gState = HOST_ENUMERATION;
 
    phost->Control.pipe_out = USBH_AllocPipe (phost, 0x00);
    phost->Control.pipe_in  = USBH_AllocPipe (phost, 0x80);
 
 
    /* Open Control pipes */
    USBH_OpenPipe (phost,
                   phost->Control.pipe_in,
                   0x80,
                   phost->device.address,
                   phost->device.speed,
                   USBH_EP_CONTROL,
                   phost->Control.pipe_size);
 
    /* Open Control pipes */
    USBH_OpenPipe (phost,
                   phost->Control.pipe_out,
                   0x00,
                   phost->device.address,
                   phost->device.speed,
                   USBH_EP_CONTROL,
                   phost->Control.pipe_size);
 
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_PORT_EVENT, 0);
#endif
 
    break;
 
  case HOST_ENUMERATION:
    /* Check for enumeration status */
    if ( USBH_HandleEnum(phost) == USBH_OK)
    {
      /* The function shall return USBH_OK when full enumeration is complete */
      USBH_UsrLog ("Enumeration done.");
      phost->device.current_interface = 0;
      if(phost->device.DevDesc.bNumConfigurations == 1)
      {
        USBH_UsrLog ("This device has only 1 configuration.");
        phost->gState  = HOST_SET_CONFIGURATION;
 
      }
      else
      {
        phost->gState  = HOST_INPUT;
      }
 
    }
    break;
 
  case HOST_INPUT:
    {
      /* user callback for end of device basic enumeration */
      if(phost->pUser != NULL)
      {
        phost->pUser(phost, HOST_USER_SELECT_CONFIGURATION);
        phost->gState = HOST_SET_CONFIGURATION;
 
#if (USBH_USE_OS == 1)
        osMessagePut ( phost->os_event, USBH_STATE_CHANGED_EVENT, 0);
#endif
      }
    }
    break;
 
  case HOST_SET_CONFIGURATION:
    /* set configuration */
    if (USBH_SetCfg(phost, phost->device.CfgDesc.bConfigurationValue) == USBH_OK)
    {
      phost->gState  = HOST_CHECK_CLASS;
      USBH_UsrLog ("Default configuration set.");
 
    }
 
    break;
 
  case HOST_CHECK_CLASS:
 
    if(phost->ClassNumber == 0)
    {
      USBH_UsrLog ("No Class has been registered.");
    }
    else
    {
      phost->pActiveClass = NULL;
 
      for (idx = 0; idx < USBH_MAX_NUM_SUPPORTED_CLASS ; idx ++)
      {
        if(phost->pClass[idx]->ClassCode == phost->device.CfgDesc.Itf_Desc[0].bInterfaceClass)
        {
          phost->pActiveClass = phost->pClass[idx];
        }
      }
 
      if(phost->pActiveClass != NULL)
      {
        if(phost->pActiveClass->Init(phost)== USBH_OK)
        {
          phost->gState  = HOST_CLASS_REQUEST;
          USBH_UsrLog ("%s class started.", phost->pActiveClass->Name);
 
          /* Inform user that a class has been activated */
          phost->pUser(phost, HOST_USER_CLASS_SELECTED);
        }
        else
        {
          phost->gState  = HOST_ABORT_STATE;
          USBH_UsrLog ("Device not supporting %s class.", phost->pActiveClass->Name);
        }
      }
      else
      {
        phost->gState  = HOST_ABORT_STATE;
        USBH_UsrLog ("No registered class for this device.");
      }
    }
 
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_STATE_CHANGED_EVENT, 0);
#endif
    break;
 
  case HOST_CLASS_REQUEST:
    /* process class standard control requests state machine */
    if(phost->pActiveClass != NULL)
    {
      status = phost->pActiveClass->Requests(phost);
 
      if(status == USBH_OK)
      {
        phost->gState  = HOST_CLASS;
      }
    }
    else
    {
      phost->gState  = HOST_ABORT_STATE;
      USBH_ErrLog ("Invalid Class Driver.");
 
#if (USBH_USE_OS == 1)
    osMessagePut ( phost->os_event, USBH_STATE_CHANGED_EVENT, 0);
#endif
    }
 
    break;
  case HOST_CLASS:
    /* process class state machine */
    if(phost->pActiveClass != NULL)
    {
      phost->pActiveClass->BgndProcess(phost);
    }
    break;
 
  case HOST_DEV_DISCONNECTED :
 
    DeInitStateMachine(phost);
 
    /* Re-Initilaize Host for new Enumeration */
    if(phost->pActiveClass != NULL)
    {
      phost->pActiveClass->DeInit(phost);
      phost->pActiveClass = NULL;
    }
    break;
 
  case HOST_ABORT_STATE:
  default :
    break;
  }
 return USBH_OK;
}

Here is the call graph for this function:

USBH_ReEnumerate()

USBH_StatusTypeDef USBH_ReEnumerate

(

USBH_HandleTypeDef *

phost

)

HCD_ReEnumerate Perform a new Enumeration phase.

Parameters

phost

Host Handle

Return values

USBH

Status

{
  /*Stop Host */
  USBH_Stop(phost);
 
  /*Device has disconnected, so wait for 200 ms */
  USBH_Delay(200);
 
  /* Set State machines in default state */
  DeInitStateMachine(phost);
 
  /* Start again the host */
  USBH_Start(phost);
 
#if (USBH_USE_OS == 1)
      osMessagePut ( phost->os_event, USBH_PORT_EVENT, 0);
#endif
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_Init()

USBH_StatusTypeDef USBH_LL_Init

(

USBH_HandleTypeDef *

phost

)

Initialize the low level portion of the host driver.

Parameters

phost

Host handle

Return values

USBH

status

                                                           {
    /* Init USB_IP */
    if (phost->id == HOST_HS) {
        /* Link the driver to the stack. */
        hhcd_USB_OTG_HS.pData = phost;
        phost->pData = &hhcd_USB_OTG_HS;
 
        hhcd_USB_OTG_HS.Instance = USB_OTG_HS;
        hhcd_USB_OTG_HS.Init.Host_channels = 12;
        hhcd_USB_OTG_HS.Init.speed = HCD_SPEED_FULL;
        hhcd_USB_OTG_HS.Init.dma_enable = DISABLE;
        hhcd_USB_OTG_HS.Init.phy_itface = USB_OTG_EMBEDDED_PHY;
        hhcd_USB_OTG_HS.Init.Sof_enable = DISABLE;
        hhcd_USB_OTG_HS.Init.low_power_enable = DISABLE;
        hhcd_USB_OTG_HS.Init.vbus_sensing_enable = DISABLE;
        hhcd_USB_OTG_HS.Init.use_external_vbus = DISABLE;
        if (HAL_HCD_Init(&hhcd_USB_OTG_HS) != HAL_OK) {
            Error_Handler();
        }
 
        USBH_LL_SetTimer(phost, HAL_HCD_GetCurrentFrame(&hhcd_USB_OTG_HS));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_DeInit()

USBH_StatusTypeDef USBH_LL_DeInit

(

USBH_HandleTypeDef *

phost

)

De-Initialize the low level portion of the host driver.

Parameters

phost

Host handle

Return values

USBH

status

                                                             {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_DeInit(phost->pData);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

USBH_LL_Start()

USBH_StatusTypeDef USBH_LL_Start

(

USBH_HandleTypeDef *

phost

)

Start the low level portion of the host driver.

Parameters

phost

Host handle

Return values

USBH

status

                                                            {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_Start(phost->pData);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_Stop()

USBH_StatusTypeDef USBH_LL_Stop

(

USBH_HandleTypeDef *

phost

)

Stop the low level portion of the host driver.

Parameters

phost

Host handle

Return values

USBH

status

                                                           {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_Stop(phost->pData);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_Connect()

USBH_StatusTypeDef USBH_LL_Connect

(

USBH_HandleTypeDef *

phost

)

USBH_LL_Connect Handle USB Host connexion event.

Parameters

phost

Host Handle

Return values

USBH_Status

{
  if(phost->gState == HOST_IDLE )
  {
    phost->device.is_connected = 1;
 
    if(phost->pUser != NULL)
    {
      phost->pUser(phost, HOST_USER_CONNECTION);
    }
  }
  else if(phost->gState == HOST_DEV_WAIT_FOR_ATTACHMENT )
  {
    phost->gState = HOST_DEV_ATTACHED ;
  }
#if (USBH_USE_OS == 1)
  osMessagePut ( phost->os_event, USBH_PORT_EVENT, 0);
#endif
 
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_Disconnect()

USBH_StatusTypeDef USBH_LL_Disconnect

(

USBH_HandleTypeDef *

phost

)

USBH_LL_Disconnect Handle USB Host disconnection event.

Parameters

phost

Host Handle

Return values

USBH_Status

{
  /*Stop Host */
  USBH_LL_Stop(phost);
 
  /* FRee Control Pipes */
  USBH_FreePipe  (phost, phost->Control.pipe_in);
  USBH_FreePipe  (phost, phost->Control.pipe_out);
 
  phost->device.is_connected = 0;
 
  if(phost->pUser != NULL)
  {
    phost->pUser(phost, HOST_USER_DISCONNECTION);
  }
  USBH_UsrLog("USB Device disconnected");
 
  /* Start the low level driver  */
  USBH_LL_Start(phost);
 
  phost->gState = HOST_DEV_DISCONNECTED;
 
#if (USBH_USE_OS == 1)
  osMessagePut ( phost->os_event, USBH_PORT_EVENT, 0);
#endif
 
  return USBH_OK;
}

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_GetSpeed()

USBH_SpeedTypeDef USBH_LL_GetSpeed

(

USBH_HandleTypeDef *

phost

)

Return the USB host speed from the low level driver.

Parameters

phost

Host handle

Return values

USBH

speeds

                                                              {
    USBH_SpeedTypeDef speed = USBH_SPEED_FULL;
 
    switch (HAL_HCD_GetCurrentSpeed(phost->pData)) {
    case 0:
        speed = USBH_SPEED_HIGH;
        break;
 
    case 1:
        speed = USBH_SPEED_FULL;
        break;
 
    case 2:
        speed = USBH_SPEED_LOW;
        break;
 
    default:
        speed = USBH_SPEED_FULL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_ResetPort()

USBH_StatusTypeDef USBH_LL_ResetPort

(

USBH_HandleTypeDef *

phost

)

Reset the Host port of the low level driver.

Parameters

phost

Host handle

Return values

USBH

status

                                                                {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_ResetPort(phost->pData);
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_GetLastXferSize()

uint32_t USBH_LL_GetLastXferSize	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe
	)

Return the last transfered packet size.

Parameters

phost	Host handle
pipe	Pipe index

Return values

Packet

size

                                                                          {

Here is the caller graph for this function:

USBH_LL_DriverVBUS()

USBH_StatusTypeDef USBH_LL_DriverVBUS	(	USBH_HandleTypeDef *	phost,
		uint8_t	state
	)

Drive VBUS.

Parameters

phost	Host handle
state	: VBUS state This parameter can be one of the these values: 0 : VBUS Active 1 : VBUS Inactive

Return values

Status

                                                                                {
 
    /* USER CODE BEGIN 0 */
 
    /* USER CODE END 0*/
 
    if (phost->id == HOST_HS) {
        if (state == 0) {
            /* Drive high Charge pump */
            /* ToDo: Add IOE driver control */
            /* USER CODE BEGIN DRIVE_HIGH_CHARGE_FOR_HS */
 
            /* USER CODE END DRIVE_HIGH_CHARGE_FOR_HS */
        } else {
            /* Drive low Charge pump */
            /* ToDo: Add IOE driver control */
            /* USER CODE BEGIN DRIVE_LOW_CHARGE_FOR_HS */
 
            /* USER CODE END DRIVE_LOW_CHARGE_FOR_HS */
        }
    }
    HAL_Delay(200);

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_OpenPipe()

USBH_StatusTypeDef USBH_LL_OpenPipe	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe_num,
		uint8_t	epnum,
		uint8_t	dev_address,
		uint8_t	speed,
		uint8_t	ep_type,
		uint16_t	mps
	)

Open a pipe of the low level driver.

Parameters

phost	Host handle
pipe_num	Pipe index
epnum	Endpoint number
dev_address	Device USB address
speed	Device Speed
ep_type	Endpoint type
mps	Endpoint max packet size

Return values

USBH

status

                                                                       {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_HC_Init(phost->pData, pipe_num, epnum,
        dev_address, speed, ep_type, mps);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_ClosePipe()

USBH_StatusTypeDef USBH_LL_ClosePipe	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe
	)

Close a pipe of the low level driver.

Parameters

phost	Host handle
pipe	Pipe index

Return values

USBH

status

                                                                              {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_HC_Halt(phost->pData, pipe);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_SubmitURB()

USBH_StatusTypeDef USBH_LL_SubmitURB	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe,
		uint8_t	direction,
		uint8_t	ep_type,
		uint8_t	token,
		uint8_t *	pbuff,
		uint16_t	length,
		uint8_t	do_ping
	)

Submit a new URB to the low level driver.

Parameters

phost	Host handle
pipe	Pipe index This parameter can be a value from 1 to 15
direction	: Channel number This parameter can be one of the these values: 0 : Output 1 : Input
ep_type	: Endpoint Type This parameter can be one of the these values: EP_TYPE_CTRL: Control type EP_TYPE_ISOC: Isochrounous type EP_TYPE_BULK: Bulk type EP_TYPE_INTR: Interrupt type
token	: Endpoint Type This parameter can be one of the these values: 0: PID_SETUP 1: PID_DATA
pbuff	: pointer to URB data
length	: Length of URB data
do_ping	: activate do ping protocol (for high speed only) This parameter can be one of the these values: 0 : do ping inactive 1 : do ping active

Return values

Status

                     {
    HAL_StatusTypeDef hal_status = HAL_OK;
    USBH_StatusTypeDef usb_status = USBH_OK;
 
    hal_status = HAL_HCD_HC_SubmitRequest(phost->pData, pipe, direction,
        ep_type, token, pbuff, length,
        do_ping);
 
    switch (hal_status) {
    case HAL_OK:
        usb_status = USBH_OK;
        break;
    case HAL_ERROR:
        usb_status = USBH_FAIL;
        break;
    case HAL_BUSY:
        usb_status = USBH_BUSY;
        break;
    case HAL_TIMEOUT:
        usb_status = USBH_FAIL;
        break;
    default:
        usb_status = USBH_FAIL;
        break;
    }

Here is the caller graph for this function:

USBH_LL_GetURBState()

USBH_URBStateTypeDef USBH_LL_GetURBState	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe
	)

Get a URB state from the low level driver.

Parameters

phost	Host handle
pipe	Pipe index This parameter can be a value from 1 to 15

Return values

URB	state This parameter can be one of the these values: URB_IDLE URB_DONE URB_NOTREADY URB_NYET URB_ERROR URB_STALL

                                                                                  {

Here is the caller graph for this function:

USBH_LL_SetToggle()

USBH_StatusTypeDef USBH_LL_SetToggle	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe,
		uint8_t	toggle
	)

Set toggle for a pipe.

Parameters

phost	Host handle
pipe	Pipe index
toggle	toggle (0/1)

Return values

Status

                                                                                              {
    HCD_HandleTypeDef *pHandle;
    pHandle = phost->pData;
 
    if (pHandle->hc[pipe].ep_is_in) {
        pHandle->hc[pipe].toggle_in = toggle;
    } else {
        pHandle->hc[pipe].toggle_out = toggle;
    }
 

Here is the caller graph for this function:

USBH_LL_GetToggle()

uint8_t USBH_LL_GetToggle	(	USBH_HandleTypeDef *	phost,
		uint8_t	pipe
	)

Return the current toggle of a pipe.

Parameters

phost	Host handle
pipe	Pipe index

Return values

toggle

(0/1)

                                                                   {
    uint8_t toggle = 0;
    HCD_HandleTypeDef *pHandle;
    pHandle = phost->pData;
 
    if (pHandle->hc[pipe].ep_is_in) {
        toggle = pHandle->hc[pipe].toggle_in;
    } else {
        toggle = pHandle->hc[pipe].toggle_out;
    }

Here is the caller graph for this function:

USBH_Delay()

void USBH_Delay

(

uint32_t

Delay

)

Delay routine for the USB Host Library.

Parameters

Delay

Delay in ms

Return values

None

                                {

Here is the call graph for this function:

Here is the caller graph for this function:

USBH_LL_SetTimer()

void USBH_LL_SetTimer	(	USBH_HandleTypeDef *	phost,
		uint32_t	time
	)

USBH_LL_SetTimer Set the initial Host Timer tick.

Parameters

phost

Host Handle

Return values

None

{
  phost->Timer = time;
}

Here is the caller graph for this function:

USBH_LL_IncTimer()

void USBH_LL_IncTimer

(

USBH_HandleTypeDef *

phost

)

USBH_LL_IncTimer Increment Host Timer tick.

Parameters

phost

Host Handle

Return values

None

{
  phost->Timer ++;
  USBH_HandleSof(phost);
}

Here is the call graph for this function:

Here is the caller graph for this function: