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