CC_UserCode.h

Go to the documentation of this file.

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

 
#ifndef _COMMANDCLASSUSERCODE_H_
#define _COMMANDCLASSUSERCODE_H_
 
/****************************************************************************/
/*                              INCLUDE FILES                               */
/****************************************************************************/
#include <CC_Common.h>

 
/****************************************************************************/
/*                     EXPORTED TYPES and DEFINITIONS                       */
/****************************************************************************/

typedef enum {
  USER_ID_AVAILABLE = 0x00, 
  USER_ID_OCCUPIED = 0x01, 
  USER_ID_RESERVED = 0x02, 
  USER_ID_NO_STATUS = 0xFE 
}
user_id_status_t;
 
typedef user_id_status_t USER_ID_STATUS;

#define USERCODE_MIN_LEN 4

#define USERCODE_MAX_LEN 10
 
// Used by application file system.
typedef struct SUserCode{
  USER_ID_STATUS user_id_status;
  uint8_t userCode[USERCODE_MAX_LEN];
  uint8_t userCodeLen;
} SUserCode;

typedef struct s_CC_userCode_data_t_{
  RECEIVE_OPTIONS_TYPE_EX rxOptions; 
  uint8_t userIdentifier;
} s_CC_userCode_data_t;

 
#define CC_USER_CODE_EVENT_VALIDATE           1
 
typedef struct {
  uint8_t id;
  uint8_t *data;
  uint8_t length;
} cc_user_code_event_validate_data_t;
 
#define CC_USER_CODE_EVENT_VALIDATE_VALID     2
#define CC_USER_CODE_EVENT_VALIDATE_INVALID   3

 
/****************************************************************************/
/*                              EXPORTED DATA                               */
/****************************************************************************/
 
// Nothing here.
 
/****************************************************************************/
/*                           EXPORTED FUNCTIONS                             */
/****************************************************************************/

e_cmd_handler_return_code_t
CC_UserCode_Set_handler(
  uint8_t identifier,
  USER_ID_STATUS id,
  uint8_t* pUserCode,
  uint8_t len,
  uint16_t modifierNodeId);

bool CC_UserCode_getId_handler(
  uint8_t identifier,
  USER_ID_STATUS* pId,
  uint8_t endpoint);

bool CC_UserCode_Report_handler(
  uint8_t identifier,
  uint8_t* pUserCode,
  size_t  *pLen,
  uint8_t endpoint);

uint8_t CC_UserCode_UsersNumberReport_handler(uint8_t endpoint);

void CC_UserCode_reset_data(void);

JOB_STATUS
  CC_UserCode_SupportReport(
  AGI_PROFILE * pProfile,
  uint8_t sourceEndpoint,
  uint8_t userIdentifier,
  uint8_t userIdStatus,
  uint8_t * pUserCode,
  uint8_t userCodeLen,
  VOID_CALLBACKFUNC(pCallback)(TRANSMISSION_RESULT * pTransmissionResult));
 
bool CC_UserCode_Validate(
  uint8_t identifier,
  const uint8_t *pCode,
  uint8_t len
  );

 
#endif /* _COMMANDCLASSUSERCODE_H_ */