From: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
To: "gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>,
"Sridharan, Ranjani" <ranjani.sridharan@intel.com>
Cc: "alsa-devel@alsa-project.org" <alsa-devel@alsa-project.org>,
"tiwai@suse.de" <tiwai@suse.de>,
"fred.oh@linux.intel.com" <fred.oh@linux.intel.com>,
"broonie@kernel.org" <broonie@kernel.org>,
"parav@nvidia.com" <parav@nvidia.com>,
"jgg@nvidia.com" <jgg@nvidia.com>,
"Ertman, David M" <david.m.ertman@intel.com>
Subject: Re: [PATCH 2/6] ASoC: SOF: Introduce descriptors for SOF client
Date: Mon, 5 Oct 2020 10:18:21 -0500 [thread overview]
Message-ID: <074b20bf-ecce-82a9-574a-758da31cef06@linux.intel.com> (raw)
In-Reply-To: <20201005112711.GB401816@kroah.com>
>>>>>>> As you are creating new sysfs directories, you should have
>>>>>>> some
>>>>>>> documentation for them :(
>>>>>> Hi Greg,
>>>>>>
>>>>>> We are not adding any sysfs entries in this series.
>>>>>
>>>>> You added directories in sysfs, right?
>>>> Hi Greg,
>>>>
>>>> We are not adding any sysfs directories.
>>>
>>> Really? Then what does creating these new devices do in sysfs? If
>>> nothing, then why are they being used at all? :)
>>>
>>>> The only change in the /sys directory will be the new ancillary
>>>> devices created in the /sys/bus/ancillary/devices directory ie
>>>> snd_sof_client.ipc_test.0 and snd_sof_client.ipc_test.1.
>>>
>>> That is what I was referring to.
>>>
>>>> In the following patches, we're adding debugfs entries for the ipc
>>>> test clients but no other sysfs changes.
>>>>
>>>> Is it required to add documentation for these as well?
>>>
>>> Why would you not document them? If you don't do anything with these
>>> devices, then why even use them? debugfs does not require sysfs
>>> entries, so I fail to see the need for using this api at all here...
>> Hi Greg,
>>
>> Pardon my ignorance here a bit. Typically, when registering platform
>> devices, we've not added any documentation to highlight how they are
>> used. Of course thats no excuse for not doing this right.
>>
>> But just to clarify so that we can fix this properly in the next
>> version, are we expected to add documentation for the directories added
>> in the /sys/bus (ie /sys/bus/ancillary, /sys/bus/ancillary/devices,
>> /sys/bus/ancillary/drivers etc) and also for the devices and drivers
>> added by the SOF driver?
>
> You are using a brand-new interface, which is designed to represent
> things in the driver model and sysfs properly, and yet your usage
> doesn't actually take advantage of the driver model or sysfs at all?
>
> That implies to me that you are using this incorrectly.
We are taking advantage of 'standard' sysfs capabilities, e.g. we get a
power/ directory and can disable pm_runtime if we chose to do so.
But the point is that for now we haven't added domain specific
properties with attributes.
For example, I noodled with this code last week to replace the platform
devices with ancillary devices in the Intel SoundWire code, and I get
this in sysfs:
root@plb:/sys/bus/ancillary/devices/soundwire_intel.link.0# ls -l
total 0
lrwxrwxrwx 1 root root 0 Oct 2 15:48 driver ->
../../../../bus/ancillary/drivers/intel-sdw
lrwxrwxrwx 1 root root 0 Oct 5 10:12 firmware_node ->
../../../LNXSYSTM:00/LNXSYBUS:00/PNP0A08:00/device:63/PRP00001:00
drwxr-xr-x 2 root root 0 Oct 5 10:12 power
drwxr-xr-x 5 root root 0 Oct 2 15:48 sdw-master-0
lrwxrwxrwx 1 root root 0 Oct 2 15:48 subsystem ->
../../../../bus/ancillary
-rw-r--r-- 1 root root 4096 Oct 2 15:48 uevent
What would you want us to document here?
next prev parent reply other threads:[~2020-10-05 15:25 UTC|newest]
Thread overview: 99+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-30 22:50 [PATCH 0/6] Ancillary bus implementation and SOF multi-client support Dave Ertman
2020-09-30 22:50 ` [PATCH 1/6] Add ancillary bus support Dave Ertman
2020-09-30 23:05 ` Jason Gunthorpe
2020-10-01 11:01 ` Greg KH
2020-10-01 11:46 ` Jason Gunthorpe
2020-10-01 11:54 ` Greg KH
2020-10-01 12:02 ` Jason Gunthorpe
2020-10-01 12:15 ` Greg KH
2020-10-01 18:26 ` Ertman, David M
2020-10-01 11:02 ` Greg KH
2020-10-01 16:30 ` Ertman, David M
2020-10-01 11:05 ` Greg KH
2020-10-01 11:58 ` Jason Gunthorpe
2020-10-01 12:14 ` Greg KH
2020-10-01 14:33 ` Jason Gunthorpe
2020-10-01 14:38 ` Greg KH
2020-10-01 16:06 ` Pierre-Louis Bossart
2020-10-01 17:42 ` Jason Gunthorpe
2020-10-01 14:39 ` Parav Pandit
2020-10-01 14:43 ` Greg KH
2020-10-01 13:27 ` Mark Brown
2020-09-30 22:50 ` [PATCH 2/6] ASoC: SOF: Introduce descriptors for SOF client Dave Ertman
2020-10-01 13:02 ` Greg KH
2020-10-01 15:59 ` Sridharan, Ranjani
2020-10-01 22:16 ` Sridharan, Ranjani
2020-10-02 4:53 ` gregkh
2020-10-02 17:07 ` Sridharan, Ranjani
2020-10-03 9:02 ` gregkh
2020-10-05 2:35 ` Sridharan, Ranjani
2020-10-05 11:27 ` gregkh
2020-10-05 15:18 ` Pierre-Louis Bossart [this message]
2020-10-05 15:32 ` gregkh
2020-10-01 13:38 ` Mark Brown
2020-10-01 16:48 ` Sridharan, Ranjani
2020-09-30 22:50 ` [PATCH 3/6] ASoC: SOF: Create client driver for IPC test Dave Ertman
2020-10-01 13:04 ` Greg KH
2020-10-01 16:46 ` Sridharan, Ranjani
2020-10-01 13:09 ` Greg KH
2020-10-01 13:55 ` Pierre-Louis Bossart
2020-10-01 16:48 ` Ertman, David M
2020-10-01 13:59 ` Mark Brown
2020-09-30 22:50 ` [PATCH 4/6] ASoC: SOF: ops: Add ops for client registration Dave Ertman
2020-09-30 22:50 ` [PATCH 5/6] ASoC: SOF: Intel: Define " Dave Ertman
2020-09-30 22:50 ` [PATCH 6/6] ASoC: SOF: debug: Remove IPC flood test support in SOF core Dave Ertman
2020-10-01 5:58 ` [PATCH 0/6] Ancillary bus implementation and SOF multi-client support Greg KH
2020-10-01 15:54 ` Ertman, David M
2020-10-01 7:14 ` Greg KH
2020-10-01 15:55 ` Ertman, David M
2020-10-01 16:10 ` Greg KH
2020-10-01 17:13 ` Ertman, David M
2020-10-02 20:23 ` Ertman, David M
2020-10-03 9:08 ` Greg KH
2020-10-03 9:09 ` Greg KH
2020-10-04 2:26 ` Parav Pandit
2020-10-04 23:45 ` Williams, Dan J
2020-10-05 1:18 ` Ertman, David M
2020-10-05 2:39 ` Parav Pandit
2020-10-05 11:25 ` gregkh
2020-10-06 22:40 ` Dan Williams
2020-10-07 9:14 ` gregkh
2020-10-07 16:19 ` Dan Williams
2020-10-07 16:22 ` Mark Brown
2020-10-07 16:41 ` Dan Williams
2020-10-07 16:42 ` Pierre-Louis Bossart
2020-10-07 16:56 ` Parav Pandit
2020-10-01 10:05 ` Rojewski, Cezary
2020-10-01 10:59 ` gregkh
2020-10-01 12:49 ` Jason Gunthorpe
2020-10-01 12:55 ` gregkh
2020-10-01 13:26 ` Jason Gunthorpe
2020-10-01 14:17 ` gregkh
2020-10-01 15:08 ` Parav Pandit
2020-10-01 12:50 ` Mark Brown
2020-10-01 13:12 ` Greg KH
2020-10-01 13:42 ` Jason Gunthorpe
2020-10-01 14:40 ` Mark Brown
2020-10-01 15:32 ` Greg KH
2020-10-01 16:03 ` Mark Brown
2020-10-01 18:16 ` Greg KH
2020-10-01 18:29 ` Ertman, David M
2020-10-01 19:38 ` Mark Brown
2020-10-01 19:54 ` Ertman, David M
2020-10-01 20:17 ` Mark Brown
2020-10-02 0:47 ` Jason Gunthorpe
2020-10-02 11:19 ` Mark Brown
2020-10-02 17:23 ` Ertman, David M
2020-10-02 17:25 ` Jason Gunthorpe
2020-10-02 17:44 ` Mark Brown
2020-10-01 14:07 ` Pierre-Louis Bossart
2020-10-01 15:24 ` Mark Brown
2020-10-01 16:20 ` Pierre-Louis Bossart
2020-10-01 16:51 ` Mark Brown
2020-10-01 18:04 ` Jason Gunthorpe
2020-10-01 18:13 ` Greg KH
2020-10-01 19:23 ` Mark Brown
2020-10-01 16:50 ` Ertman, David M
2020-10-01 17:10 ` Mark Brown
2020-10-01 17:16 ` Ertman, David M
2020-10-01 17:52 ` Ertman, David M
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=074b20bf-ecce-82a9-574a-758da31cef06@linux.intel.com \
--to=pierre-louis.bossart@linux.intel.com \
--cc=alsa-devel@alsa-project.org \
--cc=broonie@kernel.org \
--cc=david.m.ertman@intel.com \
--cc=fred.oh@linux.intel.com \
--cc=gregkh@linuxfoundation.org \
--cc=jgg@nvidia.com \
--cc=parav@nvidia.com \
--cc=ranjani.sridharan@intel.com \
--cc=tiwai@suse.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).