[J-u-boot.git] / lib / acpi / acpi_table.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Generic code used to generate ACPI tables
 *
 * Copyright 2019 Google LLC
 */

#include <common.h>
#include <dm.h>
#include <cpu.h>
#include <mapmem.h>
#include <tables_csum.h>
#include <version.h>
#include <acpi/acpi_table.h>
#include <dm/acpi.h>

int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags)
{
	struct acpi_table_header *header = &dmar->header;
	struct cpu_info info;
	struct udevice *cpu;
	int ret;

	ret = uclass_first_device(UCLASS_CPU, &cpu);
	if (ret)
		return log_msg_ret("cpu", ret);
	ret = cpu_get_info(cpu, &info);
	if (ret)
		return log_msg_ret("info", ret);
	memset((void *)dmar, 0, sizeof(struct acpi_dmar));

	/* Fill out header fields. */
	acpi_fill_header(&dmar->header, "DMAR");
	header->length = sizeof(struct acpi_dmar);
	header->revision = acpi_get_table_revision(ACPITAB_DMAR);

	dmar->host_address_width = info.address_width - 1;
	dmar->flags = flags;

	return 0;
}

int acpi_get_table_revision(enum acpi_tables table)
{
	switch (table) {
	case ACPITAB_FADT:
		return ACPI_FADT_REV_ACPI_3_0;
	case ACPITAB_MADT:
		return ACPI_MADT_REV_ACPI_3_0;
	case ACPITAB_MCFG:
		return ACPI_MCFG_REV_ACPI_3_0;
	case ACPITAB_TCPA:
		/* This version and the rest are open-coded */
		return 2;
	case ACPITAB_TPM2:
		return 4;
	case ACPITAB_SSDT: /* ACPI 3.0 upto 6.3: 2 */
		return 2;
	case ACPITAB_SRAT: /* ACPI 2.0: 1, ACPI 3.0: 2, ACPI 4.0 to 6.3: 3 */
		return 1; /* TODO Should probably be upgraded to 2 */
	case ACPITAB_DMAR:
		return 1;
	case ACPITAB_SLIT: /* ACPI 2.0 upto 6.3: 1 */
		return 1;
	case ACPITAB_SPMI: /* IMPI 2.0 */
		return 5;
	case ACPITAB_HPET: /* Currently 1. Table added in ACPI 2.0 */
		return 1;
	case ACPITAB_VFCT: /* ACPI 2.0/3.0/4.0: 1 */
		return 1;
	case ACPITAB_IVRS:
		return IVRS_FORMAT_FIXED;
	case ACPITAB_DBG2:
		return 0;
	case ACPITAB_FACS: /* ACPI 2.0/3.0: 1, ACPI 4.0 to 6.3: 2 */
		return 1;
	case ACPITAB_RSDT: /* ACPI 1.0 upto 6.3: 1 */
		return 1;
	case ACPITAB_XSDT: /* ACPI 2.0 upto 6.3: 1 */
		return 1;
	case ACPITAB_RSDP: /* ACPI 2.0 upto 6.3: 2 */
		return 2;
	case ACPITAB_HEST:
		return 1;
	case ACPITAB_NHLT:
		return 5;
	case ACPITAB_BERT:
		return 1;
	case ACPITAB_SPCR:
		return 2;
	default:
		return -EINVAL;
	}
}

void acpi_fill_header(struct acpi_table_header *header, char *signature)
{
	memcpy(header->signature, signature, 4);
	memcpy(header->oem_id, OEM_ID, 6);
	memcpy(header->oem_table_id, OEM_TABLE_ID, 8);
	header->oem_revision = U_BOOT_BUILD_DATE;
	memcpy(header->aslc_id, ASLC_ID, 4);
}

void acpi_align(struct acpi_ctx *ctx)
{
	ctx->current = (void *)ALIGN((ulong)ctx->current, 16);
}

void acpi_align64(struct acpi_ctx *ctx)
{
	ctx->current = (void *)ALIGN((ulong)ctx->current, 64);
}

void acpi_inc(struct acpi_ctx *ctx, uint amount)
{
	ctx->current += amount;
}

