1 /****************************************************************************** 2 * 3 * Name: actbl3.h - ACPI Table Definitions 4 * 5 *****************************************************************************/ 6 7 /* 8 * Copyright (C) 2000 - 2014, Intel Corp. 9 * All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions, and the following disclaimer, 16 * without modification. 17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 18 * substantially similar to the "NO WARRANTY" disclaimer below 19 * ("Disclaimer") and any redistribution must be conditioned upon 20 * including a substantially similar Disclaimer requirement for further 21 * binary redistribution. 22 * 3. Neither the names of the above-listed copyright holders nor the names 23 * of any contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * Alternatively, this software may be distributed under the terms of the 27 * GNU General Public License ("GPL") version 2 as published by the Free 28 * Software Foundation. 29 * 30 * NO WARRANTY 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 41 * POSSIBILITY OF SUCH DAMAGES. 42 */ 43 44 #ifndef __ACTBL3_H__ 45 #define __ACTBL3_H__ 46 47 /******************************************************************************* 48 * 49 * Additional ACPI Tables (3) 50 * 51 * These tables are not consumed directly by the ACPICA subsystem, but are 52 * included here to support device drivers and the AML disassembler. 53 * 54 * The tables in this file are fully defined within the ACPI specification. 55 * 56 ******************************************************************************/ 57 58 /* 59 * Values for description table header signatures for tables defined in this 60 * file. Useful because they make it more difficult to inadvertently type in 61 * the wrong signature. 62 */ 63 #define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */ 64 #define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */ 65 #define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */ 66 #define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */ 67 #define ACPI_SIG_MPST "MPST" /* Memory Power State Table */ 68 #define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */ 69 #define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */ 70 #define ACPI_SIG_RASF "RASF" /* RAS Feature table */ 71 #define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */ 72 73 #define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */ 74 #define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */ 75 76 /* Reserved table signatures */ 77 78 #define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */ 79 #define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */ 80 #define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */ 81 82 /* 83 * All tables must be byte-packed to match the ACPI specification, since 84 * the tables are provided by the system BIOS. 85 */ 86 #pragma pack(1) 87 88 /* 89 * Note: C bitfields are not used for this reason: 90 * 91 * "Bitfields are great and easy to read, but unfortunately the C language 92 * does not specify the layout of bitfields in memory, which means they are 93 * essentially useless for dealing with packed data in on-disk formats or 94 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me, 95 * this decision was a design error in C. Ritchie could have picked an order 96 * and stuck with it." Norman Ramsey. 97 * See http://stackoverflow.com/a/1053662/41661 98 */ 99 100 /******************************************************************************* 101 * 102 * BGRT - Boot Graphics Resource Table (ACPI 5.0) 103 * Version 1 104 * 105 ******************************************************************************/ 106 107 struct acpi_table_bgrt { 108 struct acpi_table_header header; /* Common ACPI table header */ 109 u16 version; 110 u8 status; 111 u8 image_type; 112 u64 image_address; 113 u32 image_offset_x; 114 u32 image_offset_y; 115 }; 116 117 /******************************************************************************* 118 * 119 * DRTM - Dynamic Root of Trust for Measurement table 120 * 121 ******************************************************************************/ 122 123 struct acpi_table_drtm { 124 struct acpi_table_header header; /* Common ACPI table header */ 125 u64 entry_base_address; 126 u64 entry_length; 127 u32 entry_address32; 128 u64 entry_address64; 129 u64 exit_address; 130 u64 log_area_address; 131 u32 log_area_length; 132 u64 arch_dependent_address; 133 u32 flags; 134 }; 135 136 /* 1) Validated Tables List */ 137 138 struct acpi_drtm_vtl_list { 139 u32 validated_table_list_count; 140 }; 141 142 /* 2) Resources List */ 143 144 struct acpi_drtm_resource_list { 145 u32 resource_list_count; 146 }; 147 148 /* 3) Platform-specific Identifiers List */ 149 150 struct acpi_drtm_id_list { 151 u32 id_list_count; 152 }; 153 154 /******************************************************************************* 155 * 156 * FPDT - Firmware Performance Data Table (ACPI 5.0) 157 * Version 1 158 * 159 ******************************************************************************/ 160 161 struct acpi_table_fpdt { 162 struct acpi_table_header header; /* Common ACPI table header */ 163 }; 164 165 /* FPDT subtable header */ 166 167 struct acpi_fpdt_header { 168 u16 type; 169 u8 length; 170 u8 revision; 171 }; 172 173 /* Values for Type field above */ 174 175 enum acpi_fpdt_type { 176 ACPI_FPDT_TYPE_BOOT = 0, 177 ACPI_FPDT_TYPE_S3PERF = 1 178 }; 179 180 /* 181 * FPDT subtables 182 */ 183 184 /* 0: Firmware Basic Boot Performance Record */ 185 186 struct acpi_fpdt_boot { 187 struct acpi_fpdt_header header; 188 u8 reserved[4]; 189 u64 reset_end; 190 u64 load_start; 191 u64 startup_start; 192 u64 exit_services_entry; 193 u64 exit_services_exit; 194 }; 195 196 /* 1: S3 Performance Table Pointer Record */ 197 198 struct acpi_fpdt_s3pt_ptr { 199 struct acpi_fpdt_header header; 200 u8 reserved[4]; 201 u64 address; 202 }; 203 204 /* 205 * S3PT - S3 Performance Table. This table is pointed to by the 206 * FPDT S3 Pointer Record above. 207 */ 208 struct acpi_table_s3pt { 209 u8 signature[4]; /* "S3PT" */ 210 u32 length; 211 }; 212 213 /* 214 * S3PT Subtables 215 */ 216 struct acpi_s3pt_header { 217 u16 type; 218 u8 length; 219 u8 revision; 220 }; 221 222 /* Values for Type field above */ 223 224 enum acpi_s3pt_type { 225 ACPI_S3PT_TYPE_RESUME = 0, 226 ACPI_S3PT_TYPE_SUSPEND = 1 227 }; 228 229 struct acpi_s3pt_resume { 230 struct acpi_s3pt_header header; 231 u32 resume_count; 232 u64 full_resume; 233 u64 average_resume; 234 }; 235 236 struct acpi_s3pt_suspend { 237 struct acpi_s3pt_header header; 238 u64 suspend_start; 239 u64 suspend_end; 240 }; 241 242 /******************************************************************************* 243 * 244 * GTDT - Generic Timer Description Table (ACPI 5.1) 245 * Version 2 246 * 247 ******************************************************************************/ 248 249 struct acpi_table_gtdt { 250 struct acpi_table_header header; /* Common ACPI table header */ 251 u64 counter_block_addresss; 252 u32 reserved; 253 u32 secure_el1_interrupt; 254 u32 secure_el1_flags; 255 u32 non_secure_el1_interrupt; 256 u32 non_secure_el1_flags; 257 u32 virtual_timer_interrupt; 258 u32 virtual_timer_flags; 259 u32 non_secure_el2_interrupt; 260 u32 non_secure_el2_flags; 261 u64 counter_read_block_address; 262 u32 platform_timer_count; 263 u32 platform_timer_offset; 264 }; 265 266 /* Flag Definitions: Timer Block Physical Timers and Virtual timers */ 267 268 #define ACPI_GTDT_INTERRUPT_MODE (1) 269 #define ACPI_GTDT_INTERRUPT_POLARITY (1<<1) 270 #define ACPI_GTDT_ALWAYS_ON (1<<2) 271 272 /* Common GTDT subtable header */ 273 274 struct acpi_gtdt_header { 275 u8 type; 276 u16 length; 277 }; 278 279 /* Values for GTDT subtable type above */ 280 281 enum acpi_gtdt_type { 282 ACPI_GTDT_TYPE_TIMER_BLOCK = 0, 283 ACPI_GTDT_TYPE_WATCHDOG = 1, 284 ACPI_GTDT_TYPE_RESERVED = 2 /* 2 and greater are reserved */ 285 }; 286 287 /* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */ 288 289 /* 0: Generic Timer Block */ 290 291 struct acpi_gtdt_timer_block { 292 struct acpi_gtdt_header header; 293 u8 reserved; 294 u64 block_address; 295 u32 timer_count; 296 u32 timer_offset; 297 }; 298 299 /* Timer Sub-Structure, one per timer */ 300 301 struct acpi_gtdt_timer_entry { 302 u8 frame_number; 303 u8 reserved[3]; 304 u64 base_address; 305 u64 el0_base_address; 306 u32 timer_interrupt; 307 u32 timer_flags; 308 u32 virtual_timer_interrupt; 309 u32 virtual_timer_flags; 310 u32 common_flags; 311 }; 312 313 /* Flag Definitions: common_flags above */ 314 315 #define ACPI_GTDT_GT_IS_SECURE_TIMER (1) 316 #define ACPI_GTDT_GT_ALWAYS_ON (1<<1) 317 318 /* 1: SBSA Generic Watchdog Structure */ 319 320 struct acpi_gtdt_watchdog { 321 struct acpi_gtdt_header header; 322 u8 reserved; 323 u64 refresh_frame_address; 324 u64 control_frame_address; 325 u32 timer_interrupt; 326 u32 timer_flags; 327 }; 328 329 /* Flag Definitions: timer_flags above */ 330 331 #define ACPI_GTDT_WATCHDOG_IRQ_MODE (1) 332 #define ACPI_GTDT_WATCHDOG_IRQ_POLARITY (1<<1) 333 #define ACPI_GTDT_WATCHDOG_SECURE (1<<2) 334 335 /******************************************************************************* 336 * 337 * MPST - Memory Power State Table (ACPI 5.0) 338 * Version 1 339 * 340 ******************************************************************************/ 341 342 #define ACPI_MPST_CHANNEL_INFO \ 343 u8 channel_id; \ 344 u8 reserved1[3]; \ 345 u16 power_node_count; \ 346 u16 reserved2; 347 348 /* Main table */ 349 350 struct acpi_table_mpst { 351 struct acpi_table_header header; /* Common ACPI table header */ 352 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */ 353 }; 354 355 /* Memory Platform Communication Channel Info */ 356 357 struct acpi_mpst_channel { 358 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */ 359 }; 360 361 /* Memory Power Node Structure */ 362 363 struct acpi_mpst_power_node { 364 u8 flags; 365 u8 reserved1; 366 u16 node_id; 367 u32 length; 368 u64 range_address; 369 u64 range_length; 370 u32 num_power_states; 371 u32 num_physical_components; 372 }; 373 374 /* Values for Flags field above */ 375 376 #define ACPI_MPST_ENABLED 1 377 #define ACPI_MPST_POWER_MANAGED 2 378 #define ACPI_MPST_HOT_PLUG_CAPABLE 4 379 380 /* Memory Power State Structure (follows POWER_NODE above) */ 381 382 struct acpi_mpst_power_state { 383 u8 power_state; 384 u8 info_index; 385 }; 386 387 /* Physical Component ID Structure (follows POWER_STATE above) */ 388 389 struct acpi_mpst_component { 390 u16 component_id; 391 }; 392 393 /* Memory Power State Characteristics Structure (follows all POWER_NODEs) */ 394 395 struct acpi_mpst_data_hdr { 396 u16 characteristics_count; 397 u16 reserved; 398 }; 399 400 struct acpi_mpst_power_data { 401 u8 structure_id; 402 u8 flags; 403 u16 reserved1; 404 u32 average_power; 405 u32 power_saving; 406 u64 exit_latency; 407 u64 reserved2; 408 }; 409 410 /* Values for Flags field above */ 411 412 #define ACPI_MPST_PRESERVE 1 413 #define ACPI_MPST_AUTOENTRY 2 414 #define ACPI_MPST_AUTOEXIT 4 415 416 /* Shared Memory Region (not part of an ACPI table) */ 417 418 struct acpi_mpst_shared { 419 u32 signature; 420 u16 pcc_command; 421 u16 pcc_status; 422 u32 command_register; 423 u32 status_register; 424 u32 power_state_id; 425 u32 power_node_id; 426 u64 energy_consumed; 427 u64 average_power; 428 }; 429 430 /******************************************************************************* 431 * 432 * PCCT - Platform Communications Channel Table (ACPI 5.0) 433 * Version 1 434 * 435 ******************************************************************************/ 436 437 struct acpi_table_pcct { 438 struct acpi_table_header header; /* Common ACPI table header */ 439 u32 flags; 440 u64 reserved; 441 }; 442 443 /* Values for Flags field above */ 444 445 #define ACPI_PCCT_DOORBELL 1 446 447 /* Values for subtable type in struct acpi_subtable_header */ 448 449 enum acpi_pcct_type { 450 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0, 451 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE = 1, 452 ACPI_PCCT_TYPE_RESERVED = 2 /* 2 and greater are reserved */ 453 }; 454 455 /* 456 * PCCT Subtables, correspond to Type in struct acpi_subtable_header 457 */ 458 459 /* 0: Generic Communications Subspace */ 460 461 struct acpi_pcct_subspace { 462 struct acpi_subtable_header header; 463 u8 reserved[6]; 464 u64 base_address; 465 u64 length; 466 struct acpi_generic_address doorbell_register; 467 u64 preserve_mask; 468 u64 write_mask; 469 u32 latency; 470 u32 max_access_rate; 471 u16 min_turnaround_time; 472 }; 473 474 /* 1: HW-reduced Communications Subspace (ACPI 5.1) */ 475 476 struct acpi_pcct_hw_reduced { 477 struct acpi_subtable_header header; 478 u32 doorbell_interrupt; 479 u8 flags; 480 u8 reserved; 481 u64 base_address; 482 u64 length; 483 struct acpi_generic_address doorbell_register; 484 u64 preserve_mask; 485 u64 write_mask; 486 u32 latency; 487 u32 max_access_rate; 488 u16 min_turnaround_time; 489 }; 490 491 /* Values for doorbell flags above */ 492 493 #define ACPI_PCCT_INTERRUPT_POLARITY (1) 494 #define ACPI_PCCT_INTERRUPT_MODE (1<<1) 495 496 /* 497 * PCC memory structures (not part of the ACPI table) 498 */ 499 500 /* Shared Memory Region */ 501 502 struct acpi_pcct_shared_memory { 503 u32 signature; 504 u16 command; 505 u16 status; 506 }; 507 508 /******************************************************************************* 509 * 510 * PMTT - Platform Memory Topology Table (ACPI 5.0) 511 * Version 1 512 * 513 ******************************************************************************/ 514 515 struct acpi_table_pmtt { 516 struct acpi_table_header header; /* Common ACPI table header */ 517 u32 reserved; 518 }; 519 520 /* Common header for PMTT subtables that follow main table */ 521 522 struct acpi_pmtt_header { 523 u8 type; 524 u8 reserved1; 525 u16 length; 526 u16 flags; 527 u16 reserved2; 528 }; 529 530 /* Values for Type field above */ 531 532 #define ACPI_PMTT_TYPE_SOCKET 0 533 #define ACPI_PMTT_TYPE_CONTROLLER 1 534 #define ACPI_PMTT_TYPE_DIMM 2 535 #define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */ 536 537 /* Values for Flags field above */ 538 539 #define ACPI_PMTT_TOP_LEVEL 0x0001 540 #define ACPI_PMTT_PHYSICAL 0x0002 541 #define ACPI_PMTT_MEMORY_TYPE 0x000C 542 543 /* 544 * PMTT subtables, correspond to Type in struct acpi_pmtt_header 545 */ 546 547 /* 0: Socket Structure */ 548 549 struct acpi_pmtt_socket { 550 struct acpi_pmtt_header header; 551 u16 socket_id; 552 u16 reserved; 553 }; 554 555 /* 1: Memory Controller subtable */ 556 557 struct acpi_pmtt_controller { 558 struct acpi_pmtt_header header; 559 u32 read_latency; 560 u32 write_latency; 561 u32 read_bandwidth; 562 u32 write_bandwidth; 563 u16 access_width; 564 u16 alignment; 565 u16 reserved; 566 u16 domain_count; 567 }; 568 569 /* 1a: Proximity Domain substructure */ 570 571 struct acpi_pmtt_domain { 572 u32 proximity_domain; 573 }; 574 575 /* 2: Physical Component Identifier (DIMM) */ 576 577 struct acpi_pmtt_physical_component { 578 struct acpi_pmtt_header header; 579 u16 component_id; 580 u16 reserved; 581 u32 memory_size; 582 u32 bios_handle; 583 }; 584 585 /******************************************************************************* 586 * 587 * RASF - RAS Feature Table (ACPI 5.0) 588 * Version 1 589 * 590 ******************************************************************************/ 591 592 struct acpi_table_rasf { 593 struct acpi_table_header header; /* Common ACPI table header */ 594 u8 channel_id[12]; 595 }; 596 597 /* RASF Platform Communication Channel Shared Memory Region */ 598 599 struct acpi_rasf_shared_memory { 600 u32 signature; 601 u16 command; 602 u16 status; 603 u16 version; 604 u8 capabilities[16]; 605 u8 set_capabilities[16]; 606 u16 num_parameter_blocks; 607 u32 set_capabilities_status; 608 }; 609 610 /* RASF Parameter Block Structure Header */ 611 612 struct acpi_rasf_parameter_block { 613 u16 type; 614 u16 version; 615 u16 length; 616 }; 617 618 /* RASF Parameter Block Structure for PATROL_SCRUB */ 619 620 struct acpi_rasf_patrol_scrub_parameter { 621 struct acpi_rasf_parameter_block header; 622 u16 patrol_scrub_command; 623 u64 requested_address_range[2]; 624 u64 actual_address_range[2]; 625 u16 flags; 626 u8 requested_speed; 627 }; 628 629 /* Masks for Flags and Speed fields above */ 630 631 #define ACPI_RASF_SCRUBBER_RUNNING 1 632 #define ACPI_RASF_SPEED (7<<1) 633 #define ACPI_RASF_SPEED_SLOW (0<<1) 634 #define ACPI_RASF_SPEED_MEDIUM (4<<1) 635 #define ACPI_RASF_SPEED_FAST (7<<1) 636 637 /* Channel Commands */ 638 639 enum acpi_rasf_commands { 640 ACPI_RASF_EXECUTE_RASF_COMMAND = 1 641 }; 642 643 /* Platform RAS Capabilities */ 644 645 enum acpi_rasf_capabiliities { 646 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0, 647 ACPI_SW_PATROL_SCRUB_EXPOSED = 1 648 }; 649 650 /* Patrol Scrub Commands */ 651 652 enum acpi_rasf_patrol_scrub_commands { 653 ACPI_RASF_GET_PATROL_PARAMETERS = 1, 654 ACPI_RASF_START_PATROL_SCRUBBER = 2, 655 ACPI_RASF_STOP_PATROL_SCRUBBER = 3 656 }; 657 658 /* Channel Command flags */ 659 660 #define ACPI_RASF_GENERATE_SCI (1<<15) 661 662 /* Status values */ 663 664 enum acpi_rasf_status { 665 ACPI_RASF_SUCCESS = 0, 666 ACPI_RASF_NOT_VALID = 1, 667 ACPI_RASF_NOT_SUPPORTED = 2, 668 ACPI_RASF_BUSY = 3, 669 ACPI_RASF_FAILED = 4, 670 ACPI_RASF_ABORTED = 5, 671 ACPI_RASF_INVALID_DATA = 6 672 }; 673 674 /* Status flags */ 675 676 #define ACPI_RASF_COMMAND_COMPLETE (1) 677 #define ACPI_RASF_SCI_DOORBELL (1<<1) 678 #define ACPI_RASF_ERROR (1<<2) 679 #define ACPI_RASF_STATUS (0x1F<<3) 680 681 /******************************************************************************* 682 * 683 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table 684 * Version 3 685 * 686 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011 687 * 688 ******************************************************************************/ 689 690 struct acpi_table_tpm2 { 691 struct acpi_table_header header; /* Common ACPI table header */ 692 u32 flags; 693 u64 control_address; 694 u32 start_method; 695 }; 696 697 /* Control area structure (not part of table, pointed to by control_address) */ 698 699 struct acpi_tpm2_control { 700 u32 reserved; 701 u32 error; 702 u32 cancel; 703 u32 start; 704 u64 interrupt_control; 705 u32 command_size; 706 u64 command_address; 707 u32 response_size; 708 u64 response_address; 709 }; 710 711 /* Reset to default packing */ 712 713 #pragma pack() 714 715 #endif /* __ACTBL3_H__ */ 716