ichwd.c revision 330897
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2004 Texas A&M University
5 * All rights reserved.
6 *
7 * Developer: Wm. Daryl Hawkins
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31/*
32 * Intel ICH Watchdog Timer (WDT) driver
33 *
34 * Originally developed by Wm. Daryl Hawkins of Texas A&M
35 * Heavily modified by <des@FreeBSD.org>
36 *
37 * This is a tricky one.  The ICH WDT can't be treated as a regular PCI
38 * device as it's actually an integrated function of the ICH LPC interface
39 * bridge.  Detection is also awkward, because we can only infer the
40 * presence of the watchdog timer from the fact that the machine has an
41 * ICH chipset, or, on ACPI 2.x systems, by the presence of the 'WDDT'
42 * ACPI table (although this driver does not support the ACPI detection
43 * method).
44 *
45 * There is one slight problem on non-ACPI or ACPI 1.x systems: we have no
46 * way of knowing if the WDT is permanently disabled (either by the BIOS
47 * or in hardware).
48 *
49 * The WDT is programmed through I/O registers in the ACPI I/O space.
50 * Intel swears it's always at offset 0x60, so we use that.
51 *
52 * For details about the ICH WDT, see Intel Application Note AP-725
53 * (document no. 292273-001).  The WDT is also described in the individual
54 * chipset datasheets, e.g. Intel82801EB ICH5 / 82801ER ICH5R Datasheet
55 * (document no. 252516-001) sections 9.10 and 9.11.
56 *
57 * ICH6/7/8 support by Takeharu KATO <takeharu1219@ybb.ne.jp>
58 * SoC PMC support by Denir Li <denir.li@cas-well.com>
59 */
60
61#include <sys/cdefs.h>
62__FBSDID("$FreeBSD: stable/11/sys/dev/ichwd/ichwd.c 330897 2018-03-14 03:19:51Z eadler $");
63
64#include <sys/param.h>
65#include <sys/kernel.h>
66#include <sys/module.h>
67#include <sys/systm.h>
68#include <sys/bus.h>
69#include <machine/bus.h>
70#include <sys/rman.h>
71#include <machine/resource.h>
72#include <sys/watchdog.h>
73
74#include <isa/isavar.h>
75#include <dev/pci/pcivar.h>
76
77#include <dev/ichwd/ichwd.h>
78
79static struct ichwd_device ichwd_devices[] = {
80	{ DEVICEID_82801AA,  "Intel 82801AA watchdog timer",	1, 1 },
81	{ DEVICEID_82801AB,  "Intel 82801AB watchdog timer",	1, 1 },
82	{ DEVICEID_82801BA,  "Intel 82801BA watchdog timer",	2, 1 },
83	{ DEVICEID_82801BAM, "Intel 82801BAM watchdog timer",	2, 1 },
84	{ DEVICEID_82801CA,  "Intel 82801CA watchdog timer",	3, 1 },
85	{ DEVICEID_82801CAM, "Intel 82801CAM watchdog timer",	3, 1 },
86	{ DEVICEID_82801DB,  "Intel 82801DB watchdog timer",	4, 1 },
87	{ DEVICEID_82801DBM, "Intel 82801DBM watchdog timer",	4, 1 },
88	{ DEVICEID_82801E,   "Intel 82801E watchdog timer",	5, 1 },
89	{ DEVICEID_82801EB,  "Intel 82801EB watchdog timer",	5, 1 },
90	{ DEVICEID_82801EBR, "Intel 82801EB/ER watchdog timer",	5, 1 },
91	{ DEVICEID_6300ESB,  "Intel 6300ESB watchdog timer",	5, 1 },
92	{ DEVICEID_82801FBR, "Intel 82801FB/FR watchdog timer",	6, 2 },
93	{ DEVICEID_ICH6M,    "Intel ICH6M watchdog timer",	6, 2 },
94	{ DEVICEID_ICH6W,    "Intel ICH6W watchdog timer",	6, 2 },
95	{ DEVICEID_ICH7,     "Intel ICH7 watchdog timer",	7, 2 },
96	{ DEVICEID_ICH7DH,   "Intel ICH7DH watchdog timer",	7, 2 },
97	{ DEVICEID_ICH7M,    "Intel ICH7M watchdog timer",	7, 2 },
98	{ DEVICEID_ICH7MDH,  "Intel ICH7MDH watchdog timer",	7, 2 },
99	{ DEVICEID_NM10,     "Intel NM10 watchdog timer",	7, 2 },
100	{ DEVICEID_ICH8,     "Intel ICH8 watchdog timer",	8, 2 },
101	{ DEVICEID_ICH8DH,   "Intel ICH8DH watchdog timer",	8, 2 },
102	{ DEVICEID_ICH8DO,   "Intel ICH8DO watchdog timer",	8, 2 },
103	{ DEVICEID_ICH8M,    "Intel ICH8M watchdog timer",	8, 2 },
104	{ DEVICEID_ICH8ME,   "Intel ICH8M-E watchdog timer",	8, 2 },
105	{ DEVICEID_63XXESB,  "Intel 63XXESB watchdog timer",	8, 2 },
106	{ DEVICEID_ICH9,     "Intel ICH9 watchdog timer",	9, 2 },
107	{ DEVICEID_ICH9DH,   "Intel ICH9DH watchdog timer",	9, 2 },
108	{ DEVICEID_ICH9DO,   "Intel ICH9DO watchdog timer",	9, 2 },
109	{ DEVICEID_ICH9M,    "Intel ICH9M watchdog timer",	9, 2 },
110	{ DEVICEID_ICH9ME,   "Intel ICH9M-E watchdog timer",	9, 2 },
111	{ DEVICEID_ICH9R,    "Intel ICH9R watchdog timer",	9, 2 },
112	{ DEVICEID_ICH10,    "Intel ICH10 watchdog timer",	10, 2 },
113	{ DEVICEID_ICH10D,   "Intel ICH10D watchdog timer",	10, 2 },
114	{ DEVICEID_ICH10DO,  "Intel ICH10DO watchdog timer",	10, 2 },
115	{ DEVICEID_ICH10R,   "Intel ICH10R watchdog timer",	10, 2 },
116	{ DEVICEID_PCH,      "Intel PCH watchdog timer",	10, 2 },
117	{ DEVICEID_PCHM,     "Intel PCH watchdog timer",	10, 2 },
118	{ DEVICEID_P55,      "Intel P55 watchdog timer",	10, 2 },
119	{ DEVICEID_PM55,     "Intel PM55 watchdog timer",	10, 2 },
120	{ DEVICEID_H55,      "Intel H55 watchdog timer",	10, 2 },
121	{ DEVICEID_QM57,     "Intel QM57 watchdog timer",       10, 2 },
122	{ DEVICEID_H57,      "Intel H57 watchdog timer",        10, 2 },
123	{ DEVICEID_HM55,     "Intel HM55 watchdog timer",       10, 2 },
124	{ DEVICEID_Q57,      "Intel Q57 watchdog timer",        10, 2 },
125	{ DEVICEID_HM57,     "Intel HM57 watchdog timer",       10, 2 },
126	{ DEVICEID_PCHMSFF,  "Intel PCHMSFF watchdog timer",    10, 2 },
127	{ DEVICEID_QS57,     "Intel QS57 watchdog timer",       10, 2 },
128	{ DEVICEID_3400,     "Intel 3400 watchdog timer",       10, 2 },
129	{ DEVICEID_3420,     "Intel 3420 watchdog timer",       10, 2 },
130	{ DEVICEID_3450,     "Intel 3450 watchdog timer",       10, 2 },
131	{ DEVICEID_CPT0,     "Intel Cougar Point watchdog timer",	10, 2 },
132	{ DEVICEID_CPT1,     "Intel Cougar Point watchdog timer",	10, 2 },
133	{ DEVICEID_CPT2,     "Intel Cougar Point watchdog timer",	10, 2 },
134	{ DEVICEID_CPT3,     "Intel Cougar Point watchdog timer",	10, 2 },
135	{ DEVICEID_CPT4,     "Intel Cougar Point watchdog timer",	10, 2 },
136	{ DEVICEID_CPT5,     "Intel Cougar Point watchdog timer",	10, 2 },
137	{ DEVICEID_CPT6,     "Intel Cougar Point watchdog timer",	10, 2 },
138	{ DEVICEID_CPT7,     "Intel Cougar Point watchdog timer",	10, 2 },
139	{ DEVICEID_CPT8,     "Intel Cougar Point watchdog timer",	10, 2 },
140	{ DEVICEID_CPT9,     "Intel Cougar Point watchdog timer",	10, 2 },
141	{ DEVICEID_CPT10,    "Intel Cougar Point watchdog timer",	10, 2 },
142	{ DEVICEID_CPT11,    "Intel Cougar Point watchdog timer",	10, 2 },
143	{ DEVICEID_CPT12,    "Intel Cougar Point watchdog timer",	10, 2 },
144	{ DEVICEID_CPT13,    "Intel Cougar Point watchdog timer",	10, 2 },
145	{ DEVICEID_CPT14,    "Intel Cougar Point watchdog timer",	10, 2 },
146	{ DEVICEID_CPT15,    "Intel Cougar Point watchdog timer",	10, 2 },
147	{ DEVICEID_CPT16,    "Intel Cougar Point watchdog timer",	10, 2 },
148	{ DEVICEID_CPT17,    "Intel Cougar Point watchdog timer",	10, 2 },
149	{ DEVICEID_CPT18,    "Intel Cougar Point watchdog timer",	10, 2 },
150	{ DEVICEID_CPT19,    "Intel Cougar Point watchdog timer",	10, 2 },
151	{ DEVICEID_CPT20,    "Intel Cougar Point watchdog timer",	10, 2 },
152	{ DEVICEID_CPT21,    "Intel Cougar Point watchdog timer",	10, 2 },
153	{ DEVICEID_CPT22,    "Intel Cougar Point watchdog timer",	10, 2 },
154	{ DEVICEID_CPT23,    "Intel Cougar Point watchdog timer",	10, 2 },
155	{ DEVICEID_CPT24,    "Intel Cougar Point watchdog timer",	10, 2 },
156	{ DEVICEID_CPT25,    "Intel Cougar Point watchdog timer",	10, 2 },
157	{ DEVICEID_CPT26,    "Intel Cougar Point watchdog timer",	10, 2 },
158	{ DEVICEID_CPT27,    "Intel Cougar Point watchdog timer",	10, 2 },
159	{ DEVICEID_CPT28,    "Intel Cougar Point watchdog timer",	10, 2 },
160	{ DEVICEID_CPT29,    "Intel Cougar Point watchdog timer",	10, 2 },
161	{ DEVICEID_CPT30,    "Intel Cougar Point watchdog timer",	10, 2 },
162	{ DEVICEID_CPT31,    "Intel Cougar Point watchdog timer",	10, 2 },
163	{ DEVICEID_PATSBURG_LPC1, "Intel Patsburg watchdog timer",	10, 2 },
164	{ DEVICEID_PATSBURG_LPC2, "Intel Patsburg watchdog timer",	10, 2 },
165	{ DEVICEID_PPT0,     "Intel Panther Point watchdog timer",	10, 2 },
166	{ DEVICEID_PPT1,     "Intel Panther Point watchdog timer",	10, 2 },
167	{ DEVICEID_PPT2,     "Intel Panther Point watchdog timer",	10, 2 },
168	{ DEVICEID_PPT3,     "Intel Panther Point watchdog timer",	10, 2 },
169	{ DEVICEID_PPT4,     "Intel Panther Point watchdog timer",	10, 2 },
170	{ DEVICEID_PPT5,     "Intel Panther Point watchdog timer",	10, 2 },
171	{ DEVICEID_PPT6,     "Intel Panther Point watchdog timer",	10, 2 },
172	{ DEVICEID_PPT7,     "Intel Panther Point watchdog timer",	10, 2 },
173	{ DEVICEID_PPT8,     "Intel Panther Point watchdog timer",	10, 2 },
174	{ DEVICEID_PPT9,     "Intel Panther Point watchdog timer",	10, 2 },
175	{ DEVICEID_PPT10,    "Intel Panther Point watchdog timer",	10, 2 },
176	{ DEVICEID_PPT11,    "Intel Panther Point watchdog timer",	10, 2 },
177	{ DEVICEID_PPT12,    "Intel Panther Point watchdog timer",	10, 2 },
178	{ DEVICEID_PPT13,    "Intel Panther Point watchdog timer",	10, 2 },
179	{ DEVICEID_PPT14,    "Intel Panther Point watchdog timer",	10, 2 },
180	{ DEVICEID_PPT15,    "Intel Panther Point watchdog timer",	10, 2 },
181	{ DEVICEID_PPT16,    "Intel Panther Point watchdog timer",	10, 2 },
182	{ DEVICEID_PPT17,    "Intel Panther Point watchdog timer",	10, 2 },
183	{ DEVICEID_PPT18,    "Intel Panther Point watchdog timer",	10, 2 },
184	{ DEVICEID_PPT19,    "Intel Panther Point watchdog timer",	10, 2 },
185	{ DEVICEID_PPT20,    "Intel Panther Point watchdog timer",	10, 2 },
186	{ DEVICEID_PPT21,    "Intel Panther Point watchdog timer",	10, 2 },
187	{ DEVICEID_PPT22,    "Intel Panther Point watchdog timer",	10, 2 },
188	{ DEVICEID_PPT23,    "Intel Panther Point watchdog timer",	10, 2 },
189	{ DEVICEID_PPT24,    "Intel Panther Point watchdog timer",	10, 2 },
190	{ DEVICEID_PPT25,    "Intel Panther Point watchdog timer",	10, 2 },
191	{ DEVICEID_PPT26,    "Intel Panther Point watchdog timer",	10, 2 },
192	{ DEVICEID_PPT27,    "Intel Panther Point watchdog timer",	10, 2 },
193	{ DEVICEID_PPT28,    "Intel Panther Point watchdog timer",	10, 2 },
194	{ DEVICEID_PPT29,    "Intel Panther Point watchdog timer",	10, 2 },
195	{ DEVICEID_PPT30,    "Intel Panther Point watchdog timer",	10, 2 },
196	{ DEVICEID_PPT31,    "Intel Panther Point watchdog timer",	10, 2 },
197	{ DEVICEID_LPT0,     "Intel Lynx Point watchdog timer",		10, 2 },
198	{ DEVICEID_LPT1,     "Intel Lynx Point watchdog timer",		10, 2 },
199	{ DEVICEID_LPT2,     "Intel Lynx Point watchdog timer",		10, 2 },
200	{ DEVICEID_LPT3,     "Intel Lynx Point watchdog timer",		10, 2 },
201	{ DEVICEID_LPT4,     "Intel Lynx Point watchdog timer",		10, 2 },
202	{ DEVICEID_LPT5,     "Intel Lynx Point watchdog timer",		10, 2 },
203	{ DEVICEID_LPT6,     "Intel Lynx Point watchdog timer",		10, 2 },
204	{ DEVICEID_LPT7,     "Intel Lynx Point watchdog timer",		10, 2 },
205	{ DEVICEID_LPT8,     "Intel Lynx Point watchdog timer",		10, 2 },
206	{ DEVICEID_LPT9,     "Intel Lynx Point watchdog timer",		10, 2 },
207	{ DEVICEID_LPT10,    "Intel Lynx Point watchdog timer",		10, 2 },
208	{ DEVICEID_LPT11,    "Intel Lynx Point watchdog timer",		10, 2 },
209	{ DEVICEID_LPT12,    "Intel Lynx Point watchdog timer",		10, 2 },
210	{ DEVICEID_LPT13,    "Intel Lynx Point watchdog timer",		10, 2 },
211	{ DEVICEID_LPT14,    "Intel Lynx Point watchdog timer",		10, 2 },
212	{ DEVICEID_LPT15,    "Intel Lynx Point watchdog timer",		10, 2 },
213	{ DEVICEID_LPT16,    "Intel Lynx Point watchdog timer",		10, 2 },
214	{ DEVICEID_LPT17,    "Intel Lynx Point watchdog timer",		10, 2 },
215	{ DEVICEID_LPT18,    "Intel Lynx Point watchdog timer",		10, 2 },
216	{ DEVICEID_LPT19,    "Intel Lynx Point watchdog timer",		10, 2 },
217	{ DEVICEID_LPT20,    "Intel Lynx Point watchdog timer",		10, 2 },
218	{ DEVICEID_LPT21,    "Intel Lynx Point watchdog timer",		10, 2 },
219	{ DEVICEID_LPT22,    "Intel Lynx Point watchdog timer",		10, 2 },
220	{ DEVICEID_LPT23,    "Intel Lynx Point watchdog timer",		10, 2 },
221	{ DEVICEID_LPT24,    "Intel Lynx Point watchdog timer",		10, 2 },
222	{ DEVICEID_LPT25,    "Intel Lynx Point watchdog timer",		10, 2 },
223	{ DEVICEID_LPT26,    "Intel Lynx Point watchdog timer",		10, 2 },
224	{ DEVICEID_LPT27,    "Intel Lynx Point watchdog timer",		10, 2 },
225	{ DEVICEID_LPT28,    "Intel Lynx Point watchdog timer",		10, 2 },
226	{ DEVICEID_LPT29,    "Intel Lynx Point watchdog timer",		10, 2 },
227	{ DEVICEID_LPT30,    "Intel Lynx Point watchdog timer",		10, 2 },
228	{ DEVICEID_LPT31,    "Intel Lynx Point watchdog timer",		10, 2 },
229	{ DEVICEID_WCPT1,    "Intel Wildcat Point watchdog timer",	10, 2 },
230	{ DEVICEID_WCPT2,    "Intel Wildcat Point watchdog timer",	10, 2 },
231	{ DEVICEID_WCPT3,    "Intel Wildcat Point watchdog timer",	10, 2 },
232	{ DEVICEID_WCPT4,    "Intel Wildcat Point watchdog timer",	10, 2 },
233	{ DEVICEID_WCPT6,    "Intel Wildcat Point watchdog timer",	10, 2 },
234	{ DEVICEID_WBG0,     "Intel Wellsburg watchdog timer",		10, 2 },
235	{ DEVICEID_WBG1,     "Intel Wellsburg watchdog timer",		10, 2 },
236	{ DEVICEID_WBG2,     "Intel Wellsburg watchdog timer",		10, 2 },
237	{ DEVICEID_WBG3,     "Intel Wellsburg watchdog timer",		10, 2 },
238	{ DEVICEID_WBG4,     "Intel Wellsburg watchdog timer",		10, 2 },
239	{ DEVICEID_WBG5,     "Intel Wellsburg watchdog timer",		10, 2 },
240	{ DEVICEID_WBG6,     "Intel Wellsburg watchdog timer",		10, 2 },
241	{ DEVICEID_WBG7,     "Intel Wellsburg watchdog timer",		10, 2 },
242	{ DEVICEID_WBG8,     "Intel Wellsburg watchdog timer",		10, 2 },
243	{ DEVICEID_WBG9,     "Intel Wellsburg watchdog timer",		10, 2 },
244	{ DEVICEID_WBG10,    "Intel Wellsburg watchdog timer",		10, 2 },
245	{ DEVICEID_WBG11,    "Intel Wellsburg watchdog timer",		10, 2 },
246	{ DEVICEID_WBG12,    "Intel Wellsburg watchdog timer",		10, 2 },
247	{ DEVICEID_WBG13,    "Intel Wellsburg watchdog timer",		10, 2 },
248	{ DEVICEID_WBG14,    "Intel Wellsburg watchdog timer",		10, 2 },
249	{ DEVICEID_WBG15,    "Intel Wellsburg watchdog timer",		10, 2 },
250	{ DEVICEID_WBG16,    "Intel Wellsburg watchdog timer",		10, 2 },
251	{ DEVICEID_WBG17,    "Intel Wellsburg watchdog timer",		10, 2 },
252	{ DEVICEID_WBG18,    "Intel Wellsburg watchdog timer",		10, 2 },
253	{ DEVICEID_WBG19,    "Intel Wellsburg watchdog timer",		10, 2 },
254	{ DEVICEID_WBG20,    "Intel Wellsburg watchdog timer",		10, 2 },
255	{ DEVICEID_WBG21,    "Intel Wellsburg watchdog timer",		10, 2 },
256	{ DEVICEID_WBG22,    "Intel Wellsburg watchdog timer",		10, 2 },
257	{ DEVICEID_WBG23,    "Intel Wellsburg watchdog timer",		10, 2 },
258	{ DEVICEID_WBG24,    "Intel Wellsburg watchdog timer",		10, 2 },
259	{ DEVICEID_WBG25,    "Intel Wellsburg watchdog timer",		10, 2 },
260	{ DEVICEID_WBG26,    "Intel Wellsburg watchdog timer",		10, 2 },
261	{ DEVICEID_WBG27,    "Intel Wellsburg watchdog timer",		10, 2 },
262	{ DEVICEID_WBG28,    "Intel Wellsburg watchdog timer",		10, 2 },
263	{ DEVICEID_WBG29,    "Intel Wellsburg watchdog timer",		10, 2 },
264	{ DEVICEID_WBG30,    "Intel Wellsburg watchdog timer",		10, 2 },
265	{ DEVICEID_WBG31,    "Intel Wellsburg watchdog timer",		10, 2 },
266	{ DEVICEID_LPT_LP0,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
267	{ DEVICEID_LPT_LP1,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
268	{ DEVICEID_LPT_LP2,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
269	{ DEVICEID_LPT_LP3,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
270	{ DEVICEID_LPT_LP4,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
271	{ DEVICEID_LPT_LP5,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
272	{ DEVICEID_LPT_LP6,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
273	{ DEVICEID_LPT_LP7,  "Intel Lynx Point-LP watchdog timer",	10, 2 },
274	{ DEVICEID_WCPT_LP1, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
275	{ DEVICEID_WCPT_LP2, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
276	{ DEVICEID_WCPT_LP3, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
277	{ DEVICEID_WCPT_LP5, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
278	{ DEVICEID_WCPT_LP6, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
279	{ DEVICEID_WCPT_LP7, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
280	{ DEVICEID_WCPT_LP9, "Intel Wildcat Point-LP watchdog timer",	10, 2 },
281	{ DEVICEID_DH89XXCC_LPC,  "Intel DH89xxCC watchdog timer",	10, 2 },
282	{ DEVICEID_COLETOCRK_LPC, "Intel Coleto Creek watchdog timer",  10, 2 },
283	{ DEVICEID_AVN0,     "Intel Avoton/Rangeley SoC watchdog timer",10, 3 },
284	{ DEVICEID_AVN1,     "Intel Avoton/Rangeley SoC watchdog timer",10, 3 },
285	{ DEVICEID_AVN2,     "Intel Avoton/Rangeley SoC watchdog timer",10, 3 },
286	{ DEVICEID_AVN3,     "Intel Avoton/Rangeley SoC watchdog timer",10, 3 },
287	{ DEVICEID_BAYTRAIL, "Intel Bay Trail SoC watchdog timer",	10, 3 },
288	{ DEVICEID_BRASWELL, "Intel Braswell SoC watchdog timer",	10, 3 },
289	{ 0, NULL, 0, 0 },
290};
291
292static devclass_t ichwd_devclass;
293
294#define ichwd_read_tco_1(sc, off) \
295	bus_read_1((sc)->tco_res, (off))
296#define ichwd_read_tco_2(sc, off) \
297	bus_read_2((sc)->tco_res, (off))
298#define ichwd_read_tco_4(sc, off) \
299	bus_read_4((sc)->tco_res, (off))
300#define ichwd_read_smi_4(sc, off) \
301	bus_read_4((sc)->smi_res, (off))
302#define ichwd_read_gcs_4(sc, off) \
303	bus_read_4((sc)->gcs_res, (off))
304/* NB: TCO version 3 devices use the gcs_res resource for the PMC register. */
305#define ichwd_read_pmc_4(sc, off) \
306	bus_read_4((sc)->gcs_res, (off))
307
308#define ichwd_write_tco_1(sc, off, val) \
309	bus_write_1((sc)->tco_res, (off), (val))
310#define ichwd_write_tco_2(sc, off, val) \
311	bus_write_2((sc)->tco_res, (off), (val))
312#define ichwd_write_tco_4(sc, off, val) \
313	bus_write_4((sc)->tco_res, (off), (val))
314#define ichwd_write_smi_4(sc, off, val) \
315	bus_write_4((sc)->smi_res, (off), (val))
316#define ichwd_write_gcs_4(sc, off, val) \
317	bus_write_4((sc)->gcs_res, (off), (val))
318/* NB: TCO version 3 devices use the gcs_res resource for the PMC register. */
319#define ichwd_write_pmc_4(sc, off, val) \
320	bus_write_4((sc)->gcs_res, (off), (val))
321
322#define ichwd_verbose_printf(dev, ...) \
323	do {						\
324		if (bootverbose)			\
325			device_printf(dev, __VA_ARGS__);\
326	} while (0)
327
328/*
329 * Disable the watchdog timeout SMI handler.
330 *
331 * Apparently, some BIOSes install handlers that reset or disable the
332 * watchdog timer instead of resetting the system, so we disable the SMI
333 * (by clearing the SMI_TCO_EN bit of the SMI_EN register) to prevent this
334 * from happening.
335 */
336static __inline void
337ichwd_smi_disable(struct ichwd_softc *sc)
338{
339	ichwd_write_smi_4(sc, SMI_EN, ichwd_read_smi_4(sc, SMI_EN) & ~SMI_TCO_EN);
340}
341
342/*
343 * Enable the watchdog timeout SMI handler.  See above for details.
344 */
345static __inline void
346ichwd_smi_enable(struct ichwd_softc *sc)
347{
348	ichwd_write_smi_4(sc, SMI_EN, ichwd_read_smi_4(sc, SMI_EN) | SMI_TCO_EN);
349}
350
351/*
352 * Check if the watchdog SMI triggering is enabled.
353 */
354static __inline int
355ichwd_smi_is_enabled(struct ichwd_softc *sc)
356{
357	return ((ichwd_read_smi_4(sc, SMI_EN) & SMI_TCO_EN) != 0);
358}
359
360/*
361 * Reset the watchdog status bits.
362 */
363static __inline void
364ichwd_sts_reset(struct ichwd_softc *sc)
365{
366	/*
367	 * The watchdog status bits are set to 1 by the hardware to
368	 * indicate various conditions.  They can be cleared by software
369	 * by writing a 1, not a 0.
370	 */
371	ichwd_write_tco_2(sc, TCO1_STS, TCO_TIMEOUT);
372	/*
373	 * According to Intel's docs, clearing SECOND_TO_STS and BOOT_STS must
374	 * be done in two separate operations.
375	 */
376	ichwd_write_tco_2(sc, TCO2_STS, TCO_SECOND_TO_STS);
377	ichwd_write_tco_2(sc, TCO2_STS, TCO_BOOT_STS);
378}
379
380/*
381 * Enable the watchdog timer by clearing the TCO_TMR_HALT bit in the
382 * TCO1_CNT register.  This is complicated by the need to preserve bit 9
383 * of that same register, and the requirement that all other bits must be
384 * written back as zero.
385 */
386static __inline void
387ichwd_tmr_enable(struct ichwd_softc *sc)
388{
389	uint16_t cnt;
390
391	cnt = ichwd_read_tco_2(sc, TCO1_CNT) & TCO_CNT_PRESERVE;
392	ichwd_write_tco_2(sc, TCO1_CNT, cnt & ~TCO_TMR_HALT);
393	sc->active = 1;
394	ichwd_verbose_printf(sc->device, "timer enabled\n");
395}
396
397/*
398 * Disable the watchdog timer.  See above for details.
399 */
400static __inline void
401ichwd_tmr_disable(struct ichwd_softc *sc)
402{
403	uint16_t cnt;
404
405	cnt = ichwd_read_tco_2(sc, TCO1_CNT) & TCO_CNT_PRESERVE;
406	ichwd_write_tco_2(sc, TCO1_CNT, cnt | TCO_TMR_HALT);
407	sc->active = 0;
408	ichwd_verbose_printf(sc->device, "timer disabled\n");
409}
410
411/*
412 * Reload the watchdog timer: writing anything to any of the lower five
413 * bits of the TCO_RLD register reloads the timer from the last value
414 * written to TCO_TMR.
415 */
416static __inline void
417ichwd_tmr_reload(struct ichwd_softc *sc)
418{
419	if (sc->tco_version == 1)
420		ichwd_write_tco_1(sc, TCO_RLD, 1);
421	else
422		ichwd_write_tco_2(sc, TCO_RLD, 1);
423}
424
425/*
426 * Set the initial timeout value.  Note that this must always be followed
427 * by a reload.
428 */
429static __inline void
430ichwd_tmr_set(struct ichwd_softc *sc, unsigned int timeout)
431{
432
433	if (timeout < TCO_RLD_TMR_MIN)
434		timeout = TCO_RLD_TMR_MIN;
435
436	if (sc->tco_version == 1) {
437		uint8_t tmr_val8 = ichwd_read_tco_1(sc, TCO_TMR1);
438
439		tmr_val8 &= (~TCO_RLD1_TMR_MAX & 0xff);
440		if (timeout > TCO_RLD1_TMR_MAX)
441			timeout = TCO_RLD1_TMR_MAX;
442		tmr_val8 |= timeout;
443		ichwd_write_tco_1(sc, TCO_TMR1, tmr_val8);
444	} else {
445		uint16_t tmr_val16 = ichwd_read_tco_2(sc, TCO_TMR2);
446
447		tmr_val16 &= (~TCO_RLD2_TMR_MAX & 0xffff);
448		if (timeout > TCO_RLD2_TMR_MAX)
449			timeout = TCO_RLD2_TMR_MAX;
450		tmr_val16 |= timeout;
451		ichwd_write_tco_2(sc, TCO_TMR2, tmr_val16);
452	}
453
454	sc->timeout = timeout;
455
456	ichwd_verbose_printf(sc->device, "timeout set to %u ticks\n", timeout);
457}
458
459static __inline int
460ichwd_clear_noreboot(struct ichwd_softc *sc)
461{
462	uint32_t status;
463	int rc = 0;
464
465	/* try to clear the NO_REBOOT bit */
466	switch (sc->tco_version) {
467	case 1:
468		status = pci_read_config(sc->ich, ICH_GEN_STA, 1);
469		status &= ~ICH_GEN_STA_NO_REBOOT;
470		pci_write_config(sc->ich, ICH_GEN_STA, status, 1);
471		status = pci_read_config(sc->ich, ICH_GEN_STA, 1);
472		if (status & ICH_GEN_STA_NO_REBOOT)
473			rc = EIO;
474		break;
475	case 2:
476		status = ichwd_read_gcs_4(sc, 0);
477		status &= ~ICH_GCS_NO_REBOOT;
478		ichwd_write_gcs_4(sc, 0, status);
479		status = ichwd_read_gcs_4(sc, 0);
480		if (status & ICH_GCS_NO_REBOOT)
481			rc = EIO;
482		break;
483	case 3:
484		status = ichwd_read_pmc_4(sc, 0);
485		status &= ~ICH_PMC_NO_REBOOT;
486		ichwd_write_pmc_4(sc, 0, status);
487		status = ichwd_read_pmc_4(sc, 0);
488		if (status & ICH_PMC_NO_REBOOT)
489			rc = EIO;
490		break;
491	default:
492		ichwd_verbose_printf(sc->device,
493		    "Unknown TCO Version: %d, can't set NO_REBOOT.\n",
494		    sc->tco_version);
495		break;
496	}
497
498	if (rc)
499		device_printf(sc->device,
500		    "ICH WDT present but disabled in BIOS or hardware\n");
501
502	return (rc);
503}
504
505/*
506 * Watchdog event handler - called by the framework to enable or disable
507 * the watchdog or change the initial timeout value.
508 */
509static void
510ichwd_event(void *arg, unsigned int cmd, int *error)
511{
512	struct ichwd_softc *sc = arg;
513	unsigned int timeout;
514
515	/* convert from power-of-two-ns to WDT ticks */
516	cmd &= WD_INTERVAL;
517
518	if (sc->tco_version == 3) {
519		timeout = ((uint64_t)1 << cmd) / ICHWD_TCO_V3_TICK;
520	} else {
521		timeout = ((uint64_t)1 << cmd) / ICHWD_TICK;
522	}
523
524	if (cmd) {
525		if (!sc->active)
526			ichwd_tmr_enable(sc);
527		if (timeout != sc->timeout)
528			ichwd_tmr_set(sc, timeout);
529		ichwd_tmr_reload(sc);
530		*error = 0;
531	} else {
532		if (sc->active)
533			ichwd_tmr_disable(sc);
534	}
535}
536
537static device_t
538ichwd_find_ich_lpc_bridge(device_t isa, struct ichwd_device **id_p)
539{
540	struct ichwd_device *id;
541	device_t isab, pci;
542	uint16_t devid;
543
544	/* Check whether parent ISA bridge looks familiar. */
545	isab = device_get_parent(isa);
546	pci = device_get_parent(isab);
547	if (pci == NULL || device_get_devclass(pci) != devclass_find("pci"))
548		return (NULL);
549	if (pci_get_vendor(isab) != VENDORID_INTEL)
550		return (NULL);
551	devid = pci_get_device(isab);
552	for (id = ichwd_devices; id->desc != NULL; ++id) {
553		if (devid == id->device) {
554			if (id_p != NULL)
555				*id_p = id;
556			return (isab);
557		}
558	}
559
560	return (NULL);
561}
562
563/*
564 * Look for an ICH LPC interface bridge.  If one is found, register an
565 * ichwd device.  There can be only one.
566 */
567static void
568ichwd_identify(driver_t *driver, device_t parent)
569{
570	struct ichwd_device *id_p;
571	device_t ich = NULL;
572	device_t dev;
573	uint32_t base_address;
574	int rc;
575
576	ich = ichwd_find_ich_lpc_bridge(parent, &id_p);
577	if (ich == NULL)
578		return;
579
580	/* good, add child to bus */
581	if ((dev = device_find_child(parent, driver->name, 0)) == NULL)
582		dev = BUS_ADD_CHILD(parent, 0, driver->name, 0);
583
584	if (dev == NULL)
585		return;
586
587	switch (id_p->tco_version) {
588	case 1:
589		break;
590	case 2:
591		/* get RCBA (root complex base address) */
592		base_address = pci_read_config(ich, ICH_RCBA, 4);
593		rc = bus_set_resource(ich, SYS_RES_MEMORY, 0,
594		    (base_address & 0xffffc000) + ICH_GCS_OFFSET,
595		    ICH_GCS_SIZE);
596		if (rc)
597			ichwd_verbose_printf(dev,
598			    "Can not set TCO v%d memory resource for RCBA\n",
599			    id_p->tco_version);
600		break;
601	case 3:
602		/* get PBASE (Power Management Controller base address) */
603		base_address = pci_read_config(ich, ICH_PBASE, 4);
604		rc = bus_set_resource(ich, SYS_RES_MEMORY, 0,
605		    (base_address & 0xfffffe00) + ICH_PMC_OFFSET,
606		    ICH_PMC_SIZE);
607		if (rc)
608			ichwd_verbose_printf(dev,
609			    "Can not set TCO v%d memory resource for PBASE\n",
610			    id_p->tco_version);
611		break;
612	default:
613		ichwd_verbose_printf(dev,
614		    "Can not set unknown TCO v%d memory resource for unknown base address\n",
615		    id_p->tco_version);
616		break;
617	}
618}
619
620static int
621ichwd_probe(device_t dev)
622{
623	struct ichwd_device *id_p;
624
625	/* Do not claim some ISA PnP device by accident. */
626	if (isa_get_logicalid(dev) != 0)
627		return (ENXIO);
628
629	if (ichwd_find_ich_lpc_bridge(device_get_parent(dev), &id_p) == NULL)
630		return (ENXIO);
631
632	device_set_desc_copy(dev, id_p->desc);
633	return (0);
634}
635
636static int
637ichwd_attach(device_t dev)
638{
639	struct ichwd_softc *sc;
640	struct ichwd_device *id_p;
641	device_t ich;
642	unsigned int pmbase = 0;
643
644	sc = device_get_softc(dev);
645	sc->device = dev;
646
647	ich = ichwd_find_ich_lpc_bridge(device_get_parent(dev), &id_p);
648	if (ich == NULL) {
649		device_printf(sc->device, "Can not find ICH device.\n");
650		goto fail;
651	}
652	sc->ich = ich;
653	sc->ich_version = id_p->ich_version;
654	sc->tco_version = id_p->tco_version;
655
656	/* get ACPI base address */
657	pmbase = pci_read_config(ich, ICH_PMBASE, 2) & ICH_PMBASE_MASK;
658	if (pmbase == 0) {
659		device_printf(dev, "ICH PMBASE register is empty\n");
660		goto fail;
661	}
662
663	/* allocate I/O register space */
664	sc->smi_rid = 0;
665	sc->smi_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &sc->smi_rid,
666	    pmbase + SMI_BASE, pmbase + SMI_BASE + SMI_LEN - 1, SMI_LEN,
667	    RF_ACTIVE | RF_SHAREABLE);
668	if (sc->smi_res == NULL) {
669		device_printf(dev, "unable to reserve SMI registers\n");
670		goto fail;
671	}
672
673	sc->tco_rid = 1;
674	sc->tco_res = bus_alloc_resource(dev, SYS_RES_IOPORT, &sc->tco_rid,
675	    pmbase + TCO_BASE, pmbase + TCO_BASE + TCO_LEN - 1, TCO_LEN,
676	    RF_ACTIVE | RF_SHAREABLE);
677	if (sc->tco_res == NULL) {
678		device_printf(dev, "unable to reserve TCO registers\n");
679		goto fail;
680	}
681
682	sc->gcs_rid = 0;
683	if (sc->tco_version >= 2) {
684		sc->gcs_res = bus_alloc_resource_any(ich, SYS_RES_MEMORY,
685		    &sc->gcs_rid, RF_ACTIVE|RF_SHAREABLE);
686		if (sc->gcs_res == NULL) {
687			device_printf(dev, "unable to reserve GCS registers\n");
688			goto fail;
689		}
690	}
691
692	if (ichwd_clear_noreboot(sc) != 0)
693		goto fail;
694
695	/*
696	 * Determine if we are coming up after a watchdog-induced reset.  Some
697	 * BIOSes may clear this bit at bootup, preventing us from reporting
698	 * this case on such systems.  We clear this bit in ichwd_sts_reset().
699	 */
700	if ((ichwd_read_tco_2(sc, TCO2_STS) & TCO_SECOND_TO_STS) != 0)
701		device_printf(dev,
702		    "resuming after hardware watchdog timeout\n");
703
704	/* reset the watchdog status registers */
705	ichwd_sts_reset(sc);
706
707	/* make sure the WDT starts out inactive */
708	ichwd_tmr_disable(sc);
709
710	/* register the watchdog event handler */
711	sc->ev_tag = EVENTHANDLER_REGISTER(watchdog_list, ichwd_event, sc, 0);
712
713	/* disable the SMI handler */
714	sc->smi_enabled = ichwd_smi_is_enabled(sc);
715	ichwd_smi_disable(sc);
716
717	return (0);
718 fail:
719	sc = device_get_softc(dev);
720	if (sc->tco_res != NULL)
721		bus_release_resource(dev, SYS_RES_IOPORT,
722		    sc->tco_rid, sc->tco_res);
723	if (sc->smi_res != NULL)
724		bus_release_resource(dev, SYS_RES_IOPORT,
725		    sc->smi_rid, sc->smi_res);
726	if (sc->gcs_res != NULL)
727		bus_release_resource(ich, SYS_RES_MEMORY,
728		    sc->gcs_rid, sc->gcs_res);
729
730	return (ENXIO);
731}
732
733static int
734ichwd_detach(device_t dev)
735{
736	struct ichwd_softc *sc;
737
738	sc = device_get_softc(dev);
739
740	/* halt the watchdog timer */
741	if (sc->active)
742		ichwd_tmr_disable(sc);
743
744	/* enable the SMI handler */
745	if (sc->smi_enabled != 0)
746		ichwd_smi_enable(sc);
747
748	/* deregister event handler */
749	if (sc->ev_tag != NULL)
750		EVENTHANDLER_DEREGISTER(watchdog_list, sc->ev_tag);
751	sc->ev_tag = NULL;
752
753	/* reset the watchdog status registers */
754	ichwd_sts_reset(sc);
755
756	/* deallocate I/O register space */
757	bus_release_resource(dev, SYS_RES_IOPORT, sc->tco_rid, sc->tco_res);
758	bus_release_resource(dev, SYS_RES_IOPORT, sc->smi_rid, sc->smi_res);
759
760	/* deallocate memory resource */
761	if (sc->gcs_res)
762		bus_release_resource(sc->ich, SYS_RES_MEMORY, sc->gcs_rid,
763		    sc->gcs_res);
764
765	return (0);
766}
767
768static device_method_t ichwd_methods[] = {
769	DEVMETHOD(device_identify, ichwd_identify),
770	DEVMETHOD(device_probe,	ichwd_probe),
771	DEVMETHOD(device_attach, ichwd_attach),
772	DEVMETHOD(device_detach, ichwd_detach),
773	DEVMETHOD(device_shutdown, ichwd_detach),
774	{0,0}
775};
776
777static driver_t ichwd_driver = {
778	"ichwd",
779	ichwd_methods,
780	sizeof(struct ichwd_softc),
781};
782
783DRIVER_MODULE(ichwd, isa, ichwd_driver, ichwd_devclass, NULL, NULL);
784