xref: /openbmc/qemu/include/hw/southbridge/ich9.h (revision 73ec0ead)
1 #ifndef HW_SOUTHBRIDGE_ICH9_H
2 #define HW_SOUTHBRIDGE_ICH9_H
3 
4 #include "hw/isa/apm.h"
5 #include "hw/acpi/ich9.h"
6 #include "hw/intc/ioapic.h"
7 #include "hw/pci/pci.h"
8 #include "hw/pci/pci_device.h"
9 #include "exec/memory.h"
10 #include "qemu/notify.h"
11 #include "qom/object.h"
12 
13 void ich9_generate_smi(void);
14 
15 #define ICH9_CC_SIZE (16 * 1024) /* 16KB. Chipset configuration registers */
16 
17 #define TYPE_ICH9_LPC_DEVICE "ICH9-LPC"
18 OBJECT_DECLARE_SIMPLE_TYPE(ICH9LPCState, ICH9_LPC_DEVICE)
19 
20 struct ICH9LPCState {
21     /* ICH9 LPC PCI to ISA bridge */
22     PCIDevice d;
23 
24     /* (pci device, intx) -> pirq
25      * In real chipset case, the unused slots are never used
26      * as ICH9 supports only D25-D31 irq routing.
27      * On the other hand in qemu case, any slot/function can be populated
28      * via command line option.
29      * So fallback interrupt routing for any devices in any slots is necessary.
30     */
31     uint8_t irr[PCI_SLOT_MAX][PCI_NUM_PINS];
32 
33     APMState apm;
34     ICH9LPCPMRegs pm;
35     uint32_t sci_level; /* track sci level */
36     uint8_t sci_gsi;
37 
38     /* 2.24 Pin Straps */
39     struct {
40         bool spkr_hi;
41     } pin_strap;
42 
43     /* 10.1 Chipset Configuration registers(Memory Space)
44      which is pointed by RCBA */
45     uint8_t chip_config[ICH9_CC_SIZE];
46 
47     /*
48      * 13.7.5 RST_CNT---Reset Control Register (LPC I/F---D31:F0)
49      *
50      * register contents and IO memory region
51      */
52     uint8_t rst_cnt;
53     MemoryRegion rst_cnt_mem;
54 
55     /* SMI feature negotiation via fw_cfg */
56     uint64_t smi_host_features;       /* guest-invisible, host endian */
57     uint8_t smi_host_features_le[8];  /* guest-visible, read-only, little
58                                        * endian uint64_t */
59     uint8_t smi_guest_features_le[8]; /* guest-visible, read-write, little
60                                        * endian uint64_t */
61     uint8_t smi_features_ok;          /* guest-visible, read-only; selecting it
62                                        * triggers feature lockdown */
63     uint64_t smi_negotiated_features; /* guest-invisible, host endian */
64 
65     MemoryRegion rcrb_mem; /* root complex register block */
66     Notifier machine_ready;
67 
68     qemu_irq gsi[IOAPIC_NUM_PINS];
69 };
70 
71 #define ICH9_MASK(bit, ms_bit, ls_bit) \
72 ((uint##bit##_t)(((1ULL << ((ms_bit) + 1)) - 1) & ~((1ULL << ls_bit) - 1)))
73 
74 /* ICH9: Chipset Configuration Registers */
75 #define ICH9_CC_ADDR_MASK                       (ICH9_CC_SIZE - 1)
76 
77 #define ICH9_CC
78 #define ICH9_CC_D28IP                           0x310C
79 #define ICH9_CC_D28IP_SHIFT                     4
80 #define ICH9_CC_D28IP_MASK                      0xf
81 #define ICH9_CC_D28IP_DEFAULT                   0x00214321
82 #define ICH9_CC_D31IR                           0x3140
83 #define ICH9_CC_D30IR                           0x3142
84 #define ICH9_CC_D29IR                           0x3144
85 #define ICH9_CC_D28IR                           0x3146
86 #define ICH9_CC_D27IR                           0x3148
87 #define ICH9_CC_D26IR                           0x314C
88 #define ICH9_CC_D25IR                           0x3150
89 #define ICH9_CC_DIR_DEFAULT                     0x3210
90 #define ICH9_CC_D30IR_DEFAULT                   0x0
91 #define ICH9_CC_DIR_SHIFT                       4
92 #define ICH9_CC_DIR_MASK                        0x7
93 #define ICH9_CC_OIC                             0x31FF
94 #define ICH9_CC_OIC_AEN                         0x1
95 #define ICH9_CC_GCS                             0x3410
96 #define ICH9_CC_GCS_DEFAULT                     0x00000020
97 #define ICH9_CC_GCS_NO_REBOOT                   (1 << 5)
98 
99 /* D28:F[0-5] */
100 #define ICH9_PCIE_DEV                           28
101 #define ICH9_PCIE_FUNC_MAX                      6
102 
103 
104 /* D29:F0 USB UHCI Controller #1 */
105 #define ICH9_USB_UHCI1_DEV                      29
106 #define ICH9_USB_UHCI1_FUNC                     0
107 
108 /* D30:F0 DMI-to-PCI bridge */
109 #define ICH9_D2P_BRIDGE                         "ICH9 D2P BRIDGE"
110 #define ICH9_D2P_BRIDGE_SAVEVM_VERSION          0
111 
112 #define ICH9_D2P_BRIDGE_DEV                     30
113 #define ICH9_D2P_BRIDGE_FUNC                    0
114 
115 #define ICH9_D2P_SECONDARY_DEFAULT              (256 - 8)
116 
117 #define ICH9_D2P_A2_REVISION                    0x92
118 
119 /* D31:F0 LPC Processor Interface */
120 #define ICH9_RST_CNT_IOPORT                     0xCF9
121 
122 /* D31:F1 LPC controller */
123 #define ICH9_A2_LPC                             "ICH9 A2 LPC"
124 #define ICH9_A2_LPC_SAVEVM_VERSION              0
125 
126 #define ICH9_LPC_DEV                            31
127 #define ICH9_LPC_FUNC                           0
128 
129 #define ICH9_A2_LPC_REVISION                    0x2
130 #define ICH9_LPC_NB_PIRQS                       8       /* PCI A-H */
131 
132 #define ICH9_LPC_PMBASE                         0x40
133 #define ICH9_LPC_PMBASE_BASE_ADDRESS_MASK       ICH9_MASK(32, 15, 7)
134 #define ICH9_LPC_PMBASE_RTE                     0x1
135 #define ICH9_LPC_PMBASE_DEFAULT                 0x1
136 
137 #define ICH9_LPC_ACPI_CTRL                      0x44
138 #define ICH9_LPC_ACPI_CTRL_ACPI_EN              0x80
139 #define ICH9_LPC_ACPI_CTRL_SCI_IRQ_SEL_MASK     ICH9_MASK(8, 2, 0)
140 #define ICH9_LPC_ACPI_CTRL_9                    0x0
141 #define ICH9_LPC_ACPI_CTRL_10                   0x1
142 #define ICH9_LPC_ACPI_CTRL_11                   0x2
143 #define ICH9_LPC_ACPI_CTRL_20                   0x4
144 #define ICH9_LPC_ACPI_CTRL_21                   0x5
145 #define ICH9_LPC_ACPI_CTRL_DEFAULT              0x0
146 
147 #define ICH9_LPC_PIRQA_ROUT                     0x60
148 #define ICH9_LPC_PIRQB_ROUT                     0x61
149 #define ICH9_LPC_PIRQC_ROUT                     0x62
150 #define ICH9_LPC_PIRQD_ROUT                     0x63
151 
152 #define ICH9_LPC_PIRQE_ROUT                     0x68
153 #define ICH9_LPC_PIRQF_ROUT                     0x69
154 #define ICH9_LPC_PIRQG_ROUT                     0x6a
155 #define ICH9_LPC_PIRQH_ROUT                     0x6b
156 
157 #define ICH9_LPC_PIRQ_ROUT_IRQEN                0x80
158 #define ICH9_LPC_PIRQ_ROUT_MASK                 ICH9_MASK(8, 3, 0)
159 #define ICH9_LPC_PIRQ_ROUT_DEFAULT              0x80
160 
161 #define ICH9_LPC_GEN_PMCON_1                    0xa0
162 #define ICH9_LPC_GEN_PMCON_1_SMI_LOCK           (1 << 4)
163 #define ICH9_LPC_GEN_PMCON_2                    0xa2
164 #define ICH9_LPC_GEN_PMCON_3                    0xa4
165 #define ICH9_LPC_GEN_PMCON_LOCK                 0xa6
166 
167 #define ICH9_LPC_RCBA                           0xf0
168 #define ICH9_LPC_RCBA_BA_MASK                   ICH9_MASK(32, 31, 14)
169 #define ICH9_LPC_RCBA_EN                        0x1
170 #define ICH9_LPC_RCBA_DEFAULT                   0x0
171 
172 #define ICH9_LPC_PIC_NUM_PINS                   16
173 #define ICH9_LPC_IOAPIC_NUM_PINS                24
174 
175 #define ICH9_GPIO_GSI "gsi"
176 
177 /* D31:F2 SATA Controller #1 */
178 #define ICH9_SATA1_DEV                          31
179 #define ICH9_SATA1_FUNC                         2
180 
181 /* D31:F0 power management I/O registers
182    offset from the address ICH9_LPC_PMBASE */
183 
184 /* ICH9 LPC PM I/O registers are 128 ports and 128-aligned */
185 #define ICH9_PMIO_SIZE                          128
186 #define ICH9_PMIO_MASK                          (ICH9_PMIO_SIZE - 1)
187 
188 #define ICH9_PMIO_PM1_STS                       0x00
189 #define ICH9_PMIO_PM1_EN                        0x02
190 #define ICH9_PMIO_PM1_CNT                       0x04
191 #define ICH9_PMIO_PM1_TMR                       0x08
192 #define ICH9_PMIO_GPE0_STS                      0x20
193 #define ICH9_PMIO_GPE0_EN                       0x28
194 #define ICH9_PMIO_GPE0_LEN                      16
195 #define ICH9_PMIO_SMI_EN                        0x30
196 #define ICH9_PMIO_SMI_EN_APMC_EN                (1 << 5)
197 #define ICH9_PMIO_SMI_EN_TCO_EN                 (1 << 13)
198 #define ICH9_PMIO_SMI_STS                       0x34
199 #define ICH9_PMIO_TCO_RLD                       0x60
200 #define ICH9_PMIO_TCO_LEN                       32
201 
202 /* FADT ACPI_ENABLE/ACPI_DISABLE */
203 #define ICH9_APM_ACPI_ENABLE                    0x2
204 #define ICH9_APM_ACPI_DISABLE                   0x3
205 
206 
207 /* D31:F3 SMBus controller */
208 #define TYPE_ICH9_SMB_DEVICE "ICH9-SMB"
209 
210 #define ICH9_A2_SMB_REVISION                    0x02
211 #define ICH9_SMB_PI                             0x00
212 
213 #define ICH9_SMB_SMBMBAR0                       0x10
214 #define ICH9_SMB_SMBMBAR1                       0x14
215 #define ICH9_SMB_SMBM_BAR                       0
216 #define ICH9_SMB_SMBM_SIZE                      (1 << 8)
217 #define ICH9_SMB_SMB_BASE                       0x20
218 #define ICH9_SMB_SMB_BASE_BAR                   4
219 #define ICH9_SMB_SMB_BASE_SIZE                  (1 << 5)
220 #define ICH9_SMB_HOSTC                          0x40
221 #define ICH9_SMB_HOSTC_SSRESET                  ((uint8_t)(1 << 3))
222 #define ICH9_SMB_HOSTC_I2C_EN                   ((uint8_t)(1 << 2))
223 #define ICH9_SMB_HOSTC_SMB_SMI_EN               ((uint8_t)(1 << 1))
224 #define ICH9_SMB_HOSTC_HST_EN                   ((uint8_t)(1 << 0))
225 
226 /* D31:F3 SMBus I/O and memory mapped I/O registers */
227 #define ICH9_SMB_DEV                            31
228 #define ICH9_SMB_FUNC                           3
229 
230 #define ICH9_SMB_HST_STS                        0x00
231 #define ICH9_SMB_HST_CNT                        0x02
232 #define ICH9_SMB_HST_CMD                        0x03
233 #define ICH9_SMB_XMIT_SLVA                      0x04
234 #define ICH9_SMB_HST_D0                         0x05
235 #define ICH9_SMB_HST_D1                         0x06
236 #define ICH9_SMB_HOST_BLOCK_DB                  0x07
237 
238 #define ICH9_LPC_SMI_NEGOTIATED_FEAT_PROP "x-smi-negotiated-features"
239 
240 /* bit positions used in fw_cfg SMI feature negotiation */
241 #define ICH9_LPC_SMI_F_BROADCAST_BIT            0
242 #define ICH9_LPC_SMI_F_CPU_HOTPLUG_BIT          1
243 #define ICH9_LPC_SMI_F_CPU_HOT_UNPLUG_BIT       2
244 
245 #endif /* HW_SOUTHBRIDGE_ICH9_H */
246