In 2007 Adrian Reber suggested that we drop ASSEMBLY in favor of __ASSEMBLER__.
[coreboot.git] / src / southbridge / intel / i82801gx / i82801gx.h
1 /*
2  * This file is part of the coreboot project.
3  *
4  * Copyright (C) 2008-2009 coresystems GmbH
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; version 2 of the License.
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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  */
19
20 #ifndef SOUTHBRIDGE_INTEL_I82801GX_I82801GX_H
21 #define SOUTHBRIDGE_INTEL_I82801GX_I82801GX_H
22 /*
23  * It does not matter where we put the SMBus I/O base, as long as we
24  * keep it consistent and don't interfere with other devices.  Stage2
25  * will relocate this anyways.
26  * Our solution is to have SMB initialization move the I/O to SMBUS_IO_BASE
27  * again. But handling static BARs is a generic problem that should be
28  * solved in the device allocator.
29  */
30 #define SMBUS_IO_BASE           0x0400
31 /* TODO Make sure these don't get changed by stage2 */
32 #define DEFAULT_GPIOBASE        0x0480
33 #define DEFAULT_PMBASE          0x0500
34
35 #define HPET_ADDR               0xfed00000
36 #define DEFAULT_RCBA            0xfed1c000
37
38 #ifndef __ACPI__
39 #define DEBUG_PERIODIC_SMIS 0
40
41 #if !defined(__ASSEMBLER__) && !defined(__ROMCC__)
42 #if !defined(__PRE_RAM__)
43 #include "chip.h"
44 extern void i82801gx_enable(device_t dev);
45 #else
46 void enable_smbus(void);
47 int smbus_read_byte(unsigned device, unsigned address);
48 #endif
49 void i82801gx_enable_usbdebug(unsigned int port);
50 #endif
51
52 #define MAINBOARD_POWER_OFF     0
53 #define MAINBOARD_POWER_ON      1
54 #define MAINBOARD_POWER_KEEP    2
55
56 #ifndef CONFIG_MAINBOARD_POWER_ON_AFTER_POWER_FAIL
57 #define CONFIG_MAINBOARD_POWER_ON_AFTER_POWER_FAIL MAINBOARD_POWER_ON
58 #endif
59
60 /* PCI Configuration Space (D30:F0): PCI2PCI */
61 #define PSTS    0x06
62 #define SMLT    0x1b
63 #define SECSTS  0x1e
64 #define INTR    0x3c
65 #define BCTRL   0x3e
66 #define   SBR   (1 << 6)
67 #define   SEE   (1 << 1)
68 #define   PERE  (1 << 0)
69
70 /* PCI Configuration Space (D31:F0): LPC */
71
72 #define SERIRQ_CNTL             0x64
73
74 #define GEN_PMCON_1             0xa0
75 #define GEN_PMCON_2             0xa2
76 #define GEN_PMCON_3             0xa4
77
78 /* GEN_PMCON_3 bits */
79 #define RTC_BATTERY_DEAD        (1 << 2)
80 #define RTC_POWER_FAILED        (1 << 1)
81 #define SLEEP_AFTER_POWER_FAIL  (1 << 0)
82
83 #define PMBASE                  0x40
84 #define ACPI_CNTL               0x44
85 #define BIOS_CNTL               0xDC
86 #define GPIO_BASE               0x48 /* LPC GPIO Base Address Register */
87 #define GPIO_CNTL               0x4C /* LPC GPIO Control Register */
88
89 #define PIRQA_ROUT              0x60
90 #define PIRQB_ROUT              0x61
91 #define PIRQC_ROUT              0x62
92 #define PIRQD_ROUT              0x63
93 #define PIRQE_ROUT              0x68
94 #define PIRQF_ROUT              0x69
95 #define PIRQG_ROUT              0x6A
96 #define PIRQH_ROUT              0x6B
97
98 #define LPC_IO_DEC              0x80 /* IO Decode Ranges Register */
99 #define LPC_EN                  0x82 /* LPC IF Enables Register */
100
101 /* PCI Configuration Space (D31:F1): IDE */
102 #define INTR_LN                 0x3c
103 #define IDE_TIM_PRI             0x40    /* IDE timings, primary */
104 #define   IDE_DECODE_ENABLE     (1 << 15)
105 #define   IDE_SITRE             (1 << 14)
106 #define   IDE_ISP_5_CLOCKS      (0 << 12)
107 #define   IDE_ISP_4_CLOCKS      (1 << 12)
108 #define   IDE_ISP_3_CLOCKS      (2 << 12)
109 #define   IDE_RCT_4_CLOCKS      (0 <<  8)
110 #define   IDE_RCT_3_CLOCKS      (1 <<  8)
111 #define   IDE_RCT_2_CLOCKS      (2 <<  8)
112 #define   IDE_RCT_1_CLOCKS      (3 <<  8)
113 #define   IDE_DTE1              (1 <<  7)
114 #define   IDE_PPE1              (1 <<  6)
115 #define   IDE_IE1               (1 <<  5)
116 #define   IDE_TIME1             (1 <<  4)
117 #define   IDE_DTE0              (1 <<  3)
118 #define   IDE_PPE0              (1 <<  2)
119 #define   IDE_IE0               (1 <<  1)
120 #define   IDE_TIME0             (1 <<  0)
121 #define IDE_TIM_SEC             0x42    /* IDE timings, secondary */
122
123 #define IDE_SDMA_CNT            0x48    /* Synchronous DMA control */
124 #define   IDE_SSDE1             (1 <<  3)
125 #define   IDE_SSDE0             (1 <<  2)
126 #define   IDE_PSDE1             (1 <<  1)
127 #define   IDE_PSDE0             (1 <<  0)
128
129 #define IDE_SDMA_TIM            0x4a
130
131 #define IDE_CONFIG              0x54    /* IDE I/O Configuration Register */
132 #define   SIG_MODE_SEC_NORMAL   (0 << 18)
133 #define   SIG_MODE_SEC_TRISTATE (1 << 18)
134 #define   SIG_MODE_SEC_DRIVELOW (2 << 18)
135 #define   SIG_MODE_PRI_NORMAL   (0 << 16)
136 #define   SIG_MODE_PRI_TRISTATE (1 << 16)
137 #define   SIG_MODE_PRI_DRIVELOW (2 << 16)
138 #define   FAST_SCB1             (1 << 15)
139 #define   FAST_SCB0             (1 << 14)
140 #define   FAST_PCB1             (1 << 13)
141 #define   FAST_PCB0             (1 << 12)
142 #define   SCB1                  (1 <<  3)
143 #define   SCB0                  (1 <<  2)
144 #define   PCB1                  (1 <<  1)
145 #define   PCB0                  (1 <<  0)
146
147 /* PCI Configuration Space (D31:F3): SMBus */
148 #define SMB_BASE                0x20
149 #define HOSTC                   0x40
150
151 /* HOSTC bits */
152 #define I2C_EN                  (1 << 2)
153 #define SMB_SMI_EN              (1 << 1)
154 #define HST_EN                  (1 << 0)
155
156 /* SMBus I/O bits. */
157 #define SMBHSTSTAT              0x0
158 #define SMBHSTCTL               0x2
159 #define SMBHSTCMD               0x3
160 #define SMBXMITADD              0x4
161 #define SMBHSTDAT0              0x5
162 #define SMBHSTDAT1              0x6
163 #define SMBBLKDAT               0x7
164 #define SMBTRNSADD              0x9
165 #define SMBSLVDATA              0xa
166 #define SMLINK_PIN_CTL          0xe
167 #define SMBUS_PIN_CTL           0xf
168
169 #define SMBUS_TIMEOUT           (10 * 1000 * 100)
170
171
172 /* Southbridge IO BARs */
173
174 #define GPIOBASE                0x48
175
176 #define PMBASE          0x40
177
178 /* Root Complex Register Block */
179 #define RCBA            0xf0
180
181 #define RCBA8(x) *((volatile u8 *)(DEFAULT_RCBA + x))
182 #define RCBA16(x) *((volatile u16 *)(DEFAULT_RCBA + x))
183 #define RCBA32(x) *((volatile u32 *)(DEFAULT_RCBA + x))
184
185 #define VCH             0x0000  /* 32bit */
186 #define VCAP1           0x0004  /* 32bit */
187 #define VCAP2           0x0008  /* 32bit */
188 #define PVC             0x000c  /* 16bit */
189 #define PVS             0x000e  /* 16bit */
190
191 #define V0CAP           0x0010  /* 32bit */
192 #define V0CTL           0x0014  /* 32bit */
193 #define V0STS           0x001a  /* 16bit */
194
195 #define V1CAP           0x001c  /* 32bit */
196 #define V1CTL           0x0020  /* 32bit */
197 #define V1STS           0x0026  /* 16bit */
198
199 #define RCTCL           0x0100  /* 32bit */
200 #define ESD             0x0104  /* 32bit */
201 #define ULD             0x0110  /* 32bit */
202 #define ULBA            0x0118  /* 64bit */
203
204 #define RP1D            0x0120  /* 32bit */
205 #define RP1BA           0x0128  /* 64bit */
206 #define RP2D            0x0130  /* 32bit */
207 #define RP2BA           0x0138  /* 64bit */
208 #define RP3D            0x0140  /* 32bit */
209 #define RP3BA           0x0148  /* 64bit */
210 #define RP4D            0x0150  /* 32bit */
211 #define RP4BA           0x0158  /* 64bit */
212 #define HDD             0x0160  /* 32bit */
213 #define HDBA            0x0168  /* 64bit */
214 #define RP5D            0x0170  /* 32bit */
215 #define RP5BA           0x0178  /* 64bit */
216 #define RP6D            0x0180  /* 32bit */
217 #define RP6BA           0x0188  /* 64bit */
218
219 #define ILCL            0x01a0  /* 32bit */
220 #define LCAP            0x01a4  /* 32bit */
221 #define LCTL            0x01a8  /* 16bit */
222 #define LSTS            0x01aa  /* 16bit */
223
224 #define RPC             0x0224  /* 32bit */
225 #define RPFN            0x0238  /* 32bit */
226
227 #define TRSR            0x1e00  /*  8bit */
228 #define TRCR            0x1e10  /* 64bit */
229 #define TWDR            0x1e18  /* 64bit */
230
231 #define IOTR0           0x1e80  /* 64bit */
232 #define IOTR1           0x1e88  /* 64bit */
233 #define IOTR2           0x1e90  /* 64bit */
234 #define IOTR3           0x1e98  /* 64bit */
235
236 #define TCTL            0x3000  /*  8bit */
237
238 #define D31IP           0x3100  /* 32bit */
239 #define D30IP           0x3104  /* 32bit */
240 #define D29IP           0x3108  /* 32bit */
241 #define D28IP           0x310c  /* 32bit */
242 #define D27IP           0x3110  /* 32bit */
243 #define D31IR           0x3140  /* 16bit */
244 #define D30IR           0x3142  /* 16bit */
245 #define D29IR           0x3144  /* 16bit */
246 #define D28IR           0x3146  /* 16bit */
247 #define D27IR           0x3148  /* 16bit */
248 #define OIC             0x31ff  /*  8bit */
249
250 #define RC              0x3400  /* 32bit */
251 #define HPTC            0x3404  /* 32bit */
252 #define GCS             0x3410  /* 32bit */
253 #define BUC             0x3414  /* 32bit */
254 #define FD              0x3418  /* 32bit */
255 #define CG              0x341c  /* 32bit */
256
257 /* Function Disable (FD) register values.
258  * Setting a bit disables the corresponding
259  * feature.
260  * Not all features might be disabled on
261  * all chipsets. Esp. ICH-7U is picky.
262  */
263 #define FD_PCIE6        (1 << 21)
264 #define FD_PCIE5        (1 << 20)
265 #define FD_PCIE4        (1 << 19)
266 #define FD_PCIE3        (1 << 18)
267 #define FD_PCIE2        (1 << 17)
268 #define FD_PCIE1        (1 << 16)
269 #define FD_EHCI         (1 << 15)
270 #define FD_LPCB         (1 << 14)
271
272 /* UHCI must be disabled from 4 downwards.
273  * If UHCI controllers get disabled, EHCI
274  * must know about it, too! */
275 #define FD_UHCI4        (1 << 11)
276 #define FD_UHCI34       (1 << 10) | FD_UHCI4
277 #define FD_UHCI234      (1 <<  9) | FD_UHCI3
278 #define FD_UHCI1234     (1 <<  8) | FD_UHCI2
279
280 #define FD_INTLAN       (1 <<  7)
281 #define FD_ACMOD        (1 <<  6)
282 #define FD_ACAUD        (1 <<  5)
283 #define FD_HDAUD        (1 <<  4)
284 #define FD_SMBUS        (1 <<  3)
285 #define FD_SATA         (1 <<  2)
286 #define FD_PATA         (1 <<  1)
287
288 /* ICH7 GPIOBASE */
289 #define GPIO_USE_SEL    0x00
290 #define GP_IO_SEL       0x04
291 #define GP_LVL          0x0c
292 #define GPO_BLINK       0x18
293 #define GPI_INV         0x2c
294 #define GPIO_USE_SEL2   0x30
295 #define GP_IO_SEL2      0x34
296 #define GP_LVL2         0x38
297
298 /* ICH7 PMBASE */
299 #define PM1_STS         0x00
300 #define   WAK_STS       (1 << 15)
301 #define   PCIEXPWAK_STS (1 << 14)
302 #define   PRBTNOR_STS   (1 << 11)
303 #define   RTC_STS       (1 << 10)
304 #define   PWRBTN_STS    (1 << 8)
305 #define   GBL_STS       (1 << 5)
306 #define   BM_STS        (1 << 4)
307 #define   TMROF_STS     (1 << 0)
308 #define PM1_EN          0x02
309 #define   PCIEXPWAK_DIS (1 << 14)
310 #define   RTC_EN        (1 << 10)
311 #define   PWRBTN_EN     (1 << 8)
312 #define   GBL_EN        (1 << 5)
313 #define   TMROF_EN      (1 << 0)
314 #define PM1_CNT         0x04
315 #define   SLP_EN        (1 << 13)
316 #define   SLP_TYP       (7 << 10)
317 #define   GBL_RLS       (1 << 2)
318 #define   BM_RLD        (1 << 1)
319 #define   SCI_EN        (1 << 0)
320 #define PM1_TMR         0x08
321 #define PROC_CNT        0x10
322 #define LV2             0x14
323 #define LV3             0x15
324 #define LV4             0x16
325 #define PM2_CNT         0x20 // mobile only
326 #define GPE0_STS        0x28
327 #define   USB4_STS      (1 << 14)
328 #define   PME_B0_STS    (1 << 13)
329 #define   USB3_STS      (1 << 12)
330 #define   PME_STS       (1 << 11)
331 #define   BATLOW_STS    (1 << 10)
332 #define   PCI_EXP_STS   (1 << 9)
333 #define   RI_STS        (1 << 8)
334 #define   SMB_WAK_STS   (1 << 7)
335 #define   TCOSCI_STS    (1 << 6)
336 #define   AC97_STS      (1 << 5)
337 #define   USB2_STS      (1 << 4)
338 #define   USB1_STS      (1 << 3)
339 #define   SWGPE_STS     (1 << 2)
340 #define   HOT_PLUG_STS  (1 << 1)
341 #define   THRM_STS      (1 << 0)
342 #define GPE0_EN         0x2c
343 #define   PME_B0_EN     (1 << 13)
344 #define   PME_EN        (1 << 11)
345 #define SMI_EN          0x30
346 #define   EL_SMI_EN      (1 << 25) // Intel Quick Resume Technology
347 #define   INTEL_USB2_EN  (1 << 18) // Intel-Specific USB2 SMI logic
348 #define   LEGACY_USB2_EN (1 << 17) // Legacy USB2 SMI logic
349 #define   PERIODIC_EN    (1 << 14) // SMI on PERIODIC_STS in SMI_STS
350 #define   TCO_EN         (1 << 13) // Enable TCO Logic (BIOSWE et al)
351 #define   MCSMI_EN       (1 << 11) // Trap microcontroller range access
352 #define   BIOS_RLS       (1 <<  7) // asserts SCI on bit set
353 #define   SWSMI_TMR_EN   (1 <<  6) // start software smi timer on bit set
354 #define   APMC_EN        (1 <<  5) // Writes to APM_CNT cause SMI#
355 #define   SLP_SMI_EN     (1 <<  4) // Write to SLP_EN in PM1_CNT asserts SMI#
356 #define   LEGACY_USB_EN  (1 <<  3) // Legacy USB circuit SMI logic
357 #define   BIOS_EN        (1 <<  2) // Assert SMI# on setting GBL_RLS bit
358 #define   EOS            (1 <<  1) // End of SMI (deassert SMI#)
359 #define   GBL_SMI_EN     (1 <<  0) // SMI# generation at all?
360 #define SMI_STS         0x34
361 #define ALT_GP_SMI_EN   0x38
362 #define ALT_GP_SMI_STS  0x3a
363 #define GPE_CNTL        0x42
364 #define DEVACT_STS      0x44
365 #define SS_CNT          0x50
366 #define C3_RES          0x54
367
368 #endif /* __ACPI__ */
369 #endif                          /* SOUTHBRIDGE_INTEL_I82801GX_I82801GX_H */