Re: [PATCH v4 1/9] Add documentation for Sahara protocol.
Jeff Hugo <[email protected]> Thu, 9 Apr 2026 13:47:06 -0600
| Newsgroups | dev.linux.lists.mhi,org.freedesktop.lists.dri-devel,org.kernel.vger.linux-arm-msm,org.kernel.vger.linux-doc,org.kernel.vger.linux-kernel |
|---|---|
| Message-ID | <[email protected]> |
$SUBJECT is not a complete sentence. You should drop the full stop ".". On 3/19/2026 12:31 AM, Kishore Batta wrote: > Introduce documentation for the Sahara protocol, describing its > operational modes and their respective functions. The image transfer mode > enables firmware transfer from host to device. The memory debug mode > allows extraction of device memory contents to host. The command mode > facilitates retrieval of DDR training data from the device and also > to restore the training data back to device in subsequent boot of device > to save boot time. Thank you for the documentation. > > Signed-off-by: Kishore Batta <[email protected]> > --- > Documentation/sahara/index.rst | 14 + > Documentation/sahara/sahara_protocol.rst | 1241 ++++++++++++++++++++++++++++++ I see from the cover letter that the sahara implementation is moving under MHI. I expect to have more about that move later in the series, but MHI already has a documentation directory. I don't see why Sahara should be at the top level if it is considered to be coupled to MHI. > 2 files changed, 1255 insertions(+) > > diff --git a/Documentation/sahara/index.rst b/Documentation/sahara/index.rst > new file mode 100644 > index 0000000000000000000000000000000000000000..073002c15a203344524e258b2aa0a6ce839e064b > --- /dev/null > +++ b/Documentation/sahara/index.rst > @@ -0,0 +1,14 @@ > +.. SPDX-License-Identifier: GPL-2.0-only > + > +======================== > +Qualcomm Sahara protocol > +======================== > + > +The Sahara protocol transfers data to and from memory and describes packet > +structures, packet flows, and their usage. > + > +.. toctree:: > + :maxdepth: 2 > + :caption: Contents > + > + sahara_protocol > diff --git a/Documentation/sahara/sahara_protocol.rst b/Documentation/sahara/sahara_protocol.rst > new file mode 100644 > index 0000000000000000000000000000000000000000..91204bb7d170be4fc4c85f142b8f0b93d3c421a0 > --- /dev/null > +++ b/Documentation/sahara/sahara_protocol.rst > @@ -0,0 +1,1241 @@ > +.. SPDX-License-Identifier: GPL-2.0-only > + > + > +============================= > +Sahara protocol Specification > +============================= > + > +The Qualcomm Sahara protocol driver is primarily designed for transferring > +software images from a host device to a target device using a simplified data > +transfer mechanism over a link. However, the sahara protocol does not support "Sahara" should be capital "S" everywhere in this patch.