xref: /openbmc/qemu/include/hw/acpi/acpi.h (revision da34e65c)
1 #ifndef QEMU_HW_ACPI_H
2 #define QEMU_HW_ACPI_H
3 /*
4  *  Copyright (c) 2009 Isaku Yamahata <yamahata at valinux co jp>
5  *                     VA Linux Systems Japan K.K.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, see
19  * <http://www.gnu.org/licenses/>.
20  */
21 
22 #include "qemu/typedefs.h"
23 #include "qemu/notify.h"
24 #include "qemu/option.h"
25 #include "exec/memory.h"
26 #include "hw/irq.h"
27 
28 /*
29  * current device naming scheme supports up to 256 memory devices
30  */
31 #define ACPI_MAX_RAM_SLOTS 256
32 
33 /* from linux include/acpi/actype.h */
34 /* Default ACPI register widths */
35 
36 #define ACPI_GPE_REGISTER_WIDTH         8
37 #define ACPI_PM1_REGISTER_WIDTH         16
38 #define ACPI_PM2_REGISTER_WIDTH         8
39 #define ACPI_PM_TIMER_WIDTH             32
40 
41 /* PM Timer ticks per second (HZ) */
42 #define PM_TIMER_FREQUENCY  3579545
43 
44 
45 /* ACPI fixed hardware registers */
46 
47 /* from linux/drivers/acpi/acpica/aclocal.h */
48 /* Masks used to access the bit_registers */
49 
50 /* PM1x_STS */
51 #define ACPI_BITMASK_TIMER_STATUS               0x0001
52 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
53 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
54 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
55 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
56 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
57 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000	/* ACPI 3.0 */
58 #define ACPI_BITMASK_WAKE_STATUS                0x8000
59 
60 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
61 	ACPI_BITMASK_TIMER_STATUS          | \
62 	ACPI_BITMASK_BUS_MASTER_STATUS     | \
63 	ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
64 	ACPI_BITMASK_POWER_BUTTON_STATUS   | \
65 	ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
66 	ACPI_BITMASK_RT_CLOCK_STATUS       | \
67 	ACPI_BITMASK_WAKE_STATUS)
68 
69 /* PM1x_EN */
70 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
71 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
72 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
73 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
74 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
75 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000	/* ACPI 3.0 */
76 
77 #define ACPI_BITMASK_PM1_COMMON_ENABLED         ( \
78         ACPI_BITMASK_RT_CLOCK_ENABLE        | \
79         ACPI_BITMASK_POWER_BUTTON_ENABLE    | \
80         ACPI_BITMASK_GLOBAL_LOCK_ENABLE     | \
81         ACPI_BITMASK_TIMER_ENABLE)
82 
83 /* PM1x_CNT */
84 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
85 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
86 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
87 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
88 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
89 
90 /* PM2_CNT */
91 #define ACPI_BITMASK_ARB_DISABLE                0x0001
92 
93 /* These values are part of guest ABI, and can not be changed */
94 typedef enum {
95     ACPI_PCI_HOTPLUG_STATUS = 2,
96     ACPI_CPU_HOTPLUG_STATUS = 4,
97     ACPI_MEMORY_HOTPLUG_STATUS = 8,
98 } AcpiGPEStatusBits;
99 
100 /* structs */
101 typedef struct ACPIPMTimer ACPIPMTimer;
102 typedef struct ACPIPM1EVT ACPIPM1EVT;
103 typedef struct ACPIPM1CNT ACPIPM1CNT;
104 typedef struct ACPIGPE ACPIGPE;
105 typedef struct ACPIREGS ACPIREGS;
106 
107 typedef void (*acpi_update_sci_fn)(ACPIREGS *ar);
108 
109 struct ACPIPMTimer {
110     QEMUTimer *timer;
111     MemoryRegion io;
112     int64_t overflow_time;
113 
114     acpi_update_sci_fn update_sci;
115 };
116 
117 struct ACPIPM1EVT {
118     MemoryRegion io;
119     uint16_t sts;
120     uint16_t en;
121     acpi_update_sci_fn update_sci;
122 };
123 
124 struct ACPIPM1CNT {
125     MemoryRegion io;
126     uint16_t cnt;
127     uint8_t s4_val;
128 };
129 
130 struct ACPIGPE {
131     uint8_t len;
132 
133     uint8_t *sts;
134     uint8_t *en;
135 };
136 
137 struct ACPIREGS {
138     ACPIPMTimer     tmr;
139     ACPIGPE         gpe;
140     struct {
141         ACPIPM1EVT  evt;
142         ACPIPM1CNT  cnt;
143     } pm1;
144     Notifier wakeup;
145 };
146 
147 /* PM_TMR */
148 void acpi_pm_tmr_update(ACPIREGS *ar, bool enable);
149 void acpi_pm_tmr_calc_overflow_time(ACPIREGS *ar);
150 void acpi_pm_tmr_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
151                       MemoryRegion *parent);
152 void acpi_pm_tmr_reset(ACPIREGS *ar);
153 
154 #include "qemu/timer.h"
155 static inline int64_t acpi_pm_tmr_get_clock(void)
156 {
157     return muldiv64(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL), PM_TIMER_FREQUENCY,
158                     get_ticks_per_sec());
159 }
160 
161 /* PM1a_EVT: piix and ich9 don't implement PM1b. */
162 uint16_t acpi_pm1_evt_get_sts(ACPIREGS *ar);
163 void acpi_pm1_evt_power_down(ACPIREGS *ar);
164 void acpi_pm1_evt_reset(ACPIREGS *ar);
165 void acpi_pm1_evt_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
166                        MemoryRegion *parent);
167 
168 /* PM1a_CNT: piix and ich9 don't implement PM1b CNT. */
169 void acpi_pm1_cnt_init(ACPIREGS *ar, MemoryRegion *parent,
170                        bool disable_s3, bool disable_s4, uint8_t s4_val);
171 void acpi_pm1_cnt_update(ACPIREGS *ar,
172                          bool sci_enable, bool sci_disable);
173 void acpi_pm1_cnt_reset(ACPIREGS *ar);
174 
175 /* GPE0 */
176 void acpi_gpe_init(ACPIREGS *ar, uint8_t len);
177 void acpi_gpe_reset(ACPIREGS *ar);
178 
179 void acpi_gpe_ioport_writeb(ACPIREGS *ar, uint32_t addr, uint32_t val);
180 uint32_t acpi_gpe_ioport_readb(ACPIREGS *ar, uint32_t addr);
181 
182 void acpi_send_gpe_event(ACPIREGS *ar, qemu_irq irq,
183                          AcpiGPEStatusBits status);
184 
185 void acpi_update_sci(ACPIREGS *acpi_regs, qemu_irq irq);
186 
187 /* acpi.c */
188 extern int acpi_enabled;
189 extern char unsigned *acpi_tables;
190 extern size_t acpi_tables_len;
191 
192 uint8_t *acpi_table_first(void);
193 uint8_t *acpi_table_next(uint8_t *current);
194 unsigned acpi_table_len(void *current);
195 void acpi_table_add(const QemuOpts *opts, Error **errp);
196 void acpi_table_add_builtin(const QemuOpts *opts, Error **errp);
197 
198 typedef struct AcpiSlicOem AcpiSlicOem;
199 struct AcpiSlicOem {
200   char *id;
201   char *table_id;
202 };
203 int acpi_get_slic_oem(AcpiSlicOem *oem);
204 
205 #endif /* !QEMU_HW_ACPI_H */
206