linux-toradex.git/Documentation/driver-api/soundwire, branch v5.7-rc6

soundwire: stream: update state machine and add state checks

2020-02-13T10:27:37+00:00

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 
Link: https://lore.kernel.org/r/20200114235227.14502-2-pierre-louis.bossart@linux.intel.com
Signed-off-by: Vinod Koul

docs: index.rst: don't use genindex for pdf output

2019-07-31T19:31:16+00:00

The genindex logic is meant to be used only for html output, as
pdf build has its own way to generate indexes.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Vinod Koul  # dmaengine and soundwire
Signed-off-by: Jonathan Corbet

docs: soundwire: locking: fix tags for a code-block

2019-06-04T15:18:45+00:00

There's an ascii artwork at Example 1 whose code-block is not properly
idented, causing those warnings.

    Documentation/driver-api/soundwire/locking.rst:50: WARNING: Inconsistent literal block quoting.
    Documentation/driver-api/soundwire/locking.rst:51: WARNING: Line block ends without a blank line.
    Documentation/driver-api/soundwire/locking.rst:55: WARNING: Inline substitution_reference start-string without end-string.
    Documentation/driver-api/soundwire/locking.rst:56: WARNING: Line block ends without a blank line.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Pierre-Louis Bossart 
Signed-off-by: Vinod Koul

Documentation: soundwire: Ensure that code is inside the code blocks

2019-04-02T13:59:56+00:00

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 
Signed-off-by: Jonathan Corbet

Documentation: soundwire: fix stream.rst markup warnings

2018-09-17T16:12:36+00:00

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: 89634f99a83e ("Documentation: soundwire: Add more documentation")

Signed-off-by: Randy Dunlap 
Reviewed-by: Takashi Sakamoto 
Tested-by: Takashi Sakamoto 
Signed-off-by: Vinod Koul

Documentation: soundwire: Add documentation for multi link

2018-08-27T04:19:48+00:00

Add example and documentation to describe multi link streams

Signed-off-by: Pierre-Louis Bossart 
Signed-off-by: Sanyog Kale 
Signed-off-by: Shreyas NC 
Acked-by: Pierre-Louis Bossart 
Signed-off-by: Vinod Koul

Documentation: soundwire: Add more documentation

2018-05-11T16:17:02+00:00

This adds documentation for error handling, locking and streams.

Signed-off-by: Pierre-Louis Bossart 
Signed-off-by: Sanyog Kale 
Signed-off-by: Shreyas NC 
Signed-off-by: Vinod Koul

Documentation: Add SoundWire summary

2017-12-19T10:14:30+00:00

SoundWire is a new Linux bus which implements a new MIPI bus protocol
'SoundWire'. The summary of SoundWire bus and API is documented in the
'summary' file.

Signed-off-by: Sanyog Kale 
Signed-off-by: Hardik T Shah 
Reviewed-by: Philippe Ombredanne 
Acked-By: Pierre-Louis Bossart 
Reviewed-by: Takashi Iwai 
Signed-off-by: Vinod Koul 
Signed-off-by: Greg Kroah-Hartman