Contiki-NG

Header file for the cc2538 PKA engine driver. More...

#include "contiki.h"
#include <stdint.h>

Go to the source code of this file.

Macros

PKA memory
#define PKA_RAM_BASE   0x44006000
 PKA Memory Address.
 
#define PKA_RAM_SIZE   0x800
 PKA Memory Size.
 
#define PKA_MAX_CURVE_SIZE   12
 Define for the maximum curve size supported by the PKA module in 32 bit word. More...
 
#define PKA_MAX_LEN   12
 Define for the maximum length of the big number supported by the PKA module in 32 bit word. More...
 
PKA register offsets
#define PKA_APTR   0x44004000
 PKA vector A address During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_BPTR   0x44004004
 PKA vector B address During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_CPTR   0x44004008
 PKA vector C address During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_DPTR   0x4400400C
 PKA vector D address During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_ALENGTH   0x44004010
 PKA vector A length During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_BLENGTH   0x44004014
 PKA vector B length During execution of basic PKCP operations, this register is double buffered and can be written with a new value for the next operation; when not written, the value remains intact. More...
 
#define PKA_SHIFT   0x44004018
 PKA bit shift value For basic PKCP operations, modifying the contents of this register is made impossible while the operation is being performed. More...
 
#define PKA_FUNCTION   0x4400401C
 PKA function This register contains the control bits to start basic PKCP as well as complex sequencer operations. More...
 
#define PKA_COMPARE   0x44004020
 PKA compare result This register provides the result of a basic PKCP compare operation. More...
 
#define PKA_MSW   0x44004024
 PKA most-significant-word of result vector This register indicates the (word) address in the PKA RAM where the most significant nonzero 32-bit word of the result is stored. More...
 
#define PKA_DIVMSW   0x44004028
 PKA most-significant-word of divide remainder This register indicates the (32-bit word) address in the PKA RAM where the most significant nonzero 32-bit word of the remainder result for the basic divide and modulo operations is stored. More...
 
#define PKA_SEQ_CTRL   0x440040C8
 PKA sequencer control and status register The sequencer is interfaced with the outside world through a single control and status register. More...
 
#define PKA_OPTIONS   0x440040F4
 PKA hardware options register This register provides the host with a means to determine the hardware configuration implemented in this PKA engine, focused on options that have an effect on software interacting with the module. More...
 
#define PKA_SW_REV   0x440040F8
 PKA firmware revision and capabilities register This register allows the host access to the internal firmware revision number of the PKA Engine for software driver matching and diagnostic purposes. More...
 
#define PKA_REVISION   0x440040FC
 PKA hardware revision register This register allows the host access to the hardware revision number of the PKA engine for software driver matching and diagnostic purposes. More...
 
PKA_APTR register registers bit fields
#define PKA_APTR_APTR_M   0x000007FF
 This register specifies the location of vector A within the PKA RAM. More...
 
#define PKA_APTR_APTR_S   0
 
PKA_BPTR register registers bit fields
#define PKA_BPTR_BPTR_M   0x000007FF
 This register specifies the location of vector B within the PKA RAM. More...
 
#define PKA_BPTR_BPTR_S   0
 
PKA_CPTR register registers bit fields
#define PKA_CPTR_CPTR_M   0x000007FF
 This register specifies the location of vector C within the PKA RAM. More...
 
#define PKA_CPTR_CPTR_S   0
 
PKA_DPTR register registers bit fields
#define PKA_DPTR_DPTR_M   0x000007FF
 This register specifies the location of vector D within the PKA RAM. More...
 
#define PKA_DPTR_DPTR_S   0
 
PKA_ALENGTH register registers bit fields
#define PKA_ALENGTH_ALENGTH_M   0x000001FF
 This register specifies the length (in 32-bit words) of Vector A. More...
 
#define PKA_ALENGTH_ALENGTH_S   0
 
PKA_BLENGTH register registers bit fields
#define PKA_BLENGTH_BLENGTH_M   0x000001FF
 This register specifies the length (in 32-bit words) of Vector B. More...
 
#define PKA_BLENGTH_BLENGTH_S   0
 
PKA_SHIFT register registers bit fields
#define PKA_SHIFT_NUM_BITS_TO_SHIFT_M   0x0000001F
 This register specifies the number of bits to shift the input vector (in the range 0-31) during a Rshift or Lshift operation. More...
 
#define PKA_SHIFT_NUM_BITS_TO_SHIFT_S   0
 
