From 8ee139d5622551087ea7b532e556115d00686bd8 Mon Sep 17 00:00:00 2001 From: Patrick Venture Date: Wed, 3 Oct 2018 16:32:18 -0700 Subject: 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 --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'README.md') 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 -- cgit v1.2.3