void acpi_inc_align(struct acpi_ctx *ctx, uint amount)
{
	ctx->current += amount;
	acpi_align(ctx);
}

/**
 * Add an ACPI table to the RSDT (and XSDT) structure, recalculate length
 * and checksum.
 */
int acpi_add_table(struct acpi_ctx *ctx, void *table)
{
	int i, entries_num;
	struct acpi_rsdt *rsdt;
	struct acpi_xsdt *xsdt;

	/* The RSDT is mandatory while the XSDT is not */
	rsdt = ctx->rsdt;

	/* This should always be MAX_ACPI_TABLES */
	entries_num = ARRAY_SIZE(rsdt->entry);

	for (i = 0; i < entries_num; i++) {
		if (rsdt->entry[i] == 0)
			break;
	}

	if (i >= entries_num) {
		log_err("ACPI: Error: too many tables\n");
		return -E2BIG;
	}

	/* Add table to the RSDT */
	rsdt->entry[i] = map_to_sysmem(table);

	/* Fix RSDT length or the kernel will assume invalid entries */
	rsdt->header.length = sizeof(struct acpi_table_header) +
				(sizeof(u32) * (i + 1));

	/* Re-calculate checksum */
	rsdt->header.checksum = 0;
	rsdt->header.checksum = table_compute_checksum((u8 *)rsdt,
						       rsdt->header.length);

	/*
	 * And now the same thing for the XSDT. We use the same index as for
	 * now we want the XSDT and RSDT to always be in sync in U-Boot
	 */
	xsdt = ctx->xsdt;

	/* Add table to the XSDT */
	xsdt->entry[i] = map_to_sysmem(table);

	/* Fix XSDT length */
	xsdt->header.length = sizeof(struct acpi_table_header) +
				(sizeof(u64) * (i + 1));

	/* Re-calculate checksum */
	xsdt->header.checksum = 0;
	xsdt->header.checksum = table_compute_checksum((u8 *)xsdt,
						       xsdt->header.length);

	return 0;
}

static void acpi_write_rsdp(struct acpi_rsdp *rsdp, struct acpi_rsdt *rsdt,
			    struct acpi_xsdt *xsdt)
{
	memset(rsdp, 0, sizeof(struct acpi_rsdp));

	memcpy(rsdp->signature, RSDP_SIG, 8);
	memcpy(rsdp->oem_id, OEM_ID, 6);

	rsdp->length = sizeof(struct acpi_rsdp);
	rsdp->rsdt_address = map_to_sysmem(rsdt);

	rsdp->xsdt_address = map_to_sysmem(xsdt);
	rsdp->revision = ACPI_RSDP_REV_ACPI_2_0;

	/* Calculate checksums */
	rsdp->checksum = table_compute_checksum(rsdp, 20);
	rsdp->ext_checksum = table_compute_checksum(rsdp,
						    sizeof(struct acpi_rsdp));
}

static void acpi_write_rsdt(struct acpi_rsdt *rsdt)
{
	struct acpi_table_header *header = &rsdt->header;

	/* Fill out header fields */
	acpi_fill_header(header, "RSDT");
	header->length = sizeof(struct acpi_rsdt);
	header->revision = 1;

	/* Entries are filled in later, we come with an empty set */

	/* Fix checksum */
	header->checksum = table_compute_checksum(rsdt,
						  sizeof(struct acpi_rsdt));
}

static void acpi_write_xsdt(struct acpi_xsdt *xsdt)
{
	struct acpi_table_header *header = &xsdt->header;

	/* Fill out header fields */
	acpi_fill_header(header, "XSDT");
	header->length = sizeof(struct acpi_xsdt);
	header->revision = 1;

	/* Entries are filled in later, we come with an empty set */

	/* Fix checksum */
	header->checksum = table_compute_checksum(xsdt,
						  sizeof(struct acpi_xsdt));
}

