Microchip ATCA
SDK Utilities and Components > Secure Element

Component for Microchip CryptoAuth devices. More...

Modules

Types
ATCA data types.
 
Key Pair
Elliptic Curve keypair APIs.
 
Certificates
Certificate APIs.
 
Configuration
Chip configuration APIs.
 

Functions

gos_result_t gos_atca_init (const gos_atca_config_t *config)
 
gos_result_t gos_atca_get_revision_str (char *revision_str_buffer)
 
gos_result_t gos_atca_get_serial_number_str (char *serial_str_buffer)
 
gos_result_t gos_atca_register_mbedtls_ec_callbacks (void)
 
gos_result_t gos_atca_wakeup (void)
 
gos_result_t gos_atca_sleep (void)
 
gos_result_t gos_atca_run_self_test (void)
 

Detailed Description

Component for Microchip CryptoAuth devices.

This provides a Gecko OS wrapper around the Microchip CryptoAuth library: Online documentation is at https://microchiptech.github.io/cryptoauthlib/

Function Documentation

◆ gos_atca_get_revision_str()

gos_result_t gos_atca_get_revision_str ( char *  revision_str_buffer)

Return chip revision number as string

Parameters
[out]revision_str_buffer
Returns
gos_result_t result of API

◆ gos_atca_get_serial_number_str()

gos_result_t gos_atca_get_serial_number_str ( char *  serial_str_buffer)

Return chip serial number as string

Executes Read command, which reads the 9 byte serial number of the SE from the config zone. Serial number converted to hex string.

Parameters
[out]serial_str_buffer
Returns
gos_result_t result of API

◆ gos_atca_init()

gos_result_t gos_atca_init ( const gos_atca_config_t *  config)

Initialize ATCA component

Parameters
[in]configSee gos_atca_config_t
Returns
gos_result_t result of API

◆ gos_atca_register_mbedtls_ec_callbacks()

gos_result_t gos_atca_register_mbedtls_ec_callbacks ( void  )

Register mBedTLS Elliptic Curve callbacks

This registers internal callbacks with the Gecko OS mBedTLS crypto library. This API must be invoked if the Secure Element is to be used during TLS transactions.

Returns
gos_result_t result of API
Examples:
demo/secure_element/main.c.

◆ gos_atca_run_self_test()

gos_result_t gos_atca_run_self_test ( void  )

Run all 'basic' self-tests

Returns
gos_result_t result of API

◆ gos_atca_sleep()

gos_result_t gos_atca_sleep ( void  )

Invoke sleep on the CryptoAuth SE

Returns
gos_result_t result of API

◆ gos_atca_wakeup()

gos_result_t gos_atca_wakeup ( void  )

Wakeup the CryptoAuth SE

Returns
gos_result_t result of API