Jump to main content

##

# 3.2.4.8 USB_HOST_BusSuspend Function

## C

    USB_HOST_RESULT USB_HOST_BusSuspend(
        USB_HOST_BUS bus
    );

## Summary

The function suspends the bus. All devices on the bus will be suspended. If bus is specified as USB_HOST_BUS_ALL, all the buses managed by this host will be suspended.

## Precondition

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

## Parameters

Parameters | Description
bus | The bus to be suspended or USB_HOST_BUS_ALL to suspend all buses.

## Returns

USB_HOST_RESULT_SUCCESS - if the request was successful.

USB_HOST_RESULT_BUS_NOT_ENABLED - if the bus was not enabled.

USB_HOST_RESULT_FAILURE - An unknown error has occurred.

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

## Example

    // Suspend the bus 0
    USB_HOST_BusSuspend(0);

    // Suspend all buses
    USB_HOST_BusSuspend(USB_HOST_BUS_ALL);

## Remarks

None.