Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/core/vmkapi_bus.h
d0a14f973771
4.4 KiB
text/x-chdr
ESXi-5.0-U1
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 | /***************************************************************************
* Copyright 2010 VMware, Inc. All rights reserved.
***************************************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Bus */ /**
* \addtogroup Device
* @{
* \defgroup Bus Bus interface
* @{
***********************************************************************
*/
#ifndef _VMKAPI_BUS_H_
#define _VMKAPI_BUS_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
typedef struct vmkBusType* vmk_BusType;
/** \brief A null bustype handle. */
#define VMK_BUSTYPE_NONE ((vmk_BusType)0)
typedef struct {
/** Module registering the bustype */
vmk_ModuleID moduleID;
/** Name of bustype */
vmk_Name name;
} vmk_BusTypeProps;
/*
***********************************************************************
* vmk_BusTypeRegister -- */ /**
*
* \brief Register a bus type with the device subsystem.
*
* \note This function will not block.
*
* \param[in] busProps Bus type description data.
* \param[out] busHandle Handle to registered bus type.
*
* \retval VMK_OK Success.
* \retval VMK_EXISTS Bus type is already registered.
* \retval VMK_NO_MEMORY Unable to allocate memory for bus type handle.
* \retval VMK_BAD_PARAM Input parameter is invalid.
*
***********************************************************************
*/
VMK_ReturnStatus
vmk_BusTypeRegister(vmk_BusTypeProps *busProps,
vmk_BusType *busHandle);
/*
***********************************************************************
* vmk_BusTypeUnregister -- */ /**
*
* \brief Unregister a bus type.
*
* \note This function will not block.
*
* \param[in] busHandle Handle to registered bus type.
*
* \retval VMK_OK Success
* \retval VMK_BAD_PARAM No bus type object matching given handle.
*
***********************************************************************
*/
VMK_ReturnStatus
vmk_BusTypeUnregister(vmk_BusType busHandle);
/*
***********************************************************************
* vmk_BusTypeFind -- */ /**
*
* \brief Return a reference to the bus type object registered with
* given name.
*
* \note Reference must be freed using vmk_BusTypeRelease.
*
* \note This function will not block.
*
* \param[in] name Name of bus type
* \param[out] busHandle Handle to bus type object.
*
* \retval VMK_OK Success
* \retval VMK_NOT_FOUND No bus type object matching given name.
*
***********************************************************************
*/
VMK_ReturnStatus
vmk_BusTypeFind(vmk_Name *name,
vmk_BusType *busHandle);
/*
***********************************************************************
* vmk_BusTypeRelease -- */ /**
*
* \brief Release a reference to a bus type object obtained using one
* of the search functions.
*
* \note If last reference was released bus type object may be freed.
*
* \note This function will not block.
*
* \param[in] busHandle Bus type handle to release.
*
* \retval VMK_OK Success
* \retval VMK_BAD_PARAM No bus type object matching given handle.
*
***********************************************************************
*/
VMK_ReturnStatus
vmk_BusTypeRelease(vmk_BusType busHandle);
/*
***********************************************************************
* vmk_BusTypeGetName -- */ /**
*
* \brief Find the name of the bus type for given bus type handle.
*
* \note This function will not block.
*
*
* \param[in] busHandle Bus type handle to find name for.
* \param[out] name Name of bus type.
*
* \retval VMK_OK Success
* \retval VMK_BAD_PARAM No bus type object matching given handle.
*
***********************************************************************
*/
VMK_ReturnStatus
vmk_BusTypeGetName(vmk_BusType busHandle,
vmk_Name *name);
#endif /* _VMKAPI_BUS_H_ */
/** @} */
/** @} */
|