2 * Copyright (C) 2001 Dave Engebretsen & Todd Inglett IBM Corporation.
3 * Copyright 2001-2012 IBM Corporation.
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.
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.
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
20 #ifndef _POWERPC_EEH_H
21 #define _POWERPC_EEH_H
24 #include <linux/init.h>
25 #include <linux/list.h>
26 #include <linux/string.h>
27 #include <linux/time.h>
35 /* EEH subsystem flags */
36 #define EEH_ENABLED 0x1 /* EEH enabled */
37 #define EEH_FORCE_DISABLED 0x2 /* EEH disabled */
38 #define EEH_PROBE_MODE_DEV 0x4 /* From PCI device */
39 #define EEH_PROBE_MODE_DEVTREE 0x8 /* From device tree */
42 * Delay for PE reset, all in ms
44 * PCI specification has reset hold time of 100 milliseconds.
45 * We have 250 milliseconds here. The PCI bus settlement time
46 * is specified as 1.5 seconds and we have 1.8 seconds.
48 #define EEH_PE_RST_HOLD_TIME 250
49 #define EEH_PE_RST_SETTLE_TIME 1800
52 * The struct is used to trace PE related EEH functionality.
53 * In theory, there will have one instance of the struct to
54 * be created against particular PE. In nature, PEs corelate
55 * to each other. the struct has to reflect that hierarchy in
56 * order to easily pick up those affected PEs when one particular
59 * Also, one particular PE might be composed of PCI device, PCI
60 * bus and its subordinate components. The struct also need ship
61 * the information. Further more, one particular PE is only meaingful
62 * in the corresponding PHB. Therefore, the root PEs should be created
63 * against existing PHBs in on-to-one fashion.
65 #define EEH_PE_INVALID (1 << 0) /* Invalid */
66 #define EEH_PE_PHB (1 << 1) /* PHB PE */
67 #define EEH_PE_DEVICE (1 << 2) /* Device PE */
68 #define EEH_PE_BUS (1 << 3) /* Bus PE */
70 #define EEH_PE_ISOLATED (1 << 0) /* Isolated PE */
71 #define EEH_PE_RECOVERING (1 << 1) /* Recovering PE */
72 #define EEH_PE_RESET (1 << 2) /* PE reset in progress */
74 #define EEH_PE_KEEP (1 << 8) /* Keep PE on hotplug */
77 int type
; /* PE type: PHB/Bus/Device */
78 int state
; /* PE EEH dependent mode */
79 int config_addr
; /* Traditional PCI address */
80 int addr
; /* PE configuration address */
81 struct pci_controller
*phb
; /* Associated PHB */
82 struct pci_bus
*bus
; /* Top PCI bus for bus PE */
83 int check_count
; /* Times of ignored error */
84 int freeze_count
; /* Times of froze up */
85 struct timeval tstamp
; /* Time on first-time freeze */
86 int false_positives
; /* Times of reported #ff's */
87 struct eeh_pe
*parent
; /* Parent PE */
88 struct list_head child_list
; /* Link PE to the child list */
89 struct list_head edevs
; /* Link list of EEH devices */
90 struct list_head child
; /* Child PEs */
93 #define eeh_pe_for_each_dev(pe, edev, tmp) \
94 list_for_each_entry_safe(edev, tmp, &pe->edevs, list)
97 * The struct is used to trace EEH state for the associated
98 * PCI device node or PCI device. In future, it might
99 * represent PE as well so that the EEH device to form
100 * another tree except the currently existing tree of PCI
101 * buses and PCI devices
103 #define EEH_DEV_BRIDGE (1 << 0) /* PCI bridge */
104 #define EEH_DEV_ROOT_PORT (1 << 1) /* PCIe root port */
105 #define EEH_DEV_DS_PORT (1 << 2) /* Downstream port */
106 #define EEH_DEV_IRQ_DISABLED (1 << 3) /* Interrupt disabled */
107 #define EEH_DEV_DISCONNECTED (1 << 4) /* Removing from PE */
109 #define EEH_DEV_NO_HANDLER (1 << 8) /* No error handler */
110 #define EEH_DEV_SYSFS (1 << 9) /* Sysfs created */
111 #define EEH_DEV_REMOVED (1 << 10) /* Removed permanently */
114 int mode
; /* EEH mode */
115 int class_code
; /* Class code of the device */
116 int config_addr
; /* Config address */
117 int pe_config_addr
; /* PE config address */
118 u32 config_space
[16]; /* Saved PCI config space */
119 int pcix_cap
; /* Saved PCIx capability */
120 int pcie_cap
; /* Saved PCIe capability */
121 int aer_cap
; /* Saved AER capability */
122 struct eeh_pe
*pe
; /* Associated PE */
123 struct list_head list
; /* Form link list in the PE */
124 struct pci_controller
*phb
; /* Associated PHB */
125 struct device_node
*dn
; /* Associated device node */
126 struct pci_dev
*pdev
; /* Associated PCI device */
127 struct pci_bus
*bus
; /* PCI bus for partial hotplug */
130 static inline struct device_node
*eeh_dev_to_of_node(struct eeh_dev
*edev
)
132 return edev
? edev
->dn
: NULL
;
135 static inline struct pci_dev
*eeh_dev_to_pci_dev(struct eeh_dev
*edev
)
137 return edev
? edev
->pdev
: NULL
;
140 /* Return values from eeh_ops::next_error */
142 EEH_NEXT_ERR_NONE
= 0,
144 EEH_NEXT_ERR_FROZEN_PE
,
145 EEH_NEXT_ERR_FENCED_PHB
,
146 EEH_NEXT_ERR_DEAD_PHB
,
147 EEH_NEXT_ERR_DEAD_IOC
151 * The struct is used to trace the registered EEH operation
152 * callback functions. Actually, those operation callback
153 * functions are heavily platform dependent. That means the
154 * platform should register its own EEH operation callback
155 * functions before any EEH further operations.
157 #define EEH_OPT_DISABLE 0 /* EEH disable */
158 #define EEH_OPT_ENABLE 1 /* EEH enable */
159 #define EEH_OPT_THAW_MMIO 2 /* MMIO enable */
160 #define EEH_OPT_THAW_DMA 3 /* DMA enable */
161 #define EEH_STATE_UNAVAILABLE (1 << 0) /* State unavailable */
162 #define EEH_STATE_NOT_SUPPORT (1 << 1) /* EEH not supported */
163 #define EEH_STATE_RESET_ACTIVE (1 << 2) /* Active reset */
164 #define EEH_STATE_MMIO_ACTIVE (1 << 3) /* Active MMIO */
165 #define EEH_STATE_DMA_ACTIVE (1 << 4) /* Active DMA */
166 #define EEH_STATE_MMIO_ENABLED (1 << 5) /* MMIO enabled */
167 #define EEH_STATE_DMA_ENABLED (1 << 6) /* DMA enabled */
168 #define EEH_RESET_DEACTIVATE 0 /* Deactivate the PE reset */
169 #define EEH_RESET_HOT 1 /* Hot reset */
170 #define EEH_RESET_FUNDAMENTAL 3 /* Fundamental reset */
171 #define EEH_LOG_TEMP 1 /* EEH temporary error log */
172 #define EEH_LOG_PERM 2 /* EEH permanent error log */
177 int (*post_init
)(void);
178 void* (*of_probe
)(struct device_node
*dn
, void *flag
);
179 int (*dev_probe
)(struct pci_dev
*dev
, void *flag
);
180 int (*set_option
)(struct eeh_pe
*pe
, int option
);
181 int (*get_pe_addr
)(struct eeh_pe
*pe
);
182 int (*get_state
)(struct eeh_pe
*pe
, int *state
);
183 int (*reset
)(struct eeh_pe
*pe
, int option
);
184 int (*wait_state
)(struct eeh_pe
*pe
, int max_wait
);
185 int (*get_log
)(struct eeh_pe
*pe
, int severity
, char *drv_log
, unsigned long len
);
186 int (*configure_bridge
)(struct eeh_pe
*pe
);
187 int (*read_config
)(struct device_node
*dn
, int where
, int size
, u32
*val
);
188 int (*write_config
)(struct device_node
*dn
, int where
, int size
, u32 val
);
189 int (*next_error
)(struct eeh_pe
**pe
);
190 int (*restore_config
)(struct device_node
*dn
);
193 extern int eeh_subsystem_flags
;
194 extern struct eeh_ops
*eeh_ops
;
195 extern raw_spinlock_t confirm_error_lock
;
197 static inline bool eeh_enabled(void)
199 if ((eeh_subsystem_flags
& EEH_FORCE_DISABLED
) ||
200 !(eeh_subsystem_flags
& EEH_ENABLED
))
206 static inline void eeh_set_enable(bool mode
)
209 eeh_subsystem_flags
|= EEH_ENABLED
;
211 eeh_subsystem_flags
&= ~EEH_ENABLED
;
214 static inline void eeh_probe_mode_set(int flag
)
216 eeh_subsystem_flags
|= flag
;
219 static inline int eeh_probe_mode_devtree(void)
221 return (eeh_subsystem_flags
& EEH_PROBE_MODE_DEVTREE
);
224 static inline int eeh_probe_mode_dev(void)
226 return (eeh_subsystem_flags
& EEH_PROBE_MODE_DEV
);
229 static inline void eeh_serialize_lock(unsigned long *flags
)
231 raw_spin_lock_irqsave(&confirm_error_lock
, *flags
);
234 static inline void eeh_serialize_unlock(unsigned long flags
)
236 raw_spin_unlock_irqrestore(&confirm_error_lock
, flags
);
240 * Max number of EEH freezes allowed before we consider the device
241 * to be permanently disabled.
243 #define EEH_MAX_ALLOWED_FREEZES 5
245 typedef void *(*eeh_traverse_func
)(void *data
, void *flag
);
246 int eeh_phb_pe_create(struct pci_controller
*phb
);
247 struct eeh_pe
*eeh_phb_pe_get(struct pci_controller
*phb
);
248 struct eeh_pe
*eeh_pe_get(struct eeh_dev
*edev
);
249 int eeh_add_to_parent_pe(struct eeh_dev
*edev
);
250 int eeh_rmv_from_parent_pe(struct eeh_dev
*edev
);
251 void eeh_pe_update_time_stamp(struct eeh_pe
*pe
);
252 void *eeh_pe_traverse(struct eeh_pe
*root
,
253 eeh_traverse_func fn
, void *flag
);
254 void *eeh_pe_dev_traverse(struct eeh_pe
*root
,
255 eeh_traverse_func fn
, void *flag
);
256 void eeh_pe_restore_bars(struct eeh_pe
*pe
);
257 struct pci_bus
*eeh_pe_bus_get(struct eeh_pe
*pe
);
259 void *eeh_dev_init(struct device_node
*dn
, void *data
);
260 void eeh_dev_phb_init_dynamic(struct pci_controller
*phb
);
262 int __init
eeh_ops_register(struct eeh_ops
*ops
);
263 int __exit
eeh_ops_unregister(const char *name
);
264 unsigned long eeh_check_failure(const volatile void __iomem
*token
,
266 int eeh_dev_check_failure(struct eeh_dev
*edev
);
267 void eeh_addr_cache_build(void);
268 void eeh_add_device_early(struct device_node
*);
269 void eeh_add_device_tree_early(struct device_node
*);
270 void eeh_add_device_late(struct pci_dev
*);
271 void eeh_add_device_tree_late(struct pci_bus
*);
272 void eeh_add_sysfs_files(struct pci_bus
*);
273 void eeh_remove_device(struct pci_dev
*);
276 * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
278 * If this macro yields TRUE, the caller relays to eeh_check_failure()
279 * which does further tests out of line.
281 #define EEH_POSSIBLE_ERROR(val, type) ((val) == (type)~0 && eeh_enabled())
284 * Reads from a device which has been isolated by EEH will return
285 * all 1s. This macro gives an all-1s value of the given size (in
286 * bytes: 1, 2, or 4) for comparing with the result of a read.
288 #define EEH_IO_ERROR_VALUE(size) (~0U >> ((4 - (size)) * 8))
290 #else /* !CONFIG_EEH */
292 static inline bool eeh_enabled(void)
297 static inline void eeh_set_enable(bool mode
) { }
299 static inline int eeh_init(void)
304 static inline void *eeh_dev_init(struct device_node
*dn
, void *data
)
309 static inline void eeh_dev_phb_init_dynamic(struct pci_controller
*phb
) { }
311 static inline unsigned long eeh_check_failure(const volatile void __iomem
*token
, unsigned long val
)
316 #define eeh_dev_check_failure(x) (0)
318 static inline void eeh_addr_cache_build(void) { }
320 static inline void eeh_add_device_early(struct device_node
*dn
) { }
322 static inline void eeh_add_device_tree_early(struct device_node
*dn
) { }
324 static inline void eeh_add_device_late(struct pci_dev
*dev
) { }
326 static inline void eeh_add_device_tree_late(struct pci_bus
*bus
) { }
328 static inline void eeh_add_sysfs_files(struct pci_bus
*bus
) { }
330 static inline void eeh_remove_device(struct pci_dev
*dev
) { }
332 #define EEH_POSSIBLE_ERROR(val, type) (0)
333 #define EEH_IO_ERROR_VALUE(size) (-1UL)
334 #endif /* CONFIG_EEH */
338 * MMIO read/write operations with EEH support.
340 static inline u8
eeh_readb(const volatile void __iomem
*addr
)
343 if (EEH_POSSIBLE_ERROR(val
, u8
))
344 return eeh_check_failure(addr
, val
);
348 static inline u16
eeh_readw(const volatile void __iomem
*addr
)
350 u16 val
= in_le16(addr
);
351 if (EEH_POSSIBLE_ERROR(val
, u16
))
352 return eeh_check_failure(addr
, val
);
356 static inline u32
eeh_readl(const volatile void __iomem
*addr
)
358 u32 val
= in_le32(addr
);
359 if (EEH_POSSIBLE_ERROR(val
, u32
))
360 return eeh_check_failure(addr
, val
);
364 static inline u64
eeh_readq(const volatile void __iomem
*addr
)
366 u64 val
= in_le64(addr
);
367 if (EEH_POSSIBLE_ERROR(val
, u64
))
368 return eeh_check_failure(addr
, val
);
372 static inline u16
eeh_readw_be(const volatile void __iomem
*addr
)
374 u16 val
= in_be16(addr
);
375 if (EEH_POSSIBLE_ERROR(val
, u16
))
376 return eeh_check_failure(addr
, val
);
380 static inline u32
eeh_readl_be(const volatile void __iomem
*addr
)
382 u32 val
= in_be32(addr
);
383 if (EEH_POSSIBLE_ERROR(val
, u32
))
384 return eeh_check_failure(addr
, val
);
388 static inline u64
eeh_readq_be(const volatile void __iomem
*addr
)
390 u64 val
= in_be64(addr
);
391 if (EEH_POSSIBLE_ERROR(val
, u64
))
392 return eeh_check_failure(addr
, val
);
396 static inline void eeh_memcpy_fromio(void *dest
, const
397 volatile void __iomem
*src
,
400 _memcpy_fromio(dest
, src
, n
);
402 /* Look for ffff's here at dest[n]. Assume that at least 4 bytes
403 * were copied. Check all four bytes.
405 if (n
>= 4 && EEH_POSSIBLE_ERROR(*((u32
*)(dest
+ n
- 4)), u32
))
406 eeh_check_failure(src
, *((u32
*)(dest
+ n
- 4)));
409 /* in-string eeh macros */
410 static inline void eeh_readsb(const volatile void __iomem
*addr
, void * buf
,
413 _insb(addr
, buf
, ns
);
414 if (EEH_POSSIBLE_ERROR((*(((u8
*)buf
)+ns
-1)), u8
))
415 eeh_check_failure(addr
, *(u8
*)buf
);
418 static inline void eeh_readsw(const volatile void __iomem
*addr
, void * buf
,
421 _insw(addr
, buf
, ns
);
422 if (EEH_POSSIBLE_ERROR((*(((u16
*)buf
)+ns
-1)), u16
))
423 eeh_check_failure(addr
, *(u16
*)buf
);
426 static inline void eeh_readsl(const volatile void __iomem
*addr
, void * buf
,
429 _insl(addr
, buf
, nl
);
430 if (EEH_POSSIBLE_ERROR((*(((u32
*)buf
)+nl
-1)), u32
))
431 eeh_check_failure(addr
, *(u32
*)buf
);
434 #endif /* CONFIG_PPC64 */
435 #endif /* __KERNEL__ */
436 #endif /* _POWERPC_EEH_H */