cc_user_credential_io.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2023 Silicon Laboratories Inc. <https://www.silabs.com/>
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */

 
#ifndef CC_USER_CREDENTIAL_IO_H
#define CC_USER_CREDENTIAL_IO_H
 
#include "CC_UserCredential.h"

 
/****************************************************************************/
/*                      EXPORTED TYPES and DEFINITIONS                      */
/****************************************************************************/
 
typedef enum u3c_db_operation_result_ {
  U3C_DB_OPERATION_RESULT_SUCCESS,         
  U3C_DB_OPERATION_RESULT_ERROR,           
  U3C_DB_OPERATION_RESULT_ERROR_IO,        
  U3C_DB_OPERATION_RESULT_ERROR_DUPLICATE, 
  U3C_DB_OPERATION_RESULT_FAIL_DNE,        
  U3C_DB_OPERATION_RESULT_FAIL_FULL,       
  U3C_DB_OPERATION_RESULT_FAIL_OCCUPIED,   
  U3C_DB_OPERATION_RESULT_FAIL_REASSIGN,   
  U3C_DB_OPERATION_RESULT_FAIL_IDENTICAL   
} u3c_db_operation_result;
 
/****************************************************************************/
/*                           GENERAL API FUNCTIONS                          */
/****************************************************************************/

void CC_UserCredential_factory_reset(void);

void CC_UserCredential_init_database(void);
 
/****************************************************************************/
/*                         USER RELATED API FUNCTIONS                       */
/****************************************************************************/

u3c_db_operation_result CC_UserCredential_get_user(
  uint16_t unique_identifier,
  u3c_user_t * user,
  uint8_t * name
  );

uint16_t CC_UserCredential_get_next_user(uint16_t unique_identifier);
 
u3c_db_operation_result CC_UserCredential_add_user(
  u3c_user_t * user,
  uint8_t * name
  );

u3c_db_operation_result CC_UserCredential_modify_user(
  u3c_user_t * user,
  uint8_t * name
  );
 
u3c_db_operation_result CC_UserCredential_delete_user(
  uint16_t user_unique_identifier
  );
 
/****************************************************************************/
/*                      CREDENTIAL RELATED API FUNCTIONS                    */
/****************************************************************************/

u3c_db_operation_result CC_UserCredential_get_credential(
  uint16_t user_unique_identifier,
  u3c_credential_type credential_type,
  uint16_t credential_slot,
  u3c_credential_metadata_t * credential_metadata,
  uint8_t * credential_data
  );

bool CC_UserCredential_get_next_credential(
  uint16_t user_unique_identifier,
  u3c_credential_type credential_type,
  uint16_t credential_slot,
  u3c_credential_type * next_credential_type,
  uint16_t * next_credential_slot
  );

u3c_db_operation_result CC_UserCredential_add_credential(
  u3c_credential_t * credential
  );
 
u3c_db_operation_result CC_UserCredential_modify_credential(
  u3c_credential_t * credential
  );

u3c_db_operation_result CC_UserCredential_delete_credential(
  u3c_credential_type credential_type,
  uint16_t credential_slot
  );

u3c_db_operation_result CC_UserCredential_move_credential(
  u3c_credential_type credential_type,
  uint16_t source_credential_slot,
  uint16_t destination_user_uid,
  uint16_t destination_credential_slot
  );
 
/****************************************************************************/
/*                      ADMIN CODE RELATED API FUNCTIONS                    */
/****************************************************************************/

u3c_db_operation_result CC_UserCredential_get_admin_code_info(u3c_admin_code_metadata_t *code);

u3c_db_operation_result CC_UserCredential_set_admin_code(u3c_admin_code_metadata_t *code);

 
#endif /* CC_USER_CREDENTIAL_IO_H */