Jump to main content

##

# 3.2.4.6 USB_HOST_BusIsSuspended Function

## C

    USB_HOST_RESULT USB_HOST_BusIsSuspended(
        USB_HOST_BUS bus
    );

## Summary

This function returns suspend status of the specified USB bus. This function can be used to check the completion of the Suspend operation started by using the USB_HOST_BusSuspend() function. The function would return USB_HOST_RESULT_FALSE if the bus is not suspended. Calling the USB_HOST_BusIsSuspended() with bus specified as USB_HOST_BUS_ALL returns the suspend status of the all USB segments that are managed by the host layer. The function would return USB_HOST_RESULT_TRUE only if all the bus are in a suspended state.

## Precondition

The USB_HOST_BusEnable() function should have been called to enable the bus.

## Parameters

Parameters | Description
bus | The bus whose suspend status is to be queried.

## Returns

USB_HOST_RESULT_TRUE - if the bus is suspended.

USB_HOST_RESULT_FALSE - if the bus is not suspended.

USB_HOST_RESULT_BUS_NOT_ENABLED - if the bus was not enabled.

USB_HOST_RESULT_BUS_UNKNOWN - if the specified bus does not exist in the system.

USB_HOST_RESULT_FAILURE - an unknown error occurred.

## Remarks

None.