Skip to contentSkip to conversation

ASoC: rt722-sdca: Add a control to support CAE firmware update

PATCH Superseded [email protected] 2 participants 2 messages May 19

Subsystems (3)

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 ASoC: rt722-sdca: Add a control to support CAE firmware update

From: Jack Yu <[email protected]>

Realtek CAE requires specific tuning parameters based on the system vendor and SKU.
This patch adds a kcontrol to trigger the firmware loading process.

---
Changes in v3:
- Remove test robot tags from commit message.
- Add boundary checks during firmware parsing to prevent out-of-bounds reads.

Changes in v2:
- Fix the build error caught by kernel test robot. Replace the non-existent snd_soc_component_get_bias_level() with snd_soc_dapm_get_bias_level().

---
 sound/soc/codecs/rt722-sdca-sdw.c |  39 +++-
 sound/soc/codecs/rt722-sdca.c     | 289 +++++++++++++++++++++++++++++-
 sound/soc/codecs/rt722-sdca.h     |  23 +++
 3 files changed, 343 insertions(+), 8 deletions(-)
sound/soc/codecs/rt722-sdca-sdw.c +37 -2
index a5feba3d0c18..0f76492ff915 100644
@@ -19,7 +19,9 @@
 static int rt722_sdca_mbq_size(struct device *dev, unsigned int reg)
 {
 	switch (reg) {
-	case 0x2f01 ... 0x2f0a:
+	case 0x22f0 ... 0x22f1:
+	case 0x2f01 ... 0x2f0c:
+	case 0x2f21 ... 0x2f24:
 	case 0x2f35 ... 0x2f36:
 	case 0x2f50 ... 0x2f52:
 	case 0x2f54:
@@ -84,6 +86,21 @@ static int rt722_sdca_mbq_size(struct device *dev, unsigned int reg)
 	case SDW_SDCA_CTL(FUNC_NUM_AMP, RT722_SDCA_ENT_CS31,
 			  RT722_SDCA_CTL_SAMPLE_FREQ_INDEX, 0):
 	case RT722_BUF_ADDR_HID1 ... RT722_BUF_ADDR_HID2:
+	case 0x44011000 ... 0x440115ff:
+	case 0x44012000:
+	case 0x44012021:
+	case 0x44012022:
+	case 0x44012025:
+	case 0x44021000 ... 0x440211ff:
+	case 0x44022000:
+	case 0x44022019:
+	case 0x4402201a:
+	case 0x4402201d:
+	case 0x44041000 ... 0x440415ff:
+	case 0x44042000:
+	case 0x44042019:
+	case 0x4404201a:
+	case 0x4404201d:
 		return 1;
 	case 0x2000000 ... 0x2000024:
 	case 0x2000029 ... 0x200004a:
@@ -95,8 +112,10 @@ static int rt722_sdca_mbq_size(struct device *dev, unsigned int reg)
 	case 0x200007f:
 	case 0x2000082 ... 0x200008e:
 	case 0x2000090 ... 0x2000094:
+	case 0x20000b1:
+	case 0x20000b4:
 	case 0x3110000:
-	case 0x5300000 ... 0x5300002:
+	case 0x5300000 ... 0x5300300:
 	case 0x5400002:
 	case 0x5600000 ... 0x5600007:
 	case 0x5700000 ... 0x5700004:
@@ -175,6 +194,7 @@ static bool rt722_sdca_volatile_register(struct device *dev, unsigned int reg)
 	case SDW_SDCA_CTL(FUNC_NUM_AMP, RT722_SDCA_ENT_PDE23, RT722_SDCA_CTL_ACTUAL_POWER_STATE, 0):
 	case RT722_BUF_ADDR_HID1 ... RT722_BUF_ADDR_HID2:
 	case 0x2000000:
+	case 0x2000007:
 	case 0x200000d:
 	case 0x2000019:
 	case 0x2000020:
@@ -186,6 +206,21 @@ static bool rt722_sdca_volatile_register(struct device *dev, unsigned int reg)
 	case 0x3110000:
 	case 0x5800003:
 	case 0x5810000:
+	case 0x44011000 ... 0x440115ff:
+	case 0x44012000:
+	case 0x44012021:
+	case 0x44012022:
+	case 0x44012025:
+	case 0x44021000 ... 0x440211ff:
+	case 0x44022000:
+	case 0x44022019:
+	case 0x4402201a:
+	case 0x4402201d:
+	case 0x44041000 ... 0x440415ff:
+	case 0x44042000:
+	case 0x44042019:
+	case 0x4404201a:
+	case 0x4404201d:
 		return true;
 	default:
 		return false;
sound/soc/codecs/rt722-sdca.c +283 -6

320 lines not on this page · raw message

sound/soc/codecs/rt722-sdca.h +23 -0
index fc50beff9424..b654b14334d4 100644
@@ -44,6 +44,7 @@ struct  rt722_sdca_priv {
 	bool fu1e_dapm_mute;
 	bool fu1e_mixer_mute[4];
 	int hw_vid;
+	int cae_update_done;
 };
 
 struct rt722_sdca_dmic_kctrl_priv {
@@ -55,6 +56,7 @@ struct rt722_sdca_dmic_kctrl_priv {
 
 /* NID */
 #define RT722_VENDOR_REG			0x20
+#define RT722_VENDOR_EQ_CAE			0x53
 #define RT722_VENDOR_CALI			0x58
 #define RT722_VENDOR_SPK_EFUSE			0x5c
 #define RT722_VENDOR_IMS_DRE			0x5b
@@ -64,6 +66,7 @@ struct rt722_sdca_dmic_kctrl_priv {
 /* Index (NID:20h) */
 #define RT722_JD_PRODUCT_NUM			0x00
 #define RT722_ANALOG_BIAS_CTL3			0x04
+#define RT722_MISC_CTRL1			0x07
 #define RT722_JD_CTRL1				0x09
 #define RT722_LDO2_3_CTL1			0x0e
 #define RT722_LDO1_CTL				0x1a
@@ -79,6 +82,12 @@ struct rt722_sdca_dmic_kctrl_priv {
 #define RT722_SW_CONFIG1			0x8a
 #define RT722_SW_CONFIG2			0x8b
 
+/* Index (NID:53h) */
+#define RT722_EQ_CTRL_SPK			0x00
+#define RT722_EQ_CTRL_HP			0x100
+#define RT722_EQ_CTRL_DMIC			0x200
+#define RT722_EQ_CTRL_AMIC			0x300
+
 /* Index (NID:58h) */
 #define RT722_DAC_DC_CALI_CTL0			0x00
 #define RT722_DAC_DC_CALI_CTL1			0x01
@@ -156,6 +165,20 @@ struct rt722_sdca_dmic_kctrl_priv {
 #define RT722_BUF_ADDR_HID1			0x44030000
 #define RT722_BUF_ADDR_HID2			0x44030020
 
+/* RT722 CAE parameter settings */
+#define RT722_SPK_CAE_PARAM1			0x44012000
+#define RT722_SPK_CAE_PARAM34			0x44012021
+#define RT722_SPK_CAE_PARAM35			0x44012022
+#define RT722_SPK_CAE_PARAM38			0x44012025
+#define RT722_HP_CAE_PARAM39			0x44022000
+#define RT722_HP_CAE_PARAM64			0x44022019
+#define RT722_HP_CAE_PARAM65			0x4402201a
+#define RT722_HP_CAE_PARAM68			0x4402201d
+#define RT722_MIC_CAE_PARAM39			0x44042000
+#define RT722_MIC_CAE_PARAM95			0x44042019
+#define RT722_MIC_CAE_PARAM96			0x4404201a
+#define RT722_MIC_CAE_PARAM99			0x4404201d
+
 /* RT722 SDCA Control - function number */
 #define FUNC_NUM_JACK_CODEC			0x01
 #define FUNC_NUM_MIC_ARRAY			0x02
Signature · 1 line
2.54.0
#1 lore raw
kernel test robot noticed the following build warnings:

Hi,

kernel test robot noticed the following build warnings:

[auto build test WARNING on broonie-sound/for-next]
[also build test WARNING on linus/master v7.1-rc4 next-20260518] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]

url:    https://github.com/intel-lab-lkp/linux/commits/jack-yu-realtek-com/ASoC-rt722-sdca-Add-a-control-to-support-CAE-firmware-update/20260519-172233
base:   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next
patch link:    https://lore.kernel.org/r/20260519054737.3457747-1-jack.yu%40realtek.com
patch subject: [PATCH v3] ASoC: rt722-sdca: Add a control to support CAE firmware update
config: arm-allyesconfig (https://download.01.org/0day-ci/archive/20260520/[email protected]/config)
compiler: arm-linux-gnueabi-gcc (GCC) 15.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20260520/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

sound/soc/codecs/rt722-sdca.c: In function 'rt722_cae_load':

>> sound/soc/codecs/rt722-sdca.c:569:1: warning: the frame size of 1416 bytes is larger than 1280 bytes [-Wframe-larger-than=]
     569 | }
         | ^

vim +569 sound/soc/codecs/rt722-sdca.c

348
349 static int rt722_cae_load(struct rt722_sdca_priv *rt722)
350 {
351 struct device *dev = &rt722->slave->dev;
352 static const char func_tag[] = "FUNC";
353 static const char xu_tag[] = "XU";
354 const char *dmi_vendor, *dmi_product, *dmi_sku;
355 char vendor[128], product[128], sku[128];
356 char *ptr_vendor, *ptr_product, *ptr_sku;
357 char cae_filename[512];
358 const struct firmware *cae_fw = NULL;
359 unsigned int cae_st_spk, cae_st_hp, cae_st_mic;
360 unsigned int func, value;
361 unsigned int combined_val;
362 unsigned int addr, size;
363 unsigned int fw_offset;
364 unsigned char mbq_high_val = 0;
365 unsigned char *param_data;
366 unsigned char *fw_data;
367 char tag[5];
368 int ret = 0, i;
369 int retry = 50;
370
371 dmi_vendor = dmi_get_system_info(DMI_SYS_VENDOR);
372 dmi_product = dmi_get_system_info(DMI_PRODUCT_NAME);
373 dmi_sku = dmi_get_system_info(DMI_PRODUCT_SKU);
374
375 if (dmi_vendor && dmi_product && dmi_sku) {
376 strscpy(vendor, dmi_vendor);
377 strscpy(product, dmi_product);
378 strscpy(sku, dmi_sku);
379 ptr_vendor = &vendor[0];
380 ptr_product = &product[0];
381 ptr_sku = &sku[0];
382 ptr_vendor = strsep(&ptr_vendor, " ");
383 ptr_product = strsep(&ptr_product, " ");
384 ptr_sku = strsep(&ptr_sku, " ");
385 dev_dbg(dev, "%s: DMI vendor=%s, product=%s, sku=%s\n", __func__,
386 vendor, product, sku);
387
388 snprintf(cae_filename, sizeof(cae_filename),
389 "realtek/rt722/rt722_RAE_%s_%s_%s.dat", vendor, product, sku);
390 dev_dbg(dev, "%s: try to load CAE file %s\n", __func__, cae_filename);
391 } else {
392 dev_warn(dev, "%s: No CAE file found!\n", __func__);
393 return -EINVAL;
394 }
395
396 regmap_write(rt722->regmap, RT722_SPK_CAE_PARAM1, 0x5f);
397 regmap_write(rt722->regmap, RT722_HP_CAE_PARAM39, 0x5f);
398 regmap_write(rt722->regmap, RT722_MIC_CAE_PARAM39, 0x5f);
399 usleep_range(50000, 60000);
400
401 request_firmware(&cae_fw, cae_filename, dev);
402 if (!cae_fw) {
403 dev_err(dev, "%s: Failed to load CAE firmware\n", __func__);
404 return -ENOENT;
405 }
406
407 regmap_read(rt722->regmap, RT722_SPK_CAE_PARAM38, &cae_st_spk);
408 regmap_read(rt722->regmap, RT722_HP_CAE_PARAM68, &cae_st_hp);
409 regmap_read(rt722->regmap, RT722_MIC_CAE_PARAM99, &cae_st_mic);
410 cae_st_spk &= 0x80;
411 cae_st_hp &= 0x80;
412 cae_st_mic &= 0x80;
413
414 dev_dbg(dev, "%s(%d) spk_crc:%x, hp_crc:%x, mic_crc:%x\n",
415 __func__, __LINE__, cae_st_spk, cae_st_hp, cae_st_mic);
416
417 if (cae_st_spk)
418 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_EQ_CAE,
419 RT722_EQ_CTRL_SPK, 0x0008, 0x0008);
420 else if (cae_st_hp)
421 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_EQ_CAE,
422 RT722_EQ_CTRL_HP, 0x0008, 0x0008);
423 else if (cae_st_mic)
424 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_EQ_CAE,
425 RT722_EQ_CTRL_DMIC, 0x0008, 0x0008);
426
427 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_REG,
428 RT722_MISC_CTRL1, 0x8000, 0x8000);
429
430 regmap_update_bits(rt722->regmap, RT722_SPK_CAE_PARAM34, 0x1, 0x0);
431 regmap_update_bits(rt722->regmap, RT722_HP_CAE_PARAM64, 0x1, 0x0);
432 regmap_update_bits(rt722->regmap, RT722_MIC_CAE_PARAM95, 0x1, 0x0);
433
434 while (--retry) {
435 regmap_read(rt722->regmap, RT722_SPK_CAE_PARAM35, &cae_st_spk);
436 regmap_read(rt722->regmap, RT722_HP_CAE_PARAM65, &cae_st_hp);
437 regmap_read(rt722->regmap, RT722_MIC_CAE_PARAM96, &cae_st_mic);
438 dev_dbg(dev, "%s(%d) cae_st_spk:%x, cae_st_hp:%x, cae_st_mic:%x\n",
439 __func__, __LINE__, cae_st_spk, cae_st_hp, cae_st_mic);
440 if ((cae_st_spk & 0x40) && (cae_st_hp & 0x40) && (cae_st_mic & 0x40))
441 break;
442 usleep_range(1000, 1100);
443 }
444
445 if (!retry && !((cae_st_spk & 0x40) && (cae_st_hp & 0x40)
446 && (cae_st_mic & 0x40))) {
447 dev_err(dev, "%s: CAE is not ready to be loaded.\n", __func__);
448 ret = -ETIMEDOUT;
449 goto out_release;
450 }
451
452 dev_dbg(dev, "%s, cae_fw size=0x%zx, start\n", __func__, cae_fw->size);
453
454 rt722_sdca_index_write(rt722, RT722_VENDOR_EQ_CAE,
455 RT722_EQ_CTRL_AMIC, 0x8000);
456 rt722_sdca_index_write(rt722, RT722_VENDOR_EQ_CAE,
457 RT722_EQ_CTRL_DMIC, 0x8004);
458 rt722_sdca_index_write(rt722, RT722_VENDOR_EQ_CAE,
459 RT722_EQ_CTRL_HP, 0x8074);
460 rt722_sdca_index_write(rt722, RT722_VENDOR_EQ_CAE,
461 RT722_EQ_CTRL_SPK, 0xa074);
462
463 regcache_cache_bypass(rt722->regmap, true);
464 for (fw_offset = 0; fw_offset < cae_fw->size;) {
465
466 if (fw_offset + 12 > cae_fw->size) {
467 dev_err(dev, "%s: Unexpected end of firmware\n", __func__);
468 ret = -EINVAL;
469 goto verify_abort;
470 }
471
472 fw_data = (unsigned char *)&cae_fw->data[fw_offset];
473 memcpy(tag, fw_data, 4);
474 tag[4] = '\0';
475
476 if (strcmp(tag, xu_tag) == 0) {
477 dev_dbg(dev, "%s: This is a XU tag", __func__);
478 memcpy(&addr, (fw_data + 4), 4);
479 memcpy(&size, (fw_data + 8), 4);
480
481 if (fw_offset + 12 + size > cae_fw->size) {
482 dev_err(dev, "%s: Firmware payload out of bounds\n", __func__);
483 ret = -EINVAL;
484 goto verify_abort;
485 }
486
487 param_data = (unsigned char *)(fw_data + 12);
488
489 dev_dbg(dev, "%s: addr=0x%x, size=0x%x\n", __func__, addr, size);
490
491 if ((addr <= 0x05302300 && addr >= 0x05300000) ||
492 (addr <= 0x020020b4 && addr >= 0x020000b1)) {
493 if (addr & BIT(13)) {
494 mbq_high_val = param_data[0];
495 dev_dbg(dev, "MBQ: High Byte 0x%02x\n", mbq_high_val);
496 fw_offset += (size + 12);
497
498 continue;
499 } else {
500 regcache_cache_bypass(rt722->regmap, false);
501 combined_val = (mbq_high_val << 8) | param_data[0];
502 if (addr == 0x20000b1 || addr == 0x20000b4)
503 combined_val |= (0x2 << 8);
504 ret = regmap_write(rt722->regmap, addr, combined_val);
505 if (ret) {
506 dev_err(dev,
507 "MBQ fail: addr=0x%x ret=%d\n", addr, ret);
508 regcache_cache_bypass(rt722->regmap, true);
509 goto verify_abort;
510 }
511
512 dev_dbg(dev, "MBQ-reg=0x%x, value=0x%x\n",
513 addr, combined_val);
514
515 fw_offset += (size + 12);
516 regcache_cache_bypass(rt722->regmap, true);
517 continue;
518 }
519 }
520
521 for (i = 0; i < size; i++) {
522 ret = regmap_write(rt722->regmap, addr + i, param_data[i]);
523 if (ret) {
524 dev_err(dev,
525 "CAE write fail: addr=0x%x ret=%d\n",
526 addr + i, ret);
527 goto verify_abort;
528 }
529 }
530 fw_offset += (size + 12);
531 } else if (strcmp(tag, func_tag) == 0) {
532 dev_dbg(dev, "%s: This is a FUNC tag", __func__);
533
534 memcpy(&func, (fw_data + 4), 4);
535 memcpy(&value, (fw_data + 8), 4);
536 dev_dbg(dev, "%s: func=0x%x, value=0x%x\n",
537 __func__, func, value);
538
539 if (func == 1)
540 msleep(value);
541
542 fw_offset += 12;
543 } else {
544 dev_err(dev, "%s: No XU/FUNC tag at fw_offset=0x%x\n",
545 __func__, fw_offset);
546 ret = -EINVAL;
547 goto verify_abort;
548 }
549 }
550
551 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_REG,
552 RT722_MISC_CTRL1, 0x8000, 0x0000);
553 regcache_cache_bypass(rt722->regmap, false);
554 rt722->cae_update_done = 1;
555 dev_dbg(dev, "%s: CAE FW update done.\n", __func__);
556 release_firmware(cae_fw);
557 return 0;
558
559 verify_abort:
560 regcache_cache_bypass(rt722->regmap, false);
561 if (!ret)
562 ret = -EIO;
563 out_release:
564 rt722_sdca_index_update_bits(rt722, RT722_VENDOR_REG,
565 RT722_MISC_CTRL1, 0x8000, 0x0000);
566 release_firmware(cae_fw);
567 dev_err(dev, "%s: CAE FW update aborted (ret=%d).\n", __func__, ret);
568 return ret;

 > 569	}

570

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki