|
| 1 | +#pragma once |
| 2 | +#include <acpi.h> |
| 3 | +#include <common.h> |
| 4 | +#include <common/dbg2.h> |
| 5 | + |
| 6 | +/** Serial Port Console Redirection Table (SPCR) |
| 7 | + Reference: |
| 8 | + https://learn.microsoft.com/en-us/windows-hardware/drivers/bringup/serial-port-console-redirection-table |
| 9 | + */ |
| 10 | + |
| 11 | +/* Table signature */ |
| 12 | +#define ACPI_SPCR_SIGNATURE 'S', 'P', 'C', 'R' |
| 13 | +// #define ACPI_SPCR_REVISION 4 |
| 14 | +#define ACPI_SPCR_REVISION 2 |
| 15 | + |
| 16 | +#define ACPI_SPCR_TABLE_STRUCTURE_NAME SERIAL_PORT_CONSOLE_REDIRECTION_TABLE |
| 17 | + |
| 18 | +/* Header Extra Data */ |
| 19 | +typedef struct { |
| 20 | + UINT8 InterfaceType; |
| 21 | + UINT8 Reserved[3]; |
| 22 | + ACPI_GAS BaseAddress; |
| 23 | + UINT8 InterruptType; |
| 24 | + UINT8 Irq; |
| 25 | + UINT32 GlobalSystemInterrupt; |
| 26 | + UINT8 ConfiguredBaudRate; |
| 27 | + UINT8 Parity; |
| 28 | + UINT8 StopBits; |
| 29 | + UINT8 FlowControl; |
| 30 | + UINT8 TerminalType; |
| 31 | + UINT8 Language; |
| 32 | + UINT16 PciDeviceId; |
| 33 | + UINT16 PciVendorId; |
| 34 | + UINT8 PciBusNumber; |
| 35 | + UINT8 PciDeviceNumber; |
| 36 | + UINT8 PciFunctionNumber; |
| 37 | + UINT32 PciFlags; // Must be 0 if it is not a PCI device |
| 38 | + UINT8 PciSegment; |
| 39 | +#if ACPI_SPCR_REVISION == 4 |
| 40 | + UINT32 UARTClockFrequency; |
| 41 | + UINT32 PreciseBaudRate; |
| 42 | + UINT16 NameSpaceStringLength; |
| 43 | + UINT16 NameSpaceStringOffset; |
| 44 | + // CHAR8 NameSpaceString[NameSpaceStringLength]; |
| 45 | + // followed by Debug device info |
| 46 | +#elif ACPI_SPCR_REVISION == 2 |
| 47 | + UINT8 Reserved2[4]; |
| 48 | +#endif |
| 49 | +} __attribute__((packed)) SPCR_HEADER_EXTRA_DATA; |
| 50 | +#if ACPI_SPCR_REVISION == 4 |
| 51 | +_Static_assert(sizeof(SPCR_HEADER_EXTRA_DATA) == 88 - sizeof(ACPI_TABLE_HEADER), |
| 52 | + "SPCR_HEADER_EXTRA_DATA size incorrect"); |
| 53 | +#elif ACPI_SPCR_REVISION == 2 |
| 54 | +_Static_assert(sizeof(SPCR_HEADER_EXTRA_DATA) == 80 - sizeof(ACPI_TABLE_HEADER), |
| 55 | + "SPCR_HEADER_EXTRA_DATA size incorrect"); |
| 56 | +#endif |
| 57 | + |
| 58 | +enum SPCR_INTERRUPT_TYPE { |
| 59 | + SPCR_INTERRUPT_TYPE_DUAL_8259_IRQ = BIT(0), |
| 60 | + SPCR_INTERRUPT_TYPE_IOAPIC_INTERRUPT = BIT(1), |
| 61 | + SPCR_INTERRUPT_TYPE_IOSAPIC_INTERRUPT = BIT(2), |
| 62 | + SPCR_INTERRUPT_TYPE_ARMH_GIC = BIT(3), |
| 63 | + SPCR_INTERRUPT_TYPE_RISCV_PLIC_APLIC = BIT(4), |
| 64 | + SPCR_INTERRUPT_TYPE_RESERVED2 = 0xFF, |
| 65 | +}; |
| 66 | + |
| 67 | +enum SPCR_CONFIGURED_BAUD_RATE { |
| 68 | + SPCR_CONFIGURED_BAUD_RATE_RELIES_ON_DRIVER = 0, |
| 69 | + SPCR_CONFIGURED_BAUD_RATE_9600 = 3, |
| 70 | + SPCR_CONFIGURED_BAUD_RATE_19200 = 4, |
| 71 | + SPCR_CONFIGURED_BAUD_RATE_57600 = 6, |
| 72 | + SPCR_CONFIGURED_BAUD_RATE_115200 = 7, |
| 73 | + SPCR_CONFIGURED_BAUD_RATE_RESERVED = 0xFF, |
| 74 | +}; |
| 75 | + |
| 76 | +enum SPCR_PARITY { |
| 77 | + SPCR_PARITY_NO_PARITY = 0, |
| 78 | + /* 1 - 255 reserved */ |
| 79 | + SPCR_PARITY_RESERVED = 0xFF, |
| 80 | +}; |
| 81 | + |
| 82 | +enum SPCR_STOP_BITS { |
| 83 | + SPCR_STOP_BITS_ONE_STOP_BIT = 1, |
| 84 | + SPCR_STOP_BITS_RESERVED = 0xFF |
| 85 | +}; |
| 86 | + |
| 87 | +enum SPCR_FLOW_CONTROL { |
| 88 | + SPCR_FLOW_CONTROL_NONE = 0, |
| 89 | + SPCR_FLOW_CONTROL_DCD_REQUIRED_FOR_TRANSMIT = BIT(0), |
| 90 | + SPCR_FLOW_CONTROL_RTS_CTS_HARDWARE_FLOW_CONTROL = BIT(1), |
| 91 | + SPCR_FLOW_CONTROL_XON_XOFF_SOFTWARE_FLOW_CONTROL = BIT(2), |
| 92 | + /* BIT[3:7] reserved */ |
| 93 | + SPCR_FLOW_CONTROL_RESERVED = 0xFF, |
| 94 | +}; |
| 95 | + |
| 96 | +enum SPCR_TERMINAL_TYPE { |
| 97 | + SPCR_TERMINAL_TYPE_VT100 = 0, |
| 98 | + SPCR_TERMINAL_TYPE_EXT_VT100 = 1, |
| 99 | + SPCR_TERMINAL_TYPE_VT_UTF8 = 2, |
| 100 | + SPCR_TERMINAL_TYPE_VT_ANSI = 3, |
| 101 | + /* 4 - 255 reserved */ |
| 102 | + SPCR_TERMINAL_TYPE_RESERVED = 0xFF, |
| 103 | +}; |
| 104 | + |
| 105 | +/* Helper macros */ |
| 106 | +#if ACPI_SPCR_REVISION == 2 |
| 107 | +#define SPCR_DEFINE_TABLE \ |
| 108 | + typedef struct { \ |
| 109 | + ACPI_TABLE_HEADER Header; \ |
| 110 | + SPCR_HEADER_EXTRA_DATA SPCRHeaderExtraData; \ |
| 111 | + } __attribute__((packed)) ACPI_SPCR_TABLE_STRUCTURE_NAME; |
| 112 | +#elif ACPI_SPCR_REVISION == 4 |
| 113 | +#define SPCR_DEFINE_TABLE(namespace_str) \ |
| 114 | + typedef struct { \ |
| 115 | + ACPI_TABLE_HEADER Header; \ |
| 116 | + SPCR_HEADER_EXTRA_DATA SPCRHeaderExtraData; \ |
| 117 | + CHAR8 NamespaceString[sizeof(namespace_str)]; \ |
| 118 | + } __attribute__((packed)) ACPI_SPCR_TABLE_STRUCTURE_NAME; |
| 119 | +#endif |
| 120 | + |
| 121 | +#define SPCR_DECLARE_HEADER \ |
| 122 | + ACPI_DECLARE_TABLE_HEADER( \ |
| 123 | + ACPI_SPCR_SIGNATURE, ACPI_SPCR_TABLE_STRUCTURE_NAME, ACPI_SPCR_REVISION) |
| 124 | + |
| 125 | +/* SPCR Table with Magic */ |
| 126 | +#define SPCR_DEFINE_WITH_MAGIC \ |
| 127 | + ACPI_TABLE_WITH_MAGIC(ACPI_SPCR_TABLE_STRUCTURE_NAME) |
| 128 | +#define SPCR_START ACPI_TABLE_START(ACPI_SPCR_TABLE_STRUCTURE_NAME) |
| 129 | +#define SPCR_END ACPI_TABLE_END(ACPI_SPCR_TABLE_STRUCTURE_NAME) |
0 commit comments