HF-TMC9660 Driver 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC9660
Loading...
Searching...
No Matches
tmc9660::OtpBurnResult Struct Reference

OTP burn operation result information. More...

#include <bootloader_protocol.hpp>

Static Public Member Functions

static OtpBurnResult createSuccess () noexcept
 Create success result.
 
static OtpBurnResult createError (OtpBurnError code) noexcept
 Create error result.
 

Public Attributes

bool isSuccess
 Whether the burn operation succeeded.
 
OtpBurnError errorCode
 Error code if operation failed.
 
const charerrorDescription
 Human-readable error description.
 

Detailed Description

OTP burn operation result information.

Contains the result of burning data to OTP (One-Time Programmable) memory. The structure includes success status, error code, and human-readable error description for debugging failed burn operations.

Member Function Documentation

◆ createError()

static OtpBurnResult tmc9660::OtpBurnResult::createError ( OtpBurnError code)
inlinestaticnoexcept

Create error result.

Here is the caller graph for this function:

◆ createSuccess()

static OtpBurnResult tmc9660::OtpBurnResult::createSuccess ( )
inlinestaticnoexcept

Create success result.

Here is the caller graph for this function:

Member Data Documentation

◆ errorCode

OtpBurnError tmc9660::OtpBurnResult::errorCode

Error code if operation failed.

◆ errorDescription

const char* tmc9660::OtpBurnResult::errorDescription

Human-readable error description.

◆ isSuccess

bool tmc9660::OtpBurnResult::isSuccess

Whether the burn operation succeeded.


The documentation for this struct was generated from the following file: