[alsa-devel] [PATCH v5 09/17] soundwire: intel: remove platform devices and use 'Master Devices' instead

[Pierre-Louis Bossart]

Hi Vinod,

>>> If I look at the calling sequence of the code (looked up the sof code on
>>> github, topic/sof-dev-rebase), the sof code sound/soc/sof/intel/hda.c
>>> invokes the sdw_intel_startup() and sdw_intel_probe() based on hardware
>>> sequencing and further you call .init and .probe/startup of sdw_md_driver.
>>>
>>> I really do not see why we need a sdw_md_driver object to do that. You can
>>> easily have a another function exported by sdw_intel driver and you call
>>> these and do same functionality without having a sdw_md_driver in
>>> between.
>>
>> I must admit I am beyond my comfort zone: I introduced this
>> sdw_master_driver only based on Greg's recommendation to look at GreyBus.
> 
> Well the recommendation was to add a device, so adding sdw_master_device
> was the right approach. But we don't need to add driver as well.

I provided two reasons below why we need one
[1] ASoC use of dev->driver
[2] PM hooks.

I would kindly ask that you re-check these points and reply on each, 
thank you. I did not remove them from my reply so that you don't have to 
go back to the previous emails.

>> That said, I have two key points that I should explain further.
>>
>> When we started this work, we initially did not have a notion of 'master
>> driver' coupled with the 'master_device'. But we faced a number of issues
>> with ASoC registrations, which seemed to required a driver to be registered
>> and associated with the device. We kept this part as a separate commit to
>> make sure this requirement wasn't lost:
> 
> Yes ASoC does require the DAI driver as it holds a reference to it. That
> was the reason we have a platform device and a platform driver for
> "int-sdw".

no, it's not related to references, it's using the name, see [1]. And 
it's not related to the 'dai driver' which is a separate entity 
unrelated to devices.

> Would it make sense to keep this as is and then export the init and
> startup APIs which can be invoked by SOF part for hardware
> initialization. So driver loading is a separate step from hardware
> initialization and sequencing.
> 
> Also you continue with the benefit of parent-child relations for this
> device :) and pm should be simpler.

the parent-child relationship was used in all cases, I don't understand 
why things would be different, you still need to add hooks in the 
'driver' for the pm of the 'master' child device, be it a platform 
device or not.

> Btw this helps if ever in future you have a separate instance of sdw
> controller that can be just hooked to acpi/pci/whatever device part and
> driver works without big plumbing
> 
>> https://github.com/thesofproject/linux/commit/28b934ce9c165e095dac5cf71da5685768831337
>>

[1]

>> Looking back at my notes, this came from this piece of code:
>>
>> static char *fmt_single_name(struct device *dev, int *id)
>> {
>> 	char *found, name[NAME_SIZE];
>> 	int id1, id2;
>>
>> 	if (dev_name(dev) == NULL)
>> 		return NULL;
>>
>> 	strlcpy(name, dev_name(dev), NAME_SIZE);
>>
>> 	/* are we a "%s.%d" name (platform and SPI components) */
>> 	found = strstr(name, dev->driver->name); <<< oops
>>
>> so for ASoC, there is an expectation that each device does have a driver
>> associated with it. Just for fun I reverted the commit above and that
>> immediately trigger an kernel oops.

[2]

>> The other point that we came across is that PM support is only enabled
>> thanks to a hook in the driver structure:
>>
>> static const struct dev_pm_ops intel_pm = {
>> 	SET_SYSTEM_SLEEP_PM_OPS(intel_suspend, intel_resume)
>> 	SET_RUNTIME_PM_OPS(intel_suspend_runtime, intel_resume_runtime, NULL)
>> };
>>
>> struct sdw_master_driver intel_sdw_driver = {
>> 	.driver = {
>> 		.name = "intel-sdw",
>> 		.owner = THIS_MODULE,
>> 		.bus = &sdw_bus_type,
>> 		.pm = &intel_pm, <<<<
>> 	},
>> 	.probe = intel_master_probe,
>> 	.startup = intel_master_startup,
>> 	.process_wake_event = intel_master_process_wakeen_event,
>> 	.remove = intel_master_remove,
>> };
>>
>> I am not aware of any other way to do this.

I suggested a minimal way of using the 'device_driver' directly in 
https://github.com/thesofproject/linux/pull/1755

>>> So to summarize, my recommendation would be to drop sdw_md_driver, keep
>>> sdw_master_device object and make sdw_master_device_add() hidden to
>>> driver and call it from sdw_add_bus_master() and keep intel specific
>>> startup/init routine which do same steps as they have now.
>>
>> I am afraid the sequence you suggest is not technically possible:
>> sdw_add_bus_master() requires a device to be created already, see e.g. how
>> it's used by Qualcomm:
>>
>> https://github.com/thesofproject/linux/blob/4026efd12ac983d363fb43c37a8af741a2c90dc8/drivers/soundwire/qcom.c#L811
>>
>> sdw_add_bus_master() is called from the platform device probe.
>> I cannot insert a device creation in this code.
> 
> So there are two things, lets discuss them independently. One is the
> device behind the controller object. I think I have given a
> recommendation above to keep the existing platform device for "int-sdw".
> This device can be PCI/ACPI/OF/Platform, we typically should not worry
> about it.

I don't understand how a platform device can be PCI/ACPI/OF? what did 
you mean here?

> Second is we create the bus instance and that also create the
> sdw_master_device to represent the soundwire master device in sysfs,
> since this would be done by soundwire core (as I suggested), it would be
> independent of which type of driver is invoking this. In fact this needs
> to be completely independent of the driver calling this.
> 
> Intel code will call sdw_add_bus_master() and we would create a
> sdw_master_device for it and add the representation. So would the qcom
> code (btw with this, we wont need to do anything on qc code and it
> 'should just work (tm)'.
> 
>> It'd actually be counter productive to add device management at the bus
>> level, since we'd soon have incompatibilities between Intel, Qualcomm and
>> others. What is platform-specific should be handled outside of the bus
>> layer.
> 
> The vision I am thinking is that sdw_master_device is a representation
> of master for everyone independent of the platform it is being used.
> 
> Let me know if this helps

Sorry no, your reply just confused me completely.

The recommendation from Greg was "remove platform devices". Here's the 
quote from his May 9, 2019 reply:

"So soundwire is creating platform devices?  Ick, no!  Don't do that,
create a "real" device that is the root of your bus and attach that to
the platform/pci/whatever device that is the parent of that device's
resources."

If your suggestion is to keep platform devices as currently done, then I 
will kindly ask that you speak with Greg and let me know what the 
agreement is.

The second part of your reply gets more confusing, you are suggesting 
that "Intel code will call sdw_add_bus_master() and we would create a 
sdw_master_device for it and add the representation". That is in direct 
contradiction with the notion of using platform devices. And it would by 
construction break the Qualcomm controller code just merged weeks ago. 
Are you suggesting I start changing Qualcomm code? Or that we add a new 
function that does device creation+bus addition in one shot?

And last you didn't acknowledge my two technical points as to why a 
driver is needed for this sdw_master_device.

So I am back to scratching my head on what the direction is? I just do 
not understand your line of thought.

Maybe we need to stop the long sentences and use this decision flow:

a) is the master device a platform device (Yes/No)?
b) if No for a) then
b.1) is the master device created within sdw_add_bus_master()
b.2) is the master device created before calling sdw_add_bus_master()

Can you please clarify what your desired choices are on this last paragraph?

Thanks
-Pierre