aboutsummaryrefslogtreecommitdiff
path: root/Documentation/driver-api/soundwire
AgeCommit message (Collapse)AuthorFilesLines
2024-01-22soundwire: stream: add missing const to DocumentationKrzysztof Kozlowski1-2/+2
Commit 21f4c443731f ("soundwire: stream: constify sdw_port_config when adding devices") added const to sdw_port_config argument, but forgot documentation. Fixes: 21f4c443731f ("soundwire: stream: constify sdw_port_config when adding devices") Signed-off-by: Krzysztof Kozlowski <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
2020-09-10docs: soundwire: fix some identation at stream.rstMauro Carvalho Chehab1-4/+4
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 <[email protected]> Link: https://lore.kernel.org/r/eddde9f8d121e27d7968b3d747064e16de8bec4f.1599660067.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <[email protected]>
2020-07-15soundwire: stream: add helper to startup/shutdown streamsPierre-Louis Bossart1-1/+10
To handle streams at the dailink level, expose two helpers that will be called from machine drivers. Reviewed-by: Ranjani Sridharan <[email protected]> Reviewed-by: Guennadi Liakhovetski <[email protected]> Reviewed-by: Kai Vehmanen <[email protected]> Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
2020-05-19soundwire: bus: rename sdw_bus_master_add/delete, add argumentsPierre-Louis Bossart1-3/+4
In preparation for future extensions, rename functions to use sdw_bus_master prefix and add a parent and fwnode argument to sdw_bus_master_add to help with device registration in follow-up patches. No functionality change, just renames and additional arguments. The Intel code is currently unused, the two additional arguments are only needed for compilation. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Bard Liao <[email protected]> Acked-by: Jaroslav Kysela <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
2020-05-05Documentation: SoundWire: clarify TDM mode supportPierre-Louis Bossart1-3/+86
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 <[email protected]> Signed-off-by: Bard Liao <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
2020-02-13soundwire: stream: update state machine and add state checksPierre-Louis Bossart1-17/+44
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 <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Vinod Koul <[email protected]>
2019-07-31docs: index.rst: don't use genindex for pdf outputMauro Carvalho Chehab1-1/+1
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 <[email protected]> Acked-by: Vinod Koul <[email protected]> # dmaengine and soundwire Signed-off-by: Jonathan Corbet <[email protected]>
2019-06-04docs: soundwire: locking: fix tags for a code-blockMauro Carvalho Chehab1-1/+3
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 <[email protected]> Acked-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Vinod Koul <[email protected]>
2019-04-02Documentation: soundwire: Ensure that code is inside the code blocksJonathan Neuschäfer1-8/+8
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 <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-09-17Documentation: soundwire: fix stream.rst markup warningsRandy Dunlap1-0/+8
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 <[email protected]> Reviewed-by: Takashi Sakamoto <[email protected]> Tested-by: Takashi Sakamoto <[email protected]> Signed-off-by: Vinod Koul <[email protected]>
2018-08-27Documentation: soundwire: Add documentation for multi linkSanyog Kale1-0/+28
Add example and documentation to describe multi link streams Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Sanyog Kale <[email protected]> Signed-off-by: Shreyas NC <[email protected]> Acked-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Vinod Koul <[email protected]>
2018-05-11Documentation: soundwire: Add more documentationSanyog Kale4-0/+546
This adds documentation for error handling, locking and streams. Signed-off-by: Pierre-Louis Bossart <[email protected]> Signed-off-by: Sanyog Kale <[email protected]> Signed-off-by: Shreyas NC <[email protected]> Signed-off-by: Vinod Koul <[email protected]>
2017-12-19Documentation: Add SoundWire summarySanyog Kale2-0/+222
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 <[email protected]> Signed-off-by: Hardik T Shah <[email protected]> Reviewed-by: Philippe Ombredanne <[email protected]> Acked-By: Pierre-Louis Bossart <[email protected]> Reviewed-by: Takashi Iwai <[email protected]> Signed-off-by: Vinod Koul <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.