include/linux/pstore_ram.h

   1 /*
   2  * Copyright (C) 2010 Marco Stornelli <marco.stornelli@gmail.com>
   3  * Copyright (C) 2011 Kees Cook <keescook@chromium.org>
   4  * Copyright (C) 2011 Google, Inc.
   5  *
   6  * This software is licensed under the terms of the GNU General Public
   7  * License version 2, as published by the Free Software Foundation, and
   8  * may be copied, distributed, and modified under those terms.
   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
  17 #ifndef __LINUX_PSTORE_RAM_H__
  18 #define __LINUX_PSTORE_RAM_H__
  19
  20 #include <linux/device.h>
  21 #include <linux/kernel.h>
  22 #include <linux/list.h>
  23 #include <linux/types.h>
  24 #include <linux/init.h>
  25
  26 /*
  27  * Choose whether access to the RAM zone requires locking or not.  If a zone
  28  * can be written to from different CPUs like with ftrace for example, then
  29  * PRZ_FLAG_NO_LOCK is used. For all other cases, locking is required.
  30  */
  31 #define PRZ_FLAG_NO_LOCK        BIT(0)
  32
  33 struct persistent_ram_buffer;
  34 struct rs_control;
  35
  36 struct persistent_ram_ecc_info {
  37         int block_size;
  38         int ecc_size;
  39         int symsize;
  40         int poly;
  41 };
  42
  43 struct persistent_ram_zone {
  44         phys_addr_t paddr;
  45         size_t size;
  46         void *vaddr;
  47         struct persistent_ram_buffer *buffer;
  48         size_t buffer_size;
  49         u32 flags;
  50         raw_spinlock_t buffer_lock;
  51
  52         /* ECC correction */
  53         char *par_buffer;
  54         char *par_header;
  55         struct rs_control *rs_decoder;
  56         int corrected_bytes;
  57         int bad_blocks;
  58         struct persistent_ram_ecc_info ecc_info;
  59
  60         char *old_log;
  61         size_t old_log_size;
  62 };
  63
  64 struct persistent_ram_zone *persistent_ram_new(phys_addr_t start, size_t size,
  65                         u32 sig, struct persistent_ram_ecc_info *ecc_info,
  66                         unsigned int memtype, u32 flags);
  67 void persistent_ram_free(struct persistent_ram_zone *prz);
  68 void persistent_ram_zap(struct persistent_ram_zone *prz);
  69
  70 int persistent_ram_write(struct persistent_ram_zone *prz, const void *s,
  71         unsigned int count);
  72
  73 void persistent_ram_save_old(struct persistent_ram_zone *prz);
  74 size_t persistent_ram_old_size(struct persistent_ram_zone *prz);
  75 void *persistent_ram_old(struct persistent_ram_zone *prz);
  76 void persistent_ram_free_old(struct persistent_ram_zone *prz);
  77 ssize_t persistent_ram_ecc_string(struct persistent_ram_zone *prz,
  78         char *str, size_t len);
  79
  80 /*
  81  * Ramoops platform data
  82  * @mem_size    memory size for ramoops
  83  * @mem_address physical memory address to contain ramoops
  84  */
  85
  86 struct ramoops_platform_data {
  87         unsigned long   mem_size;
  88         unsigned long   mem_address;
  89         unsigned int    mem_type;
  90         unsigned long   record_size;
  91         unsigned long   console_size;
  92         unsigned long   ftrace_size;
  93         unsigned long   pmsg_size;
  94         int             dump_oops;
  95         struct persistent_ram_ecc_info ecc_info;
  96 };
  97
  98 #endif