1/*-
2 * Copyright (c) 2004 Texas A&M University
3 * All rights reserved.
4 *
5 * Developer: Wm. Daryl Hawkins
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: releng/10.3/sys/dev/ichwd/ichwd.h 275439 2014-12-03 06:53:49Z mav $
29 */
30
31#ifndef _ICHWD_H_
32#define _ICHWD_H_
33
34struct ichwd_device {
35	uint16_t		 device;
36	char			*desc;
37	unsigned int		 version;
38};
39
40struct ichwd_softc {
41	device_t		 device;
42	device_t		 ich;
43	int			 ich_version;
44
45	int			 active;
46	unsigned int		 timeout;
47
48	int			 smi_enabled;
49	int			 smi_rid;
50	struct resource		*smi_res;
51
52	int			 tco_rid;
53	struct resource		*tco_res;
54
55	int			 gcs_rid;
56	struct resource		*gcs_res;
57
58	eventhandler_tag	 ev_tag;
59};
60
61#define VENDORID_INTEL		0x8086
62#define DEVICEID_CPT0		0x1c40
63#define DEVICEID_CPT1		0x1c41
64#define DEVICEID_CPT2		0x1c42
65#define DEVICEID_CPT3		0x1c43
66#define DEVICEID_CPT4		0x1c44
67#define DEVICEID_CPT5		0x1c45
68#define DEVICEID_CPT6		0x1c46
69#define DEVICEID_CPT7		0x1c47
70#define DEVICEID_CPT8		0x1c48
71#define DEVICEID_CPT9		0x1c49
72#define DEVICEID_CPT10		0x1c4a
73#define DEVICEID_CPT11		0x1c4b
74#define DEVICEID_CPT12		0x1c4c
75#define DEVICEID_CPT13		0x1c4d
76#define DEVICEID_CPT14		0x1c4e
77#define DEVICEID_CPT15		0x1c4f
78#define DEVICEID_CPT16		0x1c50
79#define DEVICEID_CPT17		0x1c51
80#define DEVICEID_CPT18		0x1c52
81#define DEVICEID_CPT19		0x1c53
82#define DEVICEID_CPT20		0x1c54
83#define DEVICEID_CPT21		0x1c55
84#define DEVICEID_CPT22		0x1c56
85#define DEVICEID_CPT23		0x1c57
86#define DEVICEID_CPT24		0x1c58
87#define DEVICEID_CPT25		0x1c59
88#define DEVICEID_CPT26		0x1c5a
89#define DEVICEID_CPT27		0x1c5b
90#define DEVICEID_CPT28		0x1c5c
91#define DEVICEID_CPT29		0x1c5d
92#define DEVICEID_CPT30		0x1c5e
93#define DEVICEID_CPT31		0x1c5f
94#define DEVICEID_PATSBURG_LPC1	0x1d40
95#define DEVICEID_PATSBURG_LPC2	0x1d41
96#define DEVICEID_PPT0		0x1e40
97#define DEVICEID_PPT1		0x1e41
98#define DEVICEID_PPT2		0x1e42
99#define DEVICEID_PPT3		0x1e43
100#define DEVICEID_PPT4		0x1e44
101#define DEVICEID_PPT5		0x1e45
102#define DEVICEID_PPT6		0x1e46
103#define DEVICEID_PPT7		0x1e47
104#define DEVICEID_PPT8		0x1e48
105#define DEVICEID_PPT9		0x1e49
106#define DEVICEID_PPT10		0x1e4a
107#define DEVICEID_PPT11		0x1e4b
108#define DEVICEID_PPT12		0x1e4c
109#define DEVICEID_PPT13		0x1e4d
110#define DEVICEID_PPT14		0x1e4e
111#define DEVICEID_PPT15		0x1e4f
112#define DEVICEID_PPT16		0x1e50
113#define DEVICEID_PPT17		0x1e51
114#define DEVICEID_PPT18		0x1e52
115#define DEVICEID_PPT19		0x1e53
116#define DEVICEID_PPT20		0x1e54
117#define DEVICEID_PPT21		0x1e55
118#define DEVICEID_PPT22		0x1e56
119#define DEVICEID_PPT23		0x1e57
120#define DEVICEID_PPT24		0x1e58
121#define DEVICEID_PPT25		0x1e59
122#define DEVICEID_PPT26		0x1e5a
123#define DEVICEID_PPT27		0x1e5b
124#define DEVICEID_PPT28		0x1e5c
125#define DEVICEID_PPT29		0x1e5d
126#define DEVICEID_PPT30		0x1e5e
127#define DEVICEID_PPT31		0x1e5f
128#define DEVICEID_DH89XXCC_LPC	0x2310
129#define DEVICEID_COLETOCRK_LPC	0x2390
130#define DEVICEID_82801AA	0x2410
131#define DEVICEID_82801AB	0x2420
132#define DEVICEID_82801BA	0x2440
133#define DEVICEID_82801BAM	0x244c
134#define DEVICEID_82801CA	0x2480
135#define DEVICEID_82801CAM	0x248c
136#define DEVICEID_82801DB	0x24c0
137#define DEVICEID_82801DBM	0x24cc
138#define DEVICEID_82801E		0x2450
139#define DEVICEID_82801EB	0x24dc
140#define DEVICEID_82801EBR	0x24d0
141#define DEVICEID_6300ESB	0x25a1
142#define DEVICEID_82801FBR	0x2640
143#define DEVICEID_ICH6M		0x2641
144#define DEVICEID_ICH6W		0x2642
145#define DEVICEID_63XXESB	0x2670
146#define DEVICEID_ICH7		0x27b8
147#define DEVICEID_ICH7DH		0x27b0
148#define DEVICEID_ICH7M		0x27b9
149#define DEVICEID_NM10		0x27bc
150#define DEVICEID_ICH7MDH	0x27bd
151#define DEVICEID_ICH8		0x2810
152#define DEVICEID_ICH8DH		0x2812
153#define DEVICEID_ICH8DO		0x2814
154#define DEVICEID_ICH8M		0x2815
155#define DEVICEID_ICH8ME		0x2811
156#define DEVICEID_ICH9		0x2918
157#define DEVICEID_ICH9DH		0x2912
158#define DEVICEID_ICH9DO		0x2914
159#define DEVICEID_ICH9M		0x2919
160#define DEVICEID_ICH9ME		0x2917
161#define DEVICEID_ICH9R		0x2916
162#define DEVICEID_ICH10		0x3a18
163#define DEVICEID_ICH10D		0x3a1a
164#define DEVICEID_ICH10DO	0x3a14
165#define DEVICEID_ICH10R		0x3a16
166#define DEVICEID_PCH		0x3b00
167#define DEVICEID_PCHM		0x3b01
168#define DEVICEID_P55		0x3b02
169#define DEVICEID_PM55		0x3b03
170#define DEVICEID_H55		0x3b06
171#define DEVICEID_QM57		0x3b07
172#define DEVICEID_H57		0x3b08
173#define DEVICEID_HM55		0x3b09
174#define DEVICEID_Q57		0x3b0a
175#define DEVICEID_HM57		0x3b0b
176#define DEVICEID_PCHMSFF	0x3b0d
177#define DEVICEID_QS57		0x3b0f
178#define DEVICEID_3400		0x3b12
179#define DEVICEID_3420		0x3b14
180#define DEVICEID_3450		0x3b16
181#define DEVICEID_LPT0		0x8c40
182#define DEVICEID_LPT1		0x8c41
183#define DEVICEID_LPT2		0x8c42
184#define DEVICEID_LPT3		0x8c43
185#define DEVICEID_LPT4		0x8c44
186#define DEVICEID_LPT5		0x8c45
187#define DEVICEID_LPT6		0x8c46
188#define DEVICEID_LPT7		0x8c47
189#define DEVICEID_LPT8		0x8c48
190#define DEVICEID_LPT9		0x8c49
191#define DEVICEID_LPT10		0x8c4a
192#define DEVICEID_LPT11		0x8c4b
193#define DEVICEID_LPT12		0x8c4c
194#define DEVICEID_LPT13		0x8c4d
195#define DEVICEID_LPT14		0x8c4e
196#define DEVICEID_LPT15		0x8c4f
197#define DEVICEID_LPT16		0x8c50
198#define DEVICEID_LPT17		0x8c51
199#define DEVICEID_LPT18		0x8c52
200#define DEVICEID_LPT19		0x8c53
201#define DEVICEID_LPT20		0x8c54
202#define DEVICEID_LPT21		0x8c55
203#define DEVICEID_LPT22		0x8c56
204#define DEVICEID_LPT23		0x8c57
205#define DEVICEID_LPT24		0x8c58
206#define DEVICEID_LPT25		0x8c59
207#define DEVICEID_LPT26		0x8c5a
208#define DEVICEID_LPT27		0x8c5b
209#define DEVICEID_LPT28		0x8c5c
210#define DEVICEID_LPT29		0x8c5d
211#define DEVICEID_LPT30		0x8c5e
212#define DEVICEID_LPT31		0x8c5f
213#define DEVICEID_WCPT2		0x8cc2
214#define DEVICEID_WCPT4		0x8cc4
215#define DEVICEID_WCPT6		0x8cc6
216
217/* ICH LPC Interface Bridge Registers (ICH5 and older) */
218#define ICH_GEN_STA		0xd4
219#define ICH_GEN_STA_NO_REBOOT	0x02
220#define ICH_PMBASE		0x40 /* ACPI base address register */
221#define ICH_PMBASE_MASK		0x7f80 /* bits 7-15 */
222
223/* ICH Chipset Configuration Registers (ICH6 and newer) */
224#define ICH_RCBA		0xf0
225#define ICH_GCS_OFFSET		0x3410
226#define ICH_GCS_SIZE		0x4
227#define ICH_GCS_NO_REBOOT	0x20
228
229/* register names and locations (relative to PMBASE) */
230#define SMI_BASE		0x30 /* base address for SMI registers */
231#define SMI_LEN			0x08
232#define SMI_EN			0x00 /* SMI Control and Enable Register */
233#define SMI_STS			0x04 /* SMI Status Register */
234#define TCO_BASE		0x60 /* base address for TCO registers */
235#define TCO_LEN			0x20
236#define TCO_RLD			0x00 /* TCO Reload and Current Value */
237#define TCO_TMR1		0x01 /* TCO Timer Initial Value
238					(ICH5 and older, 8 bits) */
239#define TCO_TMR2		0x12 /* TCO Timer Initial Value
240					(ICH6 and newer, 16 bits) */
241#define TCO_DAT_IN		0x02 /* TCO Data In (DO NOT USE) */
242#define TCO_DAT_OUT		0x03 /* TCO Data Out (DO NOT USE) */
243#define TCO1_STS		0x04 /* TCO Status 1 */
244#define TCO2_STS		0x06 /* TCO Status 2 */
245#define TCO1_CNT		0x08 /* TCO Control 1 */
246#define TCO2_CNT		0x08 /* TCO Control 2 */
247#define TCO_MESSAGE1		0x0c /* TCO Message 1 */
248#define TCO_MESSAGE2		0x0d /* TCO Message 2 */
249
250/* bit definitions for SMI_EN and SMI_STS */
251#define SMI_TCO_EN		0x2000
252#define SMI_TCO_STS		0x2000
253#define SMI_GBL_EN		0x0001
254
255/* timer value mask for TCO_RLD and TCO_TMR */
256#define TCO_TIMER_MASK		0x1f
257
258/* status bits for TCO1_STS */
259#define TCO_NEWCENTURY		0x80 /* set for RTC year roll over (99 to 00) */
260#define TCO_TIMEOUT		0x08 /* timed out */
261#define TCO_INT_STS		0x04 /* data out (DO NOT USE) */
262#define TCO_SMI_STS		0x02 /* data in (DO NOT USE) */
263
264/* status bits for TCO2_STS */
265#define TCO_BOOT_STS		0x04 /* failed to come out of reset */
266#define TCO_SECOND_TO_STS	0x02 /* ran down twice */
267
268/* control bits for TCO1_CNT */
269#define TCO_TMR_HALT		0x0800		/* clear to enable WDT */
270#define TCO_NMI2SMI_EN		0x0200		/* convert NMIs to SMIs */
271#define TCO_CNT_PRESERVE	TCO_NMI2SMI_EN	/* preserve these bits */
272#define TCO_NMI_NOW		0x0100		/* trigger an NMI */
273
274/*
275 * Masks for the TCO timer value field in TCO_RLD.
276 * If the datasheets are to be believed, the minimum value actually varies
277 * from chipset to chipset - 4 for ICH5 and 2 for all other chipsets.
278 * I suspect this is a bug in the ICH5 datasheet and that the minimum is
279 * uniformly 2, but I'd rather err on the side of caution.
280 */
281#define TCO_RLD_TMR_MIN		0x0004
282#define TCO_RLD1_TMR_MAX	0x003f
283#define TCO_RLD2_TMR_MAX	0x03ff
284
285/* approximate length in nanoseconds of one WDT tick (about 0.6 sec) */
286#define ICHWD_TICK		600000000
287
288#endif
289