CryptoAuthLib
Microchip CryptoAuthentication Library
atca_iface.h File Reference

Microchip Crypto Auth hardware interface object. More...

#include "atca_command.h"

Go to the source code of this file.

Data Structures

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

Typedefs

typedef struct atca_ifaceATCAIface
 

Enumerations

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

Functions

ATCA_STATUS initATCAIface (ATCAIfaceCfg *cfg, ATCAIface ca_iface)
 Initializer for ATCAIface objects. More...
 
ATCAIface newATCAIface (ATCAIfaceCfg *cfg)
 Constructor for ATCAIface objects. More...
 
ATCA_STATUS releaseATCAIface (ATCAIface ca_iface)
 Instruct the HAL driver to release any resources associated with this interface. More...
 
void deleteATCAIface (ATCAIface *ca_iface)
 Instruct the HAL driver to release any resources associated with this interface, then delete the object. More...
 
ATCA_STATUS atinit (ATCAIface ca_iface)
 Performs the HAL initialization by calling intermediate HAL wrapper function. If using the basic API, the atcab_init() function should be called instead. More...
 
ATCA_STATUS atpostinit (ATCAIface ca_iface)
 
ATCA_STATUS atsend (ATCAIface ca_iface, uint8_t *txdata, int txlength)
 Sends the data to the device by calling intermediate HAL wrapper function. More...
 
ATCA_STATUS atreceive (ATCAIface ca_iface, uint8_t *rxdata, uint16_t *rxlength)
 Receives data from the device by calling intermediate HAL wrapper function. More...
 
ATCA_STATUS atwake (ATCAIface ca_iface)
 Wakes up the device by calling intermediate HAL wrapper function. If using the basic API, the atcab_wakeup() function should be used instead. More...
 
ATCA_STATUS atidle (ATCAIface ca_iface)
 Puts the device into idle state by calling intermediate HAL wrapper function. If using the basic API, the atcab_idle() function should be used instead. More...
 
ATCA_STATUS atsleep (ATCAIface ca_iface)
 Puts the device into sleep state by calling intermediate HAL wrapper function. If using the basic API, the atcab_sleep() function should be used instead. More...
 
ATCAIfaceCfgatgetifacecfg (ATCAIface ca_iface)
 Returns the logical interface configuration for the device. More...
 
void * atgetifacehaldat (ATCAIface ca_iface)
 Returns the HAL data pointer for the device. More...
 

Detailed Description

Microchip Crypto Auth hardware interface object.