qemu/include/hw/acpi/acpi.h

   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 "qapi/error.h"
  23 #include "qemu/typedefs.h"
  24 #include "qemu/notify.h"
  25 #include "qemu/option.h"
  26 #include "exec/memory.h"
  27 #include "hw/irq.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 /* PM Timer ticks per second (HZ) */
  43 #define PM_TIMER_FREQUENCY  3579545
  44
  45
  46 /* ACPI fixed hardware registers */
  47
  48 /* from linux/drivers/acpi/acpica/aclocal.h */
  49 /* Masks used to access the bit_registers */
  50
  51 /* PM1x_STS */
  52 #define ACPI_BITMASK_TIMER_STATUS               0x0001
  53 #define ACPI_BITMASK_BUS_MASTER_STATUS          0x0010
  54 #define ACPI_BITMASK_GLOBAL_LOCK_STATUS         0x0020
  55 #define ACPI_BITMASK_POWER_BUTTON_STATUS        0x0100
  56 #define ACPI_BITMASK_SLEEP_BUTTON_STATUS        0x0200
  57 #define ACPI_BITMASK_RT_CLOCK_STATUS            0x0400
  58 #define ACPI_BITMASK_PCIEXP_WAKE_STATUS         0x4000  /* ACPI 3.0 */
  59 #define ACPI_BITMASK_WAKE_STATUS                0x8000
  60
  61 #define ACPI_BITMASK_ALL_FIXED_STATUS           (\
  62         ACPI_BITMASK_TIMER_STATUS          | \
  63         ACPI_BITMASK_BUS_MASTER_STATUS     | \
  64         ACPI_BITMASK_GLOBAL_LOCK_STATUS    | \
  65         ACPI_BITMASK_POWER_BUTTON_STATUS   | \
  66         ACPI_BITMASK_SLEEP_BUTTON_STATUS   | \
  67         ACPI_BITMASK_RT_CLOCK_STATUS       | \
  68         ACPI_BITMASK_WAKE_STATUS)
  69
  70 /* PM1x_EN */
  71 #define ACPI_BITMASK_TIMER_ENABLE               0x0001
  72 #define ACPI_BITMASK_GLOBAL_LOCK_ENABLE         0x0020
  73 #define ACPI_BITMASK_POWER_BUTTON_ENABLE        0x0100
  74 #define ACPI_BITMASK_SLEEP_BUTTON_ENABLE        0x0200
  75 #define ACPI_BITMASK_RT_CLOCK_ENABLE            0x0400
  76 #define ACPI_BITMASK_PCIEXP_WAKE_DISABLE        0x4000  /* ACPI 3.0 */
  77
  78 #define ACPI_BITMASK_PM1_COMMON_ENABLED         ( \
  79         ACPI_BITMASK_RT_CLOCK_ENABLE        | \
  80         ACPI_BITMASK_POWER_BUTTON_ENABLE    | \
  81         ACPI_BITMASK_GLOBAL_LOCK_ENABLE     | \
  82         ACPI_BITMASK_TIMER_ENABLE)
  83
  84 /* PM1x_CNT */
  85 #define ACPI_BITMASK_SCI_ENABLE                 0x0001
  86 #define ACPI_BITMASK_BUS_MASTER_RLD             0x0002
  87 #define ACPI_BITMASK_GLOBAL_LOCK_RELEASE        0x0004
  88 #define ACPI_BITMASK_SLEEP_TYPE                 0x1C00
  89 #define ACPI_BITMASK_SLEEP_ENABLE               0x2000
  90
  91 /* PM2_CNT */
  92 #define ACPI_BITMASK_ARB_DISABLE                0x0001
  93
  94 /* These values are part of guest ABI, and can not be changed */
  95 typedef enum {
  96     ACPI_PCI_HOTPLUG_STATUS = 2,
  97     ACPI_CPU_HOTPLUG_STATUS = 4,
  98     ACPI_MEMORY_HOTPLUG_STATUS = 8,
  99 } AcpiGPEStatusBits;
 100
 101 /* structs */
 102 typedef struct ACPIPMTimer ACPIPMTimer;
 103 typedef struct ACPIPM1EVT ACPIPM1EVT;
 104 typedef struct ACPIPM1CNT ACPIPM1CNT;
 105 typedef struct ACPIGPE ACPIGPE;
 106 typedef struct ACPIREGS ACPIREGS;
 107
 108 typedef void (*acpi_update_sci_fn)(ACPIREGS *ar);
 109
 110 struct ACPIPMTimer {
 111     QEMUTimer *timer;
 112     MemoryRegion io;
 113     int64_t overflow_time;
 114
 115     acpi_update_sci_fn update_sci;
 116 };
 117
 118 struct ACPIPM1EVT {
 119     MemoryRegion io;
 120     uint16_t sts;
 121     uint16_t en;
 122     acpi_update_sci_fn update_sci;
 123 };
 124
 125 struct ACPIPM1CNT {
 126     MemoryRegion io;
 127     uint16_t cnt;
 128     uint8_t s4_val;
 129 };
 130
 131 struct ACPIGPE {
 132     uint8_t len;
 133
 134     uint8_t *sts;
 135     uint8_t *en;
 136 };
 137
 138 struct ACPIREGS {
 139     ACPIPMTimer     tmr;
 140     ACPIGPE         gpe;
 141     struct {
 142         ACPIPM1EVT  evt;
 143         ACPIPM1CNT  cnt;
 144     } pm1;
 145     Notifier wakeup;
 146 };
 147
 148 /* PM_TMR */
 149 void acpi_pm_tmr_update(ACPIREGS *ar, bool enable);
 150 void acpi_pm_tmr_calc_overflow_time(ACPIREGS *ar);
 151 void acpi_pm_tmr_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
 152                       MemoryRegion *parent);
 153 void acpi_pm_tmr_reset(ACPIREGS *ar);
 154
 155 #include "qemu/timer.h"
 156 static inline int64_t acpi_pm_tmr_get_clock(void)
 157 {
 158     return muldiv64(qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL), PM_TIMER_FREQUENCY,
 159                     get_ticks_per_sec());
 160 }
 161
 162 /* PM1a_EVT: piix and ich9 don't implement PM1b. */
 163 uint16_t acpi_pm1_evt_get_sts(ACPIREGS *ar);
 164 void acpi_pm1_evt_power_down(ACPIREGS *ar);
 165 void acpi_pm1_evt_reset(ACPIREGS *ar);
 166 void acpi_pm1_evt_init(ACPIREGS *ar, acpi_update_sci_fn update_sci,
 167                        MemoryRegion *parent);
 168
 169 /* PM1a_CNT: piix and ich9 don't implement PM1b CNT. */
 170 void acpi_pm1_cnt_init(ACPIREGS *ar, MemoryRegion *parent,
 171                        bool disable_s3, bool disable_s4, uint8_t s4_val);
 172 void acpi_pm1_cnt_update(ACPIREGS *ar,
 173                          bool sci_enable, bool sci_disable);
 174 void acpi_pm1_cnt_reset(ACPIREGS *ar);
 175
 176 /* GPE0 */
 177 void acpi_gpe_init(ACPIREGS *ar, uint8_t len);
 178 void acpi_gpe_reset(ACPIREGS *ar);
 179
 180 void acpi_gpe_ioport_writeb(ACPIREGS *ar, uint32_t addr, uint32_t val);
 181 uint32_t acpi_gpe_ioport_readb(ACPIREGS *ar, uint32_t addr);
 182
 183 void acpi_send_gpe_event(ACPIREGS *ar, qemu_irq irq,
 184                          AcpiGPEStatusBits status);
 185
 186 void acpi_update_sci(ACPIREGS *acpi_regs, qemu_irq irq);
 187
 188 /* acpi.c */
 189 extern int acpi_enabled;
 190 extern char unsigned *acpi_tables;
 191 extern size_t acpi_tables_len;
 192
 193 uint8_t *acpi_table_first(void);
 194 uint8_t *acpi_table_next(uint8_t *current);
 195 unsigned acpi_table_len(void *current);
 196 void acpi_table_add(const QemuOpts *opts, Error **errp);
 197 void acpi_table_add_builtin(const QemuOpts *opts, Error **errp);
 198
 199 #endif /* !QEMU_HW_ACPI_H */