RxUsbCtrlTransfer
From EDM2
Executes synchronous Control Transfer with a specific endpoint.
Syntax
rc = RxUsbCtrlTransfer(Handle,Endpoint,AltSetting,RequestType,
Request,Value,Index,NumBytes,Data,Timeout)
Parameters
- Handle
- the Device Handle received from the previous RxUsbOpen.
- Endpoint
- the Endpoint Number appropriate for the control transfer.
- AltSetting
- the Alternate Setting of the interface having this endpoint.
- RequestType
- the characteristics of the Standard Device Request.
- Request
- the specific request code of the Standard Device Request.
- Value
- the request dependent value of the Standard Device Request.
- Index
- the request dependent index of the Standard Device Request.
- Timeout
- the timeout to wait for completion in milliseconds.
For device-to-host data transfer:
- 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.
For host-to-device data transfer:
- NumBytes
- the name of the variable to receive the number of bytes transferred.
- Data
- the character string if any with the data bytes to be transferred.
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 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 RxUsbCtrlTransfer */
rc = RxFuncAdd('RxUsbCtrlTransfer','usbcalls','RxUsbCtrlTransfer')
say '+RxUsbCtrlTransfer(),RC=0x'd2x(rc)
/* invoke RxUsbCtrlTransfer device-to-host */
drop Data /* receives string of data bytes read */
RequestType=x2d(81); Request=x2d(06) /* get interface descriptor */
Value=x2d(2200); Index=x2d(0000); NumBytes=4096; Timeout=8000; /* hid report */
rc = RxUsbCtrlTransfer(Handle,0,0,RequestType,Request,Value,Index,NumBytes,Data,Timeout)
say '*RxUsbCtrlTransfer(),RC=0x'd2x(rc)
/* invoke RxUsbCtrlTransfer device-to-host */
drop Data /* receives string of data bytes read */
RequestType=x2d(A1); Request=x2d(01) /* get interface class report */
Value=x2d(0300); Index=x2d(0000); NumBytes=8; Timeout=8000; /* hid feature report */
rc = RxUsbCtrlTransfer(Handle,0,0,RequestType,Request,Value,Index,NumBytes,Data,Timeout)
say '*RxUsbCtrlTransfer(),RC=0x'd2x(rc)
/* invoke RxUsbCtrlTransfer host-to-device */
Data=x2c(00 00 00 00 00 00 00 00) /* clear data */
RequestType=x2d(21); Request=x2d(09) /* set interface class report */
Value=x2d(0300); Index=x2d(0000); drop NumBytes; Timeout=8000; /* hid feature report */
rc = RxUsbCtrlTransfer(Handle,0,0,RequestType,Request,Value,Index,NumBytes,Data,Timeout)
say '*RxUsbCtrlTransfer(),RC=0x'd2x(rc)
/* drop RxUsbCtrlTransfer */
rc = RxFuncDrop('RxUsbCtrlTransfer')
say '-RxUsbCtrlTransfer(),RC=0x'd2x(rc)
