VirtualBox

source: vbox/trunk/src/VBox/ValidationKit/utils/usb/UsbTestServiceGadgetHost.cpp@ 103914

Last change on this file since 103914 was 99739, checked in by vboxsync, 19 months ago

*: doxygen corrections (mostly about removing @returns from functions returning void).

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.0 KB
Line 
1/* $Id: UsbTestServiceGadgetHost.cpp 99739 2023-05-11 01:01:08Z vboxsync $ */
2/** @file
3 * UsbTestServ - Remote USB test configuration and execution server, USB gadget host API.
4 */
5
6/*
7 * Copyright (C) 2016-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#include <iprt/asm.h>
42#include <iprt/ctype.h>
43#include <iprt/errcore.h>
44#include <iprt/mem.h>
45#include <iprt/string.h>
46
47#include "UsbTestServiceGadget.h"
48#include "UsbTestServiceGadgetHostInternal.h"
49
50
51/*********************************************************************************************************************************
52* Constants And Macros, Structures and Typedefs *
53*********************************************************************************************************************************/
54
55/**
56 * Internal UTS gadget host instance data.
57 */
58typedef struct UTSGADGETHOSTINT
59{
60 /** Reference counter. */
61 volatile uint32_t cRefs;
62 /** Pointer to the gadget host callback table. */
63 PCUTSGADGETHOSTIF pHstIf;
64 /** Interface specific instance data - variable in size. */
65 uint8_t abIfInst[1];
66} UTSGADGETHOSTINT;
67/** Pointer to the internal gadget host instance data. */
68typedef UTSGADGETHOSTINT *PUTSGADGETHOSTINT;
69
70
71/*********************************************************************************************************************************
72* Global variables *
73*********************************************************************************************************************************/
74
75/** Known gadget host interfaces. */
76static const PCUTSGADGETHOSTIF g_apUtsGadgetHostIf[] =
77{
78 &g_UtsGadgetHostIfUsbIp,
79};
80
81
82/*********************************************************************************************************************************
83* Internal Functions *
84*********************************************************************************************************************************/
85
86
87/**
88 * Destroys a gadget host instance.
89 *
90 * @param pThis The gadget host instance.
91 */
92static void utsGadgetHostDestroy(PUTSGADGETHOSTINT pThis)
93{
94 /** @todo Remove all gadgets. */
95 pThis->pHstIf->pfnTerm((PUTSGADGETHOSTTYPEINT)&pThis->abIfInst[0]);
96 RTMemFree(pThis);
97}
98
99
100DECLHIDDEN(int) utsGadgetHostCreate(UTSGADGETHOSTTYPE enmType, PCUTSGADGETCFGITEM paCfg,
101 PUTSGADGETHOST phGadgetHost)
102{
103 int rc = VINF_SUCCESS;
104 PCUTSGADGETHOSTIF pIf = NULL;
105
106 /* Get the interface. */
107 for (unsigned i = 0; i < RT_ELEMENTS(g_apUtsGadgetHostIf); i++)
108 {
109 if (g_apUtsGadgetHostIf[i]->enmType == enmType)
110 {
111 pIf = g_apUtsGadgetHostIf[i];
112 break;
113 }
114 }
115
116 if (RT_LIKELY(pIf))
117 {
118 PUTSGADGETHOSTINT pThis = (PUTSGADGETHOSTINT)RTMemAllocZ(RT_UOFFSETOF_DYN(UTSGADGETHOSTINT, abIfInst[pIf->cbIf]));
119 if (RT_LIKELY(pThis))
120 {
121 pThis->cRefs = 1;
122 pThis->pHstIf = pIf;
123 rc = pIf->pfnInit((PUTSGADGETHOSTTYPEINT)&pThis->abIfInst[0], paCfg);
124 if (RT_SUCCESS(rc))
125 *phGadgetHost = pThis;
126 else
127 RTMemFree(pThis);
128 }
129 else
130 rc = VERR_NO_MEMORY;
131 }
132 else
133 rc = VERR_INVALID_PARAMETER;
134
135 return rc;
136}
137
138
139DECLHIDDEN(uint32_t) utsGadgetHostRetain(UTSGADGETHOST hGadgetHost)
140{
141 PUTSGADGETHOSTINT pThis = hGadgetHost;
142
143 AssertPtrReturn(pThis, 0);
144
145 return ASMAtomicIncU32(&pThis->cRefs);
146}
147
148
149DECLHIDDEN(uint32_t) utsGadgetHostRelease(UTSGADGETHOST hGadgetHost)
150{
151 PUTSGADGETHOSTINT pThis = hGadgetHost;
152
153 AssertPtrReturn(pThis, 0);
154
155 uint32_t cRefs = ASMAtomicDecU32(&pThis->cRefs);
156 if (!cRefs)
157 utsGadgetHostDestroy(pThis);
158
159 return cRefs;
160}
161
162
163DECLHIDDEN(int) utsGadgetHostGadgetConnect(UTSGADGETHOST hGadgetHost, UTSGADGET hGadget)
164{
165 PUTSGADGETHOSTINT pThis = hGadgetHost;
166
167 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
168 return pThis->pHstIf->pfnGadgetConnect((PUTSGADGETHOSTTYPEINT)&pThis->abIfInst[0], hGadget);
169}
170
171
172DECLHIDDEN(int) utsGadgetHostGadgetDisconnect(UTSGADGETHOST hGadgetHost, UTSGADGET hGadget)
173{
174 PUTSGADGETHOSTINT pThis = hGadgetHost;
175
176 AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
177 return pThis->pHstIf->pfnGadgetDisconnect((PUTSGADGETHOSTTYPEINT)&pThis->abIfInst[0], hGadget);
178}
179
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette