ChassisAPI.h 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. /*****************************************************************
  2. *****************************************************************
  3. *** **
  4. *** (C)Copyright 2005-2006, American Megatrends Inc. **
  5. *** **
  6. *** All Rights Reserved. **
  7. *** **
  8. *** 6145-F, Northbelt Parkway, Norcross, **
  9. *** **
  10. *** Georgia - 30071, USA. Phone-(770)-246-8600. **
  11. *** **
  12. *****************************************************************
  13. *****************************************************************
  14. ******************************************************************
  15. *
  16. * ChassisAPI.h
  17. * Chassis Access API.
  18. *
  19. * Author: Govind Kothandapani <govindk@ami.com>
  20. *
  21. ******************************************************************/
  22. #ifndef CHASSISAPI_H
  23. #define CHASSISAPI_H
  24. #include "Types.h"
  25. /*-----------------------------------------------------------------
  26. * @fn API_ChassisPowerOff
  27. * @brief Powers off the chassis
  28. * @return 0 if success
  29. * -1 on error
  30. *-----------------------------------------------------------------*/
  31. extern int API_ChassisPowerOff (int BMCInst);
  32. /*-----------------------------------------------------------------
  33. * @fn API_ChassisPowerOn
  34. * @brief Powers on the chassis
  35. * @return 0 if success
  36. * -1 on error
  37. *-----------------------------------------------------------------*/
  38. extern int API_ChassisPowerOn (int BMCInst);
  39. /*-----------------------------------------------------------------
  40. * @fn API_ChassisPowerCycle
  41. * @brief Powers cycles the chassis
  42. * @return 0 if success
  43. * -1 on error
  44. *-----------------------------------------------------------------*/
  45. extern int API_ChassisPowerCycle (int BMCInst);
  46. /*-----------------------------------------------------------------
  47. * @fn API_ChassisPowerReset
  48. * @brief Powers resets the chassis
  49. * @return 0 if success
  50. * -1 on error
  51. *-----------------------------------------------------------------*/
  52. extern int API_ChassisPowerReset (int BMCInst);
  53. /*-----------------------------------------------------------------
  54. * @fn API_ChassisDiagInterrupt
  55. * @brief Generate diagnostic interrupt
  56. * @return 0 if success
  57. * -1 on error
  58. *-----------------------------------------------------------------*/
  59. extern int API_ChassisDiagInterrupt (int BMCInst);
  60. /*-----------------------------------------------------------------
  61. * @fn API_ChassisSMIInterrupt
  62. * @brief Generate SMI Interrupt
  63. * @return 0 if success
  64. * -1 on error
  65. *-----------------------------------------------------------------*/
  66. extern int API_ChassisSMIInterrupt (int BMCInst);
  67. /*-----------------------------------------------------------------
  68. * @fn API_ChassisPwrOnOffCount
  69. * @brief Provides the chassis Power On off count
  70. * @return number of occurences of power on & off.
  71. *-----------------------------------------------------------------*/
  72. extern int API_ChassisPwrOnOffCount (void);
  73. /*-----------------------------------------------------------------
  74. * @fn API_OnSetRestartCause
  75. * @brief Provides the hook to the API on the restart reason change.
  76. * @return 0 if success.
  77. *-----------------------------------------------------------------*/
  78. extern int API_OnSetRestartCause(INT8U u8SysRestartCause, INT8U u8MadeChange,int BMCInst);
  79. #endif /* CHASSISAPI_H */