eth/doxygen/usbh__core_8h_source.html

 /* Define to prevent recursive  ----------------------------------------------*/
 #ifndef __USBH_CORE_H
 #define __USBH_CORE_H

 #ifdef __cplusplus
  extern "C" {
 #endif

 /* Includes ------------------------------------------------------------------*/
 #include "usbh_conf.h"
 #include "usbh_def.h"
 #include "usbh_ioreq.h"
 #include "usbh_pipes.h"
 #include "usbh_ctlreq.h"

 #define HOST_USER_SELECT_CONFIGURATION          1
 #define HOST_USER_CLASS_ACTIVE                  2
 #define HOST_USER_CLASS_SELECTED                3
 #define HOST_USER_CONNECTION                    4
 #define HOST_USER_DISCONNECTION                 5
 #define HOST_USER_UNRECOVERED_ERROR             6


 USBH_StatusTypeDef  USBH_Init(USBH_HandleTypeDef *phost, void (*pUsrFunc)(USBH_HandleTypeDef *phost, uint8_t ), uint8_t id);
 USBH_StatusTypeDef  USBH_DeInit(USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef  USBH_RegisterClass(USBH_HandleTypeDef *phost, USBH_ClassTypeDef *pclass);
 USBH_StatusTypeDef  USBH_SelectInterface(USBH_HandleTypeDef *phost, uint8_t interface);
 uint8_t             USBH_FindInterface(USBH_HandleTypeDef *phost,
                                             uint8_t Class,
                                             uint8_t SubClass,
                                             uint8_t Protocol);
 uint8_t             USBH_GetActiveClass(USBH_HandleTypeDef *phost);

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

 USBH_StatusTypeDef  USBH_Start            (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef  USBH_Stop             (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef  USBH_Process          (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef  USBH_ReEnumerate      (USBH_HandleTypeDef *phost);

 /* USBH Low Level Driver */
 USBH_StatusTypeDef   USBH_LL_Init         (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef   USBH_LL_DeInit       (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef   USBH_LL_Start        (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef   USBH_LL_Stop         (USBH_HandleTypeDef *phost);

 USBH_StatusTypeDef   USBH_LL_Connect      (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef   USBH_LL_Disconnect   (USBH_HandleTypeDef *phost);
 USBH_SpeedTypeDef    USBH_LL_GetSpeed     (USBH_HandleTypeDef *phost);
 USBH_StatusTypeDef   USBH_LL_ResetPort    (USBH_HandleTypeDef *phost);
 uint32_t             USBH_LL_GetLastXferSize   (USBH_HandleTypeDef *phost, uint8_t );
 USBH_StatusTypeDef   USBH_LL_DriverVBUS   (USBH_HandleTypeDef *phost, uint8_t );

 USBH_StatusTypeDef   USBH_LL_OpenPipe     (USBH_HandleTypeDef *phost, uint8_t, uint8_t, uint8_t, uint8_t , uint8_t, uint16_t );
 USBH_StatusTypeDef   USBH_LL_ClosePipe    (USBH_HandleTypeDef *phost, uint8_t );
 USBH_StatusTypeDef   USBH_LL_SubmitURB    (USBH_HandleTypeDef *phost, uint8_t, uint8_t,uint8_t,  uint8_t, uint8_t*, uint16_t, uint8_t );
 USBH_URBStateTypeDef USBH_LL_GetURBState  (USBH_HandleTypeDef *phost, uint8_t );
 #if (USBH_USE_OS == 1)
 USBH_StatusTypeDef  USBH_LL_NotifyURBChange (USBH_HandleTypeDef *phost);
 #endif
 USBH_StatusTypeDef   USBH_LL_SetToggle    (USBH_HandleTypeDef *phost, uint8_t , uint8_t );
 uint8_t              USBH_LL_GetToggle    (USBH_HandleTypeDef *phost, uint8_t );

 /* USBH Time base */
 void                 USBH_Delay (uint32_t Delay);
 void                 USBH_LL_SetTimer     (USBH_HandleTypeDef *phost, uint32_t );
 void                 USBH_LL_IncTimer     (USBH_HandleTypeDef *phost);
 #ifdef __cplusplus
 }
 #endif

 #endif /* __USBH_CORE_H */

 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/


USBH_SelectInterface
USBH_StatusTypeDef USBH_SelectInterface(USBH_HandleTypeDef *phost, uint8_t interface)
USBH_SelectInterface Select current interface.
Definition: usbh_core.c:233

usbh_pipes.h
Header file for usbh_pipes.c.

USBH_ClassTypeDef
Definition: usbh_def.h:437

USBH_LL_Connect
USBH_StatusTypeDef USBH_LL_Connect(USBH_HandleTypeDef *phost)
USBH_LL_Connect Handle USB Host connexion event.
Definition: usbh_core.c:826

USBH_LL_ClosePipe
USBH_StatusTypeDef USBH_LL_ClosePipe(USBH_HandleTypeDef *phost, uint8_t)
USBH_LL_ClosePipe Close a pipe of the Low Level Driver.
Definition: usbh_conf_template.c:148

USBH_LL_DriverVBUS
USBH_StatusTypeDef USBH_LL_DriverVBUS(USBH_HandleTypeDef *phost, uint8_t)
USBH_LL_DriverVBUS Drive VBUS.
Definition: usbh_conf_template.c:226

USBH_Delay
void USBH_Delay(uint32_t Delay)
USBH_Delay Delay routine for the USB Host Library.
Definition: usbh_conf_template.c:267

usbh_ioreq.h
Header file for usbh_ioreq.c.

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.
Definition: usbh_core.c:274

USBH_LL_Init
USBH_StatusTypeDef USBH_LL_Init(USBH_HandleTypeDef *phost)
USBH_LL_Init Initialize the Low Level portion of the Host driver.
Definition: usbh_conf_template.c:37

USBH_LL_GetLastXferSize
uint32_t USBH_LL_GetLastXferSize(USBH_HandleTypeDef *phost, uint8_t)
USBH_LL_GetLastXferSize Return the last transferred packet size.
Definition: usbh_conf_template.c:112

USBH_LL_GetSpeed
USBH_SpeedTypeDef USBH_LL_GetSpeed(USBH_HandleTypeDef *phost)
USBH_LL_GetSpeed Return the USB Host Speed from the Low Level Driver.
Definition: usbh_conf_template.c:85

USBH_LL_DeInit
USBH_StatusTypeDef USBH_LL_DeInit(USBH_HandleTypeDef *phost)
USBH_LL_DeInit De-Initialize the Low Level portion of the Host driver.
Definition: usbh_conf_template.c:49

USBH_LL_OpenPipe
USBH_StatusTypeDef USBH_LL_OpenPipe(USBH_HandleTypeDef *phost, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint16_t)
USBH_LL_OpenPipe Open a pipe of the Low Level Driver.
Definition: usbh_conf_template.c:129

USBH_LL_GetToggle
uint8_t USBH_LL_GetToggle(USBH_HandleTypeDef *phost, uint8_t)
USBH_LL_GetToggle Return the current toggle of a pipe.
Definition: usbh_conf_template.c:254

USBH_LL_Stop
USBH_StatusTypeDef USBH_LL_Stop(USBH_HandleTypeDef *phost)
USBH_LL_Stop Stop the Low Level portion of the Host driver.
Definition: usbh_conf_template.c:73

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...
Definition: usbh_core.c:306

USBH_LL_SetTimer
void USBH_LL_SetTimer(USBH_HandleTypeDef *phost, uint32_t)
USBH_LL_SetTimer Set the initial Host Timer tick.
Definition: usbh_core.c:791

usbh_ctlreq.h
Header file for usbh_ctlreq.c.

USBH_Init
USBH_StatusTypeDef USBH_Init(USBH_HandleTypeDef *phost, void(*pUsrFunc)(USBH_HandleTypeDef *phost, uint8_t), uint8_t id)
HCD_Init Initialize the HOST Core.
Definition: usbh_core.c:92

USBH_LL_IncTimer
void USBH_LL_IncTimer(USBH_HandleTypeDef *phost)
USBH_LL_IncTimer Increment Host Timer tick.
Definition: usbh_core.c:801

USBH_Process
USBH_StatusTypeDef USBH_Process(USBH_HandleTypeDef *phost)
USBH_Process Background process of the USB Core.
Definition: usbh_core.c:397

USBH_URBStateTypeDef
USBH_URBStateTypeDef
Definition: usbh_def.h:384

_USBH_HandleTypeDef
Definition: usbh_def.h:450

USBH_LL_SetToggle
USBH_StatusTypeDef USBH_LL_SetToggle(USBH_HandleTypeDef *phost, uint8_t, uint8_t)
USBH_LL_SetToggle Set toggle for a pipe.
Definition: usbh_conf_template.c:241

USBH_RegisterClass
USBH_StatusTypeDef USBH_RegisterClass(USBH_HandleTypeDef *phost, USBH_ClassTypeDef *pclass)
USBH_RegisterClass Link class driver to Host Core.
Definition: usbh_core.c:199

USBH_LL_GetURBState
USBH_URBStateTypeDef USBH_LL_GetURBState(USBH_HandleTypeDef *phost, uint8_t)
USBH_LL_GetURBState Get a URB state from the low level driver.
Definition: usbh_conf_template.c:210

USBH_ReEnumerate
USBH_StatusTypeDef USBH_ReEnumerate(USBH_HandleTypeDef *phost)
HCD_ReEnumerate Perform a new Enumeration phase.
Definition: usbh_core.c:371

USBH_LL_SubmitURB
USBH_StatusTypeDef USBH_LL_SubmitURB(USBH_HandleTypeDef *phost, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t *, uint16_t, uint8_t)
USBH_LL_SubmitURB Submit a new URB to the low level driver.
Definition: usbh_conf_template.c:182

USBH_LL_ResetPort
USBH_StatusTypeDef USBH_LL_ResetPort(USBH_HandleTypeDef *phost)
USBH_LL_ResetPort Reset the Host Port of the Low Level Driver.
Definition: usbh_conf_template.c:99

USBH_StatusTypeDef
USBH_StatusTypeDef
Definition: usbh_def.h:302

USBH_Start
USBH_StatusTypeDef USBH_Start(USBH_HandleTypeDef *phost)
USBH_Start Start the USB Host Core.
Definition: usbh_core.c:333

USBH_GetActiveClass
uint8_t USBH_GetActiveClass(USBH_HandleTypeDef *phost)
USBH_GetActiveClass Return Device Class.
Definition: usbh_core.c:260

USBH_SpeedTypeDef
USBH_SpeedTypeDef
Definition: usbh_def.h:317

USBH_DeInit
USBH_StatusTypeDef USBH_DeInit(USBH_HandleTypeDef *phost)
HCD_Init De-Initialize the Host portion of the driver.
Definition: usbh_core.c:143

USBH_Stop
USBH_StatusTypeDef USBH_Stop(USBH_HandleTypeDef *phost)
USBH_Stop Stop the USB Host Core.
Definition: usbh_core.c:350

USBH_LL_Disconnect
USBH_StatusTypeDef USBH_LL_Disconnect(USBH_HandleTypeDef *phost)
USBH_LL_Disconnect Handle USB Host disconnection event.
Definition: usbh_core.c:854

usbh_def.h
Definitions used in the USB host library.

USBH_LL_Start
USBH_StatusTypeDef USBH_LL_Start(USBH_HandleTypeDef *phost)
USBH_LL_Start Start the Low Level portion of the Host driver.
Definition: usbh_conf_template.c:61