LXR qemu/include/hw/acpi/aml-build.h

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