apidocs/sha204__library_8h_source.html

#include "Arduino.h"


#ifndef sha204_library_H

#define sha204_library_H


/* bitbang_config.h */


#define PORT_ACCESS_TIME        (630)

#define START_PULSE_WIDTH       (4340)

#define BIT_DELAY               (4)

#define RX_TX_DELAY             (15)

#define START_PULSE_TIME_OUT    (255)

#define ZERO_PULSE_TIME_OUT     (26)


/* swi_phys.h */


#define SWI_FUNCTION_RETCODE_SUCCESS     ((uint8_t) 0x00)

#define SWI_FUNCTION_RETCODE_TIMEOUT     ((uint8_t) 0xF1)

#define SWI_FUNCTION_RETCODE_RX_FAIL     ((uint8_t) 0xF9)


/* sha204_physical.h */


#define SHA204_RSP_SIZE_MIN          ((uint8_t)  4)

#define SHA204_RSP_SIZE_MAX          ((uint8_t) 35)

#define SHA204_BUFFER_POS_COUNT      (0)

#define SHA204_BUFFER_POS_DATA       (1)

#define SHA204_WAKEUP_PULSE_WIDTH    (uint8_t) (6.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5)

#define SHA204_WAKEUP_DELAY          (uint8_t) (3.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5)


/* sha204_swi.c */

#define SHA204_SWI_FLAG_CMD     ((uint8_t) 0x77)

#define SHA204_SWI_FLAG_TX      ((uint8_t) 0x88)

#define SHA204_SWI_FLAG_IDLE    ((uint8_t) 0xBB)

#define SHA204_SWI_FLAG_SLEEP   ((uint8_t) 0xCC)


/* sha204_comm_marshaling.h */

// command op-code definitions

#define SHA204_CHECKMAC                 ((uint8_t) 0x28)

#define SHA204_DERIVE_KEY               ((uint8_t) 0x1C)

#define SHA204_DEVREV                   ((uint8_t) 0x30)

#define SHA204_GENDIG                   ((uint8_t) 0x15)

#define SHA204_HMAC                     ((uint8_t) 0x11)

#define SHA204_LOCK                     ((uint8_t) 0x17)

#define SHA204_MAC                      ((uint8_t) 0x08)

#define SHA204_NONCE                    ((uint8_t) 0x16)

#define SHA204_PAUSE                    ((uint8_t) 0x01)

#define SHA204_RANDOM                   ((uint8_t) 0x1B)

#define SHA204_READ                     ((uint8_t) 0x02)

#define SHA204_UPDATE_EXTRA             ((uint8_t) 0x20)

#define SHA204_WRITE                    ((uint8_t) 0x12)


// packet size definitions

#define SHA204_RSP_SIZE_VAL             ((uint8_t)  7)


// parameter range definitions

#define SHA204_KEY_ID_MAX               ((uint8_t) 15)

#define SHA204_OTP_BLOCK_MAX            ((uint8_t)  1)


// definitions for command packet indexes common to all commands

#define SHA204_COUNT_IDX                ( 0)

#define SHA204_OPCODE_IDX               ( 1)

#define SHA204_PARAM1_IDX               ( 2)

#define SHA204_PARAM2_IDX               ( 3)

#define SHA204_DATA_IDX                 ( 5)


// zone definitions

#define SHA204_ZONE_CONFIG              ((uint8_t)  0x00)

#define SHA204_ZONE_OTP                 ((uint8_t)  0x01)

#define SHA204_ZONE_DATA                ((uint8_t)  0x02)

#define SHA204_ZONE_MASK                ((uint8_t)  0x03)

#define SHA204_ZONE_COUNT_FLAG          ((uint8_t)  0x80)

#define SHA204_ZONE_ACCESS_4            ((uint8_t)     4)

#define SHA204_ZONE_ACCESS_32           ((uint8_t)    32)

#define SHA204_ADDRESS_MASK_CONFIG      (         0x001F)

#define SHA204_ADDRESS_MASK_OTP         (         0x000F)

#define SHA204_ADDRESS_MASK             (         0x007F)


// CheckMAC command definitions

#define CHECKMAC_MODE_IDX               SHA204_PARAM1_IDX

#define CHECKMAC_KEYID_IDX              SHA204_PARAM2_IDX

