arch/powerpc/include/asm/eeh.h

   1 /*
   2  * Copyright (C) 2001  Dave Engebretsen & Todd Inglett IBM Corporation.
   3  * Copyright 2001-2012 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 #include <linux/time.h>
  28 #include <linux/atomic.h>
  29
  30 #include <uapi/asm/eeh.h>
  31
  32 struct pci_dev;
  33 struct pci_bus;
  34 struct pci_dn;
  35
  36 #ifdef CONFIG_EEH
  37
  38 /* EEH subsystem flags */
  39 #define EEH_ENABLED             0x01    /* EEH enabled          */
  40 #define EEH_FORCE_DISABLED      0x02    /* EEH disabled         */
  41 #define EEH_PROBE_MODE_DEV      0x04    /* From PCI device      */
  42 #define EEH_PROBE_MODE_DEVTREE  0x08    /* From device tree     */
  43 #define EEH_VALID_PE_ZERO       0x10    /* PE#0 is valid        */
  44 #define EEH_ENABLE_IO_FOR_LOG   0x20    /* Enable IO for log    */
  45 #define EEH_EARLY_DUMP_LOG      0x40    /* Dump log immediately */
  46
  47 /*
  48  * Delay for PE reset, all in ms
  49  *
  50  * PCI specification has reset hold time of 100 milliseconds.
  51  * We have 250 milliseconds here. The PCI bus settlement time
  52  * is specified as 1.5 seconds and we have 1.8 seconds.
  53  */
  54 #define EEH_PE_RST_HOLD_TIME            250
  55 #define EEH_PE_RST_SETTLE_TIME          1800
  56
  57 /*
  58  * The struct is used to trace PE related EEH functionality.
  59  * In theory, there will have one instance of the struct to
  60  * be created against particular PE. In nature, PEs correlate
  61  * to each other. the struct has to reflect that hierarchy in
  62  * order to easily pick up those affected PEs when one particular
  63  * PE has EEH errors.
  64  *
  65  * Also, one particular PE might be composed of PCI device, PCI
  66  * bus and its subordinate components. The struct also need ship
  67  * the information. Further more, one particular PE is only meaingful
  68  * in the corresponding PHB. Therefore, the root PEs should be created
  69  * against existing PHBs in on-to-one fashion.
  70  */
  71 #define EEH_PE_INVALID  (1 << 0)        /* Invalid   */
  72 #define EEH_PE_PHB      (1 << 1)        /* PHB PE    */
  73 #define EEH_PE_DEVICE   (1 << 2)        /* Device PE */
  74 #define EEH_PE_BUS      (1 << 3)        /* Bus PE    */
  75 #define EEH_PE_VF       (1 << 4)        /* VF PE     */
  76
  77 #define EEH_PE_ISOLATED         (1 << 0)        /* Isolated PE          */
  78 #define EEH_PE_RECOVERING       (1 << 1)        /* Recovering PE        */
  79 #define EEH_PE_CFG_BLOCKED      (1 << 2)        /* Block config access  */
  80 #define EEH_PE_RESET            (1 << 3)        /* PE reset in progress */
  81
  82 #define EEH_PE_KEEP             (1 << 8)        /* Keep PE on hotplug   */
  83 #define EEH_PE_CFG_RESTRICTED   (1 << 9)        /* Block config on error */
  84 #define EEH_PE_REMOVED          (1 << 10)       /* Removed permanently  */
  85 #define EEH_PE_PRI_BUS          (1 << 11)       /* Cached primary bus   */
  86
  87 struct eeh_pe {
  88         int type;                       /* PE type: PHB/Bus/Device      */
  89         int state;                      /* PE EEH dependent mode        */
  90         int config_addr;                /* Traditional PCI address      */
  91         int addr;                       /* PE configuration address     */
  92         struct pci_controller *phb;     /* Associated PHB               */
  93         struct pci_bus *bus;            /* Top PCI bus for bus PE       */
  94         int check_count;                /* Times of ignored error       */
  95         int freeze_count;               /* Times of froze up            */
  96         time64_t tstamp;                /* Time on first-time freeze    */
  97         int false_positives;            /* Times of reported #ff's      */
  98         atomic_t pass_dev_cnt;          /* Count of passed through devs */
  99         struct eeh_pe *parent;          /* Parent PE                    */
 100         void *data;                     /* PE auxillary data            */
 101         struct list_head child_list;    /* Link PE to the child list    */
 102         struct list_head edevs;         /* Link list of EEH devices     */
 103         struct list_head child;         /* Child PEs                    */
 104 };
 105
 106 #define eeh_pe_for_each_dev(pe, edev, tmp) \
 107                 list_for_each_entry_safe(edev, tmp, &pe->edevs, list)
 108
 109 #define eeh_for_each_pe(root, pe) \
 110         for (pe = root; pe; pe = eeh_pe_next(pe, root))
 111
 112 static inline bool eeh_pe_passed(struct eeh_pe *pe)
 113 {
 114         return pe ? !!atomic_read(&pe->pass_dev_cnt) : false;
 115 }
 116
 117 /*
 118  * The struct is used to trace EEH state for the associated
 119  * PCI device node or PCI device. In future, it might
 120  * represent PE as well so that the EEH device to form
 121  * another tree except the currently existing tree of PCI
 122  * buses and PCI devices
 123  */
 124 #define EEH_DEV_BRIDGE          (1 << 0)        /* PCI bridge           */
 125 #define EEH_DEV_ROOT_PORT       (1 << 1)        /* PCIe root port       */
 126 #define EEH_DEV_DS_PORT         (1 << 2)        /* Downstream port      */
 127 #define EEH_DEV_IRQ_DISABLED    (1 << 3)        /* Interrupt disabled   */
 128 #define EEH_DEV_DISCONNECTED    (1 << 4)        /* Removing from PE     */
 129
 130 #define EEH_DEV_NO_HANDLER      (1 << 8)        /* No error handler     */
 131 #define EEH_DEV_SYSFS           (1 << 9)        /* Sysfs created        */
 132 #define EEH_DEV_REMOVED         (1 << 10)       /* Removed permanently  */
 133
 134 struct eeh_dev {
 135         int mode;                       /* EEH mode                     */
 136         int class_code;                 /* Class code of the device     */
 137         int pe_config_addr;             /* PE config address            */
 138         u32 config_space[16];           /* Saved PCI config space       */
 139         int pcix_cap;                   /* Saved PCIx capability        */
 140         int pcie_cap;                   /* Saved PCIe capability        */
 141         int aer_cap;                    /* Saved AER capability         */
 142         int af_cap;                     /* Saved AF capability          */
 143         struct eeh_pe *pe;              /* Associated PE                */
 144         struct list_head list;          /* Form link list in the PE     */
 145         struct list_head rmv_list;      /* Record the removed edevs     */
 146         struct pci_dn *pdn;             /* Associated PCI device node   */
 147         struct pci_dev *pdev;           /* Associated PCI device        */
 148         bool in_error;                  /* Error flag for edev          */
 149         struct pci_dev *physfn;         /* Associated SRIOV PF          */
 150         struct pci_bus *bus;            /* PCI bus for partial hotplug  */
 151 };
 152
 153 static inline struct pci_dn *eeh_dev_to_pdn(struct eeh_dev *edev)
 154 {
 155         return edev ? edev->pdn : NULL;
 156 }
 157
 158 static inline struct pci_dev *eeh_dev_to_pci_dev(struct eeh_dev *edev)
 159 {
 160         return edev ? edev->pdev : NULL;
 161 }
 162
 163 static inline struct eeh_pe *eeh_dev_to_pe(struct eeh_dev* edev)
 164 {
 165         return edev ? edev->pe : NULL;
 166 }
 167
 168 /* Return values from eeh_ops::next_error */
 169 enum {
 170         EEH_NEXT_ERR_NONE = 0,
 171         EEH_NEXT_ERR_INF,
 172         EEH_NEXT_ERR_FROZEN_PE,
 173         EEH_NEXT_ERR_FENCED_PHB,
 174         EEH_NEXT_ERR_DEAD_PHB,
 175         EEH_NEXT_ERR_DEAD_IOC
 176 };
 177
 178 /*
 179  * The struct is used to trace the registered EEH operation
 180  * callback functions. Actually, those operation callback
 181  * functions are heavily platform dependent. That means the
 182  * platform should register its own EEH operation callback
 183  * functions before any EEH further operations.
 184  */
 185 #define EEH_OPT_DISABLE         0       /* EEH disable  */
 186 #define EEH_OPT_ENABLE          1       /* EEH enable   */
 187 #define EEH_OPT_THAW_MMIO       2       /* MMIO enable  */
 188 #define EEH_OPT_THAW_DMA        3       /* DMA enable   */
 189 #define EEH_OPT_FREEZE_PE       4       /* Freeze PE    */
 190 #define EEH_STATE_UNAVAILABLE   (1 << 0)        /* State unavailable    */
 191 #define EEH_STATE_NOT_SUPPORT   (1 << 1)        /* EEH not supported    */
 192 #define EEH_STATE_RESET_ACTIVE  (1 << 2)        /* Active reset         */
 193 #define EEH_STATE_MMIO_ACTIVE   (1 << 3)        /* Active MMIO          */
 194 #define EEH_STATE_DMA_ACTIVE    (1 << 4)        /* Active DMA           */
 195 #define EEH_STATE_MMIO_ENABLED  (1 << 5)        /* MMIO enabled         */
 196 #define EEH_STATE_DMA_ENABLED   (1 << 6)        /* DMA enabled          */
 197 #define EEH_RESET_DEACTIVATE    0       /* Deactivate the PE reset      */
 198 #define EEH_RESET_HOT           1       /* Hot reset                    */
 199 #define EEH_RESET_FUNDAMENTAL   3       /* Fundamental reset            */
 200 #define EEH_LOG_TEMP            1       /* EEH temporary error log      */
 201 #define EEH_LOG_PERM            2       /* EEH permanent error log      */
 202
 203 struct eeh_ops {
 204         char *name;
 205         int (*init)(void);
 206         void* (*probe)(struct pci_dn *pdn, void *data);
 207         int (*set_option)(struct eeh_pe *pe, int option);
 208         int (*get_pe_addr)(struct eeh_pe *pe);
 209         int (*get_state)(struct eeh_pe *pe, int *state);
 210         int (*reset)(struct eeh_pe *pe, int option);
 211         int (*wait_state)(struct eeh_pe *pe, int max_wait);
 212         int (*get_log)(struct eeh_pe *pe, int severity, char *drv_log, unsigned long len);
 213         int (*configure_bridge)(struct eeh_pe *pe);
 214         int (*err_inject)(struct eeh_pe *pe, int type, int func,
 215                           unsigned long addr, unsigned long mask);
 216         int (*read_config)(struct pci_dn *pdn, int where, int size, u32 *val);
 217         int (*write_config)(struct pci_dn *pdn, int where, int size, u32 val);
 218         int (*next_error)(struct eeh_pe **pe);
 219         int (*restore_config)(struct pci_dn *pdn);
 220         int (*notify_resume)(struct pci_dn *pdn);
 221 };
 222
 223 extern int eeh_subsystem_flags;
 224 extern int eeh_max_freezes;
 225 extern struct eeh_ops *eeh_ops;
 226 extern raw_spinlock_t confirm_error_lock;
 227
 228 static inline void eeh_add_flag(int flag)
 229 {
 230         eeh_subsystem_flags |= flag;
 231 }
 232
 233 static inline void eeh_clear_flag(int flag)
 234 {
 235         eeh_subsystem_flags &= ~flag;
 236 }
 237
 238 static inline bool eeh_has_flag(int flag)
 239 {
 240         return !!(eeh_subsystem_flags & flag);
 241 }
 242
 243 static inline bool eeh_enabled(void)
 244 {
 245         if (eeh_has_flag(EEH_FORCE_DISABLED) ||
 246             !eeh_has_flag(EEH_ENABLED))
 247                 return false;
 248
 249         return true;
 250 }
 251
 252 static inline void eeh_serialize_lock(unsigned long *flags)
 253 {
 254         raw_spin_lock_irqsave(&confirm_error_lock, *flags);
 255 }
 256
 257 static inline void eeh_serialize_unlock(unsigned long flags)
 258 {
 259         raw_spin_unlock_irqrestore(&confirm_error_lock, flags);
 260 }
 261
 262 static inline bool eeh_state_active(int state)
 263 {
 264         return (state & (EEH_STATE_MMIO_ACTIVE | EEH_STATE_DMA_ACTIVE))
 265         == (EEH_STATE_MMIO_ACTIVE | EEH_STATE_DMA_ACTIVE);
 266 }
 267
 268 typedef void *(*eeh_edev_traverse_func)(struct eeh_dev *edev, void *flag);
 269 typedef void *(*eeh_pe_traverse_func)(struct eeh_pe *pe, void *flag);
 270 void eeh_set_pe_aux_size(int size);
 271 int eeh_phb_pe_create(struct pci_controller *phb);
 272 struct eeh_pe *eeh_phb_pe_get(struct pci_controller *phb);
 273 struct eeh_pe *eeh_pe_next(struct eeh_pe *pe, struct eeh_pe *root);
 274 struct eeh_pe *eeh_pe_get(struct pci_controller *phb,
 275                           int pe_no, int config_addr);
 276 int eeh_add_to_parent_pe(struct eeh_dev *edev);
 277 int eeh_rmv_from_parent_pe(struct eeh_dev *edev);
 278 void eeh_pe_update_time_stamp(struct eeh_pe *pe);
 279 void *eeh_pe_traverse(struct eeh_pe *root,
 280                       eeh_pe_traverse_func fn, void *flag);
 281 void *eeh_pe_dev_traverse(struct eeh_pe *root,
 282                           eeh_edev_traverse_func fn, void *flag);
 283 void eeh_pe_restore_bars(struct eeh_pe *pe);
 284 const char *eeh_pe_loc_get(struct eeh_pe *pe);
 285 struct pci_bus *eeh_pe_bus_get(struct eeh_pe *pe);
 286
 287 struct eeh_dev *eeh_dev_init(struct pci_dn *pdn);
 288 void eeh_dev_phb_init_dynamic(struct pci_controller *phb);
 289 void eeh_probe_devices(void);
 290 int __init eeh_ops_register(struct eeh_ops *ops);
 291 int __exit eeh_ops_unregister(const char *name);
 292 int eeh_check_failure(const volatile void __iomem *token);
 293 int eeh_dev_check_failure(struct eeh_dev *edev);
 294 void eeh_addr_cache_build(void);
 295 void eeh_add_device_early(struct pci_dn *);
 296 void eeh_add_device_tree_early(struct pci_dn *);
 297 void eeh_add_device_late(struct pci_dev *);
 298 void eeh_add_device_tree_late(struct pci_bus *);
 299 void eeh_add_sysfs_files(struct pci_bus *);
 300 void eeh_remove_device(struct pci_dev *);
 301 int eeh_unfreeze_pe(struct eeh_pe *pe, bool sw_state);
 302 int eeh_pe_reset_and_recover(struct eeh_pe *pe);
 303 int eeh_dev_open(struct pci_dev *pdev);
 304 void eeh_dev_release(struct pci_dev *pdev);
 305 struct eeh_pe *eeh_iommu_group_to_pe(struct iommu_group *group);
 306 int eeh_pe_set_option(struct eeh_pe *pe, int option);
 307 int eeh_pe_get_state(struct eeh_pe *pe);
 308 int eeh_pe_reset(struct eeh_pe *pe, int option);
 309 int eeh_pe_configure(struct eeh_pe *pe);
 310 int eeh_pe_inject_err(struct eeh_pe *pe, int type, int func,
 311                       unsigned long addr, unsigned long mask);
 312 int eeh_restore_vf_config(struct pci_dn *pdn);
 313
 314 /**
 315  * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
 316  *
 317  * If this macro yields TRUE, the caller relays to eeh_check_failure()
 318  * which does further tests out of line.
 319  */
 320 #define EEH_POSSIBLE_ERROR(val, type)   ((val) == (type)~0 && eeh_enabled())
 321
 322 /*
 323  * Reads from a device which has been isolated by EEH will return
 324  * all 1s.  This macro gives an all-1s value of the given size (in
 325  * bytes: 1, 2, or 4) for comparing with the result of a read.
 326  */
 327 #define EEH_IO_ERROR_VALUE(size)        (~0U >> ((4 - (size)) * 8))
 328
 329 #else /* !CONFIG_EEH */
 330
 331 static inline bool eeh_enabled(void)
 332 {
 333         return false;
 334 }
 335
 336 static inline void eeh_probe_devices(void) { }
 337
 338 static inline void *eeh_dev_init(struct pci_dn *pdn, void *data)
 339 {
 340         return NULL;
 341 }
 342
 343 static inline void eeh_dev_phb_init_dynamic(struct pci_controller *phb) { }
 344
 345 static inline int eeh_check_failure(const volatile void __iomem *token)
 346 {
 347         return 0;
 348 }
 349
 350 #define eeh_dev_check_failure(x) (0)
 351
 352 static inline void eeh_addr_cache_build(void) { }
 353
 354 static inline void eeh_add_device_early(struct pci_dn *pdn) { }
 355
 356 static inline void eeh_add_device_tree_early(struct pci_dn *pdn) { }
 357
 358 static inline void eeh_add_device_late(struct pci_dev *dev) { }
 359
 360 static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
 361
 362 static inline void eeh_add_sysfs_files(struct pci_bus *bus) { }
 363
 364 static inline void eeh_remove_device(struct pci_dev *dev) { }
 365
 366 #define EEH_POSSIBLE_ERROR(val, type) (0)
 367 #define EEH_IO_ERROR_VALUE(size) (-1UL)
 368 #endif /* CONFIG_EEH */
 369
 370 #ifdef CONFIG_PPC64
 371 /*
 372  * MMIO read/write operations with EEH support.
 373  */
 374 static inline u8 eeh_readb(const volatile void __iomem *addr)
 375 {
 376         u8 val = in_8(addr);
 377         if (EEH_POSSIBLE_ERROR(val, u8))
 378                 eeh_check_failure(addr);
 379         return val;
 380 }
 381
 382 static inline u16 eeh_readw(const volatile void __iomem *addr)
 383 {
 384         u16 val = in_le16(addr);
 385         if (EEH_POSSIBLE_ERROR(val, u16))
 386                 eeh_check_failure(addr);
 387         return val;
 388 }
 389
 390 static inline u32 eeh_readl(const volatile void __iomem *addr)
 391 {
 392         u32 val = in_le32(addr);
 393         if (EEH_POSSIBLE_ERROR(val, u32))
 394                 eeh_check_failure(addr);
 395         return val;
 396 }
 397
 398 static inline u64 eeh_readq(const volatile void __iomem *addr)
 399 {
 400         u64 val = in_le64(addr);
 401         if (EEH_POSSIBLE_ERROR(val, u64))
 402                 eeh_check_failure(addr);
 403         return val;
 404 }
 405
 406 static inline u16 eeh_readw_be(const volatile void __iomem *addr)
 407 {
 408         u16 val = in_be16(addr);
 409         if (EEH_POSSIBLE_ERROR(val, u16))
 410                 eeh_check_failure(addr);
 411         return val;
 412 }
 413
 414 static inline u32 eeh_readl_be(const volatile void __iomem *addr)
 415 {
 416         u32 val = in_be32(addr);
 417         if (EEH_POSSIBLE_ERROR(val, u32))
 418                 eeh_check_failure(addr);
 419         return val;
 420 }
 421
 422 static inline u64 eeh_readq_be(const volatile void __iomem *addr)
 423 {
 424         u64 val = in_be64(addr);
 425         if (EEH_POSSIBLE_ERROR(val, u64))
 426                 eeh_check_failure(addr);
 427         return val;
 428 }
 429
 430 static inline void eeh_memcpy_fromio(void *dest, const
 431                                      volatile void __iomem *src,
 432                                      unsigned long n)
 433 {
 434         _memcpy_fromio(dest, src, n);
 435
 436         /* Look for ffff's here at dest[n].  Assume that at least 4 bytes
 437          * were copied. Check all four bytes.
 438          */
 439         if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
 440                 eeh_check_failure(src);
 441 }
 442
 443 /* in-string eeh macros */
 444 static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
 445                               int ns)
 446 {
 447         _insb(addr, buf, ns);
 448         if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
 449                 eeh_check_failure(addr);
 450 }
 451
 452 static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
 453                               int ns)
 454 {
 455         _insw(addr, buf, ns);
 456         if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
 457                 eeh_check_failure(addr);
 458 }
 459
 460 static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
 461                               int nl)
 462 {
 463         _insl(addr, buf, nl);
 464         if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
 465                 eeh_check_failure(addr);
 466 }
 467
 468 #endif /* CONFIG_PPC64 */
 469 #endif /* __KERNEL__ */
 470 #endif /* _POWERPC_EEH_H */