void acpi_setup_base_tables(struct acpi_ctx *ctx, void *start)
{
	ctx->current = start;

	/* Align ACPI tables to 16 byte */
	acpi_align(ctx);
	gd->arch.acpi_start = map_to_sysmem(ctx->current);

	/* We need at least an RSDP and an RSDT Table */
	ctx->rsdp = ctx->current;
	acpi_inc_align(ctx, sizeof(struct acpi_rsdp));
	ctx->rsdt = ctx->current;
	acpi_inc_align(ctx, sizeof(struct acpi_rsdt));
	ctx->xsdt = ctx->current;
	acpi_inc_align(ctx, sizeof(struct acpi_xsdt));

	/* clear all table memory */
	memset((void *)start, '\0', ctx->current - start);

	acpi_write_rsdp(ctx->rsdp, ctx->rsdt, ctx->xsdt);
	acpi_write_rsdt(ctx->rsdt);
	acpi_write_xsdt(ctx->xsdt);
	/*
	 * Per ACPI spec, the FACS table address must be aligned to a 64 byte
	 * boundary (Windows checks this, but Linux does not).
	 */
	acpi_align64(ctx);
}
Commit	Line	Data
91fe8b79 SG	1	// SPDX-License-Identifier: GPL-2.0+
	2	/*
	3	* Generic code used to generate ACPI tables
	4	*
	5	* Copyright 2019 Google LLC
	6	*/
	7
	8	#include <common.h>
bfeb5d46 SG	9	#include <dm.h>
bfeb5d46 SG	10	#include <cpu.h>
29b35112 SG	11	#include <mapmem.h>
29b35112 SG	12	#include <tables_csum.h>
93f7f827	13	#include <version.h>
86e1778d SG	14	#include <acpi/acpi_table.h>
86e1778d SG	15	#include <dm/acpi.h>
bfeb5d46	16
bfeb5d46 SG	17	int acpi_create_dmar(struct acpi_dmar *dmar, enum dmar_flags flags)
	18	{
	19	struct acpi_table_header *header = &dmar->header;
	20	struct cpu_info info;
	21	struct udevice *cpu;
	22	int ret;
	23
	24	ret = uclass_first_device(UCLASS_CPU, &cpu);
	25	if (ret)
	26	return log_msg_ret("cpu", ret);
	27	ret = cpu_get_info(cpu, &info);
	28	if (ret)
	29	return log_msg_ret("info", ret);
	30	memset((void *)dmar, 0, sizeof(struct acpi_dmar));
	31
	32	/* Fill out header fields. */
	33	acpi_fill_header(&dmar->header, "DMAR");
	34	header->length = sizeof(struct acpi_dmar);
	35	header->revision = acpi_get_table_revision(ACPITAB_DMAR);
	36
	37	dmar->host_address_width = info.address_width - 1;
	38	dmar->flags = flags;
	39
	40	return 0;
	41	}
91fe8b79 SG	42
	43	int acpi_get_table_revision(enum acpi_tables table)
	44	{
	45	switch (table) {
	46	case ACPITAB_FADT:
	47	return ACPI_FADT_REV_ACPI_3_0;
	48	case ACPITAB_MADT:
	49	return ACPI_MADT_REV_ACPI_3_0;
	50	case ACPITAB_MCFG:
	51	return ACPI_MCFG_REV_ACPI_3_0;
	52	case ACPITAB_TCPA:
	53	/* This version and the rest are open-coded */
	54	return 2;
	55	case ACPITAB_TPM2:
	56	return 4;
	57	case ACPITAB_SSDT: /* ACPI 3.0 upto 6.3: 2 */
	58	return 2;
	59	case ACPITAB_SRAT: /* ACPI 2.0: 1, ACPI 3.0: 2, ACPI 4.0 to 6.3: 3 */
	60	return 1; /* TODO Should probably be upgraded to 2 */
	61	case ACPITAB_DMAR:
	62	return 1;
	63	case ACPITAB_SLIT: /* ACPI 2.0 upto 6.3: 1 */
	64	return 1;
	65	case ACPITAB_SPMI: /* IMPI 2.0 */
	66	return 5;
	67	case ACPITAB_HPET: /* Currently 1. Table added in ACPI 2.0 */
	68	return 1;
	69	case ACPITAB_VFCT: /* ACPI 2.0/3.0/4.0: 1 */
	70	return 1;
	71	case ACPITAB_IVRS:
	72	return IVRS_FORMAT_FIXED;
	73	case ACPITAB_DBG2:
	74	return 0;
	75	case ACPITAB_FACS: /* ACPI 2.0/3.0: 1, ACPI 4.0 to 6.3: 2 */
	76	return 1;
	77	case ACPITAB_RSDT: /* ACPI 1.0 upto 6.3: 1 */
	78	return 1;
	79	case ACPITAB_XSDT: /* ACPI 2.0 upto 6.3: 1 */
	80	return 1;
	81	case ACPITAB_RSDP: /* ACPI 2.0 upto 6.3: 2 */
	82	return 2;
	83	case ACPITAB_HEST:
	84	return 1;
	85	case ACPITAB_NHLT:
	86	return 5;
	87	case ACPITAB_BERT:
	88	return 1;
	89	case ACPITAB_SPCR:
	90	return 2;
	91	default:
	92	return -EINVAL;
	93	}
	94	}