#define CHECKMAC_CLIENT_CHALLENGE_IDX   SHA204_DATA_IDX

#define CHECKMAC_CLIENT_RESPONSE_IDX    (37)

#define CHECKMAC_DATA_IDX               (69)

#define CHECKMAC_COUNT                  (84)

#define CHECKMAC_MODE_MASK              ((uint8_t) 0x27)

#define CHECKMAC_CLIENT_CHALLENGE_SIZE  (32)

#define CHECKMAC_CLIENT_RESPONSE_SIZE   (32)

#define CHECKMAC_OTHER_DATA_SIZE        (13)


// DeriveKey command definitions

#define DERIVE_KEY_RANDOM_IDX           SHA204_PARAM1_IDX

#define DERIVE_KEY_TARGETKEY_IDX        SHA204_PARAM2_IDX

#define DERIVE_KEY_MAC_IDX              SHA204_DATA_IDX

#define DERIVE_KEY_COUNT_SMALL          SHA204_CMD_SIZE_MIN

#define DERIVE_KEY_COUNT_LARGE          (39)

#define DERIVE_KEY_RANDOM_FLAG          ((uint8_t) 4)

#define DERIVE_KEY_MAC_SIZE             (32)


// DevRev command definitions

#define DEVREV_PARAM1_IDX               SHA204_PARAM1_IDX

#define DEVREV_PARAM2_IDX               SHA204_PARAM2_IDX

#define DEVREV_COUNT                    SHA204_CMD_SIZE_MIN


// GenDig command definitions

#define GENDIG_ZONE_IDX                 SHA204_PARAM1_IDX

#define GENDIG_KEYID_IDX                SHA204_PARAM2_IDX

#define GENDIG_DATA_IDX                 SHA204_DATA_IDX

#define GENDIG_COUNT                    SHA204_CMD_SIZE_MIN

#define GENDIG_COUNT_DATA               (11)

#define GENDIG_OTHER_DATA_SIZE          (4)

#define GENDIG_ZONE_CONFIG              ((uint8_t) 0)

#define GENDIG_ZONE_OTP                 ((uint8_t) 1)

#define GENDIG_ZONE_DATA                ((uint8_t) 2)


// HMAC command definitions

#define HMAC_MODE_IDX                   SHA204_PARAM1_IDX

#define HMAC_KEYID_IDX                  SHA204_PARAM2_IDX

#define HMAC_COUNT                      SHA204_CMD_SIZE_MIN

#define HMAC_MODE_MASK                  ((uint8_t) 0x74)


// Lock command definitions

#define LOCK_ZONE_IDX                   SHA204_PARAM1_IDX

#define LOCK_SUMMARY_IDX                SHA204_PARAM2_IDX

#define LOCK_COUNT                      SHA204_CMD_SIZE_MIN

#define LOCK_ZONE_NO_CONFIG             ((uint8_t) 0x01)

#define LOCK_ZONE_NO_CRC                ((uint8_t) 0x80)

#define LOCK_ZONE_MASK                  (0x81)


// Mac command definitions

#define MAC_MODE_IDX                    SHA204_PARAM1_IDX

#define MAC_KEYID_IDX                   SHA204_PARAM2_IDX

#define MAC_CHALLENGE_IDX               SHA204_DATA_IDX

#define MAC_COUNT_SHORT                 SHA204_CMD_SIZE_MIN

#define MAC_COUNT_LONG                  (39)

#define MAC_MODE_BLOCK2_TEMPKEY         ((uint8_t) 0x01)

#define MAC_MODE_BLOCK1_TEMPKEY         ((uint8_t) 0x02)

#define MAC_MODE_SOURCE_FLAG_MATCH      ((uint8_t) 0x04)

#define MAC_MODE_PASSTHROUGH            ((uint8_t) 0x07)

#define MAC_MODE_INCLUDE_OTP_88         ((uint8_t) 0x10)

#define MAC_MODE_INCLUDE_OTP_64         ((uint8_t) 0x20)

#define MAC_MODE_INCLUDE_SN             ((uint8_t) 0x40)

#define MAC_CHALLENGE_SIZE              (32)

#define MAC_MODE_MASK                   ((uint8_t) 0x77)


// Nonce command definitions

#define NONCE_MODE_IDX                  SHA204_PARAM1_IDX

