xref: /openbmc/linux/sound/soc/intel/skylake/skl-nhlt.c (revision a36954f5)
1 /*
2  *  skl-nhlt.c - Intel SKL Platform NHLT parsing
3  *
4  *  Copyright (C) 2015 Intel Corp
5  *  Author: Sanjiv Kumar <sanjiv.kumar@intel.com>
6  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7  *
8  *  This program is free software; you can redistribute it and/or modify
9  *  it under the terms of the GNU General Public License as published by
10  *  the Free Software Foundation; version 2 of the License.
11  *
12  *  This program is distributed in the hope that it will be useful, but
13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  General Public License for more details.
16  *
17  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18  *
19  */
20 #include <linux/pci.h>
21 #include "skl.h"
22 
23 /* Unique identification for getting NHLT blobs */
24 static u8 OSC_UUID[16] = {0x6E, 0x88, 0x9F, 0xA6, 0xEB, 0x6C, 0x94, 0x45,
25 				0xA4, 0x1F, 0x7B, 0x5D, 0xCE, 0x24, 0xC5, 0x53};
26 
27 struct nhlt_acpi_table *skl_nhlt_init(struct device *dev)
28 {
29 	acpi_handle handle;
30 	union acpi_object *obj;
31 	struct nhlt_resource_desc  *nhlt_ptr = NULL;
32 	struct nhlt_acpi_table *nhlt_table = NULL;
33 
34 	handle = ACPI_HANDLE(dev);
35 	if (!handle) {
36 		dev_err(dev, "Didn't find ACPI_HANDLE\n");
37 		return NULL;
38 	}
39 
40 	obj = acpi_evaluate_dsm(handle, OSC_UUID, 1, 1, NULL);
41 	if (obj && obj->type == ACPI_TYPE_BUFFER) {
42 		nhlt_ptr = (struct nhlt_resource_desc  *)obj->buffer.pointer;
43 		nhlt_table = (struct nhlt_acpi_table *)
44 				memremap(nhlt_ptr->min_addr, nhlt_ptr->length,
45 				MEMREMAP_WB);
46 		ACPI_FREE(obj);
47 		return nhlt_table;
48 	}
49 
50 	dev_err(dev, "device specific method to extract NHLT blob failed\n");
51 	return NULL;
52 }
53 
54 void skl_nhlt_free(struct nhlt_acpi_table *nhlt)
55 {
56 	memunmap((void *) nhlt);
57 }
58 
59 static struct nhlt_specific_cfg *skl_get_specific_cfg(
60 		struct device *dev, struct nhlt_fmt *fmt,
61 		u8 no_ch, u32 rate, u16 bps, u8 linktype)
62 {
63 	struct nhlt_specific_cfg *sp_config;
64 	struct wav_fmt *wfmt;
65 	struct nhlt_fmt_cfg *fmt_config = fmt->fmt_config;
66 	int i;
67 
68 	dev_dbg(dev, "Format count =%d\n", fmt->fmt_count);
69 
70 	for (i = 0; i < fmt->fmt_count; i++) {
71 		wfmt = &fmt_config->fmt_ext.fmt;
72 		dev_dbg(dev, "ch=%d fmt=%d s_rate=%d\n", wfmt->channels,
73 			 wfmt->bits_per_sample, wfmt->samples_per_sec);
74 		if (wfmt->channels == no_ch && wfmt->bits_per_sample == bps) {
75 			/*
76 			 * if link type is dmic ignore rate check as the blob is
77 			 * generic for all rates
78 			 */
79 			sp_config = &fmt_config->config;
80 			if (linktype == NHLT_LINK_DMIC)
81 				return sp_config;
82 
83 			if (wfmt->samples_per_sec == rate)
84 				return sp_config;
85 		}
86 
87 		fmt_config = (struct nhlt_fmt_cfg *)(fmt_config->config.caps +
88 						fmt_config->config.size);
89 	}
90 
91 	return NULL;
92 }
93 
94 static void dump_config(struct device *dev, u32 instance_id, u8 linktype,
95 		u8 s_fmt, u8 num_channels, u32 s_rate, u8 dirn, u16 bps)
96 {
97 	dev_dbg(dev, "Input configuration\n");
98 	dev_dbg(dev, "ch=%d fmt=%d s_rate=%d\n", num_channels, s_fmt, s_rate);
99 	dev_dbg(dev, "vbus_id=%d link_type=%d\n", instance_id, linktype);
100 	dev_dbg(dev, "bits_per_sample=%d\n", bps);
101 }
102 
103 static bool skl_check_ep_match(struct device *dev, struct nhlt_endpoint *epnt,
104 		u32 instance_id, u8 link_type, u8 dirn, u8 dev_type)
105 {
106 	dev_dbg(dev, "vbus_id=%d link_type=%d dir=%d dev_type = %d\n",
107 			epnt->virtual_bus_id, epnt->linktype,
108 			epnt->direction, epnt->device_type);
109 
110 	if ((epnt->virtual_bus_id == instance_id) &&
111 			(epnt->linktype == link_type) &&
112 			(epnt->direction == dirn) &&
113 			(epnt->device_type == dev_type))
114 		return true;
115 	else
116 		return false;
117 }
118 
119 struct nhlt_specific_cfg
120 *skl_get_ep_blob(struct skl *skl, u32 instance, u8 link_type,
121 			u8 s_fmt, u8 num_ch, u32 s_rate,
122 			u8 dirn, u8 dev_type)
123 {
124 	struct nhlt_fmt *fmt;
125 	struct nhlt_endpoint *epnt;
126 	struct hdac_bus *bus = ebus_to_hbus(&skl->ebus);
127 	struct device *dev = bus->dev;
128 	struct nhlt_specific_cfg *sp_config;
129 	struct nhlt_acpi_table *nhlt = skl->nhlt;
130 	u16 bps = (s_fmt == 16) ? 16 : 32;
131 	u8 j;
132 
133 	dump_config(dev, instance, link_type, s_fmt, num_ch, s_rate, dirn, bps);
134 
135 	epnt = (struct nhlt_endpoint *)nhlt->desc;
136 
137 	dev_dbg(dev, "endpoint count =%d\n", nhlt->endpoint_count);
138 
139 	for (j = 0; j < nhlt->endpoint_count; j++) {
140 		if (skl_check_ep_match(dev, epnt, instance, link_type,
141 						dirn, dev_type)) {
142 			fmt = (struct nhlt_fmt *)(epnt->config.caps +
143 						 epnt->config.size);
144 			sp_config = skl_get_specific_cfg(dev, fmt, num_ch,
145 							s_rate, bps, link_type);
146 			if (sp_config)
147 				return sp_config;
148 		}
149 
150 		epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
151 	}
152 
153 	return NULL;
154 }
155 
156 int skl_get_dmic_geo(struct skl *skl)
157 {
158 	struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
159 	struct nhlt_endpoint *epnt;
160 	struct nhlt_dmic_array_config *cfg;
161 	struct device *dev = &skl->pci->dev;
162 	unsigned int dmic_geo = 0;
163 	u8 j;
164 
165 	epnt = (struct nhlt_endpoint *)nhlt->desc;
166 
167 	for (j = 0; j < nhlt->endpoint_count; j++) {
168 		if (epnt->linktype == NHLT_LINK_DMIC) {
169 			cfg = (struct nhlt_dmic_array_config  *)
170 					(epnt->config.caps);
171 			switch (cfg->array_type) {
172 			case NHLT_MIC_ARRAY_2CH_SMALL:
173 			case NHLT_MIC_ARRAY_2CH_BIG:
174 				dmic_geo |= MIC_ARRAY_2CH;
175 				break;
176 
177 			case NHLT_MIC_ARRAY_4CH_1ST_GEOM:
178 			case NHLT_MIC_ARRAY_4CH_L_SHAPED:
179 			case NHLT_MIC_ARRAY_4CH_2ND_GEOM:
180 				dmic_geo |= MIC_ARRAY_4CH;
181 				break;
182 
183 			default:
184 				dev_warn(dev, "undefined DMIC array_type 0x%0x\n",
185 						cfg->array_type);
186 
187 			}
188 		}
189 		epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
190 	}
191 
192 	return dmic_geo;
193 }
194 
195 static void skl_nhlt_trim_space(char *trim)
196 {
197 	char *s = trim;
198 	int cnt;
199 	int i;
200 
201 	cnt = 0;
202 	for (i = 0; s[i]; i++) {
203 		if (!isspace(s[i]))
204 			s[cnt++] = s[i];
205 	}
206 
207 	s[cnt] = '\0';
208 }
209 
210 int skl_nhlt_update_topology_bin(struct skl *skl)
211 {
212 	struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
213 	struct hdac_bus *bus = ebus_to_hbus(&skl->ebus);
214 	struct device *dev = bus->dev;
215 
216 	dev_dbg(dev, "oem_id %.6s, oem_table_id %8s oem_revision %d\n",
217 		nhlt->header.oem_id, nhlt->header.oem_table_id,
218 		nhlt->header.oem_revision);
219 
220 	snprintf(skl->tplg_name, sizeof(skl->tplg_name), "%x-%.6s-%.8s-%d%s",
221 		skl->pci_id, nhlt->header.oem_id, nhlt->header.oem_table_id,
222 		nhlt->header.oem_revision, "-tplg.bin");
223 
224 	skl_nhlt_trim_space(skl->tplg_name);
225 
226 	return 0;
227 }
228 
229 static ssize_t skl_nhlt_platform_id_show(struct device *dev,
230 			struct device_attribute *attr, char *buf)
231 {
232 	struct pci_dev *pci = to_pci_dev(dev);
233 	struct hdac_ext_bus *ebus = pci_get_drvdata(pci);
234 	struct skl *skl = ebus_to_skl(ebus);
235 	struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
236 	char platform_id[32];
237 
238 	sprintf(platform_id, "%x-%.6s-%.8s-%d", skl->pci_id,
239 			nhlt->header.oem_id, nhlt->header.oem_table_id,
240 			nhlt->header.oem_revision);
241 
242 	skl_nhlt_trim_space(platform_id);
243 	return sprintf(buf, "%s\n", platform_id);
244 }
245 
246 static DEVICE_ATTR(platform_id, 0444, skl_nhlt_platform_id_show, NULL);
247 
248 int skl_nhlt_create_sysfs(struct skl *skl)
249 {
250 	struct device *dev = &skl->pci->dev;
251 
252 	if (sysfs_create_file(&dev->kobj, &dev_attr_platform_id.attr))
253 		dev_warn(dev, "Error creating sysfs entry\n");
254 
255 	return 0;
256 }
257 
258 void skl_nhlt_remove_sysfs(struct skl *skl)
259 {
260 	struct device *dev = &skl->pci->dev;
261 
262 	sysfs_remove_file(&dev->kobj, &dev_attr_platform_id.attr);
263 }
264