src/include/elog.h

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright (C) 2012 The ChromiumOS Authors.  All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; version 2 of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  */
  15
  16 #ifndef ELOG_H_
  17 #define ELOG_H_
  18
  19 /* SMI command code for GSMI event logging */
  20 #define ELOG_GSMI_APM_CNT                 0xEF
  21
  22 #define MAX_EVENT_SIZE                    0x7F
  23
  24 /* End of log */
  25 #define ELOG_TYPE_EOL                     0xFF
  26
  27 /*
  28  * Standard SMBIOS event log types below 0x80
  29  */
  30 #define ELOG_TYPE_UNDEFINED_EVENT         0x00
  31 #define ELOG_TYPE_SINGLE_BIT_ECC_MEM_ERR  0x01
  32 #define ELOG_TYPE_MULTI_BIT_ECC_MEM_ERR   0x02
  33 #define ELOG_TYPE_MEM_PARITY_ERR          0x03
  34 #define ELOG_TYPE_BUS_TIMEOUT             0x04
  35 #define ELOG_TYPE_IO_CHECK                0x05
  36 #define ELOG_TYPE_SW_NMI                  0x06
  37 #define ELOG_TYPE_POST_MEM_RESIZE         0x07
  38 #define ELOG_TYPE_POST_ERR                0x08
  39 #define ELOG_TYPE_PCI_PERR                0x09
  40 #define ELOG_TYPE_PCI_SERR                0x0A
  41 #define ELOG_TYPE_CPU_FAIL                0x0B
  42 #define ELOG_TYPE_EISA_TIMEOUT            0x0C
  43 #define ELOG_TYPE_CORRECTABLE_MEMLOG_DIS  0x0D
  44 #define ELOG_TYPE_LOG_DISABLED            0x0E
  45 #define ELOG_TYPE_UNDEFINED_EVENT2        0x0F
  46 #define ELOG_TYPE_SYS_LIMIT_EXCEED        0x10
  47 #define ELOG_TYPE_ASYNC_HW_TIMER_EXPIRED  0x11
  48 #define ELOG_TYPE_SYS_CONFIG_INFO         0x12
  49 #define ELOG_TYPE_HDD_INFO                0x13
  50 #define ELOG_TYPE_SYS_RECONFIG            0x14
  51 #define ELOG_TYPE_CPU_ERROR               0x15
  52 #define ELOG_TYPE_LOG_CLEAR               0x16
  53 #define ELOG_TYPE_BOOT                    0x17
  54
  55 /*
  56  * Extended defined OEM event types start at 0x80
  57  */
  58
  59 /* OS/kernel events */
  60 #define ELOG_TYPE_OS_EVENT                0x81
  61
  62 /* Last event from coreboot */
  63 #define ELOG_TYPE_OS_BOOT                 0x90
  64
  65 /* Embedded controller event */
  66 #define ELOG_TYPE_EC_EVENT                0x91
  67 #define EC_EVENT_LID_CLOSED                0x01
  68 #define EC_EVENT_LID_OPEN                  0x02
  69 #define EC_EVENT_POWER_BUTTON              0x03
  70 #define EC_EVENT_AC_CONNECTED              0x04
  71 #define EC_EVENT_AC_DISCONNECTED           0x05
  72 #define EC_EVENT_BATTERY_LOW               0x06
  73 #define EC_EVENT_BATTERY_CRITICAL          0x07
  74 #define EC_EVENT_BATTERY                   0x08
  75 #define EC_EVENT_THERMAL_THRESHOLD         0x09
  76 #define EC_EVENT_THERMAL_OVERLOAD          0x0a
  77 #define EC_EVENT_THERMAL                   0x0b
  78 #define EC_EVENT_USB_CHARGER               0x0c
  79 #define EC_EVENT_KEY_PRESSED               0x0d
  80 #define EC_EVENT_INTERFACE_READY           0x0e
  81 #define EC_EVENT_KEYBOARD_RECOVERY         0x0f
  82 #define EC_EVENT_THERMAL_SHUTDOWN          0x10
  83 #define EC_EVENT_BATTERY_SHUTDOWN          0x11
  84 #define EC_EVENT_FAN_ERROR                 0x12
  85
  86 /* Power */
  87 #define ELOG_TYPE_POWER_FAIL              0x92
  88 #define ELOG_TYPE_SUS_POWER_FAIL          0x93
  89 #define ELOG_TYPE_PWROK_FAIL              0x94
  90 #define ELOG_TYPE_SYS_PWROK_FAIL          0x95
  91 #define ELOG_TYPE_POWER_ON                0x96
  92 #define ELOG_TYPE_POWER_BUTTON            0x97
  93 #define ELOG_TYPE_POWER_BUTTON_OVERRIDE   0x98
  94
  95 /* Reset */
  96 #define ELOG_TYPE_RESET_BUTTON            0x99
  97 #define ELOG_TYPE_SYSTEM_RESET            0x9a
  98 #define ELOG_TYPE_RTC_RESET               0x9b
  99 #define ELOG_TYPE_TCO_RESET               0x9c
 100
 101 /* Sleep/Wake */
 102 #define ELOG_TYPE_ACPI_ENTER              0x9d
 103 #define ELOG_TYPE_ACPI_WAKE               0x9e
 104 #define ELOG_TYPE_WAKE_SOURCE             0x9f
 105 #define  ELOG_WAKE_SOURCE_PCIE             0x00
 106 #define  ELOG_WAKE_SOURCE_PME              0x01
 107 #define  ELOG_WAKE_SOURCE_PME_INTERNAL     0x02
 108 #define  ELOG_WAKE_SOURCE_RTC              0x03
 109 #define  ELOG_WAKE_SOURCE_GPIO             0x04
 110 #define  ELOG_WAKE_SOURCE_SMBUS            0x05
 111 #define  ELOG_WAKE_SOURCE_PWRBTN           0x06
 112 struct elog_event_data_wake {
 113         u8 source;
 114         u32 instance;
 115 } __attribute__ ((packed));
 116
 117 /* Chrome OS related events */
 118 #define ELOG_TYPE_CROS_DEVELOPER_MODE     0xa0
 119 #define ELOG_TYPE_CROS_RECOVERY_MODE      0xa1
 120 #define  ELOG_CROS_RECOVERY_MODE_BUTTON    0x02
 121
 122 /* Management Engine Events */
 123 #define ELOG_TYPE_MANAGEMENT_ENGINE       0xa2
 124 #define ELOG_TYPE_MANAGEMENT_ENGINE_EXT   0xa4
 125 struct elog_event_data_me_extended {
 126         u8 current_working_state;
 127         u8 operation_state;
 128         u8 operation_mode;
 129         u8 error_code;
 130         u8 progress_code;
 131         u8 current_pmevent;
 132         u8 current_state;
 133 } __attribute__ ((packed));
 134
 135 /* Last post code from previous boot */
 136 #define ELOG_TYPE_LAST_POST_CODE          0xa3
 137 #define ELOG_TYPE_POST_EXTRA              0xa6
 138
 139 /* EC Shutdown Reason */
 140 #define ELOG_TYPE_EC_SHUTDOWN             0xa5
 141
 142 /* CPU Thermal Trip */
 143 #define ELOG_TYPE_THERM_TRIP              0xa7
 144
 145 #if CONFIG_ELOG
 146 /* Eventlog backing storage must be initialized before calling elog_init(). */
 147 extern int elog_init(void);
 148 extern int elog_clear(void);
 149 extern void elog_add_event_raw(u8 event_type, void *data, u8 data_size);
 150 extern void elog_add_event(u8 event_type);
 151 extern void elog_add_event_byte(u8 event_type, u8 data);
 152 extern void elog_add_event_word(u8 event_type, u16 data);
 153 extern void elog_add_event_dword(u8 event_type, u32 data);
 154 extern void elog_add_event_wake(u8 source, u32 instance);
 155 extern int elog_smbios_write_type15(unsigned long *current, int handle);
 156 #else
 157 /* Stubs to help avoid littering sources with #if CONFIG_ELOG */
 158 static inline int elog_init(void) { return -1; }
 159 static inline int elog_clear(void) { return -1; }
 160 static inline void elog_add_event_raw(void) { return; }
 161 static inline void elog_add_event(u8 event_type) { return; }
 162 static inline void elog_add_event_byte(u8 event_type, u8 data) { return; }
 163 static inline void elog_add_event_word(u8 event_type, u16 data) { return; }
 164 static inline void elog_add_event_dword(u8 event_type, u32 data) { return; }
 165 static inline void elog_add_event_wake(u8 source, u32 instance) { return; }
 166 static inline int elog_smbios_write_type15(unsigned long *current,
 167                                                 int handle) {
 168         return 0;
 169 }
 170 #endif
 171
 172 #if CONFIG_ELOG_GSMI
 173 extern u32 gsmi_exec(u8 command, u32 *param);
 174 #endif
 175
 176 #if CONFIG_ELOG_BOOT_COUNT
 177 u32 boot_count_read(void);
 178 u32 boot_count_increment(void);
 179 #else
 180 static inline u32 boot_count_read(void) { return 0; }
 181 #endif /* CONFIG_ELOG_BOOT_COUNT */
 182
 183 #endif /* ELOG_H_ */