Repository navigation
Expand file tree
/
Copy pathwebusb-device.ts
More file actions
513 lines (433 loc) · 19 KB
/
Copy pathwebusb-device.ts
File metadata and controls
513 lines (433 loc) · 19 KB
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
import * as usb from '../usb';
import { promisify } from 'util';
import { Endpoint, InEndpoint, OutEndpoint } from '../usb/endpoint';
import { platform } from 'os';
const LIBUSB_TRANSFER_TYPE_MASK = 0x03;
const ENDPOINT_NUMBER_MASK = 0x7f;
const CLEAR_FEATURE = 0x01;
const ENDPOINT_HALT = 0x00;
/**
* Wrapper to make a node-usb device look like a webusb device
*/
export class WebUSBDevice implements USBDevice {
public static async createInstance(device: usb.Device, autoDetachKernelDriver = true): Promise<WebUSBDevice> {
const instance = new WebUSBDevice(device, autoDetachKernelDriver);
await instance.initialize();
return instance;
}
public readonly usbVersionMajor: number;
public readonly usbVersionMinor: number;
public readonly usbVersionSubminor: number;
public readonly deviceClass: number;
public readonly deviceSubclass: number;
public readonly deviceProtocol: number;
public readonly vendorId: number;
public readonly productId: number;
public readonly deviceVersionMajor: number;
public readonly deviceVersionMinor: number;
public readonly deviceVersionSubminor: number;
public manufacturerName: string | null = null;
public productName: string | null = null;
public serialNumber: string | null = null;
public configurations: USBConfiguration[] = [];
private controlTransferAsync: (
bmRequestType: number,
bRequest: number,
wValue: number,
wIndex: number,
data_or_length: number | Buffer,
) => Promise<number | Buffer | undefined>;
private setConfigurationAsync: (desired: number) => Promise<void>;
private resetAsync: () => Promise<void>;
private getStringDescriptorAsync: (desc_index: number) => Promise<string | undefined>;
private constructor(private device: usb.Device, private autoDetachKernelDriver: boolean) {
const usbVersion = this.decodeVersion(device.deviceDescriptor.bcdUSB);
this.usbVersionMajor = usbVersion.major;
this.usbVersionMinor = usbVersion.minor;
this.usbVersionSubminor = usbVersion.sub;
this.deviceClass = device.deviceDescriptor.bDeviceClass;
this.deviceSubclass = device.deviceDescriptor.bDeviceSubClass;
this.deviceProtocol = device.deviceDescriptor.bDeviceProtocol;
this.vendorId = device.deviceDescriptor.idVendor;
this.productId = device.deviceDescriptor.idProduct;
const deviceVersion = this.decodeVersion(device.deviceDescriptor.bcdDevice);
this.deviceVersionMajor = deviceVersion.major;
this.deviceVersionMinor = deviceVersion.minor;
this.deviceVersionSubminor = deviceVersion.sub;
this.controlTransferAsync = promisify(this.device.controlTransfer).bind(this.device);
this.setConfigurationAsync = promisify(this.device.setConfiguration).bind(this.device);
this.resetAsync = promisify(this.device.reset).bind(this.device);
this.getStringDescriptorAsync = promisify(this.device.getStringDescriptor).bind(this.device);
}
public get configuration(): USBConfiguration | null {
if (!this.device.configDescriptor) {
return null;
}
const currentConfiguration = this.device.configDescriptor.bConfigurationValue;
return this.configurations.find(configuration => configuration.configurationValue === currentConfiguration) || null;
}
public get opened(): boolean {
return (!!this.device.interfaces);
}
public async open(): Promise<void> {
try {
if (this.opened) {
return;
}
this.device.open();
if (platform() !== 'win32') {
this.device.setAutoDetachKernelDriver(this.autoDetachKernelDriver);
}
} catch (error) {
throw new Error(`open error: ${error}`);
}
}
public async close(): Promise<void> {
try {
if (!this.opened) {
return;
}
try {
if (this.configuration) {
for (const iface of this.configuration.interfaces) {
await this._releaseInterface(iface.interfaceNumber);
// Re-create the USBInterface to set the claimed attribute
this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
interfaceNumber: iface.interfaceNumber,
alternate: iface.alternate,
alternates: iface.alternates,
claimed: false
};
}
}
} catch (_error) {
// Ignore
}
this.device.close();
} catch (error) {
throw new Error(`close error: ${error}`);
}
}
public async selectConfiguration(configurationValue: number): Promise<void> {
if (!this.opened || !this.device.configDescriptor) {
throw new Error('selectConfiguration error: invalid state');
}
if (this.device.configDescriptor.bConfigurationValue === configurationValue) {
return;
}
const config = this.configurations.find(configuration => configuration.configurationValue === configurationValue);
if (!config) {
throw new Error('selectConfiguration error: configuration not found');
}
try {
await this.setConfigurationAsync(configurationValue);
} catch (error) {
throw new Error(`selectConfiguration error: ${error}`);
}
}
public async claimInterface(interfaceNumber: number): Promise<void> {
if (!this.opened) {
throw new Error('claimInterface error: invalid state');
}
if (!this.configuration) {
throw new Error('claimInterface error: interface not found');
}
const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
if (!iface) {
throw new Error('claimInterface error: interface not found');
}
if (iface.claimed) {
return;
}
try {
this.device.interface(interfaceNumber).claim();
// Re-create the USBInterface to set the claimed attribute
this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
interfaceNumber,
alternate: iface.alternate,
alternates: iface.alternates,
claimed: true
};
} catch (error) {
throw new Error(`claimInterface error: ${error}`);
}
}
public async releaseInterface(interfaceNumber: number): Promise<void> {
await this._releaseInterface(interfaceNumber);
if (this.configuration) {
const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
if (iface) {
// Re-create the USBInterface to set the claimed attribute
this.configuration.interfaces[this.configuration.interfaces.indexOf(iface)] = {
interfaceNumber,
alternate: iface.alternate,
alternates: iface.alternates,
claimed: false
};
}
}
}
public async selectAlternateInterface(interfaceNumber: number, alternateSetting: number): Promise<void> {
if (!this.opened) {
throw new Error('selectAlternateInterface error: invalid state');
}
if (!this.configuration) {
throw new Error('selectAlternateInterface error: interface not found');
}
const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
if (!iface) {
throw new Error('selectAlternateInterface error: interface not found');
}
if (!iface.claimed) {
throw new Error('selectAlternateInterface error: invalid state');
}
try {
const iface = this.device.interface(interfaceNumber);
await iface.setAltSettingAsync(alternateSetting);
} catch (error) {
throw new Error(`selectAlternateInterface error: ${error}`);
}
}
public async controlTransferIn(setup: USBControlTransferParameters, length: number): Promise<USBInTransferResult> {
try {
this.checkDeviceOpen();
const type = this.controlTransferParamsToType(setup, usb.LIBUSB_ENDPOINT_IN);
const result = await this.controlTransferAsync(type, setup.request, setup.value, setup.index, length);
return {
data: result ? new DataView(new Uint8Array(result as Buffer).buffer) : undefined,
status: 'ok'
};
} catch (error) {
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_STALL) {
return {
status: 'stall'
};
}
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_OVERFLOW) {
return {
status: 'babble'
};
}
throw new Error(`controlTransferIn error: ${error}`);
}
}
public async controlTransferOut(setup: USBControlTransferParameters, data?: ArrayBuffer): Promise<USBOutTransferResult> {
try {
this.checkDeviceOpen();
const type = this.controlTransferParamsToType(setup, usb.LIBUSB_ENDPOINT_OUT);
const buffer = data ? Buffer.from(data) : Buffer.alloc(0);
const bytesWritten = <number>await this.controlTransferAsync(type, setup.request, setup.value, setup.index, buffer);
return {
bytesWritten,
status: 'ok'
};
} catch (error) {
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_STALL) {
return {
bytesWritten: 0,
status: 'stall'
};
}
throw new Error(`controlTransferOut error: ${error}`);
}
}
public async clearHalt(direction: USBDirection, endpointNumber: number): Promise<void> {
try {
const wIndex = endpointNumber | (direction === 'in' ? usb.LIBUSB_ENDPOINT_IN : usb.LIBUSB_ENDPOINT_OUT);
await this.controlTransferAsync(usb.LIBUSB_RECIPIENT_ENDPOINT, CLEAR_FEATURE, ENDPOINT_HALT, wIndex, Buffer.from(new Uint8Array()));
} catch (error) {
throw new Error(`clearHalt error: ${error}`);
}
}
public async transferIn(endpointNumber: number, length: number): Promise<USBInTransferResult> {
try {
this.checkDeviceOpen();
const endpoint = this.getEndpoint(endpointNumber | usb.LIBUSB_ENDPOINT_IN) as InEndpoint;
const result = await endpoint.transferAsync(length);
return {
data: result ? new DataView(new Uint8Array(result).buffer) : undefined,
status: 'ok'
};
} catch (error) {
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_STALL) {
return {
status: 'stall'
};
}
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_OVERFLOW) {
return {
status: 'babble'
};
}
throw new Error(`transferIn error: ${error}`);
}
}
public async transferOut(endpointNumber: number, data: ArrayBuffer): Promise<USBOutTransferResult> {
try {
this.checkDeviceOpen();
const endpoint = this.getEndpoint(endpointNumber | usb.LIBUSB_ENDPOINT_OUT) as OutEndpoint;
const buffer = Buffer.from(data);
const bytesWritten = await endpoint.transferAsync(buffer);
return {
bytesWritten,
status: 'ok'
};
} catch (error) {
if ((error as usb.LibUSBException).errno === usb.LIBUSB_TRANSFER_STALL) {
return {
bytesWritten: 0,
status: 'stall'
};
}
throw new Error(`transferOut error: ${error}`);
}
}
public async reset(): Promise<void> {
try {
await this.resetAsync();
} catch (error) {
throw new Error(`reset error: ${error}`);
}
}
public async isochronousTransferIn(_endpointNumber: number, _packetLengths: number[]): Promise<USBIsochronousInTransferResult> {
throw new Error('isochronousTransferIn error: method not implemented');
}
public async isochronousTransferOut(_endpointNumber: number, _data: BufferSource, _packetLengths: number[]): Promise<USBIsochronousOutTransferResult> {
throw new Error('isochronousTransferOut error: method not implemented');
}
public async forget(): Promise<void> {
throw new Error('forget error: method not implemented');
}
private async initialize(): Promise<void> {
try {
if (!this.opened) {
this.device.open();
// Explicitly set configuration for vendor-specific devices on macos
// https://github.com/node-usb/node-usb/issues/61
if (this.deviceClass === 0xff && platform() === 'darwin') {
await this.setConfigurationAsync(1);
}
}
this.manufacturerName = await this.getStringDescriptor(this.device.deviceDescriptor.iManufacturer);
this.productName = await this.getStringDescriptor(this.device.deviceDescriptor.iProduct);
this.serialNumber = await this.getStringDescriptor(this.device.deviceDescriptor.iSerialNumber);
this.configurations = await this.getConfigurations();
} catch (error) {
throw new Error(`initialize error: ${error}`);
} finally {
if (this.opened) {
this.device.close();
}
}
}
private decodeVersion(version: number): { [key: string]: number } {
const hex = `0000${version.toString(16)}`.slice(-4);
return {
major: parseInt(hex.substr(0, 2), undefined),
minor: parseInt(hex.substr(2, 1), undefined),
sub: parseInt(hex.substr(3, 1), undefined),
};
}
private async getStringDescriptor(index: number): Promise<string> {
try {
const buffer = await this.getStringDescriptorAsync(index);
return buffer ? buffer.toString() : '';
} catch (error) {
return '';
}
}
private async getConfigurations(): Promise<USBConfiguration[]> {
const configs: USBConfiguration[] = [];
for (const config of this.device.allConfigDescriptors) {
const interfaces: USBInterface[] = [];
for (const iface of config.interfaces) {
const alternates: USBAlternateInterface[] = [];
for (const alternate of iface) {
const endpoints: USBEndpoint[] = [];
for (const endpoint of alternate.endpoints) {
endpoints.push({
endpointNumber: endpoint.bEndpointAddress & ENDPOINT_NUMBER_MASK,
direction: endpoint.bEndpointAddress & usb.LIBUSB_ENDPOINT_IN ? 'in' : 'out',
type: (endpoint.bmAttributes & LIBUSB_TRANSFER_TYPE_MASK) === usb.LIBUSB_TRANSFER_TYPE_BULK ? 'bulk'
: (endpoint.bmAttributes & LIBUSB_TRANSFER_TYPE_MASK) === usb.LIBUSB_TRANSFER_TYPE_INTERRUPT ? 'interrupt'
: 'isochronous',
packetSize: endpoint.wMaxPacketSize
});
}
alternates.push({
alternateSetting: alternate.bAlternateSetting,
interfaceClass: alternate.bInterfaceClass,
interfaceSubclass: alternate.bInterfaceSubClass,
interfaceProtocol: alternate.bInterfaceProtocol,
interfaceName: await this.getStringDescriptor(alternate.iInterface),
endpoints
});
}
const interfaceNumber = iface[0].bInterfaceNumber;
const alternate = alternates.find(alt => alt.alternateSetting === this.device.interface(interfaceNumber).altSetting);
if (alternate) {
interfaces.push({
interfaceNumber,
alternate,
alternates,
claimed: false
});
}
}
configs.push({
configurationValue: config.bConfigurationValue,
configurationName: await this.getStringDescriptor(config.iConfiguration),
interfaces
});
}
return configs;
}
private getEndpoint(address: number): Endpoint | undefined {
if (!this.device.interfaces) {
return undefined;
}
for (const iface of this.device.interfaces) {
const endpoint = iface.endpoint(address);
if (endpoint) {
return endpoint;
}
}
return undefined;
}
private controlTransferParamsToType(setup: USBControlTransferParameters, direction: number): number {
const recipient = setup.recipient === 'device' ? usb.LIBUSB_RECIPIENT_DEVICE
: setup.recipient === 'interface' ? usb.LIBUSB_RECIPIENT_INTERFACE
: setup.recipient === 'endpoint' ? usb.LIBUSB_RECIPIENT_ENDPOINT
: usb.LIBUSB_RECIPIENT_OTHER;
const requestType = setup.requestType === 'standard' ? usb.LIBUSB_REQUEST_TYPE_STANDARD
: setup.requestType === 'class' ? usb.LIBUSB_REQUEST_TYPE_CLASS
: usb.LIBUSB_REQUEST_TYPE_VENDOR;
return recipient | requestType | direction;
}
private async _releaseInterface(interfaceNumber: number): Promise<void> {
if (!this.opened) {
throw new Error('releaseInterface error: invalid state');
}
if (!this.configuration) {
throw new Error('releaseInterface error: interface not found');
}
const iface = this.configuration.interfaces.find(usbInterface => usbInterface.interfaceNumber === interfaceNumber);
if (!iface) {
throw new Error('releaseInterface error: interface not found');
}
if (!iface.claimed) {
return;
}
try {
const iface = this.device.interface(interfaceNumber);
await iface.releaseAsync();
} catch (error) {
throw new Error(`releaseInterface error: ${error}`);
}
}
private checkDeviceOpen(): void {
if (!this.opened) {
throw new Error('The device must be opened first');
}
}
}