include/hw/acpi/aml-build.h

   1 #ifndef HW_ACPI_GEN_UTILS_H
   2 #define HW_ACPI_GEN_UTILS_H
   3
   4 #include <stdint.h>
   5 #include <glib.h>
   6 #include "qemu/compiler.h"
   7 #include "hw/acpi/acpi-defs.h"
   8
   9 /* Reserve RAM space for tables: add another order of magnitude. */
  10 #define ACPI_BUILD_TABLE_MAX_SIZE         0x200000
  11
  12 #define ACPI_BUILD_APPNAME6 "BOCHS "
  13 #define ACPI_BUILD_APPNAME4 "BXPC"
  14
  15 #define ACPI_BUILD_TABLE_FILE "etc/acpi/tables"
  16 #define ACPI_BUILD_RSDP_FILE "etc/acpi/rsdp"
  17 #define ACPI_BUILD_TPMLOG_FILE "etc/tpm/log"
  18
  19 #define AML_NOTIFY_METHOD "NTFY"
  20
  21 typedef enum {
  22     AML_NO_OPCODE = 0,/* has only data */
  23     AML_OPCODE,       /* has opcode optionally followed by data */
  24     AML_PACKAGE,      /* has opcode and uses PkgLength for its length */
  25     AML_EXT_PACKAGE,  /* Same as AML_PACKAGE but also has 'ExOpPrefix' */
  26     AML_BUFFER,       /* data encoded as 'DefBuffer' */
  27     AML_RES_TEMPLATE, /* encoded as ResourceTemplate macro */
  28 } AmlBlockFlags;
  29
  30 struct Aml {
  31     GArray *buf;
  32
  33     /*< private >*/
  34     uint8_t op;
  35     AmlBlockFlags block_flags;
  36 };
  37 typedef struct Aml Aml;
  38
  39 typedef enum {
  40     AML_COMPATIBILITY = 0,
  41     AML_TYPEA = 1,
  42     AML_TYPEB = 2,
  43     AML_TYPEF = 3,
  44 } AmlDmaType;
  45
  46 typedef enum {
  47     AML_NOTBUSMASTER = 0,
  48     AML_BUSMASTER = 1,
  49 } AmlDmaBusMaster;
  50
  51 typedef enum {
  52     AML_TRANSFER8 = 0,
  53     AML_TRANSFER8_16 = 1,
  54     AML_TRANSFER16 = 2,
  55 } AmlTransferSize;
  56
  57 typedef enum {
  58     AML_DECODE10 = 0,
  59     AML_DECODE16 = 1,
  60 } AmlIODecode;
  61
  62 typedef enum {
  63     AML_ANY_ACC = 0,
  64     AML_BYTE_ACC = 1,
  65     AML_WORD_ACC = 2,
  66     AML_DWORD_ACC = 3,
  67     AML_QWORD_ACC = 4,
  68     AML_BUFFER_ACC = 5,
  69 } AmlAccessType;
  70
  71 typedef enum {
  72     AML_NOLOCK = 0,
  73     AML_LOCK = 1,
  74 } AmlLockRule;
  75
  76 typedef enum {
  77     AML_PRESERVE = 0,
  78     AML_WRITE_AS_ONES = 1,
  79     AML_WRITE_AS_ZEROS = 2,
  80 } AmlUpdateRule;
  81
  82 typedef enum {
  83     AML_SYSTEM_MEMORY = 0X00,
  84     AML_SYSTEM_IO = 0X01,
  85 } AmlRegionSpace;
  86
  87 typedef enum {
  88     AML_MEMORY_RANGE = 0,
  89     AML_IO_RANGE = 1,
  90     AML_BUS_NUMBER_RANGE = 2,
  91 } AmlResourceType;
  92
  93 typedef enum {
  94     AML_SUB_DECODE = 1 << 1,
  95     AML_POS_DECODE = 0
  96 } AmlDecode;
  97
  98 typedef enum {
  99     AML_MAX_FIXED = 1 << 3,
 100     AML_MAX_NOT_FIXED = 0,
 101 } AmlMaxFixed;
 102
 103 typedef enum {
 104     AML_MIN_FIXED = 1 << 2,
 105     AML_MIN_NOT_FIXED = 0
 106 } AmlMinFixed;
 107
 108 /*
 109  * ACPI 1.0b: Table 6-26 I/O Resource Flag (Resource Type = 1) Definitions
 110  * _RNG field definition
 111  */
 112 typedef enum {
 113     AML_ISA_ONLY = 1,
 114     AML_NON_ISA_ONLY = 2,
 115     AML_ENTIRE_RANGE = 3,
 116 } AmlISARanges;
 117
 118 /*
 119  * ACPI 1.0b: Table 6-25 Memory Resource Flag (Resource Type = 0) Definitions
 120  * _MEM field definition
 121  */
 122 typedef enum {
 123     AML_NON_CACHEABLE = 0,
 124     AML_CACHEABLE = 1,
 125     AML_WRITE_COMBINING = 2,
 126     AML_PREFETCHABLE = 3,
 127 } AmlCacheable;
 128
 129 /*
 130  * ACPI 1.0b: Table 6-25 Memory Resource Flag (Resource Type = 0) Definitions
 131  * _RW field definition
 132  */
 133 typedef enum {
 134     AML_READ_ONLY = 0,
 135     AML_READ_WRITE = 1,
 136 } AmlReadAndWrite;
 137
 138 /*
 139  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 140  * Interrupt Vector Flags Bits[0] Consumer/Producer
 141  */
 142 typedef enum {
 143     AML_CONSUMER_PRODUCER = 0,
 144     AML_CONSUMER = 1,
 145 } AmlConsumerAndProducer;
 146
 147 /*
 148  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 149  * _HE field definition
 150  */
 151 typedef enum {
 152     AML_LEVEL = 0,
 153     AML_EDGE = 1,
 154 } AmlLevelAndEdge;
 155
 156 /*
 157  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 158  * _LL field definition
 159  */
 160 typedef enum {
 161     AML_ACTIVE_HIGH = 0,
 162     AML_ACTIVE_LOW = 1,
 163 } AmlActiveHighAndLow;
 164
 165 /*
 166  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 167  * _SHR field definition
 168  */
 169 typedef enum {
 170     AML_EXCLUSIVE = 0,
 171     AML_SHARED = 1,
 172     AML_EXCLUSIVE_AND_WAKE = 2,
 173     AML_SHARED_AND_WAKE = 3,
 174 } AmlShared;
 175
 176 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: MethodFlags */
 177 typedef enum {
 178     AML_NOTSERIALIZED = 0,
 179     AML_SERIALIZED = 1,
 180 } AmlSerializeFlag;
 181
 182 /*
 183  * ACPI 5.0: Table 6-189 GPIO Connection Descriptor Definition
 184  * GPIO Connection Type
 185  */
 186 typedef enum {
 187     AML_INTERRUPT_CONNECTION = 0,
 188     AML_IO_CONNECTION = 1,
 189 } AmlGpioConnectionType;
 190
 191 /*
 192  * ACPI 5.0: Table 6-189 GPIO Connection Descriptor Definition
 193  * _PPI field definition
 194  */
 195 typedef enum {
 196     AML_PULL_DEFAULT = 0,
 197     AML_PULL_UP = 1,
 198     AML_PULL_DOWN = 2,
 199     AML_PULL_NONE = 3,
 200 } AmlPinConfig;
 201
 202 typedef
 203 struct AcpiBuildTables {
 204     GArray *table_data;
 205     GArray *rsdp;
 206     GArray *tcpalog;
 207     GArray *linker;
 208 } AcpiBuildTables;
 209
 210 /**
 211  * init_aml_allocator:
 212  *
 213  * Called for initializing API allocator which allow to use
 214  * AML API.
 215  * Returns: toplevel container which accumulates all other
 216  * AML elements for a table.
 217  */
 218 Aml *init_aml_allocator(void);
 219
 220 /**
 221  * free_aml_allocator:
 222  *
 223  * Releases all elements used by AML API, frees associated memory
 224  * and invalidates AML allocator. After this call @init_aml_allocator
 225  * should be called again if AML API is to be used again.
 226  */
 227 void free_aml_allocator(void);
 228
 229 /**
 230  * aml_append:
 231  * @parent_ctx: context to which @child element is added
 232  * @child: element that is copied into @parent_ctx context
 233  *
 234  * Joins Aml elements together and helps to construct AML tables
 235  * Examle of usage:
 236  *   Aml *table = aml_def_block("SSDT", ...);
 237  *   Aml *sb = aml_scope("\\_SB");
 238  *   Aml *dev = aml_device("PCI0");
 239  *
 240  *   aml_append(dev, aml_name_decl("HID", aml_eisaid("PNP0A03")));
 241  *   aml_append(sb, dev);
 242  *   aml_append(table, sb);
 243  */
 244 void aml_append(Aml *parent_ctx, Aml *child);
 245
 246 /* non block AML object primitives */
 247 Aml *aml_name(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 248 Aml *aml_name_decl(const char *name, Aml *val);
 249 Aml *aml_return(Aml *val);
 250 Aml *aml_int(const uint64_t val);
 251 Aml *aml_arg(int pos);
 252 Aml *aml_to_integer(Aml *arg);
 253 Aml *aml_to_hexstring(Aml *src, Aml *dst);
 254 Aml *aml_to_buffer(Aml *src, Aml *dst);
 255 Aml *aml_store(Aml *val, Aml *target);
 256 Aml *aml_and(Aml *arg1, Aml *arg2, Aml *dst);
 257 Aml *aml_or(Aml *arg1, Aml *arg2, Aml *dst);
 258 Aml *aml_lor(Aml *arg1, Aml *arg2);
 259 Aml *aml_shiftleft(Aml *arg1, Aml *count);
 260 Aml *aml_shiftright(Aml *arg1, Aml *count, Aml *dst);
 261 Aml *aml_lless(Aml *arg1, Aml *arg2);
 262 Aml *aml_add(Aml *arg1, Aml *arg2, Aml *dst);
 263 Aml *aml_subtract(Aml *arg1, Aml *arg2, Aml *dst);
 264 Aml *aml_increment(Aml *arg);
 265 Aml *aml_decrement(Aml *arg);
 266 Aml *aml_index(Aml *arg1, Aml *idx);
 267 Aml *aml_notify(Aml *arg1, Aml *arg2);
 268 Aml *aml_call0(const char *method);
 269 Aml *aml_call1(const char *method, Aml *arg1);
 270 Aml *aml_call2(const char *method, Aml *arg1, Aml *arg2);
 271 Aml *aml_call3(const char *method, Aml *arg1, Aml *arg2, Aml *arg3);
 272 Aml *aml_call4(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4);
 273 Aml *aml_gpio_int(AmlConsumerAndProducer con_and_pro,
 274                   AmlLevelAndEdge edge_level,
 275                   AmlActiveHighAndLow active_level, AmlShared shared,
 276                   AmlPinConfig pin_config, uint16_t debounce_timeout,
 277                   const uint32_t pin_list[], uint32_t pin_count,
 278                   const char *resource_source_name,
 279                   const uint8_t *vendor_data, uint16_t vendor_data_len);
 280 Aml *aml_memory32_fixed(uint32_t addr, uint32_t size,
 281                         AmlReadAndWrite read_and_write);
 282 Aml *aml_interrupt(AmlConsumerAndProducer con_and_pro,
 283                    AmlLevelAndEdge level_and_edge,
 284                    AmlActiveHighAndLow high_and_low, AmlShared shared,
 285                    uint32_t *irq_list, uint8_t irq_count);
 286 Aml *aml_io(AmlIODecode dec, uint16_t min_base, uint16_t max_base,
 287             uint8_t aln, uint8_t len);
 288 Aml *aml_operation_region(const char *name, AmlRegionSpace rs,
 289                           uint32_t offset, uint32_t len);
 290 Aml *aml_irq_no_flags(uint8_t irq);
 291 Aml *aml_named_field(const char *name, unsigned length);
 292 Aml *aml_reserved_field(unsigned length);
 293 Aml *aml_local(int num);
 294 Aml *aml_string(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 295 Aml *aml_lnot(Aml *arg);
 296 Aml *aml_equal(Aml *arg1, Aml *arg2);
 297 Aml *aml_lgreater(Aml *arg1, Aml *arg2);
 298 Aml *aml_lgreater_equal(Aml *arg1, Aml *arg2);
 299 Aml *aml_processor(uint8_t proc_id, uint32_t pblk_addr, uint8_t pblk_len,
 300                    const char *name_format, ...) GCC_FMT_ATTR(4, 5);
 301 Aml *aml_eisaid(const char *str);
 302 Aml *aml_word_bus_number(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 303                          AmlDecode dec, uint16_t addr_gran,
 304                          uint16_t addr_min, uint16_t addr_max,
 305                          uint16_t addr_trans, uint16_t len);
 306 Aml *aml_word_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 307                  AmlDecode dec, AmlISARanges isa_ranges,
 308                  uint16_t addr_gran, uint16_t addr_min,
 309                  uint16_t addr_max, uint16_t addr_trans,
 310                  uint16_t len);
 311 Aml *aml_dword_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 312                  AmlDecode dec, AmlISARanges isa_ranges,
 313                  uint32_t addr_gran, uint32_t addr_min,
 314                  uint32_t addr_max, uint32_t addr_trans,
 315                  uint32_t len);
 316 Aml *aml_dword_memory(AmlDecode dec, AmlMinFixed min_fixed,
 317                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
 318                       AmlReadAndWrite read_and_write,
 319                       uint32_t addr_gran, uint32_t addr_min,
 320                       uint32_t addr_max, uint32_t addr_trans,
 321                       uint32_t len);
 322 Aml *aml_qword_memory(AmlDecode dec, AmlMinFixed min_fixed,
 323                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
 324                       AmlReadAndWrite read_and_write,
 325                       uint64_t addr_gran, uint64_t addr_min,
 326                       uint64_t addr_max, uint64_t addr_trans,
 327                       uint64_t len);
 328 Aml *aml_dma(AmlDmaType typ, AmlDmaBusMaster bm, AmlTransferSize sz,
 329              uint8_t channel);
 330 Aml *aml_sleep(uint64_t msec);
 331
 332 /* Block AML object primitives */
 333 Aml *aml_scope(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 334 Aml *aml_device(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 335 Aml *aml_method(const char *name, int arg_count, AmlSerializeFlag sflag);
 336 Aml *aml_if(Aml *predicate);
 337 Aml *aml_else(void);
 338 Aml *aml_while(Aml *predicate);
 339 Aml *aml_package(uint8_t num_elements);
 340 Aml *aml_buffer(int buffer_size, uint8_t *byte_list);
 341 Aml *aml_resource_template(void);
 342 Aml *aml_field(const char *name, AmlAccessType type, AmlLockRule lock,
 343                AmlUpdateRule rule);
 344 Aml *aml_mutex(const char *name, uint8_t sync_level);
 345 Aml *aml_acquire(Aml *mutex, uint16_t timeout);
 346 Aml *aml_release(Aml *mutex);
 347 Aml *aml_alias(const char *source_object, const char *alias_object);
 348 Aml *aml_create_dword_field(Aml *srcbuf, Aml *index, const char *name);
 349 Aml *aml_create_qword_field(Aml *srcbuf, Aml *index, const char *name);
 350 Aml *aml_varpackage(uint32_t num_elements);
 351 Aml *aml_touuid(const char *uuid);
 352 Aml *aml_unicode(const char *str);
 353 Aml *aml_derefof(Aml *arg);
 354 Aml *aml_sizeof(Aml *arg);
 355
 356 void
 357 build_header(GArray *linker, GArray *table_data,
 358              AcpiTableHeader *h, const char *sig, int len, uint8_t rev,
 359              const char *oem_table_id);
 360 void *acpi_data_push(GArray *table_data, unsigned size);
 361 unsigned acpi_data_len(GArray *table);
 362 void acpi_add_table(GArray *table_offsets, GArray *table_data);
 363 void acpi_build_tables_init(AcpiBuildTables *tables);
 364 void acpi_build_tables_cleanup(AcpiBuildTables *tables, bool mfre);
 365 void
 366 build_rsdt(GArray *table_data, GArray *linker, GArray *table_offsets);
 367
 368 #endif