From: Vinod Koul <vkoul@kernel.org>
To: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Cc: Bard Liao <yung-chuan.liao@linux.intel.com>,
alsa-devel@alsa-project.org, tiwai@suse.de,
gregkh@linuxfoundation.org, linux-kernel@vger.kernel.org,
ranjani.sridharan@linux.intel.com, hui.wang@canonical.com,
broonie@kernel.org, srinivas.kandagatla@linaro.org,
jank@cadence.com, mengdong.lin@intel.com,
slawomir.blauciak@intel.com, sanyog.r.kale@intel.com,
rander.wang@linux.intel.com, bard.liao@intel.com
Subject: Re: [PATCH 2/5] soundwire: stream: add helper to startup/shutdown streams
Date: Wed, 1 Jul 2020 11:09:10 +0530 [thread overview]
Message-ID: <20200701053910.GU2599@vkoul-mobl> (raw)
In-Reply-To: <5123471d-92f3-8f49-7a2c-d7b70bf442af@linux.intel.com>
On 30-06-20, 11:58, Pierre-Louis Bossart wrote:
> > > +int sdw_startup_stream(void *sdw_substream)
> >
> > Can we have kernel doc style Documentation for exported APIs?
>
> yes, that's a miss indeed.
>
> Though if we follow the existing examples it's not going to be very
> informative, e.g.
Yeah but...
>
> /**
> * sdw_disable_stream() - Disable SoundWire stream
> *
> * @stream: Soundwire stream
> *
> * Documentation/driver-api/soundwire/stream.rst explains this API in detail
it would help to have this pointer. I plan to include the kernel-doc
comments in Documentation for sdw so it would great to have these in
place
--
~Vinod
next prev parent reply other threads:[~2020-07-01 5:39 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-22 21:23 [PATCH 0/5] soundwire: handle stream at the dailink level Bard Liao
2020-06-22 21:23 ` [PATCH 1/5] soundwire: intel: implement get_sdw_stream() operations Bard Liao
2020-06-22 21:23 ` [PATCH 2/5] soundwire: stream: add helper to startup/shutdown streams Bard Liao
2020-06-30 16:03 ` Vinod Koul
2020-06-30 16:58 ` Pierre-Louis Bossart
2020-07-01 5:39 ` Vinod Koul [this message]
2020-06-22 21:23 ` [PATCH 3/5] soundwire: intel: remove stream allocation/free Bard Liao
2020-06-22 21:23 ` [PATCH 4/5] soundwire: cadence: allocate/free dma_data in set_sdw_stream Bard Liao
2020-06-22 21:23 ` [PATCH 5/5] soundwire: intel: don't free dma_data in DAI shutdown Bard Liao
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=20200701053910.GU2599@vkoul-mobl \
--to=vkoul@kernel.org \
--cc=alsa-devel@alsa-project.org \
--cc=bard.liao@intel.com \
--cc=broonie@kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=hui.wang@canonical.com \
--cc=jank@cadence.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mengdong.lin@intel.com \
--cc=pierre-louis.bossart@linux.intel.com \
--cc=rander.wang@linux.intel.com \
--cc=ranjani.sridharan@linux.intel.com \
--cc=sanyog.r.kale@intel.com \
--cc=slawomir.blauciak@intel.com \
--cc=srinivas.kandagatla@linaro.org \
--cc=tiwai@suse.de \
--cc=yung-chuan.liao@linux.intel.com \
/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
all inboxes | Powered by JetHome®