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
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
|
/* $Id: UsbTestServiceGadget.h $ */
/** @file
* UsbTestServ - Remote USB test configuration and execution server, Gadget API.
*/
/*
* Copyright (C) 2016-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef VBOX_INCLUDED_SRC_usb_UsbTestServiceGadget_h
#define VBOX_INCLUDED_SRC_usb_UsbTestServiceGadget_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/types.h>
RT_C_DECLS_BEGIN
/** Opaque gadget host handle. */
typedef struct UTSGADGETHOSTINT *UTSGADGETHOST;
/** Pointer to a gadget host handle. */
typedef UTSGADGETHOST *PUTSGADGETHOST;
/** NIL gadget host handle. */
#define NIL_UTSGADGETHOST ((UTSGADGETHOST)0)
/** Opaque USB gadget handle. */
typedef struct UTSGADGETINT *UTSGADGET;
/** Pointer to a USB gadget handle. */
typedef UTSGADGET *PUTSGADET;
/** NIL gadget handle. */
#define NIL_UTSGADGET ((UTSGADGET)0)
/**
* Gadget/Gadget host configuration item type.
*/
typedef enum UTSGADGETCFGTYPE
{
/** Don't use! */
UTSGADGETCFGTYPE_INVALID = 0,
/** Boolean type. */
UTSGADGETCFGTYPE_BOOLEAN,
/** UTF-8 string. */
UTSGADGETCFGTYPE_STRING,
/** Unsigned 8bit integer. */
UTSGADGETCFGTYPE_UINT8,
/** Unsigned 16bit integer. */
UTSGADGETCFGTYPE_UINT16,
/** Unsigned 32bit integer. */
UTSGADGETCFGTYPE_UINT32,
/** Unsigned 64bit integer. */
UTSGADGETCFGTYPE_UINT64,
/** Signed 8bit integer. */
UTSGADGETCFGTYPE_INT8,
/** Signed 16bit integer. */
UTSGADGETCFGTYPE_INT16,
/** Signed 32bit integer. */
UTSGADGETCFGTYPE_INT32,
/** Signed 64bit integer. */
UTSGADGETCFGTYPE_INT64,
/** 32bit hack. */
UTSGADGETCFGTYPE_32BIT_HACK = 0x7fffffff
} UTSGADGETCFGTYPE;
/**
* Gadget configuration value.
*/
typedef struct UTSGADGETCFGVAL
{
/** Value type */
UTSGADGETCFGTYPE enmType;
/** Value based on the type. */
union
{
bool f;
const char *psz;
uint8_t u8;
uint16_t u16;
uint32_t u32;
uint64_t u64;
int8_t i8;
int16_t i16;
int32_t i32;
int64_t i64;
} u;
} UTSGADGETCFGVAL;
/** Pointer to a gadget configuration value. */
typedef UTSGADGETCFGVAL *PUTSGADGETCFGVAL;
/** Pointer to a const gadget configuration value. */
typedef const UTSGADGETCFGVAL *PCUTSGADGETCFGVAL;
/**
* Gadget configuration item.
*/
typedef struct UTSGADGETCFGITEM
{
/** Item key. */
const char *pszKey;
/** Item value. */
UTSGADGETCFGVAL Val;
} UTSGADGETCFGITEM;
/** Pointer to a gadget configuration item. */
typedef UTSGADGETCFGITEM *PUTSGADGETCFGITEM;
/** Pointer to a const gadget configuration item. */
typedef const UTSGADGETCFGITEM *PCUTSGADGETCFGITEM;
/**
* Type for the gadget host.
*/
typedef enum UTSGADGETHOSTTYPE
{
/** Invalid type, don't use. */
UTSGADGETHOSTTYPE_INVALID = 0,
/** USB/IP host, gadgets are exported using a USB/IP server. */
UTSGADGETHOSTTYPE_USBIP,
/** Physical connection using a device or OTG port. */
UTSGADGETHOSTTYPE_PHYSICAL,
/** 32bit hack. */
UTSGADGETHOSTTYPE_32BIT_HACK = 0x7fffffff
} UTSGADGETHOSTTYPE;
/**
* USB gadget class.
*/
typedef enum UTSGADGETCLASS
{
/** Invalid class, don't use. */
UTSGADGETCLASS_INVALID = 0,
/** Special test device class. */
UTSGADGETCLASS_TEST,
/** MSD device. */
UTSGADGETCLASS_MSD,
/** 32bit hack. */
UTSGADGETCLASS_32BIT_HACK = 0x7fffffff
} UTSGADGETCLASS;
/**
* Queries the value of a given boolean key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pf Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryBool(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
bool *pf);
/**
* Queries the value of a given boolean key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pf Where to store the value on success.
* @param fDef The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryBoolDef(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
bool *pf, bool fDef);
/**
* Queries the string value of a given key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param ppszVal Where to store the pointer to the string on success,
* must be freed with RTStrFree().
*/
DECLHIDDEN(int) utsGadgetCfgQueryString(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
char **ppszVal);
/**
* Queries the string value of a given key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param ppszVal Where to store the pointer to the string on success,
* must be freed with RTStrFree().
* @param pszDef The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryStringDef(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
char **ppszVal, const char *pszDef);
/**
* Queries the value of a given uint8_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu8 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU8(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint8_t *pu8);
/**
* Queries the value of a given uint8_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu8 Where to store the value on success.
* @param u8Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU8Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint8_t *pu8, uint8_t u8Def);
/**
* Queries the value of a given uint16_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu16 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU16(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint16_t *pu16);
/**
* Queries the value of a given uint16_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu16 Where to store the value on success.
* @param u16Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU16Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint16_t *pu16, uint16_t u16Def);
/**
* Queries the value of a given uint32_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu32 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU32(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint32_t *pu32);
/**
* Queries the value of a given uint32_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu32 Where to store the value on success.
* @param u32Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU32Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint32_t *pu32, uint32_t u32Def);
/**
* Queries the value of a given uint64_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu64 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU64(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint64_t *pu64);
/**
* Queries the value of a given uint64_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pu64 Where to store the value on success.
* @param u64Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryU64Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint64_t *pu64, uint64_t u64Def);
/**
* Queries the value of a given int8_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi8 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS8(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
int8_t *pi8);
/**
* Queries the value of a given int8_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi8 Where to store the value on success.
* @param i8Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS8Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
int8_t *pi8, uint8_t i8Def);
/**
* Queries the value of a given int16_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi16 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS16(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint16_t *pi16);
/**
* Queries the value of a given int16_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi16 Where to store the value on success.
* @param i16Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS16Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint16_t *pi16, uint16_t i16Def);
/**
* Queries the value of a given int32_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi32 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS32(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint32_t *pi32);
/**
* Queries the value of a given int32_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi32 Where to store the value on success.
* @param i32Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS32Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint32_t *pi32, uint32_t i32Def);
/**
* Queries the value of a given int64_t key from the given configuration array.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi64 Where to store the value on success.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS64(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint64_t *pi64);
/**
* Queries the value of a given int64_t key from the given configuration array,
* setting a default if not found.
*
* @returns IPRT status code.
* @param paCfg The configuration items.
* @param pszKey The key query the value for.
* @param pi64 Where to store the value on success.
* @param i64Def The default value to assign if the key is not found.
*/
DECLHIDDEN(int) utsGadgetCfgQueryS64Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
uint64_t *pi64, uint64_t i64Def);
/**
* Creates a new USB gadget host.
*
* @returns IPRT status code.
* @param enmType The host type.
* @param paCfg Additional configuration parameters - optional.
* The array must be terminated with a NULL entry.
* @param phGadgetHost Where to store the handle to the gadget host on success.
*/
DECLHIDDEN(int) utsGadgetHostCreate(UTSGADGETHOSTTYPE enmType, PCUTSGADGETCFGITEM paCfg,
PUTSGADGETHOST phGadgetHost);
/**
* Retains the given gadget host handle.
*
* @returns New reference count.
* @param hGadgetHost The gadget host handle to retain.
*/
DECLHIDDEN(uint32_t) utsGadgetHostRetain(UTSGADGETHOST hGadgetHost);
/**
* Releases the given gadget host handle, destroying it if the reference
* count reaches 0.
*
* @returns New reference count.
* @param hGadgetHost The gadget host handle to release.
*/
DECLHIDDEN(uint32_t) utsGadgetHostRelease(UTSGADGETHOST hGadgetHost);
/**
* Returns the current config of the given gadget host.
*
* @returns Pointer to a constant array of configuration items for the given gadget host.
* @param hGadgetHost The gadget host handle.
*/
DECLHIDDEN(PCUTSGADGETCFGITEM) utsGadgetHostGetCfg(UTSGADGETHOST hGadgetHost);
/**
* Connects the given gadget to the host.
*
* @returns IPRT status code.
* @param hGadgetHost The gadget host handle.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(int) utsGadgetHostGadgetConnect(UTSGADGETHOST hGadgetHost, UTSGADGET hGadget);
/**
* Disconnects the given gadget from the host.
*
* @returns IPRT status code.
* @param hGadgetHost The gadget host handle.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(int) utsGadgetHostGadgetDisconnect(UTSGADGETHOST hGadgetHost, UTSGADGET hGadget);
/**
* Creates a new USB gadget based the class.
*
* @returns IPRT status code.
* @param hGadgetHost The gadget host the gadget is part of.
* @param enmClass The gadget class.
* @param paCfg Array of optional configuration items for the gadget.
* @param phGadget Where to store the gadget handle on success.
*/
DECLHIDDEN(int) utsGadgetCreate(UTSGADGETHOST hGadgetHost, UTSGADGETCLASS enmClass,
PCUTSGADGETCFGITEM paCfg, PUTSGADET phGadget);
/**
* Retains the given gadget handle.
*
* @returns New reference count.
* @param hGadget The gadget handle to retain.
*/
DECLHIDDEN(uint32_t) utsGadgetRetain(UTSGADGET hGadget);
/**
* Releases the given gadget handle, destroying it if the reference
* count reaches 0.
*
* @returns New reference count.
* @param hGadget The gadget handle to destroy.
*/
DECLHIDDEN(uint32_t) utsGadgetRelease(UTSGADGET hGadget);
/**
* Returns the current config of the given gadget.
*
* @returns Pointer to a constant array of configuration items for the given gadget.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(PCUTSGADGETCFGITEM) utsGadgetGetCfg(UTSGADGET hGadget);
/**
* Returns the path of the given gadget from which it can be accessed.
*
* @returns Access path.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(const char *) utsGadgetGetAccessPath(UTSGADGET hGadget);
/**
* Returns the bus ID the gadget is on.
*
* @returns Bus ID of the gadget.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(uint32_t) utsGadgetGetBusId(UTSGADGET hGadget);
/**
* Returns the device ID of the gagdet.
*
* @returns Device ID of the gadget.
* @param hGadget The gadget handle.
*/
DECLHIDDEN(uint32_t) utsGadgetGetDevId(UTSGADGET hGadget);
/**
* Mark the gadget as connected to the host. Depending
* on the host type it will be appear as physically attached
* or will appear in the exported USB device list.
*
* @returns IPRT status code.
* @param hGadget The gadget handle to connect.
*/
DECLHIDDEN(int) utsGadgetConnect(UTSGADGET hGadget);
/**
* Mark the gadget as disconnected from the host.
*
* @returns IPRT status code.
* @param hGadget The gadget handle to disconnect.
*/
DECLHIDDEN(int) utsGadgetDisconnect(UTSGADGET hGadget);
RT_C_DECLS_END
#endif /* !VBOX_INCLUDED_SRC_usb_UsbTestServiceGadget_h */
|
