[linux-block.git] / drivers / acpi / spcr.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2012, Intel Corporation
 * Copyright (c) 2015, Red Hat, Inc.
 * Copyright (c) 2015, 2016 Linaro Ltd.
 */

#define pr_fmt(fmt) "ACPI: SPCR: " fmt

#include <linux/acpi.h>
#include <linux/console.h>
#include <linux/kernel.h>
#include <linux/serial_core.h>

/*
 * Erratum 44 for QDF2432v1 and QDF2400v1 SoCs describes the BUSY bit as
 * occasionally getting stuck as 1. To avoid the potential for a hang, check
 * TXFE == 0 instead of BUSY == 1. This may not be suitable for all UART
 * implementations, so only do so if an affected platform is detected in
 * acpi_parse_spcr().
 */
bool qdf2400_e44_present;
EXPORT_SYMBOL(qdf2400_e44_present);

/*
 * Some Qualcomm Datacenter Technologies SoCs have a defective UART BUSY bit.
 * Detect them by examining the OEM fields in the SPCR header, similar to PCI
 * quirk detection in pci_mcfg.c.
 */
static bool qdf2400_erratum_44_present(struct acpi_table_header *h)
{
	if (memcmp(h->oem_id, "QCOM  ", ACPI_OEM_ID_SIZE))
		return false;

	if (!memcmp(h->oem_table_id, "QDF2432 ", ACPI_OEM_TABLE_ID_SIZE))
		return true;

	if (!memcmp(h->oem_table_id, "QDF2400 ", ACPI_OEM_TABLE_ID_SIZE) &&
			h->oem_revision == 1)
		return true;

	return false;
}

/*
 * APM X-Gene v1 and v2 UART hardware is an 16550 like device but has its
 * register aligned to 32-bit. In addition, the BIOS also encoded the
 * access width to be 8 bits. This function detects this errata condition.
 */
static bool xgene_8250_erratum_present(struct acpi_table_spcr *tb)
{
	bool xgene_8250 = false;

	if (tb->interface_type != ACPI_DBG2_16550_COMPATIBLE)
		return false;

	if (memcmp(tb->header.oem_id, "APMC0D", ACPI_OEM_ID_SIZE) &&
	    memcmp(tb->header.oem_id, "HPE   ", ACPI_OEM_ID_SIZE))
		return false;

	if (!memcmp(tb->header.oem_table_id, "XGENESPC",
	    ACPI_OEM_TABLE_ID_SIZE) && tb->header.oem_revision == 0)
		xgene_8250 = true;

	if (!memcmp(tb->header.oem_table_id, "ProLiant",
	    ACPI_OEM_TABLE_ID_SIZE) && tb->header.oem_revision == 1)
		xgene_8250 = true;

	return xgene_8250;
}

/**
 * acpi_parse_spcr() - parse ACPI SPCR table and add preferred console
 * @enable_earlycon: set up earlycon for the console specified by the table
 * @enable_console: setup the console specified by the table.
 *
 * For the architectures with support for ACPI, CONFIG_ACPI_SPCR_TABLE may be
 * defined to parse ACPI SPCR table.  As a result of the parsing preferred
 * console is registered and if @enable_earlycon is true, earlycon is set up.
 * If @enable_console is true the system console is also configured.
 *
 * When CONFIG_ACPI_SPCR_TABLE is defined, this function should be called
 * from arch initialization code as soon as the DT/ACPI decision is made.
 */
