lib: NHLT ACPI table support

Intel's SST (Smart Sound Technology) employs audio support
which may not consist of HDA. In order to define the topology
of the audio devices (mics, amps, codecs) connected to the
platform a NHLT specification was created to pass this
information from the firmware to the OS/userland.

BUG=chrome-os-partner:44481
BRANCH=None
TEST=Tested on glados. Audio does get emitted and some mic recording
     works.

Change-Id: I8a9c2f4f76a0d129be44070f09d938c28a73fd27
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: 2472af5793dcffd2607a7b95521ddd25b4be0e8c
Original-Change-Id: If469f99ed1a958364101078263afb27761236421
Original-Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/312264
Original-Reviewed-by: Duncan Laurie <dlaurie@chromium.org>
Reviewed-on: https://review.coreboot.org/12935
Tested-by: build bot (Jenkins)
Reviewed-by: Martin Roth <martinroth@google.com>

2 files changed, 422 insertions, 0 deletions

diff --git a/src/lib/Makefile.inc b/src/lib/Makefile.inc
index 724391fb21..11db6550ea 100644
--- a/src/lib/Makefile.inc
+++ b/src/lib/Makefile.inc
@@ -125,6 +125,7 @@ ramstage-$(CONFIG_TIMER_QUEUE) += timer_queue.c
 ramstage-$(CONFIG_GENERIC_GPIO_LIB) += gpio.c
 ramstage-$(CONFIG_GENERIC_UDELAY) += timer.c
 ramstage-y += b64_decode.c
+ramstage-$(CONFIG_ACPI_NHLT) += nhlt.c
 
 romstage-y += cbmem_common.c
 romstage-y += imd_cbmem.c
