thesofproject
SoundWire: use inclusive terms
The updated SoundWire specification will be published shortly. The only change is a use of 'inclusive terms'
- Slave->Peripheral
- Master->Manager
Some will note that the change does not preserve the M/S initials - that's known but the MIPI team was unable to find a better set of words.
We do want to remain aligned with the spec so need a massive rename across soundwire/regmap/asoc domains.
I would like to submit this in the 5.14 review cycle, meaning we have about 2 weeks to complete the reviews on GitHub. To avoid making things more complicated than they need to be I just reverted 2 commits related to ASoC codecs that are not upstream. I'll have to rebase this branch if/when they are updated by Realtek/Maxim.
@vinodkoul FYI
what's the usual / best process with such scripted changes? Do we just trust that the change is automated and as such must be correct? Isn't it usual to reference the script / command lines that were used for such changes? Reviewers could then at least check the script.
it's not fully scripted. I used a standard s/slave/peripheral/g and s/master/manager/g but also checked the results. E.g. there are existing firmware properties such as 'master-count' that we cannot rename since that would break the solution. Likewise some 's_rt' variables were renamed as 'peri_rt' to have a better mapping between variable names and types. There are also indentation changes needed when the name of variable changes.
@plbossart Do we need to change the terms of device property, too? For example, "mipi-sdw-master-count", "mipi-sdw-slave-channelprepare-timeout"?
@plbossart Do we need to change the terms of device property, too? For example, "mipi-sdw-master-count", "mipi-sdw-slave-channelprepare-timeout"?
No, this has to stay for backwards-compatibility. There is a suggested rename in MIPI circles but we have to keep supporting older specs.
I think term revision PR should be merged asap, or the author will need to rebase again and again..., which is time consuming.
I think term revision PR should be merged asap, or the author will need to rebase again and again..., which is time consuming.
I know, but we always have a good reason to push this out. This time it's the revision of registers and the split between shim and device in PR #3811
how about sound/soc/intel/boards/sdw ? I can't find it in PR since many changes
The last update was a year ago. It pains me to write this but I don't have the time to update this PR and with all the recent SoundWire changes it's become really difficult to make this inclusive terminology change at the 'right' time.
I'll close this for now, we can only restart later but it's a shame we couldn't get this done earlier. FYI @bardliao @lgirdwood