Skip to contentSkip to conversation

soundwire: SDCA: add helper macro to access controls

PATCH Superseded Bard Liao 3 participants 4 messages Aug 17, 2020 – Aug 21, 2020 SoundWire

v2 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Bard Liao

author maintainer
#0 lore raw

PATCH v2 1/1 soundwire: SDCA: add helper macro to access controls

From: Pierre-Louis Bossart <[email protected]>

The upcoming SDCA (SoundWire Device Class Audio) specification defines a hiearchical encoding to interface with Class-defined capabilities, based on which audio function, entity, control and channel being used.

The specification is not yet accessible to the general public but this information is released with explicit permission from the MIPI Board to avoid delays with SDCA support on Linux platforms.

---

Changelog:

v2:
- add SDW_SDCA_MBQ_CTL

---
 include/linux/soundwire/sdw_registers.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)
include/linux/soundwire/sdw_registers.h +12 -0
index 5d3c271af7d1..4517c0f65b4f 100644
@@ -305,4 +305,16 @@
 #define SDW_CASC_PORT_MASK_INTSTAT3		1
 #define SDW_CASC_PORT_REG_OFFSET_INTSTAT3	2
 
+/* v1.2 device - SDCA address mapping */
+#define SDW_SDCA_CTL(fun, ent, ctl, ch)		(BIT(30) |			\
+						 (((fun) & 0x7) << 22) |	\
+						 (((ent) & 0x40) << 15) |	\
+						 (((ent) & 0x3f) << 7) |	\
+						 (((ctl) & 0x30) << 15) |	\
+						 (((ctl) & 0x0f) << 3) |	\
+						 (((ch) & 0x38) << 12) |	\
+						 ((ch) & 0x07))
+
+#define SDW_SDCA_MBQ_CTL(reg)			((reg) | BIT(13))
+
 #endif /* __SDW_REGISTERS_H */
Signature · 1 line
2.17.1
maintainer
#1 lore raw
Quoted 4 lines · Bard Liao

From: Pierre-Louis Bossart <[email protected]>

The upcoming SDCA (SoundWire Device Class Audio) specification defines a hiearchical encoding to interface with Class-defined capabilities,

typo hiearchical

Quoted 1 line

based on which audio function, entity, control and channel being used.

Can you please elaborate on what do these terms refer to?

Also can we have some documentation for this and how Linux is going to use it..

Quoted 28 lines

The specification is not yet accessible to the general public but this information is released with explicit permission from the MIPI Board to avoid delays with SDCA support on Linux platforms.

---

Changelog:

v2:
- add SDW_SDCA_MBQ_CTL

---
 include/linux/soundwire/sdw_registers.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)
include/linux/soundwire/sdw_registers.h +0 -0
index 5d3c271af7d1..4517c0f65b4f 100644
@@ -305,4 +305,16 @@
 #define SDW_CASC_PORT_MASK_INTSTAT3		1
 #define SDW_CASC_PORT_REG_OFFSET_INTSTAT3	2
 

include/linux/soundwire/sdw_registers.h line 317

Quoted 10 lines
include/linux/soundwire/sdw_registers.h +10 -0
+/* v1.2 device - SDCA address mapping */
+#define SDW_SDCA_CTL(fun, ent, ctl, ch)		(BIT(30) |			\
+						 (((fun) & 0x7) << 22) |	\
+						 (((ent) & 0x40) << 15) |	\
+						 (((ent) & 0x3f) << 7) |	\
+						 (((ctl) & 0x30) << 15) |	\
+						 (((ctl) & 0x0f) << 3) |	\
+						 (((ch) & 0x38) << 12) |	\
+						 ((ch) & 0x07))
+

how about adding an underscore to the arguments here:

#define SDW_SDCA_CTL(_fun, _ent, _ctl, _ch)
and so on..

Signature · 1 line
~Vinod
#2 lore raw
Quoted 5 lines
Quoted 3 lines

The upcoming SDCA (SoundWire Device Class Audio) specification defines a hiearchical encoding to interface with Class-defined capabilities,

typo hiearchical

