drivers/acpi/spcr.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2012, Intel Corporation
   4  * Copyright (c) 2015, Red Hat, Inc.
   5  * Copyright (c) 2015, 2016 Linaro Ltd.
   6  */
   7
   8 #define pr_fmt(fmt) "ACPI: SPCR: " fmt
   9
  10 #include <linux/acpi.h>
  11 #include <linux/console.h>
  12 #include <linux/kernel.h>
  13 #include <linux/serial_core.h>
  14
  15 /*
  16  * Erratum 44 for QDF2432v1 and QDF2400v1 SoCs describes the BUSY bit as
  17  * occasionally getting stuck as 1. To avoid the potential for a hang, check
  18  * TXFE == 0 instead of BUSY == 1. This may not be suitable for all UART
  19  * implementations, so only do so if an affected platform is detected in
  20  * acpi_parse_spcr().
  21  */
  22 bool qdf2400_e44_present;
  23 EXPORT_SYMBOL(qdf2400_e44_present);
  24
  25 /*
  26  * Some Qualcomm Datacenter Technologies SoCs have a defective UART BUSY bit.
  27  * Detect them by examining the OEM fields in the SPCR header, similar to PCI
  28  * quirk detection in pci_mcfg.c.
  29  */
  30 static bool qdf2400_erratum_44_present(struct acpi_table_header *h)
  31 {
  32         if (memcmp(h->oem_id, "QCOM  ", ACPI_OEM_ID_SIZE))
  33                 return false;
  34
  35         if (!memcmp(h->oem_table_id, "QDF2432 ", ACPI_OEM_TABLE_ID_SIZE))
  36                 return true;
  37
  38         if (!memcmp(h->oem_table_id, "QDF2400 ", ACPI_OEM_TABLE_ID_SIZE) &&
  39                         h->oem_revision == 1)
  40                 return true;
  41
  42         return false;
  43 }
  44
  45 /*
  46  * APM X-Gene v1 and v2 UART hardware is an 16550 like device but has its
  47  * register aligned to 32-bit. In addition, the BIOS also encoded the
  48  * access width to be 8 bits. This function detects this errata condition.
  49  */
  50 static bool xgene_8250_erratum_present(struct acpi_table_spcr *tb)
  51 {
  52         bool xgene_8250 = false;
  53
  54         if (tb->interface_type != ACPI_DBG2_16550_COMPATIBLE)
  55                 return false;
  56
  57         if (memcmp(tb->header.oem_id, "APMC0D", ACPI_OEM_ID_SIZE) &&
  58             memcmp(tb->header.oem_id, "HPE   ", ACPI_OEM_ID_SIZE))
  59                 return false;
  60
  61         if (!memcmp(tb->header.oem_table_id, "XGENESPC",
  62             ACPI_OEM_TABLE_ID_SIZE) && tb->header.oem_revision == 0)
  63                 xgene_8250 = true;
  64
  65         if (!memcmp(tb->header.oem_table_id, "ProLiant",
  66             ACPI_OEM_TABLE_ID_SIZE) && tb->header.oem_revision == 1)
  67                 xgene_8250 = true;
  68
  69         return xgene_8250;
  70 }
  71
  72 /**
  73  * acpi_parse_spcr() - parse ACPI SPCR table and add preferred console
  74  *
  75  * @enable_earlycon: set up earlycon for the console specified by the table
  76  * @enable_console: setup the console specified by the table.
  77  *
  78  * For the architectures with support for ACPI, CONFIG_ACPI_SPCR_TABLE may be
  79  * defined to parse ACPI SPCR table.  As a result of the parsing preferred
  80  * console is registered and if @enable_earlycon is true, earlycon is set up.
  81  * If @enable_console is true the system console is also configured.
  82  *
  83  * When CONFIG_ACPI_SPCR_TABLE is defined, this function should be called
  84  * from arch initialization code as soon as the DT/ACPI decision is made.
  85  *
  86  */
  87 int __init acpi_parse_spcr(bool enable_earlycon, bool enable_console)
  88 {
  89         static char opts[64];
  90         struct acpi_table_spcr *table;
  91         acpi_status status;
  92         char *uart;
  93         char *iotype;
  94         int baud_rate;
  95         int err;
  96
  97         if (acpi_disabled)
  98                 return -ENODEV;
  99
 100         status = acpi_get_table(ACPI_SIG_SPCR, 0,
 101                                 (struct acpi_table_header **)&table);
 102
 103         if (ACPI_FAILURE(status))
 104                 return -ENOENT;
 105
 106         if (table->header.revision < 2)
 107                 pr_info("SPCR table version %d\n", table->header.revision);
 108
 109         if (table->serial_port.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 110                 u32 bit_width = table->serial_port.access_width;
 111
 112                 if (bit_width > ACPI_ACCESS_BIT_MAX) {
 113                         pr_err("Unacceptable wide SPCR Access Width.  Defaulting to byte size\n");
 114                         bit_width = ACPI_ACCESS_BIT_DEFAULT;
 115                 }
 116                 switch (ACPI_ACCESS_BIT_WIDTH((bit_width))) {
 117                 default:
 118                         pr_err("Unexpected SPCR Access Width.  Defaulting to byte size\n");
 119                         fallthrough;
 120                 case 8:
 121                         iotype = "mmio";
 122                         break;
 123                 case 16:
 124                         iotype = "mmio16";
 125                         break;
 126                 case 32:
 127                         iotype = "mmio32";
 128                         break;
 129                 }
 130         } else
 131                 iotype = "io";
 132
 133         switch (table->interface_type) {
 134         case ACPI_DBG2_ARM_SBSA_32BIT:
 135                 iotype = "mmio32";
 136                 fallthrough;
 137         case ACPI_DBG2_ARM_PL011:
 138         case ACPI_DBG2_ARM_SBSA_GENERIC:
 139         case ACPI_DBG2_BCM2835:
 140                 uart = "pl011";
 141                 break;
 142         case ACPI_DBG2_16550_COMPATIBLE:
 143         case ACPI_DBG2_16550_SUBSET:
 144         case ACPI_DBG2_16550_WITH_GAS:
 145         case ACPI_DBG2_16550_NVIDIA:
 146                 uart = "uart";
 147                 break;
 148         default:
 149                 err = -ENOENT;
 150                 goto done;
 151         }
 152
 153         switch (table->baud_rate) {
 154         case 0:
 155                 /*
 156                  * SPCR 1.04 defines 0 as a preconfigured state of UART.
 157                  * Assume firmware or bootloader configures console correctly.
 158                  */
 159                 baud_rate = 0;
 160                 break;
 161         case 3:
 162                 baud_rate = 9600;
 163                 break;
 164         case 4:
 165                 baud_rate = 19200;
 166                 break;
 167         case 6:
 168                 baud_rate = 57600;
 169                 break;
 170         case 7:
 171                 baud_rate = 115200;
 172                 break;
 173         default:
 174                 err = -ENOENT;
 175                 goto done;
 176         }
 177
 178         /*
 179          * If the E44 erratum is required, then we need to tell the pl011
 180          * driver to implement the work-around.
 181          *
 182          * The global variable is used by the probe function when it
 183          * creates the UARTs, whether or not they're used as a console.
 184          *
 185          * If the user specifies "traditional" earlycon, the qdf2400_e44
 186          * console name matches the EARLYCON_DECLARE() statement, and
 187          * SPCR is not used.  Parameter "earlycon" is false.
 188          *
 189          * If the user specifies "SPCR" earlycon, then we need to update
 190          * the console name so that it also says "qdf2400_e44".  Parameter
 191          * "earlycon" is true.
 192          *
 193          * For consistency, if we change the console name, then we do it
 194          * for everyone, not just earlycon.
 195          */
 196         if (qdf2400_erratum_44_present(&table->header)) {
 197                 qdf2400_e44_present = true;
 198                 if (enable_earlycon)
 199                         uart = "qdf2400_e44";
 200         }
 201
 202         if (xgene_8250_erratum_present(table)) {
 203                 iotype = "mmio32";
 204
 205                 /* for xgene v1 and v2 we don't know the clock rate of the
 206                  * UART so don't attempt to change to the baud rate state
 207                  * in the table because driver cannot calculate the dividers
 208                  */
 209                 baud_rate = 0;
 210         }
 211
 212         if (!baud_rate) {
 213                 snprintf(opts, sizeof(opts), "%s,%s,0x%llx", uart, iotype,
 214                          table->serial_port.address);
 215         } else {
 216                 snprintf(opts, sizeof(opts), "%s,%s,0x%llx,%d", uart, iotype,
 217                          table->serial_port.address, baud_rate);
 218         }
 219
 220         pr_info("console: %s\n", opts);
 221
 222         if (enable_earlycon)
 223                 setup_earlycon(opts);
 224
 225         if (enable_console)
 226                 err = add_preferred_console(uart, 0, opts + strlen(uart) + 1);
 227         else
 228                 err = 0;
 229 done:
 230         acpi_put_table((struct acpi_table_header *)table);
 231         return err;
 232 }