Skip to content

VIP firehose extension + cosmetic adjustments/fixes#110

Merged
konradybcio merged 6 commits intolinux-msm:masterfrom
igoropaniuk:vip_final_rebased
Jun 24, 2025
Merged

VIP firehose extension + cosmetic adjustments/fixes#110
konradybcio merged 6 commits intolinux-msm:masterfrom
igoropaniuk:vip_final_rebased

Conversation

@igoropaniuk
Copy link
Contributor

@igoropaniuk igoropaniuk commented Jun 13, 2025 •
edited
Loading

  1. This PR extends the Firehose protocol implementation to support the VIP
    extension. It implements a state machine that counts the number of
    packets sent, then injects the VIP table as the next RAW packet when
    the Firehose programmer runs out of provided digests and needs a new table
    of digests to validate the next packets.

  2. Improves parameters handling and prettifies usage print

@igoropaniuk igoropaniuk changed the title VIP firehose extension support + cosmetic adjustments/fixes VIP firehose extension + cosmetic adjustments/fixes Jun 13, 2025
@igoropaniuk igoropaniuk force-pushed the vip_final_rebased branch 12 times, most recently from cd42563 to 40c30ea Compare June 16, 2025 10:59
@igoropaniuk
Copy link
Contributor Author

igoropaniuk commented Jun 16, 2025 •
edited
Loading

Fixed all issues reported by checkpatch

@igoropaniuk
Copy link
Contributor Author

igoropaniuk commented Jun 17, 2025

@lumag @andersson @konradybcio could you please take a look?

lumag
lumag requested changes Jun 18, 2025
View reviewed changes
@igoropaniuk
Copy link
Contributor Author

igoropaniuk commented Jun 18, 2025

@lumag I've addressed both comments

@igoropaniuk igoropaniuk requested a review from lumag June 18, 2025 19:43
@igoropaniuk
firehose: try to obtain a status when usb write fails
df94193 
In some cases (for instance, in VIP mode), the Firehose programmer can
report an additional error code before stalling and can provide
valuable information about the type of error that occurred.

For example, when digest verification fails, Firehose programmer provides
additional log messages before stalling:

<data>
<log value="ERROR: Hash of data doesn't match the expected hash 179" />
</data>
<data>
<log value="INFO: Expected hash (32)" /></data>
<data>
<log value="INFO: 30 E1 49 55 EB F1 35 22 66 ..." /></data>
<data>
<log value="INFO: Calculated hash (32)" /></data>
<data>
<log value="INFO: AE BA 2E DE 99 FA 44 30 E4 ... " /></data>
...
</xml>

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
firehose: don't send configure packet in simulation
5fe1566 
There is a regression in the current implementation of simulation mode,
which leads to sending two configure packets:

FIREHOSE WRITE: <?xml version="1.0"?>
<data><configure MemoryName="ufs" MaxPayloadSizeToTargetInBytes="1048576"
verbose="0" ZLPAwareHost="1" SkipStorageInit="0"/></data>

FIREHOSE WRITE: <?xml version="1.0"?>
<data><configure MemoryName="ufs" MaxPayloadSizeToTargetInBytes="0"
verbose="0" ZLPAwareHost="1" SkipStorageInit="0"/></data>

In simulated mode "remote" target can't propose different size, so
we just don't re-send configure packet.
Move the check for simulation mode to prevent sending additional
configure packets with the attribute MaxPayloadSizeToTargetInBytes=0.

Also change DIGEST_TABLE.bin sha256 hash to
a05e1124edbe34dc504a327544fb66572591353dc3fa25e6e7eafbe4803e63e0,
as amount of packets supposed to be sent to the target changed.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
firehose: support VIP extension
176cfcd 
This extends the Firehose protocol implementation to support the VIP
extension. It implements a state machine that counts the number of
packets sent, then injects the VIP table as the next RAW packet when
the Firehose programmer runs out of provided digests and needs a new table
of digests to validate the next packets. For example:

Packet 0: DigestsTableToSign.bin.mbn (53 digest + 1 digest of next table)
Packet 1: <configure>
Packet 2: <program>
Packet 3: ...
...
Packet 54: ChainedTableOfDigests0.bin (255 digests + digest of next table)
Packet 55: <program>
...
Packet 309: ChainedTableOfDigests1.bin

To enable VIP extension provide a path where previously generated VIP
tables are stored using "--vip-table-path" param:

$ qdl --vip-table-path "<vip-table-path>" prog_firehose_ddr.elf \
  rawprogram*.xml patch*.xml

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
qdl: drop enum for chunk size param
387ad84 
Drop enum definition for chunk size parameter.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
qdl: fix provided options to getopt_long
1bbbdb6 
Fix list of provided command-line options to getopt_long() for parsing.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
qdl: improve usage output
733a44a 
Prettify usage details and introduce explicit -h param:

Usage: qdl [options] <prog.mbn> [<program> <patch> ...]
 -d, --debug			Print detailed debug info
 -v, --version			Print the current version and exit
 -n, --dry-run			Dry run execution, no device reading or flashing
 -f, --allow-missing		Allow skipping of missing files during flashing
 -s, --storage=T		Set target storage type T: <emmc|nand|ufs>
 -l, --finalize-provisioning	Provision the target storage
 -i, --include=T		Set an optional folder T to search for files
 -S, --serial=T			Select target by serial number T (e.g. <0AA94EFD>)
 -u, --out-chunk-size=T		Override chunk size for transaction with T
 -t, --create-digests=T		Generate table of digests in the T folder
 -D, --vip-table-path=T		Use digest tables in the T folder for VIP
 -h, --help			Print this usage info

Example: qdl prog_firehose_ddr.elf rawprogram*.xml patch*.xml

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
@igoropaniuk
Copy link
Contributor Author

igoropaniuk commented Jun 23, 2025

@lumag @konradybcio any additional comments/suggestions? thank you

lumag
lumag approved these changes Jun 23, 2025
View reviewed changes
Copy link
Contributor

@lumag lumag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: in future please try to describe why you are performing a change, not what is the patch doing (which is frequently obvious).

@konradybcio konradybcio merged commit a691179 into linux-msm:master Jun 24, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lumag lumag lumag approved these changes

+1 more reviewer

@quic-kdybcio quic-kdybcio quic-kdybcio approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@igoropaniuk @lumag @quic-kdybcio @konradybcio