Macros

#define CURRENT_STACK_TOKEN_VERSION
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...

Convenience Macros

The following convenience macros are used to simplify the definition process for commonly specified parameters to the basic TOKEN_DEF macro. See hal/micro/token.h for a more detailed explanation.

#define DEFINE_BASIC_TOKEN (name, type, ...)
#define DEFINE_BASIC_TOKEN (name, type, ...)
#define DEFINE_COUNTER_TOKEN (name, type, ...)
#define DEFINE_COUNTER_TOKEN (name, type, ...)
#define DEFINE_INDEXED_TOKEN (name, type, arraysize, ...)
#define DEFINE_INDEXED_TOKEN (name, type, arraysize, ...)
#define DEFINE_FIXED_BASIC_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_BASIC_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_COUNTER_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_COUNTER_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_INDEXED_TOKEN (name, type, arraysize, address, ...)
#define DEFINE_FIXED_INDEXED_TOKEN (name, type, arraysize, address, ...)

Creator Codes

The CREATOR is used as a distinct identifier tag for the token.

The CREATOR is necessary because the token name is defined differently depending on the hardware platform. Therefore, the CREATOR ensures that token definitions and data stay tagged and known. The only requirement is that each creator definition must be unique. See hal/micro/token.h for a more detailed explanation.

#define CREATOR_STACK_NVDATA_VERSION
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_NVDATA_VERSION
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_ANALYSIS_REBOOT
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_ANALYSIS_REBOOT
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_NODE_DATA
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_NODE_DATA
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_SECURITY_KEY
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_SECURITY_KEY
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_NONCE_COUNTER
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_NONCE_COUNTER
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_CHILD_TABLE
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_CHILD_TABLE
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_LAST_ASSIGNED_ID
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_LAST_ASSIGNED_ID
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_BOOT_COUNTER
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CREATOR_STACK_BOOT_COUNTER
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CURRENT_STACK_TOKEN_VERSION
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...
#define CURRENT_STACK_TOKEN_VERSION
The current version number of the stack tokens. MSB is the version. LSB is a complement. More...

Convenience Macros

The following convenience macros are used to simplify the definition process for commonly specified parameters to the basic TOKEN_DEF macro. See hal/micro/token.h for a more detailed explanation.

#define DEFINE_BASIC_TOKEN (name, type, ...)
#define DEFINE_COUNTER_TOKEN (name, type, ...)
#define DEFINE_INDEXED_TOKEN (name, type, arraysize, ...)
#define DEFINE_FIXED_BASIC_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_COUNTER_TOKEN (name, type, address, ...)
#define DEFINE_FIXED_INDEXED_TOKEN (name, type, arraysize, address, ...)

Creator Codes

The CREATOR is used as a distinct identifier tag for the token.

The CREATOR is necessary because the token name is defined differently depending on the hardware platform. Therefore, the CREATOR ensures that token definitions and data stay tagged and known. The only requirement is that each creator definition must be unique. See hal/micro/token.h for a more detailed explanation.

#define CREATOR_STACK_NVDATA_VERSION
#define CREATOR_STACK_ANALYSIS_REBOOT
#define CREATOR_STACK_NODE_DATA
#define CREATOR_STACK_SECURITY_KEY
#define CREATOR_STACK_NONCE_COUNTER
#define CREATOR_STACK_CHILD_TABLE
#define CREATOR_STACK_LAST_ASSIGNED_ID
#define CREATOR_STACK_BOOT_COUNTER

Detailed Description

The tokens listed here are divided into three sections (the three main types of tokens mentioned in token.h):

  • manufacturing
  • stack
  • application

For a full explanation of the tokens, see hal/micro/token.h . See token-stack.h for source code.

A set of tokens is predefined in the APPLICATION DATA section at the end of token-stack.h because these tokens are required by the stack. They are classified as application tokens since they are sized by the application via its CONFIGURATION_HEADER.

The user application can include its own tokens in a header file similar to this one. The macro ::APPLICATION_TOKEN_HEADER should be defined to equal the name of the header file in which the application tokens are defined. See the APPLICATION DATA section at the end of token-stack.h for examples of token definitions.

Since token-stack.h contains both the typedefs and the token defs, two #defines are used to select which one is needed when this file is included. #define DEFINETYPES is used to select the type definitions and #define DEFINETOKENS is used to select the token definitions. See token.h and token.c to see how these are used.

Macro Definition Documentation

#define CREATOR_STACK_ANALYSIS_REBOOT

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 202 of file cortexm3/token.h .

#define CREATOR_STACK_ANALYSIS_REBOOT

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 202 of file cortexm3/token.h .

#define CREATOR_STACK_ANALYSIS_REBOOT

Definition at line 124 of file token-stack.h .

#define CREATOR_STACK_BOOT_COUNTER

Definition at line 130 of file token-stack.h .

#define CREATOR_STACK_BOOT_COUNTER

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 208 of file cortexm3/token.h .

