USBIO Driver for Windows CE - Thesycon Systemsoftware ...

More documents

Recommendations

Info

3 Programming Interface 3 Programming Interface This section describes the programming interface of the USBIO device driver in detail. The programming interface is based on Win32 functions. 3.1 USBIO Class Library Overview The USBIO Class Library (USBIOLIB) contains classes which provide wrapper functions for all of the features supported by the USBIO programming interface. Using these classes in an application is more convenient than using the USBIO interface directly. The classes are designed to be capable of being extended. In order to meet the requirements of a particular application new classes may be derived from the existing ones. The class library is provided fully in source code. The following figure shows the classes included in the USBIOLIB and their relations. CUsbIoReader 3.1.1 CUsbIo Class CUsbIo CUsbIoPipe CUsbIoThread CUsbIoWriter Figure 1: USBIO Class Library CUsbIoBuf CUsbIoBufPool The class CUsbIo implements the basic interface to the USBIO device driver. It includes all functions that are related to a USBIO device object. Thus, by using an instance of the CUsbIo class all operations which do not require a pipe context can be performed. The CUsbIo class supports device enumeration and an Open() function that is used to connect an instance of the class to a USBIO device object. The handle that represents the connection is stored inside the class instance. It is used for all subsequent requests to the device. For each device-related operation the USBIO driver supports, a member function exists in the CUsbIo class. The function takes the parameters that are required for the operation and returns the status that is reported by the USBIO driver. 22 USBIO Driver for Windows CE
3.1.2 CUsbIoPipe Class 3 Programming Interface The class CUsbIoPipe extends the CUsbIo class by functions that are related to a USBIO pipe object. An instance of the CUsbIoPipe class is associated directly with a USBIO pipe object. In order to establish the connection to the pipe the class provides a Bind() function. After a CUsbIoPipe instance is bound, pipe-related functions can be performed by using member functions of the class. For each pipe-related operation that the USBIO driver supports a member function exists in the CUsbIoPipe class. The function takes the parameters that are required for the operation and returns the status that is reported by the USBIO driver. The CUsbIoPipe class supports an asynchronous communication model for data transfers from or to the pipe. The Read() or Write() function is used to submit a data buffer to the USBIO driver. The function returns immediately indicating success if the buffer was sent to the driver successfully. There is no blocking within the Read() or Write() function. Therefore, it is possible to send multiple buffers to the pipe. The buffers are processed sequentially in the same order as they were submitted. The WaitForCompletion() member function is used to wait until the data transfer from or to a particular buffer is finished. This function blocks the calling thread until the USBIO driver has completed the I/O operation with the buffer. In order to use a data buffer with the Read(), Write(), and WaitForCompletion() functions of the CUsbIoPipe class the buffer has to be described by a CUsbIoBuf object. The CUsbIoBuf helper class stores context information while the read or write operation is pending. 3.1.3 CUsbIoThread Class The class CUsbIoThread provides basic functions needed to implement a worker thread that performs input or output operations on a pipe. It includes functions that are used to start and stop the worker thread. The CUsbIoThread class does not implement the thread’s main routine. This has to be done in a derived class. Thus, CUsbIoThread is an universal base class that simplifies the implementation of a worker thread that performs I/O operations on a pipe. Note: The worker thread created by CUsbIoThread is a native system thread. That means it cannot be used to call MFC (Microsoft Foundation Classes) functions. It is necessary to use PostMessage, SendMessage or some other communication mechanism to switch over to MFC-aware threads. 3.1.4 CUsbIoReader Class The class CUsbIoReader extends the CUsbIoThread class by a specific worker thread routine that continuously sends read requests to the pipe. The thread’s main routine gets buffers from an internal buffer pool and submits them to the pipe using the Read() function of the CUsbIoPipe class. After all buffers are submitted the routine waits for the first pending buffer to complete. If a buffer is completed by the USBIO driver the virtual member function ProcessData is called with this buffer. Within this function the data received from the pipe should be processed. The ProcessData function has to be implemented by a class that is derived from CUsbIoReader. USBIO Driver for Windows CE 23
Page 1: ® Thesycon Systemsoftware&Consulti
Page 5 and 6: Contents Contents Table of contents
Page 7 and 8: Contents Data Members . . . . . . .
Page 9 and 10: Contents CPnPNotificator . . . . .
Page 11 and 12: Contents USBIO_ERR_DATA_BUFFER_ERRO
Page 13: Contents USBIO_ERR_PIPE_SIZE_RESTRI
Page 17 and 18: 1 Introduction 1 Introduction USBIO
Page 19 and 20: 2 Overview which the DLL is contain
Page 21: • CUsbIo::StoreConfigurationDescr
Page 25 and 26: Member Functions CUsbIo::CUsbIo Sta
Page 27 and 28: CUsbIo::DestroyDeviceList Destroy t
Page 29 and 30: CUsbIo::OpenPath Open an USB device
Page 31 and 32: CUsbIo::GetDeviceInstanceDetails Ge
Page 33 and 34: CUsbIo::GetDevicePathName Returns t
Page 35 and 36: CUsbIo::IsOpen Returns TRUE if the
Page 37 and 38: CUsbIo::IsDemoVersion Returns TRUE
Page 39 and 40: CUsbIo::GetDriverInfo Get informati
Page 41 and 42: CUsbIo::ReleaseDevice Acquire the d
Page 43 and 44: CUsbIo::GetBandwidthInfo Get inform
Page 45 and 46: The device must have been opened be
Page 47 and 48: CUsbIo::GetConfigurationDescriptor
Page 49 and 50: CUsbIo::GetStringDescriptor Get a s
Page 51 and 52: CUsbIo::SetDescriptor Set a descrip
Page 53 and 54: CUsbIo::SetFeature Send a set featu
Page 55 and 56: CUsbIo::GetStatus Send a get status
Page 57 and 58: CUsbIo::ClassOrVendorOutRequest 3 P
Page 59 and 60: CUsbIo::UnconfigureDevice Set the d
Page 61 and 62: CUsbIo::GetConfigurationInfo 3 Prog
Page 63 and 64: CUsbIo::GetInterface This function
Page 65 and 66: CUsbIo::SetDeviceParameters Set dev
Page 67 and 68: CUsbIo::CyclePort Simulates a devic
Page 69 and 70: CUsbIo::GetDevicePowerState Returns
Page 71 and 72: CUsbIo::IoctlSync Call a driver I/O
Page 73 and 74:
Data Members 3 Programming Interfac
Page 75 and 76:
CUsbIoPipe::Bind Bind the object to
Page 77 and 78:
CUsbIoPipe::Unbind Delete the assoc
Page 79 and 80:
CUsbIoPipe::Write Submit a write re
Page 81 and 82:
Comments 3 Programming Interface Af
Page 83 and 84:
3 Programming Interface Note: Using
Page 85 and 86:
3 Programming Interface The device
Page 87 and 88:
CUsbIoPipe::AbortPipe Cancel all pe
Page 89 and 90:
CUsbIoPipe::SetPipeParameters Set p
Page 91 and 92:
CUsbIoPipe::QueryPipeStatistics Ret
Page 93 and 94:
CUsbIoPipe::ResetPipeStatistics Res
Page 95 and 96:
CUsbIoBuf::CUsbIoBuf Construct a CU
Page 97 and 98:
CUsbIoBuf::˜CUsbIoBuf Destructor f
Page 99 and 100:
CUsbIoBuf::Size Get buffer size, in
Page 101 and 102:
3 Programming Interface BOOL Buffer
Page 103 and 104:
CUsbIoBufPool::Allocate Allocate al
Page 105 and 106:
CUsbIoBufPool::Get Get a buffer fro
Page 107 and 108:
CUsbIoBufPool::CurrentCount Get cur
Page 109 and 110:
See Also CUsbIoThread::˜CUsbIoThre
Page 111 and 112:
CUsbIoThread::FreeBuffers Free the
Page 113 and 114:
CUsbIoThread::ShutdownThread Termin
Page 115 and 116:
CUsbIoThread::ProcessBuffer 3 Progr
Page 117 and 118:
CUsbIoThread::OnThreadExit 3 Progra
Page 119 and 120:
CUsbIoThread::TerminateThread 3 Pro
Page 121 and 122:
See Also CUsbIoReader::˜CUsbIoRead
Page 123 and 124:
CUsbIoReader::TerminateThread 3 Pro
Page 125 and 126:
CUsbIoWriter::ThreadRoutine The mai
Page 127 and 128:
CPnPNotifyHandler class 3 Programmi
Page 129 and 130:
CPnPNotificator::Initialize 3 Progr
Page 131 and 132:
CPnPNotificator::EnableDeviceNotifi
Page 133 and 134:
3.3 Data Transfer Requests 3.3.1 Bu
Page 135 and 136:
3 Programming Interface between the
Page 137 and 138:
3 Programming Interface to the func
Page 139 and 140:
USBIO_DEVICE_INFO The USBIO_DEVICE_
Page 141 and 142:
3 Programming Interface USBIO_INFOF
Page 143 and 144:
USBIO_FEATURE_REQUEST 3 Programming
Page 145 and 146:
USBIO_STATUS_REQUEST_DATA 3 Program
Page 147 and 148:
USBIO_GET_INTERFACE 3 Programming I
Page 149 and 150:
USBIO_INTERFACE_SETTING 3 Programmi
Page 151 and 152:
USBIO_CLASS_OR_VENDOR_REQUEST 3 Pro
Page 153 and 154:
USBIO_DEVICE_PARAMETERS 3 Programmi
Page 155 and 156:
USBIO_CONFIGURATION_INFO (page 158)
Page 157 and 158:
3 Programming Interface InterfaceNu
Page 159 and 160:
USBIO_FRAME_NUMBER 3 Programming In
Page 161 and 162:
USBIO_BIND_PIPE The USBIO_BIND_PIPE
Page 163 and 164:
USBIO_SETUP_PIPE_STATISTICS 3 Progr
Page 165 and 166:
USBIO_PIPE_STATISTICS The USBIO_PIP
Page 167 and 168:
USBIO_PIPE_CONTROL_TRANSFER 3 Progr
Page 169 and 170:
3 Programming Interface ErrorCount
Page 171 and 172:
USBIO_ISO_TRANSFER_HEADER 3 Program
Page 173 and 174:
USBIO_REQUEST_RECIPIENT 3 Programmi
Page 175 and 176:
USBIO_DEVICE_POWER_STATE 3 Programm
Page 177 and 178:
USBIO_ERR_DATA_UNDERRUN (0xE0000009
Page 179 and 180:
USBIO_ERR_INTERNAL_HC_ERROR (0xE000
Page 181 and 182:
USBIO_ERR_ISO_NOT_ACCESSED_BY_HW (0
Page 183 and 184:
USBIO_ERR_TIMEOUT (0xE000100CL) The
Page 185 and 186:
USBIO_ERR_POWER_DOWN (0xE000101BL)
Page 187 and 188:
USBIO_ERR_DEVICE_NOT_OPEN (0xE00011
Page 189 and 190:
5 Installation 5 Installation This
Page 191:
6 Configuration 6.1 USB Bus Driver
Page 194 and 195:
7 Customization To summarize the cu
Page 197 and 198:
Index ˜CPnPNotificator CPnPNotific
Page 199 and 200:
CUsbIoReader::˜CUsbIoReader, 121 C
Page 201 and 202:
GetConfiguration CUsbIo::GetConfigu
Page 203 and 204:
CPnPNotificator::Shutdown, 130 Size
Page 205 and 206:
USBIO_ERR_NOT_CONFIGURED, 182 USBIO
show all

USBIO Driver for Windows CE - Thesycon Systemsoftware ...

Create successful ePaper yourself

Delete template?

Save as template?