[mirror_ubuntu-artful-kernel.git] / drivers / acpi / spcr.c

/*
 * Copyright (c) 2012, Intel Corporation
 * Copyright (c) 2015, Red Hat, Inc.
 * Copyright (c) 2015, 2016 Linaro Ltd.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */

#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
 * 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, similiar 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)
{
	if (tb->interface_type != ACPI_DBG2_16550_COMPATIBLE)
		return false;

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

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

	return false;
}

/**
 * parse_spcr() - parse ACPI SPCR table and add preferred console
 *
 * @earlycon: set up earlycon for 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 @earlycon is true, earlycon is set up.
 *
 * 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 parse_spcr(bool earlycon)
{
	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) {
		err = -ENOENT;
		pr_err("wrong table version\n");
		goto done;
	}

	if (table->serial_port.space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
		switch (table->serial_port.access_width) {
		default:
			pr_err("Unexpected SPCR Access Width.  Defaulting to byte size\n");
		case ACPI_ACCESS_SIZE_BYTE:
			iotype = "mmio";
			break;
		case ACPI_ACCESS_SIZE_WORD:
			iotype = "mmio16";
			break;
		case ACPI_ACCESS_SIZE_DWORD:
			iotype = "mmio32";
			break;
		}
	} else
		iotype = "io";

	switch (table->interface_type) {
	case ACPI_DBG2_ARM_SBSA_32BIT:
		iotype = "mmio32";
		/* fall through */
	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:
		uart = "uart";
		break;
	default:
		err = -ENOENT;
		goto done;
	}

	switch (table->baud_rate) {
	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 (earlycon)
			uart = "qdf2400_e44";
	}

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

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

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

	if (earlycon)
		setup_earlycon(opts);

	err = add_preferred_console(uart, 0, opts + strlen(uart) + 1);

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