DolphinV4 API  1.6.1.0
Secure module structures and constants
Collaboration diagram for Secure module structures and constants:

Data Structures

struct  SECU_TYPE
 Security information structure. More...

Macros

#define CMAC_SUBKEY_SIZE   16
 Amount of bytes of the CMAC subkeys.
#define TEACH_IN_TYPE_MASK   0x04
#define TEACH_IN_INFO_MASK   0x03
 INFO field bit mask in teach-in info byte.
#define TEACH_IN_PSK_MASK   0x08
 PSK field bit mask in teach-in info byte.
#define TEACH_IN_TYPE_NON_SPEC   0x00
#define TEACH_IN_TYPE_PTM   0x04
 PTM type identification.
#define TEACH_IN_INFO_ROCKER_A   0x00
 PTM info first rocker.
#define TEACH_IN_INFO_ROCKER_B   0x01
 PTM info second rocker.
#define SLF_RLC_MASK   0xE0
 Rolling code new enum definition mask.
#define SLF_RLC_ALGO_MASK   0xC0
 Rolling code algorithm identification bit mask in SLF byte.
#define SLF_RLC_TX_MASK   0x20
 Rolling code send/not send bit mask in SLF byte.
#define SLF_MAC_ALGO_MASK   0x18
 Message authentication code identificator bit mask in SLF byte.
#define SLF_DATA_ENC_MASK   0x07
 Encryption identificator bit mask.
#define SLF_NO_RLC_ALGO   0x00
#define SLF_RLC_16_BIT   0x40
 16-bit rolling code identification code
#define SLF_RLC_24_BIT   0x80
 24-bit rolling code identification code
#define SLF_RLC_32_BIT   0xC0
 32bit
#define SLF_RLC_TX_NO   0x00
 Not sending rolling code in telegram identification code.
#define SLF_RLC_TX_YES   0x20
 Sending rolling code in telegram identification code.
#define SLF_MAC_NO   0x00
 No athentication in telegram identification code.
#define SLF_MAC_3_AES128   0x08
 3-byte MAC identification code
#define SLF_MAC_4_AES128   0x10
 4-byte MAC identification code
#define SLF_ENC_NO   0x00
 No encryption identification code.
#define SLF_ENC_VAES128   0x03
 Variable AES128 encryption identification code.
#define SLF_ENC_AES128   0x04
 AES128 encryption identification code.

Enumerations

enum  SEC_RESULT { SEC_OK = 0, SEC_RLC_OUT_OF_RANGE, SEC_SIZE_WRONG, SEC_CMAC_WRONG, SEC_CHOICE_WRONG, SEC_ENC_WRONG, SEC_SLF_WRONG, SEC_PSK_WRONG }
 Return values for the security module function. More...

Detailed Description

Data structures and constant values that are used in SECURITY module


Macro Definition Documentation

#define TEACH_IN_TYPE_MASK   0x04

Teach-in info byte bit masks TYPE field bit mask in teach-in info byte

#define TEACH_IN_TYPE_NON_SPEC   0x00

Teach-in info byte fields values Non-specific type identification

#define SLF_NO_RLC_ALGO   0x00

SLF byte fields values No rolling code identification code


Enumeration Type Documentation

enum SEC_RESULT

Return values for the security module function.

Enumerator:
SEC_OK 

function correctly executed.

SEC_RLC_OUT_OF_RANGE 

Received rolling code out of range.

SEC_SIZE_WRONG 

One of the parameters had a not permitted amount of bytes.

SEC_CMAC_WRONG 

Received and expected CMAC do not match.

SEC_CHOICE_WRONG 

Message choice not valid.

SEC_ENC_WRONG 

Encryption method code in SLF byte not allowed.

SEC_SLF_WRONG 

Not valid SLF code.

SEC_PSK_WRONG 

PSK Key Missing.