Skip to content

Commit 1a2be9d

Browse files
committed
README: Add details for PLDM for File Transfer client function
Signed-off-by: Jeremy Kerr <[email protected]>
1 parent c4c41b2 commit 1a2be9d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ To incorporate NVMe-MI responder support, add the `nvme-mi` feature:
3535
cargo build --features nvme-mi
3636
```
3737

38+
We also support a test client for PLDM for File Transfer (type 7). When
39+
`mctp-dev` is assigned an MCTP EID, it will perform PLDM operations to
40+
read a file from the bus owner EID.
41+
42+
The PLDM client expects to find the File record as the first PDR entry, and
43+
will attempt to transfer the entire file. Upon completion, the file size and
44+
sha256 checksum will be printed:
45+
46+
```
47+
11:06:34 [INFO] Transfer complete. 16384 bytes, sha256 b4d3f1859dc8170c1e1f34b936aff05339a7723b6680894380c23dd84ff7e22b
48+
```
49+
50+
To enable the PLDM File functionality, add the `pldm` feature:
51+
52+
```sh
53+
cargo build --features pldm
54+
```
55+
3856
# Running
3957

4058
1. Run `qemu` with a usbredir connection to a pty:

0 commit comments

Comments
 (0)