Re: [PATCH v9 1/7] Add documentation for Sahara protocol

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [Low] doc: typographical errors in Sahara protocol documentation
--

commit 8d07d5d5d03da68e6f60aacfd0b9952197576e1b
Author: Kishore Batta <kishore.batta@oss.qualcomm.com>

Add documentation for Sahara protocol

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.

> diff --git a/Documentation/mhi/sahara_protocol.rst b/Documentation/mhi/sahara_protocol.rst
> new file mode 100644
> index 0000000000000..3190e3e5a2820
> --- /dev/null
> +++ b/Documentation/mhi/sahara_protocol.rst

[ ... ]

> +|   0x13  | Reset Sahara  |  Host   | Resets Sahara state machine and enters  |
> +|         | sate machine  |         | Sahara entry without target reset       |
> +|         | packet        |         |                                         |

[Severity: Low]
Does this code contain a typo? It looks like "sate machine" should be
"state machine".

[ ... ]

> ++-----------------------------+---------+------------------------------------+
> +|  SAHARA_MODE_MEMORY_DBEUG   |  0x2    | Memory debug mode. The host should |
> +|                             |         | prepare to receive a memory dump   |

[Severity: Low]
Does this code contain a typo? It looks like "SAHARA_MODE_MEMORY_DBEUG" should
be "SAHARA_MODE_MEMORY_DEBUG".

[ ... ]

> +host opens an output file and waits to receive the data packets. After the
> +packet is received, the content from the data pcket is written to the output
> +file, The format of the write data packet is as follows:

[Severity: Low]
Does this code contain typos? It looks like "pcket" should be "packet", and
the comma after "output file" should be a period.

[ ... ]

> +6. The target directly transfers the data to the destination address without
> +   any software processing or temporarily buffering of the data in system
> +   memory by transferring the image header to the targert and setting the
> +   receive buffer for the data as the destination address in system memory.

[Severity: Low]
Does this code contain a typo? It looks like "targert" should be "target".

[ ... ]

> +8. The host sends a done packet to allow the target to exit the protocol after
> +   it receives a successgul end of image transfer packet.

[Severity: Low]
Does this code contain a typo? It looks like "successgul" should be
"successful".

[ ... ]

> +                          |         MEMORY_READ       |
> +                          |   (Address from region 1 ,|
> +                          |    size of region 1)      |
> +                          |-------------------------->|
> +                          |         RAW_DATA          |
> +                          |     (size of region 1)    |
> +                          |<--------------------------|
> +                          |         MEMORY_READ       |
> +                          |   (Address from region 2 ,|
> +                          |    size of region 0)      |
> +                          |-------------------------->|
> +                          |         RAW_DATA          |
> +                          |     (size of region 2)    |
> +                          |<--------------------------|

[Severity: Low]
Does this diagram contain a copy-paste error? For region 2, the memory read
packet requests "size of region 0" instead of "size of region 2".

[ ... ]

> +Subsequent boot scenario with valid DDR calibration data
> +--------------------------------------------------------
> +
> +The below firgure shows the subsequent boot scenario with valid DDR calibration
> +data process being loaded from host to target.

[Severity: Low]
Does this code contain a typo? It looks like "firgure" should be "figure".

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261013-sahara_protocol_new_v2-v9-0-dc9f24357c4a@oss.qualcomm.com?part=1