SoundWire: start adding BPT/BRA support #5266

bardliao · 2024-12-06T02:08:37Z

This is a rebase version of #4679
I removed the removal of select' statements at a higher level. in the SND_SOC_SOF_HDA_LINK_BASELINE config in af779a3 which I think it is removed by accident.

drivers/soundwire/stream.c

drivers/soundwire/cadence_master.c

drivers/soundwire/intel_ace2x.c

sound/soc/sof/intel/hda-sdw-bpt.c

drivers/soundwire/intel.h

sound/soc/sof/intel/hda-sdw-bpt.c

plbossart

nice update @bardliao, keep up the good work.

Don't forget to add your own Signed-off-by tag.

plbossart · 2025-01-07T19:31:16Z

Documentation/driver-api/soundwire/summary.rst

didn't you provide multi-lane support already?

Indeed, that is great.

drivers/soundwire/cadence_master.c

plbossart · 2025-01-07T19:35:36Z

drivers/soundwire/cadence_master.c

typo: PDI0 and PDI1.

drivers/soundwire/cadence_master.c

plbossart · 2025-01-07T19:40:50Z

sound/soc/sof/intel/hda-sdw-bpt.c

plbossart · 2025-01-07T19:42:44Z

sound/soc/sof/intel/hda-sdw-bpt.c

need explanation of this value, I think it's 9.6MHz * Double data rate factor.
but if you can vary the clock now you'd need to use the max clock before using BRA/BPT...

@plbossart I think it is the sampling rate of the HDA stream. But I am not sure how does it related to the SoundWire bus rate. The SDW bus clock and the HDA sampling rate seems to be independent to me.
I guess why 192000 is because that is the max value of rate_bits[].

I can't recall where this came from... certainly something related to HDaudio format but why did we take 192k as the reference?

plbossart · 2025-01-07T19:45:31Z

sound/soc/sof/intel/hda-sdw-bpt.c

probably need an error message if the DMA position was never cleared and the timeout happens?

sound/soc/sof/intel/hda-sdw-bpt.c

plbossart · 2025-01-07T19:47:36Z

sound/soc/sof/intel/hda-sdw-bpt.c

I can't remember if there's any reason to disable RX first?

I think it is because we enable TX first. So to be symmetrical, we disable RX first.

lgirdwood · 2025-01-08T16:54:23Z

@ujfalusi can you give this a review too. Thanks !

sound/soc/sof/intel/hda-sdw-bpt.c

ujfalusi

@bardliao, I think you should add your signed-off-by and if your changes tot he original code warrants it and if @plbossart agrees, probably a Co-developed as well?

ujfalusi · 2025-01-10T12:43:38Z

drivers/soundwire/stream.c

SDW_STREAM_BPT is yet to be added, we only have definition for PCM and PDM

Swapped the commits order with the next commit.

include/linux/soundwire/sdw.h

ujfalusi · 2025-01-10T12:51:53Z

drivers/soundwire/generic_bandwidth_allocation.c

why do we pass the stream->type as a separate parameter via bpt_stream?

Good suggestion. Removed.

ujfalusi · 2025-01-10T12:52:27Z

drivers/soundwire/generic_bandwidth_allocation.c

if (stream->type == SDW_STREAM_BPT) {

?

drivers/soundwire/stream.c

ujfalusi · 2025-01-10T14:18:08Z

drivers/soundwire/debugfs.c

ujfalusi · 2025-01-10T14:19:08Z

drivers/soundwire/debugfs.c

I would check a log and drop debug prints to make it less noisy?

ok, removed

sound/soc/codecs/rt711-sdca-sdw.c

sound/soc/sof/intel/hda-sdw-bpt.c

BPT/BRA need to be special cased, i.e. there's no point in using the bandwidth allocation since the entire frame can be used. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

In the existing definition of sdw_stream_runtime, the 'type' member is never set and defaults to PCM. To prepare for the BPT/BRA support, we need to special-case streams and make use of the 'type'. No functional change for now, the implicit PCM type is now explicit. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

For BPT support, we want to allocate the entire audio payload and bypass the allocation based on PCM/PDM parameters. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

DP0 (Data Port 0) is very similar to regular data ports, with minor tweaks we can reuse the same code. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

bardliao · 2025-01-16T03:22:36Z

@bardliao, not much to comment on the functionality and flow, but can you check the patches for lines that can be folded?

I checked and folded the lines. Hope I didn't miss any.

ujfalusi

@bardliao, I only really have few small comments left..

ujfalusi · 2025-01-16T06:24:27Z

include/sound/hda-sdw-bpt.h

Probably a single WARN from hda_sdw_bpt_open() is enough to catch the attention?

Yes, but it is harmless to have WARN in every function.

ujfalusi · 2025-01-16T06:27:32Z

include/sound/hda-sdw-bpt.h

it is a good practice to protect the header with

#ifndef __HDA_SDW_BPT_H #define __HDA_SDW_BPT_H ... #endif /* __HDA_SDW_BPT_H */

ujfalusi · 2025-01-16T06:43:38Z

drivers/soundwire/bus.c

Sure, but adding a helper to do a sync transfer does not mean that the async and wait cannot be used as described while helping users to avoid duplicated code.
The do_bpt_sequence() could be as simple as:

static int do_bpt_sequence(struct sdw_slave *slave, bool write, u8 *buffer) { struct sdw_bpt_msg msg = {0}; msg.addr = start_addr; msg.len = num_bytes; msg.dev_num = slave->dev_num; if (write) msg.flags = SDW_MSG_FLAG_WRITE; else msg.flags = SDW_MSG_FLAG_READ; msg.buf = buffer; return sdw_bpt_send_sync(slave->bus, slave, &msg); /* Errors printed in the helper */ }

ujfalusi · 2025-01-16T06:43:54Z

drivers/soundwire/debugfs.c

this can fit to one line ;)

