CryptoAuthLib
Atmel CryptoAuthentication Library
ATCAIface (atca_)

Abstract interface to all CryptoAuth device types. This interface connects to the HAL implementation and abstracts the physical details of the device communication from all the upper layers of CryptoAuthLib. More...

Data Structures

struct  atca_iface
 atca_iface is the C object backing ATCAIface. See the atca_iface.h file for details on the ATCAIface methods More...
 
struct  ATCAIfaceCfg
 

Typedefs

typedef struct atca_ifaceATCAIface
 

Enumerations

enum  ATCAIfaceType {
  ATCA_I2C_IFACE, ATCA_SWI_IFACE, ATCA_UART_IFACE, ATCA_SPI_IFACE,
  ATCA_HID_IFACE
}
 

Functions

ATCA_STATUS _atinit (ATCAIface caiface, ATCAHAL_t *hal)
 
ATCAIface newATCAIface (ATCAIfaceCfg *cfg)
 constructor for ATCAIface objects More...
 
ATCA_STATUS atinit (ATCAIface caiface)
 
ATCA_STATUS atsend (ATCAIface caiface, uint8_t *txdata, int txlength)
 
ATCA_STATUS atreceive (ATCAIface caiface, uint8_t *rxdata, uint16_t *rxlength)
 
ATCA_STATUS atwake (ATCAIface caiface)
 
ATCA_STATUS atidle (ATCAIface caiface)
 
ATCA_STATUS atsleep (ATCAIface caiface)
 
ATCAIfaceCfgatgetifacecfg (ATCAIface caiface)
 
void * atgetifacehaldat (ATCAIface caiface)
 
void deleteATCAIface (ATCAIface *caiface)
 
ATCA_STATUS atpostinit (ATCAIface caiface)
 

Detailed Description

Abstract interface to all CryptoAuth device types. This interface connects to the HAL implementation and abstracts the physical details of the device communication from all the upper layers of CryptoAuthLib.

Typedef Documentation

typedef struct atca_iface* ATCAIface

Enumeration Type Documentation

Enumerator
ATCA_I2C_IFACE 
ATCA_SWI_IFACE 
ATCA_UART_IFACE 
ATCA_SPI_IFACE 
ATCA_HID_IFACE 

Function Documentation

ATCA_STATUS _atinit ( ATCAIface  caiface,
ATCAHAL_t hal 
)
ATCAIfaceCfg * atgetifacecfg ( ATCAIface  caiface)
void * atgetifacehaldat ( ATCAIface  caiface)
ATCA_STATUS atidle ( ATCAIface  caiface)
ATCA_STATUS atinit ( ATCAIface  caiface)
ATCA_STATUS atpostinit ( ATCAIface  caiface)
ATCA_STATUS atreceive ( ATCAIface  caiface,
uint8_t *  rxdata,
uint16_t *  rxlength 
)
ATCA_STATUS atsend ( ATCAIface  caiface,
uint8_t *  txdata,
int  txlength 
)
ATCA_STATUS atsleep ( ATCAIface  caiface)
ATCA_STATUS atwake ( ATCAIface  caiface)
void deleteATCAIface ( ATCAIface caiface)
ATCAIface newATCAIface ( ATCAIfaceCfg cfg)

constructor for ATCAIface objects

Parameters
[in]cfgpoints to the logical configuration for the interface
Returns
ATCAIface