1 // SPDX-License-Identifier: GPL-2.0-only 1 // SPDX-License-Identifier: GPL-2.0-only
2 // Copyright (c) 2015-2019 Intel Corporation 2 // Copyright (c) 2015-2019 Intel Corporation
3 3
4 #include <linux/acpi.h> 4 #include <linux/acpi.h>
5 #include <sound/intel-nhlt.h> 5 #include <sound/intel-nhlt.h>
6 6
7 struct nhlt_acpi_table *intel_nhlt_init(struct 7 struct nhlt_acpi_table *intel_nhlt_init(struct device *dev)
8 { 8 {
9 struct nhlt_acpi_table *nhlt; 9 struct nhlt_acpi_table *nhlt;
10 acpi_status status; 10 acpi_status status;
11 11
12 status = acpi_get_table(ACPI_SIG_NHLT, 12 status = acpi_get_table(ACPI_SIG_NHLT, 0,
13 (struct acpi_t 13 (struct acpi_table_header **)&nhlt);
14 if (ACPI_FAILURE(status)) { 14 if (ACPI_FAILURE(status)) {
15 dev_warn(dev, "NHLT table not 15 dev_warn(dev, "NHLT table not found\n");
16 return NULL; 16 return NULL;
17 } 17 }
18 18
19 return nhlt; 19 return nhlt;
20 } 20 }
21 EXPORT_SYMBOL_GPL(intel_nhlt_init); 21 EXPORT_SYMBOL_GPL(intel_nhlt_init);
22 22
23 void intel_nhlt_free(struct nhlt_acpi_table *n 23 void intel_nhlt_free(struct nhlt_acpi_table *nhlt)
24 { 24 {
25 acpi_put_table((struct acpi_table_head 25 acpi_put_table((struct acpi_table_header *)nhlt);
26 } 26 }
27 EXPORT_SYMBOL_GPL(intel_nhlt_free); 27 EXPORT_SYMBOL_GPL(intel_nhlt_free);
28 28
29 int intel_nhlt_get_dmic_geo(struct device *dev 29 int intel_nhlt_get_dmic_geo(struct device *dev, struct nhlt_acpi_table *nhlt)
30 { 30 {
31 struct nhlt_endpoint *epnt; 31 struct nhlt_endpoint *epnt;
32 struct nhlt_dmic_array_config *cfg; 32 struct nhlt_dmic_array_config *cfg;
33 struct nhlt_vendor_dmic_array_config * 33 struct nhlt_vendor_dmic_array_config *cfg_vendor;
34 struct nhlt_fmt *fmt_configs; 34 struct nhlt_fmt *fmt_configs;
35 unsigned int dmic_geo = 0; 35 unsigned int dmic_geo = 0;
36 u16 max_ch = 0; 36 u16 max_ch = 0;
37 u8 i, j; 37 u8 i, j;
38 38
39 if (!nhlt) 39 if (!nhlt)
40 return 0; 40 return 0;
41 41
42 if (nhlt->header.length <= sizeof(stru 42 if (nhlt->header.length <= sizeof(struct acpi_table_header)) {
43 dev_warn(dev, "Invalid DMIC de 43 dev_warn(dev, "Invalid DMIC description table\n");
44 return 0; 44 return 0;
45 } 45 }
46 46
47 for (j = 0, epnt = nhlt->desc; j < nhl 47 for (j = 0, epnt = nhlt->desc; j < nhlt->endpoint_count; j++,
48 epnt = (struct nhlt_endpoint *)(( 48 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length)) {
49 49
50 if (epnt->linktype != NHLT_LIN 50 if (epnt->linktype != NHLT_LINK_DMIC)
51 continue; 51 continue;
52 52
53 cfg = (struct nhlt_dmic_array_ 53 cfg = (struct nhlt_dmic_array_config *)(epnt->config.caps);
54 fmt_configs = (struct nhlt_fmt 54 fmt_configs = (struct nhlt_fmt *)(epnt->config.caps + epnt->config.size);
55 55
56 /* find max number of channels 56 /* find max number of channels based on format_configuration */
57 if (fmt_configs->fmt_count) { 57 if (fmt_configs->fmt_count) {
58 struct nhlt_fmt_cfg *f 58 struct nhlt_fmt_cfg *fmt_cfg = fmt_configs->fmt_config;
59 59
60 dev_dbg(dev, "found %d 60 dev_dbg(dev, "found %d format definitions\n",
61 fmt_configs->f 61 fmt_configs->fmt_count);
62 62
63 for (i = 0; i < fmt_co 63 for (i = 0; i < fmt_configs->fmt_count; i++) {
64 struct wav_fmt 64 struct wav_fmt_ext *fmt_ext;
65 65
66 fmt_ext = &fmt 66 fmt_ext = &fmt_cfg->fmt_ext;
67 67
68 if (fmt_ext->f 68 if (fmt_ext->fmt.channels > max_ch)
69 max_ch 69 max_ch = fmt_ext->fmt.channels;
70 70
71 /* Move to the 71 /* Move to the next nhlt_fmt_cfg */
72 fmt_cfg = (str 72 fmt_cfg = (struct nhlt_fmt_cfg *)(fmt_cfg->config.caps +
73 73 fmt_cfg->config.size);
74 } 74 }
75 dev_dbg(dev, "max chan 75 dev_dbg(dev, "max channels found %d\n", max_ch);
76 } else { 76 } else {
77 dev_dbg(dev, "No forma 77 dev_dbg(dev, "No format information found\n");
78 } 78 }
79 79
80 if (cfg->device_config.config_ 80 if (cfg->device_config.config_type != NHLT_CONFIG_TYPE_MIC_ARRAY) {
81 dmic_geo = max_ch; 81 dmic_geo = max_ch;
82 } else { 82 } else {
83 switch (cfg->array_typ 83 switch (cfg->array_type) {
84 case NHLT_MIC_ARRAY_2C 84 case NHLT_MIC_ARRAY_2CH_SMALL:
85 case NHLT_MIC_ARRAY_2C 85 case NHLT_MIC_ARRAY_2CH_BIG:
86 dmic_geo = MIC 86 dmic_geo = MIC_ARRAY_2CH;
87 break; 87 break;
88 88
89 case NHLT_MIC_ARRAY_4C 89 case NHLT_MIC_ARRAY_4CH_1ST_GEOM:
90 case NHLT_MIC_ARRAY_4C 90 case NHLT_MIC_ARRAY_4CH_L_SHAPED:
91 case NHLT_MIC_ARRAY_4C 91 case NHLT_MIC_ARRAY_4CH_2ND_GEOM:
92 dmic_geo = MIC 92 dmic_geo = MIC_ARRAY_4CH;
93 break; 93 break;
94 case NHLT_MIC_ARRAY_VE 94 case NHLT_MIC_ARRAY_VENDOR_DEFINED:
95 cfg_vendor = ( 95 cfg_vendor = (struct nhlt_vendor_dmic_array_config *)cfg;
96 dmic_geo = cfg 96 dmic_geo = cfg_vendor->nb_mics;
97 break; 97 break;
98 default: 98 default:
99 dev_warn(dev, 99 dev_warn(dev, "%s: undefined DMIC array_type 0x%0x\n",
100 __fun 100 __func__, cfg->array_type);
101 } 101 }
102 102
103 if (dmic_geo > 0) { 103 if (dmic_geo > 0) {
104 dev_dbg(dev, " 104 dev_dbg(dev, "Array with %d dmics\n", dmic_geo);
105 } 105 }
106 if (max_ch > dmic_geo) 106 if (max_ch > dmic_geo) {
107 dev_dbg(dev, " 107 dev_dbg(dev, "max channels %d exceed dmic number %d\n",
108 max_ch 108 max_ch, dmic_geo);
109 } 109 }
110 } 110 }
111 } 111 }
112 112
113 dev_dbg(dev, "dmic number %d max_ch %d 113 dev_dbg(dev, "dmic number %d max_ch %d\n", dmic_geo, max_ch);
114 114
115 return dmic_geo; 115 return dmic_geo;
116 } 116 }
117 EXPORT_SYMBOL_GPL(intel_nhlt_get_dmic_geo); 117 EXPORT_SYMBOL_GPL(intel_nhlt_get_dmic_geo);
118 118
119 bool intel_nhlt_has_endpoint_type(struct nhlt_ 119 bool intel_nhlt_has_endpoint_type(struct nhlt_acpi_table *nhlt, u8 link_type)
120 { 120 {
121 struct nhlt_endpoint *epnt; 121 struct nhlt_endpoint *epnt;
122 int i; 122 int i;
123 123
124 if (!nhlt) 124 if (!nhlt)
125 return false; 125 return false;
126 126
127 epnt = (struct nhlt_endpoint *)nhlt->d 127 epnt = (struct nhlt_endpoint *)nhlt->desc;
128 for (i = 0; i < nhlt->endpoint_count; 128 for (i = 0; i < nhlt->endpoint_count; i++) {
129 if (epnt->linktype == link_typ 129 if (epnt->linktype == link_type)
130 return true; 130 return true;
131 131
132 epnt = (struct nhlt_endpoint * 132 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
133 } 133 }
134 return false; 134 return false;
135 } 135 }
136 EXPORT_SYMBOL(intel_nhlt_has_endpoint_type); 136 EXPORT_SYMBOL(intel_nhlt_has_endpoint_type);
137 137
138 int intel_nhlt_ssp_endpoint_mask(struct nhlt_a 138 int intel_nhlt_ssp_endpoint_mask(struct nhlt_acpi_table *nhlt, u8 device_type)
139 { 139 {
140 struct nhlt_endpoint *epnt; 140 struct nhlt_endpoint *epnt;
141 int ssp_mask = 0; 141 int ssp_mask = 0;
142 int i; 142 int i;
143 143
144 if (!nhlt || (device_type != NHLT_DEVI 144 if (!nhlt || (device_type != NHLT_DEVICE_BT && device_type != NHLT_DEVICE_I2S))
145 return 0; 145 return 0;
146 146
147 epnt = (struct nhlt_endpoint *)nhlt->d 147 epnt = (struct nhlt_endpoint *)nhlt->desc;
148 for (i = 0; i < nhlt->endpoint_count; 148 for (i = 0; i < nhlt->endpoint_count; i++) {
149 if (epnt->linktype == NHLT_LIN 149 if (epnt->linktype == NHLT_LINK_SSP && epnt->device_type == device_type) {
150 /* for SSP the virtual 150 /* for SSP the virtual bus id is the SSP port */
151 ssp_mask |= BIT(epnt-> 151 ssp_mask |= BIT(epnt->virtual_bus_id);
152 } 152 }
153 epnt = (struct nhlt_endpoint * 153 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
154 } 154 }
155 155
156 return ssp_mask; 156 return ssp_mask;
157 } 157 }
158 EXPORT_SYMBOL(intel_nhlt_ssp_endpoint_mask); 158 EXPORT_SYMBOL(intel_nhlt_ssp_endpoint_mask);
159 159
160 #define SSP_BLOB_V1_0_SIZE 84 160 #define SSP_BLOB_V1_0_SIZE 84
161 #define SSP_BLOB_V1_0_MDIVC_OFFSET 19 /* 161 #define SSP_BLOB_V1_0_MDIVC_OFFSET 19 /* offset in u32 */
162 162
163 #define SSP_BLOB_V1_5_SIZE 96 163 #define SSP_BLOB_V1_5_SIZE 96
164 #define SSP_BLOB_V1_5_MDIVC_OFFSET 21 /* 164 #define SSP_BLOB_V1_5_MDIVC_OFFSET 21 /* offset in u32 */
165 #define SSP_BLOB_VER_1_5 0xEE00 165 #define SSP_BLOB_VER_1_5 0xEE000105
166 166
167 #define SSP_BLOB_V2_0_SIZE 88 167 #define SSP_BLOB_V2_0_SIZE 88
168 #define SSP_BLOB_V2_0_MDIVC_OFFSET 20 /* 168 #define SSP_BLOB_V2_0_MDIVC_OFFSET 20 /* offset in u32 */
169 #define SSP_BLOB_VER_2_0 0xEE00 169 #define SSP_BLOB_VER_2_0 0xEE000200
170 170
171 int intel_nhlt_ssp_mclk_mask(struct nhlt_acpi_ 171 int intel_nhlt_ssp_mclk_mask(struct nhlt_acpi_table *nhlt, int ssp_num)
172 { 172 {
173 struct nhlt_endpoint *epnt; 173 struct nhlt_endpoint *epnt;
174 struct nhlt_fmt *fmt; 174 struct nhlt_fmt *fmt;
175 struct nhlt_fmt_cfg *cfg; 175 struct nhlt_fmt_cfg *cfg;
176 int mclk_mask = 0; 176 int mclk_mask = 0;
177 int i, j; 177 int i, j;
178 178
179 if (!nhlt) 179 if (!nhlt)
180 return 0; 180 return 0;
181 181
182 epnt = (struct nhlt_endpoint *)nhlt->d 182 epnt = (struct nhlt_endpoint *)nhlt->desc;
183 for (i = 0; i < nhlt->endpoint_count; 183 for (i = 0; i < nhlt->endpoint_count; i++) {
184 184
185 /* we only care about endpoint 185 /* we only care about endpoints connected to an audio codec over SSP */
186 if (epnt->linktype == NHLT_LIN 186 if (epnt->linktype == NHLT_LINK_SSP &&
187 epnt->device_type == NHLT_ 187 epnt->device_type == NHLT_DEVICE_I2S &&
188 epnt->virtual_bus_id == ss 188 epnt->virtual_bus_id == ssp_num) {
189 189
190 fmt = (struct nhlt_fmt 190 fmt = (struct nhlt_fmt *)(epnt->config.caps + epnt->config.size);
191 cfg = fmt->fmt_config; 191 cfg = fmt->fmt_config;
192 192
193 /* 193 /*
194 * In theory all forma 194 * In theory all formats should use the same MCLK but it doesn't hurt to
195 * double-check that t 195 * double-check that the configuration is consistent
196 */ 196 */
197 for (j = 0; j < fmt->f 197 for (j = 0; j < fmt->fmt_count; j++) {
198 u32 *blob; 198 u32 *blob;
199 int mdivc_offs 199 int mdivc_offset;
200 int size; 200 int size;
201 201
202 /* first check 202 /* first check we have enough data to read the blob type */
203 if (cfg->confi 203 if (cfg->config.size < 8)
204 return 204 return -EINVAL;
205 205
206 blob = (u32 *) 206 blob = (u32 *)cfg->config.caps;
207 207
208 if (blob[1] == 208 if (blob[1] == SSP_BLOB_VER_2_0) {
209 mdivc_ 209 mdivc_offset = SSP_BLOB_V2_0_MDIVC_OFFSET;
210 size = 210 size = SSP_BLOB_V2_0_SIZE;
211 } else if (blo 211 } else if (blob[1] == SSP_BLOB_VER_1_5) {
212 mdivc_ 212 mdivc_offset = SSP_BLOB_V1_5_MDIVC_OFFSET;
213 size = 213 size = SSP_BLOB_V1_5_SIZE;
214 } else { 214 } else {
215 mdivc_ 215 mdivc_offset = SSP_BLOB_V1_0_MDIVC_OFFSET;
216 size = 216 size = SSP_BLOB_V1_0_SIZE;
217 } 217 }
218 218
219 /* make sure w 219 /* make sure we have enough data for the fixed part of the blob */
220 if (cfg->confi 220 if (cfg->config.size < size)
221 return 221 return -EINVAL;
222 222
223 mclk_mask |= 223 mclk_mask |= blob[mdivc_offset] & GENMASK(1, 0);
224 224
225 cfg = (struct 225 cfg = (struct nhlt_fmt_cfg *)(cfg->config.caps + cfg->config.size);
226 } 226 }
227 } 227 }
228 epnt = (struct nhlt_endpoint * 228 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
229 } 229 }
230 230
231 /* make sure only one MCLK is used */ 231 /* make sure only one MCLK is used */
232 if (hweight_long(mclk_mask) != 1) 232 if (hweight_long(mclk_mask) != 1)
233 return -EINVAL; 233 return -EINVAL;
234 234
235 return mclk_mask; 235 return mclk_mask;
236 } 236 }
237 EXPORT_SYMBOL(intel_nhlt_ssp_mclk_mask); 237 EXPORT_SYMBOL(intel_nhlt_ssp_mclk_mask);
238 238
239 static struct nhlt_specific_cfg * 239 static struct nhlt_specific_cfg *
240 nhlt_get_specific_cfg(struct device *dev, stru 240 nhlt_get_specific_cfg(struct device *dev, struct nhlt_fmt *fmt, u8 num_ch,
241 u32 rate, u8 vbps, u8 bp !! 241 u32 rate, u8 vbps, u8 bps)
242 { 242 {
243 struct nhlt_fmt_cfg *cfg = fmt->fmt_co 243 struct nhlt_fmt_cfg *cfg = fmt->fmt_config;
244 struct wav_fmt *wfmt; 244 struct wav_fmt *wfmt;
245 u16 _bps, _vbps; 245 u16 _bps, _vbps;
246 int i; 246 int i;
247 247
248 dev_dbg(dev, "Endpoint format count=%d 248 dev_dbg(dev, "Endpoint format count=%d\n", fmt->fmt_count);
249 249
250 for (i = 0; i < fmt->fmt_count; i++) { 250 for (i = 0; i < fmt->fmt_count; i++) {
251 wfmt = &cfg->fmt_ext.fmt; 251 wfmt = &cfg->fmt_ext.fmt;
252 _bps = wfmt->bits_per_sample; 252 _bps = wfmt->bits_per_sample;
253 _vbps = cfg->fmt_ext.sample.va 253 _vbps = cfg->fmt_ext.sample.valid_bits_per_sample;
254 254
255 dev_dbg(dev, "Endpoint format: 255 dev_dbg(dev, "Endpoint format: ch=%d fmt=%d/%d rate=%d\n",
256 wfmt->channels, _vbps, 256 wfmt->channels, _vbps, _bps, wfmt->samples_per_sec);
257 257
258 /* <<
259 * When looking for exact matc <<
260 * from NHLT table when ignore <<
261 */ <<
262 if (wfmt->channels == num_ch & 258 if (wfmt->channels == num_ch && wfmt->samples_per_sec == rate &&
263 (ignore_vbps || vbps == _v !! 259 vbps == _vbps && bps == _bps)
264 return &cfg->config; 260 return &cfg->config;
265 261
266 cfg = (struct nhlt_fmt_cfg *)( 262 cfg = (struct nhlt_fmt_cfg *)(cfg->config.caps + cfg->config.size);
267 } 263 }
268 264
269 return NULL; 265 return NULL;
270 } 266 }
271 267
272 static bool nhlt_check_ep_match(struct device 268 static bool nhlt_check_ep_match(struct device *dev, struct nhlt_endpoint *epnt,
273 u32 bus_id, u8 269 u32 bus_id, u8 link_type, u8 dir, u8 dev_type)
274 { 270 {
275 dev_dbg(dev, "Endpoint: vbus_id=%d lin 271 dev_dbg(dev, "Endpoint: vbus_id=%d link_type=%d dir=%d dev_type = %d\n",
276 epnt->virtual_bus_id, epnt->li 272 epnt->virtual_bus_id, epnt->linktype,
277 epnt->direction, epnt->device_ 273 epnt->direction, epnt->device_type);
278 274
279 if ((epnt->virtual_bus_id != bus_id) | 275 if ((epnt->virtual_bus_id != bus_id) ||
280 (epnt->linktype != link_type) || 276 (epnt->linktype != link_type) ||
281 (epnt->direction != dir)) 277 (epnt->direction != dir))
282 return false; 278 return false;
283 279
284 /* link of type DMIC bypasses device_t 280 /* link of type DMIC bypasses device_type check */
285 return epnt->linktype == NHLT_LINK_DMI 281 return epnt->linktype == NHLT_LINK_DMIC ||
286 epnt->device_type == dev_type; 282 epnt->device_type == dev_type;
287 } 283 }
288 284
289 struct nhlt_specific_cfg * 285 struct nhlt_specific_cfg *
290 intel_nhlt_get_endpoint_blob(struct device *de 286 intel_nhlt_get_endpoint_blob(struct device *dev, struct nhlt_acpi_table *nhlt,
291 u32 bus_id, u8 li 287 u32 bus_id, u8 link_type, u8 vbps, u8 bps,
292 u8 num_ch, u32 ra 288 u8 num_ch, u32 rate, u8 dir, u8 dev_type)
293 { 289 {
294 struct nhlt_specific_cfg *cfg; 290 struct nhlt_specific_cfg *cfg;
295 struct nhlt_endpoint *epnt; 291 struct nhlt_endpoint *epnt;
296 bool ignore_vbps = false; <<
297 struct nhlt_fmt *fmt; 292 struct nhlt_fmt *fmt;
298 int i; 293 int i;
299 294
300 if (!nhlt) 295 if (!nhlt)
301 return NULL; 296 return NULL;
302 297
303 dev_dbg(dev, "Looking for configuratio 298 dev_dbg(dev, "Looking for configuration:\n");
304 dev_dbg(dev, " vbus_id=%d link_type=% 299 dev_dbg(dev, " vbus_id=%d link_type=%d dir=%d, dev_type=%d\n",
305 bus_id, link_type, dir, dev_ty 300 bus_id, link_type, dir, dev_type);
306 if (link_type == NHLT_LINK_DMIC && bps !! 301 dev_dbg(dev, " ch=%d fmt=%d/%d rate=%d\n", num_ch, vbps, bps, rate);
307 /* <<
308 * The DMIC hardware supports <<
309 * size, which is 24 bit sampl <<
310 * are used for indicating the <<
311 * It has been observed that s <<
312 * specified as 32 while some <<
313 * The format these variations <<
314 * hardware is configured and <<
315 * Note: when the samples assu <<
316 * introduced by the lower two <<
317 * real life implication on au <<
318 */ <<
319 dev_dbg(dev, <<
320 " ch=%d fmt=%d rate=% <<
321 num_ch, bps, rate); <<
322 ignore_vbps = true; <<
323 } else { <<
324 dev_dbg(dev, " ch=%d fmt=%d/% <<
325 } <<
326 dev_dbg(dev, "Endpoint count=%d\n", nh 302 dev_dbg(dev, "Endpoint count=%d\n", nhlt->endpoint_count);
327 303
328 epnt = (struct nhlt_endpoint *)nhlt->d 304 epnt = (struct nhlt_endpoint *)nhlt->desc;
329 305
330 for (i = 0; i < nhlt->endpoint_count; 306 for (i = 0; i < nhlt->endpoint_count; i++) {
331 if (nhlt_check_ep_match(dev, e 307 if (nhlt_check_ep_match(dev, epnt, bus_id, link_type, dir, dev_type)) {
332 fmt = (struct nhlt_fmt 308 fmt = (struct nhlt_fmt *)(epnt->config.caps + epnt->config.size);
333 309
334 cfg = nhlt_get_specifi !! 310 cfg = nhlt_get_specific_cfg(dev, fmt, num_ch, rate, vbps, bps);
335 <<
336 if (cfg) 311 if (cfg)
337 return cfg; 312 return cfg;
338 } 313 }
339 314
340 epnt = (struct nhlt_endpoint * 315 epnt = (struct nhlt_endpoint *)((u8 *)epnt + epnt->length);
341 } 316 }
342 317
343 return NULL; 318 return NULL;
344 } 319 }
345 EXPORT_SYMBOL(intel_nhlt_get_endpoint_blob); 320 EXPORT_SYMBOL(intel_nhlt_get_endpoint_blob);
346 <<
347 int intel_nhlt_ssp_device_type(struct device * <<
348 u8 virtual_bus_ <<
349 { <<
350 struct nhlt_endpoint *epnt; <<
351 int i; <<
352 <<
353 if (!nhlt) <<
354 return -EINVAL; <<
355 <<
356 epnt = (struct nhlt_endpoint *)nhlt->d <<
357 for (i = 0; i < nhlt->endpoint_count; <<
358 /* for SSP link the virtual bu <<
359 if (epnt->linktype == NHLT_LIN <<
360 epnt->virtual_bus_id == vi <<
361 dev_dbg(dev, "SSP%d: d <<
362 epnt->device_t <<
363 return epnt->device_ty <<
364 } <<
365 <<
366 epnt = (struct nhlt_endpoint * <<
367 } <<
368 <<
369 return -EINVAL; <<
370 } <<
371 EXPORT_SYMBOL(intel_nhlt_ssp_device_type); <<
372 321
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.