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_UNKNOWN     = 255
  33 };
  34
  35 struct pstore_info {
  36         struct module   *owner;
  37         char            *name;
  38         spinlock_t      buf_lock;       /* serialize access to 'buf' */
  39         char            *buf;
  40         size_t          bufsize;
  41         struct mutex    read_mutex;     /* serialize open/read/close */
  42         int             (*open)(struct pstore_info *psi);
  43         int             (*close)(struct pstore_info *psi);
  44         ssize_t         (*read)(u64 *id, enum pstore_type_id *type,
  45                         struct timespec *time, char **buf,
  46                         struct pstore_info *psi);
  47         int             (*write)(enum pstore_type_id type,
  48                         enum kmsg_dump_reason reason, u64 *id,
  49                         unsigned int part, size_t size, struct pstore_info *psi);
  50         int             (*erase)(enum pstore_type_id type, u64 id,
  51                         struct pstore_info *psi);
  52         void            *data;
  53 };
  54
  55 #ifdef CONFIG_PSTORE
  56 extern int pstore_register(struct pstore_info *);
  57 extern bool pstore_cannot_block_path(enum kmsg_dump_reason reason);
  58 #else
  59 static inline int
  60 pstore_register(struct pstore_info *psi)
  61 {
  62         return -ENODEV;
  63 }
  64 static inline bool
  65 pstore_cannot_block_path(enum kmsg_dump_reason reason)
  66 {
  67         return false;
  68 }
  69 #endif
  70
  71 #endif /*_LINUX_PSTORE_H*/