include/acpi/acpi_table.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Helpers for ACPI table generation
   4  *
   5  * Based on acpi.c from coreboot
   6  *
   7  * Copyright 2019 Google LLC
   8  *
   9  * Copyright (C) 2015, Saket Sinha <saket.sinha89@gmail.com>
  10  * Copyright (C) 2016, Bin Meng <bmeng.cn@gmail.com>
  11  */
  12
  13 #ifndef __ACPI_TABLE_H__
  14 #define __ACPI_TABLE_H__
  15
  16 #include <dm/acpi.h>
  17
  18 #define RSDP_SIG                "RSD PTR "      /* RSDP pointer signature */
  19 #define OEM_ID                  "U-BOOT"        /* U-Boot */
  20 #define OEM_TABLE_ID            "U-BOOTBL"      /* U-Boot Table */
  21 #define ASLC_ID                 "INTL"          /* Intel ASL Compiler */
  22
  23 /* TODO(sjg@chromium.org): Figure out how to get compiler revision */
  24 #define ASL_REVISION    0
  25
  26 #define ACPI_RSDP_REV_ACPI_1_0  0
  27 #define ACPI_RSDP_REV_ACPI_2_0  2
  28
  29 #if !defined(__ACPI__)
  30
  31 #include <linux/bitops.h>
  32
  33 struct acpi_ctx;
  34
  35 /*
  36  * RSDP (Root System Description Pointer)
  37  * Note: ACPI 1.0 didn't have length, xsdt_address, and ext_checksum
  38  */
  39 struct acpi_rsdp {
  40         char signature[8];      /* RSDP signature */
  41         u8 checksum;            /* Checksum of the first 20 bytes */
  42         char oem_id[6];         /* OEM ID */
  43         u8 revision;            /* 0 for ACPI 1.0, others 2 */
  44         u32 rsdt_address;       /* Physical address of RSDT (32 bits) */
  45         u32 length;             /* Total RSDP length (incl. extended part) */
  46         u64 xsdt_address;       /* Physical address of XSDT (64 bits) */
  47         u8 ext_checksum;        /* Checksum of the whole table */
  48         u8 reserved[3];
  49 };
  50
  51 /* Generic ACPI header, provided by (almost) all tables */
  52 struct __packed acpi_table_header {
  53         char signature[ACPI_NAME_LEN];  /* ACPI signature (4 ASCII chars) */
  54         u32 length;             /* Table length in bytes (incl. header) */
  55         u8 revision;            /* Table version (not ACPI version!) */
  56         volatile u8 checksum;   /* To make sum of entire table == 0 */
  57         char oem_id[6];         /* OEM identification */
  58         char oem_table_id[8];   /* OEM table identification */
  59         u32 oem_revision;       /* OEM revision number */
  60         char aslc_id[4];        /* ASL compiler vendor ID */
  61         u32 aslc_revision;      /* ASL compiler revision number */
  62 };
  63
  64 struct acpi_gen_regaddr {
  65         u8 space_id;    /* Address space ID */
  66         u8 bit_width;   /* Register size in bits */
  67         u8 bit_offset;  /* Register bit offset */
  68         u8 access_size; /* Access size */
  69         u32 addrl;      /* Register address, low 32 bits */
  70         u32 addrh;      /* Register address, high 32 bits */
  71 };
  72
  73 /* A maximum number of 32 ACPI tables ought to be enough for now */
  74 #define MAX_ACPI_TABLES         32
  75
  76 /* RSDT (Root System Description Table) */
  77 struct acpi_rsdt {
  78         struct acpi_table_header header;
  79         u32 entry[MAX_ACPI_TABLES];
  80 };
  81
  82 /* XSDT (Extended System Description Table) */
  83 struct acpi_xsdt {
  84         struct acpi_table_header header;
  85         u64 entry[MAX_ACPI_TABLES];
  86 };
  87
  88 /* HPET timers */
  89 struct __packed acpi_hpet {
  90         struct acpi_table_header header;
  91         u32 id;
  92         struct acpi_gen_regaddr addr;
  93         u8 number;
  94         u16 min_tick;
  95         u8 attributes;
  96 };
  97
  98 struct __packed acpi_tpm2 {
  99         struct acpi_table_header header;
 100         u16 platform_class;
 101         u8  reserved[2];
 102         u64 control_area;
 103         u32 start_method;
 104         u8  msp[12];
 105         u32 laml;
 106         u64 lasa;
 107 };
 108
 109 struct __packed acpi_tcpa {
 110         struct acpi_table_header header;
 111         u16 platform_class;
 112         u32 laml;
 113         u64 lasa;
 114 };
 115
 116 /* FADT Preferred Power Management Profile */
 117 enum acpi_pm_profile {
 118         ACPI_PM_UNSPECIFIED = 0,
 119         ACPI_PM_DESKTOP,
 120         ACPI_PM_MOBILE,
 121         ACPI_PM_WORKSTATION,
 122         ACPI_PM_ENTERPRISE_SERVER,
 123         ACPI_PM_SOHO_SERVER,
 124         ACPI_PM_APPLIANCE_PC,
 125         ACPI_PM_PERFORMANCE_SERVER,
 126         ACPI_PM_TABLET
 127 };
 128
 129 /* FADT flags for p_lvl2_lat and p_lvl3_lat */
 130 #define ACPI_FADT_C2_NOT_SUPPORTED      101
 131 #define ACPI_FADT_C3_NOT_SUPPORTED      1001
 132
 133 /* FADT Boot Architecture Flags */
 134 #define ACPI_FADT_LEGACY_FREE           0x00
 135 #define ACPI_FADT_LEGACY_DEVICES        BIT(0)
 136 #define ACPI_FADT_8042                  BIT(1)
 137 #define ACPI_FADT_VGA_NOT_PRESENT       BIT(2)
 138 #define ACPI_FADT_MSI_NOT_SUPPORTED     BIT(3)
 139 #define ACPI_FADT_NO_PCIE_ASPM_CONTROL  BIT(4)
 140
 141 /* FADT Feature Flags */
 142 #define ACPI_FADT_WBINVD                BIT(0)
 143 #define ACPI_FADT_WBINVD_FLUSH          BIT(1)
 144 #define ACPI_FADT_C1_SUPPORTED          BIT(2)
 145 #define ACPI_FADT_C2_MP_SUPPORTED       BIT(3)
 146 #define ACPI_FADT_POWER_BUTTON          BIT(4)
 147 #define ACPI_FADT_SLEEP_BUTTON          BIT(5)
 148 #define ACPI_FADT_FIXED_RTC             BIT(6)
 149 #define ACPI_FADT_S4_RTC_WAKE           BIT(7)
 150 #define ACPI_FADT_32BIT_TIMER           BIT(8)
 151 #define ACPI_FADT_DOCKING_SUPPORTED     BIT(9)
 152 #define ACPI_FADT_RESET_REGISTER        BIT(10)
 153 #define ACPI_FADT_SEALED_CASE           BIT(11)
 154 #define ACPI_FADT_HEADLESS              BIT(12)
 155 #define ACPI_FADT_SLEEP_TYPE            BIT(13)
 156 #define ACPI_FADT_PCI_EXPRESS_WAKE      BIT(14)
 157 #define ACPI_FADT_PLATFORM_CLOCK        BIT(15)
 158 #define ACPI_FADT_S4_RTC_VALID          BIT(16)
 159 #define ACPI_FADT_REMOTE_POWER_ON       BIT(17)
 160 #define ACPI_FADT_APIC_CLUSTER          BIT(18)
 161 #define ACPI_FADT_APIC_PHYSICAL         BIT(19)
 162 #define ACPI_FADT_HW_REDUCED_ACPI       BIT(20)
 163 #define ACPI_FADT_LOW_PWR_IDLE_S0       BIT(21)
 164
 165 /* ARM boot flags */
 166 #define ACPI_ARM_PSCI_COMPLIANT         BIT(0)
 167
 168 enum acpi_address_space_type {
 169         ACPI_ADDRESS_SPACE_MEMORY = 0,  /* System memory */
 170         ACPI_ADDRESS_SPACE_IO,          /* System I/O */
 171         ACPI_ADDRESS_SPACE_PCI,         /* PCI config space */
 172         ACPI_ADDRESS_SPACE_EC,          /* Embedded controller */
 173         ACPI_ADDRESS_SPACE_SMBUS,       /* SMBus */
 174         ACPI_ADDRESS_SPACE_PCC = 0x0a,  /* Platform Comm. Channel */
 175         ACPI_ADDRESS_SPACE_FIXED = 0x7f /* Functional fixed hardware */
 176 };
 177
 178 enum acpi_address_space_size {
 179         ACPI_ACCESS_SIZE_UNDEFINED = 0,
 180         ACPI_ACCESS_SIZE_BYTE_ACCESS,
 181         ACPI_ACCESS_SIZE_WORD_ACCESS,
 182         ACPI_ACCESS_SIZE_DWORD_ACCESS,
 183         ACPI_ACCESS_SIZE_QWORD_ACCESS
 184 };
 185
 186 /* FADT (Fixed ACPI Description Table) */
 187 struct __packed acpi_fadt {
 188         struct acpi_table_header header;
 189         u32 firmware_ctrl;
 190         u32 dsdt;
 191         u8 res1;
 192         u8 preferred_pm_profile;
 193         u16 sci_int;
 194         u32 smi_cmd;
 195         u8 acpi_enable;
 196         u8 acpi_disable;
 197         u8 s4bios_req;
 198         u8 pstate_cnt;
 199         u32 pm1a_evt_blk;
 200         u32 pm1b_evt_blk;
 201         u32 pm1a_cnt_blk;
 202         u32 pm1b_cnt_blk;
 203         u32 pm2_cnt_blk;
 204         u32 pm_tmr_blk;
 205         u32 gpe0_blk;
 206         u32 gpe1_blk;
 207         u8 pm1_evt_len;
 208         u8 pm1_cnt_len;
 209         u8 pm2_cnt_len;
 210         u8 pm_tmr_len;
 211         u8 gpe0_blk_len;
 212         u8 gpe1_blk_len;
 213         u8 gpe1_base;
 214         u8 cst_cnt;
 215         u16 p_lvl2_lat;
 216         u16 p_lvl3_lat;
 217         u16 flush_size;
 218         u16 flush_stride;
 219         u8 duty_offset;
 220         u8 duty_width;
 221         u8 day_alrm;
 222         u8 mon_alrm;
 223         u8 century;
 224         u16 iapc_boot_arch;
 225         u8 res2;
 226         u32 flags;
 227         struct acpi_gen_regaddr reset_reg;
 228         u8 reset_value;
 229         u16 arm_boot_arch;
 230         u8 minor_revision;
 231         u32 x_firmware_ctl_l;
 232         u32 x_firmware_ctl_h;
 233         u32 x_dsdt_l;
 234         u32 x_dsdt_h;
 235         struct acpi_gen_regaddr x_pm1a_evt_blk;
 236         struct acpi_gen_regaddr x_pm1b_evt_blk;
 237         struct acpi_gen_regaddr x_pm1a_cnt_blk;
 238         struct acpi_gen_regaddr x_pm1b_cnt_blk;
 239         struct acpi_gen_regaddr x_pm2_cnt_blk;
 240         struct acpi_gen_regaddr x_pm_tmr_blk;
 241         struct acpi_gen_regaddr x_gpe0_blk;
 242         struct acpi_gen_regaddr x_gpe1_blk;
 243         struct acpi_gen_regaddr sleep_control_reg;
 244         struct acpi_gen_regaddr sleep_status_reg;
 245         u64 hyp_vendor_id;
 246 };
 247
 248 /* FADT TABLE Revision values - note these do not match the ACPI revision */
 249 #define ACPI_FADT_REV_ACPI_1_0          1
 250 #define ACPI_FADT_REV_ACPI_2_0          3
 251 #define ACPI_FADT_REV_ACPI_3_0          4
 252 #define ACPI_FADT_REV_ACPI_4_0          4
 253 #define ACPI_FADT_REV_ACPI_5_0          5
 254 #define ACPI_FADT_REV_ACPI_6_0          6
 255
 256 /* MADT TABLE Revision values - note these do not match the ACPI revision */
 257 #define ACPI_MADT_REV_ACPI_3_0          2
 258 #define ACPI_MADT_REV_ACPI_4_0          3
 259 #define ACPI_MADT_REV_ACPI_5_0          3
 260 #define ACPI_MADT_REV_ACPI_6_0          5
 261
 262 #define ACPI_MCFG_REV_ACPI_3_0          1
 263
 264 /* IVRS Revision Field */
 265 #define IVRS_FORMAT_FIXED       0x01    /* Type 10h & 11h only */
 266 #define IVRS_FORMAT_MIXED       0x02    /* Type 10h, 11h, & 40h */
 267
 268 /* FACS flags */
 269 #define ACPI_FACS_S4BIOS_F              BIT(0)
 270 #define ACPI_FACS_64BIT_WAKE_F          BIT(1)
 271
 272 /* FACS (Firmware ACPI Control Structure) */
 273 struct acpi_facs {
 274         char signature[ACPI_NAME_LEN];  /* "FACS" */
 275         u32 length;                     /* Length in bytes (>= 64) */
 276         u32 hardware_signature;         /* Hardware signature */
 277         u32 firmware_waking_vector;     /* Firmware waking vector */
 278         u32 global_lock;                /* Global lock */
 279         u32 flags;                      /* FACS flags */
 280         u32 x_firmware_waking_vector_l; /* X FW waking vector, low */
 281         u32 x_firmware_waking_vector_h; /* X FW waking vector, high */
 282         u8 version;                     /* Version 2 */
 283         u8 res1[3];
 284         u32 ospm_flags;                 /* OSPM enabled flags */
 285         u8 res2[24];
 286 };
 287
 288 /* MADT flags */
 289 #define ACPI_MADT_PCAT_COMPAT   BIT(0)
 290
 291 /* MADT (Multiple APIC Description Table) */
 292 struct acpi_madt {
 293         struct acpi_table_header header;
 294         u32 lapic_addr;                 /* Local APIC address */
 295         u32 flags;                      /* Multiple APIC flags */
 296 };
 297
 298 /* MADT: APIC Structure Type*/
 299 enum acpi_apic_types {
 300         ACPI_APIC_LAPIC = 0,            /* Processor local APIC */
 301         ACPI_APIC_IOAPIC,               /* I/O APIC */
 302         ACPI_APIC_IRQ_SRC_OVERRIDE,     /* Interrupt source override */
 303         ACPI_APIC_NMI_SRC,              /* NMI source */
 304         ACPI_APIC_LAPIC_NMI,            /* Local APIC NMI */
 305         ACPI_APIC_LAPIC_ADDR_OVERRIDE,  /* Local APIC address override */
 306         ACPI_APIC_IOSAPIC,              /* I/O SAPIC */
 307         ACPI_APIC_LSAPIC,               /* Local SAPIC */
 308         ACPI_APIC_PLATFORM_IRQ_SRC,     /* Platform interrupt sources */
 309         ACPI_APIC_LX2APIC,              /* Processor local x2APIC */
 310         ACPI_APIC_LX2APIC_NMI,          /* Local x2APIC NMI */
 311         ACPI_APIC_GICC,                 /* Generic Interrupt Ctlr CPU i/f */
 312         ACPI_APIC_GICD                  /* Generic Interrupt Ctlr Distributor */
 313 };
 314
 315 /* MADT: Processor Local APIC Structure */
 316
 317 #define LOCAL_APIC_FLAG_ENABLED         BIT(0)
 318
 319 struct acpi_madt_lapic {
 320         u8 type;                /* Type (0) */
 321         u8 length;              /* Length in bytes (8) */
 322         u8 processor_id;        /* ACPI processor ID */
 323         u8 apic_id;             /* Local APIC ID */
 324         u32 flags;              /* Local APIC flags */
 325 };
 326
 327 /* MADT: I/O APIC Structure */
 328 struct acpi_madt_ioapic {
 329         u8 type;                /* Type (1) */
 330         u8 length;              /* Length in bytes (12) */
 331         u8 ioapic_id;           /* I/O APIC ID */
 332         u8 reserved;
 333         u32 ioapic_addr;        /* I/O APIC address */
 334         u32 gsi_base;           /* Global system interrupt base */
 335 };
 336
 337 /* MADT: Interrupt Source Override Structure */
 338 struct __packed acpi_madt_irqoverride {
 339         u8 type;                /* Type (2) */
 340         u8 length;              /* Length in bytes (10) */
 341         u8 bus;                 /* ISA (0) */
 342         u8 source;              /* Bus-relative int. source (IRQ) */
 343         u32 gsirq;              /* Global system interrupt */
 344         u16 flags;              /* MPS INTI flags */
 345 };
 346
 347 /* MADT: Local APIC NMI Structure */
 348 struct __packed acpi_madt_lapic_nmi {
 349         u8 type;                /* Type (4) */
 350         u8 length;              /* Length in bytes (6) */
 351         u8 processor_id;        /* ACPI processor ID */
 352         u16 flags;              /* MPS INTI flags */
 353         u8 lint;                /* Local APIC LINT# */
 354 };
 355
 356 /* flags for acpi_madr_gicc flags word */
 357 enum {
 358         ACPI_MADRF_ENABLED      = BIT(0),
 359         ACPI_MADRF_PERF         = BIT(1),
 360         ACPI_MADRF_VGIC         = BIT(2),
 361 };
 362
 363 /**
 364  * struct __packed acpi_madr_gicc - GIC CPU interface (type 0xb)
 365  *
 366  * This holds information about the Generic Interrupt Controller (GIC) CPU
 367  * interface. See ACPI Spec v6.3 section 5.2.12.14
 368  */
 369 struct __packed acpi_madr_gicc {
 370         u8 type;
 371         u8 length;
 372         u16 reserved;
 373         u32 cpu_if_num;
 374         u32 processor_id;
 375         u32 flags;
 376         u32 parking_proto;
 377         u32 perf_gsiv;
 378         u64 parked_addr;
 379         u64 phys_base;
 380         u64 gicv;
 381         u64 gich;
 382         u32 vgic_maint_irq;
 383         u64 gicr_base;
 384         u64 mpidr;
 385         u8 efficiency;
 386         u8 reserved2;
 387         u16 spi_overflow_irq;
 388 };
 389
 390 /**
 391  * struct __packed acpi_madr_gicc - GIC distributor (type 0xc)
 392  *
 393  * This holds information about the Generic Interrupt Controller (GIC)
 394  * Distributor interface. See ACPI Spec v6.3 section 5.2.12.15
 395  */
 396 struct __packed acpi_madr_gicd {
 397         u8 type;
 398         u8 length;
 399         u16 reserved;
 400         u32 gic_id;
 401         u64 phys_base;
 402         u32 reserved2;
 403         u8 gic_version;
 404         u8 reserved3[3];
 405 };
 406
 407 /* MCFG (PCI Express MMIO config space BAR description table) */
 408 struct acpi_mcfg {
 409         struct acpi_table_header header;
 410         u8 reserved[8];
 411 };
 412
 413 struct acpi_mcfg_mmconfig {
 414         u32 base_address_l;
 415         u32 base_address_h;
 416         u16 pci_segment_group_number;
 417         u8 start_bus_number;
 418         u8 end_bus_number;
 419         u8 reserved[4];
 420 };
 421
 422 /* PM1_CNT bit defines */
 423 #define PM1_CNT_SCI_EN          BIT(0)
 424
 425 /* ACPI global NVS structure */
 426 struct acpi_global_nvs;
 427
 428 /* CSRT (Core System Resource Table) */
 429 struct acpi_csrt {
 430         struct acpi_table_header header;
 431 };
 432
 433 /**
 434  * struct acpi_csrt_group - header for a group within the CSRT
 435  *
 436  * The CSRT consists of one or more groups and this is the header for each
 437  *
 438  * See Core System Resources Table (CSRT), March 13, 2017, Microsoft Corporation
 439  * for details
 440  *
 441  * https://uefi.org/sites/default/files/resources/CSRT%20v2.pdf
 442  *
 443  * @shared_info_length indicates the number of shared-info bytes following this
 444  * struct (which may be 0)
 445  */
 446 struct acpi_csrt_group {
 447         u32 length;
 448         u32 vendor_id;
 449         u32 subvendor_id;
 450         u16 device_id;
 451         u16 subdevice_id;
 452         u16 revision;
 453         u16 reserved;
 454         u32 shared_info_length;
 455 };
 456
 457 /**
 458  * struct acpi_csrt_descriptor - describes the information that follows
 459  *
 460  * See the spec as above for details
 461  */
 462 struct acpi_csrt_descriptor {
 463         u32 length;
 464         u16 type;
 465         u16 subtype;
 466         u32 uid;
 467 };
 468
 469 /**
 470  * struct acpi_csrt_shared_info - shared info for Intel tangier
 471  *
 472  * This provides the shared info for this particular board. Notes that the CSRT
 473  * does not describe the format of data, so this format may not be used by any
 474  * other board.
 475  */
 476 struct acpi_csrt_shared_info {
 477         u16 major_version;
 478         u16 minor_version;
 479         u32 mmio_base_low;
 480         u32 mmio_base_high;
 481         u32 gsi_interrupt;
 482         u8 interrupt_polarity;
 483         u8 interrupt_mode;
 484         u8 num_channels;
 485         u8 dma_address_width;
 486         u16 base_request_line;
 487         u16 num_handshake_signals;
 488         u32 max_block_size;
 489 };
 490
 491 /* Port types for ACPI _UPC object */
 492 enum acpi_upc_type {
 493         UPC_TYPE_A,
 494         UPC_TYPE_MINI_AB,
 495         UPC_TYPE_EXPRESSCARD,
 496         UPC_TYPE_USB3_A,
 497         UPC_TYPE_USB3_B,
 498         UPC_TYPE_USB3_MICRO_B,
 499         UPC_TYPE_USB3_MICRO_AB,
 500         UPC_TYPE_USB3_POWER_B,
 501         UPC_TYPE_C_USB2_ONLY,
 502         UPC_TYPE_C_USB2_SS_SWITCH,
 503         UPC_TYPE_C_USB2_SS,
 504         UPC_TYPE_PROPRIETARY = 0xff,
 505         /*
 506          * The following types are not directly defined in the ACPI
 507          * spec but are used by coreboot to identify a USB device type.
 508          */
 509         UPC_TYPE_INTERNAL = 0xff,
 510         UPC_TYPE_UNUSED,
 511         UPC_TYPE_HUB
 512 };
 513
 514 enum dev_scope_type {
 515         SCOPE_PCI_ENDPOINT = 1,
 516         SCOPE_PCI_SUB = 2,
 517         SCOPE_IOAPIC = 3,
 518         SCOPE_MSI_HPET = 4,
 519         SCOPE_ACPI_NAMESPACE_DEVICE = 5
 520 };
 521
 522 struct __packed dev_scope {
 523         u8 type;
 524         u8 length;
 525         u8 reserved[2];
 526         u8 enumeration;
 527         u8 start_bus;
 528         struct {
 529                 u8 dev;
 530                 u8 fn;
 531         } __packed path[0];
 532 };
 533
 534 enum dmar_type {
 535         DMAR_DRHD = 0,
 536         DMAR_RMRR = 1,
 537         DMAR_ATSR = 2,
 538         DMAR_RHSA = 3,
 539         DMAR_ANDD = 4
 540 };
 541
 542 enum {
 543         DRHD_INCLUDE_PCI_ALL = BIT(0)
 544 };
 545
 546 enum dmar_flags {
 547         DMAR_INTR_REMAP                 = BIT(0),
 548         DMAR_X2APIC_OPT_OUT             = BIT(1),
 549         DMAR_CTRL_PLATFORM_OPT_IN_FLAG  = BIT(2),
 550 };
 551
 552 struct dmar_entry {
 553         u16 type;
 554         u16 length;
 555         u8 flags;
 556         u8 reserved;
 557         u16 segment;
 558         u64 bar;
 559 };
 560
 561 struct dmar_rmrr_entry {
 562         u16 type;
 563         u16 length;
 564         u16 reserved;
 565         u16 segment;
 566         u64 bar;
 567         u64 limit;
 568 };
 569
 570 /* DMAR (DMA Remapping Reporting Structure) */
 571 struct __packed acpi_dmar {
 572         struct acpi_table_header header;
 573         u8 host_address_width;
 574         u8 flags;
 575         u8 reserved[10];
 576         struct dmar_entry structure[0];
 577 };
 578
 579 /* DBG2 definitions are partially used for SPCR interface_type */
 580
 581 /* Types for port_type field */
 582
 583 #define ACPI_DBG2_SERIAL_PORT           0x8000
 584 #define ACPI_DBG2_1394_PORT             0x8001
 585 #define ACPI_DBG2_USB_PORT              0x8002
 586 #define ACPI_DBG2_NET_PORT              0x8003
 587
 588 /* Subtypes for port_subtype field */
 589
 590 #define ACPI_DBG2_16550_COMPATIBLE      0x0000
 591 #define ACPI_DBG2_16550_SUBSET          0x0001
 592 #define ACPI_DBG2_ARM_PL011             0x0003
 593 #define ACPI_DBG2_ARM_SBSA_32BIT        0x000D
 594 #define ACPI_DBG2_ARM_SBSA_GENERIC      0x000E
 595 #define ACPI_DBG2_ARM_DCC               0x000F
 596 #define ACPI_DBG2_BCM2835               0x0010
 597
 598 #define ACPI_DBG2_1394_STANDARD         0x0000
 599
 600 #define ACPI_DBG2_USB_XHCI              0x0000
 601 #define ACPI_DBG2_USB_EHCI              0x0001
 602
 603 #define ACPI_DBG2_UNKNOWN               0x00FF
 604
 605 /* DBG2: Microsoft Debug Port Table 2 header */
 606 struct __packed acpi_dbg2_header {
 607         struct acpi_table_header header;
 608         u32 devices_offset;
 609         u32 devices_count;
 610 };
 611
 612 /* DBG2: Microsoft Debug Port Table 2 device entry */
 613 struct __packed acpi_dbg2_device {
 614         u8  revision;
 615         u16 length;
 616         u8 address_count;
 617         u16 namespace_string_length;
 618         u16 namespace_string_offset;
 619         u16 oem_data_length;
 620         u16 oem_data_offset;
 621         u16 port_type;
 622         u16 port_subtype;
 623         u8  reserved[2];
 624         u16 base_address_offset;
 625         u16 address_size_offset;
 626 };
 627
 628 /* SPCR (Serial Port Console Redirection table) */
 629 struct __packed acpi_spcr {
 630         struct acpi_table_header header;
 631         u8 interface_type;
 632         u8 reserved[3];
 633         struct acpi_gen_regaddr serial_port;
 634         u8 interrupt_type;
 635         u8 pc_interrupt;
 636         u32 interrupt;          /* Global system interrupt */
 637         u8 baud_rate;
 638         u8 parity;
 639         u8 stop_bits;
 640         u8 flow_control;
 641         u8 terminal_type;
 642         u8 reserved1;
 643         u16 pci_device_id;      /* Must be 0xffff if not PCI device */
 644         u16 pci_vendor_id;      /* Must be 0xffff if not PCI device */
 645         u8 pci_bus;
 646         u8 pci_device;
 647         u8 pci_function;
 648         u32 pci_flags;
 649         u8 pci_segment;
 650         u32 reserved2;
 651 };
 652
 653 /**
 654  * struct acpi_gtdt - Generic Timer Description Table (GTDT)
 655  *
 656  * See ACPI Spec v6.3 section 5.2.24 for details
 657  */
 658 struct __packed acpi_gtdt {
 659         struct acpi_table_header header;
 660         u64 cnt_ctrl_base;
 661         u32 reserved0;
 662         u32 sec_el1_gsiv;
 663         u32 sec_el1_flags;
 664         u32 el1_gsiv;
 665         u32 el1_flags;
 666         u32 virt_el1_gsiv;
 667         u32 virt_el1_flags;
 668         u32 el2_gsiv;
 669         u32 el2_flags;
 670         u64 cnt_read_base;
 671         u32 plat_timer_count;
 672         u32 plat_timer_offset;
 673         u32 virt_el2_gsiv;
 674         u32 virt_el2_flags;
 675 };
 676
 677 /**
 678  * struct acpi_bgrt -  Boot Graphics Resource Table (BGRT)
 679  *
 680  * Optional table that provides a mechanism to indicate that an image was drawn
 681  * on the screen during boot, and some information about the image.
 682  *
 683  * See ACPI Spec v6.3 section 5.2.22 for details
 684  */
 685 struct __packed acpi_bgrt {
 686         struct acpi_table_header header;
 687         u16 version;
 688         u8 status;
 689         u8 image_type;
 690         u64 addr;
 691         u32 offset_x;
 692         u32 offset_y;
 693 };
 694
 695 /* Types for PPTT */
 696 #define ACPI_PPTT_TYPE_PROC             0
 697 #define ACPI_PPTT_TYPE_CACHE            1
 698
 699 /* Flags for PPTT */
 700 #define ACPI_PPTT_PHYSICAL_PACKAGE      BIT(0)
 701 #define ACPI_PPTT_PROC_ID_VALID         BIT(1)
 702 #define ACPI_PPTT_PROC_IS_THREAD        BIT(2)
 703 #define ACPI_PPTT_NODE_IS_LEAF          BIT(3)
 704 #define ACPI_PPTT_CHILDREN_IDENTICAL    BIT(4)
 705
 706 /**
 707  * struct acpi_pptt_header - Processor Properties Topology Table (PPTT) header
 708  *
 709  * Describes the topological structure of processors and their shared resources,
 710  * such as caches.
 711  *
 712  * See ACPI Spec v6.3 section 5.2.29 for details
 713  */
 714 struct __packed acpi_pptt_header {
 715         u8 type;        /* ACPI_PPTT_TYPE_... */
 716         u8 length;
 717         u16 reserved;
 718 };
 719
 720 /**
 721  * struct acpi_pptt_proc - a processor as described by PPTT
 722  */
 723 struct __packed acpi_pptt_proc {
 724         struct acpi_pptt_header hdr;
 725         u32 flags;
 726         u32 parent;
 727         u32 proc_id;
 728         u32 num_resources;
 729 };
 730
 731 /* Cache flags for acpi_pptt_cache */
 732 #define ACPI_PPTT_SIZE_VALID            BIT(0)
 733 #define ACPI_PPTT_SETS_VALID            BIT(1)
 734 #define ACPI_PPTT_ASSOC_VALID           BIT(2)
 735 #define ACPI_PPTT_ALLOC_TYPE_VALID      BIT(3)
 736 #define ACPI_PPTT_CACHE_TYPE_VALID      BIT(4)
 737 #define ACPI_PPTT_WRITE_POLICY_VALID    BIT(5)
 738 #define ACPI_PPTT_LINE_SIZE_VALID       BIT(6)
 739
 740 #define ACPI_PPTT_ALL_VALID             0x7f
 741 #define ACPI_PPTT_ALL_BUT_WRITE_POL     0x5f
 742
 743 #define ACPI_PPTT_READ_ALLOC            BIT(0)
 744 #define ACPI_PPTT_WRITE_ALLOC           BIT(1)
 745 #define ACPI_PPTT_CACHE_TYPE_SHIFT      2
 746 #define ACPI_PPTT_CACHE_TYPE_MASK       (3 << ACPI_PPTT_CACHE_TYPE_SHIFT)
 747 #define ACPI_PPTT_CACHE_TYPE_DATA       0
 748 #define ACPI_PPTT_CACHE_TYPE_INSTR      1
 749 #define ACPI_PPTT_CACHE_TYPE_UNIFIED    2
 750 #define ACPI_PPTT_CACHE_TYPE_DATA       0
 751 #define ACPI_PPTT_WRITE_THROUGH         BIT(4)
 752
 753 /**
 754  * struct acpi_pptt_cache - a cache as described by PPTT
 755  */
 756 struct __packed acpi_pptt_cache {
 757         struct acpi_pptt_header hdr;
 758         u32 flags;
 759         u32 next_cache_level;
 760         u32 size;
 761         u32 sets;
 762         u8 assoc;
 763         u8 attributes;
 764         u16 line_size;
 765 };
 766
 767 /* Tables defined/reserved by ACPI and generated by U-Boot */
 768 enum acpi_tables {
 769         ACPITAB_BERT,
 770         ACPITAB_DBG2,
 771         ACPITAB_DMAR,
 772         ACPITAB_DSDT,
 773         ACPITAB_ECDT,
 774         ACPITAB_FACS,
 775         ACPITAB_FADT,
 776         ACPITAB_HEST,
 777         ACPITAB_HPET,
 778         ACPITAB_IVRS,
 779         ACPITAB_MADT,
 780         ACPITAB_MCFG,
 781         ACPITAB_NHLT,
 782         ACPITAB_RSDP,
 783         ACPITAB_RSDT,
 784         ACPITAB_SLIT,
 785         ACPITAB_SPCR,
 786         ACPITAB_SPMI,
 787         ACPITAB_SRAT,
 788         ACPITAB_SSDT,
 789         ACPITAB_TCPA,
 790         ACPITAB_TPM2,
 791         ACPITAB_VFCT,
 792         ACPITAB_XSDT,
 793
 794         ACPITAB_COUNT,
 795 };
 796
 797 /**
 798  * acpi_get_table_revision() - Get the revision number generated for a table
 799  *
 800  * This keeps the version-number information in one place
 801  *
 802  * @table: ACPI table to check
 803  * Return: version number that U-Boot generates
 804  */
 805 int acpi_get_table_revision(enum acpi_tables table);
 806
 807 /**
 808  * acpi_create_dmar() - Create a DMA Remapping Reporting (DMAR) table
 809  *
 810  * @dmar: Place to put the table
 811  * @flags: DMAR flags to use
 812  * Return: 0 if OK, -ve on error
 813  */
 814 int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags);
 815
 816 /**
 817  * acpi_create_dbg2() - Create a DBG2 table
 818  *
 819  * This table describes how to access the debug UART
 820  *
 821  * @dbg2: Place to put information
 822  * @port_type: Serial port type (see ACPI_DBG2_...)
 823  * @port_subtype: Serial port sub-type (see ACPI_DBG2_...)
 824  * @address: ACPI address of port
 825  * @address_size: Size of address space
 826  * @device_path: Path of device (created using acpi_device_path())
 827  */
 828 void acpi_create_dbg2(struct acpi_dbg2_header *dbg2,
 829                       int port_type, int port_subtype,
 830                       struct acpi_gen_regaddr *address, uint32_t address_size,
 831                       const char *device_path);
 832
 833 /**
 834  * acpi_fill_header() - Set up a new table header
 835  *
 836  * This sets all fields except length, revision, checksum and aslc_revision
 837  *
 838  * @header: ACPI header to update
 839  * @signature: Table signature to use (4 characters)
 840  */
 841 void acpi_fill_header(struct acpi_table_header *header, char *signature);
 842
 843 /**
 844  * acpi_align() - Align the ACPI output pointer to a 16-byte boundary
 845  *
 846  * @ctx: ACPI context
 847  */
 848 void acpi_align(struct acpi_ctx *ctx);
 849
 850 /**
 851  * acpi_align64() - Align the ACPI output pointer to a 64-byte boundary
 852  *
 853  * @ctx: ACPI context
 854  */
 855 void acpi_align64(struct acpi_ctx *ctx);
 856
 857 /**
 858  * acpi_inc() - Increment the ACPI output pointer by a bit
 859  *
 860  * The pointer is NOT aligned afterwards.
 861  *
 862  * @ctx: ACPI context
 863  * @amount: Amount to increment by
 864  */
 865 void acpi_inc(struct acpi_ctx *ctx, uint amount);
 866
 867 /**
 868  * acpi_inc_align() - Increment the ACPI output pointer by a bit and align
 869  *
 870  * The pointer is aligned afterwards to a 16-byte boundary
 871  *
 872  * @ctx: ACPI context
 873  * @amount: Amount to increment by
 874  */
 875 void acpi_inc_align(struct acpi_ctx *ctx, uint amount);
 876
 877 /**
 878  * acpi_add_table() - Add a new table to the RSDP and XSDT
 879  *
 880  * @ctx: ACPI context
 881  * @table: Table to add
 882  * Return: 0 if OK, -E2BIG if too many tables
 883  */
 884 int acpi_add_table(struct acpi_ctx *ctx, void *table);
 885
 886 static inline int acpi_add_fadt(struct acpi_ctx *ctx, struct acpi_fadt *fadt)
 887 {
 888         acpi_add_table(ctx, fadt);
 889         acpi_inc(ctx, sizeof(struct acpi_fadt));
 890         return 0;
 891 }
 892
 893 /**
 894  * acpi_write_rsdp() - Write out an RSDP indicating where the ACPI tables are
 895  *
 896  * @rsdp: Address to write RSDP
 897  * @rsdt: Address of RSDT
 898  * @xsdt: Address of XSDT
 899  */
 900 void acpi_write_rsdp(struct acpi_rsdp *rsdp, struct acpi_rsdt *rsdt,
 901                      struct acpi_xsdt *xsdt);
 902
 903 /**
 904  * acpi_fill_header() - Set up a table header
 905  *
 906  * @header: Pointer to header to set up
 907  * @signature: 4-character signature to use (e.g. "FACS")
 908  */
 909 void acpi_fill_header(struct acpi_table_header *header, char *signature);
 910
 911 /**
 912  * acpi_fill_csrt() - Fill out the body of the CSRT
 913  *
 914  * This should write the contents of the Core System Resource Table (CSRT)
 915  * to the context. The header (struct acpi_table_header) has already been
 916  * written.
 917  *
 918  * @ctx: ACPI context to write to
 919  * @return 0 if OK, -ve on error
 920  */
 921 int acpi_fill_csrt(struct acpi_ctx *ctx);
 922
 923 /**
 924  * write_acpi_tables() - Write out the ACPI tables
 925  *
 926  * This writes all ACPI tables to the given address
 927  *
 928  * @start: Start address for the tables
 929  * @return address of end of tables, where the next tables can be written
 930  */
 931 ulong write_acpi_tables(ulong start);
 932
 933 /**
 934  * acpi_find_table() - Look up an ACPI table
 935  *
 936  * @sig: Signature of table (4 characters, upper case)
 937  * Return: pointer to table header, or NULL if not found
 938  */
 939 struct acpi_table_header *acpi_find_table(const char *sig);
 940
 941 #endif /* !__ACPI__*/
 942
 943 #include <asm/acpi_table.h>
 944
 945 #endif /* __ACPI_TABLE_H__ */