int __init acpi_parse_spcr(bool enable_earlycon, bool enable_console)
{
	static char opts[64];
	struct acpi_table_spcr *table;
	acpi_status status;
	char *uart;
	char *iotype;
	int baud_rate;
	int err;

	if (acpi_disabled)
		return -ENODEV;

	status = acpi_get_table(ACPI_SIG_SPCR, 0, (struct acpi_table_header **)&table);
	if (ACPI_FAILURE(status))
		return -ENOENT;

	if (table->header.revision < 2)
		pr_info("SPCR table version %d\n", table->header.revision);

	if (table->serial_port.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
		u32 bit_width = table->serial_port.access_width;

		if (bit_width > ACPI_ACCESS_BIT_MAX) {
			pr_err(FW_BUG "Unacceptable wide SPCR Access Width. Defaulting to byte size\n");
			bit_width = ACPI_ACCESS_BIT_DEFAULT;
		}
		switch (ACPI_ACCESS_BIT_WIDTH((bit_width))) {
		default:
			pr_err(FW_BUG "Unexpected SPCR Access Width. Defaulting to byte size\n");
			fallthrough;
		case 8:
			iotype = "mmio";
			break;
		case 16:
			iotype = "mmio16";
			break;
		case 32:
			iotype = "mmio32";
			break;
		}
	} else
		iotype = "io";

	switch (table->interface_type) {
	case ACPI_DBG2_ARM_SBSA_32BIT:
		iotype = "mmio32";
		fallthrough;
	case ACPI_DBG2_ARM_PL011:
	case ACPI_DBG2_ARM_SBSA_GENERIC:
	case ACPI_DBG2_BCM2835:
		uart = "pl011";
		break;
	case ACPI_DBG2_16550_COMPATIBLE:
	case ACPI_DBG2_16550_SUBSET:
	case ACPI_DBG2_16550_WITH_GAS:
	case ACPI_DBG2_16550_NVIDIA:
		uart = "uart";
		break;
	default:
		err = -ENOENT;
		goto done;
	}

	switch (table->baud_rate) {
	case 0:
		/*
		 * SPCR 1.04 defines 0 as a preconfigured state of UART.
		 * Assume firmware or bootloader configures console correctly.
		 */
		baud_rate = 0;
		break;
	case 3:
		baud_rate = 9600;
		break;
	case 4:
		baud_rate = 19200;
		break;
	case 6:
		baud_rate = 57600;
		break;
	case 7:
		baud_rate = 115200;
		break;
	default:
		err = -ENOENT;
		goto done;
	}

	/*
	 * If the E44 erratum is required, then we need to tell the pl011
	 * driver to implement the work-around.
	 *
	 * The global variable is used by the probe function when it
	 * creates the UARTs, whether or not they're used as a console.
	 *
	 * If the user specifies "traditional" earlycon, the qdf2400_e44
	 * console name matches the EARLYCON_DECLARE() statement, and
	 * SPCR is not used.  Parameter "earlycon" is false.
	 *
	 * If the user specifies "SPCR" earlycon, then we need to update
	 * the console name so that it also says "qdf2400_e44".  Parameter
	 * "earlycon" is true.
	 *
	 * For consistency, if we change the console name, then we do it
	 * for everyone, not just earlycon.
	 */
	if (qdf2400_erratum_44_present(&table->header)) {
		qdf2400_e44_present = true;
		if (enable_earlycon)
			uart = "qdf2400_e44";
	}

	if (xgene_8250_erratum_present(table)) {
		iotype = "mmio32";

		/*
		 * For xgene v1 and v2 we don't know the clock rate of the
		 * UART so don't attempt to change to the baud rate state
		 * in the table because driver cannot calculate the dividers
		 */
		baud_rate = 0;
	}

	if (!baud_rate) {
		snprintf(opts, sizeof(opts), "%s,%s,0x%llx", uart, iotype,
			 table->serial_port.address);
	} else {
		snprintf(opts, sizeof(opts), "%s,%s,0x%llx,%d", uart, iotype,
			 table->serial_port.address, baud_rate);
	}

	pr_info("console: %s\n", opts);

	if (enable_earlycon)
		setup_earlycon(opts);

	if (enable_console)
		err = add_preferred_console(uart, 0, opts + strlen(uart) + 1);
	else
		err = 0;
done:
	acpi_put_table((struct acpi_table_header *)table);
	return err;
}
Commit	Line	Data
d2912cb1	1	// SPDX-License-Identifier: GPL-2.0-only
ad1696f6 AM	2	/*
	3	* Copyright (c) 2012, Intel Corporation
	4	* Copyright (c) 2015, Red Hat, Inc.
	5	* Copyright (c) 2015, 2016 Linaro Ltd.
ad1696f6 AM	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
37ef38f3 TT	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
0231d000	20	* acpi_parse_spcr().
37ef38f3 TT	21	*/
	22	bool qdf2400_e44_present;
	23	EXPORT_SYMBOL(qdf2400_e44_present);
	24
