summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick Venture <venture@google.com>2018-10-03 16:32:18 -0700
committerPatrick Venture <venture@google.com>2018-10-04 16:50:42 +0000
commit8ee139d5622551087ea7b532e556115d00686bd8 (patch)
tree627c2b0b78dc0c6982ee02ded421691c7232c7f7
parent73eb687a46cab0d3d9d679e1af8a7a13353bcd11 (diff)
downloadphosphor-ipmi-blobs-8ee139d5622551087ea7b532e556115d00686bd8.tar.gz
phosphor-ipmi-blobs-8ee139d5622551087ea7b532e556115d00686bd8.zip
README: Add new command: BmcBlobWriteMeta
The BmcBlobWriteMeta command provides the notion that some blob object may have meta data that can be updated by the host or caller. Change-Id: Ief8e1bc5d49b7e0e4df61ef34d6b873777fabdb1 Signed-off-by: Patrick Venture <venture@google.com>
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
index 997d70d..ea2097a 100644
--- a/README.md
+++ b/README.md
@@ -321,6 +321,30 @@ struct BmcBlobSessionStatRx {
};
```
+### BmcBlobWriteMeta (10)
+
+The `BmcBlobWriteMeta` command behaves like `BmcBlobWrite`. Its purpose is
+blob-specific, and not all blobs must support it.
+
+The `BmcBlobWriteMeta` command expects to receive a body of:
+
+```
+struct BmcBlobWriteMetaTx
+{
+ uint16_t crc16;
+ uint16_t session_id; /* Returned from BmcBlobOpen. */
+ uint32_t offset; /* The byte sequence start, 0-based. */
+ uint8_t data[];
+};
+```
+
+Immediately following this structure are the bytes to write. The length of the
+entire packet is variable and handled at a higher level, therefore the number
+of bytes to write is the size of the command body less the OEN and sub-command
+(4 bytes) and less the structure size.
+
+On success it will return a success completion code.
+
## Idempotent Commands
The IPMI transport layer is somewhat flaky. Client code must rely on a
OpenPOWER on IntegriCloud