1 // SPDX-License-Identifier: GPL-2.0-only
3 * skl-nhlt.c - Intel SKL Platform NHLT parsing
5 * Copyright (C) 2015 Intel Corp
6 * Author: Sanjiv Kumar <sanjiv.kumar@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 #include <linux/pci.h>
12 #include <sound/intel-nhlt.h>
16 static struct nhlt_specific_cfg *skl_get_specific_cfg(
17 struct device *dev, struct nhlt_fmt *fmt,
18 u8 no_ch, u32 rate, u16 bps, u8 linktype)
20 struct nhlt_specific_cfg *sp_config;
22 struct nhlt_fmt_cfg *fmt_config = fmt->fmt_config;
25 dev_dbg(dev, "Format count =%d\n", fmt->fmt_count);
27 for (i = 0; i < fmt->fmt_count; i++) {
28 wfmt = &fmt_config->fmt_ext.fmt;
29 dev_dbg(dev, "ch=%d fmt=%d s_rate=%d\n", wfmt->channels,
30 wfmt->bits_per_sample, wfmt->samples_per_sec);
31 if (wfmt->channels == no_ch && wfmt->bits_per_sample == bps) {
33 * if link type is dmic ignore rate check as the blob is
34 * generic for all rates
36 sp_config = &fmt_config->config;
37 if (linktype == NHLT_LINK_DMIC)
40 if (wfmt->samples_per_sec == rate)
44 fmt_config = (struct nhlt_fmt_cfg *)(fmt_config->config.caps +
45 fmt_config->config.size);
51 static void dump_config(struct device *dev, u32 instance_id, u8 linktype,
52 u8 s_fmt, u8 num_channels, u32 s_rate, u8 dirn, u16 bps)
54 dev_dbg(dev, "Input configuration\n");
55 dev_dbg(dev, "ch=%d fmt=%d s_rate=%d\n", num_channels, s_fmt, s_rate);
56 dev_dbg(dev, "vbus_id=%d link_type=%d\n", instance_id, linktype);
57 dev_dbg(dev, "bits_per_sample=%d\n", bps);
60 static bool skl_check_ep_match(struct device *dev, struct nhlt_endpoint *epnt,
61 u32 instance_id, u8 link_type, u8 dirn, u8 dev_type)
63 dev_dbg(dev, "vbus_id=%d link_type=%d dir=%d dev_type = %d\n",
64 epnt->virtual_bus_id, epnt->linktype,
65 epnt->direction, epnt->device_type);
67 if ((epnt->virtual_bus_id == instance_id) &&
68 (epnt->linktype == link_type) &&
69 (epnt->direction == dirn)) {
70 /* do not check dev_type for DMIC link type */
71 if (epnt->linktype == NHLT_LINK_DMIC)
74 if (epnt->device_type == dev_type)
81 struct nhlt_specific_cfg
82 *skl_get_ep_blob(struct skl_dev *skl, u32 instance, u8 link_type,
83 u8 s_fmt, u8 num_ch, u32 s_rate,
87 struct nhlt_endpoint *epnt;
88 struct hdac_bus *bus = skl_to_bus(skl);
89 struct device *dev = bus->dev;
90 struct nhlt_specific_cfg *sp_config;
91 struct nhlt_acpi_table *nhlt = skl->nhlt;
92 u16 bps = (s_fmt == 16) ? 16 : 32;
95 dump_config(dev, instance, link_type, s_fmt, num_ch, s_rate, dirn, bps);
97 epnt = (struct nhlt_endpoint *)nhlt->desc;
99 dev_dbg(dev, "endpoint count =%d\n", nhlt->endpoint_count);
101 for (j = 0; j < nhlt->endpoint_count; j++) {
102 if (skl_check_ep_match(dev, epnt, instance, link_type,
104 fmt = (struct nhlt_fmt *)(epnt->config.caps +
106 sp_config = skl_get_specific_cfg(dev, fmt, num_ch,
107 s_rate, bps, link_type);
112 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
118 static void skl_nhlt_trim_space(char *trim)
125 for (i = 0; s[i]; i++) {
133 int skl_nhlt_update_topology_bin(struct skl_dev *skl)
135 struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
136 struct hdac_bus *bus = skl_to_bus(skl);
137 struct device *dev = bus->dev;
139 dev_dbg(dev, "oem_id %.6s, oem_table_id %.8s oem_revision %d\n",
140 nhlt->header.oem_id, nhlt->header.oem_table_id,
141 nhlt->header.oem_revision);
143 snprintf(skl->tplg_name, sizeof(skl->tplg_name), "/*(DEBLOBBED)*/");
145 skl_nhlt_trim_space(skl->tplg_name);
150 static ssize_t skl_nhlt_platform_id_show(struct device *dev,
151 struct device_attribute *attr, char *buf)
153 struct pci_dev *pci = to_pci_dev(dev);
154 struct hdac_bus *bus = pci_get_drvdata(pci);
155 struct skl_dev *skl = bus_to_skl(bus);
156 struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
157 char platform_id[32];
159 sprintf(platform_id, "%x-%.6s-%.8s-%d", skl->pci_id,
160 nhlt->header.oem_id, nhlt->header.oem_table_id,
161 nhlt->header.oem_revision);
163 skl_nhlt_trim_space(platform_id);
164 return sprintf(buf, "%s\n", platform_id);
167 static DEVICE_ATTR(platform_id, 0444, skl_nhlt_platform_id_show, NULL);
169 int skl_nhlt_create_sysfs(struct skl_dev *skl)
171 struct device *dev = &skl->pci->dev;
173 if (sysfs_create_file(&dev->kobj, &dev_attr_platform_id.attr))
174 dev_warn(dev, "Error creating sysfs entry\n");
179 void skl_nhlt_remove_sysfs(struct skl_dev *skl)
181 struct device *dev = &skl->pci->dev;
184 sysfs_remove_file(&dev->kobj, &dev_attr_platform_id.attr);
188 * Queries NHLT for all the fmt configuration for a particular endpoint and
189 * stores all possible rates supported in a rate table for the corresponding
192 static void skl_get_ssp_clks(struct skl_dev *skl, struct skl_ssp_clk *ssp_clks,
193 struct nhlt_fmt *fmt, u8 id)
195 struct skl_i2s_config_blob_ext *i2s_config_ext;
196 struct skl_i2s_config_blob_legacy *i2s_config;
197 struct skl_clk_parent_src *parent;
198 struct skl_ssp_clk *sclk, *sclkfs;
199 struct nhlt_fmt_cfg *fmt_cfg;
200 struct wav_fmt_ext *wav_fmt;
202 bool present = false;
209 sclk = &ssp_clks[SKL_SCLK_OFS];
210 sclkfs = &ssp_clks[SKL_SCLKFS_OFS];
212 if (fmt->fmt_count == 0)
215 for (i = 0; i < fmt->fmt_count; i++) {
216 fmt_cfg = &fmt->fmt_config[i];
217 wav_fmt = &fmt_cfg->fmt_ext;
219 channels = wav_fmt->fmt.channels;
220 bps = wav_fmt->fmt.bits_per_sample;
221 fs = wav_fmt->fmt.samples_per_sec;
224 * In case of TDM configuration on a ssp, there can
225 * be more than one blob in which channel masks are
226 * different for each usecase for a specific rate and bps.
227 * But the sclk rate will be generated for the total
228 * number of channels used for that endpoint.
230 * So for the given fs and bps, choose blob which has
231 * the superset of all channels for that endpoint and
234 for (j = i; j < fmt->fmt_count; j++) {
235 fmt_cfg = &fmt->fmt_config[j];
236 wav_fmt = &fmt_cfg->fmt_ext;
237 if ((fs == wav_fmt->fmt.samples_per_sec) &&
238 (bps == wav_fmt->fmt.bits_per_sample))
239 channels = max_t(u16, channels,
240 wav_fmt->fmt.channels);
243 rate = channels * bps * fs;
245 /* check if the rate is added already to the given SSP's sclk */
246 for (j = 0; (j < SKL_MAX_CLK_RATES) &&
247 (sclk[id].rate_cfg[j].rate != 0); j++) {
248 if (sclk[id].rate_cfg[j].rate == rate) {
254 /* Fill rate and parent for sclk/sclkfs */
256 i2s_config_ext = (struct skl_i2s_config_blob_ext *)
257 fmt->fmt_config[0].config.caps;
259 /* MCLK Divider Source Select */
260 if (is_legacy_blob(i2s_config_ext->hdr.sig)) {
261 i2s_config = ext_to_legacy_blob(i2s_config_ext);
262 clk_src = get_clk_src(i2s_config->mclk,
263 SKL_MNDSS_DIV_CLK_SRC_MASK);
265 clk_src = get_clk_src(i2s_config_ext->mclk,
266 SKL_MNDSS_DIV_CLK_SRC_MASK);
269 parent = skl_get_parent_clk(clk_src);
272 * Do not copy the config data if there is no parent
273 * clock available for this clock source select
278 sclk[id].rate_cfg[rate_index].rate = rate;
279 sclk[id].rate_cfg[rate_index].config = fmt_cfg;
280 sclkfs[id].rate_cfg[rate_index].rate = rate;
281 sclkfs[id].rate_cfg[rate_index].config = fmt_cfg;
282 sclk[id].parent_name = parent->name;
283 sclkfs[id].parent_name = parent->name;
290 static void skl_get_mclk(struct skl_dev *skl, struct skl_ssp_clk *mclk,
291 struct nhlt_fmt *fmt, u8 id)
293 struct skl_i2s_config_blob_ext *i2s_config_ext;
294 struct skl_i2s_config_blob_legacy *i2s_config;
295 struct nhlt_specific_cfg *fmt_cfg;
296 struct skl_clk_parent_src *parent;
297 u32 clkdiv, div_ratio;
300 fmt_cfg = &fmt->fmt_config[0].config;
301 i2s_config_ext = (struct skl_i2s_config_blob_ext *)fmt_cfg->caps;
303 /* MCLK Divider Source Select and divider */
304 if (is_legacy_blob(i2s_config_ext->hdr.sig)) {
305 i2s_config = ext_to_legacy_blob(i2s_config_ext);
306 clk_src = get_clk_src(i2s_config->mclk,
307 SKL_MCLK_DIV_CLK_SRC_MASK);
308 clkdiv = i2s_config->mclk.mdivr &
309 SKL_MCLK_DIV_RATIO_MASK;
311 clk_src = get_clk_src(i2s_config_ext->mclk,
312 SKL_MCLK_DIV_CLK_SRC_MASK);
313 clkdiv = i2s_config_ext->mclk.mdivr[0] &
314 SKL_MCLK_DIV_RATIO_MASK;
320 if (clkdiv != SKL_MCLK_DIV_RATIO_MASK)
321 /* Divider is 2 + clkdiv */
322 div_ratio = clkdiv + 2;
324 /* Calculate MCLK rate from source using div value */
325 parent = skl_get_parent_clk(clk_src);
329 mclk[id].rate_cfg[0].rate = parent->rate/div_ratio;
330 mclk[id].rate_cfg[0].config = &fmt->fmt_config[0];
331 mclk[id].parent_name = parent->name;
334 void skl_get_clks(struct skl_dev *skl, struct skl_ssp_clk *ssp_clks)
336 struct nhlt_acpi_table *nhlt = (struct nhlt_acpi_table *)skl->nhlt;
337 struct nhlt_endpoint *epnt;
338 struct nhlt_fmt *fmt;
342 epnt = (struct nhlt_endpoint *)nhlt->desc;
343 for (i = 0; i < nhlt->endpoint_count; i++) {
344 if (epnt->linktype == NHLT_LINK_SSP) {
345 id = epnt->virtual_bus_id;
347 fmt = (struct nhlt_fmt *)(epnt->config.caps
348 + epnt->config.size);
350 skl_get_ssp_clks(skl, ssp_clks, fmt, id);
351 skl_get_mclk(skl, ssp_clks, fmt, id);
353 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);