Add definitions and helpers for the BPT/BRA protocol. Peripheral drivers (aka ASoC codec drivers) can use this API to send bulk data such as firmware or tables. The design intent is however NOT to directly use this API but to rely on an intermediate regmap layer. The API is only available when no other audio streams have been allocated, and only one BTP/BRA stream is allowed per link. To avoid the addition of yet another lock, the refcount tests are handled in the stream master_runtime alloc/free routines where the bus_lock is already held. Another benefit of this approach is that the same bus_lock is used to handle runtime and port linked lists, which reduces the potential for misaligned configurations. In addition to exclusion with audio streams, BPT transfers have a lot of overhead, specifically registers writes are needed to enable transport in DP0. Most DMAs don't handle too well very small data sets and they may have alignment limitations. The size and alignment requirements are for now not handled by the core but must be checked by platform-specific drivers. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

Add a convenience pointer to the 'sdw_bus' structure. BPT is a dedicated stream which will typically not be handled by DAIs or dailinks. Since there's only one BPT stream per link, storing the pointer at the link level seems rather natural. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

The Cadence IP expects a specific format (detailed in the Documentation). Add helpers to copy the data into the DMA buffer. The crc8 table is for now only used by the Cadence driver. This table might be moved to a common module at a later point if needed by other controller implementations. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

Mirror abstraction added for master ops. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

Add SoundWire BPT DMA helpers as a separate module to avoid circular dependencies. For now this assumes no link DMA, only coupled mode. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

This is needed to be shared between open/send_async/close. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

Add support for BTP API using Cadence and hda-sdw-bpt helpers. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

When the firmware is involved, the data can be transferred with a CHAIN_DMA on LNL+. The CHAIN_DMA needs to be programmed before the DMAs per the documentation. The states are not exactly symmetrical, on stop we must do a PAUSE and RESET. The FIFO size of 10ms was determined experimentally. With the minimum of 2ms, errors were reported by the codec, likely because of xruns. The code flow deals with the two TX and RX CHAIN_DMAs in symmetrical ways, i.e. alloc TX alloc RX enable TX enable RX disable RX disable TX free RX free TX Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

Add code to show what codec drivers will need to do to enable BPT/BRA transfers. The only difference is to set the 'command_type' file to '1'. A zero-value will rely on regular read/write commands in Column0. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

DP0 is required for BPT/BRA transport. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

ujfalusi

@bardliao (and @plbossart ) thank you I think this looks pretty nice!

ranj063 · 2025-01-22T18:45:02Z

SOFCI TEST

plbossart

one typo in comments, this can be handled with a fixup, thanks @bardliao

plbossart · 2025-01-22T22:13:11Z

Documentation/driver-api/soundwire/bra.rst

+       that stream can connect master ports as well as all peripheral
+       DP0 ports.
+
+   (5) BRA transfers only make sense in the concept of one


in the context of

plbossart · 2025-01-22T22:23:37Z

sound/soc/sof/intel/hda-sdw-bpt.c

I can't recall where this came from... certainly something related to HDaudio format but why did we take 192k as the reference?

bardliao · 2025-01-23T03:24:08Z

@plbossart The fixup PR: #5305

bardliao force-pushed the sdw/start-BRA-support branch from 5d16674 to 1b0b781 Compare December 6, 2024 05:33

bardliao commented Dec 11, 2024

View reviewed changes

drivers/soundwire/stream.c Outdated Show resolved Hide resolved

bardliao commented Dec 11, 2024

View reviewed changes

drivers/soundwire/stream.c Outdated Show resolved Hide resolved

