util/sconfig/sconfig.h

   1 /* sconfig, coreboot device tree compiler */
   2 /* SPDX-License-Identifier: GPL-2.0-only */
   3
   4 #include <stdint.h>
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <string.h>
   8 #include <sys/types.h>
   9 #include <unistd.h>
  10 #include <errno.h>
  11
  12 struct resource;
  13 struct resource {
  14         int type;
  15         int index;
  16         int base;
  17         struct resource *next;
  18 };
  19
  20 struct reg;
  21 struct reg {
  22         char *key;
  23         char *value;
  24         struct reg *next;
  25 };
  26
  27 struct pci_irq_info {
  28         int ioapic_irq_pin;
  29         int ioapic_dst_id;
  30 };
  31
  32 struct fw_config_option;
  33 struct fw_config_option {
  34         const char *name;
  35         uint64_t value;
  36         struct fw_config_option *next;
  37 };
  38
  39 struct fw_config_field_bits;
  40 struct fw_config_field_bits {
  41         unsigned int start_bit;
  42         unsigned int end_bit;
  43         struct fw_config_field_bits *next;
  44 };
  45
  46 struct fw_config_field;
  47 struct fw_config_field {
  48         const char *name;
  49         struct fw_config_field_bits *bits;
  50         struct fw_config_field *next;
  51         struct fw_config_option *options;
  52 };
  53 struct fw_config_probe;
  54 struct fw_config_probe {
  55         const char *field;
  56         const char *option;
  57         struct fw_config_probe *next;
  58 };
  59
  60 struct chip;
  61 struct chip_instance {
  62         /* Monotonically increasing ID for each chip instance. */
  63         int id;
  64
  65         /* Pointer to registers for this chip. */
  66         struct reg *reg;
  67
  68         /* Pointer to references for this chip. */
  69         struct reg *ref;
  70
  71         /* Pointer to chip of which this is instance. */
  72         struct chip *chip;
  73
  74         /* Pointer to next instance of the same chip. */
  75         struct chip_instance *next;
  76
  77         /*
  78          * Pointer to corresponding chip instance in base devicetree.
  79          * a) If the chip instance belongs to the base devicetree, then this pointer is set to
  80          * NULL.
  81          * b) If the chip instance belongs to override tree, then this pointer is set to its
  82          * corresponding chip instance in base devicetree (if it exists), else to NULL.
  83          *
  84          * This is useful when generating chip instances and chip_ops for a device to determine
  85          * if this is the instance to emit or if there is a base chip instance to use instead.
  86          */
  87         struct chip_instance *base_chip_instance;
  88 };
  89
  90 struct chip {
  91         /* Indicates if chip header exists for this chip. */
  92         int chiph_exists;
  93
  94         /* Name of current chip. */
  95         char *name;
  96
  97         /* Name of current chip normalized to _. */
  98         char *name_underscore;
  99
 100         /* Pointer to first instance of this chip. */
 101         struct chip_instance *instance;
 102
 103         /* Pointer to next chip. */
 104         struct chip *next;
 105 };
 106
 107 struct device;
 108 struct bus {
 109         /* Instance/ID of the bus under the device. */
 110         int id;
 111
 112         /* Pointer to device to which this bus belongs. */
 113         struct device *dev;
 114
 115         /* Pointer to list of children. */
 116         struct device *children;
 117
 118         /* Pointer to next bus for the device. */
 119         struct bus *next_bus;
 120 };
 121
 122 struct device {
 123         /* Indicates device status (enabled / hidden or not). */
 124         int enabled;
 125         int hidden;
 126         /* non-zero if the device should be included in all cases */
 127         int mandatory;
 128
 129         /* Subsystem IDs for the device. */
 130         int subsystem_vendor;
 131         int subsystem_device;
 132         int inherit_subsystem;
 133
 134         /* Name of this device. */
 135         char *name;
 136
 137         /* Alias of this device (for internal references) */
 138         char *alias;
 139
 140         /* Path of this device. */
 141         char *path;
 142         int path_a;
 143         int path_b;
 144
 145         /* Type of bus that exists under this device. */
 146         int bustype;
 147
 148         /* PCI IRQ info. */
 149         struct pci_irq_info pci_irq_info[4];
 150
 151         /* Pointer to bus of parent on which this device resides. */
 152         struct bus *parent;
 153
 154         /* Pointer to next child under the same parent. */
 155         struct device *sibling;
 156
 157         /* Pointer to resources for this device. */
 158         struct resource *res;
 159
 160         /* Pointer to chip instance for this device. */
 161         struct chip_instance *chip_instance;
 162
 163         /* Pointer to list of buses under this device. */
 164         struct bus *bus;
 165         /* Pointer to last bus under this device. */
 166         struct bus *last_bus;
 167
 168         /* SMBIOS slot type */
 169         char *smbios_slot_type;
 170
 171         /* SMBIOS slot data width */
 172         char *smbios_slot_data_width;
 173
 174         /* SMBIOS slot description for reference designation */
 175         char *smbios_slot_designation;
 176
 177         /* SMBIOS slot length */
 178         char *smbios_slot_length;
 179
 180         /* List of field+option to probe. */
 181         struct fw_config_probe *probe;
 182 };
 183
 184 extern struct bus *root_parent;
 185
 186 struct device *new_device_raw(struct bus *parent,
 187                               struct chip_instance *chip_instance,
 188                               const int bustype, const char *devnum,
 189                               char *alias, int status);
 190
 191 struct device *new_device_reference(struct bus *parent,
 192                                     struct chip_instance *chip_instance,
 193                                     const char *reference, int status);
 194
 195 void add_resource(struct bus *bus, int type, int index, int base);
 196
 197 void add_pci_subsystem_ids(struct bus *bus, int vendor, int device,
 198                            int inherit);
 199
 200 void add_ioapic_info(struct bus *bus, int apicid, const char *_srcpin,
 201                      int irqpin);
 202
 203 void add_slot_desc(struct bus *bus, char *type, char *length, char *designation,
 204                    char *data_width);
 205
 206 void yyrestart(FILE *input_file);
 207
 208 /* Add chip data to tail of queue. */
 209 void chip_enqueue_tail(void *data);
 210
 211 /* Retrieve chip data from tail of queue. */
 212 void *chip_dequeue_tail(void);
 213
 214 struct chip_instance *new_chip_instance(char *path);
 215 void add_register(struct chip_instance *chip, char *name, char *val);
 216 void add_reference(struct chip_instance *chip, char *name, char *alias);
 217
 218 struct fw_config_field *get_fw_config_field(const char *name);
 219
 220 void add_fw_config_field_bits(struct fw_config_field *field,
 221                               unsigned int start_bit, unsigned int end_bit);
 222
 223 struct fw_config_field *new_fw_config_field(const char *name, struct fw_config_field_bits *bits);
 224
 225 void add_fw_config_option(struct fw_config_field *field, const char *name,
 226                           uint64_t value);
 227
 228 void add_fw_config_probe(struct bus *bus, const char *field, const char *option);
 229
 230 void append_fw_config_bits(struct fw_config_field_bits **bits,
 231                            unsigned int start_bit, unsigned int end_bit);