RxUsbBulkRead: Difference between revisions
added return codes |
mNo edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
Executes synchronous device-to-host Bulk Transfer with a specific endpoint. | |||
Executes synchronous device-to-host Bulk Transfer with a specific endpoint. | |||
==Syntax== | ==Syntax== | ||
rc = RxUsbBulkRead(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout) | |||
rc = RxUsbBulkRead(Handle,Endpoint,AltSetting,NumBytes,Data,Timeout) | |||
==Parameters== | ==Parameters== | ||
; Handle : the Device Handle received from the previous RxUsbOpen. | ; Handle : the Device Handle received from the previous RxUsbOpen. | ||
; Endpoint : the Endpoint Number with the Direction Bit set to one. | |||
; 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. | |||
; AltSetting : the Alternate Setting of the interface having this endpoint. | ; Data : the name of the variable to receive the data bytes transferred. | ||
; 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. | ; Timeout : the timeout to wait for completion in milliseconds. | ||
==Return Code== | ==Return Code== | ||
0x0000 - NO_ERROR | |||
0x0000 - NO_ERROR | |||
===Errors=== | ===Errors=== | ||
<pre> | <pre> | ||
| Line 36: | Line 27: | ||
0x4000 - USB_IORB_REQUEST | 0x4000 - USB_IORB_REQUEST | ||
0x80XX - USB_IORB_FAILED | 0x80XX - USB_IORB_FAILED | ||
0xFF0D - ERROR_INVALID_DATA | |||
0xFF13 - ERROR_I24_INVALID_PARAMETER | |||
0xFF13 - USB_IDC_PARMERR | |||
0xFF18 - USB_IDC_ADDRINV | |||
0xFF37 - ERROR_DEV_NOT_EXIST | |||
0xFF5D - EROR_NO_ITEMS | |||
0xFFA7 - ERROR_LOCK_FAILED | |||
</pre> | </pre> | ||
==Example Code== | ==Example Code== | ||
| Line 57: | Line 54: | ||
==Related Functions== | ==Related Functions== | ||
* [[RxUsbBulkWrite]] | |||
* [[RxUsbDataTransfer]] | |||
* [[RxUsbOpen]] | |||
[[Category:USBCalls]] | [[Category:USBCalls]] | ||
Latest revision as of 14:01, 4 April 2018
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 0xFF0D - ERROR_INVALID_DATA 0xFF13 - ERROR_I24_INVALID_PARAMETER 0xFF13 - USB_IDC_PARMERR 0xFF18 - USB_IDC_ADDRINV 0xFF37 - ERROR_DEV_NOT_EXIST 0xFF5D - EROR_NO_ITEMS 0xFFA7 - ERROR_LOCK_FAILED
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)