bardliao commented Dec 12, 2024

View reviewed changes

drivers/soundwire/stream.c Outdated Show resolved Hide resolved

bardliao commented Dec 12, 2024

View reviewed changes

drivers/soundwire/cadence_master.c Outdated Show resolved Hide resolved

bardliao commented Dec 12, 2024

View reviewed changes

drivers/soundwire/intel_ace2x.c Outdated Show resolved Hide resolved

bardliao commented Dec 12, 2024

View reviewed changes

drivers/soundwire/intel_ace2x.c Outdated Show resolved Hide resolved

bardliao force-pushed the sdw/start-BRA-support branch from 1b0b781 to 336a2f4 Compare December 24, 2024 07:44

bardliao force-pushed the sdw/start-BRA-support branch 4 times, most recently from 4291dd7 to 1eb379b Compare January 6, 2025 12:32

bardliao marked this pull request as ready for review January 6, 2025 12:55

bardliao requested review from dbaluta, kv2019i, lgirdwood, plbossart, ranj063 and ujfalusi as code owners January 6, 2025 12:55

ranj063 reviewed Jan 6, 2025

View reviewed changes

bardliao force-pushed the sdw/start-BRA-support branch from 1eb379b to 8debac1 Compare January 7, 2025 07:47

ranj063 reviewed Jan 7, 2025

View reviewed changes

sound/soc/sof/intel/hda-sdw-bpt.c Outdated Show resolved Hide resolved

plbossart reviewed Jan 7, 2025

View reviewed changes

bardliao force-pushed the sdw/start-BRA-support branch 2 times, most recently from 470fcc9 to fa54048 Compare January 8, 2025 08:51

ranj063 reviewed Jan 8, 2025

View reviewed changes

sound/soc/sof/intel/hda-sdw-bpt.c Outdated Show resolved Hide resolved

bardliao force-pushed the sdw/start-BRA-support branch from fa54048 to dc995f8 Compare January 9, 2025 03:11

ranj063 previously approved these changes Jan 9, 2025

View reviewed changes

ujfalusi reviewed Jan 10, 2025

View reviewed changes

plbossart added 3 commits January 15, 2025 22:01

soundwire: extend sdw_stream_type to BPT

0d1876a

BPT/BRA need to be special cased, i.e. there's no point in using the bandwidth allocation since the entire frame can be used. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

soundwire: stream: special-case the bus compute_params() routine

634117f

For BPT support, we want to allocate the entire audio payload and bypass the allocation based on PCM/PDM parameters. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

bardliao force-pushed the sdw/start-BRA-support branch from 1811ffb to e297ac6 Compare January 16, 2025 01:43

soundwire: stream: reuse existing code for BPT stream

1fb9822

DP0 (Data Port 0) is very similar to regular data ports, with minor tweaks we can reuse the same code. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

bardliao force-pushed the sdw/start-BRA-support branch 2 times, most recently from c292254 to 6efefed Compare January 16, 2025 03:20

ujfalusi reviewed Jan 16, 2025

View reviewed changes

plbossart and others added 10 commits January 16, 2025 16:21

soundwire: intel_auxdevice: add indirection for BPT send_async/wait

e9e29f3

Mirror abstraction added for master ops. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

soundwire: intel: add BPT context definition

d1aa453

This is needed to be shared between open/send_async/close. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

soundwire: intel_ace2x: add BPT send_async/wait callbacks

9411b6f

Add support for BTP API using Cadence and hda-sdw-bpt helpers. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

ASoC: rt711-sdca: add DP0 support

1f40c2e

DP0 is required for BPT/BRA transport. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]>

bardliao force-pushed the sdw/start-BRA-support branch from 6efefed to 1f40c2e Compare January 16, 2025 08:31

ujfalusi approved these changes Jan 16, 2025

View reviewed changes

bardliao requested review from plbossart and ranj063 January 16, 2025 09:26

lgirdwood approved these changes Jan 16, 2025

View reviewed changes

ranj063 approved these changes Jan 22, 2025

View reviewed changes

plbossart approved these changes Jan 22, 2025

View reviewed changes

plbossart mentioned this pull request Jan 22, 2025

SoundWire: start adding BPT/BRA support #4679

Closed

bardliao merged commit fb2c628 into thesofproject:topic/sof-dev Jan 23, 2025
7 of 14 checks passed

SoundWire: start adding BPT/BRA support #5266

SoundWire: start adding BPT/BRA support #5266

Uh oh!

Conversation

bardliao commented Dec 6, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

plbossart left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lgirdwood commented Jan 8, 2025

Uh oh!

Uh oh!

ujfalusi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bardliao Jan 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

bardliao Jan 13, 2025 •

edited

Loading