blob: b886bec67016795582d1922b3ccc2c0913c8f878 [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
Arnd Bergmann88ced032005-12-16 22:43:46 +010022#ifdef __KERNEL__
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/init.h>
25#include <linux/list.h>
26#include <linux/string.h>
27
28struct pci_dev;
John Rose827c1a62006-02-24 11:34:23 -060029struct pci_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030struct device_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
32#ifdef CONFIG_EEH
33
David Woodhouse1e28a7d2005-11-17 00:44:03 +000034extern int eeh_subsystem_enabled;
35
Linus Torvalds1da177e2005-04-16 15:20:36 -070036/* Values for eeh_mode bits in device_node */
Linas Vepstas77bd7412005-11-03 18:52:49 -060037#define EEH_MODE_SUPPORTED (1<<0)
38#define EEH_MODE_NOCHECK (1<<1)
39#define EEH_MODE_ISOLATED (1<<2)
40#define EEH_MODE_RECOVERING (1<<3)
41#define EEH_MODE_IRQ_DISABLED (1<<4)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042
Linas Vepstas172ca922005-11-03 18:50:04 -060043/* Max number of EEH freezes allowed before we consider the device
44 * to be permanently disabled. */
45#define EEH_MAX_ALLOWED_FREEZES 5
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047void __init eeh_init(void);
48unsigned long eeh_check_failure(const volatile void __iomem *token,
49 unsigned long val);
50int eeh_dn_check_failure(struct device_node *dn, struct pci_dev *dev);
51void __init pci_addr_cache_build(void);
52
53/**
54 * eeh_add_device_early
55 * eeh_add_device_late
56 *
57 * Perform eeh initialization for devices added after boot.
58 * Call eeh_add_device_early before doing any i/o to the
59 * device (including config space i/o). Call eeh_add_device_late
60 * to finish the eeh setup for this device.
61 */
Linas Vepstase2a296e2005-11-03 18:51:31 -060062void eeh_add_device_tree_early(struct device_node *);
John Rose827c1a62006-02-24 11:34:23 -060063void eeh_add_device_tree_late(struct pci_bus *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
65/**
Linas Vepstase2a296e2005-11-03 18:51:31 -060066 * eeh_remove_device_recursive - undo EEH for device & children.
67 * @dev: pci device to be removed
68 *
69 * As above, this removes the device; it also removes child
70 * pci devices as well.
71 */
72void eeh_remove_bus_device(struct pci_dev *);
73
74/**
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * 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
Haren Myneni022930e2005-12-27 18:58:29 -0800104static inline void eeh_add_device_tree_early(struct device_node *dn) { }
105
John Rose827c1a62006-02-24 11:34:23 -0600106static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
107
Haren Myneni022930e2005-12-27 18:58:29 -0800108static inline void eeh_remove_bus_device(struct pci_dev *dev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#define EEH_POSSIBLE_ERROR(val, type) (0)
110#define EEH_IO_ERROR_VALUE(size) (-1UL)
111#endif /* CONFIG_EEH */
112
Linas Vepstas172ca922005-11-03 18:50:04 -0600113/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * MMIO read/write operations with EEH support.
115 */
116static inline u8 eeh_readb(const volatile void __iomem *addr)
117{
118 u8 val = in_8(addr);
119 if (EEH_POSSIBLE_ERROR(val, u8))
120 return eeh_check_failure(addr, val);
121 return val;
122}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124static inline u16 eeh_readw(const volatile void __iomem *addr)
125{
126 u16 val = in_le16(addr);
127 if (EEH_POSSIBLE_ERROR(val, u16))
128 return eeh_check_failure(addr, val);
129 return val;
130}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
132static inline u32 eeh_readl(const volatile void __iomem *addr)
133{
134 u32 val = in_le32(addr);
135 if (EEH_POSSIBLE_ERROR(val, u32))
136 return eeh_check_failure(addr, val);
137 return val;
138}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
140static inline u64 eeh_readq(const volatile void __iomem *addr)
141{
142 u64 val = in_le64(addr);
143 if (EEH_POSSIBLE_ERROR(val, u64))
144 return eeh_check_failure(addr, val);
145 return val;
146}
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100147
148static inline u16 eeh_readw_be(const volatile void __iomem *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149{
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100150 u16 val = in_be16(addr);
151 if (EEH_POSSIBLE_ERROR(val, u16))
152 return eeh_check_failure(addr, val);
153 return val;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154}
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100155
156static inline u32 eeh_readl_be(const volatile void __iomem *addr)
157{
158 u32 val = in_be32(addr);
159 if (EEH_POSSIBLE_ERROR(val, u32))
160 return eeh_check_failure(addr, val);
161 return val;
162}
163
164static inline u64 eeh_readq_be(const volatile void __iomem *addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165{
166 u64 val = in_be64(addr);
167 if (EEH_POSSIBLE_ERROR(val, u64))
168 return eeh_check_failure(addr, val);
169 return val;
170}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Benjamin Herrenschmidt68a64352006-11-13 09:27:39 +1100172static inline void eeh_memcpy_fromio(void *dest, const
173 volatile void __iomem *src,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 unsigned long n)
175{
Benjamin Herrenschmidt68a64352006-11-13 09:27:39 +1100176 _memcpy_fromio(dest, src, n);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178 /* Look for ffff's here at dest[n]. Assume that at least 4 bytes
179 * were copied. Check all four bytes.
180 */
Benjamin Herrenschmidt68a64352006-11-13 09:27:39 +1100181 if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
182 eeh_check_failure(src, *((u32 *)(dest + n - 4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183}
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185/* in-string eeh macros */
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100186static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
187 int ns)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100189 _insb(addr, buf, ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100191 eeh_check_failure(addr, *(u8*)buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192}
193
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100194static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
195 int ns)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100197 _insw(addr, buf, ns);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100199 eeh_check_failure(addr, *(u16*)buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200}
201
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100202static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
203 int nl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100205 _insl(addr, buf, nl);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
Benjamin Herrenschmidt4cb3cee2006-11-11 17:25:10 +1100207 eeh_check_failure(addr, *(u32*)buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208}
209
Arnd Bergmann88ced032005-12-16 22:43:46 +0100210#endif /* __KERNEL__ */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211#endif /* _PPC64_EEH_H */