USB control exchange is used to determine device identification and
configuration requirements, and to configure a device; it can also be used
for other device-specific purposes, including control of other pipes on the
Control exchange takes place via a control pipe — the default pipe 0, which always exists. The control transfer consists of a setup stage (in which a setup packet is sent from the host to the device), an optional data stage and a status stage.
The control transaction always begins with a setup stage. The setup stage is followed by zero or more control data transactions (data stage) that carry the specific information for the requested operation, and finally a status transaction completes the control transfer by returning the status to the host.
During the setup stage, an 8-byte setup packet is used to transmit information to the control endpoint of the device (endpoint 0). The setup packet's format is defined by the USB specification.
A control transfer can be a read transaction or a write transaction. In a read transaction the setup packet indicates the characteristics and amount of data to be read from the device. In a write transaction the setup packet contains the command sent (written) to the device and the number of control data bytes that will be sent to the device in the data stage.
'(in)' indicates data flow from the device to the host.
'(out)' indicates data flow from the host to the device.
The setup packets (combined with the control data stage and the status stage) are used to configure and send commands to the device. Chapter 9 of the USB specification defines standard device requests. USB requests such as these are sent from the host to the device, using setup packets. The USB device is required to respond properly to these requests. In addition, each vendor may define device-specific setup packets to perform device-specific operations. The standard setup packets (standard USB device requests) are detailed below. The vendor's device-specific setup packets are detailed in the vendor's data book for each USB device.
The table below shows the format of the USB setup packet. For more information, please refer to the USB specification at http://www.usb.org.
Bit 7: Request direction (0=Host to device — Out, 1=Device to host
Bits 5-6: Request type (0=standard, 1=class, 2=vendor, 3=reserved).
Bits 0-4: Recipient (0=device, 1=interface, 2=endpoint,3=other).
The actual request (see the Standard Device Request Codes table|
A word-size value that varies according to the request. For example, in the
|3||wValueH||The upper byte of the |
|4||wIndexL||A word-size value that varies according to the request. The index is generally used to specify an endpoint or an interface.|
|5||wIndexH||The upper byte of the |
|6||wLengthL||A word-size value that indicates the number of bytes to be transferred if there is a data stage.|
|7||wLengthH||The upper byte of the |
The table below shows the standard device request codes.
|Reserved for future use||2|
|Reserved for future use||4|
This example of a standard USB device request illustrates the setup packet format and its fields. The setup packet is in Hex format.
The following setup packet is for a control read transaction that retrieves the device descriptor from the USB device. The device descriptor includes information such as USB standard revision, vendor ID and product ID.
GET_DESCRIPTOR (Device) Setup Packet
Setup packet meaning:
bit 7=1 -> direction of data is from device to host.
bits 0..1=00 -> the recipient is the device.
|1||bRequest||06||The Request is GET_DESCRIPTOR.|
|3||wValueH||01||The descriptor type is device (values defined in USB spec).|
|4||wIndexL||00||The index is not relevant in this setup packet since there is only one device descriptor.|
|6||wLengthL||12||Length of the data to be retrieved: 18(12h) bytes (this is the length of the device descriptor).|
In response, the device sends the device descriptor data. A device descriptor of the Cypress EZ-USB Integrated Circuit is provided as an example:
As defined in the USB specification, byte 0 indicates the length of the descriptor, bytes 2-3 contain the USB specification release number, byte 7 is the maximum packet size for the control endpoint (endpoint 0), bytes 8-9 are the vendor ID, bytes 10-11 are the product ID, etc.
WinDriver allows you to easily send and receive control transfers on the control
pipe (pipe 0), while using DriverWizard to test your device. You can either use
the API generated by DriverWizard
To perform a read or write transaction on the control pipe, you can either use
the API generated by DriverWizard for your hardware, or directly call the
Fill the setup packet in the
BYTE SetupPacket array and call
these functions to send setup packets on the control pipe (pipe 0) and to
retrieve control and status data from the device.
SetupPacketvariable with a
setupPacket = 0x80; /* BmRequstType */ setupPacket = 0x6; /* bRequest [0x6 == GET_DESCRIPTOR] */ setupPacket = 0; /* wValue */ setupPacket = 0x1; /* wValue [Descriptor Type: 0x1 == DEVICE] */ setupPacket = 0; /* wIndex */ setupPacket = 0; /* wIndex */ setupPacket = 0x12; /* wLength [Size for the returned buffer] */ setupPacket = 0; /* wLength */
GETinstruction; the device will return the information requested in the
WDU_TransferDefaultPipe(hDev, TRUE, 0, pBuffer, dwSize, bytes_transferred, &setupPacket, 10000);
WDU_TransferDefaultPipe(hDev, FALSE, 0, NULL, 0, bytes_transferred, &setupPacket, 10000);