modify coding style to pass ecc tool and provide comments that complied with Doxgen.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5436 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -1,5 +1,7 @@
|
||||
/** @file
|
||||
|
||||
USB bus enumeration interface.
|
||||
|
||||
Copyright (c) 2007, Intel Corporation
|
||||
All rights reserved. This program and the accompanying materials
|
||||
are licensed and made available under the terms and conditions of the BSD License
|
||||
@@ -9,17 +11,6 @@ http://opensource.org/licenses/bsd-license.php
|
||||
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
|
||||
Module Name:
|
||||
|
||||
UsbEnumer.h
|
||||
|
||||
Abstract:
|
||||
|
||||
USB bus enumeration interface
|
||||
|
||||
Revision History
|
||||
|
||||
|
||||
**/
|
||||
|
||||
#ifndef _USB_ENUMERATION_H_
|
||||
@@ -110,35 +101,93 @@ struct _USB_HUB_API{
|
||||
USB_HUB_RELEASE Release;
|
||||
};
|
||||
|
||||
/**
|
||||
Return the endpoint descriptor in this interface.
|
||||
|
||||
@param UsbIf The interface to search in.
|
||||
@param EpAddr The address of the endpoint to return.
|
||||
|
||||
@return The endpoint descriptor or NULL.
|
||||
|
||||
**/
|
||||
USB_ENDPOINT_DESC*
|
||||
UsbGetEndpointDesc (
|
||||
IN USB_INTERFACE *UsbIf,
|
||||
IN UINT8 EpAddr
|
||||
);
|
||||
|
||||
/**
|
||||
Select an alternate setting for the interface.
|
||||
Each interface can have several mutually exclusive
|
||||
settings. Only one setting is active. It will
|
||||
also reset its endpoints' toggle to zero.
|
||||
|
||||
@param IfDesc The interface descriptor to set.
|
||||
@param Alternate The alternate setting number to locate.
|
||||
|
||||
@retval EFI_NOT_FOUND There is no setting with this alternate index.
|
||||
@retval EFI_SUCCESS The interface is set to Alternate setting.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
UsbSelectSetting (
|
||||
IN USB_INTERFACE_DESC *IfDesc,
|
||||
IN UINT8 Alternate
|
||||
);
|
||||
|
||||
/**
|
||||
Select a new configuration for the device. Each
|
||||
device may support several configurations.
|
||||
|
||||
@param Device The device to select configuration.
|
||||
@param ConfigIndex The index of the configuration ( != 0).
|
||||
|
||||
@retval EFI_NOT_FOUND There is no configuration with the index.
|
||||
@retval EFI_OUT_OF_RESOURCES Failed to allocate resource.
|
||||
@retval EFI_SUCCESS The configuration is selected.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
UsbSelectConfig (
|
||||
IN USB_DEVICE *Device,
|
||||
IN UINT8 ConfigIndex
|
||||
);
|
||||
|
||||
/**
|
||||
Remove the current device configuration.
|
||||
|
||||
@param Device The USB device to remove configuration from.
|
||||
|
||||
@return None.
|
||||
|
||||
**/
|
||||
VOID
|
||||
UsbRemoveConfig (
|
||||
IN USB_DEVICE *Device
|
||||
);
|
||||
|
||||
/**
|
||||
Remove the device and all its children from the bus.
|
||||
|
||||
@param Device The device to remove.
|
||||
|
||||
@retval EFI_SUCCESS The device is removed.
|
||||
|
||||
**/
|
||||
EFI_STATUS
|
||||
UsbRemoveDevice (
|
||||
IN USB_DEVICE *Device
|
||||
);
|
||||
|
||||
/**
|
||||
Enumerate all the changed hub ports.
|
||||
|
||||
@param Event The event that is triggered.
|
||||
@param Context The context to the event.
|
||||
|
||||
@return None.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
UsbHubEnumeration (
|
||||
@@ -146,6 +195,15 @@ UsbHubEnumeration (
|
||||
IN VOID *Context
|
||||
);
|
||||
|
||||
/**
|
||||
Enumerate all the changed hub ports.
|
||||
|
||||
@param Event The event that is triggered.
|
||||
@param Context The context to the event.
|
||||
|
||||
@return None.
|
||||
|
||||
**/
|
||||
VOID
|
||||
EFIAPI
|
||||
UsbRootHubEnumeration (
|
||||
|
Reference in New Issue
Block a user