mice and mass storage devices. In particular, functions for managing devices \r
on USB buses are defined here.\r
\r
- Copyright (c) 2006 - 2008, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
typedef USB_INTERFACE_DESCRIPTOR EFI_USB_INTERFACE_DESCRIPTOR;\r
typedef USB_ENDPOINT_DESCRIPTOR EFI_USB_ENDPOINT_DESCRIPTOR;\r
\r
-//\r
-// USB data transfer direction\r
-//\r
+///\r
+/// USB data transfer direction\r
+///\r
typedef enum {\r
EfiUsbDataIn,\r
EfiUsbDataOut,\r
otherwise EFI_INVALID_PARAMETER is returned. If \r
the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER \r
is returned. The MSB of this parameter indicates \r
- the endpoint direction. The number “1” stands for \r
- an IN endpoint, and “0” stands for an OUT endpoint.\r
+ the endpoint direction. The number "1" stands for \r
+ an IN endpoint, and "0" stands for an OUT endpoint.\r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
device or received from USB device.\r
@param DataLength The size, in bytes, of the data buffer specified by Data.\r
otherwise EFI_INVALID_PARAMETER is returned. If \r
the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER \r
is returned. The MSB of this parameter indicates \r
- the endpoint direction. The number “1” stands for \r
- an IN endpoint, and “0” stands for an OUT endpoint.\r
+ the endpoint direction. The number "1" stands for \r
+ an IN endpoint, and "0" stands for an OUT endpoint.\r
@param IsNewTransfer If TRUE, a new transfer will be submitted to USB controller. If\r
FALSE, the interrupt transfer is deleted from the device's interrupt\r
transfer queue.\r
otherwise EFI_INVALID_PARAMETER is returned. If \r
the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER \r
is returned. The MSB of this parameter indicates \r
- the endpoint direction. The number “1” stands for \r
- an IN endpoint, and “0” stands for an OUT endpoint.\r
+ the endpoint direction. The number "1" stands for \r
+ an IN endpoint, and "0" stands for an OUT endpoint.\r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
device or received from USB device.\r
@param DataLength On input, then size, in bytes, of the buffer Data. On output, the\r
otherwise EFI_INVALID_PARAMETER is returned. If \r
the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER \r
is returned. The MSB of this parameter indicates \r
- the endpoint direction. The number “1” stands for \r
- an IN endpoint, and “0” stands for an OUT endpoint.\r
+ the endpoint direction. The number "1" stands for \r
+ an IN endpoint, and "0" stands for an OUT endpoint.\r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
device or received from USB device.\r
@param DataLength The size, in bytes, of the data buffer specified by Data.\r
otherwise EFI_INVALID_PARAMETER is returned. If \r
the endpoint is not a BULK endpoint, EFI_INVALID_PARAMETER \r
is returned. The MSB of this parameter indicates \r
- the endpoint direction. The number “1” stands for \r
- an IN endpoint, and “0” stands for an OUT endpoint.\r
+ the endpoint direction. The number "1" stands for \r
+ an IN endpoint, and "0" stands for an OUT endpoint.\r
@param Data A pointer to the buffer of data that will be transmitted to USB\r
device or received from USB device.\r
@param DataLength The size, in bytes, of the data buffer specified by Data.\r
);\r
\r
/**\r
- Retrieves a Unicode string stored in a USB Device.\r
+ Retrieves a string stored in a USB Device.\r
\r
@param This A pointer to the EFI_USB_IO_PROTOCOL instance.\r
@param LangID The Language ID for the string being retrieved.\r
OUT UINT16 *TableSize\r
);\r
\r
-/** \r
- @par Protocol Description:\r
- The EFI_USB_IO_PROTOCOL provides four basic transfers types described \r
- in the USB 1.1 Specification. These include control transfer, interrupt \r
- transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL \r
- also provides some basic USB device/controller management and configuration \r
- interfaces. A USB device driver uses the services of this protocol to manage USB devices. \r
-\r
- @param UsbControlTransfer \r
- Accesses the USB Device through USB Control Transfer Pipe. \r
-\r
- @param UsbBulkTransfer\r
- Accesses the USB Device through USB Bulk Transfer Pipe. \r
-\r
- @param UsbAsyncInterruptTransfer\r
- Non-block USB interrupt transfer. \r
-\r
- @param UsbSyncInterruptTransfer\r
- Accesses the USB Device through USB Synchronous\r
- Interrupt Transfer Pipe. \r
-\r
- @param UsbIsochronousTransfer\r
- Accesses the USB Device through USB Isochronous Transfer Pipe. \r
-\r
- @param UsbAsyncIsochronousTransfer\r
- Nonblock USB isochronous transfer. \r
-\r
- @param UsbGetDeviceDescriptor\r
- Retrieves the device descriptor of a USB device. \r
-\r
- @param UsbGetConfigDescriptor\r
- Retrieves the activated configuration descriptor of a USB device. \r
-\r
- @param UsbGetInterfaceDescriptor\r
- Retrieves the interface descriptor of a USB Controller. \r
-\r
- @param UsbGetEndpointDescriptor\r
- Retrieves the endpoint descriptor of a USB Controller. \r
-\r
- @param UsbGetStringDescriptor\r
- Retrieves the string descriptor inside a USB Device. \r
-\r
- @param UsbGetSupportedLanguages\r
- Retrieves the array of languages that the USB device supports. \r
-\r
- @param UsbPortReset\r
- Resets and reconfigures the USB controller. \r
-**/\r
+///\r
+/// The EFI_USB_IO_PROTOCOL provides four basic transfers types described \r
+/// in the USB 1.1 Specification. These include control transfer, interrupt \r
+/// transfer, bulk transfer and isochronous transfer. The EFI_USB_IO_PROTOCOL \r
+/// also provides some basic USB device/controller management and configuration \r
+/// interfaces. A USB device driver uses the services of this protocol to manage USB devices. \r
+///\r
struct _EFI_USB_IO_PROTOCOL {\r
//\r
// IO transfer\r