EVE 1.0
TOC
Collaboration diagram for TOC:

Data Structures

struct  min_max_t
 minimal and maximal possible values for the INTEGER parameters. More...
 
struct  toc_t
 Applikasjon-spesifikk parameter beskrivelse. More...
 
struct  toc_blob_t
 
struct  toc_file_context_t
 
struct  toc_service_t
 

Macros

#define TOC_SYSTEM_SEGMENT_DESCRIPTORS()
 System TOC segments definition.
 
#define BIND_SEGMENT(type, tag)
 The utility macro binds a segment structure "type" with tag "tag". See toc-instance.h for defails.
 
#define TOC_ACL_PUBLIC   (0)
 
#define TOC_ACL_PROTECTED   (1)
 
#define TOC_ACL_PRIVATE   (2)
 
#define TOC_ACL_DENIED   (3)
 
#define TOC_POLICY_PRE_CB   (1 << 0)
 
#define TOC_POLICY_POST_CB   (1 << 1)
 
#define TOC_FLAG_ACL(x)    (((x) & 3) << 0)
 
#define TOC_FLAG_READ_POLICY(x)    (((x) & 3) << 2)
 
#define TOC_FLAG_WRITE_POLICY(x)    (((x) & 3) << 4)
 
#define TOC_FLAG_READ   (1 << 6)
 
#define TOC_FLAG_WRITE   (1 << 7)
 
#define TOC_FLAG_BINARY   (1 << 8)
 
#define TOC_FLAG_VIRTUAL   (1 << 9)
 
#define TOC_FLAG_EXTERN_LIMITS   (1 << 10)
 
#define TOC_FLAG_V_SIZE   (1 << 11)
 
#define TOC_FLAG_BLE_BROADCAST   (1 << 13)
 
#define TOC_FLAG_BLE_NOTIFICATION   (1 << 14)
 
#define TOC_FLAG_BLE_INDICATION   (1 << 15)
 
#define TOC_POLICY_MASK   (3)
 
#define TOC_FLAG_ACL_MASK   TOC_FLAG_ACL(3)
 
#define TOC_FLAG_READ_POLICY_MASK   TOC_FLAG_READ_POLICY(3)
 
#define TOC_FLAG_WRITE_POLICY_MASK   TOC_FLAG_WRITE_POLICY(3)
 

Enumerations

Functions

void TocGetMinMax (const struct toc_blob_t *Ptr, const struct toc_t *Var, struct min_max_t *MinMax)
 
void TocAppGetToc (struct toc_blob_t *Ptr)
 Gir "table of content" (TOC). More...
 

Variables

struct toc_data_t TocData
 
union toc_command_t TocCommand
 
const struct toc_services_t TocServices
 

Detailed Description

Macro Definition Documentation

#define TOC_ACL_PUBLIC   (0)

The paramater is visible for everyone

Definition at line 112 of file toc-app.h.

#define TOC_ACL_PROTECTED   (1)

The paramater is visible for a super user

Definition at line 113 of file toc-app.h.

#define TOC_ACL_PRIVATE   (2)

The paramater is visible in debug mode only

Definition at line 114 of file toc-app.h.

#define TOC_ACL_DENIED   (3)

The paramater is not visible

Definition at line 115 of file toc-app.h.

#define TOC_POLICY_PRE_CB   (1 << 0)

A callback to be called before the paramater access

Definition at line 117 of file toc-app.h.

#define TOC_POLICY_POST_CB   (1 << 1)

A callback to be called after the paramater access

Definition at line 118 of file toc-app.h.

#define TOC_FLAG_ACL (   x)    (((x) & 3) << 0)

Access control flags, see TOC_ACL_...

Definition at line 120 of file toc-app.h.

#define TOC_FLAG_READ_POLICY (   x)    (((x) & 3) << 2)

Read policy, see TOC_POLICY_...

Definition at line 121 of file toc-app.h.

#define TOC_FLAG_WRITE_POLICY (   x)    (((x) & 3) << 4)

Write policy, see TOC_POLICY_...

Definition at line 122 of file toc-app.h.

#define TOC_FLAG_READ   (1 << 6)

The parameter is readable

Definition at line 123 of file toc-app.h.

#define TOC_FLAG_WRITE   (1 << 7)

The parameter is writeable

Definition at line 124 of file toc-app.h.

#define TOC_FLAG_BINARY   (1 << 8)

The STRING parameter contains binary data

Definition at line 126 of file toc-app.h.

#define TOC_FLAG_VIRTUAL   (1 << 9)

The parameter is a virtual array

Definition at line 127 of file toc-app.h.

Referenced by JsonTocIsArray().

#define TOC_FLAG_EXTERN_LIMITS   (1 << 10)

Min and Max contain offsets to real uint32_t limits in a pool

Definition at line 128 of file toc-app.h.

#define TOC_FLAG_V_SIZE   (1 << 11)

The parameter has variable size

Definition at line 129 of file toc-app.h.

#define TOC_FLAG_BLE_BROADCAST   (1 << 13)

BLE should allow broadcast for the parameter

Definition at line 131 of file toc-app.h.

#define TOC_FLAG_BLE_NOTIFICATION   (1 << 14)

BLE should allow notification for the parameter

Definition at line 132 of file toc-app.h.

#define TOC_FLAG_BLE_INDICATION   (1 << 15)

BLE should allow indication for the parameter

Definition at line 133 of file toc-app.h.

#define TOC_POLICY_MASK   (3)

Policy type mask

Definition at line 135 of file toc-app.h.

#define TOC_FLAG_ACL_MASK   TOC_FLAG_ACL(3)

ACL flags mask

Definition at line 136 of file toc-app.h.

#define TOC_FLAG_READ_POLICY_MASK   TOC_FLAG_READ_POLICY(3)

Read policy mask

Definition at line 137 of file toc-app.h.

#define TOC_FLAG_WRITE_POLICY_MASK   TOC_FLAG_WRITE_POLICY(3)

Write policy mask

Definition at line 138 of file toc-app.h.

Enumeration Type Documentation

The enum defines type of a generic value.

Enumerator
TOC_VAL_TYPE_STRING 

The value is a string variable

TOC_VAL_TYPE_INT 

The value is a 32-bit integer

TOC_VAL_TYPE_BOOL 

The value is a Boolean variable

TOC_VAL_TYPE_STRUCT 

The value is a structure

TOC_VAL_TYPE_SERVICE 

BLE service descriptor

TOC_VAL_TYPE_UNKNOWN 

Reserved

Definition at line 93 of file toc-app.h.

System part of segment types

User code may extend the segments with own ones.

Definition at line 52 of file types.h.

Function Documentation

void TocGetMinMax ( const struct toc_blob_t Ptr,
const struct toc_t Var,
struct min_max_t MinMax 
)

Get minimal and maximal values for the parameter

void TocAppGetToc ( struct toc_blob_t Ptr)

Gir "table of content" (TOC).

Tabellen definerer de parameterene applikasjon kan kontrollere. TOC aldri skrives noe i tabellen, så den kan ligge i flash minne.

Parameters
Ptrapplikasjonen må settes (*TocPtr) pekeren på TOC-tabel

Variable Documentation

struct toc_data_t TocData

user-defined RAM segment

union toc_command_t TocCommand

user-defined command segment

const struct toc_services_t TocServices

user-defined services segment