#define CREATOR_STACK_BOOT_COUNTER

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 208 of file cortexm3/token.h .

#define CREATOR_STACK_CHILD_TABLE

Definition at line 128 of file token-stack.h .

#define CREATOR_STACK_CHILD_TABLE

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 206 of file cortexm3/token.h .

#define CREATOR_STACK_CHILD_TABLE

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 206 of file cortexm3/token.h .

#define CREATOR_STACK_LAST_ASSIGNED_ID

Definition at line 129 of file token-stack.h .

#define CREATOR_STACK_LAST_ASSIGNED_ID

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 207 of file cortexm3/token.h .

#define CREATOR_STACK_LAST_ASSIGNED_ID

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 207 of file cortexm3/token.h .

#define CREATOR_STACK_NODE_DATA

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 203 of file cortexm3/token.h .

#define CREATOR_STACK_NODE_DATA

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 203 of file cortexm3/token.h .

#define CREATOR_STACK_NODE_DATA

Definition at line 125 of file token-stack.h .

#define CREATOR_STACK_NONCE_COUNTER

Definition at line 127 of file token-stack.h .

#define CREATOR_STACK_NONCE_COUNTER

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 205 of file cortexm3/token.h .

#define CREATOR_STACK_NONCE_COUNTER

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 205 of file cortexm3/token.h .

#define CREATOR_STACK_NVDATA_VERSION

Definition at line 123 of file token-stack.h .

#define CREATOR_STACK_NVDATA_VERSION

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 201 of file cortexm3/token.h .

#define CREATOR_STACK_NVDATA_VERSION

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 201 of file cortexm3/token.h .

#define CREATOR_STACK_SECURITY_KEY

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 204 of file cortexm3/token.h .

#define CREATOR_STACK_SECURITY_KEY

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 204 of file cortexm3/token.h .

#define CREATOR_STACK_SECURITY_KEY

Definition at line 126 of file token-stack.h .

#define CURRENT_STACK_TOKEN_VERSION

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 156 of file token-stack.h .

#define CURRENT_STACK_TOKEN_VERSION

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 234 of file cortexm3/token.h .

#define CURRENT_STACK_TOKEN_VERSION

The current version number of the stack tokens. MSB is the version. LSB is a complement.

See hal/micro/token.h for a more complete explanation.

Definition at line 234 of file cortexm3/token.h .

#define DEFINE_BASIC_TOKEN ( name,
type,
...
)

Definition at line 156 of file cortexm3/token.h .

#define DEFINE_BASIC_TOKEN ( name,
type,
...
)

Definition at line 156 of file cortexm3/token.h .

#define DEFINE_BASIC_TOKEN ( name,
type,
...
)

Definition at line 78 of file token-stack.h .

#define DEFINE_COUNTER_TOKEN ( name,
type,
...
)

Definition at line 81 of file token-stack.h .

#define DEFINE_COUNTER_TOKEN ( name,
type,
...
)

Definition at line 159 of file cortexm3/token.h .

#define DEFINE_COUNTER_TOKEN ( name,
type,
...
)

Definition at line 159 of file cortexm3/token.h .

#define DEFINE_FIXED_BASIC_TOKEN ( name,
type,
address,
...
)

Definition at line 87 of file token-stack.h .

#define DEFINE_FIXED_BASIC_TOKEN ( name,
type,
address,
...
)

Definition at line 165 of file cortexm3/token.h .

#define DEFINE_FIXED_BASIC_TOKEN ( name,
type,
address,
...
)

Definition at line 165 of file cortexm3/token.h .

#define DEFINE_FIXED_COUNTER_TOKEN ( name,
type,
address,
...
)

Definition at line 169 of file cortexm3/token.h .

#define DEFINE_FIXED_COUNTER_TOKEN ( name,
type,
address,
...
)

Definition at line 169 of file cortexm3/token.h .

#define DEFINE_FIXED_COUNTER_TOKEN ( name,
type,
address,
...
)

Definition at line 91 of file token-stack.h .

#define DEFINE_FIXED_INDEXED_TOKEN ( name,
type,
arraysize,
address,
...
)

Definition at line 173 of file cortexm3/token.h .

#define DEFINE_FIXED_INDEXED_TOKEN ( name,
type,
arraysize,
address,
...
)

Definition at line 173 of file cortexm3/token.h .

#define DEFINE_FIXED_INDEXED_TOKEN ( name,
type,
arraysize,
address,
...
)

Definition at line 95 of file token-stack.h .

#define DEFINE_INDEXED_TOKEN ( name,
type,
arraysize,
...
)

Definition at line 162 of file cortexm3/token.h .

#define DEFINE_INDEXED_TOKEN ( name,
type,
arraysize,
...
)

Definition at line 84 of file token-stack.h .

#define DEFINE_INDEXED_TOKEN ( name,
type,
arraysize,
...
)

Definition at line 162 of file cortexm3/token.h .