CryptoAuthLib v3.9.0
Microchip CryptoAuthentication Library
 
Loading...
Searching...
No Matches
atca_basic.h File Reference

CryptoAuthLib Basic API methods - a simple crypto authentication API. These methods manage a global ATCADevice object behind the scenes. They also manage the wake/idle state transitions so callers don't need to. More...

Macros

#define atcab_get_addr(...)   calib_get_addr(__VA_ARGS__)
 
#define atca_execute_command(...)   calib_execute_command(__VA_ARGS__)
 

Functions

ATCA_STATUS atcab_version (char *ver_str)
 basic API methods are all prefixed with atcab_ (CryptoAuthLib Basic) the fundamental premise of the basic API is it is based on a single interface instance and that instance is global, so all basic API commands assume that one global device is the one to operate on.
 
ATCA_STATUS atcab_init_ext (ATCADevice *device, ATCAIfaceCfg *cfg)
 Creates and initializes a ATCADevice context.
 
ATCA_STATUS atcab_init (ATCAIfaceCfg *cfg)
 Creates a global ATCADevice object used by Basic API.
 
ATCA_STATUS atcab_init_device (ATCADevice ca_device)
 Initialize the global ATCADevice object to point to one of your choosing for use with all the atcab_ basic API.
 
ATCA_STATUS atcab_release_ext (ATCADevice *device)
 release (free) the an ATCADevice instance.
 
ATCA_STATUS atcab_release (void)
 release (free) the global ATCADevice instance. This must be called in order to release or free up the interface.
 
ATCADevice atcab_get_device (void)
 Get the global device object.
 
ATCADeviceType atcab_get_device_type_ext (ATCADevice device)
 Get the selected device type of rthe device context.
 
ATCADeviceType atcab_get_device_type (void)
 Get the current device type configured for the global ATCADevice.
 
uint8_t atcab_get_device_address (ATCADevice device)
 Get the current device address based on the configured device and interface.
 
bool atcab_is_ca_device (ATCADeviceType dev_type)
 Check whether the device is cryptoauth device.
 
bool atcab_is_ca2_device (ATCADeviceType dev_type)
 Check whether the device is cryptoauth device.
 
bool atcab_is_ta_device (ATCADeviceType dev_type)
 Check whether the device is Trust Anchor device.
 

Variables

ATCADevice g_atcab_device_ptr
 

Detailed Description

CryptoAuthLib Basic API methods - a simple crypto authentication API. These methods manage a global ATCADevice object behind the scenes. They also manage the wake/idle state transitions so callers don't need to.