diff --git a/scripts/sysman/firmware.yml b/scripts/sysman/firmware.yml index d1e1b56b4..c07b13d0b 100644 --- a/scripts/sysman/firmware.yml +++ b/scripts/sysman/firmware.yml @@ -108,6 +108,27 @@ params: name: pCompletionPercent desc: "[in,out] Pointer to the Completion Percentage of Firmware Update" --- #-------------------------------------------------------------------------- +type: function +desc: "Get Firmware Console Logs" +version: "1.9" +class: $sFirmware +name: GetConsoleLogs +details: + - "The caller may pass nullptr for pFirmwareLog and set pSize to zero when querying only for size." + - "The caller must provide memory for Firmware log." + - "The application may call this function from simultaneous threads." + - "The implementation of this function should be lock-free." +params: + - type: $s_firmware_handle_t + name: hFirmware + desc: "[in] Handle for the component." + - type: "size_t*" + name: pSize + desc: "[in,out] size of firmware log" + - type: "char*" + name: pFirmwareLog + desc: "[in,out][optional] pointer to null-terminated string of the log." +--- #-------------------------------------------------------------------------- type: class desc: "C++ wrapper for a Sysman device firmware" name: $sFirmware