ok

Quoted 6 lines
Quoted 1 line

based on which audio function, entity, control and channel being used.

Can you please elaborate on what do these terms refer to?

Also can we have some documentation for this and how Linux is going to use it..

These are concepts in the SDCA draft spec, and that should be the reference. We worked with MIPI so that this spec will be available with a click-through agreement when ratified, for now it's only available to contributors per MIPI bylaws.

If you do not have access to this specification, then that's a real problem. Maybe you need to let Bard take care of this part as a co-maintainer?

The goal with this macro is to enable a first set of codecs drivers using these concepts to be released upstream. All you need to know at this point is that controls are defined in a hierarchical way and accessed with a read/write transaction from/to the address created with the following macro.

Quoted 13 lines

include/linux/soundwire/sdw_registers.h line 317

Quoted 10 lines
include/linux/soundwire/sdw_registers.h +10 -0
+/* v1.2 device - SDCA address mapping */
+#define SDW_SDCA_CTL(fun, ent, ctl, ch)		(BIT(30) |			\
+						 (((fun) & 0x7) << 22) |	\
+						 (((ent) & 0x40) << 15) |	\
+						 (((ent) & 0x3f) << 7) |	\
+						 (((ctl) & 0x30) << 15) |	\
+						 (((ctl) & 0x0f) << 3) |	\
+						 (((ch) & 0x38) << 12) |	\
+						 ((ch) & 0x07))
+

how about adding an underscore to the arguments here:

Quoted 2 lines

#define SDW_SDCA_CTL(_fun, _ent, _ctl, _ch)
and so on..

I checked the SoundWire defines and the vast majority of the macros don't use underscores, and when they do there's no consistency between 1 or 2 underscores.

maintainer
#3 lore raw
Quoted 20 lines · Pierre-Louis Bossart
Quoted 5 lines
Quoted 3 lines

The upcoming SDCA (SoundWire Device Class Audio) specification defines a hiearchical encoding to interface with Class-defined capabilities,

typo hiearchical

ok

Quoted 6 lines
Quoted 1 line

based on which audio function, entity, control and channel being used.

Can you please elaborate on what do these terms refer to?

Also can we have some documentation for this and how Linux is going to use it..

These are concepts in the SDCA draft spec, and that should be the reference. We worked with MIPI so that this spec will be available with a click-through agreement when ratified, for now it's only available to contributors per MIPI bylaws.

Quoted 7 lines

If you do not have access to this specification, then that's a real problem. Maybe you need to let Bard take care of this part as a co-maintainer?

The goal with this macro is to enable a first set of codecs drivers using these concepts to be released upstream. All you need to know at this point is that controls are defined in a hierarchical way and accessed with a read/write transaction from/to the address created with the following macro.

Hmmm, if we cannot get some kind of Documentation of what it means and review the code, then I do not see a point in getting this into kernel.

As kernel community we would like to see some form of Documentation associated with the patches on what this means.

If that is not possible due to MIPI regulations, maybe deferring this would make sense

Thanks

Quoted 20 lines
Quoted 14 lines

include/linux/soundwire/sdw_registers.h line 317

Quoted 11 lines
include/linux/soundwire/sdw_registers.h +10 -0
+/* v1.2 device - SDCA address mapping */
+#define SDW_SDCA_CTL(fun, ent, ctl, ch)		(BIT(30) |			\
+						 (((fun) & 0x7) << 22) |	\
+						 (((ent) & 0x40) << 15) |	\
+						 (((ent) & 0x3f) << 7) |	\
+						 (((ctl) & 0x30) << 15) |	\
+						 (((ctl) & 0x0f) << 3) |	\
+						 (((ch) & 0x38) << 12) |	\
+						 ((ch) & 0x07))
+

how about adding an underscore to the arguments here:

Quoted 2 lines

#define SDW_SDCA_CTL(_fun, _ent, _ctl, _ch)
and so on..

I checked the SoundWire defines and the vast majority of the macros don't use underscores, and when they do there's no consistency between 1 or 2 underscores.

Signature · 1 line
~Vinod