1 | /* $Id: UsbTestServiceGadgetCfg.cpp 82968 2020-02-04 10:35:17Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * UsbTestServ - Remote USB test configuration and execution server, USB gadget Cfg API.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2016-2020 Oracle Corporation
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
---|
10 | * available from http://www.virtualbox.org. This file is free software;
|
---|
11 | * you can redistribute it and/or modify it under the terms of the GNU
|
---|
12 | * General Public License (GPL) as published by the Free Software
|
---|
13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
---|
14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
---|
15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
---|
16 | *
|
---|
17 | * The contents of this file may alternatively be used under the terms
|
---|
18 | * of the Common Development and Distribution License Version 1.0
|
---|
19 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
---|
20 | * VirtualBox OSE distribution, in which case the provisions of the
|
---|
21 | * CDDL are applicable instead of those of the GPL.
|
---|
22 | *
|
---|
23 | * You may elect to license modified versions of this file under the
|
---|
24 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
25 | */
|
---|
26 |
|
---|
27 |
|
---|
28 | /*********************************************************************************************************************************
|
---|
29 | * Header Files *
|
---|
30 | *********************************************************************************************************************************/
|
---|
31 | #include <iprt/cdefs.h>
|
---|
32 | #include <iprt/ctype.h>
|
---|
33 | #include <iprt/err.h>
|
---|
34 | #include <iprt/mem.h>
|
---|
35 | #include <iprt/string.h>
|
---|
36 |
|
---|
37 | #include "UsbTestServiceGadget.h"
|
---|
38 |
|
---|
39 |
|
---|
40 | /*********************************************************************************************************************************
|
---|
41 | * Internal Functions *
|
---|
42 | *********************************************************************************************************************************/
|
---|
43 |
|
---|
44 | /**
|
---|
45 | * Returns the gadget configuration item matching the given key.
|
---|
46 | *
|
---|
47 | * @returns Pointer to the configuration item on success or NULL if not found.
|
---|
48 | * @param paCfg The configuration item array.
|
---|
49 | * @param pszKey The key to look for.
|
---|
50 | */
|
---|
51 | static PCUTSGADGETCFGITEM utsGadgetCfgGetItemFromKey(PCUTSGADGETCFGITEM paCfg, const char *pszKey)
|
---|
52 | {
|
---|
53 | while ( paCfg
|
---|
54 | && paCfg->pszKey)
|
---|
55 | {
|
---|
56 | if (!RTStrCmp(paCfg->pszKey, pszKey))
|
---|
57 | return paCfg;
|
---|
58 |
|
---|
59 | paCfg++;
|
---|
60 | }
|
---|
61 | return NULL;
|
---|
62 | }
|
---|
63 |
|
---|
64 |
|
---|
65 |
|
---|
66 | DECLHIDDEN(int) utsGadgetCfgQueryBool(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
67 | bool *pf)
|
---|
68 | {
|
---|
69 | int rc = VERR_NOT_FOUND;
|
---|
70 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
71 |
|
---|
72 | if (pCfgItem)
|
---|
73 | {
|
---|
74 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_BOOLEAN)
|
---|
75 | {
|
---|
76 | *pf = pCfgItem->Val.u.f;
|
---|
77 | rc = VINF_SUCCESS;
|
---|
78 | }
|
---|
79 | else
|
---|
80 | rc = VERR_INVALID_PARAMETER;
|
---|
81 | }
|
---|
82 |
|
---|
83 | return rc;
|
---|
84 | }
|
---|
85 |
|
---|
86 |
|
---|
87 | DECLHIDDEN(int) utsGadgetCfgQueryBoolDef(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
88 | bool *pf, bool fDef)
|
---|
89 | {
|
---|
90 | int rc = VERR_INVALID_PARAMETER;
|
---|
91 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
92 |
|
---|
93 | if ( !pCfgItem
|
---|
94 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_BOOLEAN)
|
---|
95 | {
|
---|
96 | *pf = pCfgItem ? pCfgItem->Val.u.f : fDef;
|
---|
97 | rc = VINF_SUCCESS;
|
---|
98 | }
|
---|
99 |
|
---|
100 | return rc;
|
---|
101 | }
|
---|
102 |
|
---|
103 |
|
---|
104 | DECLHIDDEN(int) utsGadgetCfgQueryString(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
105 | char **ppszVal)
|
---|
106 | {
|
---|
107 | int rc = VERR_NOT_FOUND;
|
---|
108 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
109 |
|
---|
110 | if (pCfgItem)
|
---|
111 | {
|
---|
112 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_STRING)
|
---|
113 | {
|
---|
114 | *ppszVal = RTStrDup(pCfgItem->Val.u.psz);
|
---|
115 | if (*ppszVal)
|
---|
116 | rc = VINF_SUCCESS;
|
---|
117 | else
|
---|
118 | rc = VERR_NO_STR_MEMORY;
|
---|
119 | }
|
---|
120 | else
|
---|
121 | rc = VERR_INVALID_PARAMETER;
|
---|
122 | }
|
---|
123 |
|
---|
124 | return rc;
|
---|
125 | }
|
---|
126 |
|
---|
127 |
|
---|
128 | DECLHIDDEN(int) utsGadgetCfgQueryStringDef(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
129 | char **ppszVal, const char *pszDef)
|
---|
130 | {
|
---|
131 | int rc = VERR_NOT_FOUND;
|
---|
132 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
133 |
|
---|
134 | if ( !pCfgItem
|
---|
135 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_STRING)
|
---|
136 | {
|
---|
137 | *ppszVal = RTStrDup(pCfgItem ? pCfgItem->Val.u.psz : pszDef);
|
---|
138 | if (*ppszVal)
|
---|
139 | rc = VINF_SUCCESS;
|
---|
140 | else
|
---|
141 | rc = VERR_NO_STR_MEMORY;
|
---|
142 | }
|
---|
143 | else
|
---|
144 | rc = VERR_INVALID_PARAMETER;
|
---|
145 |
|
---|
146 | return rc;
|
---|
147 | }
|
---|
148 |
|
---|
149 |
|
---|
150 | DECLHIDDEN(int) utsGadgetCfgQueryU8(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
151 | uint8_t *pu8)
|
---|
152 | {
|
---|
153 | int rc = VERR_NOT_FOUND;
|
---|
154 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
155 |
|
---|
156 | if (pCfgItem)
|
---|
157 | {
|
---|
158 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT8)
|
---|
159 | {
|
---|
160 | *pu8 = pCfgItem->Val.u.u8;
|
---|
161 | rc = VINF_SUCCESS;
|
---|
162 | }
|
---|
163 | else
|
---|
164 | rc = VERR_INVALID_PARAMETER;
|
---|
165 | }
|
---|
166 |
|
---|
167 | return rc;
|
---|
168 | }
|
---|
169 |
|
---|
170 |
|
---|
171 | DECLHIDDEN(int) utsGadgetCfgQueryU8Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
172 | uint8_t *pu8, uint8_t u8Def)
|
---|
173 | {
|
---|
174 | int rc = VERR_INVALID_PARAMETER;
|
---|
175 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
176 |
|
---|
177 | if ( !pCfgItem
|
---|
178 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT8)
|
---|
179 | {
|
---|
180 | *pu8 = pCfgItem ? pCfgItem->Val.u.u8 : u8Def;
|
---|
181 | rc = VINF_SUCCESS;
|
---|
182 | }
|
---|
183 |
|
---|
184 | return rc;
|
---|
185 | }
|
---|
186 |
|
---|
187 |
|
---|
188 | DECLHIDDEN(int) utsGadgetCfgQueryU16(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
189 | uint16_t *pu16)
|
---|
190 | {
|
---|
191 | int rc = VERR_NOT_FOUND;
|
---|
192 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
193 |
|
---|
194 | if (pCfgItem)
|
---|
195 | {
|
---|
196 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT16)
|
---|
197 | {
|
---|
198 | *pu16 = pCfgItem->Val.u.u16;
|
---|
199 | rc = VINF_SUCCESS;
|
---|
200 | }
|
---|
201 | else
|
---|
202 | rc = VERR_INVALID_PARAMETER;
|
---|
203 | }
|
---|
204 |
|
---|
205 | return rc;
|
---|
206 | }
|
---|
207 |
|
---|
208 |
|
---|
209 | DECLHIDDEN(int) utsGadgetCfgQueryU16Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
210 | uint16_t *pu16, uint16_t u16Def)
|
---|
211 | {
|
---|
212 | int rc = VERR_INVALID_PARAMETER;
|
---|
213 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
214 |
|
---|
215 | if ( !pCfgItem
|
---|
216 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT16)
|
---|
217 | {
|
---|
218 | *pu16 = pCfgItem ? pCfgItem->Val.u.u16 : u16Def;
|
---|
219 | rc = VINF_SUCCESS;
|
---|
220 | }
|
---|
221 |
|
---|
222 | return rc;
|
---|
223 | }
|
---|
224 |
|
---|
225 |
|
---|
226 | DECLHIDDEN(int) utsGadgetCfgQueryU32(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
227 | uint32_t *pu32)
|
---|
228 | {
|
---|
229 | int rc = VERR_NOT_FOUND;
|
---|
230 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
231 |
|
---|
232 | if (pCfgItem)
|
---|
233 | {
|
---|
234 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT32)
|
---|
235 | {
|
---|
236 | *pu32 = pCfgItem->Val.u.u32;
|
---|
237 | rc = VINF_SUCCESS;
|
---|
238 | }
|
---|
239 | else
|
---|
240 | rc = VERR_INVALID_PARAMETER;
|
---|
241 | }
|
---|
242 |
|
---|
243 | return rc;
|
---|
244 | }
|
---|
245 |
|
---|
246 |
|
---|
247 | DECLHIDDEN(int) utsGadgetCfgQueryU32Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
248 | uint32_t *pu32, uint32_t u32Def)
|
---|
249 | {
|
---|
250 | int rc = VERR_INVALID_PARAMETER;
|
---|
251 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
252 |
|
---|
253 | if ( !pCfgItem
|
---|
254 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT32)
|
---|
255 | {
|
---|
256 | *pu32 = pCfgItem ? pCfgItem->Val.u.u32 : u32Def;
|
---|
257 | rc = VINF_SUCCESS;
|
---|
258 | }
|
---|
259 |
|
---|
260 | return rc;
|
---|
261 | }
|
---|
262 |
|
---|
263 |
|
---|
264 | DECLHIDDEN(int) utsGadgetCfgQueryU64(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
265 | uint64_t *pu64)
|
---|
266 | {
|
---|
267 | int rc = VERR_NOT_FOUND;
|
---|
268 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
269 |
|
---|
270 | if (pCfgItem)
|
---|
271 | {
|
---|
272 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT64)
|
---|
273 | {
|
---|
274 | *pu64 = pCfgItem->Val.u.u64;
|
---|
275 | rc = VINF_SUCCESS;
|
---|
276 | }
|
---|
277 | else
|
---|
278 | rc = VERR_INVALID_PARAMETER;
|
---|
279 | }
|
---|
280 |
|
---|
281 | return rc;
|
---|
282 | }
|
---|
283 |
|
---|
284 |
|
---|
285 | DECLHIDDEN(int) utsGadgetCfgQueryU64Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
286 | uint64_t *pu64, uint64_t u64Def)
|
---|
287 | {
|
---|
288 | int rc = VERR_INVALID_PARAMETER;
|
---|
289 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
290 |
|
---|
291 | if ( !pCfgItem
|
---|
292 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_UINT64)
|
---|
293 | {
|
---|
294 | *pu64 = pCfgItem ? pCfgItem->Val.u.u64 : u64Def;
|
---|
295 | rc = VINF_SUCCESS;
|
---|
296 | }
|
---|
297 |
|
---|
298 | return rc;
|
---|
299 | }
|
---|
300 |
|
---|
301 |
|
---|
302 | DECLHIDDEN(int) utsGadgetCfgQueryS8(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
303 | int8_t *pi8)
|
---|
304 | {
|
---|
305 | int rc = VERR_NOT_FOUND;
|
---|
306 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
307 |
|
---|
308 | if (pCfgItem)
|
---|
309 | {
|
---|
310 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT8)
|
---|
311 | {
|
---|
312 | *pi8 = pCfgItem->Val.u.i8;
|
---|
313 | rc = VINF_SUCCESS;
|
---|
314 | }
|
---|
315 | else
|
---|
316 | rc = VERR_INVALID_PARAMETER;
|
---|
317 | }
|
---|
318 |
|
---|
319 | return rc;
|
---|
320 | }
|
---|
321 |
|
---|
322 |
|
---|
323 | DECLHIDDEN(int) utsGadgetCfgQueryS8Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
324 | int8_t *pi8, uint8_t i8Def)
|
---|
325 | {
|
---|
326 | int rc = VERR_INVALID_PARAMETER;
|
---|
327 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
328 |
|
---|
329 | if ( !pCfgItem
|
---|
330 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT8)
|
---|
331 | {
|
---|
332 | *pi8 = pCfgItem ? pCfgItem->Val.u.i8 : i8Def;
|
---|
333 | rc = VINF_SUCCESS;
|
---|
334 | }
|
---|
335 |
|
---|
336 | return rc;
|
---|
337 | }
|
---|
338 |
|
---|
339 |
|
---|
340 | DECLHIDDEN(int) utsGadgetCfgQueryS16(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
341 | uint16_t *pi16)
|
---|
342 | {
|
---|
343 | int rc = VERR_NOT_FOUND;
|
---|
344 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
345 |
|
---|
346 | if (pCfgItem)
|
---|
347 | {
|
---|
348 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT16)
|
---|
349 | {
|
---|
350 | *pi16 = pCfgItem->Val.u.i16;
|
---|
351 | rc = VINF_SUCCESS;
|
---|
352 | }
|
---|
353 | else
|
---|
354 | rc = VERR_INVALID_PARAMETER;
|
---|
355 | }
|
---|
356 |
|
---|
357 | return rc;
|
---|
358 | }
|
---|
359 |
|
---|
360 |
|
---|
361 | DECLHIDDEN(int) utsGadgetCfgQueryS16Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
362 | uint16_t *pi16, uint16_t i16Def)
|
---|
363 | {
|
---|
364 | int rc = VERR_INVALID_PARAMETER;
|
---|
365 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
366 |
|
---|
367 | if ( !pCfgItem
|
---|
368 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT16)
|
---|
369 | {
|
---|
370 | *pi16 = pCfgItem ? pCfgItem->Val.u.i16 : i16Def;
|
---|
371 | rc = VINF_SUCCESS;
|
---|
372 | }
|
---|
373 |
|
---|
374 | return rc;
|
---|
375 | }
|
---|
376 |
|
---|
377 |
|
---|
378 | DECLHIDDEN(int) utsGadgetCfgQueryS32(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
379 | uint32_t *pi32)
|
---|
380 | {
|
---|
381 | int rc = VERR_NOT_FOUND;
|
---|
382 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
383 |
|
---|
384 | if (pCfgItem)
|
---|
385 | {
|
---|
386 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT32)
|
---|
387 | {
|
---|
388 | *pi32 = pCfgItem->Val.u.i32;
|
---|
389 | rc = VINF_SUCCESS;
|
---|
390 | }
|
---|
391 | else
|
---|
392 | rc = VERR_INVALID_PARAMETER;
|
---|
393 | }
|
---|
394 |
|
---|
395 | return rc;
|
---|
396 | }
|
---|
397 |
|
---|
398 |
|
---|
399 | DECLHIDDEN(int) utsGadgetCfgQueryS32Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
400 | uint32_t *pi32, uint32_t i32Def)
|
---|
401 | {
|
---|
402 | int rc = VERR_INVALID_PARAMETER;
|
---|
403 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
404 |
|
---|
405 | if ( !pCfgItem
|
---|
406 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT32)
|
---|
407 | {
|
---|
408 | *pi32 = pCfgItem ? pCfgItem->Val.u.i32 : i32Def;
|
---|
409 | rc = VINF_SUCCESS;
|
---|
410 | }
|
---|
411 |
|
---|
412 | return rc;
|
---|
413 | }
|
---|
414 |
|
---|
415 |
|
---|
416 | DECLHIDDEN(int) utsGadgetCfgQueryS64(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
417 | uint64_t *pi64)
|
---|
418 | {
|
---|
419 | int rc = VERR_NOT_FOUND;
|
---|
420 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
421 |
|
---|
422 | if (pCfgItem)
|
---|
423 | {
|
---|
424 | if (pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT64)
|
---|
425 | {
|
---|
426 | *pi64 = pCfgItem->Val.u.i64;
|
---|
427 | rc = VINF_SUCCESS;
|
---|
428 | }
|
---|
429 | else
|
---|
430 | rc = VERR_INVALID_PARAMETER;
|
---|
431 | }
|
---|
432 |
|
---|
433 | return rc;
|
---|
434 | }
|
---|
435 |
|
---|
436 |
|
---|
437 | DECLHIDDEN(int) utsGadgetCfgQueryS64Def(PCUTSGADGETCFGITEM paCfg, const char *pszKey,
|
---|
438 | uint64_t *pi64, uint64_t i64Def)
|
---|
439 | {
|
---|
440 | int rc = VERR_INVALID_PARAMETER;
|
---|
441 | PCUTSGADGETCFGITEM pCfgItem = utsGadgetCfgGetItemFromKey(paCfg, pszKey);
|
---|
442 |
|
---|
443 | if ( !pCfgItem
|
---|
444 | || pCfgItem->Val.enmType == UTSGADGETCFGTYPE_INT64)
|
---|
445 | {
|
---|
446 | *pi64 = pCfgItem ? pCfgItem->Val.u.i64 : i64Def;
|
---|
447 | rc = VINF_SUCCESS;
|
---|
448 | }
|
---|
449 |
|
---|
450 | return rc;
|
---|
451 | }
|
---|
452 |
|
---|