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
|
/** @file
* tstDevice: Plugin API.
*/
/*
* Copyright (C) 2017-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef VBOX_INCLUDED_SRC_testcase_tstDevicePlugin_h
#define VBOX_INCLUDED_SRC_testcase_tstDevicePlugin_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/types.h>
/**
* Config item type.
*/
typedef enum TSTDEVCFGITEMTYPE
{
/** Invalid type. */
TSTDEVCFGITEMTYPE_INVALID = 0,
/** String type. */
TSTDEVCFGITEMTYPE_STRING,
/** Integer value encoded in the string. */
TSTDEVCFGITEMTYPE_INTEGER,
/** Raw bytes. */
TSTDEVCFGITEMTYPE_BYTES,
/** 32bit hack. */
TSTDEVCFGITEMTYPE_32BIT_HACK = 0x7fffffff
} TSTDEVCFGITEMTYPE;
/** Pointer to a config item type. */
typedef TSTDEVCFGITEMTYPE *PTSTDEVCFGITEMTYPE;
/**
* Testcase config item.
*/
typedef struct TSTDEVCFGITEM
{
/** The key of the item. */
const char *pszKey;
/** Type of the config item. */
TSTDEVCFGITEMTYPE enmType;
/** The value of the item (as a string/number of bytes to make static
* instantiation easier). */
const char *pszVal;
} TSTDEVCFGITEM;
/** Pointer to a testcase config item. */
typedef TSTDEVCFGITEM *PTSTDEVCFGITEM;
/** Pointer to a constant testcase config item. */
typedef const TSTDEVCFGITEM *PCTSTDEVCFGITEM;
/** Device under test handle. */
typedef struct TSTDEVDUTINT *TSTDEVDUT;
/**
* Testcase registration structure.
*/
typedef struct TSTDEVTESTCASEREG
{
/** Testcase name. */
char szName[16];
/** Testcase description. */
const char *pszDesc;
/** The device name the testcase handles. */
char szDevName[16];
/** Flags for this testcase. */
uint32_t fFlags;
/** CFGM configuration for the device to be instantiated. */
PCTSTDEVCFGITEM paDevCfg;
/**
* Testcase entry point.
*
* @returns VBox status code.
* @param hDut Handle of the device under test.
*/
DECLR3CALLBACKMEMBER(int, pfnTestEntry, (TSTDEVDUT hDut));
} TSTDEVTESTCASEREG;
/** Pointer to a testcase registration structure. */
typedef TSTDEVTESTCASEREG *PTSTDEVTESTCASEREG;
/** Pointer to a constant testcase registration structure. */
typedef const TSTDEVTESTCASEREG *PCTSTDEVTESTCASEREG;
/**
* Testcase register callbacks structure.
*/
typedef struct TSTDEVPLUGINREGISTER
{
/**
* Registers a new testcase.
*
* @returns VBox status code.
* @param pvUser Opaque user data given in the plugin load callback.
* @param pTestcaseReg The testcase descriptor to register.
*/
DECLR3CALLBACKMEMBER(int, pfnRegisterTestcase, (void *pvUser, PCTSTDEVTESTCASEREG pTestcaseReg));
} TSTDEVPLUGINREGISTER;
/** Pointer to a backend register callbacks structure. */
typedef TSTDEVPLUGINREGISTER *PTSTDEVPLUGINREGISTER;
/**
* Initialization entry point called by the device test framework when
* a plugin is loaded.
*
* @returns VBox status code.
* @param pvUser Opaque user data passed in the register callbacks.
* @param pRegisterCallbacks Pointer to the register callbacks structure.
*/
typedef DECLCALLBACK(int) FNTSTDEVPLUGINLOAD(void *pvUser, PTSTDEVPLUGINREGISTER pRegisterCallbacks);
typedef FNTSTDEVPLUGINLOAD *PFNTSTDEVPLUGINLOAD;
#define TSTDEV_PLUGIN_LOAD_NAME "TSTDevPluginLoad"
#endif /* !VBOX_INCLUDED_SRC_testcase_tstDevicePlugin_h */
|
