]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - arch/powerpc/include/asm/eeh.h
powerpc/pci/hotplug: Don't need to remove from EEH cache twice
[mirror_ubuntu-jammy-kernel.git] / arch / powerpc / include / asm / eeh.h
CommitLineData
172ca926 1/*
1da177e4 2 * Copyright (C) 2001 Dave Engebretsen & Todd Inglett IBM Corporation.
cb3bc9d0 3 * Copyright 2001-2012 IBM Corporation.
1da177e4
LT
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.
172ca926 9 *
1da177e4
LT
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.
172ca926 14 *
1da177e4
LT
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
8b8da358
BH
20#ifndef _POWERPC_EEH_H
21#define _POWERPC_EEH_H
88ced031 22#ifdef __KERNEL__
1da177e4 23
1da177e4
LT
24#include <linux/init.h>
25#include <linux/list.h>
26#include <linux/string.h>
5a71978e 27#include <linux/time.h>
1da177e4
LT
28
29struct pci_dev;
827c1a6c 30struct pci_bus;
1da177e4 31struct device_node;
1da177e4
LT
32
33#ifdef CONFIG_EEH
34
968f968f
GS
35/*
36 * The struct is used to trace PE related EEH functionality.
37 * In theory, there will have one instance of the struct to
38 * be created against particular PE. In nature, PEs corelate
39 * to each other. the struct has to reflect that hierarchy in
40 * order to easily pick up those affected PEs when one particular
41 * PE has EEH errors.
42 *
43 * Also, one particular PE might be composed of PCI device, PCI
44 * bus and its subordinate components. The struct also need ship
45 * the information. Further more, one particular PE is only meaingful
46 * in the corresponding PHB. Therefore, the root PEs should be created
47 * against existing PHBs in on-to-one fashion.
48 */
5efc3ad7
GS
49#define EEH_PE_INVALID (1 << 0) /* Invalid */
50#define EEH_PE_PHB (1 << 1) /* PHB PE */
51#define EEH_PE_DEVICE (1 << 2) /* Device PE */
52#define EEH_PE_BUS (1 << 3) /* Bus PE */
968f968f
GS
53
54#define EEH_PE_ISOLATED (1 << 0) /* Isolated PE */
55#define EEH_PE_RECOVERING (1 << 1) /* Recovering PE */
8a6b1bc7 56#define EEH_PE_PHB_DEAD (1 << 2) /* Dead PHB */
968f968f
GS
57
58struct eeh_pe {
59 int type; /* PE type: PHB/Bus/Device */
60 int state; /* PE EEH dependent mode */
61 int config_addr; /* Traditional PCI address */
62 int addr; /* PE configuration address */
63 struct pci_controller *phb; /* Associated PHB */
8cdb2833 64 struct pci_bus *bus; /* Top PCI bus for bus PE */
968f968f
GS
65 int check_count; /* Times of ignored error */
66 int freeze_count; /* Times of froze up */
5a71978e 67 struct timeval tstamp; /* Time on first-time freeze */
968f968f
GS
68 int false_positives; /* Times of reported #ff's */
69 struct eeh_pe *parent; /* Parent PE */
70 struct list_head child_list; /* Link PE to the child list */
71 struct list_head edevs; /* Link list of EEH devices */
72 struct list_head child; /* Child PEs */
73};
74
5b663529
GS
75#define eeh_pe_for_each_dev(pe, edev) \
76 list_for_each_entry(edev, &pe->edevs, list)
77
eb740b5f
GS
78/*
79 * The struct is used to trace EEH state for the associated
80 * PCI device node or PCI device. In future, it might
81 * represent PE as well so that the EEH device to form
82 * another tree except the currently existing tree of PCI
83 * buses and PCI devices
84 */
dbbceee1 85#define EEH_DEV_IRQ_DISABLED (1<<0) /* Interrupt disabled */
eb740b5f
GS
86
87struct eeh_dev {
88 int mode; /* EEH mode */
89 int class_code; /* Class code of the device */
90 int config_addr; /* Config address */
91 int pe_config_addr; /* PE config address */
eb740b5f 92 u32 config_space[16]; /* Saved PCI config space */
968f968f
GS
93 struct eeh_pe *pe; /* Associated PE */
94 struct list_head list; /* Form link list in the PE */
eb740b5f
GS
95 struct pci_controller *phb; /* Associated PHB */
96 struct device_node *dn; /* Associated device node */
97 struct pci_dev *pdev; /* Associated PCI device */
98};
99
100static inline struct device_node *eeh_dev_to_of_node(struct eeh_dev *edev)
101{
2d5c1216 102 return edev ? edev->dn : NULL;
eb740b5f
GS
103}
104
105static inline struct pci_dev *eeh_dev_to_pci_dev(struct eeh_dev *edev)
106{
2d5c1216 107 return edev ? edev->pdev : NULL;
eb740b5f
GS
108}
109
aa1e6374
GS
110/*
111 * The struct is used to trace the registered EEH operation
112 * callback functions. Actually, those operation callback
113 * functions are heavily platform dependent. That means the
114 * platform should register its own EEH operation callback
115 * functions before any EEH further operations.
116 */
8fb8f709
GS
117#define EEH_OPT_DISABLE 0 /* EEH disable */
118#define EEH_OPT_ENABLE 1 /* EEH enable */
119#define EEH_OPT_THAW_MMIO 2 /* MMIO enable */
120#define EEH_OPT_THAW_DMA 3 /* DMA enable */
eb594a47
GS
121#define EEH_STATE_UNAVAILABLE (1 << 0) /* State unavailable */
122#define EEH_STATE_NOT_SUPPORT (1 << 1) /* EEH not supported */
123#define EEH_STATE_RESET_ACTIVE (1 << 2) /* Active reset */
124#define EEH_STATE_MMIO_ACTIVE (1 << 3) /* Active MMIO */
125#define EEH_STATE_DMA_ACTIVE (1 << 4) /* Active DMA */
126#define EEH_STATE_MMIO_ENABLED (1 << 5) /* MMIO enabled */
127#define EEH_STATE_DMA_ENABLED (1 << 6) /* DMA enabled */
2652481f
GS
128#define EEH_RESET_DEACTIVATE 0 /* Deactivate the PE reset */
129#define EEH_RESET_HOT 1 /* Hot reset */
130#define EEH_RESET_FUNDAMENTAL 3 /* Fundamental reset */
8d633291
GS
131#define EEH_LOG_TEMP 1 /* EEH temporary error log */
132#define EEH_LOG_PERM 2 /* EEH permanent error log */
eb594a47 133
aa1e6374
GS
134struct eeh_ops {
135 char *name;
136 int (*init)(void);
21fd21f5 137 int (*post_init)(void);
d7bb8862 138 void* (*of_probe)(struct device_node *dn, void *flag);
51fb5f56 139 int (*dev_probe)(struct pci_dev *dev, void *flag);
371a395d
GS
140 int (*set_option)(struct eeh_pe *pe, int option);
141 int (*get_pe_addr)(struct eeh_pe *pe);
142 int (*get_state)(struct eeh_pe *pe, int *state);
143 int (*reset)(struct eeh_pe *pe, int option);
144 int (*wait_state)(struct eeh_pe *pe, int max_wait);
145 int (*get_log)(struct eeh_pe *pe, int severity, char *drv_log, unsigned long len);
146 int (*configure_bridge)(struct eeh_pe *pe);
3780444c
GS
147 int (*read_config)(struct device_node *dn, int where, int size, u32 *val);
148 int (*write_config)(struct device_node *dn, int where, int size, u32 val);
8a6b1bc7 149 int (*next_error)(struct eeh_pe **pe);
aa1e6374
GS
150};
151
152extern struct eeh_ops *eeh_ops;
1e28a7dd 153extern int eeh_subsystem_enabled;
4907581d 154extern raw_spinlock_t confirm_error_lock;
d7bb8862
GS
155extern int eeh_probe_mode;
156
157#define EEH_PROBE_MODE_DEV (1<<0) /* From PCI device */
158#define EEH_PROBE_MODE_DEVTREE (1<<1) /* From device tree */
159
160static inline void eeh_probe_mode_set(int flag)
161{
162 eeh_probe_mode = flag;
163}
164
165static inline int eeh_probe_mode_devtree(void)
166{
167 return (eeh_probe_mode == EEH_PROBE_MODE_DEVTREE);
168}
169
170static inline int eeh_probe_mode_dev(void)
171{
172 return (eeh_probe_mode == EEH_PROBE_MODE_DEV);
173}
646a8499 174
4907581d
GS
175static inline void eeh_serialize_lock(unsigned long *flags)
176{
177 raw_spin_lock_irqsave(&confirm_error_lock, *flags);
178}
179
180static inline void eeh_serialize_unlock(unsigned long flags)
181{
182 raw_spin_unlock_irqrestore(&confirm_error_lock, flags);
183}
184
cb3bc9d0
GS
185/*
186 * Max number of EEH freezes allowed before we consider the device
187 * to be permanently disabled.
188 */
172ca926
LV
189#define EEH_MAX_ALLOWED_FREEZES 5
190
22f4ab12 191typedef void *(*eeh_traverse_func)(void *data, void *flag);
cad5cef6 192int eeh_phb_pe_create(struct pci_controller *phb);
9ff67433 193struct eeh_pe *eeh_phb_pe_get(struct pci_controller *phb);
01566808 194struct eeh_pe *eeh_pe_get(struct eeh_dev *edev);
9b84348c 195int eeh_add_to_parent_pe(struct eeh_dev *edev);
20ee6a97 196int eeh_rmv_from_parent_pe(struct eeh_dev *edev, int purge_pe);
5a71978e 197void eeh_pe_update_time_stamp(struct eeh_pe *pe);
9e6d2cf6
GS
198void *eeh_pe_dev_traverse(struct eeh_pe *root,
199 eeh_traverse_func fn, void *flag);
200void eeh_pe_restore_bars(struct eeh_pe *pe);
9b3c76f0 201struct pci_bus *eeh_pe_bus_get(struct eeh_pe *pe);
55037d17 202
cad5cef6
GKH
203void *eeh_dev_init(struct device_node *dn, void *data);
204void eeh_dev_phb_init_dynamic(struct pci_controller *phb);
eeb6361f 205int eeh_init(void);
aa1e6374
GS
206int __init eeh_ops_register(struct eeh_ops *ops);
207int __exit eeh_ops_unregister(const char *name);
1da177e4
LT
208unsigned long eeh_check_failure(const volatile void __iomem *token,
209 unsigned long val);
f8f7d63f 210int eeh_dev_check_failure(struct eeh_dev *edev);
eeb6361f 211void eeh_addr_cache_build(void);
f2856491 212void eeh_add_device_early(struct device_node *);
e2a296ee 213void eeh_add_device_tree_early(struct device_node *);
f2856491 214void eeh_add_device_late(struct pci_dev *);
827c1a6c 215void eeh_add_device_tree_late(struct pci_bus *);
6a040ce7 216void eeh_add_sysfs_files(struct pci_bus *);
f2856491 217void eeh_remove_device(struct pci_dev *, int);
20ee6a97 218void eeh_remove_bus_device(struct pci_dev *, int);
e2a296ee 219
1da177e4
LT
220/**
221 * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
222 *
223 * If this macro yields TRUE, the caller relays to eeh_check_failure()
224 * which does further tests out of line.
225 */
1e28a7dd 226#define EEH_POSSIBLE_ERROR(val, type) ((val) == (type)~0 && eeh_subsystem_enabled)
1da177e4
LT
227
228/*
229 * Reads from a device which has been isolated by EEH will return
230 * all 1s. This macro gives an all-1s value of the given size (in
231 * bytes: 1, 2, or 4) for comparing with the result of a read.
232 */
233#define EEH_IO_ERROR_VALUE(size) (~0U >> ((4 - (size)) * 8))
234
235#else /* !CONFIG_EEH */
eb740b5f 236
51fb5f56
GS
237static inline int eeh_init(void)
238{
239 return 0;
240}
241
eb740b5f
GS
242static inline void *eeh_dev_init(struct device_node *dn, void *data)
243{
244 return NULL;
245}
246
247static inline void eeh_dev_phb_init_dynamic(struct pci_controller *phb) { }
248
1da177e4
LT
249static inline unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
250{
251 return val;
252}
253
f8f7d63f 254#define eeh_dev_check_failure(x) (0)
1da177e4 255
3ab96a02 256static inline void eeh_addr_cache_build(void) { }
1da177e4 257
f2856491
GS
258static inline void eeh_add_device_early(struct device_node *dn) { }
259
022930eb
HM
260static inline void eeh_add_device_tree_early(struct device_node *dn) { }
261
f2856491
GS
262static inline void eeh_add_device_late(struct pci_dev *dev) { }
263
827c1a6c
JR
264static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
265
6a040ce7
TLSC
266static inline void eeh_add_sysfs_files(struct pci_bus *bus) { }
267
f2856491
GS
268static inline void eeh_remove_device(struct pci_dev *dev, int purge_pe) { }
269
20ee6a97 270static inline void eeh_remove_bus_device(struct pci_dev *dev, int purge_pe) { }
646a8499 271
1da177e4
LT
272#define EEH_POSSIBLE_ERROR(val, type) (0)
273#define EEH_IO_ERROR_VALUE(size) (-1UL)
274#endif /* CONFIG_EEH */
275
8b8da358 276#ifdef CONFIG_PPC64
172ca926 277/*
1da177e4
LT
278 * MMIO read/write operations with EEH support.
279 */
280static inline u8 eeh_readb(const volatile void __iomem *addr)
281{
282 u8 val = in_8(addr);
283 if (EEH_POSSIBLE_ERROR(val, u8))
284 return eeh_check_failure(addr, val);
285 return val;
286}
1da177e4
LT
287
288static inline u16 eeh_readw(const volatile void __iomem *addr)
289{
290 u16 val = in_le16(addr);
291 if (EEH_POSSIBLE_ERROR(val, u16))
292 return eeh_check_failure(addr, val);
293 return val;
294}
1da177e4
LT
295
296static inline u32 eeh_readl(const volatile void __iomem *addr)
297{
298 u32 val = in_le32(addr);
299 if (EEH_POSSIBLE_ERROR(val, u32))
300 return eeh_check_failure(addr, val);
301 return val;
302}
4cb3cee0
BH
303
304static inline u64 eeh_readq(const volatile void __iomem *addr)
1da177e4 305{
4cb3cee0
BH
306 u64 val = in_le64(addr);
307 if (EEH_POSSIBLE_ERROR(val, u64))
1da177e4
LT
308 return eeh_check_failure(addr, val);
309 return val;
310}
1da177e4 311
4cb3cee0 312static inline u16 eeh_readw_be(const volatile void __iomem *addr)
1da177e4 313{
4cb3cee0
BH
314 u16 val = in_be16(addr);
315 if (EEH_POSSIBLE_ERROR(val, u16))
1da177e4
LT
316 return eeh_check_failure(addr, val);
317 return val;
318}
4cb3cee0
BH
319
320static inline u32 eeh_readl_be(const volatile void __iomem *addr)
1da177e4 321{
4cb3cee0
BH
322 u32 val = in_be32(addr);
323 if (EEH_POSSIBLE_ERROR(val, u32))
324 return eeh_check_failure(addr, val);
325 return val;
1da177e4 326}
4cb3cee0
BH
327
328static inline u64 eeh_readq_be(const volatile void __iomem *addr)
1da177e4
LT
329{
330 u64 val = in_be64(addr);
331 if (EEH_POSSIBLE_ERROR(val, u64))
332 return eeh_check_failure(addr, val);
333 return val;
334}
1da177e4 335
68a64357
BH
336static inline void eeh_memcpy_fromio(void *dest, const
337 volatile void __iomem *src,
1da177e4
LT
338 unsigned long n)
339{
68a64357 340 _memcpy_fromio(dest, src, n);
1da177e4
LT
341
342 /* Look for ffff's here at dest[n]. Assume that at least 4 bytes
343 * were copied. Check all four bytes.
344 */
68a64357
BH
345 if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
346 eeh_check_failure(src, *((u32 *)(dest + n - 4)));
1da177e4
LT
347}
348
1da177e4 349/* in-string eeh macros */
4cb3cee0
BH
350static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
351 int ns)
1da177e4 352{
4cb3cee0 353 _insb(addr, buf, ns);
1da177e4 354 if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
4cb3cee0 355 eeh_check_failure(addr, *(u8*)buf);
1da177e4
LT
356}
357
4cb3cee0
BH
358static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
359 int ns)
1da177e4 360{
4cb3cee0 361 _insw(addr, buf, ns);
1da177e4 362 if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
4cb3cee0 363 eeh_check_failure(addr, *(u16*)buf);
1da177e4
LT
364}
365
4cb3cee0
BH
366static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
367 int nl)
1da177e4 368{
4cb3cee0 369 _insl(addr, buf, nl);
1da177e4 370 if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
4cb3cee0 371 eeh_check_failure(addr, *(u32*)buf);
1da177e4
LT
372}
373
8b8da358 374#endif /* CONFIG_PPC64 */
88ced031 375#endif /* __KERNEL__ */
8b8da358 376#endif /* _POWERPC_EEH_H */