d8a4995b CC	25	/*
d8a4995b CC	26	* Some Qualcomm Datacenter Technologies SoCs have a defective UART BUSY bit.
603fadf3	27	* Detect them by examining the OEM fields in the SPCR header, similar to PCI
d8a4995b CC	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) &&
542ed784	39	h->oem_revision == 1)
d8a4995b CC	40	return true;
	41
	42	return false;
	43	}
	44
79a64832 LH	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	{
dee82bc1 GG	52	bool xgene_8250 = false;
dee82bc1 GG	53
79a64832 LH	54	if (tb->interface_type != ACPI_DBG2_16550_COMPATIBLE)
	55	return false;
	56
dee82bc1 GG	57	if (memcmp(tb->header.oem_id, "APMC0D", ACPI_OEM_ID_SIZE) &&
dee82bc1 GG	58	memcmp(tb->header.oem_id, "HPE ", ACPI_OEM_ID_SIZE))
79a64832 LH	59	return false;
	60
	61	if (!memcmp(tb->header.oem_table_id, "XGENESPC",
	62	ACPI_OEM_TABLE_ID_SIZE) && tb->header.oem_revision == 0)
dee82bc1	63	xgene_8250 = true;
79a64832	64
dee82bc1 GG	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;
79a64832 LH	70	}
79a64832 LH	71
ad1696f6	72	/**
0231d000	73	* acpi_parse_spcr() - parse ACPI SPCR table and add preferred console
0231d000 PB	74	* @enable_earlycon: set up earlycon for the console specified by the table
0231d000 PB	75	* @enable_console: setup the console specified by the table.
ad1696f6 AM	76	*
	77	* For the architectures with support for ACPI, CONFIG_ACPI_SPCR_TABLE may be
	78	* defined to parse ACPI SPCR table. As a result of the parsing preferred
0231d000 PB	79	* console is registered and if @enable_earlycon is true, earlycon is set up.
0231d000 PB	80	* If @enable_console is true the system console is also configured.
ad1696f6 AM	81	*
ad1696f6 AM	82	* When CONFIG_ACPI_SPCR_TABLE is defined, this function should be called
183b8021	83	* from arch initialization code as soon as the DT/ACPI decision is made.
ad1696f6	84	*/
0231d000	85	int __init acpi_parse_spcr(bool enable_earlycon, bool enable_console)
ad1696f6 AM	86	{
	87	static char opts[64];
	88	struct acpi_table_spcr *table;
ad1696f6 AM	89	acpi_status status;
	90	char *uart;
	91	char *iotype;
	92	int baud_rate;
	93	int err;
	94
	95	if (acpi_disabled)
	96	return -ENODEV;
	97
dcf0c2e0	98	status = acpi_get_table(ACPI_SIG_SPCR, 0, (struct acpi_table_header **)&table);
ad1696f6 AM	99	if (ACPI_FAILURE(status))
	100	return -ENOENT;
	101
0231d000 PB	102	if (table->header.revision < 2)
0231d000 PB	103	pr_info("SPCR table version %d\n", table->header.revision);
ad1696f6	104
2bece493	105	if (table->serial_port.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
ee3fe99f ML	106	u32 bit_width = table->serial_port.access_width;
	107
	108	if (bit_width > ACPI_ACCESS_BIT_MAX) {
da30a34a	109	pr_err(FW_BUG "Unacceptable wide SPCR Access Width. Defaulting to byte size\n");
ee3fe99f ML	110	bit_width = ACPI_ACCESS_BIT_DEFAULT;
	111	}
	112	switch (ACPI_ACCESS_BIT_WIDTH((bit_width))) {
2bece493	113	default:
da30a34a	114	pr_err(FW_BUG "Unexpected SPCR Access Width. Defaulting to byte size\n");
57d2dd4b	115	fallthrough;
4eebedd8	116	case 8:
2bece493 LH	117	iotype = "mmio";
2bece493 LH	118	break;
4eebedd8	119	case 16:
2bece493 LH	120	iotype = "mmio16";
2bece493 LH	121	break;
4eebedd8	122	case 32:
2bece493 LH	123	iotype = "mmio32";
	124	break;
	125	}
	126	} else
	127	iotype = "io";
ad1696f6 AM	128
	129	switch (table->interface_type) {
	130	case ACPI_DBG2_ARM_SBSA_32BIT:
	131	iotype = "mmio32";
57d2dd4b	132	fallthrough;
ad1696f6 AM	133	case ACPI_DBG2_ARM_PL011:
	134	case ACPI_DBG2_ARM_SBSA_GENERIC:
	135	case ACPI_DBG2_BCM2835:
	136	uart = "pl011";
	137	break;
	138	case ACPI_DBG2_16550_COMPATIBLE:
	139	case ACPI_DBG2_16550_SUBSET:
2aaea6a1	140	case ACPI_DBG2_16550_WITH_GAS:
3a506ca2	141	case ACPI_DBG2_16550_NVIDIA:
ad1696f6 AM	142	uart = "uart";
	143	break;
	144	default:
	145	err = -ENOENT;
	146	goto done;
	147	}
	148
	149	switch (table->baud_rate) {
b413b1ab AS	150	case 0:
	151	/*
	152	* SPCR 1.04 defines 0 as a preconfigured state of UART.
	153	* Assume firmware or bootloader configures console correctly.
	154	*/
	155	baud_rate = 0;
	156	break;
ad1696f6 AM	157	case 3:
	158	baud_rate = 9600;
	159	break;
	160	case 4:
	161	baud_rate = 19200;
	162	break;
	163	case 6:
	164	baud_rate = 57600;
	165	break;
	166	case 7:
	167	baud_rate = 115200;
	168	break;
	169	default:
	170	err = -ENOENT;
	171	goto done;
	172	}
	173
37ef38f3 TT	174	/*
	175	* If the E44 erratum is required, then we need to tell the pl011
	176	* driver to implement the work-around.
	177	*
	178	* The global variable is used by the probe function when it
	179	* creates the UARTs, whether or not they're used as a console.
	180	*
	181	* If the user specifies "traditional" earlycon, the qdf2400_e44
	182	* console name matches the EARLYCON_DECLARE() statement, and
	183	* SPCR is not used. Parameter "earlycon" is false.
	184	*
	185	* If the user specifies "SPCR" earlycon, then we need to update
	186	* the console name so that it also says "qdf2400_e44". Parameter
	187	* "earlycon" is true.
	188	*
	189	* For consistency, if we change the console name, then we do it
	190	* for everyone, not just earlycon.
	191	*/
	192	if (qdf2400_erratum_44_present(&table->header)) {
	193	qdf2400_e44_present = true;
0231d000	194	if (enable_earlycon)
37ef38f3 TT	195	uart = "qdf2400_e44";
	196	}
	197
03c3876f	198	if (xgene_8250_erratum_present(table)) {
79a64832	199	iotype = "mmio32";
d8a4995b	200
dcf0c2e0 AS	201	/*
dcf0c2e0 AS	202	* For xgene v1 and v2 we don't know the clock rate of the
03c3876f GG	203	* UART so don't attempt to change to the baud rate state
	204	* in the table because driver cannot calculate the dividers
	205	*/
b413b1ab AS	206	baud_rate = 0;
	207	}
	208
	209	if (!baud_rate) {
03c3876f GG	210	snprintf(opts, sizeof(opts), "%s,%s,0x%llx", uart, iotype,
	211	table->serial_port.address);
	212	} else {
	213	snprintf(opts, sizeof(opts), "%s,%s,0x%llx,%d", uart, iotype,
	214	table->serial_port.address, baud_rate);
	215	}
ad1696f6 AM	216
	217	pr_info("console: %s\n", opts);
	218
0231d000	219	if (enable_earlycon)
ad1696f6 AM	220	setup_earlycon(opts);
ad1696f6 AM	221
0231d000 PB	222	if (enable_console)
	223	err = add_preferred_console(uart, 0, opts + strlen(uart) + 1);
	224	else
	225	err = 0;
ad1696f6	226	done:
6b11d1d6	227	acpi_put_table((struct acpi_table_header *)table);
ad1696f6 AM	228	return err;
ad1696f6 AM	229	}