Enum rust_cryptoauthlib::AtcaStatus

pub enum AtcaStatus {
    AtcaSuccess,
    AtcaConfigZoneLocked,
    AtcaDataZoneLocked,
    AtcaWakeFailed,
    AtcaCheckMacVerifyFailed,
    AtcaParseError,
    AtcaStatusCrc,
    AtcaStatusUnknown,
    AtcaStatusEcc,
    AtcaStatusSelftestError,
    AtcaFuncFail,
    AtcaGenFail,
    AtcaBadParam,
    AtcaInvalidId,
    AtcaInvalidSize,
    AtcaRxCrcError,
    AtcaRxFail,
    AtcaRxNoResponse,
    AtcaResyncWithWakeup,
    AtcaParityError,
    AtcaTxTimeout,
    AtcaRxTimeout,
    AtcaTooManyCommRetries,
    AtcaSmallBuffer,
    AtcaCommFail,
    AtcaTimeout,
    AtcaBadOpcode,
    AtcaWakeSuccess,
    AtcaExecutionError,
    AtcaUnimplemented,
    AtcaAssertFailure,
    AtcaTxFail,
    AtcaNotLocked,
    AtcaNoDevices,
    AtcaHealthTestError,
    AtcaAllocFailure,
    AtcaUseFlagsConsumed,
    AtcaUnknown,
}

Return status for device accessing functions

Variants

AtcaSuccess

Function succeeded.

AtcaConfigZoneLocked

AtcaDataZoneLocked

AtcaWakeFailed

response status byte indicates CheckMac failure (status byte = 0x01)

AtcaCheckMacVerifyFailed

response status byte indicates CheckMac failure (status byte = 0x01)

AtcaParseError

response status byte indicates parsing error (status byte = 0x03)

AtcaStatusCrc

response status byte indicates DEVICE did not receive data properly (status byte = 0xFF)

AtcaStatusUnknown

response status byte is unknown

AtcaStatusEcc

response status byte is ECC fault (status byte = 0x05)

AtcaStatusSelftestError

response status byte is Self Test Error, chip in failure mode (status byte = 0x07)

AtcaFuncFail

Function could not execute due to incorrect condition / state.

AtcaGenFail

unspecified error

AtcaBadParam

bad argument (out of range, null pointer, etc.)

AtcaInvalidId

invalid device id, id not set

AtcaInvalidSize

Count value is out of range or greater than buffer size.

AtcaRxCrcError

CRC error in data received from device

AtcaRxFail

Timed out while waiting for response. Number of bytes received is > 0.

AtcaRxNoResponse

Not an error while the Command layer is polling for a command response.

AtcaResyncWithWakeup

Re-synchronization succeeded, but only after generating a Wake-up

AtcaParityError

for protocols needing parity

AtcaTxTimeout

for Microchip PHY protocol, timeout on transmission waiting for master

AtcaRxTimeout

for Microchip PHY protocol, timeout on receipt waiting for master

AtcaTooManyCommRetries

Device did not respond too many times during a transmission. Could indicate no device present.

AtcaSmallBuffer

Supplied buffer is too small for data required

AtcaCommFail

Communication with device failed. Same as in hardware dependent modules.

AtcaTimeout

Timed out while waiting for response. Number of bytes received is 0.

AtcaBadOpcode

opcode is not supported by the device

AtcaWakeSuccess

received proper wake token

AtcaExecutionError

chip was in a state where it could not execute the command, response status byte indicates command execution error (status byte = 0x0F)

AtcaUnimplemented

Function or some element of it hasn’t been implemented yet

AtcaAssertFailure

Code failed run-time consistency check

AtcaTxFail

Failed to write

AtcaNotLocked

required zone was not locked

AtcaNoDevices

For protocols that support device discovery (kit protocol), no devices were found

AtcaHealthTestError

random number generator health test error

AtcaAllocFailure

Couldn’t allocate required memory

AtcaUseFlagsConsumed

Use flags on the device indicates its consumed fully

AtcaUnknown

Unknown error occured

Trait Implementations

impl Debug for AtcaStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for AtcaStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<u32> for AtcaStatus

fn from(atca_status: ATCA_STATUS) -> Self

Performs the conversion.

impl PartialEq<AtcaStatus> for AtcaStatus

fn eq(&self, other: &AtcaStatus) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralPartialEq for AtcaStatus