93f7f827 SG	95
	96	void acpi_fill_header(struct acpi_table_header header, char signature)
	97	{
	98	memcpy(header->signature, signature, 4);
	99	memcpy(header->oem_id, OEM_ID, 6);
	100	memcpy(header->oem_table_id, OEM_TABLE_ID, 8);
	101	header->oem_revision = U_BOOT_BUILD_DATE;
	102	memcpy(header->aslc_id, ASLC_ID, 4);
	103	}
86e1778d SG	104
	105	void acpi_align(struct acpi_ctx *ctx)
	106	{
	107	ctx->current = (void *)ALIGN((ulong)ctx->current, 16);
	108	}
	109
	110	void acpi_align64(struct acpi_ctx *ctx)
	111	{
	112	ctx->current = (void *)ALIGN((ulong)ctx->current, 64);
	113	}
	114
	115	void acpi_inc(struct acpi_ctx *ctx, uint amount)
	116	{
	117	ctx->current += amount;
	118	}
	119
	120	void acpi_inc_align(struct acpi_ctx *ctx, uint amount)
	121	{
	122	ctx->current += amount;
	123	acpi_align(ctx);
	124	}
29b35112 SG	125
	126	/**
	127	* Add an ACPI table to the RSDT (and XSDT) structure, recalculate length
	128	* and checksum.
	129	*/
	130	int acpi_add_table(struct acpi_ctx ctx, void table)
	131	{
	132	int i, entries_num;
	133	struct acpi_rsdt *rsdt;
	134	struct acpi_xsdt *xsdt;
	135
	136	/* The RSDT is mandatory while the XSDT is not */
	137	rsdt = ctx->rsdt;
	138
	139	/* This should always be MAX_ACPI_TABLES */
	140	entries_num = ARRAY_SIZE(rsdt->entry);
	141
	142	for (i = 0; i < entries_num; i++) {
	143	if (rsdt->entry[i] == 0)
	144	break;
	145	}
	146
	147	if (i >= entries_num) {
	148	log_err("ACPI: Error: too many tables\n");
	149	return -E2BIG;
	150	}
	151
	152	/* Add table to the RSDT */
	153	rsdt->entry[i] = map_to_sysmem(table);
	154
	155	/* Fix RSDT length or the kernel will assume invalid entries */
	156	rsdt->header.length = sizeof(struct acpi_table_header) +
	157	(sizeof(u32) * (i + 1));
	158
	159	/* Re-calculate checksum */
	160	rsdt->header.checksum = 0;
	161	rsdt->header.checksum = table_compute_checksum((u8 *)rsdt,
	162	rsdt->header.length);
	163
	164	/*
	165	* And now the same thing for the XSDT. We use the same index as for
	166	* now we want the XSDT and RSDT to always be in sync in U-Boot
	167	*/
b38309b7	168	xsdt = ctx->xsdt;
29b35112 SG	169
	170	/* Add table to the XSDT */
	171	xsdt->entry[i] = map_to_sysmem(table);
	172
	173	/* Fix XSDT length */
	174	xsdt->header.length = sizeof(struct acpi_table_header) +
	175	(sizeof(u64) * (i + 1));
	176
	177	/* Re-calculate checksum */
	178	xsdt->header.checksum = 0;
	179	xsdt->header.checksum = table_compute_checksum((u8 *)xsdt,
	180	xsdt->header.length);
	181
	182	return 0;
	183	}
