1/*
2 * 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.
9 *
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.
14 *
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
20#ifndef _PPC64_EEH_H
21#define _PPC64_EEH_H
22#ifdef __KERNEL__
23
24#include <linux/init.h>
25#include <linux/list.h>
26#include <linux/string.h>
27
28struct pci_dev;
29struct pci_bus;
30struct device_node;
31
32#ifdef CONFIG_EEH
33
34extern int eeh_subsystem_enabled;
35
36/* Values for eeh_mode bits in device_node */
37#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)
42
43/* Max number of EEH freezes allowed before we consider the device
44 * to be permanently disabled. */
45#define EEH_MAX_ALLOWED_FREEZES 5
46
47void __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 */
62void eeh_add_device_tree_early(struct device_node *);
63void eeh_add_device_tree_late(struct pci_bus *);
64
65/**
66 * 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/**
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 */
80#define EEH_POSSIBLE_ERROR(val, type)	((val) == (type)~0 && eeh_subsystem_enabled)
81
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_tree_early(struct device_node *dn) { }
105
106static inline void eeh_add_device_tree_late(struct pci_bus *bus) { }
107
108static inline void eeh_remove_bus_device(struct pci_dev *dev) { }
109#define EEH_POSSIBLE_ERROR(val, type) (0)
110#define EEH_IO_ERROR_VALUE(size) (-1UL)
111#endif /* CONFIG_EEH */
112
113/*
114 * 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}
123
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}
131
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}
139
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}
147
148static inline u16 eeh_readw_be(const volatile void __iomem *addr)
149{
150	u16 val = in_be16(addr);
151	if (EEH_POSSIBLE_ERROR(val, u16))
152		return eeh_check_failure(addr, val);
153	return val;
154}
155
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)
165{
166	u64 val = in_be64(addr);
167	if (EEH_POSSIBLE_ERROR(val, u64))
168		return eeh_check_failure(addr, val);
169	return val;
170}
171
172static inline void eeh_memcpy_fromio(void *dest, const
173				     volatile void __iomem *src,
174				     unsigned long n)
175{
176	_memcpy_fromio(dest, src, n);
177
178	/* Look for ffff's here at dest[n].  Assume that at least 4 bytes
179	 * were copied. Check all four bytes.
180	 */
181	if (n >= 4 && EEH_POSSIBLE_ERROR(*((u32 *)(dest + n - 4)), u32))
182		eeh_check_failure(src, *((u32 *)(dest + n - 4)));
183}
184
185/* in-string eeh macros */
186static inline void eeh_readsb(const volatile void __iomem *addr, void * buf,
187			      int ns)
188{
189	_insb(addr, buf, ns);
190	if (EEH_POSSIBLE_ERROR((*(((u8*)buf)+ns-1)), u8))
191		eeh_check_failure(addr, *(u8*)buf);
192}
193
194static inline void eeh_readsw(const volatile void __iomem *addr, void * buf,
195			      int ns)
196{
197	_insw(addr, buf, ns);
198	if (EEH_POSSIBLE_ERROR((*(((u16*)buf)+ns-1)), u16))
199		eeh_check_failure(addr, *(u16*)buf);
200}
201
202static inline void eeh_readsl(const volatile void __iomem *addr, void * buf,
203			      int nl)
204{
205	_insl(addr, buf, nl);
206	if (EEH_POSSIBLE_ERROR((*(((u32*)buf)+nl-1)), u32))
207		eeh_check_failure(addr, *(u32*)buf);
208}
209
210#endif /* __KERNEL__ */
211#endif /* _PPC64_EEH_H */
212