?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
acpi: add aml_to_hexstring()
[qemu.git] / hw / acpi / aml-build.c
blob40ea1284b70d400d4a71fe96bb0efd2ec06808ab
1 /* Support for generating ACPI tables and passing them to Guests
2 *
3 * Copyright (C) 2015 Red Hat Inc
4 *
5 * Author: Michael S. Tsirkin <mst@redhat.com>
6 * Author: Igor Mammedov <imammedo@redhat.com>
7 *
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.
12
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.
17
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/>.
20 */
21
22 #include <glib/gprintf.h>
23 #include <stdio.h>
24 #include <stdarg.h>
25 #include <assert.h>
26 #include <stdbool.h>
27 #include <string.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"
32
33 static GArray *build_alloc_array(void)
34 {
35 return g_array_new(false, true /* clear */, 1);
36 }
37
38 static void build_free_array(GArray *array)
39 {
40 g_array_free(array, true);
41 }
42
43 static void build_prepend_byte(GArray *array, uint8_t val)
44 {
45 g_array_prepend_val(array, val);
46 }
47
48 static void build_append_byte(GArray *array, uint8_t val)
49 {
50 g_array_append_val(array, val);
51 }
52
53 static void build_append_array(GArray *array, GArray *val)
54 {
55 g_array_append_vals(array, val->data, val->len);
56 }
57
58 #define ACPI_NAMESEG_LEN 4
59
60 static void
61 build_append_nameseg(GArray *array, const char *seg)
62 {
63 int len;
64
65 len = strlen(seg);
66 assert(len <= ACPI_NAMESEG_LEN);
67
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);
71 }
72
73 static void GCC_FMT_ATTR(2, 0)
74 build_append_namestringv(GArray *array, const char *format, va_list ap)
75 {
76 char *s;
77 char **segs;
78 char **segs_iter;
79 int seg_count = 0;
80
81 s = g_strdup_vprintf(format, ap);
82 segs = g_strsplit(s, ".", 0);
83 g_free(s);
84
85 /* count segments */
86 segs_iter = segs;
87 while (*segs_iter) {
88 ++segs_iter;
89 ++seg_count;
90 }
91 /*
92 * ACPI 5.0 spec: 20.2.2 Name Objects Encoding:
93 * "SegCount can be from 1 to 255"
94 */
95 assert(seg_count > 0 && seg_count <= 255);
96
97 /* handle RootPath || PrefixPath */
98 s = *segs;
99 while (*s == '\\' || *s == '^') {
100 build_append_byte(array, *s);
101 ++s;
102 }
103
104 switch (seg_count) {
105 case 1:
106 if (!*s) {
107 build_append_byte(array, 0x00); /* NullName */
108 } else {
109 build_append_nameseg(array, s);
110 }
111 break;
112
113 case 2:
114 build_append_byte(array, 0x2E); /* DualNamePrefix */
115 build_append_nameseg(array, s);
116 build_append_nameseg(array, segs[1]);
117 break;
118 default:
119 build_append_byte(array, 0x2F); /* MultiNamePrefix */
120 build_append_byte(array, seg_count);
121
122 /* handle the 1st segment manually due to prefix/root path */
123 build_append_nameseg(array, s);
124
125 /* add the rest of segments */
126 segs_iter = segs + 1;
127 while (*segs_iter) {
128 build_append_nameseg(array, *segs_iter);
129 ++segs_iter;
130 }
131 break;
132 }
133 g_strfreev(segs);
134 }
135
136 GCC_FMT_ATTR(2, 3)
137 static void build_append_namestring(GArray *array, const char *format, ...)
138 {
139 va_list ap;
140
141 va_start(ap, format);
142 build_append_namestringv(array, format, ap);
143 va_end(ap);
144 }
145
146 /* 5.4 Definition Block Encoding */
147 enum {
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,
152 };
153
154 static void
155 build_prepend_package_length(GArray *package, unsigned length, bool incl_self)
156 {
157 uint8_t byte;
158 unsigned length_bytes;
159
160 if (length + 1 < (1 << PACKAGE_LENGTH_1BYTE_SHIFT)) {
161 length_bytes = 1;
162 } else if (length + 2 < (1 << PACKAGE_LENGTH_3BYTE_SHIFT)) {
163 length_bytes = 2;
164 } else if (length + 3 < (1 << PACKAGE_LENGTH_4BYTE_SHIFT)) {
165 length_bytes = 3;
166 } else {
167 length_bytes = 4;
168 }
169
170 /*
171 * NamedField uses PkgLength encoding but it doesn't include length
172 * of PkgLength itself.
173 */
174 if (incl_self) {
175 /*
176 * PkgLength is the length of the inclusive length of the data
177 * and PkgLength's length itself when used for terms with
178 * explitit length.
179 */
180 length += length_bytes;
181 }
182
183 switch (length_bytes) {
184 case 1:
185 byte = length;
186 build_prepend_byte(package, byte);
187 return;
188 case 4:
189 byte = length >> PACKAGE_LENGTH_4BYTE_SHIFT;
190 build_prepend_byte(package, byte);
191 length &= (1 << PACKAGE_LENGTH_4BYTE_SHIFT) - 1;
192 /* fall through */
193 case 3:
194 byte = length >> PACKAGE_LENGTH_3BYTE_SHIFT;
195 build_prepend_byte(package, byte);
196 length &= (1 << PACKAGE_LENGTH_3BYTE_SHIFT) - 1;
197 /* fall through */
198 case 2:
199 byte = length >> PACKAGE_LENGTH_2BYTE_SHIFT;
200 build_prepend_byte(package, byte);
201 length &= (1 << PACKAGE_LENGTH_2BYTE_SHIFT) - 1;
202 /* fall through */
203 }
204 /*
205 * Most significant two bits of byte zero indicate how many following bytes
206 * are in PkgLength encoding.
207 */
208 byte = ((length_bytes - 1) << PACKAGE_LENGTH_1BYTE_SHIFT) | length;
209 build_prepend_byte(package, byte);
210 }
211
212 static void
213 build_append_pkg_length(GArray *array, unsigned length, bool incl_self)
214 {
215 GArray *tmp = build_alloc_array();
216
217 build_prepend_package_length(tmp, length, incl_self);
218 build_append_array(array, tmp);
219 build_free_array(tmp);
220 }
221
222 static void build_package(GArray *package, uint8_t op)
223 {
224 build_prepend_package_length(package, package->len, true);
225 build_prepend_byte(package, op);
226 }
227
228 static void build_extop_package(GArray *package, uint8_t op)
229 {
230 build_package(package, op);
231 build_prepend_byte(package, 0x5B); /* ExtOpPrefix */
232 }
233
234 static void build_append_int_noprefix(GArray *table, uint64_t value, int size)
235 {
236 int i;
237
238 for (i = 0; i < size; ++i) {
239 build_append_byte(table, value & 0xFF);
240 value = value >> 8;
241 }
242 }
243
244 static void build_append_int(GArray *table, uint64_t value)
245 {
246 if (value == 0x00) {
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);
259 } else {
260 build_append_byte(table, 0x0E); /* QWordPrefix */
261 build_append_int_noprefix(table, value, 8);
262 }
263 }
264
265 static GPtrArray *alloc_list;
266
267 static Aml *aml_alloc(void)
268 {
269 Aml *var = g_new0(typeof(*var), 1);
270
271 g_ptr_array_add(alloc_list, var);
272 var->block_flags = AML_NO_OPCODE;
273 var->buf = build_alloc_array();
274 return var;
275 }
276
277 static Aml *aml_opcode(uint8_t op)
278 {
279 Aml *var = aml_alloc();
280
281 var->op = op;
282 var->block_flags = AML_OPCODE;
283 return var;
284 }
285
286 static Aml *aml_bundle(uint8_t op, AmlBlockFlags flags)
287 {
288 Aml *var = aml_alloc();
289
290 var->op = op;
291 var->block_flags = flags;
292 return var;
293 }
294
295 static void aml_free(gpointer data, gpointer user_data)
296 {
297 Aml *var = data;
298 build_free_array(var->buf);
299 g_free(var);
300 }
301
302 Aml *init_aml_allocator(void)
303 {
304 Aml *var;
305
306 assert(!alloc_list);
307 alloc_list = g_ptr_array_new();
308 var = aml_alloc();
309 return var;
310 }
311
312 void free_aml_allocator(void)
313 {
314 g_ptr_array_foreach(alloc_list, aml_free, NULL);
315 g_ptr_array_free(alloc_list, true);
316 alloc_list = 0;
317 }
318
319 /* pack data with DefBuffer encoding */
320 static void build_buffer(GArray *array, uint8_t op)
321 {
322 GArray *data = build_alloc_array();
323
324 build_append_int(data, array->len);
325 g_array_prepend_vals(array, data->data, data->len);
326 build_free_array(data);
327 build_package(array, op);
328 }
329
330 void aml_append(Aml *parent_ctx, Aml *child)
331 {
332 GArray *buf = build_alloc_array();
333 build_append_array(buf, child->buf);
334
335 switch (child->block_flags) {
336 case AML_OPCODE:
337 build_append_byte(parent_ctx->buf, child->op);
338 break;
339 case AML_EXT_PACKAGE:
340 build_extop_package(buf, child->op);
341 break;
342 case AML_PACKAGE:
343 build_package(buf, child->op);
344 break;
345 case AML_RES_TEMPLATE:
346 build_append_byte(buf, 0x79); /* EndTag */
347 /*
348 * checksum operations are treated as succeeded if checksum
349 * field is zero. [ACPI Spec 1.0b, 6.4.2.8 End Tag]
350 */
351 build_append_byte(buf, 0);
352 /* fall through, to pack resources in buffer */
353 case AML_BUFFER:
354 build_buffer(buf, child->op);
355 break;
356 case AML_NO_OPCODE:
357 break;
358 default:
359 assert(0);
360 break;
361 }
362 build_append_array(parent_ctx->buf, buf);
363 build_free_array(buf);
364 }
365
366 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefScope */
367 Aml *aml_scope(const char *name_format, ...)
368 {
369 va_list ap;
370 Aml *var = aml_bundle(0x10 /* ScopeOp */, AML_PACKAGE);
371 va_start(ap, name_format);
372 build_append_namestringv(var->buf, name_format, ap);
373 va_end(ap);
374 return var;
375 }
376
377 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefReturn */
378 Aml *aml_return(Aml *val)
379 {
380 Aml *var = aml_opcode(0xA4 /* ReturnOp */);
381 aml_append(var, val);
382 return var;
383 }
384
385 /*
386 * ACPI 1.0b: 16.2.3 Data Objects Encoding:
387 * encodes: ByteConst, WordConst, DWordConst, QWordConst, ZeroOp, OneOp
388 */
389 Aml *aml_int(const uint64_t val)
390 {
391 Aml *var = aml_alloc();
392 build_append_int(var->buf, val);
393 return var;
394 }
395
396 /*
397 * helper to construct NameString, which returns Aml object
398 * for using with aml_append or other aml_* terms
399 */
400 Aml *aml_name(const char *name_format, ...)
401 {
402 va_list ap;
403 Aml *var = aml_alloc();
404 va_start(ap, name_format);
405 build_append_namestringv(var->buf, name_format, ap);
406 va_end(ap);
407 return var;
408 }
409
410 /* ACPI 1.0b: 16.2.5.1 Namespace Modifier Objects Encoding: DefName */
411 Aml *aml_name_decl(const char *name, Aml *val)
412 {
413 Aml *var = aml_opcode(0x08 /* NameOp */);
414 build_append_namestring(var->buf, "%s", name);
415 aml_append(var, val);
416 return var;
417 }
418
419 /* ACPI 1.0b: 16.2.6.1 Arg Objects Encoding */
420 Aml *aml_arg(int pos)
421 {
422 Aml *var;
423 uint8_t op = 0x68 /* ARG0 op */ + pos;
424
425 assert(pos <= 6);
426 var = aml_opcode(op);
427 return var;
428 }
429
430 /* ACPI 2.0a: 17.2.4.4 Type 2 Opcodes Encoding: DefToInteger */
431 Aml *aml_to_integer(Aml *arg)
432 {
433 Aml *var = aml_opcode(0x99 /* ToIntegerOp */);
434 aml_append(var, arg);
435 build_append_byte(var->buf, 0x00 /* NullNameOp */);
436 return var;
437 }
438
439 /* ACPI 2.0a: 17.2.4.4 Type 2 Opcodes Encoding: DefToHexString */
440 Aml *aml_to_hexstring(Aml *src, Aml *dst)
441 {
442 Aml *var = aml_opcode(0x98 /* ToHexStringOp */);
443 aml_append(var, src);
444 if (dst) {
445 aml_append(var, dst);
446 } else {
447 build_append_byte(var->buf, 0x00 /* NullNameOp */);
448 }
449 return var;
450 }
451
452 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefStore */
453 Aml *aml_store(Aml *val, Aml *target)
454 {
455 Aml *var = aml_opcode(0x70 /* StoreOp */);
456 aml_append(var, val);
457 aml_append(var, target);
458 return var;
459 }
460
461 /**
462 * build_opcode_2arg_dst:
463 * @op: 1-byte opcode
464 * @arg1: 1st operand
465 * @arg2: 2nd operand
466 * @dst: optional target to store to, set to NULL if it's not required
467 *
468 * An internal helper to compose AML terms that have
469 * "Op Operand Operand Target"
470 * pattern.
471 *
472 * Returns: The newly allocated and composed according to patter Aml object.
473 */
474 static Aml *
475 build_opcode_2arg_dst(uint8_t op, Aml *arg1, Aml *arg2, Aml *dst)
476 {
477 Aml *var = aml_opcode(op);
478 aml_append(var, arg1);
479 aml_append(var, arg2);
480 if (dst) {
481 aml_append(var, dst);
482 } else {
483 build_append_byte(var->buf, 0x00 /* NullNameOp */);
484 }
485 return var;
486 }
487
488 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAnd */
489 Aml *aml_and(Aml *arg1, Aml *arg2)
490 {
491 return build_opcode_2arg_dst(0x7B /* AndOp */, arg1, arg2, NULL);
492 }
493
494 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefOr */
495 Aml *aml_or(Aml *arg1, Aml *arg2)
496 {
497 return build_opcode_2arg_dst(0x7D /* OrOp */, arg1, arg2, NULL);
498 }
499
500 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLOr */
501 Aml *aml_lor(Aml *arg1, Aml *arg2)
502 {
503 Aml *var = aml_opcode(0x91 /* LOrOp */);
504 aml_append(var, arg1);
505 aml_append(var, arg2);
506 return var;
507 }
508
509 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefShiftLeft */
510 Aml *aml_shiftleft(Aml *arg1, Aml *count)
511 {
512 return build_opcode_2arg_dst(0x79 /* ShiftLeftOp */, arg1, count, NULL);
513 }
514
515 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefShiftRight */
516 Aml *aml_shiftright(Aml *arg1, Aml *count, Aml *dst)
517 {
518 return build_opcode_2arg_dst(0x7A /* ShiftRightOp */, arg1, count, dst);
519 }
520
521 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLLess */
522 Aml *aml_lless(Aml *arg1, Aml *arg2)
523 {
524 Aml *var = aml_opcode(0x95 /* LLessOp */);
525 aml_append(var, arg1);
526 aml_append(var, arg2);
527 return var;
528 }
529
530 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAdd */
531 Aml *aml_add(Aml *arg1, Aml *arg2, Aml *dst)
532 {
533 return build_opcode_2arg_dst(0x72 /* AddOp */, arg1, arg2, dst);
534 }
535
536 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefSubtract */
537 Aml *aml_subtract(Aml *arg1, Aml *arg2, Aml *dst)
538 {
539 return build_opcode_2arg_dst(0x74 /* SubtractOp */, arg1, arg2, dst);
540 }
541
542 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefIncrement */
543 Aml *aml_increment(Aml *arg)
544 {
545 Aml *var = aml_opcode(0x75 /* IncrementOp */);
546 aml_append(var, arg);
547 return var;
548 }
549
550 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefDecrement */
551 Aml *aml_decrement(Aml *arg)
552 {
553 Aml *var = aml_opcode(0x76 /* DecrementOp */);
554 aml_append(var, arg);
555 return var;
556 }
557
558 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefIndex */
559 Aml *aml_index(Aml *arg1, Aml *idx)
560 {
561 return build_opcode_2arg_dst(0x88 /* IndexOp */, arg1, idx, NULL);
562 }
563
564 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefNotify */
565 Aml *aml_notify(Aml *arg1, Aml *arg2)
566 {
567 Aml *var = aml_opcode(0x86 /* NotifyOp */);
568 aml_append(var, arg1);
569 aml_append(var, arg2);
570 return var;
571 }
572
573 /* helper to call method with 1 argument */
574 Aml *aml_call0(const char *method)
575 {
576 Aml *var = aml_alloc();
577 build_append_namestring(var->buf, "%s", method);
578 return var;
579 }
580
581 /* helper to call method with 1 argument */
582 Aml *aml_call1(const char *method, Aml *arg1)
583 {
584 Aml *var = aml_alloc();
585 build_append_namestring(var->buf, "%s", method);
586 aml_append(var, arg1);
587 return var;
588 }
589
590 /* helper to call method with 2 arguments */
591 Aml *aml_call2(const char *method, Aml *arg1, Aml *arg2)
592 {
593 Aml *var = aml_alloc();
594 build_append_namestring(var->buf, "%s", method);
595 aml_append(var, arg1);
596 aml_append(var, arg2);
597 return var;
598 }
599
600 /* helper to call method with 3 arguments */
601 Aml *aml_call3(const char *method, Aml *arg1, Aml *arg2, Aml *arg3)
602 {
603 Aml *var = aml_alloc();
604 build_append_namestring(var->buf, "%s", method);
605 aml_append(var, arg1);
606 aml_append(var, arg2);
607 aml_append(var, arg3);
608 return var;
609 }
610
611 /* helper to call method with 4 arguments */
612 Aml *aml_call4(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4)
613 {
614 Aml *var = aml_alloc();
615 build_append_namestring(var->buf, "%s", method);
616 aml_append(var, arg1);
617 aml_append(var, arg2);
618 aml_append(var, arg3);
619 aml_append(var, arg4);
620 return var;
621 }
622
623 /*
624 * ACPI 5.0: 6.4.3.8.1 GPIO Connection Descriptor
625 * Type 1, Large Item Name 0xC
626 */
627
628 static Aml *aml_gpio_connection(AmlGpioConnectionType type,
629 AmlConsumerAndProducer con_and_pro,
630 uint8_t flags, AmlPinConfig pin_config,
631 uint16_t output_drive,
632 uint16_t debounce_timeout,
633 const uint32_t pin_list[], uint32_t pin_count,
634 const char *resource_source_name,
635 const uint8_t *vendor_data,
636 uint16_t vendor_data_len)
637 {
638 Aml *var = aml_alloc();
639 const uint16_t min_desc_len = 0x16;
640 uint16_t resource_source_name_len, length;
641 uint16_t pin_table_offset, resource_source_name_offset, vendor_data_offset;
642 uint32_t i;
643
644 assert(resource_source_name);
645 resource_source_name_len = strlen(resource_source_name) + 1;
646 length = min_desc_len + resource_source_name_len + vendor_data_len;
647 pin_table_offset = min_desc_len + 1;
648 resource_source_name_offset = pin_table_offset + pin_count * 2;
649 vendor_data_offset = resource_source_name_offset + resource_source_name_len;
650
651 build_append_byte(var->buf, 0x8C); /* GPIO Connection Descriptor */
652 build_append_int_noprefix(var->buf, length, 2); /* Length */
653 build_append_byte(var->buf, 1); /* Revision ID */
654 build_append_byte(var->buf, type); /* GPIO Connection Type */
655 /* General Flags (2 bytes) */
656 build_append_int_noprefix(var->buf, con_and_pro, 2);
657 /* Interrupt and IO Flags (2 bytes) */
658 build_append_int_noprefix(var->buf, flags, 2);
659 /* Pin Configuration 0 = Default 1 = Pull-up 2 = Pull-down 3 = No Pull */
660 build_append_byte(var->buf, pin_config);
661 /* Output Drive Strength (2 bytes) */
662 build_append_int_noprefix(var->buf, output_drive, 2);
663 /* Debounce Timeout (2 bytes) */
664 build_append_int_noprefix(var->buf, debounce_timeout, 2);
665 /* Pin Table Offset (2 bytes) */
666 build_append_int_noprefix(var->buf, pin_table_offset, 2);
667 build_append_byte(var->buf, 0); /* Resource Source Index */
668 /* Resource Source Name Offset (2 bytes) */
669 build_append_int_noprefix(var->buf, resource_source_name_offset, 2);
670 /* Vendor Data Offset (2 bytes) */
671 build_append_int_noprefix(var->buf, vendor_data_offset, 2);
672 /* Vendor Data Length (2 bytes) */
673 build_append_int_noprefix(var->buf, vendor_data_len, 2);
674 /* Pin Number (2n bytes)*/
675 for (i = 0; i < pin_count; i++) {
676 build_append_int_noprefix(var->buf, pin_list[i], 2);
677 }
678
679 /* Resource Source Name */
680 build_append_namestring(var->buf, "%s", resource_source_name);
681 build_append_byte(var->buf, '\0');
682
683 /* Vendor-defined Data */
684 if (vendor_data != NULL) {
685 g_array_append_vals(var->buf, vendor_data, vendor_data_len);
686 }
687
688 return var;
689 }
690
691 /*
692 * ACPI 5.0: 19.5.53
693 * GpioInt(GPIO Interrupt Connection Resource Descriptor Macro)
694 */
695 Aml *aml_gpio_int(AmlConsumerAndProducer con_and_pro,
696 AmlLevelAndEdge edge_level,
697 AmlActiveHighAndLow active_level, AmlShared shared,
698 AmlPinConfig pin_config, uint16_t debounce_timeout,
699 const uint32_t pin_list[], uint32_t pin_count,
700 const char *resource_source_name,
701 const uint8_t *vendor_data, uint16_t vendor_data_len)
702 {
703 uint8_t flags = edge_level | (active_level << 1) | (shared << 3);
704
705 return aml_gpio_connection(AML_INTERRUPT_CONNECTION, con_and_pro, flags,
706 pin_config, 0, debounce_timeout, pin_list,
707 pin_count, resource_source_name, vendor_data,
708 vendor_data_len);
709 }
710
711 /*
712 * ACPI 1.0b: 6.4.3.4 32-Bit Fixed Location Memory Range Descriptor
713 * (Type 1, Large Item Name 0x6)
714 */
715 Aml *aml_memory32_fixed(uint32_t addr, uint32_t size,
716 AmlReadAndWrite read_and_write)
717 {
718 Aml *var = aml_alloc();
719 build_append_byte(var->buf, 0x86); /* Memory32Fixed Resource Descriptor */
720 build_append_byte(var->buf, 9); /* Length, bits[7:0] value = 9 */
721 build_append_byte(var->buf, 0); /* Length, bits[15:8] value = 0 */
722 build_append_byte(var->buf, read_and_write); /* Write status, 1 rw 0 ro */
723
724 /* Range base address */
725 build_append_byte(var->buf, extract32(addr, 0, 8)); /* bits[7:0] */
726 build_append_byte(var->buf, extract32(addr, 8, 8)); /* bits[15:8] */
727 build_append_byte(var->buf, extract32(addr, 16, 8)); /* bits[23:16] */
728 build_append_byte(var->buf, extract32(addr, 24, 8)); /* bits[31:24] */
729
730 /* Range length */
731 build_append_byte(var->buf, extract32(size, 0, 8)); /* bits[7:0] */
732 build_append_byte(var->buf, extract32(size, 8, 8)); /* bits[15:8] */
733 build_append_byte(var->buf, extract32(size, 16, 8)); /* bits[23:16] */
734 build_append_byte(var->buf, extract32(size, 24, 8)); /* bits[31:24] */
735 return var;
736 }
737
738 /*
739 * ACPI 5.0: 6.4.3.6 Extended Interrupt Descriptor
740 * Type 1, Large Item Name 0x9
741 */
742 Aml *aml_interrupt(AmlConsumerAndProducer con_and_pro,
743 AmlLevelAndEdge level_and_edge,
744 AmlActiveHighAndLow high_and_low, AmlShared shared,
745 uint32_t *irq_list, uint8_t irq_count)
746 {
747 int i;
748 Aml *var = aml_alloc();
749 uint8_t irq_flags = con_and_pro | (level_and_edge << 1)
750 | (high_and_low << 2) | (shared << 3);
751 const int header_bytes_in_len = 2;
752 uint16_t len = header_bytes_in_len + irq_count * sizeof(uint32_t);
753
754 assert(irq_count > 0);
755
756 build_append_byte(var->buf, 0x89); /* Extended irq descriptor */
757 build_append_byte(var->buf, len & 0xFF); /* Length, bits[7:0] */
758 build_append_byte(var->buf, len >> 8); /* Length, bits[15:8] */
759 build_append_byte(var->buf, irq_flags); /* Interrupt Vector Information. */
760 build_append_byte(var->buf, irq_count); /* Interrupt table length */
761
762 /* Interrupt Number List */
763 for (i = 0; i < irq_count; i++) {
764 build_append_int_noprefix(var->buf, irq_list[i], 4);
765 }
766 return var;
767 }
768
769 /* ACPI 1.0b: 6.4.2.5 I/O Port Descriptor */
770 Aml *aml_io(AmlIODecode dec, uint16_t min_base, uint16_t max_base,
771 uint8_t aln, uint8_t len)
772 {
773 Aml *var = aml_alloc();
774 build_append_byte(var->buf, 0x47); /* IO port descriptor */
775 build_append_byte(var->buf, dec);
776 build_append_byte(var->buf, min_base & 0xff);
777 build_append_byte(var->buf, (min_base >> 8) & 0xff);
778 build_append_byte(var->buf, max_base & 0xff);
779 build_append_byte(var->buf, (max_base >> 8) & 0xff);
780 build_append_byte(var->buf, aln);
781 build_append_byte(var->buf, len);
782 return var;
783 }
784
785 /*
786 * ACPI 1.0b: 6.4.2.1.1 ASL Macro for IRQ Descriptor
787 *
788 * More verbose description at:
789 * ACPI 5.0: 19.5.64 IRQNoFlags (Interrupt Resource Descriptor Macro)
790 * 6.4.2.1 IRQ Descriptor
791 */
792 Aml *aml_irq_no_flags(uint8_t irq)
793 {
794 uint16_t irq_mask;
795 Aml *var = aml_alloc();
796
797 assert(irq < 16);
798 build_append_byte(var->buf, 0x22); /* IRQ descriptor 2 byte form */
799
800 irq_mask = 1U << irq;
801 build_append_byte(var->buf, irq_mask & 0xFF); /* IRQ mask bits[7:0] */
802 build_append_byte(var->buf, irq_mask >> 8); /* IRQ mask bits[15:8] */
803 return var;
804 }
805
806 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLNot */
807 Aml *aml_lnot(Aml *arg)
808 {
809 Aml *var = aml_opcode(0x92 /* LNotOp */);
810 aml_append(var, arg);
811 return var;
812 }
813
814 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLEqual */
815 Aml *aml_equal(Aml *arg1, Aml *arg2)
816 {
817 Aml *var = aml_opcode(0x93 /* LequalOp */);
818 aml_append(var, arg1);
819 aml_append(var, arg2);
820 return var;
821 }
822
823 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLGreater */
824 Aml *aml_lgreater(Aml *arg1, Aml *arg2)
825 {
826 Aml *var = aml_opcode(0x94 /* LGreaterOp */);
827 aml_append(var, arg1);
828 aml_append(var, arg2);
829 return var;
830 }
831
832 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLGreaterEqual */
833 Aml *aml_lgreater_equal(Aml *arg1, Aml *arg2)
834 {
835 /* LGreaterEqualOp := LNotOp LLessOp */
836 Aml *var = aml_opcode(0x92 /* LNotOp */);
837 build_append_byte(var->buf, 0x95 /* LLessOp */);
838 aml_append(var, arg1);
839 aml_append(var, arg2);
840 return var;
841 }
842
843 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefIfElse */
844 Aml *aml_if(Aml *predicate)
845 {
846 Aml *var = aml_bundle(0xA0 /* IfOp */, AML_PACKAGE);
847 aml_append(var, predicate);
848 return var;
849 }
850
851 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefElse */
852 Aml *aml_else(void)
853 {
854 Aml *var = aml_bundle(0xA1 /* ElseOp */, AML_PACKAGE);
855 return var;
856 }
857
858 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefWhile */
859 Aml *aml_while(Aml *predicate)
860 {
861 Aml *var = aml_bundle(0xA2 /* WhileOp */, AML_PACKAGE);
862 aml_append(var, predicate);
863 return var;
864 }
865
866 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefMethod */
867 Aml *aml_method(const char *name, int arg_count, AmlSerializeFlag sflag)
868 {
869 Aml *var = aml_bundle(0x14 /* MethodOp */, AML_PACKAGE);
870 int methodflags;
871
872 /*
873 * MethodFlags:
874 * bit 0-2: ArgCount (0-7)
875 * bit 3: SerializeFlag
876 * 0: NotSerialized
877 * 1: Serialized
878 * bit 4-7: reserved (must be 0)
879 */
880 assert(arg_count < 8);
881 methodflags = arg_count | (sflag << 3);
882
883 build_append_namestring(var->buf, "%s", name);
884 build_append_byte(var->buf, methodflags); /* MethodFlags: ArgCount */
885 return var;
886 }
887
888 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefDevice */
889 Aml *aml_device(const char *name_format, ...)
890 {
891 va_list ap;
892 Aml *var = aml_bundle(0x82 /* DeviceOp */, AML_EXT_PACKAGE);
893 va_start(ap, name_format);
894 build_append_namestringv(var->buf, name_format, ap);
895 va_end(ap);
896 return var;
897 }
898
899 /* ACPI 1.0b: 6.4.1 ASL Macros for Resource Descriptors */
900 Aml *aml_resource_template(void)
901 {
902 /* ResourceTemplate is a buffer of Resources with EndTag at the end */
903 Aml *var = aml_bundle(0x11 /* BufferOp */, AML_RES_TEMPLATE);
904 return var;
905 }
906
907 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefBuffer
908 * Pass byte_list as NULL to request uninitialized buffer to reserve space.
909 */
910 Aml *aml_buffer(int buffer_size, uint8_t *byte_list)
911 {
912 int i;
913 Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
914
915 for (i = 0; i < buffer_size; i++) {
916 if (byte_list == NULL) {
917 build_append_byte(var->buf, 0x0);
918 } else {
919 build_append_byte(var->buf, byte_list[i]);
920 }
921 }
922
923 return var;
924 }
925
926 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefPackage */
927 Aml *aml_package(uint8_t num_elements)
928 {
929 Aml *var = aml_bundle(0x12 /* PackageOp */, AML_PACKAGE);
930 build_append_byte(var->buf, num_elements);
931 return var;
932 }
933
934 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefOpRegion */
935 Aml *aml_operation_region(const char *name, AmlRegionSpace rs,
936 uint32_t offset, uint32_t len)
937 {
938 Aml *var = aml_alloc();
939 build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
940 build_append_byte(var->buf, 0x80); /* OpRegionOp */
941 build_append_namestring(var->buf, "%s", name);
942 build_append_byte(var->buf, rs);
943 build_append_int(var->buf, offset);
944 build_append_int(var->buf, len);
945 return var;
946 }
947
948 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: NamedField */
949 Aml *aml_named_field(const char *name, unsigned length)
950 {
951 Aml *var = aml_alloc();
952 build_append_nameseg(var->buf, name);
953 build_append_pkg_length(var->buf, length, false);
954 return var;
955 }
956
957 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: ReservedField */
958 Aml *aml_reserved_field(unsigned length)
959 {
960 Aml *var = aml_alloc();
961 /* ReservedField := 0x00 PkgLength */
962 build_append_byte(var->buf, 0x00);
963 build_append_pkg_length(var->buf, length, false);
964 return var;
965 }
966
967 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefField */
968 Aml *aml_field(const char *name, AmlAccessType type, AmlLockRule lock,
969 AmlUpdateRule rule)
970 {
971 Aml *var = aml_bundle(0x81 /* FieldOp */, AML_EXT_PACKAGE);
972 uint8_t flags = rule << 5 | type;
973
974 flags |= lock << 4; /* LockRule at 4 bit offset */
975
976 build_append_namestring(var->buf, "%s", name);
977 build_append_byte(var->buf, flags);
978 return var;
979 }
980
981 static
982 Aml *create_field_common(int opcode, Aml *srcbuf, Aml *index, const char *name)
983 {
984 Aml *var = aml_opcode(opcode);
985 aml_append(var, srcbuf);
986 aml_append(var, index);
987 build_append_namestring(var->buf, "%s", name);
988 return var;
989 }
990
991 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefCreateDWordField */
992 Aml *aml_create_dword_field(Aml *srcbuf, Aml *index, const char *name)
993 {
994 return create_field_common(0x8A /* CreateDWordFieldOp */,
995 srcbuf, index, name);
996 }
997
998 /* ACPI 2.0a: 17.2.4.2 Named Objects Encoding: DefCreateQWordField */
999 Aml *aml_create_qword_field(Aml *srcbuf, Aml *index, const char *name)
1000 {
1001 return create_field_common(0x8F /* CreateQWordFieldOp */,
1002 srcbuf, index, name);
1003 }
1004
1005 /* ACPI 1.0b: 16.2.3 Data Objects Encoding: String */
1006 Aml *aml_string(const char *name_format, ...)
1007 {
1008 Aml *var = aml_opcode(0x0D /* StringPrefix */);
1009 va_list ap;
1010 char *s;
1011 int len;
1012
1013 va_start(ap, name_format);
1014 len = g_vasprintf(&s, name_format, ap);
1015 va_end(ap);
1016
1017 g_array_append_vals(var->buf, s, len + 1);
1018 g_free(s);
1019
1020 return var;
1021 }
1022
1023 /* ACPI 1.0b: 16.2.6.2 Local Objects Encoding */
1024 Aml *aml_local(int num)
1025 {
1026 Aml *var;
1027 uint8_t op = 0x60 /* Local0Op */ + num;
1028
1029 assert(num <= 7);
1030 var = aml_opcode(op);
1031 return var;
1032 }
1033
1034 /* ACPI 2.0a: 17.2.2 Data Objects Encoding: DefVarPackage */
1035 Aml *aml_varpackage(uint32_t num_elements)
1036 {
1037 Aml *var = aml_bundle(0x13 /* VarPackageOp */, AML_PACKAGE);
1038 build_append_int(var->buf, num_elements);
1039 return var;
1040 }
1041
1042 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefProcessor */
1043 Aml *aml_processor(uint8_t proc_id, uint32_t pblk_addr, uint8_t pblk_len,
1044 const char *name_format, ...)
1045 {
1046 va_list ap;
1047 Aml *var = aml_bundle(0x83 /* ProcessorOp */, AML_EXT_PACKAGE);
1048 va_start(ap, name_format);
1049 build_append_namestringv(var->buf, name_format, ap);
1050 va_end(ap);
1051 build_append_byte(var->buf, proc_id); /* ProcID */
1052 build_append_int_noprefix(var->buf, pblk_addr, sizeof(pblk_addr));
1053 build_append_byte(var->buf, pblk_len); /* PblkLen */
1054 return var;
1055 }
1056
1057 static uint8_t Hex2Digit(char c)
1058 {
1059 if (c >= 'A') {
1060 return c - 'A' + 10;
1061 }
1062
1063 return c - '0';
1064 }
1065
1066 /* ACPI 1.0b: 15.2.3.6.4.1 EISAID Macro - Convert EISA ID String To Integer */
1067 Aml *aml_eisaid(const char *str)
1068 {
1069 Aml *var = aml_alloc();
1070 uint32_t id;
1071
1072 g_assert(strlen(str) == 7);
1073 id = (str[0] - 0x40) << 26 |
1074 (str[1] - 0x40) << 21 |
1075 (str[2] - 0x40) << 16 |
1076 Hex2Digit(str[3]) << 12 |
1077 Hex2Digit(str[4]) << 8 |
1078 Hex2Digit(str[5]) << 4 |
1079 Hex2Digit(str[6]);
1080
1081 build_append_byte(var->buf, 0x0C); /* DWordPrefix */
1082 build_append_int_noprefix(var->buf, bswap32(id), sizeof(id));
1083 return var;
1084 }
1085
1086 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor: bytes 3-5 */
1087 static Aml *aml_as_desc_header(AmlResourceType type, AmlMinFixed min_fixed,
1088 AmlMaxFixed max_fixed, AmlDecode dec,
1089 uint8_t type_flags)
1090 {
1091 uint8_t flags = max_fixed | min_fixed | dec;
1092 Aml *var = aml_alloc();
1093
1094 build_append_byte(var->buf, type);
1095 build_append_byte(var->buf, flags);
1096 build_append_byte(var->buf, type_flags); /* Type Specific Flags */
1097 return var;
1098 }
1099
1100 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor */
1101 static Aml *aml_word_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
1102 AmlMaxFixed max_fixed, AmlDecode dec,
1103 uint16_t addr_gran, uint16_t addr_min,
1104 uint16_t addr_max, uint16_t addr_trans,
1105 uint16_t len, uint8_t type_flags)
1106 {
1107 Aml *var = aml_alloc();
1108
1109 build_append_byte(var->buf, 0x88); /* Word Address Space Descriptor */
1110 /* minimum length since we do not encode optional fields */
1111 build_append_byte(var->buf, 0x0D);
1112 build_append_byte(var->buf, 0x0);
1113
1114 aml_append(var,
1115 aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
1116 build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
1117 build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
1118 build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
1119 build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
1120 build_append_int_noprefix(var->buf, len, sizeof(len));
1121 return var;
1122 }
1123
1124 /* ACPI 1.0b: 6.4.3.5.3 DWord Address Space Descriptor */
1125 static Aml *aml_dword_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
1126 AmlMaxFixed max_fixed, AmlDecode dec,
1127 uint32_t addr_gran, uint32_t addr_min,
1128 uint32_t addr_max, uint32_t addr_trans,
1129 uint32_t len, uint8_t type_flags)
1130 {
1131 Aml *var = aml_alloc();
1132
1133 build_append_byte(var->buf, 0x87); /* DWord Address Space Descriptor */
1134 /* minimum length since we do not encode optional fields */
1135 build_append_byte(var->buf, 23);
1136 build_append_byte(var->buf, 0x0);
1137
1138
1139 aml_append(var,
1140 aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
1141 build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
1142 build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
1143 build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
1144 build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
1145 build_append_int_noprefix(var->buf, len, sizeof(len));
1146 return var;
1147 }
1148
1149 /* ACPI 1.0b: 6.4.3.5.1 QWord Address Space Descriptor */
1150 static Aml *aml_qword_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
1151 AmlMaxFixed max_fixed, AmlDecode dec,
1152 uint64_t addr_gran, uint64_t addr_min,
1153 uint64_t addr_max, uint64_t addr_trans,
1154 uint64_t len, uint8_t type_flags)
1155 {
1156 Aml *var = aml_alloc();
1157
1158 build_append_byte(var->buf, 0x8A); /* QWord Address Space Descriptor */
1159 /* minimum length since we do not encode optional fields */
1160 build_append_byte(var->buf, 0x2B);
1161 build_append_byte(var->buf, 0x0);
1162
1163 aml_append(var,
1164 aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
1165 build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
1166 build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
1167 build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
1168 build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
1169 build_append_int_noprefix(var->buf, len, sizeof(len));
1170 return var;
1171 }
1172
1173 /*
1174 * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
1175 *
1176 * More verbose description at:
1177 * ACPI 5.0: 19.5.141 WordBusNumber (Word Bus Number Resource Descriptor Macro)
1178 */
1179 Aml *aml_word_bus_number(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1180 AmlDecode dec, uint16_t addr_gran,
1181 uint16_t addr_min, uint16_t addr_max,
1182 uint16_t addr_trans, uint16_t len)
1183
1184 {
1185 return aml_word_as_desc(AML_BUS_NUMBER_RANGE, min_fixed, max_fixed, dec,
1186 addr_gran, addr_min, addr_max, addr_trans, len, 0);
1187 }
1188
1189 /*
1190 * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
1191 *
1192 * More verbose description at:
1193 * ACPI 5.0: 19.5.142 WordIO (Word IO Resource Descriptor Macro)
1194 */
1195 Aml *aml_word_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1196 AmlDecode dec, AmlISARanges isa_ranges,
1197 uint16_t addr_gran, uint16_t addr_min,
1198 uint16_t addr_max, uint16_t addr_trans,
1199 uint16_t len)
1200
1201 {
1202 return aml_word_as_desc(AML_IO_RANGE, min_fixed, max_fixed, dec,
1203 addr_gran, addr_min, addr_max, addr_trans, len,
1204 isa_ranges);
1205 }
1206
1207 /*
1208 * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Descriptor
1209 *
1210 * More verbose description at:
1211 * ACPI 5.0: 19.5.33 DWordIO (DWord IO Resource Descriptor Macro)
1212 */
1213 Aml *aml_dword_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1214 AmlDecode dec, AmlISARanges isa_ranges,
1215 uint32_t addr_gran, uint32_t addr_min,
1216 uint32_t addr_max, uint32_t addr_trans,
1217 uint32_t len)
1218
1219 {
1220 return aml_dword_as_desc(AML_IO_RANGE, min_fixed, max_fixed, dec,
1221 addr_gran, addr_min, addr_max, addr_trans, len,
1222 isa_ranges);
1223 }
1224
1225 /*
1226 * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Space Descriptor
1227 *
1228 * More verbose description at:
1229 * ACPI 5.0: 19.5.34 DWordMemory (DWord Memory Resource Descriptor Macro)
1230 */
1231 Aml *aml_dword_memory(AmlDecode dec, AmlMinFixed min_fixed,
1232 AmlMaxFixed max_fixed, AmlCacheable cacheable,
1233 AmlReadAndWrite read_and_write,
1234 uint32_t addr_gran, uint32_t addr_min,
1235 uint32_t addr_max, uint32_t addr_trans,
1236 uint32_t len)
1237 {
1238 uint8_t flags = read_and_write | (cacheable << 1);
1239
1240 return aml_dword_as_desc(AML_MEMORY_RANGE, min_fixed, max_fixed,
1241 dec, addr_gran, addr_min, addr_max,
1242 addr_trans, len, flags);
1243 }
1244
1245 /*
1246 * ACPI 1.0b: 6.4.3.5.2 ASL Macros for QWORD Address Space Descriptor
1247 *
1248 * More verbose description at:
1249 * ACPI 5.0: 19.5.102 QWordMemory (QWord Memory Resource Descriptor Macro)
1250 */
1251 Aml *aml_qword_memory(AmlDecode dec, AmlMinFixed min_fixed,
1252 AmlMaxFixed max_fixed, AmlCacheable cacheable,
1253 AmlReadAndWrite read_and_write,
1254 uint64_t addr_gran, uint64_t addr_min,
1255 uint64_t addr_max, uint64_t addr_trans,
1256 uint64_t len)
1257 {
1258 uint8_t flags = read_and_write | (cacheable << 1);
1259
1260 return aml_qword_as_desc(AML_MEMORY_RANGE, min_fixed, max_fixed,
1261 dec, addr_gran, addr_min, addr_max,
1262 addr_trans, len, flags);
1263 }
1264
1265 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefSleep */
1266 Aml *aml_sleep(uint64_t msec)
1267 {
1268 Aml *var = aml_alloc();
1269 build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
1270 build_append_byte(var->buf, 0x22); /* SleepOp */
1271 aml_append(var, aml_int(msec));
1272 return var;
1273 }
1274
1275 static uint8_t Hex2Byte(const char *src)
1276 {
1277 int hi, lo;
1278
1279 hi = Hex2Digit(src[0]);
1280 assert(hi >= 0);
1281 assert(hi <= 15);
1282
1283 lo = Hex2Digit(src[1]);
1284 assert(lo >= 0);
1285 assert(lo <= 15);
1286 return (hi << 4) | lo;
1287 }
1288
1289 /*
1290 * ACPI 3.0: 17.5.124 ToUUID (Convert String to UUID Macro)
1291 * e.g. UUID: aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
1292 * call aml_touuid("aabbccdd-eeff-gghh-iijj-kkllmmnnoopp");
1293 */
1294 Aml *aml_touuid(const char *uuid)
1295 {
1296 Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
1297
1298 assert(strlen(uuid) == 36);
1299 assert(uuid[8] == '-');
1300 assert(uuid[13] == '-');
1301 assert(uuid[18] == '-');
1302 assert(uuid[23] == '-');
1303
1304 build_append_byte(var->buf, Hex2Byte(uuid + 6)); /* dd - at offset 00 */
1305 build_append_byte(var->buf, Hex2Byte(uuid + 4)); /* cc - at offset 01 */
1306 build_append_byte(var->buf, Hex2Byte(uuid + 2)); /* bb - at offset 02 */
1307 build_append_byte(var->buf, Hex2Byte(uuid + 0)); /* aa - at offset 03 */
1308
1309 build_append_byte(var->buf, Hex2Byte(uuid + 11)); /* ff - at offset 04 */
1310 build_append_byte(var->buf, Hex2Byte(uuid + 9)); /* ee - at offset 05 */
1311
1312 build_append_byte(var->buf, Hex2Byte(uuid + 16)); /* hh - at offset 06 */
1313 build_append_byte(var->buf, Hex2Byte(uuid + 14)); /* gg - at offset 07 */
1314
1315 build_append_byte(var->buf, Hex2Byte(uuid + 19)); /* ii - at offset 08 */
1316 build_append_byte(var->buf, Hex2Byte(uuid + 21)); /* jj - at offset 09 */
1317
1318 build_append_byte(var->buf, Hex2Byte(uuid + 24)); /* kk - at offset 10 */
1319 build_append_byte(var->buf, Hex2Byte(uuid + 26)); /* ll - at offset 11 */
1320 build_append_byte(var->buf, Hex2Byte(uuid + 28)); /* mm - at offset 12 */
1321 build_append_byte(var->buf, Hex2Byte(uuid + 30)); /* nn - at offset 13 */
1322 build_append_byte(var->buf, Hex2Byte(uuid + 32)); /* oo - at offset 14 */
1323 build_append_byte(var->buf, Hex2Byte(uuid + 34)); /* pp - at offset 15 */
1324
1325 return var;
1326 }
1327
1328 /*
1329 * ACPI 2.0b: 16.2.3.6.4.3 Unicode Macro (Convert Ascii String To Unicode)
1330 */
1331 Aml *aml_unicode(const char *str)
1332 {
1333 int i = 0;
1334 Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
1335
1336 do {
1337 build_append_byte(var->buf, str[i]);
1338 build_append_byte(var->buf, 0);
1339 i++;
1340 } while (i <= strlen(str));
1341
1342 return var;
1343 }
1344
1345 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefDerefOf */
1346 Aml *aml_derefof(Aml *arg)
1347 {
1348 Aml *var = aml_opcode(0x83 /* DerefOfOp */);
1349 aml_append(var, arg);
1350 return var;
1351 }
1352
1353 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefSizeOf */
1354 Aml *aml_sizeof(Aml *arg)
1355 {
1356 Aml *var = aml_opcode(0x87 /* SizeOfOp */);
1357 aml_append(var, arg);
1358 return var;
1359 }
1360
1361 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefMutex */
1362 Aml *aml_mutex(const char *name, uint8_t sync_level)
1363 {
1364 Aml *var = aml_alloc();
1365 build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
1366 build_append_byte(var->buf, 0x01); /* MutexOp */
1367 build_append_namestring(var->buf, "%s", name);
1368 assert(!(sync_level & 0xF0));
1369 build_append_byte(var->buf, sync_level);
1370 return var;
1371 }
1372
1373 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAcquire */
1374 Aml *aml_acquire(Aml *mutex, uint16_t timeout)
1375 {
1376 Aml *var = aml_alloc();
1377 build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
1378 build_append_byte(var->buf, 0x23); /* AcquireOp */
1379 aml_append(var, mutex);
1380 build_append_int_noprefix(var->buf, timeout, sizeof(timeout));
1381 return var;
1382 }
1383
1384 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefRelease */
1385 Aml *aml_release(Aml *mutex)
1386 {
1387 Aml *var = aml_alloc();
1388 build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
1389 build_append_byte(var->buf, 0x27); /* ReleaseOp */
1390 aml_append(var, mutex);
1391 return var;
1392 }
1393
1394 /* ACPI 1.0b: 16.2.5.1 Name Space Modifier Objects Encoding: DefAlias */
1395 Aml *aml_alias(const char *source_object, const char *alias_object)
1396 {
1397 Aml *var = aml_opcode(0x06 /* AliasOp */);
1398 aml_append(var, aml_name("%s", source_object));
1399 aml_append(var, aml_name("%s", alias_object));
1400 return var;
1401 }
1402
1403 void
1404 build_header(GArray *linker, GArray *table_data,
1405 AcpiTableHeader *h, const char *sig, int len, uint8_t rev,
1406 const char *oem_table_id)
1407 {
1408 memcpy(&h->signature, sig, 4);
1409 h->length = cpu_to_le32(len);
1410 h->revision = rev;
1411 memcpy(h->oem_id, ACPI_BUILD_APPNAME6, 6);
1412
1413 if (oem_table_id) {
1414 strncpy((char *)h->oem_table_id, oem_table_id, sizeof(h->oem_table_id));
1415 } else {
1416 memcpy(h->oem_table_id, ACPI_BUILD_APPNAME4, 4);
1417 memcpy(h->oem_table_id + 4, sig, 4);
1418 }
1419
1420 h->oem_revision = cpu_to_le32(1);
1421 memcpy(h->asl_compiler_id, ACPI_BUILD_APPNAME4, 4);
1422 h->asl_compiler_revision = cpu_to_le32(1);
1423 h->checksum = 0;
1424 /* Checksum to be filled in by Guest linker */
1425 bios_linker_loader_add_checksum(linker, ACPI_BUILD_TABLE_FILE,
1426 table_data->data, h, len, &h->checksum);
1427 }
1428
1429 void *acpi_data_push(GArray *table_data, unsigned size)
1430 {
1431 unsigned off = table_data->len;
1432 g_array_set_size(table_data, off + size);
1433 return table_data->data + off;
1434 }
1435
1436 unsigned acpi_data_len(GArray *table)
1437 {
1438 assert(g_array_get_element_size(table) == 1);
1439 return table->len;
1440 }
1441
1442 void acpi_add_table(GArray *table_offsets, GArray *table_data)
1443 {
1444 uint32_t offset = cpu_to_le32(table_data->len);
1445 g_array_append_val(table_offsets, offset);
1446 }
1447
1448 void acpi_build_tables_init(AcpiBuildTables *tables)
1449 {
1450 tables->rsdp = g_array_new(false, true /* clear */, 1);
1451 tables->table_data = g_array_new(false, true /* clear */, 1);
1452 tables->tcpalog = g_array_new(false, true /* clear */, 1);
1453 tables->linker = bios_linker_loader_init();
1454 }
1455
1456 void acpi_build_tables_cleanup(AcpiBuildTables *tables, bool mfre)
1457 {
1458 void *linker_data = bios_linker_loader_cleanup(tables->linker);
1459 g_free(linker_data);
1460 g_array_free(tables->rsdp, true);
1461 g_array_free(tables->table_data, true);
1462 g_array_free(tables->tcpalog, mfre);
1463 }
1464
1465 /* Build rsdt table */
1466 void
1467 build_rsdt(GArray *table_data, GArray *linker, GArray *table_offsets)
1468 {
1469 AcpiRsdtDescriptorRev1 *rsdt;
1470 size_t rsdt_len;
1471 int i;
1472 const int table_data_len = (sizeof(uint32_t) * table_offsets->len);
1473
1474 rsdt_len = sizeof(*rsdt) + table_data_len;
1475 rsdt = acpi_data_push(table_data, rsdt_len);
1476 memcpy(rsdt->table_offset_entry, table_offsets->data, table_data_len);
1477 for (i = 0; i < table_offsets->len; ++i) {
1478 /* rsdt->table_offset_entry to be filled by Guest linker */
1479 bios_linker_loader_add_pointer(linker,
1480 ACPI_BUILD_TABLE_FILE,
1481 ACPI_BUILD_TABLE_FILE,
1482 table_data, &rsdt->table_offset_entry[i],
1483 sizeof(uint32_t));
1484 }
1485 build_header(linker, table_data,
1486 (void *)rsdt, "RSDT", rsdt_len, 1, NULL);
1487 }
QEmu