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/>.
27 #include "hw/acpi/aml-build.h"
28 #include "qemu/bswap.h"
30 GArray
*build_alloc_array(void)
32 return g_array_new(false, true /* clear */, 1);
35 void build_free_array(GArray
*array
)
37 g_array_free(array
, true);
40 void build_prepend_byte(GArray
*array
, uint8_t val
)
42 g_array_prepend_val(array
, val
);
45 void build_append_byte(GArray
*array
, uint8_t val
)
47 g_array_append_val(array
, val
);
50 void build_append_array(GArray
*array
, GArray
*val
)
52 g_array_append_vals(array
, val
->data
, val
->len
);
55 #define ACPI_NAMESEG_LEN 4
58 build_append_nameseg(GArray
*array
, const char *seg
)
60 /* It would be nicer to use g_string_vprintf but it's only there in 2.22 */
64 assert(len
<= ACPI_NAMESEG_LEN
);
66 g_array_append_vals(array
, seg
, len
);
67 /* Pad up to ACPI_NAMESEG_LEN characters if necessary. */
68 g_array_append_vals(array
, "____", ACPI_NAMESEG_LEN
- len
);
72 build_append_namestringv(GArray
*array
, const char *format
, va_list ap
)
74 /* It would be nicer to use g_string_vprintf but it's only there in 2.22 */
83 len
= vsnprintf(NULL
, 0, format
, va_len
);
86 s
= g_new(typeof(*s
), len
);
88 len
= vsnprintf(s
, len
, format
, ap
);
90 segs
= g_strsplit(s
, ".", 0);
100 * ACPI 5.0 spec: 20.2.2 Name Objects Encoding:
101 * "SegCount can be from 1 to 255"
103 assert(seg_count
> 0 && seg_count
<= 255);
105 /* handle RootPath || PrefixPath */
107 while (*s
== '\\' || *s
== '^') {
108 build_append_byte(array
, *s
);
115 build_append_byte(array
, 0x0); /* NullName */
117 build_append_nameseg(array
, s
);
122 build_append_byte(array
, 0x2E); /* DualNamePrefix */
123 build_append_nameseg(array
, s
);
124 build_append_nameseg(array
, segs
[1]);
127 build_append_byte(array
, 0x2F); /* MultiNamePrefix */
128 build_append_byte(array
, seg_count
);
130 /* handle the 1st segment manually due to prefix/root path */
131 build_append_nameseg(array
, s
);
133 /* add the rest of segments */
134 segs_iter
= segs
+ 1;
136 build_append_nameseg(array
, *segs_iter
);
144 void build_append_namestring(GArray
*array
, const char *format
, ...)
148 va_start(ap
, format
);
149 build_append_namestringv(array
, format
, ap
);
153 /* 5.4 Definition Block Encoding */
155 PACKAGE_LENGTH_1BYTE_SHIFT
= 6, /* Up to 63 - use extra 2 bits. */
156 PACKAGE_LENGTH_2BYTE_SHIFT
= 4,
157 PACKAGE_LENGTH_3BYTE_SHIFT
= 12,
158 PACKAGE_LENGTH_4BYTE_SHIFT
= 20,
162 build_prepend_package_length(GArray
*package
, unsigned length
, bool incl_self
)
165 unsigned length_bytes
;
167 if (length
+ 1 < (1 << PACKAGE_LENGTH_1BYTE_SHIFT
)) {
169 } else if (length
+ 2 < (1 << PACKAGE_LENGTH_3BYTE_SHIFT
)) {
171 } else if (length
+ 3 < (1 << PACKAGE_LENGTH_4BYTE_SHIFT
)) {
178 * NamedField uses PkgLength encoding but it doesn't include length
179 * of PkgLength itself.
183 * PkgLength is the length of the inclusive length of the data
184 * and PkgLength's length itself when used for terms with
187 length
+= length_bytes
;
190 switch (length_bytes
) {
193 build_prepend_byte(package
, byte
);
196 byte
= length
>> PACKAGE_LENGTH_4BYTE_SHIFT
;
197 build_prepend_byte(package
, byte
);
198 length
&= (1 << PACKAGE_LENGTH_4BYTE_SHIFT
) - 1;
201 byte
= length
>> PACKAGE_LENGTH_3BYTE_SHIFT
;
202 build_prepend_byte(package
, byte
);
203 length
&= (1 << PACKAGE_LENGTH_3BYTE_SHIFT
) - 1;
206 byte
= length
>> PACKAGE_LENGTH_2BYTE_SHIFT
;
207 build_prepend_byte(package
, byte
);
208 length
&= (1 << PACKAGE_LENGTH_2BYTE_SHIFT
) - 1;
212 * Most significant two bits of byte zero indicate how many following bytes
213 * are in PkgLength encoding.
215 byte
= ((length_bytes
- 1) << PACKAGE_LENGTH_1BYTE_SHIFT
) | length
;
216 build_prepend_byte(package
, byte
);
220 build_append_pkg_length(GArray
*array
, unsigned length
, bool incl_self
)
222 GArray
*tmp
= build_alloc_array();
224 build_prepend_package_length(tmp
, length
, incl_self
);
225 build_append_array(array
, tmp
);
226 build_free_array(tmp
);
229 void build_package(GArray
*package
, uint8_t op
)
231 build_prepend_package_length(package
, package
->len
, true);
232 build_prepend_byte(package
, op
);
235 void build_extop_package(GArray
*package
, uint8_t op
)
237 build_package(package
, op
);
238 build_prepend_byte(package
, 0x5B); /* ExtOpPrefix */
241 static void build_append_int_noprefix(GArray
*table
, uint64_t value
, int size
)
245 for (i
= 0; i
< size
; ++i
) {
246 build_append_byte(table
, value
& 0xFF);
251 void build_append_int(GArray
*table
, uint64_t value
)
254 build_append_byte(table
, 0x00); /* ZeroOp */
255 } else if (value
== 0x01) {
256 build_append_byte(table
, 0x01); /* OneOp */
257 } else if (value
<= 0xFF) {
258 build_append_byte(table
, 0x0A); /* BytePrefix */
259 build_append_int_noprefix(table
, value
, 1);
260 } else if (value
<= 0xFFFF) {
261 build_append_byte(table
, 0x0B); /* WordPrefix */
262 build_append_int_noprefix(table
, value
, 2);
263 } else if (value
<= 0xFFFFFFFF) {
264 build_append_byte(table
, 0x0C); /* DWordPrefix */
265 build_append_int_noprefix(table
, value
, 4);
267 build_append_byte(table
, 0x0E); /* QWordPrefix */
268 build_append_int_noprefix(table
, value
, 8);
272 static GPtrArray
*alloc_list
;
274 static Aml
*aml_alloc(void)
276 Aml
*var
= g_new0(typeof(*var
), 1);
278 g_ptr_array_add(alloc_list
, var
);
279 var
->block_flags
= AML_NO_OPCODE
;
280 var
->buf
= build_alloc_array();
284 static Aml
*aml_opcode(uint8_t op
)
286 Aml
*var
= aml_alloc();
289 var
->block_flags
= AML_OPCODE
;
293 static Aml
*aml_bundle(uint8_t op
, AmlBlockFlags flags
)
295 Aml
*var
= aml_alloc();
298 var
->block_flags
= flags
;
302 static void aml_free(gpointer data
)
305 build_free_array(var
->buf
);
308 Aml
*init_aml_allocator(void)
313 alloc_list
= g_ptr_array_new_with_free_func(aml_free
);
318 void free_aml_allocator(void)
320 g_ptr_array_free(alloc_list
, true);
324 /* pack data with DefBuffer encoding */
325 static void build_buffer(GArray
*array
, uint8_t op
)
327 GArray
*data
= build_alloc_array();
329 build_append_int(data
, array
->len
);
330 g_array_prepend_vals(array
, data
->data
, data
->len
);
331 build_free_array(data
);
332 build_package(array
, op
);
335 void aml_append(Aml
*parent_ctx
, Aml
*child
)
337 switch (child
->block_flags
) {
339 build_append_byte(parent_ctx
->buf
, child
->op
);
341 case AML_EXT_PACKAGE
:
342 build_extop_package(child
->buf
, child
->op
);
345 build_package(child
->buf
, child
->op
);
347 case AML_RES_TEMPLATE
:
348 build_append_byte(child
->buf
, 0x79); /* EndTag */
350 * checksum operations are treated as succeeded if checksum
351 * field is zero. [ACPI Spec 1.0b, 6.4.2.8 End Tag]
353 build_append_byte(child
->buf
, 0);
354 /* fall through, to pack resources in buffer */
356 build_buffer(child
->buf
, child
->op
);
364 build_append_array(parent_ctx
->buf
, child
->buf
);
367 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefScope */
368 Aml
*aml_scope(const char *name_format
, ...)
371 Aml
*var
= aml_bundle(0x10 /* ScopeOp */, AML_PACKAGE
);
372 va_start(ap
, name_format
);
373 build_append_namestringv(var
->buf
, name_format
, ap
);
378 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefReturn */
379 Aml
*aml_return(Aml
*val
)
381 Aml
*var
= aml_opcode(0xA4 /* ReturnOp */);
382 aml_append(var
, val
);
387 * ACPI 1.0b: 16.2.3 Data Objects Encoding:
388 * encodes: ByteConst, WordConst, DWordConst, QWordConst, ZeroOp, OneOp
390 Aml
*aml_int(const uint64_t val
)
392 Aml
*var
= aml_alloc();
393 build_append_int(var
->buf
, val
);
398 * helper to construct NameString, which returns Aml object
399 * for using with aml_append or other aml_* terms
401 Aml
*aml_name(const char *name_format
, ...)
404 Aml
*var
= aml_alloc();
405 va_start(ap
, name_format
);
406 build_append_namestringv(var
->buf
, name_format
, ap
);
411 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefName */
412 Aml
*aml_name_decl(const char *name
, Aml
*val
)
414 Aml
*var
= aml_opcode(0x08 /* NameOp */);
415 build_append_namestring(var
->buf
, "%s", name
);
416 aml_append(var
, val
);
420 /* ACPI 1.0b: 16.2.6.1 Arg Objects Encoding */
421 Aml
*aml_arg(int pos
)
424 uint8_t op
= 0x68 /* ARG0 op */ + pos
;
427 var
= aml_opcode(op
);
431 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefStore */
432 Aml
*aml_store(Aml
*val
, Aml
*target
)
434 Aml
*var
= aml_opcode(0x70 /* StoreOp */);
435 aml_append(var
, val
);
436 aml_append(var
, target
);
440 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAnd */
441 Aml
*aml_and(Aml
*arg1
, Aml
*arg2
)
443 Aml
*var
= aml_opcode(0x7B /* AndOp */);
444 aml_append(var
, arg1
);
445 aml_append(var
, arg2
);
446 build_append_int(var
->buf
, 0x00 /* NullNameOp */);
450 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefNotify */
451 Aml
*aml_notify(Aml
*arg1
, Aml
*arg2
)
453 Aml
*var
= aml_opcode(0x86 /* NotifyOp */);
454 aml_append(var
, arg1
);
455 aml_append(var
, arg2
);
459 /* helper to call method with 1 argument */
460 Aml
*aml_call1(const char *method
, Aml
*arg1
)
462 Aml
*var
= aml_alloc();
463 build_append_namestring(var
->buf
, "%s", method
);
464 aml_append(var
, arg1
);
468 /* helper to call method with 2 arguments */
469 Aml
*aml_call2(const char *method
, Aml
*arg1
, Aml
*arg2
)
471 Aml
*var
= aml_alloc();
472 build_append_namestring(var
->buf
, "%s", method
);
473 aml_append(var
, arg1
);
474 aml_append(var
, arg2
);
478 /* helper to call method with 3 arguments */
479 Aml
*aml_call3(const char *method
, Aml
*arg1
, Aml
*arg2
, Aml
*arg3
)
481 Aml
*var
= aml_alloc();
482 build_append_namestring(var
->buf
, "%s", method
);
483 aml_append(var
, arg1
);
484 aml_append(var
, arg2
);
485 aml_append(var
, arg3
);
489 /* helper to call method with 4 arguments */
490 Aml
*aml_call4(const char *method
, Aml
*arg1
, Aml
*arg2
, Aml
*arg3
, Aml
*arg4
)
492 Aml
*var
= aml_alloc();
493 build_append_namestring(var
->buf
, "%s", method
);
494 aml_append(var
, arg1
);
495 aml_append(var
, arg2
);
496 aml_append(var
, arg3
);
497 aml_append(var
, arg4
);
501 /* ACPI 1.0b: 6.4.2.5 I/O Port Descriptor */
502 Aml
*aml_io(AmlIODecode dec
, uint16_t min_base
, uint16_t max_base
,
503 uint8_t aln
, uint8_t len
)
505 Aml
*var
= aml_alloc();
506 build_append_byte(var
->buf
, 0x47); /* IO port descriptor */
507 build_append_byte(var
->buf
, dec
);
508 build_append_byte(var
->buf
, min_base
& 0xff);
509 build_append_byte(var
->buf
, (min_base
>> 8) & 0xff);
510 build_append_byte(var
->buf
, max_base
& 0xff);
511 build_append_byte(var
->buf
, (max_base
>> 8) & 0xff);
512 build_append_byte(var
->buf
, aln
);
513 build_append_byte(var
->buf
, len
);
517 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefIfElse */
518 Aml
*aml_if(Aml
*predicate
)
520 Aml
*var
= aml_bundle(0xA0 /* IfOp */, AML_PACKAGE
);
521 aml_append(var
, predicate
);
525 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefMethod */
526 Aml
*aml_method(const char *name
, int arg_count
)
528 Aml
*var
= aml_bundle(0x14 /* MethodOp */, AML_PACKAGE
);
529 build_append_namestring(var
->buf
, "%s", name
);
530 build_append_byte(var
->buf
, arg_count
); /* MethodFlags: ArgCount */
534 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefDevice */
535 Aml
*aml_device(const char *name_format
, ...)
538 Aml
*var
= aml_bundle(0x82 /* DeviceOp */, AML_EXT_PACKAGE
);
539 va_start(ap
, name_format
);
540 build_append_namestringv(var
->buf
, name_format
, ap
);
545 /* ACPI 1.0b: 6.4.1 ASL Macros for Resource Descriptors */
546 Aml
*aml_resource_template(void)
548 /* ResourceTemplate is a buffer of Resources with EndTag at the end */
549 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_RES_TEMPLATE
);
553 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefBuffer */
554 Aml
*aml_buffer(void)
556 Aml
*var
= aml_bundle(0x11 /* BufferOp */, AML_BUFFER
);
560 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefPackage */
561 Aml
*aml_package(uint8_t num_elements
)
563 Aml
*var
= aml_bundle(0x12 /* PackageOp */, AML_PACKAGE
);
564 build_append_byte(var
->buf
, num_elements
);
568 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefOpRegion */
569 Aml
*aml_operation_region(const char *name
, AmlRegionSpace rs
,
570 uint32_t offset
, uint32_t len
)
572 Aml
*var
= aml_alloc();
573 build_append_byte(var
->buf
, 0x5B); /* ExtOpPrefix */
574 build_append_byte(var
->buf
, 0x80); /* OpRegionOp */
575 build_append_namestring(var
->buf
, "%s", name
);
576 build_append_byte(var
->buf
, rs
);
577 build_append_int(var
->buf
, offset
);
578 build_append_int(var
->buf
, len
);
582 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: NamedField */
583 Aml
*aml_named_field(const char *name
, unsigned length
)
585 Aml
*var
= aml_alloc();
586 build_append_nameseg(var
->buf
, name
);
587 build_append_pkg_length(var
->buf
, length
, false);
591 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefField */
592 Aml
*aml_field(const char *name
, AmlFieldFlags flags
)
594 Aml
*var
= aml_bundle(0x81 /* FieldOp */, AML_EXT_PACKAGE
);
595 build_append_namestring(var
->buf
, "%s", name
);
596 build_append_byte(var
->buf
, flags
);
600 /* ACPI 1.0b: 16.2.3 Data Objects Encoding: String */
601 Aml
*aml_string(const char *name_format
, ...)
603 Aml
*var
= aml_opcode(0x0D /* StringPrefix */);
608 va_start(ap
, name_format
);
610 len
= vsnprintf(NULL
, 0, name_format
, va_len
);
613 s
= g_new0(typeof(*s
), len
);
615 len
= vsnprintf(s
, len
, name_format
, ap
);
618 g_array_append_vals(var
->buf
, s
, len
);
619 build_append_byte(var
->buf
, 0x0); /* NullChar */
625 /* ACPI 1.0b: 16.2.6.2 Local Objects Encoding */
626 Aml
*aml_local(int num
)
629 uint8_t op
= 0x60 /* Local0Op */ + num
;
632 var
= aml_opcode(op
);
636 /* ACPI 2.0a: 17.2.2 Data Objects Encoding: DefVarPackage */
637 Aml
*aml_varpackage(uint32_t num_elements
)
639 Aml
*var
= aml_bundle(0x13 /* VarPackageOp */, AML_PACKAGE
);
640 build_append_int(var
->buf
, num_elements
);