include/linux/pstore.h

   1 /*
   2  * Persistent Storage - pstore.h
   3  *
   4  * Copyright (C) 2010 Intel Corporation <tony.luck@intel.com>
   5  *
   6  * This code is the generic layer to export data records from platform
   7  * level persistent storage via a file system.
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License version 2 as
  11  *  published by the Free Software Foundation.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22 #ifndef _LINUX_PSTORE_H
  23 #define _LINUX_PSTORE_H
  24
  25 #include <linux/time.h>
  26 #include <linux/kmsg_dump.h>
  27
  28 /* types */
  29 enum pstore_type_id {
  30         PSTORE_TYPE_DMESG       = 0,
  31         PSTORE_TYPE_MCE         = 1,
  32         PSTORE_TYPE_CONSOLE     = 2,
  33         PSTORE_TYPE_FTRACE      = 3,
  34         PSTORE_TYPE_UNKNOWN     = 255
  35 };
  36
  37 struct pstore_info {
  38         struct module   *owner;
  39         char            *name;
  40         spinlock_t      buf_lock;       /* serialize access to 'buf' */
  41         char            *buf;
  42         size_t          bufsize;
  43         struct mutex    read_mutex;     /* serialize open/read/close */
  44         int             (*open)(struct pstore_info *psi);
  45         int             (*close)(struct pstore_info *psi);
  46         ssize_t         (*read)(u64 *id, enum pstore_type_id *type,
  47                         struct timespec *time, char **buf,
  48                         struct pstore_info *psi);
  49         int             (*write)(enum pstore_type_id type,
  50                         enum kmsg_dump_reason reason, u64 *id,
  51                         unsigned int part, size_t size, struct pstore_info *psi);
  52         int             (*write_buf)(enum pstore_type_id type,
  53                         enum kmsg_dump_reason reason, u64 *id,
  54                         unsigned int part, const char *buf, size_t size,
  55                         struct pstore_info *psi);
  56         int             (*erase)(enum pstore_type_id type, u64 id,
  57                         struct pstore_info *psi);
  58         void            *data;
  59 };
  60
  61
  62 #ifdef CONFIG_PSTORE_FTRACE
  63 extern void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip);
  64 #else
  65 static inline void pstore_ftrace_call(unsigned long ip, unsigned long parent_ip)
  66 { }
  67 #endif
  68
  69 #ifdef CONFIG_PSTORE
  70 extern int pstore_register(struct pstore_info *);
  71 #else
  72 static inline int
  73 pstore_register(struct pstore_info *psi)
  74 {
  75         return -ENODEV;
  76 }
  77 #endif
  78
  79 #endif /*_LINUX_PSTORE_H*/