arch/powerpc/include/asm/fadump.h

   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 /* The upper limit percentage for user specified boot memory size (25%) */
  47 #define MAX_BOOT_MEM_RATIO                      4
  48
  49 #define memblock_num_regions(memblock_type)     (memblock.memblock_type.cnt)
  50
  51 /* Firmware provided dump sections */
  52 #define FADUMP_CPU_STATE_DATA   0x0001
  53 #define FADUMP_HPTE_REGION      0x0002
  54 #define FADUMP_REAL_MODE_REGION 0x0011
  55
  56 /* Dump request flag */
  57 #define FADUMP_REQUEST_FLAG     0x00000001
  58
  59 /* FAD commands */
  60 #define FADUMP_REGISTER         1
  61 #define FADUMP_UNREGISTER       2
  62 #define FADUMP_INVALIDATE       3
  63
  64 /* Dump status flag */
  65 #define FADUMP_ERROR_FLAG       0x2000
  66
  67 #define FADUMP_CPU_ID_MASK      ((1UL << 32) - 1)
  68
  69 #define CPU_UNKNOWN             (~((u32)0))
  70
  71 /* Utility macros */
  72 #define SKIP_TO_NEXT_CPU(reg_entry)                                     \
  73 ({                                                                      \
  74         while (be64_to_cpu(reg_entry->reg_id) != REG_ID("CPUEND"))      \
  75                 reg_entry++;                                            \
  76         reg_entry++;                                                    \
  77 })
  78
  79 /* Kernel Dump section info */
  80 struct fadump_section {
  81         __be32  request_flag;
  82         __be16  source_data_type;
  83         __be16  error_flags;
  84         __be64  source_address;
  85         __be64  source_len;
  86         __be64  bytes_dumped;
  87         __be64  destination_address;
  88 };
  89
  90 /* ibm,configure-kernel-dump header. */
  91 struct fadump_section_header {
  92         __be32  dump_format_version;
  93         __be16  dump_num_sections;
  94         __be16  dump_status_flag;
  95         __be32  offset_first_dump_section;
  96
  97         /* Fields for disk dump option. */
  98         __be32  dd_block_size;
  99         __be64  dd_block_offset;
 100         __be64  dd_num_blocks;
 101         __be32  dd_offset_disk_path;
 102
 103         /* Maximum time allowed to prevent an automatic dump-reboot. */
 104         __be32  max_time_auto;
 105 };
 106
 107 /*
 108  * Firmware Assisted dump memory structure. This structure is required for
 109  * registering future kernel dump with power firmware through rtas call.
 110  *
 111  * No disk dump option. Hence disk dump path string section is not included.
 112  */
 113 struct fadump_mem_struct {
 114         struct fadump_section_header    header;
 115
 116         /* Kernel dump sections */
 117         struct fadump_section           cpu_state_data;
 118         struct fadump_section           hpte_region;
 119         struct fadump_section           rmr_region;
 120 };
 121
 122 /* Firmware-assisted dump configuration details. */
 123 struct fw_dump {
 124         unsigned long   cpu_state_data_size;
 125         unsigned long   hpte_region_size;
 126         unsigned long   boot_memory_size;
 127         unsigned long   reserve_dump_area_start;
 128         unsigned long   reserve_dump_area_size;
 129         /* cmd line option during boot */
 130         unsigned long   reserve_bootvar;
 131
 132         unsigned long   fadumphdr_addr;
 133         unsigned long   cpu_notes_buf;
 134         unsigned long   cpu_notes_buf_size;
 135
 136         int             ibm_configure_kernel_dump;
 137
 138         unsigned long   fadump_enabled:1;
 139         unsigned long   fadump_supported:1;
 140         unsigned long   dump_active:1;
 141         unsigned long   dump_registered:1;
 142 };
 143
 144 /*
 145  * Copy the ascii values for first 8 characters from a string into u64
 146  * variable at their respective indexes.
 147  * e.g.
 148  *  The string "FADMPINF" will be converted into 0x4641444d50494e46
 149  */
 150 static inline u64 str_to_u64(const char *str)
 151 {
 152         u64 val = 0;
 153         int i;
 154
 155         for (i = 0; i < sizeof(val); i++)
 156                 val = (*str) ? (val << 8) | *str++ : val << 8;
 157         return val;
 158 }
 159 #define STR_TO_HEX(x)   str_to_u64(x)
 160 #define REG_ID(x)       str_to_u64(x)
 161
 162 #define FADUMP_CRASH_INFO_MAGIC         STR_TO_HEX("FADMPINF")
 163 #define REGSAVE_AREA_MAGIC              STR_TO_HEX("REGSAVE")
 164
 165 /* The firmware-assisted dump format.
 166  *
 167  * The register save area is an area in the partition's memory used to preserve
 168  * the register contents (CPU state data) for the active CPUs during a firmware
 169  * assisted dump. The dump format contains register save area header followed
 170  * by register entries. Each list of registers for a CPU starts with
 171  * "CPUSTRT" and ends with "CPUEND".
 172  */
 173
 174 /* Register save area header. */
 175 struct fadump_reg_save_area_header {
 176         __be64          magic_number;
 177         __be32          version;
 178         __be32          num_cpu_offset;
 179 };
 180
 181 /* Register entry. */
 182 struct fadump_reg_entry {
 183         __be64          reg_id;
 184         __be64          reg_value;
 185 };
 186
 187 /* fadump crash info structure */
 188 struct fadump_crash_info_header {
 189         u64             magic_number;
 190         u64             elfcorehdr_addr;
 191         u32             crashing_cpu;
 192         struct pt_regs  regs;
 193         struct cpumask  online_mask;
 194 };
 195
 196 /* Crash memory ranges */
 197 #define INIT_CRASHMEM_RANGES    (INIT_MEMBLOCK_REGIONS + 2)
 198
 199 struct fad_crash_memory_ranges {
 200         unsigned long long      base;
 201         unsigned long long      size;
 202 };
 203
 204 extern int early_init_dt_scan_fw_dump(unsigned long node,
 205                 const char *uname, int depth, void *data);
 206 extern int fadump_reserve_mem(void);
 207 extern int setup_fadump(void);
 208 extern int is_fadump_active(void);
 209 extern void crash_fadump(struct pt_regs *, const char *);
 210 extern void fadump_cleanup(void);
 211
 212 #else   /* CONFIG_FA_DUMP */
 213 static inline int is_fadump_active(void) { return 0; }
 214 static inline void crash_fadump(struct pt_regs *regs, const char *str) { }
 215 #endif
 216 #endif