Files
@ d0a14f973771
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public/vmkernel64/release/base/vmkapi_system.h
d0a14f973771
4.5 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 | /* **********************************************************
* Copyright 1998 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* System */ /**
*
* \defgroup System General Kernel System Interfaces
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_SYSTEM_H_
#define _VMKAPI_SYSTEM_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 */
/**
* \brief
* The maximum length of a system version info string including the
* trailing nul.
*/
#define VMK_SYSTEM_VERSION_INFO_MAX_LEN 32
/** \brief A reboot handler callback */
typedef void (*vmk_RebootHandler)(void *data);
/**
* \brief States for a vmkernel system.
*/
typedef enum {
/** \brief System is in a normal running state */
VMK_SYSTEM_STATE_NORMAL=0,
/** \brief System is currently panicing */
VMK_SYSTEM_STATE_PANIC=1,
/** \brief System is currently shutting down/rebooting */
VMK_SYSTEM_STATE_UNLOADING=2
} vmk_SystemState;
/**
* \brief General-interest version and name information about vmkernel
*/
typedef struct {
const char *productName;
const char *productVersion;
const char *buildVersion;
} vmk_SystemVersionInfo;
/*
***********************************************************************
* vmk_RegisterRebootHandler -- */ /**
*
* \ingroup System
* \brief Register a handler to be called before reboot.
*
* \note This function will not block
*
* \param[in] handler Handler function to call before reboot.
* \param[in] data Pointer to be passed to reboot handler function.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_RegisterRebootHandler(
vmk_RebootHandler handler, void *data);
/*
***********************************************************************
* vmk_UnregisterRebootHandler -- */ /**
*
* \ingroup System
* \brief Unregister a reboot handler.
*
* \note This function will not block
*
* \param[in] handler Handler function to unregister.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_UnregisterRebootHandler(
vmk_RebootHandler handler);
/*
***********************************************************************
* vmk_SystemCheckState -- */ /**
*
* \ingroup System
* \brief Check if the system is in a particular state.
*
* \note A system may be in more than one state simultaneously.
*
* \note This is a snapshot of the state at the time of the call and
* is subject to change.
*
* \note This function will not block
*
* \param[in] state State to check for.
*
* \retval VMK_TRUE The system is in the specified state.
* \retval VMK_FALSE The system is not in the specified state.
*
***********************************************************************
*/
vmk_Bool vmk_SystemCheckState(
vmk_SystemState state);
/*
***********************************************************************
* vmk_SystemGetIDString -- */ /**
*
* \ingroup System
* \brief Get a persistent system identifier string.
*
* \note The identifier string conforms to the string
* representation cited in section three of RFC 4122.
*
* \note This function will not block
*
* \param[out] id The identifier string.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_SystemGetIDString(
const char *id[]);
/*
***********************************************************************
* vmk_SystemGetVersionInfo -- */ /**
*
* \ingroup System
* \brief Get string-style version information about vmkernel, for
* display purposes only. No run-time checks should be
* performed on the result of this call.
*
* \note This function will not block
*
* \param[out] info Version information about vmkernel for display
* purposes.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_SystemGetVersionInfo(
vmk_SystemVersionInfo *info);
#endif /* _VMKAPI_SYSTEM_H_ */
/** @} */
|