PKA_FUNCTION register registers bit fields
#define PKA_FUNCTION_STALL_RESULT   0x01000000
 When written with a 1b, updating of the PKA_COMPARE, PKA_MSW and PKA_DIVMSW registers, as well as resetting the run bit is stalled beyond the point that a running operation is actually finished. More...
 
#define PKA_FUNCTION_STALL_RESULT_M   0x01000000
 
#define PKA_FUNCTION_STALL_RESULT_S   24
 
#define PKA_FUNCTION_RUN   0x00008000
 The host sets this bit to instruct the PKA module to begin processing the basic PKCP or complex sequencer operation. More...
 
#define PKA_FUNCTION_RUN_M   0x00008000
 
#define PKA_FUNCTION_RUN_S   15
 
#define PKA_FUNCTION_SEQUENCER_OPERATIONS_M   0x00007000
 These bits select the complex sequencer operation to perform: 000b: None 001b: ExpMod-CRT 010b: ExpMod-ACT4 (compatible with EIP2315) 011b: ECC-ADD (if available in firmware, otherwise reserved) 100b: ExpMod-ACT2 (compatible with EIP2316) 101b: ECC-MUL (if available in firmware, otherwise reserved) 110b: ExpMod-variable 111b: ModInv (if available in firmware, otherwise reserved) The encoding of these operations is determined by sequencer firmware. More...
 
#define PKA_FUNCTION_SEQUENCER_OPERATIONS_S   12
 
#define PKA_FUNCTION_COPY   0x00000800
 Perform copy operation.
 
#define PKA_FUNCTION_COPY_M   0x00000800
 
#define PKA_FUNCTION_COPY_S   11
 
#define PKA_FUNCTION_COMPARE   0x00000400
 Perform compare operation.
 
#define PKA_FUNCTION_COMPARE_M   0x00000400
 
#define PKA_FUNCTION_COMPARE_S   10
 
#define PKA_FUNCTION_MODULO   0x00000200
 Perform modulo operation.
 
#define PKA_FUNCTION_MODULO_M   0x00000200
 
#define PKA_FUNCTION_MODULO_S   9
 
#define PKA_FUNCTION_DIVIDE   0x00000100
 Perform divide operation.
 
#define PKA_FUNCTION_DIVIDE_M   0x00000100
 
#define PKA_FUNCTION_DIVIDE_S   8
 
#define PKA_FUNCTION_LSHIFT   0x00000080
 Perform left shift operation.
 
#define PKA_FUNCTION_LSHIFT_M   0x00000080
 
#define PKA_FUNCTION_LSHIFT_S   7
 
#define PKA_FUNCTION_RSHIFT   0x00000040
 Perform right shift operation.
 
#define PKA_FUNCTION_RSHIFT_M   0x00000040
 
#define PKA_FUNCTION_RSHIFT_S   6
 
#define PKA_FUNCTION_SUBTRACT   0x00000020
 Perform subtract operation.
 
#define PKA_FUNCTION_SUBTRACT_M   0x00000020
 
#define PKA_FUNCTION_SUBTRACT_S   5
 
#define PKA_FUNCTION_ADD   0x00000010
 Perform add operation.
 
#define PKA_FUNCTION_ADD_M   0x00000010
 
#define PKA_FUNCTION_ADD_S   4
 
#define PKA_FUNCTION_MS_ONE   0x00000008
 Loads the location of the Most Significant one bit within the result word indicated in the PKA_MSW register into bits [4:0] of the PKA_DIVMSW register - can only be used with basic PKCP operations, except for Divide, Modulo and Compare. More...
 
#define PKA_FUNCTION_MS_ONE_M   0x00000008
 
#define PKA_FUNCTION_MS_ONE_S   3
 
#define PKA_FUNCTION_ADDSUB   0x00000002
 Perform combined add/subtract operation.
 
#define PKA_FUNCTION_ADDSUB_M   0x00000002
 
#define PKA_FUNCTION_ADDSUB_S   1
 
#define PKA_FUNCTION_MULTIPLY   0x00000001
 Perform multiply operation.
 
#define PKA_FUNCTION_MULTIPLY_M   0x00000001
 
#define PKA_FUNCTION_MULTIPLY_S   0
 
PKA_COMPARE register registers bit fields
#define PKA_COMPARE_A_GREATER_THAN_B   0x00000004
 Vector_A is greater than Vector_B.
 
#define PKA_COMPARE_A_GREATER_THAN_B_M   0x00000004
 
#define PKA_COMPARE_A_GREATER_THAN_B_S   2
 
#define PKA_COMPARE_A_LESS_THAN_B   0x00000002
 Vector_A is less than Vector_B.
 
