USB Host HUB API#

• USBH_HUB_TaskPrioSet()

• USBH_HUB_PortSuspendReq()

• USBH_HUB_PortResumeReq()

• USBH_HUB_PortResetReq()

• USBH_HUB_PortDisconnReq()

USBH_HUB_TaskPrioSet()#

Description#

Assigns a new priority to the USB host HUB task.

Files#

usbh_core_hub.h/usbh_core_hub.c

Prototype#

void  USBH_HUB_TaskPrioSet(CPU_INT08U   prio,
                           RTOS_ERR    *p_err)

Arguments#

prio

New priority of the the hub task.

p_err

Pointer to the variable that will receive one of the following error code(s) from this function:

• RTOS_ERR_NONE

• RTOS_ERR_INVALID_ARG

Returned Value#

None.

Notes / Warnings#

1. This function cannot be called before the USB Host module has been initialized via the USBH_Init() function.

USBH_HUB_PortSuspendReq()#

Description#

Requests a suspend on the specified port and hub.

Files#

usbh_core_hub.h/usbh_core_hub.c

Prototype#

void USBH_HUB_PortSuspendReq (USBH_DEV_HANDLE       hub_dev_handle,
                               CPU_INT08U            port_nbr,
                               USBH_PORT_REQ_CMPL    cmpl_callback,
                               void                 *p_arg,
                               RTOS_ERR             *p_err)

Arguments#

hub_dev_handle

Handle on the hub device.

port_nbr

Port number, can be USBH_HUB_PORT_ALL.

cmpl_callback

Callback to notify caller that the operation is complete. Can be DEF_NULL.

p_arg

Argument that will be passed to callback.

p_err

Pointer to the variable that will receive one of these return error codes from this function :

• RTOS_ERR_NONE

• RTOS_ERR_ALLOC

• RTOS_ERR_WOULD_OVF

• RTOS_ERR_NOT_AVAIL

Returned Value#

None.

Notes / Warnings#

None.

USBH_HUB_PortResumeReq()#

Description#

Request resume on the specified port and hub.

Files#

usbh_core_hub.h/usbh_core_hub.c

Prototype#

void USBH_HUB_PortResumeReq (USBH_DEV_HANDLE      hub_dev_handle,
                             CPU_INT08U           port_nbr,
                             USBH_PORT_REQ_CMPL   cmpl_callback,
                              void                *p_arg,
                              RTOS_ERR            *p_err)

Arguments#

hub_dev_handle

Handle on the hub device.

port_nbr

Port number, can be USBH_HUB_PORT_ALL.

cmpl_callback

Callback to notify caller that the operation is complete. Can be DEF_NULL.

p_arg

Argument that will be passed to the callback.

p_err

Pointer to the variable that will receive one of these return error codes from this function :

• RTOS_ERR_NONE

• RTOS_ERR_ALLOC

• RTOS_ERR_WOULD_OVF

• RTOS_ERR_NOT_AVAIL

Returned Value#

None.

Notes / Warnings#

None.

USBH_HUB_PortResetReq()#

Description#

Requests the reset on specified port and hub.

Files#

usbh_core_hub.h/usbh_core_hub.c

Prototype#

void USBH_HUB_PortResetReq (USBH_DEV_HANDLE        hub_dev_handle,
                            CPU_INT08U             port_nbr,
                            USBH_PORT_REQ_CMPL     cmpl_callback,
                            void                  *p_arg,
                            RTOS_ERR              *p_err)

Arguments#

hub_dev_handle

Handle on the hub device.

port_nbr

Port number, can be USBH_HUB_PORT_ALL.

cmpl_callback

Callback to notify the caller that the operation is complete. Can be DEF_NULL.

p_arg

Argument that will be passed to the callback.

p_err

Pointer to the variable that will receive one of these return error codes from this function :

• RTOS_ERR_NONE

• RTOS_ERR_ALLOC

• RTOS_ERR_WOULD_OVF

• RTOS_ERR_NOT_AVAIL

Returned Value#

None.

Notes / Warnings#

None.

USBH_HUB_PortDisconnReq()#

Description#

Request a disconnect on the specified port and hub.

Files#

usbh_core_hub.h/usbh_core_hub.c

Prototype#

void USBH_HUB_PortDisconnReq (USBH_DEV_HANDLE      hub_dev_handle,
                                CPU_INT08U         port_nbr,
                                USBH_PORT_REQ_CMPL cmpl_callback,
                                void               *p_arg,
                                RTOS_ERR           *p_err)

Arguments#

hub_dev_handle

Handle on the hub device.

port_nbr

Port number, can be USBH_HUB_PORT_ALL.

cmpl_callback

Callback to notify the caller that the operation is complete. Can be DEF_NULL.

p_arg

Argument that will be passed to the callback.

p_err

Pointer to the variable that will receive one of these return error codes from this function :

• RTOS_ERR_NONE

• RTOS_ERR_ALLOC

• RTOS_ERR_WOULD_OVF

• RTOS_ERR_NOT_AVAIL

Returned Value#

None.

Notes / Warnings#

None.