From a1c0015c40da55a0c9bd35a7ca44d1114956e5d5 Mon Sep 17 00:00:00 2001 From: Bard Liao Date: Thu, 27 Feb 2025 22:11:20 +0800 Subject: [PATCH] fixup! Documentation: driver: add SoundWire BRA description Revise bra.rst as suggested. Signed-off-by: Bard Liao --- Documentation/driver-api/soundwire/bra.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/driver-api/soundwire/bra.rst b/Documentation/driver-api/soundwire/bra.rst index 2f3521daf508a8..8500253fa3e8ca 100644 --- a/Documentation/driver-api/soundwire/bra.rst +++ b/Documentation/driver-api/soundwire/bra.rst @@ -89,12 +89,12 @@ transmission or programming errors, each BRA packet provides: transmitted as the last-but-one byte in the packet, prior to the footer response. -The header response can be one of +The header response can be one of: (a) Ack (b) Nak (c) Not Ready -The footer response can be one of +The footer response can be one of: (1) Ack (2) Nak (CRC failure) (3) Good (operation completed) @@ -112,7 +112,7 @@ to start on a new SoundWire Row, and the scale of data may vary. +---+--------------------------------------------+ + | | + | BRA HEADER | - + | | + + | | + +--------------------------------------------+ + C | HEADER CRC | + O +--------------------------------------------+ @@ -184,7 +184,7 @@ consumed/produced by these FIFOs is not symmetrical, as a result hardware typically inserts markers to help software and hardware interpret raw data -Each packet will typically have +Each packet will typically have: (1) a 'Start of Packet' indicator. @@ -240,15 +240,15 @@ One possible strategy to speed-up all initialization tasks would be to start a BRA transfer for firmware download, then deal with all the "regular" read/writes in parallel with the command channel, and last to wait for the BRA transfers to complete. This would allow for a -degree of overlap instead of a purely sequential solution. As a -results, the BRA API must support async transfers and expose a -separate wait function. +degree of overlap instead of a purely sequential solution. As such, +the BRA API must support async transfers and expose a separate wait +function. Peripheral/bus interface ------------------------ -The bus interface for BPT/BRA is made of two functions +The bus interface for BPT/BRA is made of two functions: - sdw_bpt_send_async(bpt_message)