1 /* 2 * Firmware Assisted dump header file. 3 * 4 * This program is free software; you can redistribute it and/or modify 5 * it under the terms of the GNU General Public License as published by 6 * the Free Software Foundation; either version 2 of the License, or 7 * (at your option) any later version. 8 * 9 * This program is distributed in the hope that it will be useful, 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 * GNU General Public License for more details. 13 * 14 * You should have received a copy of the GNU General Public License 15 * along with this program; if not, write to the Free Software 16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. 17 * 18 * Copyright 2011 IBM Corporation 19 * Author: Mahesh Salgaonkar <mahesh@linux.vnet.ibm.com> 20 */ 21 22 #ifndef __PPC64_FA_DUMP_H__ 23 #define __PPC64_FA_DUMP_H__ 24 25 #ifdef CONFIG_FA_DUMP 26 27 /* 28 * The RMA region will be saved for later dumping when kernel crashes. 29 * RMA is Real Mode Area, the first block of logical memory address owned 30 * by logical partition, containing the storage that may be accessed with 31 * translate off. 32 */ 33 #define RMA_START 0x0 34 #define RMA_END (ppc64_rma_size) 35 36 /* 37 * On some Power systems where RMO is 128MB, it still requires minimum of 38 * 256MB for kernel to boot successfully. When kdump infrastructure is 39 * configured to save vmcore over network, we run into OOM issue while 40 * loading modules related to network setup. Hence we need aditional 64M 41 * of memory to avoid OOM issue. 42 */ 43 #define MIN_BOOT_MEM (((RMA_END < (0x1UL << 28)) ? (0x1UL << 28) : RMA_END) \ 44 + (0x1UL << 26)) 45 46 #define memblock_num_regions(memblock_type) (memblock.memblock_type.cnt) 47 48 /* Firmware provided dump sections */ 49 #define FADUMP_CPU_STATE_DATA 0x0001 50 #define FADUMP_HPTE_REGION 0x0002 51 #define FADUMP_REAL_MODE_REGION 0x0011 52 53 /* Dump request flag */ 54 #define FADUMP_REQUEST_FLAG 0x00000001 55 56 /* FAD commands */ 57 #define FADUMP_REGISTER 1 58 #define FADUMP_UNREGISTER 2 59 #define FADUMP_INVALIDATE 3 60 61 /* Dump status flag */ 62 #define FADUMP_ERROR_FLAG 0x2000 63 64 #define FADUMP_CPU_ID_MASK ((1UL << 32) - 1) 65 66 #define CPU_UNKNOWN (~((u32)0)) 67 68 /* Utility macros */ 69 #define SKIP_TO_NEXT_CPU(reg_entry) \ 70 ({ \ 71 while (be64_to_cpu(reg_entry->reg_id) != REG_ID("CPUEND")) \ 72 reg_entry++; \ 73 reg_entry++; \ 74 }) 75 76 /* Kernel Dump section info */ 77 struct fadump_section { 78 __be32 request_flag; 79 __be16 source_data_type; 80 __be16 error_flags; 81 __be64 source_address; 82 __be64 source_len; 83 __be64 bytes_dumped; 84 __be64 destination_address; 85 }; 86 87 /* ibm,configure-kernel-dump header. */ 88 struct fadump_section_header { 89 __be32 dump_format_version; 90 __be16 dump_num_sections; 91 __be16 dump_status_flag; 92 __be32 offset_first_dump_section; 93 94 /* Fields for disk dump option. */ 95 __be32 dd_block_size; 96 __be64 dd_block_offset; 97 __be64 dd_num_blocks; 98 __be32 dd_offset_disk_path; 99 100 /* Maximum time allowed to prevent an automatic dump-reboot. */ 101 __be32 max_time_auto; 102 }; 103 104 /* 105 * Firmware Assisted dump memory structure. This structure is required for 106 * registering future kernel dump with power firmware through rtas call. 107 * 108 * No disk dump option. Hence disk dump path string section is not included. 109 */ 110 struct fadump_mem_struct { 111 struct fadump_section_header header; 112 113 /* Kernel dump sections */ 114 struct fadump_section cpu_state_data; 115 struct fadump_section hpte_region; 116 struct fadump_section rmr_region; 117 }; 118 119 /* Firmware-assisted dump configuration details. */ 120 struct fw_dump { 121 unsigned long cpu_state_data_size; 122 unsigned long hpte_region_size; 123 unsigned long boot_memory_size; 124 unsigned long reserve_dump_area_start; 125 unsigned long reserve_dump_area_size; 126 /* cmd line option during boot */ 127 unsigned long reserve_bootvar; 128 129 unsigned long fadumphdr_addr; 130 unsigned long cpu_notes_buf; 131 unsigned long cpu_notes_buf_size; 132 133 int ibm_configure_kernel_dump; 134 135 unsigned long fadump_enabled:1; 136 unsigned long fadump_supported:1; 137 unsigned long dump_active:1; 138 unsigned long dump_registered:1; 139 }; 140 141 /* 142 * Copy the ascii values for first 8 characters from a string into u64 143 * variable at their respective indexes. 144 * e.g. 145 * The string "FADMPINF" will be converted into 0x4641444d50494e46 146 */ 147 static inline u64 str_to_u64(const char *str) 148 { 149 u64 val = 0; 150 int i; 151 152 for (i = 0; i < sizeof(val); i++) 153 val = (*str) ? (val << 8) | *str++ : val << 8; 154 return val; 155 } 156 #define STR_TO_HEX(x) str_to_u64(x) 157 #define REG_ID(x) str_to_u64(x) 158 159 #define FADUMP_CRASH_INFO_MAGIC STR_TO_HEX("FADMPINF") 160 #define REGSAVE_AREA_MAGIC STR_TO_HEX("REGSAVE") 161 162 /* The firmware-assisted dump format. 163 * 164 * The register save area is an area in the partition's memory used to preserve 165 * the register contents (CPU state data) for the active CPUs during a firmware 166 * assisted dump. The dump format contains register save area header followed 167 * by register entries. Each list of registers for a CPU starts with 168 * "CPUSTRT" and ends with "CPUEND". 169 */ 170 171 /* Register save area header. */ 172 struct fadump_reg_save_area_header { 173 __be64 magic_number; 174 __be32 version; 175 __be32 num_cpu_offset; 176 }; 177 178 /* Register entry. */ 179 struct fadump_reg_entry { 180 __be64 reg_id; 181 __be64 reg_value; 182 }; 183 184 /* fadump crash info structure */ 185 struct fadump_crash_info_header { 186 u64 magic_number; 187 u64 elfcorehdr_addr; 188 u32 crashing_cpu; 189 struct pt_regs regs; 190 struct cpumask online_mask; 191 }; 192 193 /* Crash memory ranges */ 194 #define INIT_CRASHMEM_RANGES (INIT_MEMBLOCK_REGIONS + 2) 195 196 struct fad_crash_memory_ranges { 197 unsigned long long base; 198 unsigned long long size; 199 }; 200 201 extern int early_init_dt_scan_fw_dump(unsigned long node, 202 const char *uname, int depth, void *data); 203 extern int fadump_reserve_mem(void); 204 extern int setup_fadump(void); 205 extern int is_fadump_active(void); 206 extern void crash_fadump(struct pt_regs *, const char *); 207 extern void fadump_cleanup(void); 208 209 #else /* CONFIG_FA_DUMP */ 210 static inline int is_fadump_active(void) { return 0; } 211 static inline void crash_fadump(struct pt_regs *regs, const char *str) { } 212 #endif 213 #endif 214