arch/powerpc/include/asm/eeh.h

   1 /*
   2  * eeh.h
   3  * Copyright (C) 2001  Dave Engebretsen & Todd Inglett IBM Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   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  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18  */
  19
  20 #ifndef _POWERPC_EEH_H
  21 #define _POWERPC_EEH_H
  22 #ifdef __KERNEL__
  23
  24 #include <linux/init.h>
  25 #include <linux/list.h>
  26 #include <linux/string.h>
  27
  28 struct pci_dev;
  29 struct pci_bus;
  30 struct device_node;
  31
  32 #ifdef CONFIG_EEH
  33
  34 extern int eeh_subsystem_enabled;
  35
  36 /* Values for eeh_mode bits in device_node */
  37 #define EEH_MODE_SUPPORTED     (1<<0)
  38 #define EEH_MODE_NOCHECK       (1<<1)
  39 #define EEH_MODE_ISOLATED      (1<<2)
  40 #define EEH_MODE_RECOVERING    (1<<3)
  41 #define EEH_MODE_IRQ_DISABLED  (1<<4)
  42
  43 /* Max number of EEH freezes allowed before we consider the device
  44  * to be permanently disabled. */
  45 #define EEH_MAX_ALLOWED_FREEZES 5
  46
  47 void __init eeh_init(void);
  48 unsigned long eeh_check_failure(const volatile void __iomem *token,
  49                                 unsigned long val);
  50 int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev);
  51 void __init pci_addr_cache_build(void);
  52
  53 /**
  54  * eeh_add_device_early
  55  * eeh_add_device_late
  56  *
  57  * Perform eeh initialization for devices added after boot.
  58  * Call eeh_add_device_early before doing any i/o to the
  59  * device (including config space i/o).  Call eeh_add_device_late
  60  * to finish the eeh setup for this device.
  61  */
  62 void eeh_add_device_tree_early(struct device_node *);
  63 void eeh_add_device_tree_late(struct pci_bus *);
  64 void eeh_add_sysfs_files(struct pci_bus *);
  65
  66 /**
  67  * eeh_remove_device_recursive - undo EEH for device & children.
  68  * @dev: pci device to be removed
  69  *
  70  * As above, this removes the device; it also removes child
  71  * pci devices as well.
  72  */
  73 void eeh_remove_bus_device(struct pci_dev *);
  74
  75 /**
  76  * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
  77  *
  78  * If this macro yields TRUE, the caller relays to eeh_check_failure()
  79  * which does further tests out of line.
  80  */
  81 #define EEH_POSSIBLE_ERROR(val, type)   ((val) == (type)~0 && eeh_subsystem_enabled)
  82
  83 /*
  84  * Reads from a device which has been isolated by EEH will return
  85  * all 1s.  This macro gives an all-1s value of the given size (in
  86  * bytes: 1, 2, or 4) for comparing with the result of a read.
  87  */
  88 #define EEH_IO_ERROR_VALUE(size)        (~0U >> ((4 - (size)) * 8))
  89
  90 #else /* !CONFIG_EEH */
  91 static inline void eeh_init(void) { }
  92
  93 static inline unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
  94 {
  95         return val;
  96 }
  97
  98 static inline int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev)
  99 {
 100         return 0;
 101 }
 102
 103 static inline void pci_addr_cache_build(void) { }
 104
 105 static inline void eeh_add_device_tree_early(struct device_node *dn) { }
 106
 107 static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
 108
 109 static inline void eeh_add_sysfs_files(struct pci_bus *bus) { }
 110
 111 static inline void eeh_remove_bus_device(struct pci_dev *dev) { }
 112 #define EEH_POSSIBLE_ERROR(val, type) (0)
 113 #define EEH_IO_ERROR_VALUE(size) (-1UL)
 114 #endif /* CONFIG_EEH */
 115
 116 #ifdef CONFIG_PPC64
 117 /*
 118  * MMIO read/write operations with EEH support.
 119  */
 120 static inline u8 eeh_readb(const volatile void __iomem *addr)
 121 {
 122         u8 val = in_8(addr);
 123         if (EEH_POSSIBLE_ERROR(val, u8))
 124                 return eeh_check_failure(addr, val);
 125         return val;
 126 }
 127
 128 static inline u16 eeh_readw(const volatile void __iomem *addr)
 129 {
 130         u16 val = in_le16(addr);
 131         if (EEH_POSSIBLE_ERROR(val, u16))
 132                 return eeh_check_failure(addr, val);
 133         return val;
 134 }
 135
 136 static inline u32 eeh_readl(const volatile void __iomem *addr)
 137 {
 138         u32 val = in_le32(addr);
 139         if (EEH_POSSIBLE_ERROR(val, u32))
 140                 return eeh_check_failure(addr, val);
 141         return val;
 142 }
 143
 144 static inline u64 eeh_readq(const volatile void __iomem *addr)
 145 {
 146         u64 val = in_le64(addr);
 147         if (EEH_POSSIBLE_ERROR(val, u64))
 148                 return eeh_check_failure(addr, val);
 149         return val;
 150 }
 151
 152 static inline u16 eeh_readw_be(const volatile void __iomem *addr)
 153 {
 154         u16 val = in_be16(addr);
 155         if (EEH_POSSIBLE_ERROR(val, u16))
 156                 return eeh_check_failure(addr, val);
 157         return val;
 158 }
 159
 160 static inline u32 eeh_readl_be(const volatile void __iomem *addr)
 161 {
 162         u32 val = in_be32(addr);
 163         if (EEH_POSSIBLE_ERROR(val, u32))
 164                 return eeh_check_failure(addr, val);
 165         return val;
 166 }
 167
 168 static inline u64 eeh_readq_be(const volatile void __iomem *addr)
 169 {
 170         u64 val = in_be64(addr);
 171         if (EEH_POSSIBLE_ERROR(val, u64))
 172                 return eeh_check_failure(addr, val);
 173         return val;
 174 }
 175
 176 static inline void eeh_memcpy_fromio(void *dest, const
 177                                      volatile void __iomem *src,
 178                                      unsigned long n)
 179 {
 180         _memcpy_fromio(dest, src, n);
 181
 182         /* Look for ffff's here at dest[n].  Assume that at least 4 bytes
 183          * were copied. Check all four bytes.
 184          */
 185         if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
 186                 eeh_check_failure(src, *((u32 *)(dest + n - 4)));
 187 }
 188
 189 /* in-string eeh macros */
 190 static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
 191                               int ns)
 192 {
 193         _insb(addr, buf, ns);
 194         if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
 195                 eeh_check_failure(addr, *(u8*)buf);
 196 }
 197
 198 static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
 199                               int ns)
 200 {
 201         _insw(addr, buf, ns);
 202         if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
 203                 eeh_check_failure(addr, *(u16*)buf);
 204 }
 205
 206 static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
 207                               int nl)
 208 {
 209         _insl(addr, buf, nl);
 210         if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
 211                 eeh_check_failure(addr, *(u32*)buf);
 212 }
 213
 214 #endif /* CONFIG_PPC64 */
 215 #endif /* __KERNEL__ */
 216 #endif /* _POWERPC_EEH_H */