zwapi_protocol_mem.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAPI_PROTOCOL_MEM_H
#define ZWAPI_PROTOCOL_MEM_H
 
#include <stdint.h>
 
// Includes from other components
#include "sl_status.h"
#include "zwave_node_id_definitions.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Size definitions for the NVR structure */
#define NVR_SAW_CENTER_FREQ_SIZE      0x03
#define NVR_NVM_SIZE_SIZE             0x02
#define NVR_NVM_PAGE_SIZE_SIZE        0x02
#define NVR_UUID_SIZE                 0x10
#define NVR_USBID_SIZE                0x02
#define NVR_SECURITY_PUBLIC_KEY_SIZE  0x20
#define NVR_SECURITY_PRIVATE_KEY_SIZE 0x20
#define NVR_CRC16_SIZE                0x02
 
/* Structure of the data in the NVR flash page */
typedef struct _NVR_FLASH_STRUCT_ {
  uint8_t bRevision;
  uint8_t bCrystalCalibration;
  uint8_t bPinSwap;
  uint8_t bNVMChipSelect;
  uint8_t abSAWCenterFreq[NVR_SAW_CENTER_FREQ_SIZE];
  uint8_t bSAWBandwidth;
  uint8_t bNVMType;
  uint8_t bNVMSize[NVR_NVM_SIZE_SIZE];
  uint8_t bNVMPageSize[NVR_NVM_PAGE_SIZE_SIZE];
  uint8_t abUUID[NVR_UUID_SIZE];
  uint8_t idVendorUsb
    [NVR_USBID_SIZE]; /*idVendor if 0xff -> use sigma Vendor ID (Assigned by USB Org)*/
  uint8_t idProductUsb
    [NVR_USBID_SIZE]; /*idProduct  if 0xff -> use sigma Product ID (Assigned by Manufacturer)*/
  uint8_t bTxCalibration1;
  uint8_t bTxCalibration2;
  uint8_t aSecurityPublicKey[NVR_SECURITY_PUBLIC_KEY_SIZE];
  uint8_t aSecurityPrivateKey[NVR_SECURITY_PRIVATE_KEY_SIZE];
} NVR_FLASH_STRUCT;
 
sl_status_t
  zwapi_nvr_get_value(uint8_t bOffset, uint8_t bLength, uint8_t *bRetBuffer);
 
sl_status_t zwapi_memory_get_ids(zwave_home_id_t *home_id,
                                 zwave_node_id_t *node_id);
 
sl_status_t zwapi_memory_get_byte(uint16_t offset, uint8_t *byte_value);
 
uint8_t zwapi_memory_put_byte(uint16_t offset, uint8_t bData);
 
sl_status_t
  zwapi_memory_get_buffer(uint16_t offset, uint8_t *buffer, uint8_t length);
 
uint8_t zwapi_memory_put_buffer(uint16_t offset,
                                const uint8_t *buffer,
                                uint16_t length,
                                void (*callback_function)(void));
 
uint8_t zwapi_memory_put_buffer_blocking(uint16_t offset,
                                         uint8_t *buffer,
                                         uint16_t length,
                                         uint16_t timeout);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  // ZWAPI_PROTOCOL_MEM_H