X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FUsbLib.h;fp=MdePkg%2FInclude%2FLibrary%2FUsbLib.h;h=4d81b35ee2ad2a702d58fa411323ff8fef5204ea;hb=2c8547ab2d20df0fe38974dfc7fb7cfca92ef8ea;hp=a77a855230e3d156a26d01c02507953b29b1e07a;hpb=c69a09d928ca6f3f2785424b5e4eb50ec4dceae3;p=mirror_edk2.git diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h index a77a855230..4d81b35ee2 100644 --- a/MdePkg/Include/Library/UsbLib.h +++ b/MdePkg/Include/Library/UsbLib.h @@ -1,7 +1,7 @@ /** @file - Common Dxe Libarary for USB + Common Dxe Libarary for USB. - Copyright (c) 2006, Intel Corporation
+ Copyright (c) 2006 - 2008, 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 which accompanies this distribution. The full text of the license may be found at @@ -24,10 +24,10 @@ #define TIMEOUT_VALUE 3 * 1000 /** - Get Hid Descriptor + Get Hid Descriptor. - @param UsbIo EFI_USB_IO_PROTOCOL - @param InterfaceNum Hid interface number + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param InterfaceNum Hid interface number. @param HidDescriptor Caller allocated buffer to store Usb hid descriptor if successfully returned. @@ -45,9 +45,9 @@ UsbGetHidDescriptor ( /** - get Report Class descriptor + get Report Class descriptor. - @param UsbIo EFI_USB_IO_PROTOCOL. + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param InterfaceNum Report interface number. @param DescriptorSize Length of DescriptorBuffer. @param DescriptorBuffer Caller allocated buffer to store Usb report descriptor @@ -67,10 +67,10 @@ UsbGetReportDescriptor ( ); /** - Get Hid Protocol Request + Get Hid Protocol Request. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Interface Which interface the caller wants to get protocol + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Interface Which interface the caller wants to get protocol. @param Protocol Protocol value returned. @return Status of getting Protocol Request through USB I/O @@ -86,10 +86,10 @@ UsbGetProtocolRequest ( ); /** - Set Hid Protocol Request + Set Hid Protocol Request. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Interface Which interface the caller wants to set protocol + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Interface Which interface the caller wants to set protocol. @param Protocol Protocol value the caller wants to set. @return Status of setting Protocol Request through USB I/O @@ -107,7 +107,7 @@ UsbSetProtocolRequest ( /** Set Idel request. - @param UsbIo EFI_USB_IO_PROTOCOL + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param Interface Which interface the caller wants to set. @param ReportId Which report the caller wants to set. @param Duration Idle rate the caller wants to set. @@ -128,7 +128,7 @@ UsbSetIdleRequest ( /** Get Idel request. - @param UsbIo EFI_USB_IO_PROTOCOL + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param Interface Which interface the caller wants to get. @param ReportId Which report the caller wants to get. @param Duration Idle rate the caller wants to get. @@ -149,7 +149,7 @@ UsbGetIdleRequest ( /** Hid Set Report request. - @param UsbIo EFI_USB_IO_PROTOCOL + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param Interface Which interface the caller wants to set. @param ReportId Which report the caller wants to set. @param ReportType Type of report. @@ -174,7 +174,7 @@ UsbSetReportRequest ( /** Hid Set Report request. - @param UsbIo EFI_USB_IO_PROTOCOL + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. @param Interface Which interface the caller wants to set. @param ReportId Which report the caller wants to set. @param ReportType Type of report. @@ -197,18 +197,18 @@ UsbGetReportRequest ( ); /** - Usb Get Descriptor + Usb Get Descriptor. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Value Device Request Value - @param Index Device Request Index - @param DescriptorLength Descriptor Length - @param Descriptor Descriptor buffer to contain result - @param Status Transfer Status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Value Device Request Value. + @param Index Device Request Index. + @param DescriptorLength Descriptor Length. + @param Descriptor Descriptor buffer to contain result. + @param Status Transfer Status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -223,18 +223,18 @@ UsbGetDescriptor ( ); /** - Usb Set Descriptor + Usb Set Descriptor. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Value Device Request Value - @param Index Device Request Index - @param DescriptorLength Descriptor Length - @param Descriptor Descriptor buffer to set - @param Status Transfer Status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Value Device Request Value. + @param Index Device Request Index. + @param DescriptorLength Descriptor Length. + @param Descriptor Descriptor buffer to set. + @param Status Transfer Status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -249,16 +249,16 @@ UsbSetDescriptor ( ); /** - Usb Get Device Interface + Usb Get Device Interface. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Index Interface index value - @param AltSetting Alternate setting - @param Status Trasnsfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Index Interface index value. + @param AltSetting Alternate setting. + @param Status Trasnsfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -271,16 +271,16 @@ UsbGetInterface ( ); /** - Usb Set Device Interface + Usb Set Device Interface. - @param UsbIo EFI_USB_IO_PROTOCOL - @param InterfaceNo Interface Number - @param AltSetting Alternate setting - @param Status Trasnsfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param InterfaceNo Interface Number. + @param AltSetting Alternate setting. + @param Status Trasnsfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -293,15 +293,15 @@ UsbSetInterface ( ); /** - Usb Get Device Configuration + Usb Get Device Configuration. - @param UsbIo EFI_USB_IO_PROTOCOL - @param ConfigValue Config Value - @param Status Transfer Status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param ConfigValue Config Value. + @param Status Transfer Status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -313,15 +313,15 @@ UsbGetConfiguration ( ); /** - Usb Set Device Configuration + Usb Set Device Configuration. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Value Configuration Value to set - @param Status Transfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Value Configuration Value to set. + @param Status Transfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -333,17 +333,17 @@ UsbSetConfiguration ( ); /** - Usb Set Device Feature + Usb Set Device Feature. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Recipient Interface/Device/Endpoint - @param Value Request value - @param Target Request Index - @param Status Transfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Recipient Interface/Device/Endpoint. + @param Value Request value. + @param Target Request Index. + @param Status Transfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -357,17 +357,17 @@ UsbSetFeature ( ); /** - Usb Clear Device Feature + Usb Clear Device Feature. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Recipient Interface/Device/Endpoint - @param Value Request value - @param Target Request Index - @param Status Transfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Recipient Interface/Device/Endpoint. + @param Value Request value. + @param Target Request Index. + @param Status Transfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -381,17 +381,17 @@ UsbClearFeature ( ); /** - Usb Get Device Status + Usb Get Device Status. - @param UsbIo EFI_USB_IO_PROTOCOL - @param Recipient Interface/Device/Endpoint - @param Target Request index - @param DevStatus Device status - @param Status Transfer status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param Recipient Interface/Device/Endpoint. + @param Target Request index. + @param DevStatus Device status. + @param Status Transfer status. - @retval EFI_INVALID_PARAMETER Parameter is error - @retval EFI_SUCCESS Success - @retval EFI_TIMEOUT Device has no response + @retval EFI_INVALID_PARAMETER Parameter is error. + @retval EFI_SUCCESS Success. + @retval EFI_TIMEOUT Device has no response. **/ EFI_STATUS @@ -405,15 +405,15 @@ UsbGetStatus ( ); /** - Clear endpoint stall + Clear endpoint stall. - @param UsbIo EFI_USB_IO_PROTOCOL - @param EndpointNo Endpoint Number - @param Status Transfer Status + @param UsbIo A pointer to EFI_USB_IO_PROTOCOL. + @param EndpointNo Endpoint Number. + @param Status Transfer Status. - @retval EFI_NOT_FOUND Can't find the Endpoint - @retval EFI_DEVICE_ERROR Hardware error - @retval EFI_SUCCESS Success + @retval EFI_NOT_FOUND Can't find the Endpoint. + @retval EFI_DEVICE_ERROR Hardware error. + @retval EFI_SUCCESS Success. **/ EFI_STATUS