#define PKA_COMPARE_A_LESS_THAN_B_M   0x00000002
 
#define PKA_COMPARE_A_LESS_THAN_B_S   1
 
#define PKA_COMPARE_A_EQUALS_B   0x00000001
 Vector_A is equal to Vector_B.
 
#define PKA_COMPARE_A_EQUALS_B_M   0x00000001
 
#define PKA_COMPARE_A_EQUALS_B_S   0
 
PKA_MSW register registers bit fields
#define PKA_MSW_RESULT_IS_ZERO   0x00008000
 The result vector is all zeroes, ignore the address returned in bits [10:0].
 
#define PKA_MSW_RESULT_IS_ZERO_M   0x00008000
 
#define PKA_MSW_RESULT_IS_ZERO_S   15
 
#define PKA_MSW_MSW_ADDRESS_M   0x000007FF
 Address of the most-significant nonzero 32-bit word of the result vector in PKA RAM.
 
#define PKA_MSW_MSW_ADDRESS_S   0
 
PKA_DIVMSW register registers bit fields
#define PKA_DIVMSW_RESULT_IS_ZERO   0x00008000
 The result vector is all zeroes, ignore the address returned in bits [10:0].
 
#define PKA_DIVMSW_RESULT_IS_ZERO_M   0x00008000
 
#define PKA_DIVMSW_RESULT_IS_ZERO_S   15
 
#define PKA_DIVMSW_MSW_ADDRESS_M   0x000007FF
 Address of the most significant nonzero 32-bit word of the remainder result vector in PKA RAM.
 
#define PKA_DIVMSW_MSW_ADDRESS_S   0
 
PKA_SEQ_CTRL register registers bit fields
#define PKA_SEQ_CTRL_RESET   0x80000000
 Option program ROM: Reset value = 0. More...
 
#define PKA_SEQ_CTRL_RESET_M   0x80000000
 
#define PKA_SEQ_CTRL_RESET_S   31
 
#define PKA_SEQ_CTRL_SEQUENCER_STATUS_M   0x0000FF00
 These read-only bits can be used by the sequencer to communicate status to the outside world. More...
 
#define PKA_SEQ_CTRL_SEQUENCER_STATUS_S   8
 
#define PKA_SEQ_CTRL_SW_CONTROL_STATUS_M   0x000000FF
 These bits can be used by software to trigger sequencer operations. More...
 
#define PKA_SEQ_CTRL_SW_CONTROL_STATUS_S   0
 
PKA_OPTIONS register registers bit fields
#define PKA_OPTIONS_FIRST_LNME_FIFO_DEPTH_M   0xFF000000
 Number of words in the first LNME's FIFO RAM Should be ignored if LNME configuration is 0. More...
 
#define PKA_OPTIONS_FIRST_LNME_FIFO_DEPTH_S   24
 
#define PKA_OPTIONS_FIRST_LNME_NR_OF_PES_M   0x003F0000
 Number of processing elements in the pipeline of the first LNME Should be ignored if LNME configuration is 0. More...
 
#define PKA_OPTIONS_FIRST_LNME_NR_OF_PES_S   16
 
#define PKA_OPTIONS_MMM3A   0x00001000
 Reserved for a future functional extension to the LNME Always 0b.
 
#define PKA_OPTIONS_MMM3A_M   0x00001000
 
#define PKA_OPTIONS_MMM3A_S   12
 
#define PKA_OPTIONS_INT_MASKING   0x00000800
 Value 0b indicates that the main interrupt output (bit [1] of the interrupts output bus) is the direct complement of the run bit in the PKA_CONTROL register, value 1b indicates that interrupt masking logic is present for this output. More...
 
#define PKA_OPTIONS_INT_MASKING_M   0x00000800
 
#define PKA_OPTIONS_INT_MASKING_S   11
 
#define PKA_OPTIONS_PROTECTION_OPTION_M   0x00000700
 Value 0 indicates no additional protection against side channel attacks, value 1 indicates the SCAP option, value 3 indicates the PROT option; other values are reserved. More...
 
#define PKA_OPTIONS_PROTECTION_OPTION_S   8
 
#define PKA_OPTIONS_PROGRAM_RAM   0x00000080
 Value 1b indicates sequencer program storage in RAM, value 0b in ROM. More...
 
#define PKA_OPTIONS_PROGRAM_RAM_M   0x00000080
 
#define PKA_OPTIONS_PROGRAM_RAM_S   7
 
#define PKA_OPTIONS_SEQUENCER_CONFIGURATION_M   0x00000060
 Value 1 indicates a standard sequencer; other values are reserved. More...
 