#define NONCE_PARAM2_IDX                SHA204_PARAM2_IDX

#define NONCE_INPUT_IDX                 SHA204_DATA_IDX

#define NONCE_COUNT_SHORT               (27)

#define NONCE_COUNT_LONG                (39)

#define NONCE_MODE_MASK                 ((uint8_t) 3)

#define NONCE_MODE_SEED_UPDATE          ((uint8_t) 0x00)

#define NONCE_MODE_NO_SEED_UPDATE       ((uint8_t) 0x01)

#define NONCE_MODE_INVALID              ((uint8_t) 0x02)

#define NONCE_MODE_PASSTHROUGH          ((uint8_t) 0x03)

#define NONCE_NUMIN_SIZE                (20)

#define NONCE_NUMIN_SIZE_PASSTHROUGH    (32)


// Pause command definitions

#define PAUSE_SELECT_IDX                SHA204_PARAM1_IDX

#define PAUSE_PARAM2_IDX                SHA204_PARAM2_IDX

#define PAUSE_COUNT                     SHA204_CMD_SIZE_MIN


// Random command definitions

#define RANDOM_MODE_IDX                 SHA204_PARAM1_IDX

#define RANDOM_PARAM2_IDX               SHA204_PARAM2_IDX

#define RANDOM_COUNT                    SHA204_CMD_SIZE_MIN

#define RANDOM_SEED_UPDATE              ((uint8_t) 0x00)

#define RANDOM_NO_SEED_UPDATE           ((uint8_t) 0x01)


// Read command definitions

#define READ_ZONE_IDX                   SHA204_PARAM1_IDX

#define READ_ADDR_IDX                   SHA204_PARAM2_IDX

#define READ_COUNT                      SHA204_CMD_SIZE_MIN

#define READ_ZONE_MASK                  ((uint8_t) 0x83)

#define READ_ZONE_MODE_32_BYTES         ((uint8_t) 0x80)


// UpdateExtra command definitions

#define UPDATE_MODE_IDX                  SHA204_PARAM1_IDX

#define UPDATE_VALUE_IDX                 SHA204_PARAM2_IDX

#define UPDATE_COUNT                     SHA204_CMD_SIZE_MIN

#define UPDATE_CONFIG_BYTE_86            ((uint8_t) 0x01)


// Write command definitions

#define WRITE_ZONE_IDX                  SHA204_PARAM1_IDX

#define WRITE_ADDR_IDX                  SHA204_PARAM2_IDX

#define WRITE_VALUE_IDX                 SHA204_DATA_IDX

#define WRITE_MAC_VS_IDX                ( 9)

#define WRITE_MAC_VL_IDX                (37)

#define WRITE_COUNT_SHORT               (11)

#define WRITE_COUNT_LONG                (39)

#define WRITE_COUNT_SHORT_MAC           (43)

#define WRITE_COUNT_LONG_MAC            (71)

#define WRITE_MAC_SIZE                  (32)

#define WRITE_ZONE_MASK                 ((uint8_t) 0xC3)

#define WRITE_ZONE_WITH_MAC             ((uint8_t) 0x40)


// Response size definitions

#define CHECKMAC_RSP_SIZE               SHA204_RSP_SIZE_MIN

#define DERIVE_KEY_RSP_SIZE             SHA204_RSP_SIZE_MIN

#define DEVREV_RSP_SIZE                 SHA204_RSP_SIZE_VAL

#define GENDIG_RSP_SIZE                 SHA204_RSP_SIZE_MIN

#define HMAC_RSP_SIZE                   SHA204_RSP_SIZE_MAX

#define LOCK_RSP_SIZE                   SHA204_RSP_SIZE_MIN

#define MAC_RSP_SIZE                    SHA204_RSP_SIZE_MAX

#define NONCE_RSP_SIZE_SHORT            SHA204_RSP_SIZE_MIN

#define NONCE_RSP_SIZE_LONG             SHA204_RSP_SIZE_MAX

#define PAUSE_RSP_SIZE                  SHA204_RSP_SIZE_MIN

#define RANDOM_RSP_SIZE                 SHA204_RSP_SIZE_MAX

#define READ_4_RSP_SIZE                 SHA204_RSP_SIZE_VAL

#define READ_32_RSP_SIZE                SHA204_RSP_SIZE_MAX

