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