Re: [PATCH 2/6] ASoC: SOF: Introduce descriptors for SOF client

From: "Sridharan, Ranjani" <ranjani.sridharan@intel.com>
To: "gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>
Cc: "alsa-devel@alsa-project.org" <alsa-devel@alsa-project.org>,
	"tiwai@suse.de" <tiwai@suse.de>,
	"pierre-louis.bossart@linux.intel.com"
	<pierre-louis.bossart@linux.intel.com>,
	"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: Fri, 2 Oct 2020 17:07:13 +0000	[thread overview]
Message-ID: <ad38db14921dc5afb424db1ecac53053f15bb753.camel@intel.com> (raw)
In-Reply-To: <20201002045357.GA34005@kroah.com>

On Fri, 2020-10-02 at 06:53 +0200, gregkh@linuxfoundation.org wrote:
> On Thu, Oct 01, 2020 at 10:16:00PM +0000, Sridharan, Ranjani wrote:
> > On Thu, 2020-10-01 at 15:02 +0200, Greg KH wrote:
> > > On Wed, Sep 30, 2020 at 03:50:47PM -0700, Dave Ertman wrote:
> > > > From: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
> > > > 
> > > > A client in the SOF (Sound Open Firmware) context is a
> > > > device that needs to communicate with the DSP via IPC
> > > > messages. The SOF core is responsible for serializing the
> > > > IPC messages to the DSP from the different clients. One
> > > > example of an SOF client would be an IPC test client that
> > > > floods the DSP with test IPC messages to validate if the
> > > > serialization works as expected. Multi-client support will
> > > > also add the ability to split the existing audio cards
> > > > into multiple ones, so as to e.g. to deal with HDMI with a
> > > > dedicated client instead of adding HDMI to all cards.
> > > > 
> > > > This patch introduces descriptors for SOF client driver
> > > > and SOF client device along with APIs for registering
> > > > and unregistering a SOF client driver, sending IPCs from
> > > > a client device and accessing the SOF core debugfs root entry.
> > > > 
> > > > Along with this, add a couple of new members to struct
> > > > snd_sof_dev that will be used for maintaining the list of
> > > > clients.
> > > > 
> > > > Reviewed-by: Pierre-Louis Bossart <
> > > > pierre-louis.bossart@linux.intel.com>
> > > > Signed-off-by: Ranjani Sridharan <
> > > > ranjani.sridharan@linux.intel.com
> > > > Co-developed-by: Fred Oh <fred.oh@linux.intel.com>
> > > > Signed-off-by: Fred Oh <fred.oh@linux.intel.com>
> > > > Signed-off-by: Dave Ertman <david.m.ertman@intel.com>
> > > > ---
> > > >  sound/soc/sof/Kconfig      |  19 ++++++
> > > >  sound/soc/sof/Makefile     |   3 +
> > > >  sound/soc/sof/core.c       |   2 +
> > > >  sound/soc/sof/sof-client.c | 117
> > > > +++++++++++++++++++++++++++++++++++++
> > > >  sound/soc/sof/sof-client.h |  65 +++++++++++++++++++++
> > > >  sound/soc/sof/sof-priv.h   |   6 ++
> > > >  6 files changed, 212 insertions(+)
> > > >  create mode 100644 sound/soc/sof/sof-client.c
> > > >  create mode 100644 sound/soc/sof/sof-client.h
> > > 
> > > 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. 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. 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?

Thanks,
Ranjani