Mauro Carvalho Chehab
001e92922c
docs: soundwire: fix some identation at stream.rst
...
Currently, sphinx emits one warning on this file:
Documentation/driver-api/soundwire/stream.rst:522: WARNING: Block quote ends without a blank line; unexpected unindent.
That's due to some extra spaces before the title of a chapter.
Yet, the list afterwards is missing identation.
So, address both issues.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org >
Link: https://lore.kernel.org/r/eddde9f8d121e27d7968b3d747064e16de8bec4f.1599660067.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2020-09-10 10:49:29 -06:00
Pierre-Louis Bossart
4550569bd7
soundwire: stream: add helper to startup/shutdown streams
...
To handle streams at the dailink level, expose two helpers that will
be called from machine drivers.
Reviewed-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com >
Reviewed-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com >
Reviewed-by: Kai Vehmanen <kai.vehmanen@linux.intel.com >
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com >
Link: https://lore.kernel.org/r/20200630184356.24939-3-yung-chuan.liao@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2020-07-15 10:10:05 +05:30
Pierre-Louis Bossart
01de995075
Documentation: SoundWire: clarify TDM mode support
...
The current description of stream topologies does not explicitly
mention 'mirror' topologies used for audio amplifiers, where all
amplifiers see the same data and generate a different output based on
configuration or dynamic information. Add examples and notes to
explain how channels can be transmitted and mapped.
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com >
Link: https://lore.kernel.org/r/20200419185117.4233-1-yung-chuan.liao@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2020-05-05 08:51:44 +05:30
Pierre-Louis Bossart
5952880771
soundwire: stream: update state machine and add state checks
...
The state machine and notes don't accurately explain or allow
transitions from STREAM_DEPREPARED and STREAM_DISABLED.
Add more explanations and allow for more transitions as a result of a
trigger_stop(), trigger_suspend() and prepare(), depending on the
ALSA/ASoC layer behavior defined by the INFO_RESUME and INFO_PAUSE
flags.
Also add basic checks to help debug inconsistent states and illegal
state machine transitions.
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Link: https://lore.kernel.org/r/20200114235227.14502-2-pierre-louis.bossart@linux.intel.com
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2020-02-13 15:57:37 +05:30
Jonathan Neuschäfer
491a3e883c
Documentation: soundwire: Ensure that code is inside the code blocks
...
The way the document is written now, Sphinx renders empty code blocks
followed by the lines that should be inside them.
Unindent the code-block directives to fix this.
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net >
Signed-off-by: Jonathan Corbet <corbet@lwn.net >
2019-04-02 07:59:56 -06:00
Randy Dunlap
502c00d9c3
Documentation: soundwire: fix stream.rst markup warnings
...
Fix kernel-doc markup warnings in soundwire/stream.rst:
rc4/Documentation/driver-api/soundwire/stream.rst:177: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:203: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:248: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:277: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:304: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:328: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:352: WARNING: Explicit markup ends without a blank line; unexpected unindent.
rc4/Documentation/driver-api/soundwire/stream.rst:364: WARNING: Explicit markup ends without a blank line; unexpected unindent.
Fixes: 89634f99a8rdunlap@infradead.org >
Reviewed-by: Takashi Sakamoto <o-takashi@sakamocchi.jp >
Tested-by: Takashi Sakamoto <o-takashi@sakamocchi.jp >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2018-09-17 09:12:36 -07:00
Sanyog Kale
8cf3f9cfd9
Documentation: soundwire: Add documentation for multi link
...
Add example and documentation to describe multi link streams
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Sanyog Kale <sanyog.r.kale@intel.com >
Signed-off-by: Shreyas NC <shreyas.nc@intel.com >
Acked-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2018-08-27 09:49:48 +05:30
Sanyog Kale
89634f99a8
Documentation: soundwire: Add more documentation
...
This adds documentation for error handling, locking and streams.
Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com >
Signed-off-by: Sanyog Kale <sanyog.r.kale@intel.com >
Signed-off-by: Shreyas NC <shreyas.nc@intel.com >
Signed-off-by: Vinod Koul <vkoul@kernel.org >
2018-05-11 21:47:02 +05:30
