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