#define TEMP_SENSE_RSP_SIZE             SHA204_RSP_SIZE_VAL

#define UPDATE_RSP_SIZE                 SHA204_RSP_SIZE_MIN

#define WRITE_RSP_SIZE                  SHA204_RSP_SIZE_MIN


// command timing definitions for minimum execution times (ms)

#define CHECKMAC_DELAY                  ((uint8_t) (12.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define DERIVE_KEY_DELAY                ((uint8_t) (14.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define DEVREV_DELAY                    ((uint8_t) ( 0.4 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define GENDIG_DELAY                    ((uint8_t) (11.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define HMAC_DELAY                      ((uint8_t) (27.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define LOCK_DELAY                      ((uint8_t) ( 5.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define MAC_DELAY                       ((uint8_t) (12.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define NONCE_DELAY                     ((uint8_t) (22.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define PAUSE_DELAY                     ((uint8_t) ( 0.4 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define RANDOM_DELAY                    ((uint8_t) (11.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define READ_DELAY                      ((uint8_t) ( 0.4 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define TEMP_SENSE_DELAY                ((uint8_t) ( 4.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define UPDATE_DELAY                    ((uint8_t) ( 4.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))

#define WRITE_DELAY                     ((uint8_t) ( 4.0 * CPU_CLOCK_DEVIATION_NEGATIVE - 0.5))


// command timing definitions for maximum execution times (ms)

#define CHECKMAC_EXEC_MAX                ((uint8_t) (38.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define DERIVE_KEY_EXEC_MAX              ((uint8_t) (62.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define DEVREV_EXEC_MAX                  ((uint8_t) ( 2.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define GENDIG_EXEC_MAX                  ((uint8_t) (43.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define HMAC_EXEC_MAX                    ((uint8_t) (69.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define LOCK_EXEC_MAX                    ((uint8_t) (24.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define MAC_EXEC_MAX                     ((uint8_t) (35.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define NONCE_EXEC_MAX                   ((uint8_t) (60.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define PAUSE_EXEC_MAX                   ((uint8_t) ( 2.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define RANDOM_EXEC_MAX                  ((uint8_t) (50.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define READ_EXEC_MAX                    ((uint8_t) ( 4.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define TEMP_SENSE_EXEC_MAX              ((uint8_t) (11.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define UPDATE_EXEC_MAX                  ((uint8_t) ( 6.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define WRITE_EXEC_MAX                   ((uint8_t) (42.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))


/* from sha204_config.h */


#define CPU_CLOCK_DEVIATION_POSITIVE   (1.01)

#define CPU_CLOCK_DEVIATION_NEGATIVE   (0.99)

#define SHA204_RETRY_COUNT           (1)

#define SWI_RECEIVE_TIME_OUT      ((uint16_t) 163)

#define SWI_US_PER_BYTE           ((uint16_t) 313)

#define SHA204_SYNC_TIMEOUT       ((uint8_t) 85)

#define SHA204_RESPONSE_TIMEOUT   ((uint16_t) SWI_RECEIVE_TIME_OUT + SWI_US_PER_BYTE)


/* from sha204_comm.h */


#define SHA204_COMMAND_EXEC_MAX      ((uint8_t) (69.0 * CPU_CLOCK_DEVIATION_POSITIVE + 0.5))

#define SHA204_CMD_SIZE_MIN          ((uint8_t)  7)

#ifndef SHA204_CMD_SIZE_MAX

#define SHA204_CMD_SIZE_MAX          ((uint8_t) 84)

#endif

#define SHA204_CRC_SIZE              ((uint8_t)  2)

#define SHA204_BUFFER_POS_STATUS     (1)

#define SHA204_BUFFER_POS_DATA       (1)

#define SHA204_STATUS_BYTE_WAKEUP    ((uint8_t) 0x11)

#define SHA204_STATUS_BYTE_PARSE     ((uint8_t) 0x03)

#define SHA204_STATUS_BYTE_EXEC      ((uint8_t) 0x0F)

#define SHA204_STATUS_BYTE_COMM      ((uint8_t) 0xFF)


/* EEPROM Addresses */

/* Configuration Zone */

#define ADDRESS_SN03        0   // SN[0:3] are bytes 0->3 of configuration zone

