RxUsbBulkRead: Difference between revisions
Appearance
Created page with "==Description== Executes synchronous device-to-host Bulk Transfer with a specific endpoint. ==Syntax== <pre> rc = RxUsbBulkRead(Handle,Endpoint,AltSetting,NumBytes,Data,Time..." |
added return codes |
||
Line 20: | Line 20: | ||
; Timeout : the timeout to wait for completion in milliseconds. | ; Timeout : the timeout to wait for completion in milliseconds. | ||
==Return Code== | ==Return Code== | ||
<pre> | |||
0x0000 - NO_ERROR | |||
</pre> | |||
===Errors=== | ===Errors=== | ||
<pre> | |||
0x0006 - ERROR_INVALID_HANDLE | |||
0x0008 - ERROR_NOT_ENOUGH_MEMORY | |||
0x0057 - ERROR_INVALID_PARAMETER | |||
0x005F - ERROR_INTERRUPT | |||
0x0122 - ERROR_TOO_MANY_HANDLES | |||
0x0280 - ERROR_TIMEOUT | |||
0x1B58 - USB_NOT_INIT | |||
0x1B5B - USB_ERROR_INVALID_ENDPOINT | |||
0x4000 - USB_IORB_REQUEST | |||
0x80XX - USB_IORB_FAILED | |||
</pre> | |||
==Remarks== | ==Remarks== | ||
Line 42: | Line 54: | ||
rc = RxFuncDrop('RxUsbBulkRead') | rc = RxFuncDrop('RxUsbBulkRead') | ||
say '-RxUsbBulkRead(),RC=0x'd2x(rc) | say '-RxUsbBulkRead(),RC=0x'd2x(rc) | ||
</pre> | </pre> | ||
Revision as of 12:11, 23 January 2017
Description
Executes synchronous device-to-host Bulk Transfer with a specific endpoint.
Syntax
rc = RxUsbBulkRead(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout)
Parameters
- Handle
- the Device Handle received from the previous RxUsbOpen.
- Endpoint
- the Endpoint Number with the Direction Bit set to one.
- AltSetting
- the Alternate Setting of the interface having this endpoint.
- NumBytes
- the number of bytes to be transferred or 0 for no data transfer.
- Data
- the name of the variable to receive the data bytes transferred.
- Timeout
- the timeout to wait for completion in milliseconds.
Return Code
0x0000 - NO_ERROR
Errors
0x0006 - ERROR_INVALID_HANDLE 0x0008 - ERROR_NOT_ENOUGH_MEMORY 0x0057 - ERROR_INVALID_PARAMETER 0x005F - ERROR_INTERRUPT 0x0122 - ERROR_TOO_MANY_HANDLES 0x0280 - ERROR_TIMEOUT 0x1B58 - USB_NOT_INIT 0x1B5B - USB_ERROR_INVALID_ENDPOINT 0x4000 - USB_IORB_REQUEST 0x80XX - USB_IORB_FAILED
Remarks
Example Code
/* add RxUsbBulkRead */ rc = RxFuncAdd('RxUsbBulkRead','usbcalls','RxUsbBulkRead') say '+RxUsbBulkRead(),RC=0x'd2x(rc) /* invoke RxUsbBulkRead */ drop Data /* receives string of data bytes read */ Endpoint=128+1; AltSetting=0; NumBytes=4096; Timeout=8000 rc = RxUsbBulkRead(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout) say '*RxUsbBulkRead(),RC=0x'd2x(rc) /* drop RxUsbBulkRead */ rc = RxFuncDrop('RxUsbBulkRead') say '-RxUsbBulkRead(),RC=0x'd2x(rc)