Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / ic / i82801lpcreg.h
blob4272d525d2891dc6883c6a117d655573da4f4de5
1 /* $NetBSD: i82801lpcreg.h,v 1.9 2009/09/21 16:18:31 jakllsch Exp $ */
3 /*-
4 * Copyright (c) 2004 The NetBSD Foundation, Inc.
5 * All rights reserved.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Minoura Makoto.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
33 * Intel 82801 Series I/O Controller Hub (ICH) -- LPC Interface Bridge part
34 * register definitions.
37 #ifndef _DEV_IC_I82801LPGREG_H_
38 #define _DEV_IC_I82801LPGREG_H_
40 * PCI configuration registers
42 #define LPCIB_PCI_PMBASE 0x40
43 #define LPCIB_PCI_ACPI_CNTL 0x44
44 # define LPCIB_PCI_ACPI_CNTL_EN (1 << 4)
45 /* GPIO config registers ICH6+ */
46 #define LPCIB_PCI_GPIO_BASE_ICH6 0x48
47 #define LPCIB_PCI_GPIO_CNTL_ICH6 0x4c
48 #define LPCIB_PCI_BIOS_CNTL 0x4e
49 #define LPCIB_PCI_TCO_CNTL 0x54
50 /* GPIO config registers ICH0-ICH5 */
51 #define LPCIB_PCI_GPIO_BASE 0x58
52 #define LPCIB_PCI_GPIO_CNTL 0x5c
53 #define LPCIB_PCI_GPIO_CNTL_EN (1 << 4)
54 #define LPCIB_PCI_PIRQA_ROUT 0x60
55 #define LPCIB_PCI_PIRQB_ROUT 0x61
56 #define LPCIB_PCI_PIRQC_ROUT 0x62
57 #define LPCIB_PCI_PIRQD_ROUT 0x63
58 #define LPCIB_PCI_SIRQ_CNTL 0x64
59 #define LPCIB_PCI_PIRQE_ROUT 0x68
60 #define LPCIB_PCI_PIRQF_ROUT 0x69
61 #define LPCIB_PCI_PIRQG_ROUT 0x6a
62 #define LPCIB_PCI_PIRQH_ROUT 0x6b
63 #define LPCIB_PCI_D31_ERR_CFG 0x88
64 #define LPCIB_PCI_D31_ERR_STS 0x8a
65 #define LPCIB_PCI_PCI_DMA_C 0x90
66 #define LPCIB_PCI_GEN_PMCON_1 0xa0
67 # define LPCIB_PCI_GEN_PMCON_1_SS_EN 0x08
68 #define LPCIB_PCI_GEN_PMCON_2 0xa2
69 #define LPCIB_PCI_GEN_PMCON_3 0xa4
70 #define LPCIB_PCI_STPCLK_DEL 0xa8
71 #define LPCIB_PCI_GPI_ROUT 0xb8
72 #define LPCIB_PCI_TRP_FWD_EN 0xc0
73 #define LPCIB_PCI_MON4_TRP_RNG 0xc4
74 #define LPCIB_PCI_MON5_TRP_RNG 0xc5
75 #define LPCIB_PCI_MON6_TRP_RNG 0xc6
76 #define LPCIB_PCI_MON7_TRP_RNG 0xc7
77 #define LPCIB_PCI_MON_TRP_MSK 0xcc
78 #define LPCIB_PCI_GEN_CNTL 0xd0
79 #define LPCIB_ICH5_HPTC_EN 0x00020000
80 #define LPCIB_ICH5_HPTC_WIN_MASK 0x0000c000
81 #define LPCIB_ICH5_HPTC_0000 0x00000000
82 #define LPCIB_ICH5_HPTC_0000_BASE 0xfed00000
83 #define LPCIB_ICH5_HPTC_1000 0x00008000
84 #define LPCIB_ICH5_HPTC_1000_BASE 0xfed01000
85 #define LPCIB_ICH5_HPTC_2000 0x00010000
86 #define LPCIB_ICH5_HPTC_2000_BASE 0xfed02000
87 #define LPCIB_ICH5_HPTC_3000 0x00018000
88 #define LPCIB_ICH5_HPTC_3000_BASE 0xfed03000
89 #define LPCIB_PCI_GEN_STA 0xd4
90 # define LPCIB_PCI_GEN_STA_SAFE_MODE (1 << 2)
91 # define LPCIB_PCI_GEN_STA_NO_REBOOT (1 << 1)
92 #define LPCIB_PCI_BACK_CNTL 0xd5
93 #define LPCIB_PCI_RTC_CONF 0xd8
94 #define LPCIB_PCI_COM_DEC 0xe0
95 #define LPCIB_PCI_LPCFDD_DEC 0xe1
96 #define LPCIB_PCI_SND_DEC 0xe2
97 #define LPCIB_PCI_FWH_DEC_EN1 0xe3
98 #define LPCIB_PCI_GEN1_DEC 0xe4
99 #define LPCIB_PCI_LPC_EN 0xe6
100 #define LPCIB_PCI_FWH_SEL1 0xe8
101 #define LPCIB_PCI_GEN2_DEC 0xec
102 #define LPCIB_PCI_FWH_SEL2 0xee
103 #define LPCIB_PCI_FWH_DEC_EN2 0xf0
104 #define LPCIB_PCI_FUNC_DIS 0xf2
107 * Power management I/O registers
108 * (offset from PMBASE)
110 #define LPCIB_PM1_STS 0x00 /* ACPI PM1a_EVT_BLK fixed event status */
111 #define LPCIB_PM1_EN 0x02 /* ACPI PM1a_EVT_BLK fixed event enable */
112 #define LPCIB_PM1_CNT 0x04 /* ACPI PM1a_CNT_BLK */
113 #define LPCIB_PM1_TMR 0x08 /* ACPI PMTMR_BLK power mgmt timer */
114 #define LPCIB_PROC_CNT 0x10 /* ACPI P_BLK processor control */
115 #define LPCIB_LV2 0x14 /* ACPI P_BLK processor C2 control */
116 #define LPCIB_PM_CTRL 0x20 /* ACPI Power Management Control */
117 # define LPCIB_PM_SS_STATE_LOW 0x01 /* SpeedStep Low Power State */
118 #define LPCIB_GPE0_STS 0x28 /* ACPI GPE0_BLK GPE0 status */
119 #define LPCIB_GPE0_EN 0x2c /* ACPI GPE0_BLK GPE0 enable */
120 #define LPCIB_SMI_EN 0x30
121 # define LPCIB_SMI_EN_INTEL_USB2_EN (1 << 18)
122 # define LPCIB_SMI_EN_LEGACY_USB2_EN (1 << 17)
123 # define LPCIB_SMI_EN_PERIODIC_EN (1 << 14)
124 # define LPCIB_SMI_EN_TCO_EN (1 << 13)
125 # define LPCIB_SMI_EN_MCSMI_EN (1 << 11)
126 # define LPCIB_SMI_EN_BIOS_RLS (1 << 7)
127 # define LPCIB_SMI_EN_SWSMI_TMR_EN (1 << 6)
128 # define LPCIB_SMI_EN_APMC_EN (1 << 5)
129 # define LPCIB_SMI_EN_SLP_SMI_EN (1 << 4)
130 # define LPCIB_SMI_EN_LEGACY_USB_EN (1 << 3)
131 # define LPCIB_SMI_EN_BIOS_EN (1 << 2)
132 # define LPCIB_SMI_EN_EOS (1 << 1)
133 # define LPCIB_SMI_EN_GBL_SMI_EN (1 << 0)
134 #define LPCIB_SMI_STS 0x34
135 #define LPCIB_ALT_GP_SMI_EN 0x38
136 #define LPCIB_ALT_GP_SMI_STS 0x3a
137 #define LPCIB_MON_SMI 0x40
138 #define LPCIB_DEVACT_STS 0x44
139 #define LPCIB_DEVTRAP_EN 0x48
140 #define LPCIB_BUS_ADDR_TRACK 0x4c
141 #define LPCIB_BUS_CYC_TRACK 0x4e
142 #define LPCIB_PM_SS_CNTL 0x50 /* SpeedStep control */
143 # define LPCIB_PM_SS_CNTL_ARB_DIS 0x01 /* disable arbiter */
146 * General Purpose I/O Registers
147 * (offset from GPIO_BASE)
149 #define LPCIB_GPIO_GPIO_USE_SEL 0x00
150 #define LPCIB_GPIO_GP_IO_SEL 0x04
151 #define LPCIB_GPIO_GP_LVL 0x0c
152 #define LPCIB_GPIO_GPO_TTL 0x14
153 #define LPCIB_GPIO_GPO_BLINK 0x18
154 #define LPCIB_GPIO_GPI_INV 0x2c
155 #define LPCIB_GPIO_GPIO_USE_SEL2 0x30
156 #define LPCIB_GPIO_GP_IO_SEL2 0x34
157 #define LPCIB_GPIO_GP_LVL2 0x38
160 * SMBus controller registers.
163 /* PCI configuration registers */
164 #define LPCIB_SMB_BASE 0x20 /* SMBus base address */
165 #define LPCIB_SMB_HOSTC 0x40 /* host configuration */
166 #define LPCIB_SMB_HOSTC_HSTEN (1 << 0) /* enable host controller */
167 #define LPCIB_SMB_HOSTC_SMIEN (1 << 1) /* generate SMI */
168 #define LPCIB_SMB_HOSTC_I2CEN (1 << 2) /* enable I2C commands */
170 /* SMBus I/O registers */
171 #define LPCIB_SMB_HS 0x00 /* host status */
172 #define LPCIB_SMB_HS_BUSY (1 << 0) /* running a command */
173 #define LPCIB_SMB_HS_INTR (1 << 1) /* command completed */
174 #define LPCIB_SMB_HS_DEVERR (1 << 2) /* command error */
175 #define LPCIB_SMB_HS_BUSERR (1 << 3) /* transaction collision */
176 #define LPCIB_SMB_HS_FAILED (1 << 4) /* failed bus transaction */
177 #define LPCIB_SMB_HS_SMBAL (1 << 5) /* SMBALERT# asserted */
178 #define LPCIB_SMB_HS_INUSE (1 << 6) /* bus semaphore */
179 #define LPCIB_SMB_HS_BDONE (1 << 7) /* byte received/transmitted */
180 #define LPCIB_SMB_HS_BITS "\020\001BUSY\002INTR\003DEVERR\004BUSERR\005FAILED\006SMBAL\007INUSE\010BDONE"
181 #define LPCIB_SMB_HC 0x02 /* host control */
182 #define LPCIB_SMB_HC_INTREN (1 << 0) /* enable interrupts */
183 #define LPCIB_SMB_HC_KILL (1 << 1) /* kill current transaction */
184 #define LPCIB_SMB_HC_CMD_QUICK (0 << 2) /* QUICK command */
185 #define LPCIB_SMB_HC_CMD_BYTE (1 << 2) /* BYTE command */
186 #define LPCIB_SMB_HC_CMD_BDATA (2 << 2) /* BYTE DATA command */
187 #define LPCIB_SMB_HC_CMD_WDATA (3 << 2) /* WORD DATA command */
188 #define LPCIB_SMB_HC_CMD_PCALL (4 << 2) /* PROCESS CALL command */
189 #define LPCIB_SMB_HC_CMD_BLOCK (5 << 2) /* BLOCK command */
190 #define LPCIB_SMB_HC_CMD_I2CREAD (6 << 2) /* I2C READ command */
191 #define LPCIB_SMB_HC_CMD_BLOCKP (7 << 2) /* BLOCK PROCESS command */
192 #define LPCIB_SMB_HC_LASTB (1 << 5) /* last byte in block */
193 #define LPCIB_SMB_HC_START (1 << 6) /* start transaction */
194 #define LPCIB_SMB_HC_PECEN (1 << 7) /* enable PEC */
195 #define LPCIB_SMB_HCMD 0x03 /* host command */
196 #define LPCIB_SMB_TXSLVA 0x04 /* transmit slave address */
197 #define LPCIB_SMB_TXSLVA_READ (1 << 0) /* read direction */
198 #define LPCIB_SMB_TXSLVA_ADDR(x) (((x) & 0x7f) << 1) /* 7-bit address */
199 #define LPCIB_SMB_HD0 0x05 /* host data 0 */
200 #define LPCIB_SMB_HD1 0x06 /* host data 1 */
201 #define LPCIB_SMB_HBDB 0x07 /* host block data byte */
202 #define LPCIB_SMB_PEC 0x08 /* PEC data */
203 #define LPCIB_SMB_RXSLVA 0x09 /* receive slave address */
204 #define LPCIB_SMB_SD 0x0a /* receive slave data */
205 #define LPCIB_SMB_SD_MSG0(x) ((x) & 0xff) /* data message byte 0 */
206 #define LPCIB_SMB_SD_MSG1(x) ((x) >> 8) /* data message byte 1 */
207 #define LPCIB_SMB_AS 0x0c /* auxiliary status */
208 #define LPCIB_SMB_AS_CRCE (1 << 0) /* CRC error */
209 #define LPCIB_SMB_AS_TCO (1 << 1) /* advanced TCO mode */
210 #define LPCIB_SMB_AC 0x0d /* auxiliary control */
211 #define LPCIB_SMB_AC_AAC (1 << 0) /* automatically append CRC */
212 #define LPCIB_SMB_AC_E32B (1 << 1) /* enable 32-byte buffer */
213 #define LPCIB_SMB_SMLPC 0x0e /* SMLink pin control */
214 #define LPCIB_SMB_SMLPC_LINK0 (1 << 0) /* SMLINK0 pin state */
215 #define LPCIB_SMB_SMLPC_LINK1 (1 << 1) /* SMLINK1 pin state */
216 #define LPCIB_SMB_SMLPC_CLKC (1 << 2) /* SMLINK0 pin is untouched */
217 #define LPCIB_SMB_SMBPC 0x0f /* SMBus pin control */
218 #define LPCIB_SMB_SMBPC_CLK (1 << 0) /* SMBCLK pin state */
219 #define LPCIB_SMB_SMBPC_DATA (1 << 1) /* SMBDATA pin state */
220 #define LPCIB_SMB_SMBPC_CLKC (1 << 2) /* SMBCLK pin is untouched */
221 #define LPCIB_SMB_SS 0x10 /* slave status */
222 #define LPCIB_SMB_SS_HN (1 << 0) /* Host Notify command */
223 #define LPCIB_SMB_SCMD 0x11 /* slave command */
224 #define LPCIB_SMB_SCMD_INTREN (1 << 0) /* enable interrupts on HN */
225 #define LPCIB_SMB_SCMD_WKEN (1 << 1) /* wake on HN */
226 #define LPCIB_SMB_SCMD_SMBALDS (1 << 2) /* disable SMBALERT# intr */
227 #define LPCIB_SMB_NDADDR 0x14 /* notify device address */
228 #define LPCIB_SMB_NDADDR_ADDR(x) ((x) >> 1) /* 7-bit address */
229 #define LPCIB_SMB_NDLOW 0x16 /* notify data low byte */
230 #define LPCIB_SMB_NDHIGH 0x17 /* notify data high byte */
232 /* ICH Chipset Configuration Registers (ICH6 and newer) */
233 #define LPCIB_RCBA 0xf0
234 #define LPCIB_RCBA_EN 0x00000001
235 #define LPCIB_RCBA_SIZE 0x00004000
236 #define LPCIB_GCS_OFFSET 0x3410
237 #define LPCIB_GCS_NO_REBOOT 0x20
238 #define LPCIB_RCBA_HPTC 0x00003404
239 #define LPCIB_RCBA_HPTC_EN 0x00000080
240 #define LPCIB_RCBA_HPTC_WIN_MASK 0x00000003
241 #define LPCIB_RCBA_HPTC_0000 0x00000000
242 #define LPCIB_RCBA_HPTC_0000_BASE 0xfed00000
243 #define LPCIB_RCBA_HPTC_1000 0x00000001
244 #define LPCIB_RCBA_HPTC_1000_BASE 0xfed01000
245 #define LPCIB_RCBA_HPTC_2000 0x00000002
246 #define LPCIB_RCBA_HPTC_2000_BASE 0xfed02000
247 #define LPCIB_RCBA_HPTC_3000 0x00000003
248 #define LPCIB_RCBA_HPTC_3000_BASE 0xfed03000
251 * System management TCO registers
252 * (offset from PMBASE)
254 #define LPCIB_TCO_BASE 0x60
255 #define LPCIB_TCO_RLD (LPCIB_TCO_BASE+0x00)
256 #define LPCIB_TCO_TMR (LPCIB_TCO_BASE+0x01)
257 #define LPCIB_TCO_TMR2 (LPCIB_TCO_BASE+0x12) /* ICH6 and newer */
258 # define LPCIB_TCO_TMR_MASK 0x3f
259 #define LPCIB_TCO_DAT_IN (LPCIB_TCO_BASE+0x02)
260 #define LPCIB_TCO_DAT_OUT (LPCIB_TCO_BASE+0x03)
261 #define LPCIB_TCO1_STS (LPCIB_TCO_BASE+0x04)
262 # define LPCIB_TCO1_STS_TIMEOUT 0x08
263 #define LPCIB_TCO2_STS (LPCIB_TCO_BASE+0x06)
264 # define LPCIB_TCO2_STS_BOOT_STS 0x04
265 # define LPCIB_TCO2_STS_SECONDS_TO_STS 0x02
266 #define LPCIB_TCO1_CNT (LPCIB_TCO_BASE+0x08)
267 # define LPCIB_TCO1_CNT_TCO_LOCK (1 << 12)
268 # define LPCIB_TCO1_CNT_TCO_TMR_HLT (1 << 11)
269 # define LPCIB_TCO1_CNT_SEND_NOW (1 << 10)
270 # define LPCIB_TCO1_CNT_NMI2SMI_EN (1 << 9)
271 # define LPCIB_TCO1_CNT_NMI_NOW (1 << 8)
272 #define LPCIB_TCO2_CNT (LPCIB_TCO_BASE+0x0a)
273 #define LPCIB_TCO_MESSAGE1 (LPCIB_TCO_BASE+0x0c)
274 #define LPCIB_TCO_MESSAGE2 (LPCIB_TCO_BASE+0x0d)
275 #define LPCIB_TCO_WDSTATUS (LPCIB_TCO_BASE+0x0e)
276 #define LPCIB_SW_IRQ_GEN (LPCIB_TCO_BASE+0x10)
279 * TCO timer tick. ICH datasheets say:
280 * - The timer is clocked at approximately 0.6 seconds
281 * - 6 bit; values of 0-3 will be ignored and should not be attempted
283 static __inline int
284 lpcib_tcotimer_tick_to_second(int ltick)
286 return ltick * 6 / 10;
289 static __inline int
290 lpcib_tcotimer_second_to_tick(int ltick)
292 return ltick * 10 / 6;
295 #define LPCIB_TCOTIMER_MIN_TICK 4
296 #define LPCIB_TCOTIMER2_MIN_TICK 2
297 #define LPCIB_TCOTIMER_MAX_TICK 0x3f /* 39 seconds max */
298 #define LPCIB_TCOTIMER2_MAX_TICK 0x265 /* 613 seconds max */
300 #endif /* _DEV_IC_I82801LPGREG_H_ */