powerpc/eeh: Device bars restore based on PE
[GitHub/mt8127/android_kernel_alcatel_ttab.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 */
48#define EEH_PE_PHB 1 /* PHB PE */
49#define EEH_PE_DEVICE 2 /* Device PE */
50#define EEH_PE_BUS 3 /* Bus PE */
51
52#define EEH_PE_ISOLATED (1 << 0) /* Isolated PE */
53#define EEH_PE_RECOVERING (1 << 1) /* Recovering PE */
54
55struct eeh_pe {
56 int type; /* PE type: PHB/Bus/Device */
57 int state; /* PE EEH dependent mode */
58 int config_addr; /* Traditional PCI address */
59 int addr; /* PE configuration address */
60 struct pci_controller *phb; /* Associated PHB */
61 int check_count; /* Times of ignored error */
62 int freeze_count; /* Times of froze up */
63 int false_positives; /* Times of reported #ff's */
64 struct eeh_pe *parent; /* Parent PE */
65 struct list_head child_list; /* Link PE to the child list */
66 struct list_head edevs; /* Link list of EEH devices */
67 struct list_head child; /* Child PEs */
68};
69
5b663529
GS
70#define eeh_pe_for_each_dev(pe, edev) \
71 list_for_each_entry(edev, &pe->edevs, list)
72
eb740b5f
GS
73/*
74 * The struct is used to trace EEH state for the associated
75 * PCI device node or PCI device. In future, it might
76 * represent PE as well so that the EEH device to form
77 * another tree except the currently existing tree of PCI
78 * buses and PCI devices
79 */
80#define EEH_MODE_SUPPORTED (1<<0) /* EEH supported on the device */
81#define EEH_MODE_NOCHECK (1<<1) /* EEH check should be skipped */
82#define EEH_MODE_ISOLATED (1<<2) /* The device has been isolated */
83#define EEH_MODE_RECOVERING (1<<3) /* Recovering the device */
84#define EEH_MODE_IRQ_DISABLED (1<<4) /* Interrupt disabled */
85
86struct eeh_dev {
87 int mode; /* EEH mode */
88 int class_code; /* Class code of the device */
89 int config_addr; /* Config address */
90 int pe_config_addr; /* PE config address */
91 int check_count; /* Times of ignored error */
92 int freeze_count; /* Times of froze up */
93 int false_positives; /* Times of reported #ff's */
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{
104 return edev->dn;
105}
106
107static inline struct pci_dev *eeh_dev_to_pci_dev(struct eeh_dev *edev)
108{
109 return edev->pdev;
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);
371a395d
GS
139 int (*set_option)(struct eeh_pe *pe, int option);
140 int (*get_pe_addr)(struct eeh_pe *pe);
141 int (*get_state)(struct eeh_pe *pe, int *state);
142 int (*reset)(struct eeh_pe *pe, int option);
143 int (*wait_state)(struct eeh_pe *pe, int max_wait);
144 int (*get_log)(struct eeh_pe *pe, int severity, char *drv_log, unsigned long len);
145 int (*configure_bridge)(struct eeh_pe *pe);
3780444c
GS
146 int (*read_config)(struct device_node *dn, int where, int size, u32 *val);
147 int (*write_config)(struct device_node *dn, int where, int size, u32 val);
aa1e6374
GS
148};
149
150extern struct eeh_ops *eeh_ops;
1e28a7dd 151extern int eeh_subsystem_enabled;
646a8499
GS
152extern struct mutex eeh_mutex;
153
154static inline void eeh_lock(void)
155{
156 mutex_lock(&eeh_mutex);
157}
158
159static inline void eeh_unlock(void)
160{
161 mutex_unlock(&eeh_mutex);
162}
1e28a7dd 163
cb3bc9d0
GS
164/*
165 * Max number of EEH freezes allowed before we consider the device
166 * to be permanently disabled.
167 */
172ca926
LV
168#define EEH_MAX_ALLOWED_FREEZES 5
169
22f4ab12 170typedef void *(*eeh_traverse_func)(void *data, void *flag);
55037d17 171int __devinit eeh_phb_pe_create(struct pci_controller *phb);
9b84348c 172int eeh_add_to_parent_pe(struct eeh_dev *edev);
82e8882f 173int eeh_rmv_from_parent_pe(struct eeh_dev *edev);
9e6d2cf6
GS
174void *eeh_pe_dev_traverse(struct eeh_pe *root,
175 eeh_traverse_func fn, void *flag);
176void eeh_pe_restore_bars(struct eeh_pe *pe);
55037d17 177
eb740b5f
GS
178void * __devinit eeh_dev_init(struct device_node *dn, void *data);
179void __devinit eeh_dev_phb_init_dynamic(struct pci_controller *phb);
aa1e6374
GS
180int __init eeh_ops_register(struct eeh_ops *ops);
181int __exit eeh_ops_unregister(const char *name);
1da177e4
LT
182unsigned long eeh_check_failure(const volatile void __iomem *token,
183 unsigned long val);
184int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev);
185void __init pci_addr_cache_build(void);
e2a296ee 186void eeh_add_device_tree_early(struct device_node *);
827c1a6c 187void eeh_add_device_tree_late(struct pci_bus *);
e2a296ee
LV
188void eeh_remove_bus_device(struct pci_dev *);
189
1da177e4
LT
190/**
191 * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
192 *
193 * If this macro yields TRUE, the caller relays to eeh_check_failure()
194 * which does further tests out of line.
195 */
1e28a7dd 196#define EEH_POSSIBLE_ERROR(val, type) ((val) == (type)~0 && eeh_subsystem_enabled)
1da177e4
LT
197
198/*
199 * Reads from a device which has been isolated by EEH will return
200 * all 1s. This macro gives an all-1s value of the given size (in
201 * bytes: 1, 2, or 4) for comparing with the result of a read.
202 */
203#define EEH_IO_ERROR_VALUE(size) (~0U >> ((4 - (size)) * 8))
204
205#else /* !CONFIG_EEH */
eb740b5f
GS
206
207static inline void *eeh_dev_init(struct device_node *dn, void *data)
208{
209 return NULL;
210}
211
212static inline void eeh_dev_phb_init_dynamic(struct pci_controller *phb) { }
213
1da177e4
LT
214static inline unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
215{
216 return val;
217}
218
219static inline int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev)
220{
221 return 0;
222}
223
224static inline void pci_addr_cache_build(void) { }
225
022930eb
HM
226static inline void eeh_add_device_tree_early(struct device_node *dn) { }
227
827c1a6c
JR
228static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
229
022930eb 230static inline void eeh_remove_bus_device(struct pci_dev *dev) { }
646a8499
GS
231
232static inline void eeh_lock(void) { }
233static inline void eeh_unlock(void) { }
234
1da177e4
LT
235#define EEH_POSSIBLE_ERROR(val, type) (0)
236#define EEH_IO_ERROR_VALUE(size) (-1UL)
237#endif /* CONFIG_EEH */
238
8b8da358 239#ifdef CONFIG_PPC64
172ca926 240/*
1da177e4
LT
241 * MMIO read/write operations with EEH support.
242 */
243static inline u8 eeh_readb(const volatile void __iomem *addr)
244{
245 u8 val = in_8(addr);
246 if (EEH_POSSIBLE_ERROR(val, u8))
247 return eeh_check_failure(addr, val);
248 return val;
249}
1da177e4
LT
250
251static inline u16 eeh_readw(const volatile void __iomem *addr)
252{
253 u16 val = in_le16(addr);
254 if (EEH_POSSIBLE_ERROR(val, u16))
255 return eeh_check_failure(addr, val);
256 return val;
257}
1da177e4
LT
258
259static inline u32 eeh_readl(const volatile void __iomem *addr)
260{
261 u32 val = in_le32(addr);
262 if (EEH_POSSIBLE_ERROR(val, u32))
263 return eeh_check_failure(addr, val);
264 return val;
265}
4cb3cee0
BH
266
267static inline u64 eeh_readq(const volatile void __iomem *addr)
1da177e4 268{
4cb3cee0
BH
269 u64 val = in_le64(addr);
270 if (EEH_POSSIBLE_ERROR(val, u64))
1da177e4
LT
271 return eeh_check_failure(addr, val);
272 return val;
273}
1da177e4 274
4cb3cee0 275static inline u16 eeh_readw_be(const volatile void __iomem *addr)
1da177e4 276{
4cb3cee0
BH
277 u16 val = in_be16(addr);
278 if (EEH_POSSIBLE_ERROR(val, u16))
1da177e4
LT
279 return eeh_check_failure(addr, val);
280 return val;
281}
4cb3cee0
BH
282
283static inline u32 eeh_readl_be(const volatile void __iomem *addr)
1da177e4 284{
4cb3cee0
BH
285 u32 val = in_be32(addr);
286 if (EEH_POSSIBLE_ERROR(val, u32))
287 return eeh_check_failure(addr, val);
288 return val;
1da177e4 289}
4cb3cee0
BH
290
291static inline u64 eeh_readq_be(const volatile void __iomem *addr)
1da177e4
LT
292{
293 u64 val = in_be64(addr);
294 if (EEH_POSSIBLE_ERROR(val, u64))
295 return eeh_check_failure(addr, val);
296 return val;
297}
1da177e4 298
68a64357
BH
299static inline void eeh_memcpy_fromio(void *dest, const
300 volatile void __iomem *src,
1da177e4
LT
301 unsigned long n)
302{
68a64357 303 _memcpy_fromio(dest, src, n);
1da177e4
LT
304
305 /* Look for ffff's here at dest[n]. Assume that at least 4 bytes
306 * were copied. Check all four bytes.
307 */
68a64357
BH
308 if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
309 eeh_check_failure(src, *((u32 *)(dest + n - 4)));
1da177e4
LT
310}
311
1da177e4 312/* in-string eeh macros */
4cb3cee0
BH
313static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
314 int ns)
1da177e4 315{
4cb3cee0 316 _insb(addr, buf, ns);
1da177e4 317 if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
4cb3cee0 318 eeh_check_failure(addr, *(u8*)buf);
1da177e4
LT
319}
320
4cb3cee0
BH
321static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
322 int ns)
1da177e4 323{
4cb3cee0 324 _insw(addr, buf, ns);
1da177e4 325 if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
4cb3cee0 326 eeh_check_failure(addr, *(u16*)buf);
1da177e4
LT
327}
328
4cb3cee0
BH
329static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
330 int nl)
1da177e4 331{
4cb3cee0 332 _insl(addr, buf, nl);
1da177e4 333 if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
4cb3cee0 334 eeh_check_failure(addr, *(u32*)buf);
1da177e4
LT
335}
336
8b8da358 337#endif /* CONFIG_PPC64 */
88ced031 338#endif /* __KERNEL__ */
8b8da358 339#endif /* _POWERPC_EEH_H */