include/asm-powerpc/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 _PPC64_EEH_H
  21 #define _PPC64_EEH_H
  22
  23 #include <linux/config.h>
  24 #include <linux/init.h>
  25 #include <linux/list.h>
  26 #include <linux/string.h>
  27
  28 struct pci_dev;
  29 struct device_node;
  30
  31 #ifdef CONFIG_EEH
  32
  33 /* Values for eeh_mode bits in device_node */
  34 #define EEH_MODE_SUPPORTED      (1<<0)
  35 #define EEH_MODE_NOCHECK        (1<<1)
  36 #define EEH_MODE_ISOLATED       (1<<2)
  37
  38 /* Max number of EEH freezes allowed before we consider the device
  39  * to be permanently disabled. */
  40 #define EEH_MAX_ALLOWED_FREEZES 5
  41
  42 void __init eeh_init(void);
  43 unsigned long eeh_check_failure(const volatile void __iomem *token,
  44                                 unsigned long val);
  45 int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev);
  46 void __init pci_addr_cache_build(void);
  47
  48 /**
  49  * eeh_add_device_early
  50  * eeh_add_device_late
  51  *
  52  * Perform eeh initialization for devices added after boot.
  53  * Call eeh_add_device_early before doing any i/o to the
  54  * device (including config space i/o).  Call eeh_add_device_late
  55  * to finish the eeh setup for this device.
  56  */
  57 void eeh_add_device_early(struct device_node *);
  58 void eeh_add_device_late(struct pci_dev *);
  59
  60 /**
  61  * eeh_remove_device - undo EEH setup for the indicated pci device
  62  * @dev: pci device to be removed
  63  *
  64  * This routine should be called when a device is removed from
  65  * a running system (e.g. by hotplug or dlpar).  It unregisters
  66  * the PCI device from the EEH subsystem.  I/O errors affecting
  67  * this device will no longer be detected after this call; thus,
  68  * i/o errors affecting this slot may leave this device unusable.
  69  */
  70 void eeh_remove_device(struct pci_dev *);
  71
  72 /**
  73  * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
  74  *
  75  * If this macro yields TRUE, the caller relays to eeh_check_failure()
  76  * which does further tests out of line.
  77  */
  78 #define EEH_POSSIBLE_ERROR(val, type)   ((val) == (type)~0)
  79
  80 /*
  81  * Reads from a device which has been isolated by EEH will return
  82  * all 1s.  This macro gives an all-1s value of the given size (in
  83  * bytes: 1, 2, or 4) for comparing with the result of a read.
  84  */
  85 #define EEH_IO_ERROR_VALUE(size)        (~0U >> ((4 - (size)) * 8))
  86
  87 #else /* !CONFIG_EEH */
  88 static inline void eeh_init(void) { }
  89
  90 static inline unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
  91 {
  92         return val;
  93 }
  94
  95 static inline int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev)
  96 {
  97         return 0;
  98 }
  99
 100 static inline void pci_addr_cache_build(void) { }
 101
 102 static inline void eeh_add_device_early(struct device_node *dn) { }
 103
 104 static inline void eeh_add_device_late(struct pci_dev *dev) { }
 105
 106 static inline void eeh_remove_device(struct pci_dev *dev) { }
 107
 108 #define EEH_POSSIBLE_ERROR(val, type) (0)
 109 #define EEH_IO_ERROR_VALUE(size) (-1UL)
 110 #endif /* CONFIG_EEH */
 111
 112 /*
 113  * MMIO read/write operations with EEH support.
 114  */
 115 static inline u8 eeh_readb(const volatile void __iomem *addr)
 116 {
 117         u8 val = in_8(addr);
 118         if (EEH_POSSIBLE_ERROR(val, u8))
 119                 return eeh_check_failure(addr, val);
 120         return val;
 121 }
 122 static inline void eeh_writeb(u8 val, volatile void __iomem *addr)
 123 {
 124         out_8(addr, val);
 125 }
 126
 127 static inline u16 eeh_readw(const volatile void __iomem *addr)
 128 {
 129         u16 val = in_le16(addr);
 130         if (EEH_POSSIBLE_ERROR(val, u16))
 131                 return eeh_check_failure(addr, val);
 132         return val;
 133 }
 134 static inline void eeh_writew(u16 val, volatile void __iomem *addr)
 135 {
 136         out_le16(addr, val);
 137 }
 138 static inline u16 eeh_raw_readw(const volatile void __iomem *addr)
 139 {
 140         u16 val = in_be16(addr);
 141         if (EEH_POSSIBLE_ERROR(val, u16))
 142                 return eeh_check_failure(addr, val);
 143         return val;
 144 }
 145 static inline void eeh_raw_writew(u16 val, volatile void __iomem *addr) {
 146         volatile u16 __iomem *vaddr = (volatile u16 __iomem *) addr;
 147         out_be16(vaddr, val);
 148 }
 149
 150 static inline u32 eeh_readl(const volatile void __iomem *addr)
 151 {
 152         u32 val = in_le32(addr);
 153         if (EEH_POSSIBLE_ERROR(val, u32))
 154                 return eeh_check_failure(addr, val);
 155         return val;
 156 }
 157 static inline void eeh_writel(u32 val, volatile void __iomem *addr)
 158 {
 159         out_le32(addr, val);
 160 }
 161 static inline u32 eeh_raw_readl(const volatile void __iomem *addr)
 162 {
 163         u32 val = in_be32(addr);
 164         if (EEH_POSSIBLE_ERROR(val, u32))
 165                 return eeh_check_failure(addr, val);
 166         return val;
 167 }
 168 static inline void eeh_raw_writel(u32 val, volatile void __iomem *addr)
 169 {
 170         out_be32(addr, val);
 171 }
 172
 173 static inline u64 eeh_readq(const volatile void __iomem *addr)
 174 {
 175         u64 val = in_le64(addr);
 176         if (EEH_POSSIBLE_ERROR(val, u64))
 177                 return eeh_check_failure(addr, val);
 178         return val;
 179 }
 180 static inline void eeh_writeq(u64 val, volatile void __iomem *addr)
 181 {
 182         out_le64(addr, val);
 183 }
 184 static inline u64 eeh_raw_readq(const volatile void __iomem *addr)
 185 {
 186         u64 val = in_be64(addr);
 187         if (EEH_POSSIBLE_ERROR(val, u64))
 188                 return eeh_check_failure(addr, val);
 189         return val;
 190 }
 191 static inline void eeh_raw_writeq(u64 val, volatile void __iomem *addr)
 192 {
 193         out_be64(addr, val);
 194 }
 195
 196 #define EEH_CHECK_ALIGN(v,a) \
 197         ((((unsigned long)(v)) & ((a) - 1)) == 0)
 198
 199 static inline void eeh_memset_io(volatile void __iomem *addr, int c,
 200                                  unsigned long n)
 201 {
 202         void *p = (void __force *)addr;
 203         u32 lc = c;
 204         lc |= lc << 8;
 205         lc |= lc << 16;
 206
 207         while(n && !EEH_CHECK_ALIGN(p, 4)) {
 208                 *((volatile u8 *)p) = c;
 209                 p++;
 210                 n--;
 211         }
 212         while(n >= 4) {
 213                 *((volatile u32 *)p) = lc;
 214                 p += 4;
 215                 n -= 4;
 216         }
 217         while(n) {
 218                 *((volatile u8 *)p) = c;
 219                 p++;
 220                 n--;
 221         }
 222         __asm__ __volatile__ ("sync" : : : "memory");
 223 }
 224 static inline void eeh_memcpy_fromio(void *dest, const volatile void __iomem *src,
 225                                      unsigned long n)
 226 {
 227         void *vsrc = (void __force *) src;
 228         void *destsave = dest;
 229         unsigned long nsave = n;
 230
 231         while(n && (!EEH_CHECK_ALIGN(vsrc, 4) || !EEH_CHECK_ALIGN(dest, 4))) {
 232                 *((u8 *)dest) = *((volatile u8 *)vsrc);
 233                 __asm__ __volatile__ ("eieio" : : : "memory");
 234                 vsrc++;
 235                 dest++;
 236                 n--;
 237         }
 238         while(n > 4) {
 239                 *((u32 *)dest) = *((volatile u32 *)vsrc);
 240                 __asm__ __volatile__ ("eieio" : : : "memory");
 241                 vsrc += 4;
 242                 dest += 4;
 243                 n -= 4;
 244         }
 245         while(n) {
 246                 *((u8 *)dest) = *((volatile u8 *)vsrc);
 247                 __asm__ __volatile__ ("eieio" : : : "memory");
 248                 vsrc++;
 249                 dest++;
 250                 n--;
 251         }
 252         __asm__ __volatile__ ("sync" : : : "memory");
 253
 254         /* Look for ffff's here at dest[n].  Assume that at least 4 bytes
 255          * were copied. Check all four bytes.
 256          */
 257         if ((nsave >= 4) &&
 258                 (EEH_POSSIBLE_ERROR((*((u32 *) destsave+nsave-4)), u32))) {
 259                 eeh_check_failure(src, (*((u32 *) destsave+nsave-4)));
 260         }
 261 }
 262
 263 static inline void eeh_memcpy_toio(volatile void __iomem *dest, const void *src,
 264                                    unsigned long n)
 265 {
 266         void *vdest = (void __force *) dest;
 267
 268         while(n && (!EEH_CHECK_ALIGN(vdest, 4) || !EEH_CHECK_ALIGN(src, 4))) {
 269                 *((volatile u8 *)vdest) = *((u8 *)src);
 270                 src++;
 271                 vdest++;
 272                 n--;
 273         }
 274         while(n > 4) {
 275                 *((volatile u32 *)vdest) = *((volatile u32 *)src);
 276                 src += 4;
 277                 vdest += 4;
 278                 n-=4;
 279         }
 280         while(n) {
 281                 *((volatile u8 *)vdest) = *((u8 *)src);
 282                 src++;
 283                 vdest++;
 284                 n--;
 285         }
 286         __asm__ __volatile__ ("sync" : : : "memory");
 287 }
 288
 289 #undef EEH_CHECK_ALIGN
 290
 291 static inline u8 eeh_inb(unsigned long port)
 292 {
 293         u8 val;
 294         if (!_IO_IS_VALID(port))
 295                 return ~0;
 296         val = in_8((u8 __iomem *)(port+pci_io_base));
 297         if (EEH_POSSIBLE_ERROR(val, u8))
 298                 return eeh_check_failure((void __iomem *)(port), val);
 299         return val;
 300 }
 301
 302 static inline void eeh_outb(u8 val, unsigned long port)
 303 {
 304         if (_IO_IS_VALID(port))
 305                 out_8((u8 __iomem *)(port+pci_io_base), val);
 306 }
 307
 308 static inline u16 eeh_inw(unsigned long port)
 309 {
 310         u16 val;
 311         if (!_IO_IS_VALID(port))
 312                 return ~0;
 313         val = in_le16((u16 __iomem *)(port+pci_io_base));
 314         if (EEH_POSSIBLE_ERROR(val, u16))
 315                 return eeh_check_failure((void __iomem *)(port), val);
 316         return val;
 317 }
 318
 319 static inline void eeh_outw(u16 val, unsigned long port)
 320 {
 321         if (_IO_IS_VALID(port))
 322                 out_le16((u16 __iomem *)(port+pci_io_base), val);
 323 }
 324
 325 static inline u32 eeh_inl(unsigned long port)
 326 {
 327         u32 val;
 328         if (!_IO_IS_VALID(port))
 329                 return ~0;
 330         val = in_le32((u32 __iomem *)(port+pci_io_base));
 331         if (EEH_POSSIBLE_ERROR(val, u32))
 332                 return eeh_check_failure((void __iomem *)(port), val);
 333         return val;
 334 }
 335
 336 static inline void eeh_outl(u32 val, unsigned long port)
 337 {
 338         if (_IO_IS_VALID(port))
 339                 out_le32((u32 __iomem *)(port+pci_io_base), val);
 340 }
 341
 342 /* in-string eeh macros */
 343 static inline void eeh_insb(unsigned long port, void * buf, int ns)
 344 {
 345         _insb((u8 __iomem *)(port+pci_io_base), buf, ns);
 346         if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
 347                 eeh_check_failure((void __iomem *)(port), *(u8*)buf);
 348 }
 349
 350 static inline void eeh_insw_ns(unsigned long port, void * buf, int ns)
 351 {
 352         _insw_ns((u16 __iomem *)(port+pci_io_base), buf, ns);
 353         if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
 354                 eeh_check_failure((void __iomem *)(port), *(u16*)buf);
 355 }
 356
 357 static inline void eeh_insl_ns(unsigned long port, void * buf, int nl)
 358 {
 359         _insl_ns((u32 __iomem *)(port+pci_io_base), buf, nl);
 360         if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
 361                 eeh_check_failure((void __iomem *)(port), *(u32*)buf);
 362 }
 363
 364 #endif /* _PPC64_EEH_H */