forked from ioLab/python-ioLabs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
psyscopex.py
368 lines (305 loc) · 18.2 KB
/
psyscopex.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
'''
module for handling USB boxes connected via psyscopex install, which circumcents the
usual HID driver.
we provide a HID "emulation" layer, so the rest of the code interacts with this in
the same way as for a HID device
'''
import logging
import struct
from ctypes import *
from hid import HIDDevice
from hid.cparser import parse, define
try:
from hid.osx import IOObjectRelease, find_usb_devices, COMObjectRef, IOCreatePlugInInterfaceForService, \
CFUUIDGetConstantUUIDWithBytes, IOCFPlugInInterfaceStruct, SInt32, UInt32, UInt8, kIOCFPlugInInterfaceID, \
IUNKNOWN_C_GUTS, CFUUIDGetUUIDBytes, io_iterator_t, IOIteratorNext, kIOReturnSuccess
on_osx=True
except:
on_osx=False
if on_osx:
# only define all these things if we have imported the osx hid library ok
def err_system(x):
return (((x)&0x3f)<<26)
def err_sub(x):
return (((x)&0xfff)<<14)
def iokit_common_err(ret):
sys_iokit=err_system(0x38)
sub_iokit_common=err_sub(0)
return sys_iokit|sub_iokit_common|ret
kIOUSBDeviceClassName="IOUSBDevice"
kUSBVendorID="idVendor"
kUSBProductID="idProduct"
kIOReturnExclusiveAccess=iokit_common_err(0x2c5)
kIOUSBFindInterfaceDontCare = 0xFFFF
kIOUSBDeviceUserClientTypeID=CFUUIDGetConstantUUIDWithBytes(None,
0x9d, 0xc7, 0xb7, 0x80, 0x9e, 0xc0, 0x11, 0xD4,
0xa5, 0x4f, 0x00, 0x0a, 0x27, 0x05, 0x28, 0x61)
kIOUSBInterfaceUserClientTypeID=CFUUIDGetConstantUUIDWithBytes(None,
0x2d, 0x97, 0x86, 0xc6, 0x9e, 0xf3, 0x11, 0xD4,
0xad, 0x51, 0x00, 0x0a, 0x27, 0x05, 0x28, 0x61)
kIOUSBInterfaceInterfaceID=CFUUIDGetConstantUUIDWithBytes(None,
0x73, 0xc9, 0x7a, 0xe8, 0x9e, 0xf3, 0x11, 0xD4,
0xb1, 0xd0, 0x00, 0x0a, 0x27, 0x05, 0x28, 0x61)
kIOUSBDeviceInterfaceID=CFUUIDGetConstantUUIDWithBytes(None,
0x5c, 0x81, 0x87, 0xd0, 0x9e, 0xf3, 0x11, 0xD4,
0x8b, 0x45, 0x00, 0x0a, 0x27, 0x05, 0x28, 0x61)
USBDeviceAddress=define('USBDeviceAddress','UInt16')
class IOUSBDevRequest(Structure):
_fields_=[
parse('UInt8 bmRequestType').cstruct,
parse('UInt8 bRequest').cstruct,
parse('UInt16 wValue').cstruct,
parse('UInt16 wIndex').cstruct,
parse('UInt16 wLength').cstruct,
parse('void *pData').cstruct,
parse('UInt32 wLenDone').cstruct,
]
define('IOUSBDevRequest',IOUSBDevRequest)
IOAsyncCallback1=parse('void ( *IOAsyncCallback1)(void *refcon,IOReturn result,void *arg0)').ctype
define('IOAsyncCallback1',IOAsyncCallback1)
class IOUSBIsocFrame(Structure):
_fields_=[
parse('IOReturn frStatus').cstruct,
parse('UInt16 frReqCount').cstruct,
parse('UInt16 frActCount').cstruct,
]
define('IOUSBIsocFrame',IOUSBIsocFrame)
class IOUSBDevRequestTO(Structure):
_fields_=[
parse('UInt8 bmRequestType').cstruct,
parse('UInt8 bRequest').cstruct,
parse('UInt16 wValue').cstruct,
parse('UInt16 wIndex').cstruct,
parse('UInt16 wLength').cstruct,
parse('void *pData').cstruct,
parse('UInt32 wLenDone').cstruct,
parse('UInt32 noDataTimeout').cstruct,
parse('UInt32 completionTimeout').cstruct,
]
define('IOUSBDevRequestTO', IOUSBDevRequestTO)
class IOUSBConfigurationDescriptor(Structure):
_fields_=[
parse('UInt8 bLength').cstruct,
parse('UInt8 bDescriptorType').cstruct,
parse('UInt16 wTotalLength').cstruct,
parse('UInt8 bNumInterfaces').cstruct,
parse('UInt8 bConfigurationValue').cstruct,
parse('UInt8 iConfiguration').cstruct,
parse('UInt8 bmAttributes').cstruct,
parse('UInt8 MaxPower').cstruct,
]
define('IOUSBConfigurationDescriptor',IOUSBConfigurationDescriptor)
IOUSBConfigurationDescriptorPtr=define('IOUSBConfigurationDescriptorPtr','IOUSBConfigurationDescriptor*')
class IOUSBFindInterfaceRequest(Structure):
_fields_=[
parse('UInt16 bInterfaceClass').cstruct,
parse('UInt16 bInterfaceSubClass').cstruct,
parse('UInt16 bInterfaceProtocol').cstruct,
parse('UInt16 bAlternateSetting').cstruct,
]
define('IOUSBFindInterfaceRequest',IOUSBFindInterfaceRequest)
class IOUSBDeviceInterface(Structure):
_fields_= IUNKNOWN_C_GUTS + \
[
parse('IOReturn (*CreateDeviceAsyncEventSource)(void *self, CFRunLoopSourceRef *source)').cstruct,
parse('CFRunLoopSourceRef (*GetDeviceAsyncEventSource)(void *self)').cstruct,
parse('IOReturn (*CreateDeviceAsyncPort)(void *self, mach_port_t *port)').cstruct,
parse('mach_port_t (*GetDeviceAsyncPort)(void *self)').cstruct,
parse('IOReturn (*USBDeviceOpen)(void *self)').cstruct,
parse('IOReturn (*USBDeviceClose)(void *self)').cstruct,
parse('IOReturn (*GetDeviceClass)(void *self, UInt8 *devClass)').cstruct,
parse('IOReturn (*GetDeviceSubClass)(void *self, UInt8 *devSubClass)').cstruct,
parse('IOReturn (*GetDeviceProtocol)(void *self, UInt8 *devProtocol)').cstruct,
parse('IOReturn (*GetDeviceVendor)(void *self, UInt16 *devVendor)').cstruct,
parse('IOReturn (*GetDeviceProduct)(void *self, UInt16 *devProduct)').cstruct,
parse('IOReturn (*GetDeviceReleaseNumber)(void *self, UInt16 *devRelNum)').cstruct,
parse('IOReturn (*GetDeviceAddress)(void *self, USBDeviceAddress *addr)').cstruct,
parse('IOReturn (*GetDeviceBusPowerAvailable)(void *self, UInt32 *powerAvailable)').cstruct,
parse('IOReturn (*GetDeviceSpeed)(void *self, UInt8 *devSpeed)').cstruct,
parse('IOReturn (*GetNumberOfConfigurations)(void *self, UInt8 *numConfig)').cstruct,
parse('IOReturn (*GetLocationID)(void *self, UInt32 *locationID)').cstruct,
parse('IOReturn (*GetConfigurationDescriptorPtr)(void *self, UInt8 configIndex, IOUSBConfigurationDescriptorPtr *desc)').cstruct,
parse('IOReturn (*GetConfiguration)(void *self, UInt8 *configNum)').cstruct,
parse('IOReturn (*SetConfiguration)(void *self, UInt8 configNum)').cstruct,
parse('IOReturn (*GetBusFrameNumber)(void *self, UInt64 *frame, AbsoluteTime *atTime)').cstruct,
parse('IOReturn (*ResetDevice)(void *self)').cstruct,
parse('IOReturn (*DeviceRequest)(void *self, IOUSBDevRequest *req)').cstruct,
parse('IOReturn (*DeviceRequestAsync)(void *self, IOUSBDevRequest *req, IOAsyncCallback1 callback, void *refCon)').cstruct,
parse('IOReturn (*CreateInterfaceIterator)(void *self, IOUSBFindInterfaceRequest *req, io_iterator_t *iter)').cstruct,
]
define('IOUSBDeviceInterface',IOUSBDeviceInterface)
class IOUSBInterfaceInterface182(Structure):
_fields_ = IUNKNOWN_C_GUTS + \
[
parse('IOReturn (*CreateInterfaceAsyncEventSource)(void *self, CFRunLoopSourceRef *source)').cstruct,
parse('CFRunLoopSourceRef (*GetInterfaceAsyncEventSource)(void *self)').cstruct,
parse('IOReturn (*CreateInterfaceAsyncPort)(void *self, mach_port_t *port)').cstruct,
parse('mach_port_t (*GetInterfaceAsyncPort)(void *self)').cstruct,
parse('IOReturn (*USBInterfaceOpen)(void *self)').cstruct,
parse('IOReturn (*USBInterfaceClose)(void *self)').cstruct,
parse('IOReturn (*GetInterfaceClass)(void *self, UInt8 *intfClass)').cstruct,
parse('IOReturn (*GetInterfaceSubClass)(void *self, UInt8 *intfSubClass)').cstruct,
parse('IOReturn (*GetInterfaceProtocol)(void *self, UInt8 *intfProtocol)').cstruct,
parse('IOReturn (*GetDeviceVendor)(void *self, UInt16 *devVendor)').cstruct,
parse('IOReturn (*GetDeviceProduct)(void *self, UInt16 *devProduct)').cstruct,
parse('IOReturn (*GetDeviceReleaseNumber)(void *self, UInt16 *devRelNum)').cstruct,
parse('IOReturn (*GetConfigurationValue)(void *self, UInt8 *configVal)').cstruct,
parse('IOReturn (*GetInterfaceNumber)(void *self, UInt8 *intfNumber)').cstruct,
parse('IOReturn (*GetAlternateSetting)(void *self, UInt8 *intfAltSetting)').cstruct,
parse('IOReturn (*GetNumEndpoints)(void *self, UInt8 *intfNumEndpoints)').cstruct,
parse('IOReturn (*GetLocationID)(void *self, UInt32 *locationID)').cstruct,
parse('IOReturn (*GetDevice)(void *self, io_service_t *device)').cstruct,
parse('IOReturn (*SetAlternateInterface)(void *self, UInt8 alternateSetting)').cstruct,
parse('IOReturn (*GetBusFrameNumber)(void *self, UInt64 *frame, AbsoluteTime *atTime)').cstruct,
parse('IOReturn (*ControlRequest)(void *self, UInt8 pipeRef, IOUSBDevRequest *req)').cstruct,
parse('IOReturn (*ControlRequestAsync)(void *self, UInt8 pipeRef, IOUSBDevRequest *req, IOAsyncCallback1 callback, void *refCon)').cstruct,
parse('IOReturn (*GetPipeProperties)(void *self, UInt8 pipeRef, UInt8 *direction, UInt8 *number, UInt8 *transferType, UInt16 *maxPacketSize, UInt8 *interval)').cstruct,
parse('IOReturn (*GetPipeStatus)(void *self, UInt8 pipeRef)').cstruct,
parse('IOReturn (*AbortPipe)(void *self, UInt8 pipeRef)').cstruct,
parse('IOReturn (*ResetPipe)(void *self, UInt8 pipeRef)').cstruct,
parse('IOReturn (*ClearPipeStall)(void *self, UInt8 pipeRef)').cstruct,
parse('IOReturn (*ReadPipe)(void *self, UInt8 pipeRef, void *buf, UInt32 *size)').cstruct,
parse('IOReturn (*WritePipe)(void *self, UInt8 pipeRef, void *buf, UInt32 size)').cstruct,
parse('IOReturn (*ReadPipeAsync)(void *self, UInt8 pipeRef, void *buf, UInt32 size, IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*WritePipeAsync)(void *self, UInt8 pipeRef, void *buf, UInt32 size, IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*ReadIsochPipeAsync)(void *self, UInt8 pipeRef, void *buf, UInt64 frameStart, UInt32 numFrames, IOUSBIsocFrame *frameList,'
'IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*WriteIsochPipeAsync)(void *self, UInt8 pipeRef, void *buf, UInt64 frameStart, UInt32 numFrames, IOUSBIsocFrame *frameList,'
'IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*ControlRequestTO)(void *self, UInt8 pipeRef, IOUSBDevRequestTO *req)').cstruct,
parse('IOReturn (*ControlRequestAsyncTO)(void *self, UInt8 pipeRef, IOUSBDevRequestTO *req, IOAsyncCallback1 callback, void *refCon)').cstruct,
parse('IOReturn (*ReadPipeTO)(void *self, UInt8 pipeRef, void *buf, UInt32 *size, UInt32 noDataTimeout, UInt32 completionTimeout)').cstruct,
parse('IOReturn (*WritePipeTO)(void *self, UInt8 pipeRef, void *buf, UInt32 size, UInt32 noDataTimeout, UInt32 completionTimeout)').cstruct,
parse('IOReturn (*ReadPipeAsyncTO)(void *self, UInt8 pipeRef, void *buf, UInt32 size, UInt32 noDataTimeout, UInt32 completionTimeout, IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*WritePipeAsyncTO)(void *self, UInt8 pipeRef, void *buf, UInt32 size, UInt32 noDataTimeout, UInt32 completionTimeout, IOAsyncCallback1 callback, void *refcon)').cstruct,
parse('IOReturn (*USBInterfaceGetStringIndex)(void *self, UInt8 *si)').cstruct,
]
def find_devices():
# attempt to directly find usb devices via
# this function from hid lib (fail gracefully if
# we're not running on os x)
if on_osx:
return find_usb_devices(kIOUSBDeviceClassName,kUSBVendorID,kUSBProductID,PsyScopeXUSBDevice)
return []
class PsyScopeXUSBDevice(HIDDevice):
def __init__(self, dev, vendor, product):
super(PsyScopeXUSBDevice,self).__init__(vendor,product)
self._usbDevice=dev
self._devInterface = None
# cache these so they are guaranteed to be available
# when calling __del__
self.IOObjectRelease=IOObjectRelease
self.logging_info=logging.info
self._parent__del__=super(PsyScopeXUSBDevice,self).__del__
def __del__(self):
self._parent__del__()
if self._usbDevice:
self.logging_info("releasing USB device: %s"%self)
self.IOObjectRelease(self._usbDevice)
def close(self):
if self._devInterface:
self._devInterface.USBInterfaceClose()
super(PsyScopeXUSBDevice,self).close()
def is_open(self):
return self._devInterface is not None
def open(self):
logging.info("opening hid device via usb")
# plugInInterface initialised to NULL
plugInInterface=COMObjectRef(POINTER(POINTER(IOCFPlugInInterfaceStruct))())
score=SInt32()
err=IOCreatePlugInInterfaceForService(self._usbDevice, kIOUSBDeviceUserClientTypeID,
kIOCFPlugInInterfaceID, byref(plugInInterface.ref), byref(score));
# query to get the USB interface
usbDevInterface=POINTER(POINTER(IOUSBDeviceInterface))()
err=plugInInterface.QueryInterface(CFUUIDGetUUIDBytes(kIOUSBDeviceInterfaceID),parse('LPVOID*').cast(byref(usbDevInterface)))
if err:
raise RuntimeError("Failed to QueryInterface for USB Device Interface")
usbDevInterface=COMObjectRef(usbDevInterface)
# open USB device
err=usbDevInterface.USBDeviceOpen()
if err:
if err == kIOReturnExclusiveAccess:
raise RuntimeError("Device already open")
raise RuntimeError("Could not open device")
numConf=UInt8()
err=usbDevInterface.GetNumberOfConfigurations(byref(numConf))
if err:
raise RuntimeError("Error calling GetNumberOfConfigurations")
logging.info("Found %d Interface(s)" % numConf.value)
configDesc=IOUSBConfigurationDescriptorPtr()
# get first (and only) config
err = usbDevInterface.GetConfigurationDescriptorPtr(0, byref(configDesc))
if err:
raise RuntimeError("Error calling GetConfigurationDescriptorPtr")
err = usbDevInterface.SetConfiguration(configDesc.contents.bConfigurationValue)
if err:
raise RuntimeError("Error calling SetConfiguration")
interfaceRequest=IOUSBFindInterfaceRequest()
interfaceRequest.bInterfaceClass = kIOUSBFindInterfaceDontCare
interfaceRequest.bInterfaceSubClass = kIOUSBFindInterfaceDontCare
interfaceRequest.bInterfaceProtocol = kIOUSBFindInterfaceDontCare
interfaceRequest.bAlternateSetting = kIOUSBFindInterfaceDontCare
interfaceIterator=io_iterator_t()
err = usbDevInterface.CreateInterfaceIterator(byref(interfaceRequest), byref(interfaceIterator))
if err:
raise RuntimeError("Error calling CreateInterfaceIterator")
err = usbDevInterface.USBDeviceClose()
if err:
raise RuntimeError("Error calling USBDeviceClose")
while True:
interface = IOIteratorNext(interfaceIterator)
if not interface:
break
self._open_interface(interface)
IOObjectRelease(interfaceIterator)
def _open_interface(self, interface):
plugInInterface=COMObjectRef(POINTER(POINTER(IOCFPlugInInterfaceStruct))())
score=SInt32()
err = IOCreatePlugInInterfaceForService(interface,
kIOUSBInterfaceUserClientTypeID, kIOCFPlugInInterfaceID, byref(plugInInterface.ref), byref(score));
devInterface=POINTER(POINTER(IOUSBInterfaceInterface182))()
err = plugInInterface.QueryInterface(CFUUIDGetUUIDBytes(kIOUSBInterfaceInterfaceID),parse('LPVOID*').cast(byref(devInterface)));
if err:
raise RuntimeError("Failed to QueryInterface for USB Interface Interface")
self._devInterface=COMObjectRef(devInterface)
err = self._devInterface.USBInterfaceOpen()
if err:
raise RuntimeError("Error opening USB interface")
numPipes=UInt8()
err = self._devInterface.GetNumEndpoints(byref(numPipes))
if err:
raise RuntimeError("Error calling GetNumEndpoints")
def set_report(self,report_data,report_id=0):
'''
"set" a report - send the data to the device (which must have been opened previously)
'''
HIDDevice.set_report(self,report_data,report_id)
# copy data into a ctypes buffer
report_buffer=(c_ubyte*len(report_data))()
for i,c in enumerate(report_data):
report_buffer[i]=struct.unpack('B',c)[0]
ioret=self._devInterface.WritePipe(2, report_buffer, len(report_data))
if ioret != kIOReturnSuccess:
logging.info("error writing to device: 0x%x" % long(ioret))
def _run_interrupt_callback_loop(self,report_buffer_size):
if not self.is_open():
raise RuntimeError("device not open")
logging.info("starting _run_interrupt_callback_loop")
# create the report buffer
report_buffer=(c_ubyte*report_buffer_size)()
while self._running and self.is_open():
# just repeatedly read from the pipe 1 on the interface
size=UInt32(report_buffer_size)
ioret=self._devInterface.ReadPipe(1, byref(report_buffer), byref(size))
if ioret == kIOReturnSuccess:
report_data="".join([struct.pack('B',b) for b in report_buffer])
# zero buffer after to ensure we don't get weird-ness
# if it's not fully written to later
for i in range(len(report_buffer)):
report_buffer[i]=0
logging.info('interrupt_report_callback(%r)',report_data)
self._callback(self,report_data)
else:
logging.info("error reading from device: 0x%x" % long(ioret))