sof icon indicating copy to clipboard operation
sof copied to clipboard

[BUG] sof-ctl blob format is not the same as with ALSA UCM, should align the sof-ctl format

Open singalsu opened this issue 1 year ago • 4 comments

Describe the bug

Sof-ctl supports ASCII text format uint32_t numbers data (txt) and binary (blob) format. The binary blobs supported by UCM's cset-tlv need to have an additional 8 bytes header to work. The header contains for ALSA control API an index SOF_CTRL_CMD_BINARY (value 3) and size of following blob data without this header.

As result we need two kinds of binary blobs.

To Reproduce Trying to cset-tlv an existing blob is not working. There is a fix in #9070 to produce new format binary blobs for UCM. But those blobs do not work with sof-ctl.

Reproduction Rate Always

Expected behavior Tools support for blobs without confusion to developers. Likely it would be best to change in sof-ctl both text and binary format data files to use the version with header from UCM.

The topology embedded format is same as sof-ctl's current format, no 8 bytes header. The topology blob format (.m4 or .conf ASCII hex bytes) should stay the same to avoid a compatibility break.

Impact Annoyance.

Environment

  1. Branch name and commit hash of the 2 repositories: sof (firmware/topology) and linux (kernel driver).
    • Kernel: {SHA}
    • SOF: {SHA}
  2. Name of the topology file
    • Topology: {FILE}
  3. Name of the platform(s) on which the bug is observed.
    • Platform: {PLATFORM}

Screenshots or console output If applicable, add a screenshot (drag-and-drop an image), or console logs (cut-and-paste text and put a code fence (```) before and after, to help explain the issue.

Please also include the relevant sections from the firmware log and kernel log in the report (and attach the full logs for complete reference). Kernel log is taken from dmesg and firmware log from sof-logger. See https://thesofproject.github.io/latest/developer_guides/debugability/logger/index.html

singalsu avatar May 02 '24 11:05 singalsu

@singalsu is the intention to align sof-ctl with how cset-tlv works or the other way around ?

lgirdwood avatar May 02 '24 15:05 lgirdwood

@singalsu is the intention to align sof-ctl with how cset-tlv works or the other way around ?

There's already a lot of products mass with UCM's cset-tlv so we should follow it with sof-ctl (used only by developers).

singalsu avatar May 03 '24 07:05 singalsu

@singalsu Is this still planned for v2.11 (rc1 tag next Friday)?

kv2019i avatar Sep 05 '24 11:09 kv2019i

@singalsu Is this still planned for v2.11 (rc1 tag next Friday)?

I'll change it to v2.12, not enough time to test the change impact to various scripts (GUI, sof-test etc.). It's not critical since it's a developer feature.

singalsu avatar Sep 11 '24 14:09 singalsu

I today started I to work with the feature to target 2.13, updating Octave scripts for blobs exports and update sof-ctl. The patch depends on #9749.

singalsu avatar Dec 20 '24 15:12 singalsu

The fix is in #9760, now ready for review.

singalsu avatar Jan 28 '25 09:01 singalsu

The sof-ctl patch is now merged, this can be closed!

singalsu avatar Feb 13 '25 13:02 singalsu