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