cc_user_credential_nvm.h File Reference

#include "CC_UserCredential.h"
#include "cc_user_credential_config.h"

Include dependency graph for cc_user_credential_nvm.h:

Go to the source code of this file.

Data Structures
struct	credential_metadata_nvm_t_
struct	user_descriptor_t_
struct	credential_descriptor_t_
struct	admin_pin_code_metadata_nvm_t_
	Metadata to track current admin code information. More...

Macros
#define	MAX_USER_OBJECTS
#define	MAX_CREDENTIAL_OBJECTS

Typedefs
typedef struct credential_metadata_nvm_t_	credential_metadata_nvm_t
typedef struct user_descriptor_t_	user_descriptor_t
typedef struct credential_descriptor_t_	credential_descriptor_t
typedef struct admin_pin_code_metadata_nvm_t_	admin_pin_code_metadata_nvm_t
	Metadata to track current admin code information.
typedef enum u3c_nvm_operation_	u3c_nvm_operation
typedef enum u3c_nvm_area_	u3c_nvm_area

Enumerations
enum	u3c_nvm_operation_ {   U3C_READ ,   U3C_WRITE }
enum	u3c_nvm_area_ {   AREA_NUMBER_OF_USERS ,   AREA_NUMBER_OF_CREDENTIALS ,   AREA_USER_DESCRIPTORS ,   AREA_USERS ,   AREA_USER_NAMES ,   AREA_CREDENTIAL_DESCRIPTORS ,   AREA_CREDENTIAL_METADATA ,   AREA_CREDENTIAL_DATA ,   AREA_ADMIN_PIN_CODE_DATA }

Detailed Description

Non-volatile memory implementation for Command Class User Credential I/O

Copyright

2024 Silicon Laboratories Inc.

Macro Definition Documentation

MAX_CREDENTIAL_OBJECTS

#define MAX_CREDENTIAL_OBJECTS

Value:

  ZAF_FILE_ID_CC_USER_CREDENTIAL_CREDENTIAL_LAST \
  - ZAF_FILE_ID_CC_USER_CREDENTIAL_CREDENTIAL_BASE

Maximum number of Credential and Credential Data objects that can be stored in the NVM

MAX_USER_OBJECTS

#define MAX_USER_OBJECTS

Value:

  ZAF_FILE_ID_CC_USER_CREDENTIAL_USER_LAST \
  - ZAF_FILE_ID_CC_USER_CREDENTIAL_USER_BASE

Typedef Documentation

admin_pin_code_metadata_nvm_t

typedef struct admin_pin_code_metadata_nvm_t_ admin_pin_code_metadata_nvm_t

Metadata to track current admin code information.

credential_descriptor_t

typedef struct credential_descriptor_t_ credential_descriptor_t

The Credential descriptor table is an array of associations between unique Credentials and file IDs of Credential metadata objects. A Credential is identified by its owner's User Unique ID and the Credential's type and slot. Only the entries from ZAF_FILE_ID_CC_USER_CREDENTIAL_USER_BASE to ZAF_FILE_ID_CC_USER_CREDENTIAL_USER_BASE + n_credentials - 1 are to be considered valid.

credential_metadata_nvm_t

typedef struct credential_metadata_nvm_t_ credential_metadata_nvm_t

Credential metadata object for storage in NVM.

u3c_nvm_area

typedef enum u3c_nvm_area_ u3c_nvm_area

u3c_nvm_operation

typedef enum u3c_nvm_operation_ u3c_nvm_operation

user_descriptor_t

typedef struct user_descriptor_t_ user_descriptor_t

The User descriptor table is an array of associations between User Unique IDs and file IDs of User objects. Only the entries from ZAF_FILE_ID_CC_USER_CREDENTIAL_CREDENTIAL_BASE to ZAF_FILE_ID_CC_USER_CREDENTIAL_CREDENTIAL_BASE + n_users - 1 are to be considered valid.

Enumeration Type Documentation

u3c_nvm_area_

enum u3c_nvm_area_

Enumerator
AREA_NUMBER_OF_USERS
AREA_NUMBER_OF_CREDENTIALS
AREA_USER_DESCRIPTORS
AREA_USERS
AREA_USER_NAMES
AREA_CREDENTIAL_DESCRIPTORS
AREA_CREDENTIAL_METADATA
AREA_CREDENTIAL_DATA
AREA_ADMIN_PIN_CODE_DATA

u3c_nvm_operation_

enum u3c_nvm_operation_

Enumerator
U3C_READ
U3C_WRITE