cc_user_credential_tx.h

Go to the documentation of this file.

 
#ifndef CC_USER_CREDENTIAL_TX_H
#define CC_USER_CREDENTIAL_TX_H
 
/****************************************************************************/
/*                              INCLUDE FILES                               */
/****************************************************************************/
 
#include "CC_UserCredential.h"
#include "cc_user_credential_tx.h"
 
/****************************************************************************/
/*                          CONSTANTS and TYPEDEFS                          */
/****************************************************************************/
 
#define CREDENTIAL_USAGE_MAX_ITEMS CREDENTIAL_RULE_TRIPLE
 
#define CREDENTIAL_USAGE_DATA_MAX_SIZE (                                       \
    sizeof(uuid) + sizeof(credential_count)                                    \
    + (CREDENTIAL_USAGE_MAX_ITEMS * (1 + sizeof(p_credential_metadata->slot))) \
    )
 
typedef void (*u3c_credential_report_tx_callback_t)(
  const u3c_credential_report_type_t report_type,
  const u3c_credential_t * const p_credential,
  const u3c_credential_type next_credential_type,
  const uint16_t next_credential_slot,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
/****************************************************************************/
/*                              API FUNCTIONS                               */
/****************************************************************************/
 
bool is_rx_frame_initiated_locally(const RECEIVE_OPTIONS_TYPE_EX * p_rx_options);
 
void fill_rx_frame_with_local(RECEIVE_OPTIONS_TYPE_EX * p_rx_options);
 
void CC_UserCredential_UserReport_tx(
  const u3c_user_report_type_t report_type,
  const u3c_user_t * const p_user,
  const uint8_t * const p_name,
  const uint16_t next_uuid,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
void CC_UserCredential_CredentialReport_tx(
  const u3c_credential_report_type_t report_type,
  const u3c_credential_t * p_credential,
  const u3c_credential_type next_credential_type,
  const uint16_t next_credential_slot,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
void CC_UserCredential_AdminCodeReport_tx(
  const u3c_admin_code_metadata_t * const data,
  RECEIVE_OPTIONS_TYPE_EX * rx_options
  );
 
void CC_UserCredential_AllUsersChecksumReport_tx(
  uint16_t checksum,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
void CC_UserCredential_UserChecksumReport_tx(
  uint16_t uuid,
  uint16_t checksum,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
void CC_UserCredential_CredentialChecksumReport_tx(
  u3c_credential_type type,
  uint16_t checksum,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options
  );
 
void CC_UserCredential_CredentialLearnStatusReport_tx(
  const u3c_credential_learn_status_t status,
  const u3c_credential_identifier_t * const p_target,
  const uint8_t steps_remaining,
  RECEIVE_OPTIONS_TYPE_EX * p_rx_options);
 
JOB_STATUS CC_UserCredential_UsageNotification_tx(
  const uint8_t notification_event,
  const uint16_t uuid,
  const uint8_t credential_count,
  const u3c_credential_metadata_t * const p_credential_metadata
  );
 
#endif /* CC_USER_CREDENTIAL_TX_H */