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