7e586f69 SG	184
	185	static void acpi_write_rsdp(struct acpi_rsdp rsdp, struct acpi_rsdt rsdt,
	186	struct acpi_xsdt *xsdt)
	187	{
	188	memset(rsdp, 0, sizeof(struct acpi_rsdp));
	189
	190	memcpy(rsdp->signature, RSDP_SIG, 8);
	191	memcpy(rsdp->oem_id, OEM_ID, 6);
	192
	193	rsdp->length = sizeof(struct acpi_rsdp);
	194	rsdp->rsdt_address = map_to_sysmem(rsdt);
	195
	196	rsdp->xsdt_address = map_to_sysmem(xsdt);
	197	rsdp->revision = ACPI_RSDP_REV_ACPI_2_0;
	198
	199	/* Calculate checksums */
	200	rsdp->checksum = table_compute_checksum(rsdp, 20);
	201	rsdp->ext_checksum = table_compute_checksum(rsdp,
	202	sizeof(struct acpi_rsdp));
	203	}
	204
	205	static void acpi_write_rsdt(struct acpi_rsdt *rsdt)
	206	{
	207	struct acpi_table_header *header = &rsdt->header;
	208
	209	/* Fill out header fields */
	210	acpi_fill_header(header, "RSDT");
	211	header->length = sizeof(struct acpi_rsdt);
	212	header->revision = 1;
	213
	214	/* Entries are filled in later, we come with an empty set */
	215
	216	/* Fix checksum */
	217	header->checksum = table_compute_checksum(rsdt,
	218	sizeof(struct acpi_rsdt));
	219	}
	220
	221	static void acpi_write_xsdt(struct acpi_xsdt *xsdt)
	222	{
	223	struct acpi_table_header *header = &xsdt->header;
	224
	225	/* Fill out header fields */
	226	acpi_fill_header(header, "XSDT");
	227	header->length = sizeof(struct acpi_xsdt);
	228	header->revision = 1;
	229
	230	/* Entries are filled in later, we come with an empty set */
	231
	232	/* Fix checksum */
	233	header->checksum = table_compute_checksum(xsdt,
	234	sizeof(struct acpi_xsdt));
	235	}
	236
	237	void acpi_setup_base_tables(struct acpi_ctx ctx, void start)
	238	{
7e586f69 SG	239	ctx->current = start;
	240
	241	/* Align ACPI tables to 16 byte */
	242	acpi_align(ctx);
0b885bcf	243	gd->arch.acpi_start = map_to_sysmem(ctx->current);
7e586f69 SG	244
	245	/* We need at least an RSDP and an RSDT Table */
	246	ctx->rsdp = ctx->current;
	247	acpi_inc_align(ctx, sizeof(struct acpi_rsdp));
	248	ctx->rsdt = ctx->current;
	249	acpi_inc_align(ctx, sizeof(struct acpi_rsdt));
b38309b7	250	ctx->xsdt = ctx->current;
7e586f69 SG	251	acpi_inc_align(ctx, sizeof(struct acpi_xsdt));
	252
	253	/* clear all table memory */
	254	memset((void *)start, '\0', ctx->current - start);
	255
b38309b7	256	acpi_write_rsdp(ctx->rsdp, ctx->rsdt, ctx->xsdt);
7e586f69	257	acpi_write_rsdt(ctx->rsdt);
b38309b7	258	acpi_write_xsdt(ctx->xsdt);
7e586f69 SG	259	/*
	260	* Per ACPI spec, the FACS table address must be aligned to a 64 byte
	261	* boundary (Windows checks this, but Linux does not).
	262	*/
	263	acpi_align64(ctx);
	264	}