#define PKA_OPTIONS_SEQUENCER_CONFIGURATION_S   5
 
#define PKA_OPTIONS_LNME_CONFIGURATION_M   0x0000001C
 Value 0 indicates NO LNME, value 1 indicates one standard LNME (with alpha = 32, beta = 8); other values reserved. More...
 
#define PKA_OPTIONS_LNME_CONFIGURATION_S   2
 
#define PKA_OPTIONS_PKCP_CONFIGURATION_M   0x00000003
 Value 1 indicates a PKCP with a 16x16 multiplier, value 2 indicates a PKCP with a 32x32 multiplier, other values reserved. More...
 
#define PKA_OPTIONS_PKCP_CONFIGURATION_S   0
 
PKA_SW_REV register registers bit fields
#define PKA_SW_REV_FW_CAPABILITIES_M   0xF0000000
 4-bit binary encoding for the functionality implemented in the firmware. More...
 
#define PKA_SW_REV_FW_CAPABILITIES_S   28
 
#define PKA_SW_REV_MAJOR_FW_REVISION_M   0x0F000000
 4-bit binary encoding of the major firmware revision number
 
#define PKA_SW_REV_MAJOR_FW_REVISION_S   24
 
#define PKA_SW_REV_MINOR_FW_REVISION_M   0x00F00000
 4-bit binary encoding of the minor firmware revision number
 
#define PKA_SW_REV_MINOR_FW_REVISION_S   20
 
#define PKA_SW_REV_FW_PATCH_LEVEL_M   0x000F0000
 4-bit binary encoding of the firmware patch level, initial release will carry value zero Patches are used to remove bugs without changing the functionality or interface of a module. More...
 
#define PKA_SW_REV_FW_PATCH_LEVEL_S   16
 
PKA_REVISION register registers bit fields
#define PKA_REVISION_MAJOR_HW_REVISION_M   0x0F000000
 4-bit binary encoding of the major hardware revision number
 
#define PKA_REVISION_MAJOR_HW_REVISION_S   24
 
#define PKA_REVISION_MINOR_HW_REVISION_M   0x00F00000
 4-bit binary encoding of the minor hardware revision number
 
#define PKA_REVISION_MINOR_HW_REVISION_S   20
 
#define PKA_REVISION_HW_PATCH_LEVEL_M   0x000F0000
 4-bit binary encoding of the hardware patch level, initial release will carry value zero Patches are used to remove bugs without changing the functionality or interface of a module. More...
 
#define PKA_REVISION_HW_PATCH_LEVEL_S   16
 
#define PKA_REVISION_COMPLEMENT_OF_BASIC_EIP_NUMBER_M   0x0000FF00
 Bit-by-bit logic complement of bits [7:0], EIP-28 gives 0xE3.
 
#define PKA_REVISION_COMPLEMENT_OF_BASIC_EIP_NUMBER_S   8
 
#define PKA_REVISION_BASIC_EIP_NUMBER_M   0x000000FF
 8-bit binary encoding of the EIP number, EIP-28 gives 0x1C
 
#define PKA_REVISION_BASIC_EIP_NUMBER_S   0
 
PKA driver return codes
#define PKA_STATUS_SUCCESS   0
 Success.
 
#define PKA_STATUS_FAILURE   1
 Failure.
 
#define PKA_STATUS_INVALID_PARAM   2
 Invalid parameter.
 
#define PKA_STATUS_BUF_UNDERFLOW   3
 Buffer underflow.
 
#define PKA_STATUS_RESULT_0   4
 Result is all zeros.
 
#define PKA_STATUS_A_GR_B   5
 Big number compare return status if the first big num is greater than the second. More...
 
#define PKA_STATUS_A_LT_B   6
 Big number compare return status if the first big num is less than the second. More...
 
#define PKA_STATUS_OPERATION_INPRG   7
 PKA operation is in progress. More...
 
#define PKA_STATUS_OPERATION_NOT_INPRG   8
 No PKA operation is in progress. More...
 
#define PKA_STATUS_SIGNATURE_INVALID   9
 Signature is invalid. More...
 

Functions

PKA functions
void pka_init (void)
 Enables and resets the PKA engine.
 
void pka_enable (void)
 Enables the PKA engine.
 
void pka_disable (void)
 Disables the PKA engine. More...
 
uint8_t pka_check_status (void)
 Checks the status of the PKA engine operation. More...
 
void pka_register_process_notification (struct process *p)
 Registers a process to be notified of the completion of a PKA operation. More...
 

Detailed Description

Header file for the cc2538 PKA engine driver.

Definition in file pka.h.