#define ADDRESS_RevNum      4   // bytes 4->7 of config zone are RevNum

#define ADDRESS_SN47        8   // SN[4:7] are bytes 8->11 of config zone

#define ADDRESS_SN8         12  // SN[8] is byte 12 of config zone, should be 0xEE

#define ADDRESS_I2CEN       14  // I2C Enable, bit 0 represents I2C enable status

#define ADDRESS_I2CADD      16  // Defines I2C address of SHA204

#define ADDRESS_OTPMODE     18  // Sets the One-time-programmable mode

#define ADDRESS_SELECTOR    19  // Controls writability of Selector


/* Low level HW access macros */

/* function calls is not working, as it will have too much overhead */

#if !defined(ARDUINO_ARCH_AVR) // For everything else than AVR use pinMode / digitalWrite

#define SHA204_SET_OUTPUT() pinMode(device_pin, OUTPUT)

#define SHA204_SET_INPUT() pinMode(device_pin, INPUT)

#define SHA204_POUT_HIGH() digitalWrite(device_pin, HIGH)

#define SHA204_POUT_LOW() digitalWrite(device_pin, LOW)

#define SHA204_PIN_READ() digitalRead(device_pin)

#else

#define SHA204_SET_INPUT()  *device_port_DDR &= ~device_pin

#define SHA204_SET_OUTPUT() *device_port_DDR |= device_pin

#define SHA204_POUT_HIGH() *device_port_OUT |= device_pin

#define SHA204_POUT_LOW() *device_port_OUT &= ~device_pin

#define SHA204_PIN_READ() (*device_port_IN & device_pin)

#endif


class atsha204Class

{

private:

    uint8_t device_pin;

#ifdef ARDUINO_ARCH_AVR

    volatile uint8_t *device_port_DDR, *device_port_OUT, *device_port_IN;

#endif

    void sha204c_calculate_crc(uint8_t length, uint8_t *data, uint8_t *crc);

    uint8_t sha204c_check_crc(uint8_t *response);

    void swi_set_signal_pin(uint8_t is_high);

    uint8_t swi_receive_bytes(uint8_t count, uint8_t *buffer);

    uint8_t swi_send_bytes(uint8_t count, uint8_t *buffer);

    uint8_t swi_send_byte(uint8_t value);

    uint8_t sha204p_receive_response(uint8_t size, uint8_t *response);

    uint8_t sha204p_wakeup();

    uint8_t sha204p_send_command(uint8_t count, uint8_t * command);

    uint8_t sha204p_sleep();

    uint8_t sha204p_resync(uint8_t size, uint8_t *response);


public:

    explicit atsha204Class(uint8_t pin);


    uint8_t sha204c_wakeup(uint8_t *response);


    uint8_t sha204c_send_and_receive(uint8_t *tx_buffer, uint8_t rx_size, uint8_t *rx_buffer,

                                     uint8_t execution_delay, uint8_t execution_timeout);


    uint8_t sha204c_resync(uint8_t size, uint8_t *response);


    uint8_t sha204m_random(uint8_t * tx_buffer, uint8_t * rx_buffer, uint8_t mode);


    uint8_t sha204m_dev_rev(uint8_t *tx_buffer, uint8_t *rx_buffer);


    uint8_t sha204m_read(uint8_t *tx_buffer, uint8_t *rx_buffer, uint8_t zone, uint16_t address);


    uint8_t sha204m_execute(uint8_t op_code, uint8_t param1, uint16_t param2,

                            uint8_t datalen1, uint8_t *data1, uint8_t datalen2, uint8_t *data2, uint8_t datalen3,

                            uint8_t *data3,

                            uint8_t tx_size, uint8_t *tx_buffer, uint8_t rx_size, uint8_t *rx_buffer);


    uint8_t sha204m_check_parameters(uint8_t op_code, uint8_t param1, uint16_t param2,

                                     uint8_t datalen1, uint8_t *data1, uint8_t datalen2, uint8_t *data2, uint8_t datalen3,

                                     uint8_t *data3,

                                     uint8_t tx_size, uint8_t *tx_buffer, uint8_t rx_size, uint8_t *rx_buffer);


    uint8_t getSerialNumber(uint8_t *response);


    uint16_t calculateAndUpdateCrc(uint8_t length, uint8_t *data, uint16_t current_crc);


};


#endif