nrf_sdm.h

/*
 * Copyright (c) Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 *    Semiconductor ASA integrated circuit in a product or a software update for
 *    such product, must reproduce the above copyright notice, this list of
 *    conditions and the following disclaimer in the documentation and/or other
 *    materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 *    Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 *    engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef NRF_SDM_H__
#define NRF_SDM_H__
 
#include <stdint.h>
#include "nrf_svc.h"
#include "nrf_error.h"
#include "nrf_error_sdm.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SD_MAJOR_VERSION  (10)
 
#define SD_MINOR_VERSION  (0)
 
#define SD_BUGFIX_VERSION (0)
 
#define SD_VARIANT_ID 115
 
#define SD_VERSION (SD_MAJOR_VERSION * 1000000 + SD_MINOR_VERSION * 1000 + SD_BUGFIX_VERSION)
 
#define SDM_SVC_BASE 0x10
 
#define SD_UNIQUE_STR_SIZE 20
 
#define SDM_INFO_FIELD_INVALID (0)
 
#define SOFTDEVICE_INFO_STRUCT_OFFSET (0x2000)
 
#define SD_INFO_STRUCT_SIZE_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET)
 
#define SD_SIZE_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET + 0x08)
 
#define SD_FWID_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET + 0x0C)
 
#define SD_ID_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET + 0x10)
 
#define SD_VERSION_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET + 0x14)
 
#define SD_UNIQUE_STR_OFFSET (SOFTDEVICE_INFO_STRUCT_OFFSET + 0x18)
 
#define SD_INFO_STRUCT_SIZE_GET(baseaddr) (*((uint8_t *) ((baseaddr) + SD_INFO_STRUCT_SIZE_OFFSET)))
 
#define SD_SIZE_GET(baseaddr) (*((uint32_t *) ((baseaddr) + SD_SIZE_OFFSET)))
 
#define SD_FLASH_SIZE 0x19400
 
#define SD_FWID_GET(baseaddr) (*((uint16_t *) ((baseaddr) + SD_FWID_OFFSET)))
 
#define SD_ID_GET(baseaddr) ((SD_INFO_STRUCT_SIZE_GET(baseaddr) > (SD_ID_OFFSET - SOFTDEVICE_INFO_STRUCT_OFFSET)) \
        ? (*((uint32_t *) ((baseaddr) + SD_ID_OFFSET))) : SDM_INFO_FIELD_INVALID)
 
#define SD_VERSION_GET(baseaddr) ((SD_INFO_STRUCT_SIZE_GET(baseaddr) > (SD_VERSION_OFFSET - SOFTDEVICE_INFO_STRUCT_OFFSET)) \
        ? (*((uint32_t *) ((baseaddr) + SD_VERSION_OFFSET))) : SDM_INFO_FIELD_INVALID)
 
#define SD_UNIQUE_STR_ADDR_GET(baseaddr) ((SD_INFO_STRUCT_SIZE_GET(baseaddr) > (SD_UNIQUE_STR_OFFSET - SOFTDEVICE_INFO_STRUCT_OFFSET)) \
        ? (((uint8_t *) ((baseaddr) + SD_UNIQUE_STR_OFFSET))) : SDM_INFO_FIELD_INVALID)
 
#define NRF_FAULT_ID_SD_RANGE_START     0x00000000            
#define NRF_FAULT_ID_APP_RANGE_START    0x00001000            
#define NRF_FAULT_ID_SD_ASSERT    (NRF_FAULT_ID_SD_RANGE_START  + 1)          
#define NRF_FAULT_ID_APP_MEMACC   (NRF_FAULT_ID_APP_RANGE_START + 1)          
enum NRF_SD_SVCS
{
  SD_SOFTDEVICE_ENABLE = SDM_SVC_BASE, 
  SD_SOFTDEVICE_DISABLE,               
  SD_SOFTDEVICE_IS_ENABLED,            
  SVC_SDM_LAST                         
};
 
#define NRF_CLOCK_LF_ACCURACY_250_PPM (0) 
#define NRF_CLOCK_LF_ACCURACY_500_PPM (1) 
#define NRF_CLOCK_LF_ACCURACY_150_PPM (2) 
#define NRF_CLOCK_LF_ACCURACY_100_PPM (3) 
#define NRF_CLOCK_LF_ACCURACY_75_PPM  (4) 
#define NRF_CLOCK_LF_ACCURACY_50_PPM  (5) 
#define NRF_CLOCK_LF_ACCURACY_30_PPM  (6) 
#define NRF_CLOCK_LF_ACCURACY_20_PPM  (7) 
#define NRF_CLOCK_LF_ACCURACY_10_PPM  (8) 
#define NRF_CLOCK_LF_ACCURACY_5_PPM   (9) 
#define NRF_CLOCK_LF_ACCURACY_2_PPM  (10) 
#define NRF_CLOCK_LF_ACCURACY_1_PPM  (11) 
#define NRF_CLOCK_LF_SRC_RC      (0)                        
#define NRF_CLOCK_LF_SRC_XTAL    (1)                        
#define NRF_CLOCK_LF_SRC_SYNTH   (2)                        
typedef struct
{
  uint8_t source;         
  uint8_t rc_ctiv;        
  uint8_t rc_temp_ctiv;   
  uint8_t accuracy;       
  uint16_t hfclk_latency; 
  uint8_t hfint_ctiv;     
} nrf_clock_lf_cfg_t;
 
typedef void (*nrf_fault_handler_t)(uint32_t id, uint32_t pc, uint32_t info);
 
SVCALL(SD_SOFTDEVICE_ENABLE, uint32_t, sd_softdevice_enable(nrf_clock_lf_cfg_t const * p_clock_lf_cfg, nrf_fault_handler_t fault_handler));
 
 
SVCALL(SD_SOFTDEVICE_DISABLE, uint32_t, sd_softdevice_disable(void));
 
SVCALL(SD_SOFTDEVICE_IS_ENABLED, uint32_t, sd_softdevice_is_enabled(uint8_t * p_softdevice_enabled));
 
#ifdef __cplusplus
}
#endif
#endif // NRF_SDM_H__