1 /* Support for generating ACPI tables and passing them to Guests
3 * Copyright (C) 2015 Red Hat Inc
5 * Author: Michael S. Tsirkin <mst@redhat.com>
6 * Author: Igor Mammedov <imammedo@redhat.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include <glib/gprintf.h>
28 #include "hw/acpi/aml-build.h"
29 #include "qemu/bswap.h"
30 #include "qemu/bitops.h"
31 #include "hw/acpi/bios-linker-loader.h"
33 static GArray
*build_alloc_array(void)
35 return g_array_new(false, true /* clear */, 1);
38 static void build_free_array(GArray
*array
)
40 g_array_free(array
, true);
43 static void build_prepend_byte(GArray
*array
, uint8_t val
)
45 g_array_prepend_val(array
, val
);
48 static void build_append_byte(GArray
*array
, uint8_t val
)
50 g_array_append_val(array
, val
);
53 static void build_append_array(GArray
*array
, GArray
*val
)
55 g_array_append_vals(array
, val
->data
, val
->len
);
58 #define ACPI_NAMESEG_LEN 4
61 build_append_nameseg(GArray
*array
, const char *seg
)
66 assert(len
<= ACPI_NAMESEG_LEN
);
68 g_array_append_vals(array
, seg
, len
);
69 /* Pad up to ACPI_NAMESEG_LEN characters if necessary. */
70 g_array_append_vals(array
, "____", ACPI_NAMESEG_LEN
- len
);
73 static void GCC_FMT_ATTR(2, 0)
74 build_append_namestringv(GArray
*array
, const char *format
, va_list ap
)
81 s
= g_strdup_vprintf(format
, ap
);
82 segs
= g_strsplit(s
, ".", 0);
92 * ACPI 5.0 spec: 20.2.2 Name Objects Encoding:
93 * "SegCount can be from 1 to 255"
95 assert(seg_count
> 0 && seg_count
<= 255);
97 /* handle RootPath || PrefixPath */
99 while (*s
== '\\' || *s
== '^') {
100 build_append_byte(array
, *s
);
107 build_append_byte(array
, 0x00); /* NullName */
109 build_append_nameseg(array
, s
);
114 build_append_byte(array
, 0x2E); /* DualNamePrefix */
115 build_append_nameseg(array
, s
);
116 build_append_nameseg(array
, segs
[1]);
119 build_append_byte(array
, 0x2F); /* MultiNamePrefix */
120 build_append_byte(array
, seg_count
);
122 /* handle the 1st segment manually due to prefix/root path */
123 build_append_nameseg(array
, s
);
125 /* add the rest of segments */
126 segs_iter
= segs
+ 1;
128 build_append_nameseg(array
, *segs_iter
);
137 static void build_append_namestring(GArray
*array
, const char *format
, ...)
141 va_start(ap
, format
);
142 build_append_namestringv(array
, format
, ap
);
146 /* 5.4 Definition Block Encoding */
148 PACKAGE_LENGTH_1BYTE_SHIFT
= 6, /* Up to 63 - use extra 2 bits. */
149 PACKAGE_LENGTH_2BYTE_SHIFT
= 4,
150 PACKAGE_LENGTH_3BYTE_SHIFT
= 12,
151 PACKAGE_LENGTH_4BYTE_SHIFT
= 20,
155 build_prepend_package_length(GArray
*package
, unsigned length
, bool incl_self
)
158 unsigned length_bytes
;
160 if (length
+ 1 < (1 << PACKAGE_LENGTH_1BYTE_SHIFT
)) {
162 } else if (length
+ 2 < (1 << PACKAGE_LENGTH_3BYTE_SHIFT
)) {
164 } else if (length
+ 3 < (1 << PACKAGE_LENGTH_4BYTE_SHIFT
)) {
171 * NamedField uses PkgLength encoding but it doesn't include length
172 * of PkgLength itself.
176 * PkgLength is the length of the inclusive length of the data
177 * and PkgLength's length itself when used for terms with
180 length
+= length_bytes
;
183 switch (length_bytes
) {
186 build_prepend_byte(package
, byte
);
189 byte
= length
>> PACKAGE_LENGTH_4BYTE_SHIFT
;
190 build_prepend_byte(package
, byte
);
191 length
&= (1 << PACKAGE_LENGTH_4BYTE_SHIFT
) - 1;
194 byte
= length
>> PACKAGE_LENGTH_3BYTE_SHIFT
;
195 build_prepend_byte(package
, byte
);
196 length
&= (1 << PACKAGE_LENGTH_3BYTE_SHIFT
) - 1;
199 byte
= length
>> PACKAGE_LENGTH_2BYTE_SHIFT
;
200 build_prepend_byte(package
, byte
);
201 length
&= (1 << PACKAGE_LENGTH_2BYTE_SHIFT
) - 1;
205 * Most significant two bits of byte zero indicate how many following bytes
206 * are in PkgLength encoding.
208 byte
= ((length_bytes
- 1) << PACKAGE_LENGTH_1BYTE_SHIFT
) | length
;
209 build_prepend_byte(package
, byte
);
213 build_append_pkg_length(GArray
*array
, unsigned length
, bool incl_self
)
215 GArray
*tmp
= build_alloc_array();
217 build_prepend_package_length(tmp
, length
, incl_self
);
218 build_append_array(array
, tmp
);
219 build_free_array(tmp
);
222 static void build_package(GArray
*package
, uint8_t op
)
224 build_prepend_package_length(package
, package
->len
, true);
225 build_prepend_byte(package
, op
);
228 static void build_extop_package(GArray
*package
, uint8_t op
)
230 build_package(package
, op
);
231 build_prepend_byte(package
, 0x5B); /* ExtOpPrefix */
234 static void build_append_int_noprefix(GArray
*table
, uint64_t value
, int size
)
238 for (i
= 0; i
< size
; ++i
) {
239 build_append_byte(table
, value
& 0xFF);
244 static void build_append_int(GArray
*table
, uint64_t value
)
247 build_append_byte(table
, 0x00); /* ZeroOp */
248 } else if (value
== 0x01) {
249 build_append_byte(table
, 0x01); /* OneOp */
250 } else if (value
<= 0xFF) {
251 build_append_byte(table
, 0x0A); /* BytePrefix */
252 build_append_int_noprefix(table
, value
, 1);
253 } else if (value
<= 0xFFFF) {
254 build_append_byte(table
, 0x0B); /* WordPrefix */
255 build_append_int_noprefix(table
, value
, 2);
256 } else if (value
<= 0xFFFFFFFF) {
257 build_append_byte(table
, 0x0C); /* DWordPrefix */
258 build_append_int_noprefix(table
, value
, 4);
260 build_append_byte(table
, 0x0E); /* QWordPrefix */
261 build_append_int_noprefix(table
, value
, 8);
265 static GPtrArray
*alloc_list
;
267 static Aml
*aml_alloc(void)
269 Aml
*var
= g_new0(typeof(*var
), 1);
271 g_ptr_array_add(alloc_list
, var
);
272 var
->block_flags
= AML_NO_OPCODE
;
273 var
->buf
= build_alloc_array();
277 static Aml
*aml_opcode(uint8_t op
)
279 Aml
*var
= aml_alloc();
282 var
->block_flags
= AML_OPCODE
;
286 static Aml
*aml_bundle(uint8_t op
, AmlBlockFlags flags
)
288 Aml
*var
= aml_alloc();
291 var
->block_flags
= flags
;
295 static void aml_free(gpointer data
, gpointer user_data
)
298 build_free_array(var
->buf
);
301 Aml
*init_aml_allocator(void)
306 alloc_list
= g_ptr_array_new();
311 void free_aml_allocator(void)
313 g_ptr_array_foreach(alloc_list
, aml_free
, NULL
);
314 g_ptr_array_free(alloc_list
, true);
318 /* pack data with DefBuffer encoding */
319 static void build_buffer(GArray
*array
, uint8_t op
)
321 GArray
*data
= build_alloc_array();
323 build_append_int(data
, array
->len
);
324 g_array_prepend_vals(array
, data
->data
, data
->len
);
325 build_free_array(data
);
326 build_package(array
, op
);
329 void aml_append(Aml
*parent_ctx
, Aml
*child
)
331 GArray
*buf
= build_alloc_array();
332 build_append_array(buf
, child
->buf
);
334 switch (child
->block_flags
) {
336 build_append_byte(parent_ctx
->buf
, child
->op
);
338 case AML_EXT_PACKAGE
:
339 build_extop_package(buf
, child
->op
);
342 build_package(buf
, child
->op
);
344 case AML_RES_TEMPLATE
:
345 build_append_byte(buf
, 0x79); /* EndTag */
347 * checksum operations are treated as succeeded if checksum
348 * field is zero. [ACPI Spec 1.0b, 6.4.2.8 End Tag]
350 build_append_byte(buf
, 0);
351 /* fall through, to pack resources in buffer */
353 build_buffer(buf
, child
->op
);
361 build_append_array(parent_ctx
->buf
, buf
);
362 build_free_array(buf
);
365 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefScope */
366 Aml
*aml_scope(const char *name_format
, ...)
369 Aml
*var
= aml_bundle(0x10 /* ScopeOp */, AML_PACKAGE
);
370 va_start(ap
, name_format
);
371 build_append_namestringv(var
->buf
, name_format
, ap
);
376 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefReturn */
377 Aml
*aml_return(Aml
*val
)
379 Aml
*var
= aml_opcode(0xA4 /* ReturnOp */);
380 aml_append(var
, val
);
385 * ACPI 1.0b: 16.2.3 Data Objects Encoding:
386 * encodes: ByteConst, WordConst, DWordConst, QWordConst, ZeroOp, OneOp
388 Aml
*aml_int(const uint64_t val
)
390 Aml
*var
= aml_alloc();
391 build_append_int(var
->buf
, val
);
396 * helper to construct NameString, which returns Aml object
397 * for using with aml_append or other aml_* terms
399 Aml
*aml_name(const char *name_format
, ...)
402 Aml
*var
= aml_alloc();
403 va_start(ap
, name_format
);
404 build_append_namestringv(var
->buf
, name_format
, ap
);
409 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefName */
410 Aml
*aml_name_decl(const char *name
, Aml
*val
)
412 Aml
*var
= aml_opcode(0x08 /* NameOp */);
413 build_append_namestring(var
->buf
, "%s", name
);
414 aml_append(var
, val
);
418 /* ACPI 1.0b: 16.2.6.1 Arg Objects Encoding */
419 Aml
*aml_arg(int pos
)
422 uint8_t op
= 0x68 /* ARG0 op */ + pos
;
425 var
= aml_opcode(op
);
429 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefStore */
430 Aml
*aml_store(Aml
*val
, Aml
*target
)
432 Aml
*var
= aml_opcode(0x70 /* StoreOp */);
433 aml_append(var
, val
);
434 aml_append(var
, target
);
438 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAnd */
439 Aml
*aml_and(Aml
*arg1
, Aml
*arg2
)
441 Aml
*var
= aml_opcode(0x7B /* AndOp */);
442 aml_append(var
, arg1
);
443 aml_append(var
, arg2
);
444 build_append_byte(var
->buf
, 0x00 /* NullNameOp */);
448 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefOr */
449 Aml
*aml_or(Aml
*arg1
, Aml
*arg2
)
451 Aml
*var
= aml_opcode(0x7D /* OrOp */);
452 aml_append(var
, arg1
);
453 aml_append(var
, arg2
);
454 build_append_byte(var
->buf
, 0x00 /* NullNameOp */);
458 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefShiftLeft */
459 Aml
*aml_shiftleft(Aml
*arg1
, Aml
*count
)
461 Aml
*var
= aml_opcode(0x79 /* ShiftLeftOp */);
462 aml_append(var
, arg1
);
463 aml_append(var
, count
);
464 build_append_byte(var
->buf
, 0x00); /* NullNameOp */
468 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLLess */
469 Aml
*aml_lless(Aml
*arg1
, Aml
*arg2
)
471 Aml
*var
= aml_opcode(0x95 /* LLessOp */);
472 aml_append(var
, arg1
);
473 aml_append(var
, arg2
);
477 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAdd */
478 Aml
*aml_add(Aml
*arg1
, Aml
*arg2
)
480 Aml
*var
= aml_opcode(0x72 /* AddOp */);
481 aml_append(var
, arg1
);
482 aml_append(var
, arg2
);
483 build_append_byte(var
->buf
, 0x00 /* NullNameOp */);
487 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefIndex */
488 Aml
*aml_index(Aml
*arg1
, Aml
*idx
)
490 Aml
*var
= aml_opcode(0x88 /* IndexOp */);
491 aml_append(var
, arg1
);
492 aml_append(var
, idx
);
493 build_append_byte(var
->buf
, 0x00 /* NullNameOp */);
497 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefNotify */
498 Aml
*aml_notify(Aml
*arg1
, Aml
*arg2
)
500 Aml
*var
= aml_opcode(0x86 /* NotifyOp */);
501 aml_append(var
, arg1
);
502 aml_append(var
, arg2
);
506 /* helper to call method with 1 argument */
507 Aml
*aml_call1(const char *method
, Aml
*arg1
)
509 Aml
*var
= aml_alloc();
510 build_append_namestring(var
->buf
, "%s", method
);
511 aml_append(var
, arg1
);
515 /* helper to call method with 2 arguments */
516 Aml
*aml_call2(const char *method
, Aml
*arg1
, Aml
*arg2
)
518 Aml
*var
= aml_alloc();
519 build_append_namestring(var
->buf
, "%s", method
);
520 aml_append(var
, arg1
);
521 aml_append(var
, arg2
);
525 /* helper to call method with 3 arguments */
526 Aml
*aml_call3(const char *method
, Aml
*arg1
, Aml
*arg2
, Aml
*arg3
)
528 Aml
*var
= aml_alloc();
529 build_append_namestring(var
->buf
, "%s", method
);
530 aml_append(var
, arg1
);
531 aml_append(var
, arg2
);
532 aml_append(var
, arg3
);
536 /* helper to call method with 4 arguments */
537 Aml
*aml_call4(const char *method
, Aml
*arg1
, Aml
*arg2
, Aml
*arg3
, Aml
*arg4
)
539 Aml
*var
= aml_alloc();
540 build_append_namestring(var
->buf
, "%s", method
);
541 aml_append(var
, arg1
);
542 aml_append(var
, arg2
);
543 aml_append(var
, arg3
);
544 aml_append(var
, arg4
);
549 * ACPI 1.0b: 6.4.3.4 32-Bit Fixed Location Memory Range Descriptor
550 * (Type 1, Large Item Name 0x6)
552 Aml
*aml_memory32_fixed(uint32_t addr
, uint32_t size
,
553 AmlReadAndWrite read_and_write
)
555 Aml
*var
= aml_alloc();
556 build_append_byte(var
->buf
, 0x86); /* Memory32Fixed Resource Descriptor */
557 build_append_byte(var
->buf
, 9); /* Length, bits[7:0] value = 9 */
558 build_append_byte(var
->buf
, 0); /* Length, bits[15:8] value = 0 */
559 build_append_byte(var
->buf
, read_and_write
); /* Write status, 1 rw 0 ro */
561 /* Range base address */
562 build_append_byte(var
->buf
, extract32(addr
, 0, 8)); /* bits[7:0] */
563 build_append_byte(var
->buf
, extract32(addr
, 8, 8)); /* bits[15:8] */
564 build_append_byte(var
->buf
, extract32(addr
, 16, 8)); /* bits[23:16] */
565 build_append_byte(var
->buf
, extract32(addr
, 24, 8)); /* bits[31:24] */
568 build_append_byte(var
->buf
, extract32(size
, 0, 8)); /* bits[7:0] */
569 build_append_byte(var
->buf
, extract32(size
, 8, 8)); /* bits[15:8] */
570 build_append_byte(var
->buf
, extract32(size
, 16, 8)); /* bits[23:16] */
571 build_append_byte(var
->buf
, extract32(size
, 24, 8)); /* bits[31:24] */
576 * ACPI 5.0: 6.4.3.6 Extended Interrupt Descriptor
577 * Type 1, Large Item Name 0x9
579 Aml
*aml_interrupt(AmlConsumerAndProducer con_and_pro
,
580 AmlLevelAndEdge level_and_edge
,
581 AmlActiveHighAndLow high_and_low
, AmlShared shared
,
584 Aml
*var
= aml_alloc();
585 uint8_t irq_flags
= con_and_pro
| (level_and_edge
<< 1)
586 | (high_and_low
<< 2) | (shared
<< 3);
588 build_append_byte(var
->buf
, 0x89); /* Extended irq descriptor */
589 build_append_byte(var
->buf
, 6); /* Length, bits[7:0] minimum value = 6 */
590 build_append_byte(var
->buf
, 0); /* Length, bits[15:8] minimum value = 0 */
591 build_append_byte(var
->buf
, irq_flags
); /* Interrupt Vector Information. */
592 build_append_byte(var
->buf
, 0x01); /* Interrupt table length = 1 */
594 /* Interrupt Number */
595 build_append_byte(var
->buf
, extract32(irq
, 0, 8)); /* bits[7:0] */
596 build_append_byte(var
->buf
, extract32(irq
, 8, 8)); /* bits[15:8] */
597 build_append_byte(var
->buf
, extract32(irq
, 16, 8)); /* bits[23:16] */
598 build_append_byte(var
->buf
, extract32(irq
, 24, 8)); /* bits[31:24] */
602 /* ACPI 1.0b: 6.4.2.5 I/O Port Descriptor */
603 Aml
*aml_io(AmlIODecode dec
, uint16_t min_base
, uint16_t max_base
,
604 uint8_t aln
, uint8_t len
)
606 Aml
*var
= aml_alloc();
607 build_append_byte(var
->buf
, 0x47); /* IO port descriptor */
608 build_append_byte(var
->buf
, dec
);
609 build_append_byte(var
->buf
, min_base
& 0xff);
610 build_append_byte(var
->buf
, (min_base
>> 8) & 0xff);
611 build_append_byte(var
->buf
, max_base
& 0xff);
612 build_append_byte(var
->buf
, (max_base
>> 8) & 0xff);
613 build_append_byte(var
->buf
, aln
);
614 build_append_byte(var
->buf
, len
);
619 * ACPI 1.0b: 6.4.2.1.1 ASL Macro for IRQ Descriptor
621 * More verbose description at:
622 * ACPI 5.0: 19.5.64 IRQNoFlags (Interrupt Resource Descriptor Macro)
623 * 6.4.2.1 IRQ Descriptor
625 Aml
*aml_irq_no_flags(uint8_t irq
)
628 Aml
*var
= aml_alloc();
631 build_append_byte(var
->buf
, 0x22); /* IRQ descriptor 2 byte form */
633 irq_mask
= 1U << irq
;
634 build_append_byte(var
->buf
, irq_mask
& 0xFF); /* IRQ mask bits[7:0] */
635 build_append_byte(var
->buf
, irq_mask
>> 8); /* IRQ mask bits[15:8] */
639 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLNot */
640 Aml
*aml_lnot(Aml
*arg
)
642 Aml
*var
= aml_opcode(0x92 /* LNotOp */);
643 aml_append(var
, arg
);
647 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLEqual */
648 Aml
*aml_equal(Aml
*arg1
, Aml
*arg2
)
650 Aml
*var
= aml_opcode(0x93 /* LequalOp */);
651 aml_append(var
, arg1
);
652 aml_append(var
, arg2
);
656 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefIfElse */
657 Aml
*aml_if(Aml
*predicate
)
659 Aml
*var
= aml_bundle(0xA0 /* IfOp */, AML_PACKAGE
);
660 aml_append(var
, predicate
);
664 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefElse */
667 Aml
*var
= aml_bundle(0xA1 /* ElseOp */, AML_PACKAGE
);
671 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefMethod */
672 Aml
*aml_method(const char *name
, int arg_count
)
674 Aml
*var
= aml_bundle(0x14 /* MethodOp */, AML_PACKAGE
);
675 build_append_namestring(var
->buf
, "%s", name
);
676 build_append_byte(var
->buf
, arg_count
); /* MethodFlags: ArgCount */
680 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefDevice */
681 Aml
*aml_device(const char *name_format
, ...)
684 Aml
*var
= aml_bundle(0x82 /* DeviceOp */, AML_EXT_PACKAGE
);
685 va_start(ap
, name_format
);
686 build_append_namestringv(var
->buf
, name_format
, ap
);
691 /* ACPI 1.0b: 6.4.1 ASL Macros for Resource Descriptors */
692 Aml
*aml_resource_template(void)
694 /* ResourceTemplate is a buffer of Resources with EndTag at the end */
695 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_RES_TEMPLATE
);
699 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefBuffer
700 * Pass byte_list as NULL to request uninitialized buffer to reserve space.
702 Aml
*aml_buffer(int buffer_size
, uint8_t *byte_list
)
705 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_BUFFER
);
707 for (i
= 0; i
< buffer_size
; i
++) {
708 if (byte_list
== NULL
) {
709 build_append_byte(var
->buf
, 0x0);
711 build_append_byte(var
->buf
, byte_list
[i
]);
718 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefPackage */
719 Aml
*aml_package(uint8_t num_elements
)
721 Aml
*var
= aml_bundle(0x12 /* PackageOp */, AML_PACKAGE
);
722 build_append_byte(var
->buf
, num_elements
);
726 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefOpRegion */
727 Aml
*aml_operation_region(const char *name
, AmlRegionSpace rs
,
728 uint32_t offset
, uint32_t len
)
730 Aml
*var
= aml_alloc();
731 build_append_byte(var
->buf
, 0x5B); /* ExtOpPrefix */
732 build_append_byte(var
->buf
, 0x80); /* OpRegionOp */
733 build_append_namestring(var
->buf
, "%s", name
);
734 build_append_byte(var
->buf
, rs
);
735 build_append_int(var
->buf
, offset
);
736 build_append_int(var
->buf
, len
);
740 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: NamedField */
741 Aml
*aml_named_field(const char *name
, unsigned length
)
743 Aml
*var
= aml_alloc();
744 build_append_nameseg(var
->buf
, name
);
745 build_append_pkg_length(var
->buf
, length
, false);
749 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: ReservedField */
750 Aml
*aml_reserved_field(unsigned length
)
752 Aml
*var
= aml_alloc();
753 /* ReservedField := 0x00 PkgLength */
754 build_append_byte(var
->buf
, 0x00);
755 build_append_pkg_length(var
->buf
, length
, false);
759 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefField */
760 Aml
*aml_field(const char *name
, AmlAccessType type
, AmlUpdateRule rule
)
762 Aml
*var
= aml_bundle(0x81 /* FieldOp */, AML_EXT_PACKAGE
);
763 uint8_t flags
= rule
<< 5 | type
;
765 build_append_namestring(var
->buf
, "%s", name
);
766 build_append_byte(var
->buf
, flags
);
770 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefCreateDWordField */
771 Aml
*aml_create_dword_field(Aml
*srcbuf
, Aml
*index
, const char *name
)
773 Aml
*var
= aml_alloc();
774 build_append_byte(var
->buf
, 0x8A); /* CreateDWordFieldOp */
775 aml_append(var
, srcbuf
);
776 aml_append(var
, index
);
777 build_append_namestring(var
->buf
, "%s", name
);
781 /* ACPI 1.0b: 16.2.3 Data Objects Encoding: String */
782 Aml
*aml_string(const char *name_format
, ...)
784 Aml
*var
= aml_opcode(0x0D /* StringPrefix */);
789 va_start(ap
, name_format
);
790 len
= g_vasprintf(&s
, name_format
, ap
);
793 g_array_append_vals(var
->buf
, s
, len
+ 1);
799 /* ACPI 1.0b: 16.2.6.2 Local Objects Encoding */
800 Aml
*aml_local(int num
)
803 uint8_t op
= 0x60 /* Local0Op */ + num
;
806 var
= aml_opcode(op
);
810 /* ACPI 2.0a: 17.2.2 Data Objects Encoding: DefVarPackage */
811 Aml
*aml_varpackage(uint32_t num_elements
)
813 Aml
*var
= aml_bundle(0x13 /* VarPackageOp */, AML_PACKAGE
);
814 build_append_int(var
->buf
, num_elements
);
818 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefProcessor */
819 Aml
*aml_processor(uint8_t proc_id
, uint32_t pblk_addr
, uint8_t pblk_len
,
820 const char *name_format
, ...)
823 Aml
*var
= aml_bundle(0x83 /* ProcessorOp */, AML_EXT_PACKAGE
);
824 va_start(ap
, name_format
);
825 build_append_namestringv(var
->buf
, name_format
, ap
);
827 build_append_byte(var
->buf
, proc_id
); /* ProcID */
828 build_append_int_noprefix(var
->buf
, pblk_addr
, sizeof(pblk_addr
));
829 build_append_byte(var
->buf
, pblk_len
); /* PblkLen */
833 static uint8_t Hex2Digit(char c
)
842 /* ACPI 1.0b: 15.2.3.6.4.1 EISAID Macro - Convert EISA ID String To Integer */
843 Aml
*aml_eisaid(const char *str
)
845 Aml
*var
= aml_alloc();
848 g_assert(strlen(str
) == 7);
849 id
= (str
[0] - 0x40) << 26 |
850 (str
[1] - 0x40) << 21 |
851 (str
[2] - 0x40) << 16 |
852 Hex2Digit(str
[3]) << 12 |
853 Hex2Digit(str
[4]) << 8 |
854 Hex2Digit(str
[5]) << 4 |
857 build_append_byte(var
->buf
, 0x0C); /* DWordPrefix */
858 build_append_int_noprefix(var
->buf
, bswap32(id
), sizeof(id
));
862 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor: bytes 3-5 */
863 static Aml
*aml_as_desc_header(AmlResourceType type
, AmlMinFixed min_fixed
,
864 AmlMaxFixed max_fixed
, AmlDecode dec
,
867 uint8_t flags
= max_fixed
| min_fixed
| dec
;
868 Aml
*var
= aml_alloc();
870 build_append_byte(var
->buf
, type
);
871 build_append_byte(var
->buf
, flags
);
872 build_append_byte(var
->buf
, type_flags
); /* Type Specific Flags */
876 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor */
877 static Aml
*aml_word_as_desc(AmlResourceType type
, AmlMinFixed min_fixed
,
878 AmlMaxFixed max_fixed
, AmlDecode dec
,
879 uint16_t addr_gran
, uint16_t addr_min
,
880 uint16_t addr_max
, uint16_t addr_trans
,
881 uint16_t len
, uint8_t type_flags
)
883 Aml
*var
= aml_alloc();
885 build_append_byte(var
->buf
, 0x88); /* Word Address Space Descriptor */
886 /* minimum length since we do not encode optional fields */
887 build_append_byte(var
->buf
, 0x0D);
888 build_append_byte(var
->buf
, 0x0);
891 aml_as_desc_header(type
, min_fixed
, max_fixed
, dec
, type_flags
));
892 build_append_int_noprefix(var
->buf
, addr_gran
, sizeof(addr_gran
));
893 build_append_int_noprefix(var
->buf
, addr_min
, sizeof(addr_min
));
894 build_append_int_noprefix(var
->buf
, addr_max
, sizeof(addr_max
));
895 build_append_int_noprefix(var
->buf
, addr_trans
, sizeof(addr_trans
));
896 build_append_int_noprefix(var
->buf
, len
, sizeof(len
));
900 /* ACPI 1.0b: 6.4.3.5.3 DWord Address Space Descriptor */
901 static Aml
*aml_dword_as_desc(AmlResourceType type
, AmlMinFixed min_fixed
,
902 AmlMaxFixed max_fixed
, AmlDecode dec
,
903 uint32_t addr_gran
, uint32_t addr_min
,
904 uint32_t addr_max
, uint32_t addr_trans
,
905 uint32_t len
, uint8_t type_flags
)
907 Aml
*var
= aml_alloc();
909 build_append_byte(var
->buf
, 0x87); /* DWord Address Space Descriptor */
910 /* minimum length since we do not encode optional fields */
911 build_append_byte(var
->buf
, 23);
912 build_append_byte(var
->buf
, 0x0);
916 aml_as_desc_header(type
, min_fixed
, max_fixed
, dec
, type_flags
));
917 build_append_int_noprefix(var
->buf
, addr_gran
, sizeof(addr_gran
));
918 build_append_int_noprefix(var
->buf
, addr_min
, sizeof(addr_min
));
919 build_append_int_noprefix(var
->buf
, addr_max
, sizeof(addr_max
));
920 build_append_int_noprefix(var
->buf
, addr_trans
, sizeof(addr_trans
));
921 build_append_int_noprefix(var
->buf
, len
, sizeof(len
));
925 /* ACPI 1.0b: 6.4.3.5.1 QWord Address Space Descriptor */
926 static Aml
*aml_qword_as_desc(AmlResourceType type
, AmlMinFixed min_fixed
,
927 AmlMaxFixed max_fixed
, AmlDecode dec
,
928 uint64_t addr_gran
, uint64_t addr_min
,
929 uint64_t addr_max
, uint64_t addr_trans
,
930 uint64_t len
, uint8_t type_flags
)
932 Aml
*var
= aml_alloc();
934 build_append_byte(var
->buf
, 0x8A); /* QWord Address Space Descriptor */
935 /* minimum length since we do not encode optional fields */
936 build_append_byte(var
->buf
, 0x2B);
937 build_append_byte(var
->buf
, 0x0);
940 aml_as_desc_header(type
, min_fixed
, max_fixed
, dec
, type_flags
));
941 build_append_int_noprefix(var
->buf
, addr_gran
, sizeof(addr_gran
));
942 build_append_int_noprefix(var
->buf
, addr_min
, sizeof(addr_min
));
943 build_append_int_noprefix(var
->buf
, addr_max
, sizeof(addr_max
));
944 build_append_int_noprefix(var
->buf
, addr_trans
, sizeof(addr_trans
));
945 build_append_int_noprefix(var
->buf
, len
, sizeof(len
));
950 * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
952 * More verbose description at:
953 * ACPI 5.0: 19.5.141 WordBusNumber (Word Bus Number Resource Descriptor Macro)
955 Aml
*aml_word_bus_number(AmlMinFixed min_fixed
, AmlMaxFixed max_fixed
,
956 AmlDecode dec
, uint16_t addr_gran
,
957 uint16_t addr_min
, uint16_t addr_max
,
958 uint16_t addr_trans
, uint16_t len
)
961 return aml_word_as_desc(AML_BUS_NUMBER_RANGE
, min_fixed
, max_fixed
, dec
,
962 addr_gran
, addr_min
, addr_max
, addr_trans
, len
, 0);
966 * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
968 * More verbose description at:
969 * ACPI 5.0: 19.5.142 WordIO (Word IO Resource Descriptor Macro)
971 Aml
*aml_word_io(AmlMinFixed min_fixed
, AmlMaxFixed max_fixed
,
972 AmlDecode dec
, AmlISARanges isa_ranges
,
973 uint16_t addr_gran
, uint16_t addr_min
,
974 uint16_t addr_max
, uint16_t addr_trans
,
978 return aml_word_as_desc(AML_IO_RANGE
, min_fixed
, max_fixed
, dec
,
979 addr_gran
, addr_min
, addr_max
, addr_trans
, len
,
984 * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Descriptor
986 * More verbose description at:
987 * ACPI 5.0: 19.5.33 DWordIO (DWord IO Resource Descriptor Macro)
989 Aml
*aml_dword_io(AmlMinFixed min_fixed
, AmlMaxFixed max_fixed
,
990 AmlDecode dec
, AmlISARanges isa_ranges
,
991 uint32_t addr_gran
, uint32_t addr_min
,
992 uint32_t addr_max
, uint32_t addr_trans
,
996 return aml_dword_as_desc(AML_IO_RANGE
, min_fixed
, max_fixed
, dec
,
997 addr_gran
, addr_min
, addr_max
, addr_trans
, len
,
1002 * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Space Descriptor
1004 * More verbose description at:
1005 * ACPI 5.0: 19.5.34 DWordMemory (DWord Memory Resource Descriptor Macro)
1007 Aml
*aml_dword_memory(AmlDecode dec
, AmlMinFixed min_fixed
,
1008 AmlMaxFixed max_fixed
, AmlCacheable cacheable
,
1009 AmlReadAndWrite read_and_write
,
1010 uint32_t addr_gran
, uint32_t addr_min
,
1011 uint32_t addr_max
, uint32_t addr_trans
,
1014 uint8_t flags
= read_and_write
| (cacheable
<< 1);
1016 return aml_dword_as_desc(AML_MEMORY_RANGE
, min_fixed
, max_fixed
,
1017 dec
, addr_gran
, addr_min
, addr_max
,
1018 addr_trans
, len
, flags
);
1022 * ACPI 1.0b: 6.4.3.5.2 ASL Macros for QWORD Address Space Descriptor
1024 * More verbose description at:
1025 * ACPI 5.0: 19.5.102 QWordMemory (QWord Memory Resource Descriptor Macro)
1027 Aml
*aml_qword_memory(AmlDecode dec
, AmlMinFixed min_fixed
,
1028 AmlMaxFixed max_fixed
, AmlCacheable cacheable
,
1029 AmlReadAndWrite read_and_write
,
1030 uint64_t addr_gran
, uint64_t addr_min
,
1031 uint64_t addr_max
, uint64_t addr_trans
,
1034 uint8_t flags
= read_and_write
| (cacheable
<< 1);
1036 return aml_qword_as_desc(AML_MEMORY_RANGE
, min_fixed
, max_fixed
,
1037 dec
, addr_gran
, addr_min
, addr_max
,
1038 addr_trans
, len
, flags
);
1041 static uint8_t Hex2Byte(const char *src
)
1045 hi
= Hex2Digit(src
[0]);
1049 lo
= Hex2Digit(src
[1]);
1052 return (hi
<< 4) | lo
;
1056 * ACPI 3.0: 17.5.124 ToUUID (Convert String to UUID Macro)
1057 * e.g. UUID: aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
1058 * call aml_touuid("aabbccdd-eeff-gghh-iijj-kkllmmnnoopp");
1060 Aml
*aml_touuid(const char *uuid
)
1062 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_BUFFER
);
1064 assert(strlen(uuid
) == 36);
1065 assert(uuid
[8] == '-');
1066 assert(uuid
[13] == '-');
1067 assert(uuid
[18] == '-');
1068 assert(uuid
[23] == '-');
1070 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 6)); /* dd - at offset 00 */
1071 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 4)); /* cc - at offset 01 */
1072 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 2)); /* bb - at offset 02 */
1073 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 0)); /* aa - at offset 03 */
1075 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 11)); /* ff - at offset 04 */
1076 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 9)); /* ee - at offset 05 */
1078 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 16)); /* hh - at offset 06 */
1079 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 14)); /* gg - at offset 07 */
1081 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 19)); /* ii - at offset 08 */
1082 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 21)); /* jj - at offset 09 */
1084 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 24)); /* kk - at offset 10 */
1085 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 26)); /* ll - at offset 11 */
1086 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 28)); /* mm - at offset 12 */
1087 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 30)); /* nn - at offset 13 */
1088 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 32)); /* oo - at offset 14 */
1089 build_append_byte(var
->buf
, Hex2Byte(uuid
+ 34)); /* pp - at offset 15 */
1095 * ACPI 2.0b: 16.2.3.6.4.3 Unicode Macro (Convert Ascii String To Unicode)
1097 Aml
*aml_unicode(const char *str
)
1100 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_BUFFER
);
1103 build_append_byte(var
->buf
, str
[i
]);
1104 build_append_byte(var
->buf
, 0);
1106 } while (i
<= strlen(str
));
1112 build_header(GArray
*linker
, GArray
*table_data
,
1113 AcpiTableHeader
*h
, const char *sig
, int len
, uint8_t rev
)
1115 memcpy(&h
->signature
, sig
, 4);
1116 h
->length
= cpu_to_le32(len
);
1118 memcpy(h
->oem_id
, ACPI_BUILD_APPNAME6
, 6);
1119 memcpy(h
->oem_table_id
, ACPI_BUILD_APPNAME4
, 4);
1120 memcpy(h
->oem_table_id
+ 4, sig
, 4);
1121 h
->oem_revision
= cpu_to_le32(1);
1122 memcpy(h
->asl_compiler_id
, ACPI_BUILD_APPNAME4
, 4);
1123 h
->asl_compiler_revision
= cpu_to_le32(1);
1125 /* Checksum to be filled in by Guest linker */
1126 bios_linker_loader_add_checksum(linker
, ACPI_BUILD_TABLE_FILE
,
1127 table_data
->data
, h
, len
, &h
->checksum
);
1130 void *acpi_data_push(GArray
*table_data
, unsigned size
)
1132 unsigned off
= table_data
->len
;
1133 g_array_set_size(table_data
, off
+ size
);
1134 return table_data
->data
+ off
;
1137 unsigned acpi_data_len(GArray
*table
)
1139 #if GLIB_CHECK_VERSION(2, 22, 0)
1140 assert(g_array_get_element_size(table
) == 1);
1145 void acpi_add_table(GArray
*table_offsets
, GArray
*table_data
)
1147 uint32_t offset
= cpu_to_le32(table_data
->len
);
1148 g_array_append_val(table_offsets
, offset
);
1151 void acpi_build_tables_init(AcpiBuildTables
*tables
)
1153 tables
->rsdp
= g_array_new(false, true /* clear */, 1);
1154 tables
->table_data
= g_array_new(false, true /* clear */, 1);
1155 tables
->tcpalog
= g_array_new(false, true /* clear */, 1);
1156 tables
->linker
= bios_linker_loader_init();
1159 void acpi_build_tables_cleanup(AcpiBuildTables
*tables
, bool mfre
)
1161 void *linker_data
= bios_linker_loader_cleanup(tables
->linker
);
1162 g_free(linker_data
);
1163 g_array_free(tables
->rsdp
, true);
1164 g_array_free(tables
->table_data
, true);
1165 g_array_free(tables
->tcpalog
, mfre
);
1168 /* Build rsdt table */
1170 build_rsdt(GArray
*table_data
, GArray
*linker
, GArray
*table_offsets
)
1172 AcpiRsdtDescriptorRev1
*rsdt
;
1175 const int table_data_len
= (sizeof(uint32_t) * table_offsets
->len
);
1177 rsdt_len
= sizeof(*rsdt
) + table_data_len
;
1178 rsdt
= acpi_data_push(table_data
, rsdt_len
);
1179 memcpy(rsdt
->table_offset_entry
, table_offsets
->data
, table_data_len
);
1180 for (i
= 0; i
< table_offsets
->len
; ++i
) {
1181 /* rsdt->table_offset_entry to be filled by Guest linker */
1182 bios_linker_loader_add_pointer(linker
,
1183 ACPI_BUILD_TABLE_FILE
,
1184 ACPI_BUILD_TABLE_FILE
,
1185 table_data
, &rsdt
->table_offset_entry
[i
],
1188 build_header(linker
, table_data
,
1189 (void *)rsdt
, "RSDT", rsdt_len
, 1);