Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/base/vmkapi_config.h
d0a14f973771
5.8 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 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | /* **********************************************************
* Copyright 2008 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Configuration */ /**
* \defgroup Configuration Configuration Options
*
* The configuration option interface allows access to kernel
* configuration options set by the user.
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_CONFIG_H_
#define _VMKAPI_CONFIG_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 */
/*
* Useful configuration group and parameter names
*/
/** \brief Misc parameter group name */
#define VMK_CONFIG_GROUP_MISC "Misc"
/** \brief Disk parameter group name */
#define VMK_CONFIG_GROUP_DISK "Disk"
/** \brief Scsi parameter group name */
#define VMK_CONFIG_GROUP_SCSI "Scsi"
/** \brief Net parameter group name */
#define VMK_CONFIG_GROUP_NET "Net"
/** \brief Nmp parameter group name */
#define VMK_CONFIG_GROUP_NMP "Nmp"
/** \brief Host Name parameter name */
#define VMK_CONFIG_PARAM_HOSTNAME "HostName"
/** \brief Host IP Address parameter name */
#define VMK_CONFIG_PARAM_MGMT_IPADDR "ManagementAddr"
/**
* \brief Opaque handle to a configuration parameter.
*/
typedef vmk_uint64 vmk_ConfigParamHandle;
/*
***********************************************************************
* vmk_ConfigParamOpen -- */ /**
*
* \ingroup Configuration
* \brief Open a handle to a configuration parameter.
*
* \note This function will not block.
*
* \param[in] groupName A functional group name associated with
* configuration parameter.
* \param[in] paramName A parameter name.
* \param[out] handle Handle to the configuration parameter.
*
* \retval VMK_BAD_PARAM The group name or configuration parameter
* name was invalid.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_ConfigParamOpen(
const char *groupName,
const char *paramName,
vmk_ConfigParamHandle *handle);
/*
***********************************************************************
* vmk_ConfigParamClose -- */ /**
*
* \ingroup Configuration
* \brief Close a handle to a configuration parameter.
*
* \note This function will not block.
*
* \param[in] handle Handle to the configuration parameter.
*
* \retval VMK_BAD_PARAM The configuration handle was invalid
*
***********************************************************************
*/
VMK_ReturnStatus vmk_ConfigParamClose(
vmk_ConfigParamHandle handle);
/*
***********************************************************************
* vmk_ConfigParamGetUint -- */ /**
*
* \ingroup Configuration
* \brief Get an UInt value associated with a configuration parameter
* handle.
*
* \note This function will not block.
*
* \param[in] handle Handle to the configuration parameter.
* \param[out] value unsigned integer value associated with
* configuration parameter handle.
*
* \retval VMK_BAD_PARAM Invalid handle or there is no unsigned.
* integer value associated with the handle.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_ConfigParamGetUint(
vmk_ConfigParamHandle handle,
unsigned *value);
/*
***********************************************************************
* vmk_ConfigParamGetStringSize -- */ /**
*
* \ingroup Configuration
* \brief Get size of a buffer required to hold string value associated
* with a configuration parameter handle.
*
* \note This function will not block.
*
* \param[in] handle Handle to the configuration parameter.
* \param[out] size Size of the buffer required to hold
* string value (including terminating nul)
* associated with configuration parameter
* handle.
*
* \retval VMK_BAD_PARAM Invalid handle or there is no string value
* associated with the handle
*
***********************************************************************
*/
VMK_ReturnStatus vmk_ConfigParamGetStringSize(
vmk_ConfigParamHandle handle,
vmk_ByteCount *size);
/*
***********************************************************************
* vmk_ConfigParamGetString -- */ /**
*
* \ingroup Configuration
* \brief Get a string value associated with a configuration parameter
* handle.
*
* \note This function will not block.
*
* \param[in] handle Handle to the configuration parameter
* \param[out] value Location for a value associated with
* configuration parameter handle to be
* copied to.
* \param[in] size Size of the buffer in bytes. The buffer
* should have enough room for a terminating
* nul.
*
* \retval VMK_BAD_PARAM Invalid handle or there is no
* string value associated with the
* handle.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_ConfigParamGetString(
vmk_ConfigParamHandle handle,
char *value,
vmk_ByteCount size);
#endif
/** @} */
|