On Time RTOS-32 Documentation
Welcome
RTTarget-32
RTKernel-32
RTFiles-32
RTIP-32
RTPEG-32
RTUSB-32
RTUSB-32 Programming Manual
RTUSB-32 Reference Manual
Introduction
Initialization
Device Query
Device Configuration
Pipe I/O
Function RTUOpenPipe
Function RTUSetPipeMsgQ
Function RTUSetPipeCallback
Function RTUSetPipeOption
Function RTUSendSetup
Function RTUStartIO
Function RTUIOWait
Function RTUIOWaitTimed
Function RTUCancelIO
Function RTUDeviceOfPipe
Function RTUClosePipe
Function RTUSetControlTimeout
Message Queues
Keyboard Class Driver
Mouse Class Driver
Touch Screen Driver
Printer Class Driver
Mass Storage Class Driver
AX772 USB-Ethernet Driver
AX172 USB-Ethernet Driver
CDC ECM USB-Ethernet Driver
Audio Class Driver
Media Transfer Protocol Class Driver
RTUSB-32 Error Codes and Diagnostics
|
Function RTUSetPipeOption
RTUSetPipeOption defines a few options of a pipe:
int RTUSetPipeOption(RTUPipeHandle Pipe, RTUPipeOption Option, int Value);
ParametersPipeHandle to the pipe.
OptionThe option to change (see below).
ValueThe value to apply to option Option (see below).
return valueIf the function succeeds, RTU_SUCCESS is returned. On error, a negative error code is returned.
The supported Options are:
Option |
Meaning |
RTUTimeout |
Assigns Value milliseconds as the new timeout for all future calls to RTUSendSetup using the given pipe. May only be used on pipes to Control endpoints. |
RTUZPacket |
Instructs RTUSB-32 to append a zero-length packet for all outgoing transactions which have a length which is a multiple of the endpoint's maximum packet length. This option is required if the protocol does not provide a way to specify the length of a transaction from the host to the device. Value 1 enables and 0 disables this option. It may only be used for Bulk and Interrupt OUT (host to device) endpoints. |
RTUAsynch |
The pipe will be used for asynchronous I/O. This option can be used to bypasss transaction polling as set by RTUSBConfig.EHCIMaxPollBulk. Setting this option's value to 1 (enable) will cause I/O on this endpoint to consume less CPU time, but the application may see a higher latency in receiving a notification that the transaction has completed. It has no impact on the time required to actually perform the transaction on the USB bus. This option may only be applied to a Bulk endpoint. |
RTUIsoBufferList |
This option may only be specified for Isochronous endpoints. Value 1 enables and 0 disables this option. If enabled, an array of RTUIsoBuffers must be passed to RTUStartIO instead of a send/receive buffer. |
Function RTUSetPipeCallback
Function RTUSendSetup
|