blob: f8633aafe4baa5d000e608b35b92e5f13be45311 [file] [log] [blame]
Linas Vepstas172ca922005-11-03 18:50:04 -06001/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002 * eeh.h
3 * Copyright (C) 2001 Dave Engebretsen & Todd Inglett IBM Corporation.
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.
Linas Vepstas172ca922005-11-03 18:50:04 -06009 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * 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.
Linas Vepstas172ca922005-11-03 18:50:04 -060014 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 * 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
20#ifndef _PPC64_EEH_H
21#define _PPC64_EEH_H
22
23#include <linux/config.h>
24#include <linux/init.h>
25#include <linux/list.h>
26#include <linux/string.h>
27
28struct pci_dev;
29struct device_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
31#ifdef CONFIG_EEH
32
David Woodhouse1e28a7d2005-11-17 00:44:03 +000033extern int eeh_subsystem_enabled;
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035/* Values for eeh_mode bits in device_node */
36#define EEH_MODE_SUPPORTED (1<<0)
37#define EEH_MODE_NOCHECK (1<<1)
38#define EEH_MODE_ISOLATED (1<<2)
39
Linas Vepstas172ca922005-11-03 18:50:04 -060040/* Max number of EEH freezes allowed before we consider the device
41 * to be permanently disabled. */
42#define EEH_MAX_ALLOWED_FREEZES 5
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044void __init eeh_init(void);
45unsigned long eeh_check_failure(const volatile void __iomem *token,
46 unsigned long val);
47int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev);
48void __init pci_addr_cache_build(void);
49
50/**
51 * eeh_add_device_early
52 * eeh_add_device_late
53 *
54 * Perform eeh initialization for devices added after boot.
55 * Call eeh_add_device_early before doing any i/o to the
56 * device (including config space i/o). Call eeh_add_device_late
57 * to finish the eeh setup for this device.
58 */
59void eeh_add_device_early(struct device_node *);
60void eeh_add_device_late(struct pci_dev *);
61
62/**
63 * eeh_remove_device - undo EEH setup for the indicated pci device
64 * @dev: pci device to be removed
65 *
Linas Vepstas172ca922005-11-03 18:50:04 -060066 * This routine should be called when a device is removed from
67 * a running system (e.g. by hotplug or dlpar). It unregisters
68 * the PCI device from the EEH subsystem. I/O errors affecting
69 * this device will no longer be detected after this call; thus,
70 * i/o errors affecting this slot may leave this device unusable.
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 */
72void eeh_remove_device(struct pci_dev *);
73
Linus Torvalds1da177e2005-04-16 15:20:36 -070074/**
75 * EEH_POSSIBLE_ERROR() -- test for possible MMIO failure.
76 *
77 * If this macro yields TRUE, the caller relays to eeh_check_failure()
78 * which does further tests out of line.
79 */
David Woodhouse1e28a7d2005-11-17 00:44:03 +000080#define EEH_POSSIBLE_ERROR(val, type) ((val) == (type)~0 && eeh_subsystem_enabled)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
82/*
83 * Reads from a device which has been isolated by EEH will return
84 * all 1s. This macro gives an all-1s value of the given size (in
85 * bytes: 1, 2, or 4) for comparing with the result of a read.
86 */
87#define EEH_IO_ERROR_VALUE(size) (~0U >> ((4 - (size)) * 8))
88
89#else /* !CONFIG_EEH */
90static inline void eeh_init(void) { }
91
92static inline unsigned long eeh_check_failure(const volatile void __iomem *token, unsigned long val)
93{
94 return val;
95}
96
97static inline int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev)
98{
99 return 0;
100}
101
102static inline void pci_addr_cache_build(void) { }
103
104static inline void eeh_add_device_early(struct device_node *dn) { }
105
106static inline void eeh_add_device_late(struct pci_dev *dev) { }
107
108static inline void eeh_remove_device(struct pci_dev *dev) { }
109
110#define EEH_POSSIBLE_ERROR(val, type) (0)
111#define EEH_IO_ERROR_VALUE(size) (-1UL)
112#endif /* CONFIG_EEH */
113
Linas Vepstas172ca922005-11-03 18:50:04 -0600114/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * MMIO read/write operations with EEH support.
116 */
117static inline u8 eeh_readb(const volatile void __iomem *addr)
118{
119 u8 val = in_8(addr);
120 if (EEH_POSSIBLE_ERROR(val, u8))
121 return eeh_check_failure(addr, val);
122 return val;
123}
124static inline void eeh_writeb(u8 val, volatile void __iomem *addr)
125{
126 out_8(addr, val);
127}
128
129static inline u16 eeh_readw(const volatile void __iomem *addr)
130{
131 u16 val = in_le16(addr);
132 if (EEH_POSSIBLE_ERROR(val, u16))
133 return eeh_check_failure(addr, val);
134 return val;
135}
136static inline void eeh_writew(u16 val, volatile void __iomem *addr)
137{
138 out_le16(addr, val);
139}
140static inline u16 eeh_raw_readw(const volatile void __iomem *addr)
141{
142 u16 val = in_be16(addr);
143 if (EEH_POSSIBLE_ERROR(val, u16))
144 return eeh_check_failure(addr, val);
145 return val;
146}
147static inline void eeh_raw_writew(u16 val, volatile void __iomem *addr) {
148 volatile u16 __iomem *vaddr = (volatile u16 __iomem *) addr;
149 out_be16(vaddr, val);
150}
151
152static inline u32 eeh_readl(const volatile void __iomem *addr)
153{
154 u32 val = in_le32(addr);
155 if (EEH_POSSIBLE_ERROR(val, u32))
156 return eeh_check_failure(addr, val);
157 return val;
158}
159static inline void eeh_writel(u32 val, volatile void __iomem *addr)
160{
161 out_le32(addr, val);
162}
163static inline u32 eeh_raw_readl(const volatile void __iomem *addr)
164{
165 u32 val = in_be32(addr);
166 if (EEH_POSSIBLE_ERROR(val, u32))
167 return eeh_check_failure(addr, val);
168 return val;
169}
170static inline void eeh_raw_writel(u32 val, volatile void __iomem *addr)
171{
172 out_be32(addr, val);
173}
174
175static inline u64 eeh_readq(const volatile void __iomem *addr)
176{
177 u64 val = in_le64(addr);
178 if (EEH_POSSIBLE_ERROR(val, u64))
179 return eeh_check_failure(addr, val);
180 return val;
181}
182static inline void eeh_writeq(u64 val, volatile void __iomem *addr)
183{
184 out_le64(addr, val);
185}
186static inline u64 eeh_raw_readq(const volatile void __iomem *addr)
187{
188 u64 val = in_be64(addr);
189 if (EEH_POSSIBLE_ERROR(val, u64))
190 return eeh_check_failure(addr, val);
191 return val;
192}
193static inline void eeh_raw_writeq(u64 val, volatile void __iomem *addr)
194{
195 out_be64(addr, val);
196}
197
198#define EEH_CHECK_ALIGN(v,a) \
199 ((((unsigned long)(v)) & ((a) - 1)) == 0)
200
201static inline void eeh_memset_io(volatile void __iomem *addr, int c,
202 unsigned long n)
203{
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100204 void *p = (void __force *)addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205 u32 lc = c;
206 lc |= lc << 8;
207 lc |= lc << 16;
208
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100209 while(n && !EEH_CHECK_ALIGN(p, 4)) {
210 *((volatile u8 *)p) = c;
211 p++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 n--;
213 }
214 while(n >= 4) {
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100215 *((volatile u32 *)p) = lc;
216 p += 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 n -= 4;
218 }
219 while(n) {
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100220 *((volatile u8 *)p) = c;
221 p++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 n--;
223 }
224 __asm__ __volatile__ ("sync" : : : "memory");
225}
226static inline void eeh_memcpy_fromio(void *dest, const volatile void __iomem *src,
227 unsigned long n)
228{
229 void *vsrc = (void __force *) src;
230 void *destsave = dest;
231 unsigned long nsave = n;
232
233 while(n && (!EEH_CHECK_ALIGN(vsrc, 4) || !EEH_CHECK_ALIGN(dest, 4))) {
234 *((u8 *)dest) = *((volatile u8 *)vsrc);
235 __asm__ __volatile__ ("eieio" : : : "memory");
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100236 vsrc++;
237 dest++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 n--;
239 }
240 while(n > 4) {
241 *((u32 *)dest) = *((volatile u32 *)vsrc);
242 __asm__ __volatile__ ("eieio" : : : "memory");
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100243 vsrc += 4;
244 dest += 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 n -= 4;
246 }
247 while(n) {
248 *((u8 *)dest) = *((volatile u8 *)vsrc);
249 __asm__ __volatile__ ("eieio" : : : "memory");
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100250 vsrc++;
251 dest++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 n--;
253 }
254 __asm__ __volatile__ ("sync" : : : "memory");
255
256 /* Look for ffff's here at dest[n]. Assume that at least 4 bytes
257 * were copied. Check all four bytes.
258 */
259 if ((nsave >= 4) &&
260 (EEH_POSSIBLE_ERROR((*((u32 *) destsave+nsave-4)), u32))) {
261 eeh_check_failure(src, (*((u32 *) destsave+nsave-4)));
262 }
263}
264
265static inline void eeh_memcpy_toio(volatile void __iomem *dest, const void *src,
266 unsigned long n)
267{
268 void *vdest = (void __force *) dest;
269
270 while(n && (!EEH_CHECK_ALIGN(vdest, 4) || !EEH_CHECK_ALIGN(src, 4))) {
271 *((volatile u8 *)vdest) = *((u8 *)src);
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100272 src++;
273 vdest++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 n--;
275 }
276 while(n > 4) {
277 *((volatile u32 *)vdest) = *((volatile u32 *)src);
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100278 src += 4;
279 vdest += 4;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 n-=4;
281 }
282 while(n) {
283 *((volatile u8 *)vdest) = *((u8 *)src);
viro@ZenIV.linux.org.uk6c9afc62005-09-09 16:50:43 +0100284 src++;
285 vdest++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 n--;
287 }
288 __asm__ __volatile__ ("sync" : : : "memory");
289}
290
291#undef EEH_CHECK_ALIGN
292
293static inline u8 eeh_inb(unsigned long port)
294{
295 u8 val;
296 if (!_IO_IS_VALID(port))
297 return ~0;
298 val = in_8((u8 __iomem *)(port+pci_io_base));
299 if (EEH_POSSIBLE_ERROR(val, u8))
300 return eeh_check_failure((void __iomem *)(port), val);
301 return val;
302}
303
304static inline void eeh_outb(u8 val, unsigned long port)
305{
306 if (_IO_IS_VALID(port))
307 out_8((u8 __iomem *)(port+pci_io_base), val);
308}
309
310static inline u16 eeh_inw(unsigned long port)
311{
312 u16 val;
313 if (!_IO_IS_VALID(port))
314 return ~0;
315 val = in_le16((u16 __iomem *)(port+pci_io_base));
316 if (EEH_POSSIBLE_ERROR(val, u16))
317 return eeh_check_failure((void __iomem *)(port), val);
318 return val;
319}
320
321static inline void eeh_outw(u16 val, unsigned long port)
322{
323 if (_IO_IS_VALID(port))
324 out_le16((u16 __iomem *)(port+pci_io_base), val);
325}
326
327static inline u32 eeh_inl(unsigned long port)
328{
329 u32 val;
330 if (!_IO_IS_VALID(port))
331 return ~0;
332 val = in_le32((u32 __iomem *)(port+pci_io_base));
333 if (EEH_POSSIBLE_ERROR(val, u32))
334 return eeh_check_failure((void __iomem *)(port), val);
335 return val;
336}
337
338static inline void eeh_outl(u32 val, unsigned long port)
339{
340 if (_IO_IS_VALID(port))
341 out_le32((u32 __iomem *)(port+pci_io_base), val);
342}
343
344/* in-string eeh macros */
345static inline void eeh_insb(unsigned long port, void * buf, int ns)
346{
347 _insb((u8 __iomem *)(port+pci_io_base), buf, ns);
348 if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
349 eeh_check_failure((void __iomem *)(port), *(u8*)buf);
350}
351
352static inline void eeh_insw_ns(unsigned long port, void * buf, int ns)
353{
354 _insw_ns((u16 __iomem *)(port+pci_io_base), buf, ns);
355 if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
356 eeh_check_failure((void __iomem *)(port), *(u16*)buf);
357}
358
359static inline void eeh_insl_ns(unsigned long port, void * buf, int nl)
360{
361 _insl_ns((u32 __iomem *)(port+pci_io_base), buf, nl);
362 if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
363 eeh_check_failure((void __iomem *)(port), *(u32*)buf);
364}
365
366#endif /* _PPC64_EEH_H */