]> Git Repo - qemu.git/blob - hw/acpi/aml-build.c
acpi: extend aml_interrupt() to support multiple irqs
[qemu.git] / hw / acpi / aml-build.c
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 <[email protected]>
6  * Author: Igor Mammedov <[email protected]>
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 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefStore */
431 Aml *aml_store(Aml *val, Aml *target)
432 {
433     Aml *var = aml_opcode(0x70 /* StoreOp */);
434     aml_append(var, val);
435     aml_append(var, target);
436     return var;
437 }
438
439 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAnd */
440 Aml *aml_and(Aml *arg1, Aml *arg2)
441 {
442     Aml *var = aml_opcode(0x7B /* AndOp */);
443     aml_append(var, arg1);
444     aml_append(var, arg2);
445     build_append_byte(var->buf, 0x00 /* NullNameOp */);
446     return var;
447 }
448
449 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefOr */
450 Aml *aml_or(Aml *arg1, Aml *arg2)
451 {
452     Aml *var = aml_opcode(0x7D /* OrOp */);
453     aml_append(var, arg1);
454     aml_append(var, arg2);
455     build_append_byte(var->buf, 0x00 /* NullNameOp */);
456     return var;
457 }
458
459 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefShiftLeft */
460 Aml *aml_shiftleft(Aml *arg1, Aml *count)
461 {
462     Aml *var = aml_opcode(0x79 /* ShiftLeftOp */);
463     aml_append(var, arg1);
464     aml_append(var, count);
465     build_append_byte(var->buf, 0x00); /* NullNameOp */
466     return var;
467 }
468
469 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefShiftRight */
470 Aml *aml_shiftright(Aml *arg1, Aml *count)
471 {
472     Aml *var = aml_opcode(0x7A /* ShiftRightOp */);
473     aml_append(var, arg1);
474     aml_append(var, count);
475     build_append_byte(var->buf, 0x00); /* NullNameOp */
476     return var;
477 }
478
479 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLLess */
480 Aml *aml_lless(Aml *arg1, Aml *arg2)
481 {
482     Aml *var = aml_opcode(0x95 /* LLessOp */);
483     aml_append(var, arg1);
484     aml_append(var, arg2);
485     return var;
486 }
487
488 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefAdd */
489 Aml *aml_add(Aml *arg1, Aml *arg2)
490 {
491     Aml *var = aml_opcode(0x72 /* AddOp */);
492     aml_append(var, arg1);
493     aml_append(var, arg2);
494     build_append_byte(var->buf, 0x00 /* NullNameOp */);
495     return var;
496 }
497
498 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefIncrement */
499 Aml *aml_increment(Aml *arg)
500 {
501     Aml *var = aml_opcode(0x75 /* IncrementOp */);
502     aml_append(var, arg);
503     return var;
504 }
505
506 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefIndex */
507 Aml *aml_index(Aml *arg1, Aml *idx)
508 {
509     Aml *var = aml_opcode(0x88 /* IndexOp */);
510     aml_append(var, arg1);
511     aml_append(var, idx);
512     build_append_byte(var->buf, 0x00 /* NullNameOp */);
513     return var;
514 }
515
516 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefNotify */
517 Aml *aml_notify(Aml *arg1, Aml *arg2)
518 {
519     Aml *var = aml_opcode(0x86 /* NotifyOp */);
520     aml_append(var, arg1);
521     aml_append(var, arg2);
522     return var;
523 }
524
525 /* helper to call method with 1 argument */
526 Aml *aml_call1(const char *method, Aml *arg1)
527 {
528     Aml *var = aml_alloc();
529     build_append_namestring(var->buf, "%s", method);
530     aml_append(var, arg1);
531     return var;
532 }
533
534 /* helper to call method with 2 arguments */
535 Aml *aml_call2(const char *method, Aml *arg1, Aml *arg2)
536 {
537     Aml *var = aml_alloc();
538     build_append_namestring(var->buf, "%s", method);
539     aml_append(var, arg1);
540     aml_append(var, arg2);
541     return var;
542 }
543
544 /* helper to call method with 3 arguments */
545 Aml *aml_call3(const char *method, Aml *arg1, Aml *arg2, Aml *arg3)
546 {
547     Aml *var = aml_alloc();
548     build_append_namestring(var->buf, "%s", method);
549     aml_append(var, arg1);
550     aml_append(var, arg2);
551     aml_append(var, arg3);
552     return var;
553 }
554
555 /* helper to call method with 4 arguments */
556 Aml *aml_call4(const char *method, Aml *arg1, Aml *arg2, Aml *arg3, Aml *arg4)
557 {
558     Aml *var = aml_alloc();
559     build_append_namestring(var->buf, "%s", method);
560     aml_append(var, arg1);
561     aml_append(var, arg2);
562     aml_append(var, arg3);
563     aml_append(var, arg4);
564     return var;
565 }
566
567 /*
568  * ACPI 1.0b: 6.4.3.4 32-Bit Fixed Location Memory Range Descriptor
569  * (Type 1, Large Item Name 0x6)
570  */
571 Aml *aml_memory32_fixed(uint32_t addr, uint32_t size,
572                         AmlReadAndWrite read_and_write)
573 {
574     Aml *var = aml_alloc();
575     build_append_byte(var->buf, 0x86); /* Memory32Fixed Resource Descriptor */
576     build_append_byte(var->buf, 9);    /* Length, bits[7:0] value = 9 */
577     build_append_byte(var->buf, 0);    /* Length, bits[15:8] value = 0 */
578     build_append_byte(var->buf, read_and_write); /* Write status, 1 rw 0 ro */
579
580     /* Range base address */
581     build_append_byte(var->buf, extract32(addr, 0, 8));  /* bits[7:0] */
582     build_append_byte(var->buf, extract32(addr, 8, 8));  /* bits[15:8] */
583     build_append_byte(var->buf, extract32(addr, 16, 8)); /* bits[23:16] */
584     build_append_byte(var->buf, extract32(addr, 24, 8)); /* bits[31:24] */
585
586     /* Range length */
587     build_append_byte(var->buf, extract32(size, 0, 8));  /* bits[7:0] */
588     build_append_byte(var->buf, extract32(size, 8, 8));  /* bits[15:8] */
589     build_append_byte(var->buf, extract32(size, 16, 8)); /* bits[23:16] */
590     build_append_byte(var->buf, extract32(size, 24, 8)); /* bits[31:24] */
591     return var;
592 }
593
594 /*
595  * ACPI 5.0: 6.4.3.6 Extended Interrupt Descriptor
596  * Type 1, Large Item Name 0x9
597  */
598 Aml *aml_interrupt(AmlConsumerAndProducer con_and_pro,
599                    AmlLevelAndEdge level_and_edge,
600                    AmlActiveHighAndLow high_and_low, AmlShared shared,
601                    uint32_t *irq_list, uint8_t irq_count)
602 {
603     int i;
604     Aml *var = aml_alloc();
605     uint8_t irq_flags = con_and_pro | (level_and_edge << 1)
606                         | (high_and_low << 2) | (shared << 3);
607     const int header_bytes_in_len = 2;
608     uint16_t len = header_bytes_in_len + irq_count * sizeof(uint32_t);
609
610     assert(irq_count > 0);
611
612     build_append_byte(var->buf, 0x89); /* Extended irq descriptor */
613     build_append_byte(var->buf, len & 0xFF); /* Length, bits[7:0] */
614     build_append_byte(var->buf, len >> 8); /* Length, bits[15:8] */
615     build_append_byte(var->buf, irq_flags); /* Interrupt Vector Information. */
616     build_append_byte(var->buf, irq_count);   /* Interrupt table length */
617
618     /* Interrupt Number List */
619     for (i = 0; i < irq_count; i++) {
620         build_append_int_noprefix(var->buf, irq_list[i], 4);
621     }
622     return var;
623 }
624
625 /* ACPI 1.0b: 6.4.2.5 I/O Port Descriptor */
626 Aml *aml_io(AmlIODecode dec, uint16_t min_base, uint16_t max_base,
627             uint8_t aln, uint8_t len)
628 {
629     Aml *var = aml_alloc();
630     build_append_byte(var->buf, 0x47); /* IO port descriptor */
631     build_append_byte(var->buf, dec);
632     build_append_byte(var->buf, min_base & 0xff);
633     build_append_byte(var->buf, (min_base >> 8) & 0xff);
634     build_append_byte(var->buf, max_base & 0xff);
635     build_append_byte(var->buf, (max_base >> 8) & 0xff);
636     build_append_byte(var->buf, aln);
637     build_append_byte(var->buf, len);
638     return var;
639 }
640
641 /*
642  * ACPI 1.0b: 6.4.2.1.1 ASL Macro for IRQ Descriptor
643  *
644  * More verbose description at:
645  * ACPI 5.0: 19.5.64 IRQNoFlags (Interrupt Resource Descriptor Macro)
646  *           6.4.2.1 IRQ Descriptor
647  */
648 Aml *aml_irq_no_flags(uint8_t irq)
649 {
650     uint16_t irq_mask;
651     Aml *var = aml_alloc();
652
653     assert(irq < 16);
654     build_append_byte(var->buf, 0x22); /* IRQ descriptor 2 byte form */
655
656     irq_mask = 1U << irq;
657     build_append_byte(var->buf, irq_mask & 0xFF); /* IRQ mask bits[7:0] */
658     build_append_byte(var->buf, irq_mask >> 8); /* IRQ mask bits[15:8] */
659     return var;
660 }
661
662 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLNot */
663 Aml *aml_lnot(Aml *arg)
664 {
665     Aml *var = aml_opcode(0x92 /* LNotOp */);
666     aml_append(var, arg);
667     return var;
668 }
669
670 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefLEqual */
671 Aml *aml_equal(Aml *arg1, Aml *arg2)
672 {
673     Aml *var = aml_opcode(0x93 /* LequalOp */);
674     aml_append(var, arg1);
675     aml_append(var, arg2);
676     return var;
677 }
678
679 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefIfElse */
680 Aml *aml_if(Aml *predicate)
681 {
682     Aml *var = aml_bundle(0xA0 /* IfOp */, AML_PACKAGE);
683     aml_append(var, predicate);
684     return var;
685 }
686
687 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefElse */
688 Aml *aml_else(void)
689 {
690     Aml *var = aml_bundle(0xA1 /* ElseOp */, AML_PACKAGE);
691     return var;
692 }
693
694 /* ACPI 1.0b: 16.2.5.3 Type 1 Opcodes Encoding: DefWhile */
695 Aml *aml_while(Aml *predicate)
696 {
697     Aml *var = aml_bundle(0xA2 /* WhileOp */, AML_PACKAGE);
698     aml_append(var, predicate);
699     return var;
700 }
701
702 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefMethod */
703 Aml *aml_method(const char *name, int arg_count, AmlSerializeFlag sflag)
704 {
705     Aml *var = aml_bundle(0x14 /* MethodOp */, AML_PACKAGE);
706     int methodflags;
707
708     /*
709      * MethodFlags:
710      *   bit 0-2: ArgCount (0-7)
711      *   bit 3: SerializeFlag
712      *     0: NotSerialized
713      *     1: Serialized
714      *   bit 4-7: reserved (must be 0)
715      */
716     assert(arg_count < 8);
717     methodflags = arg_count | (sflag << 3);
718
719     build_append_namestring(var->buf, "%s", name);
720     build_append_byte(var->buf, methodflags); /* MethodFlags: ArgCount */
721     return var;
722 }
723
724 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefDevice */
725 Aml *aml_device(const char *name_format, ...)
726 {
727     va_list ap;
728     Aml *var = aml_bundle(0x82 /* DeviceOp */, AML_EXT_PACKAGE);
729     va_start(ap, name_format);
730     build_append_namestringv(var->buf, name_format, ap);
731     va_end(ap);
732     return var;
733 }
734
735 /* ACPI 1.0b: 6.4.1 ASL Macros for Resource Descriptors */
736 Aml *aml_resource_template(void)
737 {
738     /* ResourceTemplate is a buffer of Resources with EndTag at the end */
739     Aml *var = aml_bundle(0x11 /* BufferOp */, AML_RES_TEMPLATE);
740     return var;
741 }
742
743 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefBuffer
744  * Pass byte_list as NULL to request uninitialized buffer to reserve space.
745  */
746 Aml *aml_buffer(int buffer_size, uint8_t *byte_list)
747 {
748     int i;
749     Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
750
751     for (i = 0; i < buffer_size; i++) {
752         if (byte_list == NULL) {
753             build_append_byte(var->buf, 0x0);
754         } else {
755             build_append_byte(var->buf, byte_list[i]);
756         }
757     }
758
759     return var;
760 }
761
762 /* ACPI 1.0b: 16.2.5.4 Type 2 Opcodes Encoding: DefPackage */
763 Aml *aml_package(uint8_t num_elements)
764 {
765     Aml *var = aml_bundle(0x12 /* PackageOp */, AML_PACKAGE);
766     build_append_byte(var->buf, num_elements);
767     return var;
768 }
769
770 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefOpRegion */
771 Aml *aml_operation_region(const char *name, AmlRegionSpace rs,
772                           uint32_t offset, uint32_t len)
773 {
774     Aml *var = aml_alloc();
775     build_append_byte(var->buf, 0x5B); /* ExtOpPrefix */
776     build_append_byte(var->buf, 0x80); /* OpRegionOp */
777     build_append_namestring(var->buf, "%s", name);
778     build_append_byte(var->buf, rs);
779     build_append_int(var->buf, offset);
780     build_append_int(var->buf, len);
781     return var;
782 }
783
784 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: NamedField */
785 Aml *aml_named_field(const char *name, unsigned length)
786 {
787     Aml *var = aml_alloc();
788     build_append_nameseg(var->buf, name);
789     build_append_pkg_length(var->buf, length, false);
790     return var;
791 }
792
793 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: ReservedField */
794 Aml *aml_reserved_field(unsigned length)
795 {
796     Aml *var = aml_alloc();
797     /* ReservedField  := 0x00 PkgLength */
798     build_append_byte(var->buf, 0x00);
799     build_append_pkg_length(var->buf, length, false);
800     return var;
801 }
802
803 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefField */
804 Aml *aml_field(const char *name, AmlAccessType type, AmlUpdateRule rule)
805 {
806     Aml *var = aml_bundle(0x81 /* FieldOp */, AML_EXT_PACKAGE);
807     uint8_t flags = rule << 5 | type;
808
809     build_append_namestring(var->buf, "%s", name);
810     build_append_byte(var->buf, flags);
811     return var;
812 }
813
814 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefCreateDWordField */
815 Aml *aml_create_dword_field(Aml *srcbuf, Aml *index, const char *name)
816 {
817     Aml *var = aml_alloc();
818     build_append_byte(var->buf, 0x8A); /* CreateDWordFieldOp */
819     aml_append(var, srcbuf);
820     aml_append(var, index);
821     build_append_namestring(var->buf, "%s", name);
822     return var;
823 }
824
825 /* ACPI 1.0b: 16.2.3 Data Objects Encoding: String */
826 Aml *aml_string(const char *name_format, ...)
827 {
828     Aml *var = aml_opcode(0x0D /* StringPrefix */);
829     va_list ap;
830     char *s;
831     int len;
832
833     va_start(ap, name_format);
834     len = g_vasprintf(&s, name_format, ap);
835     va_end(ap);
836
837     g_array_append_vals(var->buf, s, len + 1);
838     g_free(s);
839
840     return var;
841 }
842
843 /* ACPI 1.0b: 16.2.6.2 Local Objects Encoding */
844 Aml *aml_local(int num)
845 {
846     Aml *var;
847     uint8_t op = 0x60 /* Local0Op */ + num;
848
849     assert(num <= 7);
850     var = aml_opcode(op);
851     return var;
852 }
853
854 /* ACPI 2.0a: 17.2.2 Data Objects Encoding: DefVarPackage */
855 Aml *aml_varpackage(uint32_t num_elements)
856 {
857     Aml *var = aml_bundle(0x13 /* VarPackageOp */, AML_PACKAGE);
858     build_append_int(var->buf, num_elements);
859     return var;
860 }
861
862 /* ACPI 1.0b: 16.2.5.2 Named Objects Encoding: DefProcessor */
863 Aml *aml_processor(uint8_t proc_id, uint32_t pblk_addr, uint8_t pblk_len,
864                    const char *name_format, ...)
865 {
866     va_list ap;
867     Aml *var = aml_bundle(0x83 /* ProcessorOp */, AML_EXT_PACKAGE);
868     va_start(ap, name_format);
869     build_append_namestringv(var->buf, name_format, ap);
870     va_end(ap);
871     build_append_byte(var->buf, proc_id); /* ProcID */
872     build_append_int_noprefix(var->buf, pblk_addr, sizeof(pblk_addr));
873     build_append_byte(var->buf, pblk_len); /* PblkLen */
874     return var;
875 }
876
877 static uint8_t Hex2Digit(char c)
878 {
879     if (c >= 'A') {
880         return c - 'A' + 10;
881     }
882
883     return c - '0';
884 }
885
886 /* ACPI 1.0b: 15.2.3.6.4.1 EISAID Macro - Convert EISA ID String To Integer */
887 Aml *aml_eisaid(const char *str)
888 {
889     Aml *var = aml_alloc();
890     uint32_t id;
891
892     g_assert(strlen(str) == 7);
893     id = (str[0] - 0x40) << 26 |
894     (str[1] - 0x40) << 21 |
895     (str[2] - 0x40) << 16 |
896     Hex2Digit(str[3]) << 12 |
897     Hex2Digit(str[4]) << 8 |
898     Hex2Digit(str[5]) << 4 |
899     Hex2Digit(str[6]);
900
901     build_append_byte(var->buf, 0x0C); /* DWordPrefix */
902     build_append_int_noprefix(var->buf, bswap32(id), sizeof(id));
903     return var;
904 }
905
906 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor: bytes 3-5 */
907 static Aml *aml_as_desc_header(AmlResourceType type, AmlMinFixed min_fixed,
908                                AmlMaxFixed max_fixed, AmlDecode dec,
909                                uint8_t type_flags)
910 {
911     uint8_t flags = max_fixed | min_fixed | dec;
912     Aml *var = aml_alloc();
913
914     build_append_byte(var->buf, type);
915     build_append_byte(var->buf, flags);
916     build_append_byte(var->buf, type_flags); /* Type Specific Flags */
917     return var;
918 }
919
920 /* ACPI 1.0b: 6.4.3.5.5 Word Address Space Descriptor */
921 static Aml *aml_word_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
922                              AmlMaxFixed max_fixed, AmlDecode dec,
923                              uint16_t addr_gran, uint16_t addr_min,
924                              uint16_t addr_max, uint16_t addr_trans,
925                              uint16_t len, uint8_t type_flags)
926 {
927     Aml *var = aml_alloc();
928
929     build_append_byte(var->buf, 0x88); /* Word Address Space Descriptor */
930     /* minimum length since we do not encode optional fields */
931     build_append_byte(var->buf, 0x0D);
932     build_append_byte(var->buf, 0x0);
933
934     aml_append(var,
935         aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
936     build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
937     build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
938     build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
939     build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
940     build_append_int_noprefix(var->buf, len, sizeof(len));
941     return var;
942 }
943
944 /* ACPI 1.0b: 6.4.3.5.3 DWord Address Space Descriptor */
945 static Aml *aml_dword_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
946                               AmlMaxFixed max_fixed, AmlDecode dec,
947                               uint32_t addr_gran, uint32_t addr_min,
948                               uint32_t addr_max, uint32_t addr_trans,
949                               uint32_t len, uint8_t type_flags)
950 {
951     Aml *var = aml_alloc();
952
953     build_append_byte(var->buf, 0x87); /* DWord Address Space Descriptor */
954     /* minimum length since we do not encode optional fields */
955     build_append_byte(var->buf, 23);
956     build_append_byte(var->buf, 0x0);
957
958
959     aml_append(var,
960         aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
961     build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
962     build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
963     build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
964     build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
965     build_append_int_noprefix(var->buf, len, sizeof(len));
966     return var;
967 }
968
969 /* ACPI 1.0b: 6.4.3.5.1 QWord Address Space Descriptor */
970 static Aml *aml_qword_as_desc(AmlResourceType type, AmlMinFixed min_fixed,
971                               AmlMaxFixed max_fixed, AmlDecode dec,
972                               uint64_t addr_gran, uint64_t addr_min,
973                               uint64_t addr_max, uint64_t addr_trans,
974                               uint64_t len, uint8_t type_flags)
975 {
976     Aml *var = aml_alloc();
977
978     build_append_byte(var->buf, 0x8A); /* QWord Address Space Descriptor */
979     /* minimum length since we do not encode optional fields */
980     build_append_byte(var->buf, 0x2B);
981     build_append_byte(var->buf, 0x0);
982
983     aml_append(var,
984         aml_as_desc_header(type, min_fixed, max_fixed, dec, type_flags));
985     build_append_int_noprefix(var->buf, addr_gran, sizeof(addr_gran));
986     build_append_int_noprefix(var->buf, addr_min, sizeof(addr_min));
987     build_append_int_noprefix(var->buf, addr_max, sizeof(addr_max));
988     build_append_int_noprefix(var->buf, addr_trans, sizeof(addr_trans));
989     build_append_int_noprefix(var->buf, len, sizeof(len));
990     return var;
991 }
992
993 /*
994  * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
995  *
996  * More verbose description at:
997  * ACPI 5.0: 19.5.141 WordBusNumber (Word Bus Number Resource Descriptor Macro)
998  */
999 Aml *aml_word_bus_number(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1000                          AmlDecode dec, uint16_t addr_gran,
1001                          uint16_t addr_min, uint16_t addr_max,
1002                          uint16_t addr_trans, uint16_t len)
1003
1004 {
1005     return aml_word_as_desc(AML_BUS_NUMBER_RANGE, min_fixed, max_fixed, dec,
1006                             addr_gran, addr_min, addr_max, addr_trans, len, 0);
1007 }
1008
1009 /*
1010  * ACPI 1.0b: 6.4.3.5.6 ASL Macros for WORD Address Descriptor
1011  *
1012  * More verbose description at:
1013  * ACPI 5.0: 19.5.142 WordIO (Word IO Resource Descriptor Macro)
1014  */
1015 Aml *aml_word_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1016                  AmlDecode dec, AmlISARanges isa_ranges,
1017                  uint16_t addr_gran, uint16_t addr_min,
1018                  uint16_t addr_max, uint16_t addr_trans,
1019                  uint16_t len)
1020
1021 {
1022     return aml_word_as_desc(AML_IO_RANGE, min_fixed, max_fixed, dec,
1023                             addr_gran, addr_min, addr_max, addr_trans, len,
1024                             isa_ranges);
1025 }
1026
1027 /*
1028  * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Descriptor
1029  *
1030  * More verbose description at:
1031  * ACPI 5.0: 19.5.33 DWordIO (DWord IO Resource Descriptor Macro)
1032  */
1033 Aml *aml_dword_io(AmlMinFixed min_fixed, AmlMaxFixed max_fixed,
1034                  AmlDecode dec, AmlISARanges isa_ranges,
1035                  uint32_t addr_gran, uint32_t addr_min,
1036                  uint32_t addr_max, uint32_t addr_trans,
1037                  uint32_t len)
1038
1039 {
1040     return aml_dword_as_desc(AML_IO_RANGE, min_fixed, max_fixed, dec,
1041                             addr_gran, addr_min, addr_max, addr_trans, len,
1042                             isa_ranges);
1043 }
1044
1045 /*
1046  * ACPI 1.0b: 6.4.3.5.4 ASL Macros for DWORD Address Space Descriptor
1047  *
1048  * More verbose description at:
1049  * ACPI 5.0: 19.5.34 DWordMemory (DWord Memory Resource Descriptor Macro)
1050  */
1051 Aml *aml_dword_memory(AmlDecode dec, AmlMinFixed min_fixed,
1052                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
1053                       AmlReadAndWrite read_and_write,
1054                       uint32_t addr_gran, uint32_t addr_min,
1055                       uint32_t addr_max, uint32_t addr_trans,
1056                       uint32_t len)
1057 {
1058     uint8_t flags = read_and_write | (cacheable << 1);
1059
1060     return aml_dword_as_desc(AML_MEMORY_RANGE, min_fixed, max_fixed,
1061                              dec, addr_gran, addr_min, addr_max,
1062                              addr_trans, len, flags);
1063 }
1064
1065 /*
1066  * ACPI 1.0b: 6.4.3.5.2 ASL Macros for QWORD Address Space Descriptor
1067  *
1068  * More verbose description at:
1069  * ACPI 5.0: 19.5.102 QWordMemory (QWord Memory Resource Descriptor Macro)
1070  */
1071 Aml *aml_qword_memory(AmlDecode dec, AmlMinFixed min_fixed,
1072                       AmlMaxFixed max_fixed, AmlCacheable cacheable,
1073                       AmlReadAndWrite read_and_write,
1074                       uint64_t addr_gran, uint64_t addr_min,
1075                       uint64_t addr_max, uint64_t addr_trans,
1076                       uint64_t len)
1077 {
1078     uint8_t flags = read_and_write | (cacheable << 1);
1079
1080     return aml_qword_as_desc(AML_MEMORY_RANGE, min_fixed, max_fixed,
1081                              dec, addr_gran, addr_min, addr_max,
1082                              addr_trans, len, flags);
1083 }
1084
1085 static uint8_t Hex2Byte(const char *src)
1086 {
1087     int hi, lo;
1088
1089     hi = Hex2Digit(src[0]);
1090     assert(hi >= 0);
1091     assert(hi <= 15);
1092
1093     lo = Hex2Digit(src[1]);
1094     assert(lo >= 0);
1095     assert(lo <= 15);
1096     return (hi << 4) | lo;
1097 }
1098
1099 /*
1100  * ACPI 3.0: 17.5.124 ToUUID (Convert String to UUID Macro)
1101  * e.g. UUID: aabbccdd-eeff-gghh-iijj-kkllmmnnoopp
1102  * call aml_touuid("aabbccdd-eeff-gghh-iijj-kkllmmnnoopp");
1103  */
1104 Aml *aml_touuid(const char *uuid)
1105 {
1106     Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
1107
1108     assert(strlen(uuid) == 36);
1109     assert(uuid[8] == '-');
1110     assert(uuid[13] == '-');
1111     assert(uuid[18] == '-');
1112     assert(uuid[23] == '-');
1113
1114     build_append_byte(var->buf, Hex2Byte(uuid + 6));  /* dd - at offset 00 */
1115     build_append_byte(var->buf, Hex2Byte(uuid + 4));  /* cc - at offset 01 */
1116     build_append_byte(var->buf, Hex2Byte(uuid + 2));  /* bb - at offset 02 */
1117     build_append_byte(var->buf, Hex2Byte(uuid + 0));  /* aa - at offset 03 */
1118
1119     build_append_byte(var->buf, Hex2Byte(uuid + 11)); /* ff - at offset 04 */
1120     build_append_byte(var->buf, Hex2Byte(uuid + 9));  /* ee - at offset 05 */
1121
1122     build_append_byte(var->buf, Hex2Byte(uuid + 16)); /* hh - at offset 06 */
1123     build_append_byte(var->buf, Hex2Byte(uuid + 14)); /* gg - at offset 07 */
1124
1125     build_append_byte(var->buf, Hex2Byte(uuid + 19)); /* ii - at offset 08 */
1126     build_append_byte(var->buf, Hex2Byte(uuid + 21)); /* jj - at offset 09 */
1127
1128     build_append_byte(var->buf, Hex2Byte(uuid + 24)); /* kk - at offset 10 */
1129     build_append_byte(var->buf, Hex2Byte(uuid + 26)); /* ll - at offset 11 */
1130     build_append_byte(var->buf, Hex2Byte(uuid + 28)); /* mm - at offset 12 */
1131     build_append_byte(var->buf, Hex2Byte(uuid + 30)); /* nn - at offset 13 */
1132     build_append_byte(var->buf, Hex2Byte(uuid + 32)); /* oo - at offset 14 */
1133     build_append_byte(var->buf, Hex2Byte(uuid + 34)); /* pp - at offset 15 */
1134
1135     return var;
1136 }
1137
1138 /*
1139  * ACPI 2.0b: 16.2.3.6.4.3  Unicode Macro (Convert Ascii String To Unicode)
1140  */
1141 Aml *aml_unicode(const char *str)
1142 {
1143     int i = 0;
1144     Aml *var = aml_bundle(0x11 /* BufferOp */, AML_BUFFER);
1145
1146     do {
1147         build_append_byte(var->buf, str[i]);
1148         build_append_byte(var->buf, 0);
1149         i++;
1150     } while (i <= strlen(str));
1151
1152     return var;
1153 }
1154
1155 void
1156 build_header(GArray *linker, GArray *table_data,
1157              AcpiTableHeader *h, const char *sig, int len, uint8_t rev)
1158 {
1159     memcpy(&h->signature, sig, 4);
1160     h->length = cpu_to_le32(len);
1161     h->revision = rev;
1162     memcpy(h->oem_id, ACPI_BUILD_APPNAME6, 6);
1163     memcpy(h->oem_table_id, ACPI_BUILD_APPNAME4, 4);
1164     memcpy(h->oem_table_id + 4, sig, 4);
1165     h->oem_revision = cpu_to_le32(1);
1166     memcpy(h->asl_compiler_id, ACPI_BUILD_APPNAME4, 4);
1167     h->asl_compiler_revision = cpu_to_le32(1);
1168     h->checksum = 0;
1169     /* Checksum to be filled in by Guest linker */
1170     bios_linker_loader_add_checksum(linker, ACPI_BUILD_TABLE_FILE,
1171                                     table_data->data, h, len, &h->checksum);
1172 }
1173
1174 void *acpi_data_push(GArray *table_data, unsigned size)
1175 {
1176     unsigned off = table_data->len;
1177     g_array_set_size(table_data, off + size);
1178     return table_data->data + off;
1179 }
1180
1181 unsigned acpi_data_len(GArray *table)
1182 {
1183     assert(g_array_get_element_size(table) == 1);
1184     return table->len;
1185 }
1186
1187 void acpi_add_table(GArray *table_offsets, GArray *table_data)
1188 {
1189     uint32_t offset = cpu_to_le32(table_data->len);
1190     g_array_append_val(table_offsets, offset);
1191 }
1192
1193 void acpi_build_tables_init(AcpiBuildTables *tables)
1194 {
1195     tables->rsdp = g_array_new(false, true /* clear */, 1);
1196     tables->table_data = g_array_new(false, true /* clear */, 1);
1197     tables->tcpalog = g_array_new(false, true /* clear */, 1);
1198     tables->linker = bios_linker_loader_init();
1199 }
1200
1201 void acpi_build_tables_cleanup(AcpiBuildTables *tables, bool mfre)
1202 {
1203     void *linker_data = bios_linker_loader_cleanup(tables->linker);
1204     g_free(linker_data);
1205     g_array_free(tables->rsdp, true);
1206     g_array_free(tables->table_data, true);
1207     g_array_free(tables->tcpalog, mfre);
1208 }
1209
1210 /* Build rsdt table */
1211 void
1212 build_rsdt(GArray *table_data, GArray *linker, GArray *table_offsets)
1213 {
1214     AcpiRsdtDescriptorRev1 *rsdt;
1215     size_t rsdt_len;
1216     int i;
1217     const int table_data_len = (sizeof(uint32_t) * table_offsets->len);
1218
1219     rsdt_len = sizeof(*rsdt) + table_data_len;
1220     rsdt = acpi_data_push(table_data, rsdt_len);
1221     memcpy(rsdt->table_offset_entry, table_offsets->data, table_data_len);
1222     for (i = 0; i < table_offsets->len; ++i) {
1223         /* rsdt->table_offset_entry to be filled by Guest linker */
1224         bios_linker_loader_add_pointer(linker,
1225                                        ACPI_BUILD_TABLE_FILE,
1226                                        ACPI_BUILD_TABLE_FILE,
1227                                        table_data, &rsdt->table_offset_entry[i],
1228                                        sizeof(uint32_t));
1229     }
1230     build_header(linker, table_data,
1231                  (void *)rsdt, "RSDT", rsdt_len, 1);
1232 }
This page took 0.086953 seconds and 4 git commands to generate.