diff --git a/src/lib/nhlt.c b/src/lib/nhlt.c
new file mode 100644
index 0000000000..4fa4a0c2c1
--- /dev/null
+++ b/src/lib/nhlt.c
@@ -0,0 +1,421 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright 2015 Google, Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ */
+
+#include <arch/acpi.h>
+#include <cbfs.h>
+#include <commonlib/endian.h>
+#include <console/console.h>
+#include <nhlt.h>
+#include <stdlib.h>
+#include <string.h>
+
+#define NHLT_RID 1
+#define NHLT_SSID 1
+#define WAVEFORMAT_TAG 0xfffe
+
+static const struct sub_format pcm_subformat = {
+	.data1 = 0x00000001,
+	.data2 = 0x0000,
+	.data3 = 0x0010,
+	.data4 = { 0x80, 0x00, 0x00, 0xaa, 0x00, 0x38, 0x9b, 0x71 },
+};
+
+struct nhlt *nhlt_init(void)
+{
+	struct nhlt *nhlt;
+
+	nhlt = malloc(sizeof(*nhlt));
+
+	if (nhlt == NULL)
+		return NULL;
+
+	memset(nhlt, 0, sizeof(*nhlt));
+
+	return nhlt;
+}
+
+struct nhlt_endpoint *nhlt_add_endpoint(struct nhlt *nhlt, int link_type,
+					int device_type, int dir,
+					uint16_t vid, uint16_t did)
+{
+	struct nhlt_endpoint *endp;
+
+	if (link_type < NHLT_LINK_HDA || link_type >= NHLT_MAX_LINK_TYPES)
+		return NULL;
+
+	if (nhlt->num_endpoints >= MAX_ENDPOINTS)
+		return NULL;
+
+	endp = &nhlt->endpoints[nhlt->num_endpoints];
+
+	endp->link_type = link_type;
+	endp->instance_id = nhlt->current_instance_id[link_type];
+	endp->vendor_id = vid;
+	endp->device_id = did;
+	endp->revision_id = NHLT_RID;
+	endp->subsystem_id = NHLT_SSID;
+	endp->device_type = device_type;
+	endp->direction = dir;
+	endp->virtual_bus_id = 0;
+
+	nhlt->num_endpoints++;
+
+	return endp;
+}
+
+static int append_specific_config(struct nhlt_specific_config *spec_cfg,
+					const void *config, size_t config_sz)
+{
+	size_t new_sz;
+	void *new_cfg;
+
+	if (config == NULL || config_sz == 0)
+		return 0;
+
+	new_sz = spec_cfg->size + config_sz;
+
+	new_cfg = malloc(new_sz);
+
+	if (new_cfg == NULL)
+		return -1;
+
+	/* Append new config. */
+	memcpy(new_cfg, spec_cfg->capabilities, spec_cfg->size);
+	memcpy(new_cfg + spec_cfg->size, config, config_sz);
+
+	free(spec_cfg->capabilities);
+
+	/* Update with new config data. */
+	spec_cfg->size = new_sz;
+	spec_cfg->capabilities = new_cfg;
+
+	return 0;
+}
+
+int nhlt_endpoint_append_config(struct nhlt_endpoint *endp, const void *config,
+				size_t config_sz)
+{
+	return append_specific_config(&endp->config, config, config_sz);
+}
+
+struct nhlt_format *nhlt_add_format(struct nhlt_endpoint *endp,
+					int num_channels,
+					int sample_freq_khz,
+					int container_bits_per_sample,
+					int valid_bits_per_sample,
+					uint32_t speaker_mask)
+{
+	struct nhlt_format *fmt;
+	struct nhlt_waveform *wave;
+
+	if (endp->num_formats >= MAX_FORMATS)
+		return NULL;
+
+	fmt = &endp->formats[endp->num_formats];
+	wave = &fmt->waveform;
+
+	wave->tag = WAVEFORMAT_TAG;
+	wave->num_channels = num_channels;
+	wave->samples_per_second = sample_freq_khz * KHz;
+	wave->bits_per_sample = container_bits_per_sample;
+	wave->extra_size = sizeof(wave->valid_bits_per_sample);
+	wave->extra_size += sizeof(wave->channel_mask);
+	wave->extra_size += sizeof(wave->sub_format);
+	wave->valid_bits_per_sample = valid_bits_per_sample;
+	wave->channel_mask = speaker_mask;
+	memcpy(&wave->sub_format, &pcm_subformat, sizeof(wave->sub_format));
+
+	/* Calculate the dervied fields. */
+	wave->block_align = wave->num_channels * wave->bits_per_sample / 8;
+	wave->bytes_per_second = wave->block_align * wave->samples_per_second;
+
+	endp->num_formats++;
+
+	return fmt;
+}
+
+int nhlt_format_append_config(struct nhlt_format *fmt, const void *config,
+				size_t config_sz)
+{
+	return append_specific_config(&fmt->config, config, config_sz);
+}
+
+int nhlt_endpoint_add_formats(struct nhlt_endpoint *endp,
+				const struct nhlt_format_config *formats,
+				size_t num_formats)
+{
+	size_t i;
+
+	for (i = 0; i < num_formats; i++) {
+		struct nhlt_format *fmt;
+		struct cbfsf file;
+		struct region_device settings;
+		void *settings_data;
+		const struct nhlt_format_config *cfg = &formats[i];
+
+		fmt = nhlt_add_format(endp, cfg->num_channels,
+					cfg->sample_freq_khz,
+					cfg->container_bits_per_sample,
+					cfg->valid_bits_per_sample,
+					cfg->speaker_mask);
+
+		if (fmt == NULL)
+			return -1;
+
+		if (cfg->settings_file == NULL)
+			continue;
+
+		/* Find the settings file in CBFS and place it in format. */
+		if (cbfs_boot_locate(&file, cfg->settings_file, NULL))
+			return -1;
+
+		cbfs_file_data(&settings, &file);
+
+		settings_data = rdev_mmap_full(&settings);
+
+		if (settings_data == NULL)
+			return -1;
+
+		if (nhlt_format_append_config(fmt, settings_data,
+					region_device_sz(&settings))) {
+			rdev_munmap(&settings, settings_data);
+			return -1;
+		}
+
+		rdev_munmap(&settings, settings_data);
+	}
+
+	return 0;
+}
+
+void nhlt_next_instance(struct nhlt *nhlt, int link_type)
+{
+	if (link_type < NHLT_LINK_HDA || link_type >= NHLT_MAX_LINK_TYPES)
+		return;
+
+	nhlt->current_instance_id[link_type]++;
+}
+
+static size_t calc_specific_config_size(struct nhlt_specific_config *cfg)
+{
+	return sizeof(cfg->size) + cfg->size;
+}
+
+static size_t calc_format_size(struct nhlt_format *fmt)
+{
+	size_t sz = 0;
+
+	/* Wave format first. */
+	sz += sizeof(fmt->waveform.tag);
+	sz += sizeof(fmt->waveform.num_channels);
+	sz += sizeof(fmt->waveform.samples_per_second);
+	sz += sizeof(fmt->waveform.bytes_per_second);
+	sz += sizeof(fmt->waveform.block_align);
+	sz += sizeof(fmt->waveform.bits_per_sample);
+	sz += sizeof(fmt->waveform.extra_size);
+	sz += sizeof(fmt->waveform.valid_bits_per_sample);
+	sz += sizeof(fmt->waveform.channel_mask);
+	sz += sizeof(fmt->waveform.sub_format);
+
+	sz += calc_specific_config_size(&fmt->config);
+
+	return sz;
+}
+
+static size_t calc_endpoint_size(struct nhlt_endpoint *endp)
+{
+	int i;
+	size_t sz = 0;
+
+	sz += sizeof(endp->length) + sizeof(endp->link_type);
+	sz += sizeof(endp->instance_id) + sizeof(endp->vendor_id);
+	sz += sizeof(endp->device_id) + sizeof(endp->revision_id);
+	sz += sizeof(endp->subsystem_id) + sizeof(endp->device_type);
+	sz += sizeof(endp->direction) + sizeof(endp->virtual_bus_id);
+	sz += calc_specific_config_size(&endp->config);
+	sz += sizeof(endp->num_formats);
+
+	for (i = 0; i < endp->num_formats; i++)
+		sz += calc_format_size(&endp->formats[i]);
+
+	/* Adjust endpoint length to reflect current configuration. */
+	endp->length = sz;
+
+	return sz;
+}
+
+static size_t calc_endpoints_size(struct nhlt *nhlt)
+{
+	int i;
+	size_t sz = 0;
+
+	for (i = 0; i < nhlt->num_endpoints; i++)
+		sz += calc_endpoint_size(&nhlt->endpoints[i]);
+
+	return sz;
+}
+
+static size_t calc_size(struct nhlt *nhlt)
+{
+	return sizeof(nhlt->num_endpoints) + calc_endpoints_size(nhlt);
+}
+
+size_t nhlt_current_size(struct nhlt *nhlt)
+{
+	return calc_size(nhlt) + sizeof(acpi_header_t);
+}
+
+static void nhlt_free_resources(struct nhlt *nhlt)
+{
+	int i;
+	int j;
+
+	/* Free all specific configs. */
+	for (i = 0; i < nhlt->num_endpoints; i++) {
+		struct nhlt_endpoint *endp = &nhlt->endpoints[i];
+
+		free(endp->config.capabilities);
+		for (j = 0; j < endp->num_formats; j++) {
+			struct nhlt_format *fmt = &endp->formats[j];
+
+			free(fmt->config.capabilities);
+		}
+	}
+
+	/* Free nhlt object proper. */
+	free(nhlt);
+}
+
+struct cursor {
+	uint8_t *buf;
+};
+
+static void ser8(struct cursor *cur, uint8_t val)
+{
+	write_le8(cur->buf, val);
+	cur->buf += sizeof(val);
+}
+
+static void ser16(struct cursor *cur, uint16_t val)
+{
+	write_le16(cur->buf, val);
+	cur->buf += sizeof(val);
+}
+
+static void ser32(struct cursor *cur, uint32_t val)
+{
+	write_le32(cur->buf, val);
+	cur->buf += sizeof(val);
+}
+
+static void serblob(struct cursor *cur, void *from, size_t sz)
+{
+	memcpy(cur->buf, from, sz);
+	cur->buf += sz;
+}
+
+static void serialize_specific_config(struct nhlt_specific_config *cfg,
+					struct cursor *cur)
+{
+	ser32(cur, cfg->size);
+	serblob(cur, cfg->capabilities, cfg->size);
+}
+
+static void serialize_waveform(struct nhlt_waveform *wave, struct cursor *cur)
+{
+	ser16(cur, wave->tag);
+	ser16(cur, wave->num_channels);
+	ser32(cur, wave->samples_per_second);
+	ser32(cur, wave->bytes_per_second);
+	ser16(cur, wave->block_align);
+	ser16(cur, wave->bits_per_sample);
+	ser16(cur, wave->extra_size);
+	ser16(cur, wave->valid_bits_per_sample);
+	ser32(cur, wave->channel_mask);
+	ser32(cur, wave->sub_format.data1);
+	ser16(cur, wave->sub_format.data2);
+	ser16(cur, wave->sub_format.data3);
+	serblob(cur, wave->sub_format.data4, sizeof(wave->sub_format.data4));
+}
+
+static void serialize_format(struct nhlt_format *fmt, struct cursor *cur)
+{
+	serialize_waveform(&fmt->waveform, cur);
+	serialize_specific_config(&fmt->config, cur);
+}
+
+static void serialize_endpoint(struct nhlt_endpoint *endp, struct cursor *cur)
+{
+	int i;
+
+	ser32(cur, endp->length);
+	ser8(cur, endp->link_type);
+	ser8(cur, endp->instance_id);
+	ser16(cur, endp->vendor_id);
+	ser16(cur, endp->device_id);
+	ser16(cur, endp->revision_id);
+	ser32(cur, endp->subsystem_id);
+	ser8(cur, endp->device_type);
+	ser8(cur, endp->direction);
+	ser8(cur, endp->virtual_bus_id);
+	serialize_specific_config(&endp->config, cur);
+	ser8(cur, endp->num_formats);
+
+	for (i = 0; i < endp->num_formats; i++)
+		serialize_format(&endp->formats[i], cur);
+}
+
+static void nhlt_serialize_endpoints(struct nhlt *nhlt, struct cursor *cur)
+{
+	int i;
+
+	ser8(cur, nhlt->num_endpoints);
+
+	for (i = 0; i < nhlt->num_endpoints; i++)
+		serialize_endpoint(&nhlt->endpoints[i], cur);
+}
+
+uintptr_t nhlt_serialize(struct nhlt *nhlt, uintptr_t acpi_addr)
+{
+	struct cursor cur;
+	acpi_header_t *header;
+	size_t sz;
+
+	printk(BIOS_DEBUG, "ACPI:    * NHLT\n");
+
+	sz = nhlt_current_size(nhlt);
+
+	/* Create header */
+	header = (void *)acpi_addr;
+	memset(header, 0, sizeof(acpi_header_t));
+	memcpy(header->signature, "NHLT", 4);
+	write_le32(&header->length, sz);
+	write_le8(&header->revision, 5);
+	memcpy(header->oem_id, OEM_ID, 6);
+	memcpy(header->oem_table_id, ACPI_TABLE_CREATOR, 8);
+	memcpy(header->asl_compiler_id, ASLC, 4);
+
+	cur.buf = (void *)(acpi_addr + sizeof(acpi_header_t));
+	nhlt_serialize_endpoints(nhlt, &cur);
+
+	write_le8(&header->checksum, acpi_checksum((void *)header, sz));
+
+	nhlt_free_resources(nhlt);
+
+	acpi_addr += sz;
+	acpi_addr = ALIGN_UP(acpi_addr, 16);
+
+	return acpi_addr;
+}