UsbBulkRead: Difference between revisions

Latest revision as of 22:43, 13 September 2021

Description

Executes synchronous device-to-host Bulk Transfer with a specific endpoint.

Syntax

ulrc = UsbBulkRead(Handle,ucEndpoint,ucAltSetting,pulNumBytes,pucData,ulTimeout)

Parameters

Handle: the Device Handle received from the previous UsbOpen.
ucEndpoint: the Endpoint Number with the Direction Bit set to one.
ucAltSetting: the Alternate Setting of the interface having this endpoint.
pulNumBytes: the address of the variable to specify/receive the number of bytes.
pucData: the address of the buffer to receive the data bytes transferred.
ulTimeout: the timeout to wait for completion in milliseconds.

Return Code

0x0000 - NO_ERROR

Errors

0x0000 - NO_ERROR
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

Remarks

Example Code

//Code Snippet - UsbBulkRead
{
  APIRET ulrc;
  PUCHAR pucData;
  PULONG pulNumBytes;
  UCHAR ucAltSetting = 0;
  UCHAR ucData[4096];
  UCHAR ucEndpoint = 0x81;
  ULONG ulNumBytes = sizeof(ucData);
  ULONG ulTimeout = 8000;

  pucData = &ucData[0]; pulNumBytes = &ulNumBytes;
  ulrc = UsbBulkRead(Handle,ucEndpoint,ucAltSetting,pulNumBytes,pucData,ulTimeout);
  printf("\nUsbBulkRead - ulrc: 0x%04X (%hu)",ulrc,ulrc);
  if (!ulrc) //success
  {
    int i; printf(" - bulk data:\n");
    for (i=0;i<ulNumBytes;i++) printf("%02X",ucData[i]);
  }
}

Related Functions

@@ Line 3: / Line 3: @@
 ==Syntax==
-<pre>
+ ulrc = UsbBulkRead(Handle,ucEndpoint,ucAltSetting,pulNumBytes,pucData,ulTimeout)
-ulrc=UsbBulkRead(Handle,Endpoint,AltInterface,*pulNumBytes,*pucData,ulTimeout)
-</pre>
 ==Parameters==
-; Handle :
+; Handle : the Device Handle received from the previous UsbOpen.
+; ucEndpoint : the Endpoint Number with the Direction Bit set to one.
-; Endpoint :
+; ucAltSetting : the Alternate Setting of the interface having this endpoint.
+; pulNumBytes : the address of the variable to specify/receive the number of bytes.
-; AltInterface :
+; pucData : the address of the buffer to receive the data bytes transferred.
+; ulTimeout : the timeout to wait for completion in milliseconds.
-; *pulNumBytes :
-; *pucData :
-; ulTimeout :
 ==Return Code==
+x0000 - NO_ERROR
 ===Errors===
+<pre>
-  [0000] - NO_ERROR
+x0000 - NO_ERROR
-  [0006] - ERROR_INVALID_HANDLE
+x0006 - ERROR_INVALID_HANDLE
-  [0008] - ERROR_NOT_ENOUGH_MEMORY
+x0008 - ERROR_NOT_ENOUGH_MEMORY
-  [0057] - ERROR_INVALID_PARAMETER
+x0057 - ERROR_INVALID_PARAMETER
-  [005F] - ERROR_INTERRUPT (95)
+x005F - ERROR_INTERRUPT
-  [0122] - ERROR_TOO_MANY_HANDLES (290)
+x0122 - ERROR_TOO_MANY_HANDLES
-  [0280] - ERROR_TIMEOUT (640)
+x0280 - ERROR_TIMEOUT
-  [1B58] - USB_NOT_INIT (7000)
+x1B58 - USB_NOT_INIT
-  [1B5B] - USB_ERROR_INVALID_ENDPOINT (7003)
+x1B5B - USB_ERROR_INVALID_ENDPOINT
-  [4000] - USB_IORB_REQUEST
+x4000 - USB_IORB_REQUEST
-  [80XX] - USB_IORB_FAILED
+x80XX - USB_IORB_FAILED
+xFF0D - ERROR_INVALID_DATA
+xFF13 - ERROR_I24_INVALID_PARAMETER
+xFF13 - USB_IDC_PARMERR
+xFF18 - USB_IDC_ADDRINV
+xFF37 - ERROR_DEV_NOT_EXIST
+xFF5D - EROR_NO_ITEMS
+xFFA7 - ERROR_LOCK_FAILED
+</pre>
 ==Remarks==
@@ Line 41: / Line 42: @@
 ==Example Code==
 <pre>
+//Code Snippet - UsbBulkRead
+{
+  APIRET ulrc;
+  PUCHAR pucData;
+  PULONG pulNumBytes;
+  UCHAR ucAltSetting = 0;
+  UCHAR ucData[4096];
+  UCHAR ucEndpoint = 0x81;
+  ULONG ulNumBytes = sizeof(ucData);
+  ULONG ulTimeout = 8000;
+  pucData = &ucData[0]; pulNumBytes = &ulNumBytes;
+  ulrc = UsbBulkRead(Handle,ucEndpoint,ucAltSetting,pulNumBytes,pucData,ulTimeout);
+  printf("\nUsbBulkRead - ulrc: 0x%04X (%hu)",ulrc,ulrc);
+  if (!ulrc) //success
+  {
+    int i; printf(" - bulk data:\n");
+    for (i=0;i<ulNumBytes;i++) printf("%02X",ucData[i]);
+  }
+}
 </pre>
 ==Related Functions==
+* [[UsbBulkWrite]]
+* [[UsbDataTransfer]]
+* [[UsbOpen]]
 [[Category:USBCalls]]