include/hw/acpi/aml-build.h

   1 #ifndef HW_ACPI_AML_BUILD_H
   2 #define HW_ACPI_AML_BUILD_H
   3
   4 #include "hw/acpi/acpi-defs.h"
   5 #include "hw/acpi/bios-linker-loader.h"
   6
   7 /* Reserve RAM space for tables: add another order of magnitude. */
   8 #define ACPI_BUILD_TABLE_MAX_SIZE         0x200000
   9
  10 #define ACPI_BUILD_APPNAME6 "BOCHS "
  11 #define ACPI_BUILD_APPNAME8 "BXPC    "
  12
  13 #define ACPI_BUILD_TABLE_FILE "etc/acpi/tables"
  14 #define ACPI_BUILD_RSDP_FILE "etc/acpi/rsdp"
  15 #define ACPI_BUILD_TPMLOG_FILE "etc/tpm/log"
  16 #define ACPI_BUILD_LOADER_FILE "etc/table-loader"
  17
  18 #define AML_NOTIFY_METHOD "NTFY"
  19
  20 typedef enum {
  21     AML_NO_OPCODE = 0,/* has only data */
  22     AML_OPCODE,       /* has opcode optionally followed by data */
  23     AML_PACKAGE,      /* has opcode and uses PkgLength for its length */
  24     AML_EXT_PACKAGE,  /* Same as AML_PACKAGE but also has 'ExOpPrefix' */
  25     AML_BUFFER,       /* data encoded as 'DefBuffer' */
  26     AML_RES_TEMPLATE, /* encoded as ResourceTemplate macro */
  27 } AmlBlockFlags;
  28
  29 struct Aml {
  30     GArray *buf;
  31
  32     /*< private >*/
  33     uint8_t op;
  34     AmlBlockFlags block_flags;
  35 };
  36
  37 typedef enum {
  38     AML_COMPATIBILITY = 0,
  39     AML_TYPEA = 1,
  40     AML_TYPEB = 2,
  41     AML_TYPEF = 3,
  42 } AmlDmaType;
  43
  44 typedef enum {
  45     AML_NOTBUSMASTER = 0,
  46     AML_BUSMASTER = 1,
  47 } AmlDmaBusMaster;
  48
  49 typedef enum {
  50     AML_TRANSFER8 = 0,
  51     AML_TRANSFER8_16 = 1,
  52     AML_TRANSFER16 = 2,
  53 } AmlTransferSize;
  54
  55 typedef enum {
  56     AML_DECODE10 = 0,
  57     AML_DECODE16 = 1,
  58 } AmlIODecode;
  59
  60 typedef enum {
  61     AML_ANY_ACC = 0,
  62     AML_BYTE_ACC = 1,
  63     AML_WORD_ACC = 2,
  64     AML_DWORD_ACC = 3,
  65     AML_QWORD_ACC = 4,
  66     AML_BUFFER_ACC = 5,
  67 } AmlAccessType;
  68
  69 typedef enum {
  70     AML_NOLOCK = 0,
  71     AML_LOCK = 1,
  72 } AmlLockRule;
  73
  74 typedef enum {
  75     AML_PRESERVE = 0,
  76     AML_WRITE_AS_ONES = 1,
  77     AML_WRITE_AS_ZEROS = 2,
  78 } AmlUpdateRule;
  79
  80 typedef enum {
  81     AML_AS_SYSTEM_MEMORY = 0X00,
  82     AML_AS_SYSTEM_IO = 0X01,
  83     AML_AS_PCI_CONFIG = 0X02,
  84     AML_AS_EMBEDDED_CTRL = 0X03,
  85     AML_AS_SMBUS = 0X04,
  86     AML_AS_FFH = 0X7F,
  87 } AmlAddressSpace;
  88
  89 typedef enum {
  90     AML_SYSTEM_MEMORY = 0X00,
  91     AML_SYSTEM_IO = 0X01,
  92     AML_PCI_CONFIG = 0X02,
  93 } AmlRegionSpace;
  94
  95 typedef enum {
  96     AML_MEMORY_RANGE = 0,
  97     AML_IO_RANGE = 1,
  98     AML_BUS_NUMBER_RANGE = 2,
  99 } AmlResourceType;
 100
 101 typedef enum {
 102     AML_SUB_DECODE = 1 << 1,
 103     AML_POS_DECODE = 0
 104 } AmlDecode;
 105
 106 typedef enum {
 107     AML_MAX_FIXED = 1 << 3,
 108     AML_MAX_NOT_FIXED = 0,
 109 } AmlMaxFixed;
 110
 111 typedef enum {
 112     AML_MIN_FIXED = 1 << 2,
 113     AML_MIN_NOT_FIXED = 0
 114 } AmlMinFixed;
 115
 116 /*
 117  * ACPI 1.0b: Table 6-26 I/O Resource Flag (Resource Type = 1) Definitions
 118  * _RNG field definition
 119  */
 120 typedef enum {
 121     AML_ISA_ONLY = 1,
 122     AML_NON_ISA_ONLY = 2,
 123     AML_ENTIRE_RANGE = 3,
 124 } AmlISARanges;
 125
 126 /*
 127  * ACPI 1.0b: Table 6-25 Memory Resource Flag (Resource Type = 0) Definitions
 128  * _MEM field definition
 129  */
 130 typedef enum {
 131     AML_NON_CACHEABLE = 0,
 132     AML_CACHEABLE = 1,
 133     AML_WRITE_COMBINING = 2,
 134     AML_PREFETCHABLE = 3,
 135 } AmlCacheable;
 136
 137 /*
 138  * ACPI 1.0b: Table 6-25 Memory Resource Flag (Resource Type = 0) Definitions
 139  * _RW field definition
 140  */
 141 typedef enum {
 142     AML_READ_ONLY = 0,
 143     AML_READ_WRITE = 1,
 144 } AmlReadAndWrite;
 145
 146 /*
 147  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 148  * Interrupt Vector Flags Bits[0] Consumer/Producer
 149  */
 150 typedef enum {
 151     AML_CONSUMER_PRODUCER = 0,
 152     AML_CONSUMER = 1,
 153 } AmlConsumerAndProducer;
 154
 155 /*
 156  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 157  * _HE field definition
 158  */
 159 typedef enum {
 160     AML_LEVEL = 0,
 161     AML_EDGE = 1,
 162 } AmlLevelAndEdge;
 163
 164 /*
 165  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 166  * _LL field definition
 167  */
 168 typedef enum {
 169     AML_ACTIVE_HIGH = 0,
 170     AML_ACTIVE_LOW = 1,
 171 } AmlActiveHighAndLow;
 172
 173 /*
 174  * ACPI 5.0: Table 6-187 Extended Interrupt Descriptor Definition
 175  * _SHR field definition
 176  */
 177 typedef enum {
 178     AML_EXCLUSIVE = 0,
 179     AML_SHARED = 1,
 180     AML_EXCLUSIVE_AND_WAKE = 2,
 181     AML_SHARED_AND_WAKE = 3,
 182 } AmlShared;
 183
 184 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: MethodFlags */
 185 typedef enum {
 186     AML_NOTSERIALIZED = 0,
 187     AML_SERIALIZED = 1,
 188 } AmlSerializeFlag;
 189
 190 /*
 191  * ACPI 5.0: Table 6-189 GPIO Connection Descriptor Definition
 192  * GPIO Connection Type
 193  */
 194 typedef enum {
 195     AML_INTERRUPT_CONNECTION = 0,
 196     AML_IO_CONNECTION = 1,
 197 } AmlGpioConnectionType;
 198
 199 /*
 200  * ACPI 5.0: Table 6-189 GPIO Connection Descriptor Definition
 201  * _PPI field definition
 202  */
 203 typedef enum {
 204     AML_PULL_DEFAULT = 0,
 205     AML_PULL_UP = 1,
 206     AML_PULL_DOWN = 2,
 207     AML_PULL_NONE = 3,
 208 } AmlPinConfig;
 209
 210 typedef enum {
 211     MEM_AFFINITY_NOFLAGS      = 0,
 212     MEM_AFFINITY_ENABLED      = (1 << 0),
 213     MEM_AFFINITY_HOTPLUGGABLE = (1 << 1),
 214     MEM_AFFINITY_NON_VOLATILE = (1 << 2),
 215 } MemoryAffinityFlags;
 216
 217 typedef
 218 struct AcpiBuildTables {
 219     GArray *table_data;
 220     GArray *rsdp;
 221     GArray *tcpalog;
 222     GArray *vmgenid;
 223     GArray *hardware_errors;
 224     BIOSLinker *linker;
 225 } AcpiBuildTables;
 226
 227 typedef
 228 struct CrsRangeEntry {
 229     uint64_t base;
 230     uint64_t limit;
 231 } CrsRangeEntry;
 232
 233 typedef
 234 struct CrsRangeSet {
 235     GPtrArray *io_ranges;
 236     GPtrArray *mem_ranges;
 237     GPtrArray *mem_64bit_ranges;
 238 } CrsRangeSet;
 239
 240
 241 /*
 242  * ACPI 5.0: 6.4.3.8.2 Serial Bus Connection Descriptors
 243  * Serial Bus Type
 244  */
 245 #define AML_SERIAL_BUS_TYPE_I2C  1
 246 #define AML_SERIAL_BUS_TYPE_SPI  2
 247 #define AML_SERIAL_BUS_TYPE_UART 3
 248
 249 /*
 250  * ACPI 5.0: 6.4.3.8.2 Serial Bus Connection Descriptors
 251  * General Flags
 252  */
 253 /* Slave Mode */
 254 #define AML_SERIAL_BUS_FLAG_MASTER_DEVICE       (1 << 0)
 255 /* Consumer/Producer */
 256 #define AML_SERIAL_BUS_FLAG_CONSUME_ONLY        (1 << 1)
 257
 258 /**
 259  * init_aml_allocator:
 260  *
 261  * Called for initializing API allocator which allow to use
 262  * AML API.
 263  * Returns: toplevel container which accumulates all other
 264  * AML elements for a table.
 265  */
 266 Aml *init_aml_allocator(void);
 267
 268 /**
 269  * free_aml_allocator:
 270  *
 271  * Releases all elements used by AML API, frees associated memory
 272  * and invalidates AML allocator. After this call @init_aml_allocator
 273  * should be called again if AML API is to be used again.
 274  */
 275 void free_aml_allocator(void);
 276
 277 /**
 278  * aml_append:
 279  * @parent_ctx: context to which @child element is added
 280  * @child: element that is copied into @parent_ctx context
 281  *
 282  * Joins Aml elements together and helps to construct AML tables
 283  * Examle of usage:
 284  *   Aml *table = aml_def_block("SSDT", ...);
 285  *   Aml *sb = aml_scope("\\_SB");
 286  *   Aml *dev = aml_device("PCI0");
 287  *
 288  *   aml_append(dev, aml_name_decl("HID", aml_eisaid("PNP0A03")));
 289  *   aml_append(sb, dev);
 290  *   aml_append(table, sb);
 291  */
 292 void aml_append(Aml *parent_ctx, Aml *child);
 293
 294 /* non block AML object primitives */
 295 Aml *aml_name(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 296 Aml *aml_name_decl(const char *name, Aml *val);
 297 Aml *aml_debug(void);
 298 Aml *aml_return(Aml *val);
 299 Aml *aml_int(const uint64_t val);
 300 Aml *aml_arg(int pos);
 301 Aml *aml_to_integer(Aml *arg);
 302 Aml *aml_to_hexstring(Aml *src, Aml *dst);
 303 Aml *aml_to_buffer(Aml *src, Aml *dst);
 304 Aml *aml_store(Aml *val, Aml *target);
 305 Aml *aml_and(Aml *arg1, Aml *arg2, Aml *dst);
 306 Aml *aml_or(Aml *arg1, Aml *arg2, Aml *dst);
 307 Aml *aml_land(Aml *arg1, Aml *arg2);
 308 Aml *aml_lor(Aml *arg1, Aml *arg2);
 309 Aml *aml_shiftleft(Aml *arg1, Aml *count);
 310 Aml *aml_shiftright(Aml *arg1, Aml *count, Aml *dst);
 311 Aml *aml_lless(Aml *arg1, Aml *arg2);
 312 Aml *aml_add(Aml *arg1, Aml *arg2, Aml *dst);
 313 Aml *aml_subtract(Aml *arg1, Aml *arg2, Aml *dst);
 314 Aml *aml_increment(Aml *arg);
 315 Aml *aml_decrement(Aml *arg);
 316 Aml *aml_index(Aml *arg1, Aml *idx);
 317 Aml *aml_notify(Aml *arg1, Aml *arg2);
 318 Aml *aml_break(void);
 319 Aml *aml_call0(const char *method);
 320 Aml *aml_call1(const char *method, Aml *arg1);
 321 Aml *aml_call2(const char *method, Aml *arg1, Aml *arg2);
 322 Aml *aml_call3(const char *method, Aml *arg1, Aml *arg2, Aml *arg3);
 323 Aml *aml_call4(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4);
 324 Aml *aml_call5(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4,
 325                Aml *arg5);
 326 Aml *aml_gpio_int(AmlConsumerAndProducer con_and_pro,
 327                   AmlLevelAndEdge edge_level,
 328                   AmlActiveHighAndLow active_level, AmlShared shared,
 329                   AmlPinConfig pin_config, uint16_t debounce_timeout,
 330                   const uint32_t pin_list[], uint32_t pin_count,
 331                   const char *resource_source_name,
 332                   const uint8_t *vendor_data, uint16_t vendor_data_len);
 333 Aml *aml_memory32_fixed(uint32_t addr, uint32_t size,
 334                         AmlReadAndWrite read_and_write);
 335 Aml *aml_interrupt(AmlConsumerAndProducer con_and_pro,
 336                    AmlLevelAndEdge level_and_edge,
 337                    AmlActiveHighAndLow high_and_low, AmlShared shared,
 338                    uint32_t *irq_list, uint8_t irq_count);
 339 Aml *aml_io(AmlIODecode dec, uint16_t min_base, uint16_t max_base,
 340             uint8_t aln, uint8_t len);
 341 Aml *aml_operation_region(const char *name, AmlRegionSpace rs,
 342                           Aml *offset, uint32_t len);
 343 Aml *aml_irq_no_flags(uint8_t irq);
 344 Aml *aml_named_field(const char *name, unsigned length);
 345 Aml *aml_reserved_field(unsigned length);
 346 Aml *aml_local(int num);
 347 Aml *aml_string(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 348 Aml *aml_lnot(Aml *arg);
 349 Aml *aml_equal(Aml *arg1, Aml *arg2);
 350 Aml *aml_lgreater(Aml *arg1, Aml *arg2);
 351 Aml *aml_lgreater_equal(Aml *arg1, Aml *arg2);
 352 Aml *aml_processor(uint8_t proc_id, uint32_t pblk_addr, uint8_t pblk_len,
 353                    const char *name_format, ...) GCC_FMT_ATTR(4, 5);
 354 Aml *aml_eisaid(const char *str);
 355 Aml *aml_word_bus_number(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 356                          AmlDecode dec, uint16_t addr_gran,
 357                          uint16_t addr_min, uint16_t addr_max,
 358                          uint16_t addr_trans, uint16_t len);
 359 Aml *aml_word_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 360                  AmlDecode dec, AmlISARanges isa_ranges,
 361                  uint16_t addr_gran, uint16_t addr_min,
 362                  uint16_t addr_max, uint16_t addr_trans,
 363                  uint16_t len);
 364 Aml *aml_dword_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
 365                  AmlDecode dec, AmlISARanges isa_ranges,
 366                  uint32_t addr_gran, uint32_t addr_min,
 367                  uint32_t addr_max, uint32_t addr_trans,
 368                  uint32_t len);
 369 Aml *aml_dword_memory(AmlDecode dec, AmlMinFixed min_fixed,
 370                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
 371                       AmlReadAndWrite read_and_write,
 372                       uint32_t addr_gran, uint32_t addr_min,
 373                       uint32_t addr_max, uint32_t addr_trans,
 374                       uint32_t len);
 375 Aml *aml_qword_memory(AmlDecode dec, AmlMinFixed min_fixed,
 376                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
 377                       AmlReadAndWrite read_and_write,
 378                       uint64_t addr_gran, uint64_t addr_min,
 379                       uint64_t addr_max, uint64_t addr_trans,
 380                       uint64_t len);
 381 Aml *aml_dma(AmlDmaType typ, AmlDmaBusMaster bm, AmlTransferSize sz,
 382              uint8_t channel);
 383 Aml *aml_sleep(uint64_t msec);
 384 Aml *aml_i2c_serial_bus_device(uint16_t address, const char *resource_source);
 385
 386 /* Block AML object primitives */
 387 Aml *aml_scope(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 388 Aml *aml_device(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
 389 Aml *aml_method(const char *name, int arg_count, AmlSerializeFlag sflag);
 390 Aml *aml_if(Aml *predicate);
 391 Aml *aml_else(void);
 392 Aml *aml_while(Aml *predicate);
 393 Aml *aml_package(uint8_t num_elements);
 394 Aml *aml_buffer(int buffer_size, uint8_t *byte_list);
 395 Aml *aml_resource_template(void);
 396 Aml *aml_field(const char *name, AmlAccessType type, AmlLockRule lock,
 397                AmlUpdateRule rule);
 398 Aml *aml_mutex(const char *name, uint8_t sync_level);
 399 Aml *aml_acquire(Aml *mutex, uint16_t timeout);
 400 Aml *aml_release(Aml *mutex);
 401 Aml *aml_alias(const char *source_object, const char *alias_object);
 402 Aml *aml_create_field(Aml *srcbuf, Aml *bit_index, Aml *num_bits,
 403                       const char *name);
 404 Aml *aml_create_dword_field(Aml *srcbuf, Aml *index, const char *name);
 405 Aml *aml_create_qword_field(Aml *srcbuf, Aml *index, const char *name);
 406 Aml *aml_varpackage(uint32_t num_elements);
 407 Aml *aml_touuid(const char *uuid);
 408 Aml *aml_unicode(const char *str);
 409 Aml *aml_refof(Aml *arg);
 410 Aml *aml_derefof(Aml *arg);
 411 Aml *aml_sizeof(Aml *arg);
 412 Aml *aml_concatenate(Aml *source1, Aml *source2, Aml *target);
 413 Aml *aml_object_type(Aml *object);
 414
 415 void build_append_int_noprefix(GArray *table, uint64_t value, int size);
 416 void
 417 build_header(BIOSLinker *linker, GArray *table_data,
 418              AcpiTableHeader *h, const char *sig, int len, uint8_t rev,
 419              const char *oem_id, const char *oem_table_id);
 420 void *acpi_data_push(GArray *table_data, unsigned size);
 421 unsigned acpi_data_len(GArray *table);
 422 void acpi_add_table(GArray *table_offsets, GArray *table_data);
 423 void acpi_build_tables_init(AcpiBuildTables *tables);
 424 void acpi_build_tables_cleanup(AcpiBuildTables *tables, bool mfre);
 425 void
 426 build_rsdp(GArray *tbl, BIOSLinker *linker, AcpiRsdpData *rsdp_data);
 427 void
 428 build_rsdt(GArray *table_data, BIOSLinker *linker, GArray *table_offsets,
 429            const char *oem_id, const char *oem_table_id);
 430 void
 431 build_xsdt(GArray *table_data, BIOSLinker *linker, GArray *table_offsets,
 432            const char *oem_id, const char *oem_table_id);
 433
 434 int
 435 build_append_named_dword(GArray *array, const char *name_format, ...)
 436 GCC_FMT_ATTR(2, 3);
 437
 438 void build_append_gas(GArray *table, AmlAddressSpace as,
 439                       uint8_t bit_width, uint8_t bit_offset,
 440                       uint8_t access_width, uint64_t address);
 441
 442 static inline void
 443 build_append_gas_from_struct(GArray *table, const struct AcpiGenericAddress *s)
 444 {
 445     build_append_gas(table, s->space_id, s->bit_width, s->bit_offset,
 446                      s->access_width, s->address);
 447 }
 448
 449 void crs_range_insert(GPtrArray *ranges, uint64_t base, uint64_t limit);
 450 void crs_replace_with_free_ranges(GPtrArray *ranges,
 451                                          uint64_t start, uint64_t end);
 452 void crs_range_set_init(CrsRangeSet *range_set);
 453 void crs_range_set_free(CrsRangeSet *range_set);
 454
 455 Aml *build_crs(PCIHostState *host, CrsRangeSet *range_set, uint32_t io_offset,
 456                uint32_t mmio32_offset, uint64_t mmio64_offset,
 457                uint16_t bus_nr_offset);
 458
 459 void build_srat_memory(AcpiSratMemoryAffinity *numamem, uint64_t base,
 460                        uint64_t len, int node, MemoryAffinityFlags flags);
 461
 462 void build_slit(GArray *table_data, BIOSLinker *linker, MachineState *ms,
 463                 const char *oem_id, const char *oem_table_id);
 464
 465 void build_fadt(GArray *tbl, BIOSLinker *linker, const AcpiFadtData *f,
 466                 const char *oem_id, const char *oem_table_id);
 467
 468 void build_tpm2(GArray *table_data, BIOSLinker *linker, GArray *tcpalog,
 469                 const char *oem_id, const char *oem_table_id);
 470 #endif