include/hw/acpi/aml-build.h

   1 #ifndef HW_ACPI_GEN_UTILS_H
   2 #define HW_ACPI_GEN_UTILS_H
   3
   4 #include <stdint.h>
   5 #include <glib.h>
   6 #include "qemu/compiler.h"
   7
   8 typedef enum {
   9     AML_NO_OPCODE = 0,/* has only data */
  10     AML_OPCODE,       /* has opcode optionally followed by data */
  11     AML_PACKAGE,      /* has opcode and uses PkgLength for its length */
  12     AML_EXT_PACKAGE,  /* ame as AML_PACKAGE but also has 'ExOpPrefix' */
  13     AML_BUFFER,       /* data encoded as 'DefBuffer' */
  14     AML_RES_TEMPLATE, /* encoded as ResourceTemplate macro */
  15 } AmlBlockFlags;
  16
  17 struct Aml {
  18     GArray *buf;
  19
  20     /*< private >*/
  21     uint8_t op;
  22     AmlBlockFlags block_flags;
  23 };
  24 typedef struct Aml Aml;
  25
  26 /**
  27  * init_aml_allocator:
  28  *
  29  * Called for initializing API allocator which allow to use
  30  * AML API.
  31  * Returns: toplevel container which accumulates all other
  32  * AML elements for a table.
  33  */
  34 Aml *init_aml_allocator(void);
  35
  36 /**
  37  * free_aml_allocator:
  38  *
  39  * Releases all elements used by AML API, frees associated memory
  40  * and invalidates AML allocator. After this call @init_aml_allocator
  41  * should be called again if AML API is to be used again.
  42  */
  43 void free_aml_allocator(void);
  44
  45 /**
  46  * aml_append:
  47  * @parent_ctx: context to which @child element is added
  48  * @child: element that is copied into @parent_ctx context
  49  *
  50  * Joins Aml elements together and helps to construct AML tables
  51  * Examle of usage:
  52  *   Aml *table = aml_def_block("SSDT", ...);
  53  *   Aml *sb = aml_scope("\_SB");
  54  *   Aml *dev = aml_device("PCI0");
  55  *
  56  *   aml_append(dev, aml_name_decl("HID", aml_eisaid("PNP0A03")));
  57  *   aml_append(sb, dev);
  58  *   aml_append(table, sb);
  59  */
  60 void aml_append(Aml *parent_ctx, Aml *child);
  61
  62 /* non block AML object primitives */
  63 Aml *aml_name(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
  64 Aml *aml_name_decl(const char *name, Aml *val);
  65 Aml *aml_int(const uint64_t val);
  66
  67 /* Block AML object primitives */
  68 Aml *aml_scope(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
  69 Aml *aml_device(const char *name_format, ...) GCC_FMT_ATTR(1, 2);
  70 Aml *aml_method(const char *name, int arg_count);
  71 Aml *aml_if(Aml *predicate);
  72
  73 /* other helpers */
  74 GArray *build_alloc_array(void);
  75 void build_free_array(GArray *array);
  76 void build_prepend_byte(GArray *array, uint8_t val);
  77 void build_append_byte(GArray *array, uint8_t val);
  78 void build_append_array(GArray *array, GArray *val);
  79
  80 void GCC_FMT_ATTR(2, 3)
  81 build_append_namestring(GArray *array, const char *format, ...);
  82
  83 void build_prepend_package_length(GArray *package);
  84 void build_package(GArray *package, uint8_t op);
  85 void build_append_int(GArray *table, uint64_t value);
  86 void build_extop_package(GArray *package, uint8_t op);
  87
  88 #endif