Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider: - [Low] docs: mhi: multiple typos and minor copy-paste errors in Sahara protocol documentation --
commit 6e5d4c22229dc0e189e8ab259dab37fed17658dd Author: Kishore Batta <[email protected]> Add documentation for Sahara protocol Introduce documentation for the Sahara protocol, describing its operational modes and their respective functions. > 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 [ ... ] > +| 0x12 | 64 bit Read | Target | Reads specified number of bytes from > | > +| | data | | host for a given 64 bit image. > | > ++---------+---------------+---------+-----------------------------------------+ > +| 0x13 | Reset Sahara | Host | Resets Sahara state machine and enters > | > +| | sate machine | | Sahara entry without target reset > | > +| | packet | | > | [Severity: Low] This isn't a bug, but there's a typo here: 'sate machine' instead of 'state machine'. [ ... ] > ++-----------------------------+---------+------------------------------------+ > +|SAHARA_MODE_IMAGE_TX_COMPLETE| 0x1 | Image transfer is in the complete > | > +| | | mode. Transfer image from the > host.| > +| | | After completion, the host should > | > +| | | not expect another image transfer > | > +| | | request. > | > ++-----------------------------+---------+------------------------------------+ > +| SAHARA_MODE_MEMORY_DBEUG | 0x2 | Memory debug mode. The host should > | > +| | | prepare to receive a memory dump > | > +| | | from the target. > | [Severity: Low] This isn't a bug, but there's a typo here: 'DBEUG' instead of 'DEBUG'. [ ... ] > ++-----------------------------+---------+------------------------------------+ > +| SAHARA_MODE_COMMAND | 0x3 | Command mode. The host executes > | > +| | | operations on the target by > sending| > +| | | the appropriate client command to > | > +| | | the Sahara client running on the > | > +| | | target. The Sahar client > interprets| > +| | | the client command and the > response| [Severity: Low] This isn't a bug, but there's a typo here: 'Sahar client' instead of 'Sahara client'. [ ... ] > +To initiate a write data transfer, the target fills the write data packet > with > +the image ID corresponding to the image data that it wants to send. The > target > +also sends the offset into the output file and the length of the data(in > bytes) > +it wants to write from the target. As soon as the host receives the packet, > the > +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] This isn't a bug, but there's a typo here: 'pcket' instead of 'packet'. [ ... ] > +5. After receiving a read data request, the host parses the image ID, data > + offset, and data length to transfer data from the corresponding image > file. > + The host sends the requested data without any packet header. > + > +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] This isn't a bug, but there's a typo here: 'targert' instead of 'target'. [ ... ] > + | 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) | > + |-------------------------->| [Severity: Low] Should region 2 request 'size of region 2' here instead of 'size of region 0'? [ ... ] > +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] This isn't a bug, but there's a typo here: 'firgure' instead of 'figure'. -- Sashiko AI review ยท https://sashiko.dev/#/patchset/20261008-sahara_protocol_new_v2-v7-0-90d278bd7...@oss.qualcomm.com?part=1
