| 1 | /** @file
|
|---|
| 2 | * PDM - Pluggable Device Manager, Common Instance Macros.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2022 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef VBOX_INCLUDED_vmm_pdmins_h
|
|---|
| 27 | #define VBOX_INCLUDED_vmm_pdmins_h
|
|---|
| 28 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 29 | # pragma once
|
|---|
| 30 | #endif
|
|---|
| 31 |
|
|---|
| 32 |
|
|---|
| 33 | /** @defgroup grp_pdm_ins Common PDM Instance Macros
|
|---|
| 34 | * @ingroup grp_pdm
|
|---|
| 35 | * @{
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /** @def PDMBOTHCBDECL
|
|---|
| 39 | * Macro for declaring a callback which is static in HC and exported in GC.
|
|---|
| 40 | */
|
|---|
| 41 | #if defined(IN_RC) || defined(IN_RING0)
|
|---|
| 42 | # ifdef __cplusplus
|
|---|
| 43 | # define PDMBOTHCBDECL(type) extern "C" DECLEXPORT(type)
|
|---|
| 44 | # else
|
|---|
| 45 | # define PDMBOTHCBDECL(type) DECLEXPORT(type)
|
|---|
| 46 | # endif
|
|---|
| 47 | #else
|
|---|
| 48 | # define PDMBOTHCBDECL(type) static DECLCALLBACK(type)
|
|---|
| 49 | #endif
|
|---|
| 50 |
|
|---|
| 51 | /** @def PDMINS_2_DATA
|
|---|
| 52 | * Gets the shared instance data for a PDM device, USB device, or driver instance.
|
|---|
| 53 | * @note For devices using PDMDEVINS_2_DATA is highly recommended.
|
|---|
| 54 | */
|
|---|
| 55 | #define PDMINS_2_DATA(pIns, type) ( (type)(pIns)->CTX_SUFF(pvInstanceData) )
|
|---|
| 56 |
|
|---|
| 57 | /** @def PDMINS_2_DATA_CC
|
|---|
| 58 | * Gets the current context instance data for a PDM device, USB device, or driver instance.
|
|---|
| 59 | * @note For devices using PDMDEVINS_2_DATA_CC is highly recommended.
|
|---|
| 60 | */
|
|---|
| 61 | #define PDMINS_2_DATA_CC(pIns, type) ( (type)(void *)&(pIns)->achInstanceData[0] )
|
|---|
| 62 |
|
|---|
| 63 | /* @def PDMINS_2_DATA_RC
|
|---|
| 64 | * Gets the raw-mode context instance data for a PDM device instance.
|
|---|
| 65 | */
|
|---|
| 66 | #define PDMINS_2_DATA_RC(pIns, type) ( (type)(pIns)->CTX_SUFF(pvInstanceDataForRC) )
|
|---|
| 67 |
|
|---|
| 68 |
|
|---|
| 69 | /** @def PDMINS_2_DATA_RCPTR
|
|---|
| 70 | * Converts a PDM Device, USB Device, or Driver instance pointer to a RC pointer to the instance data.
|
|---|
| 71 | * @deprecated
|
|---|
| 72 | */
|
|---|
| 73 | #define PDMINS_2_DATA_RCPTR(pIns) ( (pIns)->pvInstanceDataRC )
|
|---|
| 74 |
|
|---|
| 75 | /** @def PDMINS_2_DATA_R3PTR
|
|---|
| 76 | * Converts a PDM Device, USB Device, or Driver instance pointer to a HC pointer to the instance data.
|
|---|
| 77 | * @deprecated
|
|---|
| 78 | */
|
|---|
| 79 | #define PDMINS_2_DATA_R3PTR(pIns) ( (pIns)->pvInstanceDataR3 )
|
|---|
| 80 |
|
|---|
| 81 | /** @def PDMINS_2_DATA_R0PTR
|
|---|
| 82 | * Converts a PDM Device, USB Device, or Driver instance pointer to a R0 pointer to the instance data.
|
|---|
| 83 | * @deprecated
|
|---|
| 84 | */
|
|---|
| 85 | #define PDMINS_2_DATA_R0PTR(pIns) ( (pIns)->pvInstanceDataR0 )
|
|---|
| 86 |
|
|---|
| 87 | /** @} */
|
|---|
| 88 |
|
|---|
| 89 | #endif /* !VBOX_INCLUDED_vmm_pdmins_h */
|
|---|
