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 #include "hw/acpi/bios-linker-loader.h" 7 8 /* Reserve RAM space for tables: add another order of magnitude. */ 9 #define ACPI_BUILD_TABLE_MAX_SIZE 0x200000 10 11 #define ACPI_BUILD_APPNAME6 "BOCHS " 12 #define ACPI_BUILD_APPNAME4 "BXPC" 13 14 #define ACPI_BUILD_TABLE_FILE "etc/acpi/tables" 15 #define ACPI_BUILD_RSDP_FILE "etc/acpi/rsdp" 16 #define ACPI_BUILD_TPMLOG_FILE "etc/tpm/log" 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 typedef struct Aml Aml; 37 38 typedef enum { 39 AML_COMPATIBILITY = 0, 40 AML_TYPEA = 1, 41 AML_TYPEB = 2, 42 AML_TYPEF = 3, 43 } AmlDmaType; 44 45 typedef enum { 46 AML_NOTBUSMASTER = 0, 47 AML_BUSMASTER = 1, 48 } AmlDmaBusMaster; 49 50 typedef enum { 51 AML_TRANSFER8 = 0, 52 AML_TRANSFER8_16 = 1, 53 AML_TRANSFER16 = 2, 54 } AmlTransferSize; 55 56 typedef enum { 57 AML_DECODE10 = 0, 58 AML_DECODE16 = 1, 59 } AmlIODecode; 60 61 typedef enum { 62 AML_ANY_ACC = 0, 63 AML_BYTE_ACC = 1, 64 AML_WORD_ACC = 2, 65 AML_DWORD_ACC = 3, 66 AML_QWORD_ACC = 4, 67 AML_BUFFER_ACC = 5, 68 } AmlAccessType; 69 70 typedef enum { 71 AML_NOLOCK = 0, 72 AML_LOCK = 1, 73 } AmlLockRule; 74 75 typedef enum { 76 AML_PRESERVE = 0, 77 AML_WRITE_AS_ONES = 1, 78 AML_WRITE_AS_ZEROS = 2, 79 } AmlUpdateRule; 80 81 typedef enum { 82 AML_SYSTEM_MEMORY = 0X00, 83 AML_SYSTEM_IO = 0X01, 84 AML_PCI_CONFIG = 0X02, 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 enum { 203 MEM_AFFINITY_NOFLAGS = 0, 204 MEM_AFFINITY_ENABLED = (1 << 0), 205 MEM_AFFINITY_HOTPLUGGABLE = (1 << 1), 206 MEM_AFFINITY_NON_VOLATILE = (1 << 2), 207 } MemoryAffinityFlags; 208 209 typedef 210 struct AcpiBuildTables { 211 GArray *table_data; 212 GArray *rsdp; 213 GArray *tcpalog; 214 BIOSLinker *linker; 215 } AcpiBuildTables; 216 217 /** 218 * init_aml_allocator: 219 * 220 * Called for initializing API allocator which allow to use 221 * AML API. 222 * Returns: toplevel container which accumulates all other 223 * AML elements for a table. 224 */ 225 Aml *init_aml_allocator(void); 226 227 /** 228 * free_aml_allocator: 229 * 230 * Releases all elements used by AML API, frees associated memory 231 * and invalidates AML allocator. After this call @init_aml_allocator 232 * should be called again if AML API is to be used again. 233 */ 234 void free_aml_allocator(void); 235 236 /** 237 * aml_append: 238 * @parent_ctx: context to which @child element is added 239 * @child: element that is copied into @parent_ctx context 240 * 241 * Joins Aml elements together and helps to construct AML tables 242 * Examle of usage: 243 * Aml *table = aml_def_block("SSDT", ...); 244 * Aml *sb = aml_scope("\\_SB"); 245 * Aml *dev = aml_device("PCI0"); 246 * 247 * aml_append(dev, aml_name_decl("HID", aml_eisaid("PNP0A03"))); 248 * aml_append(sb, dev); 249 * aml_append(table, sb); 250 */ 251 void aml_append(Aml *parent_ctx, Aml *child); 252 253 /* non block AML object primitives */ 254 Aml *aml_name(const char *name_format, ...) GCC_FMT_ATTR(1, 2); 255 Aml *aml_name_decl(const char *name, Aml *val); 256 Aml *aml_debug(void); 257 Aml *aml_return(Aml *val); 258 Aml *aml_int(const uint64_t val); 259 Aml *aml_arg(int pos); 260 Aml *aml_to_integer(Aml *arg); 261 Aml *aml_to_hexstring(Aml *src, Aml *dst); 262 Aml *aml_to_buffer(Aml *src, Aml *dst); 263 Aml *aml_store(Aml *val, Aml *target); 264 Aml *aml_and(Aml *arg1, Aml *arg2, Aml *dst); 265 Aml *aml_or(Aml *arg1, Aml *arg2, Aml *dst); 266 Aml *aml_lor(Aml *arg1, Aml *arg2); 267 Aml *aml_shiftleft(Aml *arg1, Aml *count); 268 Aml *aml_shiftright(Aml *arg1, Aml *count, Aml *dst); 269 Aml *aml_lless(Aml *arg1, Aml *arg2); 270 Aml *aml_add(Aml *arg1, Aml *arg2, Aml *dst); 271 Aml *aml_subtract(Aml *arg1, Aml *arg2, Aml *dst); 272 Aml *aml_increment(Aml *arg); 273 Aml *aml_decrement(Aml *arg); 274 Aml *aml_index(Aml *arg1, Aml *idx); 275 Aml *aml_notify(Aml *arg1, Aml *arg2); 276 Aml *aml_call0(const char *method); 277 Aml *aml_call1(const char *method, Aml *arg1); 278 Aml *aml_call2(const char *method, Aml *arg1, Aml *arg2); 279 Aml *aml_call3(const char *method, Aml *arg1, Aml *arg2, Aml *arg3); 280 Aml *aml_call4(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4); 281 Aml *aml_gpio_int(AmlConsumerAndProducer con_and_pro, 282 AmlLevelAndEdge edge_level, 283 AmlActiveHighAndLow active_level, AmlShared shared, 284 AmlPinConfig pin_config, uint16_t debounce_timeout, 285 const uint32_t pin_list[], uint32_t pin_count, 286 const char *resource_source_name, 287 const uint8_t *vendor_data, uint16_t vendor_data_len); 288 Aml *aml_memory32_fixed(uint32_t addr, uint32_t size, 289 AmlReadAndWrite read_and_write); 290 Aml *aml_interrupt(AmlConsumerAndProducer con_and_pro, 291 AmlLevelAndEdge level_and_edge, 292 AmlActiveHighAndLow high_and_low, AmlShared shared, 293 uint32_t *irq_list, uint8_t irq_count); 294 Aml *aml_io(AmlIODecode dec, uint16_t min_base, uint16_t max_base, 295 uint8_t aln, uint8_t len); 296 Aml *aml_operation_region(const char *name, AmlRegionSpace rs, 297 Aml *offset, uint32_t len); 298 Aml *aml_irq_no_flags(uint8_t irq); 299 Aml *aml_named_field(const char *name, unsigned length); 300 Aml *aml_reserved_field(unsigned length); 301 Aml *aml_local(int num); 302 Aml *aml_string(const char *name_format, ...) GCC_FMT_ATTR(1, 2); 303 Aml *aml_lnot(Aml *arg); 304 Aml *aml_equal(Aml *arg1, Aml *arg2); 305 Aml *aml_lgreater(Aml *arg1, Aml *arg2); 306 Aml *aml_lgreater_equal(Aml *arg1, Aml *arg2); 307 Aml *aml_processor(uint8_t proc_id, uint32_t pblk_addr, uint8_t pblk_len, 308 const char *name_format, ...) GCC_FMT_ATTR(4, 5); 309 Aml *aml_eisaid(const char *str); 310 Aml *aml_word_bus_number(AmlMinFixed min_fixed, AmlMaxFixed max_fixed, 311 AmlDecode dec, uint16_t addr_gran, 312 uint16_t addr_min, uint16_t addr_max, 313 uint16_t addr_trans, uint16_t len); 314 Aml *aml_word_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed, 315 AmlDecode dec, AmlISARanges isa_ranges, 316 uint16_t addr_gran, uint16_t addr_min, 317 uint16_t addr_max, uint16_t addr_trans, 318 uint16_t len); 319 Aml *aml_dword_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed, 320 AmlDecode dec, AmlISARanges isa_ranges, 321 uint32_t addr_gran, uint32_t addr_min, 322 uint32_t addr_max, uint32_t addr_trans, 323 uint32_t len); 324 Aml *aml_dword_memory(AmlDecode dec, AmlMinFixed min_fixed, 325 AmlMaxFixed max_fixed, AmlCacheable cacheable, 326 AmlReadAndWrite read_and_write, 327 uint32_t addr_gran, uint32_t addr_min, 328 uint32_t addr_max, uint32_t addr_trans, 329 uint32_t len); 330 Aml *aml_qword_memory(AmlDecode dec, AmlMinFixed min_fixed, 331 AmlMaxFixed max_fixed, AmlCacheable cacheable, 332 AmlReadAndWrite read_and_write, 333 uint64_t addr_gran, uint64_t addr_min, 334 uint64_t addr_max, uint64_t addr_trans, 335 uint64_t len); 336 Aml *aml_dma(AmlDmaType typ, AmlDmaBusMaster bm, AmlTransferSize sz, 337 uint8_t channel); 338 Aml *aml_sleep(uint64_t msec); 339 340 /* Block AML object primitives */ 341 Aml *aml_scope(const char *name_format, ...) GCC_FMT_ATTR(1, 2); 342 Aml *aml_device(const char *name_format, ...) GCC_FMT_ATTR(1, 2); 343 Aml *aml_method(const char *name, int arg_count, AmlSerializeFlag sflag); 344 Aml *aml_if(Aml *predicate); 345 Aml *aml_else(void); 346 Aml *aml_while(Aml *predicate); 347 Aml *aml_package(uint8_t num_elements); 348 Aml *aml_buffer(int buffer_size, uint8_t *byte_list); 349 Aml *aml_resource_template(void); 350 Aml *aml_field(const char *name, AmlAccessType type, AmlLockRule lock, 351 AmlUpdateRule rule); 352 Aml *aml_mutex(const char *name, uint8_t sync_level); 353 Aml *aml_acquire(Aml *mutex, uint16_t timeout); 354 Aml *aml_release(Aml *mutex); 355 Aml *aml_alias(const char *source_object, const char *alias_object); 356 Aml *aml_create_field(Aml *srcbuf, Aml *bit_index, Aml *num_bits, 357 const char *name); 358 Aml *aml_create_dword_field(Aml *srcbuf, Aml *index, const char *name); 359 Aml *aml_create_qword_field(Aml *srcbuf, Aml *index, const char *name); 360 Aml *aml_varpackage(uint32_t num_elements); 361 Aml *aml_touuid(const char *uuid); 362 Aml *aml_unicode(const char *str); 363 Aml *aml_refof(Aml *arg); 364 Aml *aml_derefof(Aml *arg); 365 Aml *aml_sizeof(Aml *arg); 366 Aml *aml_concatenate(Aml *source1, Aml *source2, Aml *target); 367 368 void 369 build_header(BIOSLinker *linker, GArray *table_data, 370 AcpiTableHeader *h, const char *sig, int len, uint8_t rev, 371 const char *oem_id, const char *oem_table_id); 372 void *acpi_data_push(GArray *table_data, unsigned size); 373 unsigned acpi_data_len(GArray *table); 374 void acpi_add_table(GArray *table_offsets, GArray *table_data); 375 void acpi_build_tables_init(AcpiBuildTables *tables); 376 void acpi_build_tables_cleanup(AcpiBuildTables *tables, bool mfre); 377 void 378 build_rsdt(GArray *table_data, BIOSLinker *linker, GArray *table_offsets, 379 const char *oem_id, const char *oem_table_id); 380 381 int 382 build_append_named_dword(GArray *array, const char *name_format, ...) 383 GCC_FMT_ATTR(2, 3); 384 385 void build_srat_memory(AcpiSratMemoryAffinity *numamem, uint64_t base, 386 uint64_t len, int node, MemoryAffinityFlags flags); 387 388 #endif 389