model_common.h

/* Copyright (c) 2010 - 2019, 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 MODEL_COMMON_H__
#define MODEL_COMMON_H__

#include <stdint.h>
#include "utils.h"
#include "app_timer.h"
#include "timer_scheduler.h"
#include "access.h"

#define MODEL_TRANSITION_TIME_UNKNOWN (UINT32_MAX)


#ifndef MODEL_ACKNOWLEDGED_TRANSACTION_TIMEOUT
#define MODEL_ACKNOWLEDGED_TRANSACTION_TIMEOUT (SEC_TO_US(30))
#endif

#define TRANSITION_TIME_STEP_100MS_MAX (6200ul)

#define TRANSITION_TIME_STEP_1S_MAX (SEC_TO_MS(62ul))

#define TRANSITION_TIME_STEP_10S_MAX (SEC_TO_MS(620ul))

#define TRANSITION_TIME_STEP_10M_MAX (MIN_TO_MS(620ul))

#define TRANSITION_TIME_MAX (0x3E)

#define TRANSITION_TIME_UNKNOWN (0x3F)

#define TRANSITION_TIME_MAX_MS (TRANSITION_TIME_STEP_10M_MAX)

#define DELAY_TIME_STEP_FACTOR_MS (5)

#define DELAY_TIME_STEP_MAX (0xFF)

#define DELAY_TIME_MAX_MS (DELAY_TIME_STEP_MAX * DELAY_TIME_STEP_FACTOR_MS)

#define MODEL_TIMER_TIMEOUT_MIN_TICKS (APP_TIMER_TICKS(1))

#define MODEL_TIMER_TIMEOUT_MIN_US (MODEL_TIMER_PERIOD_US_GET(MODEL_TIMER_TIMEOUT_MIN_TICKS))

#define MODEL_TIMER_MAX_TIMEOUT_TICKS (APP_TIMER_MAX_CNT_VAL)

#define MODEL_TIMER_PERIOD_MS_GET(TICKS) ((1000ul * (TICKS)) / APP_TIMER_CLOCK_FREQ)

#define MODEL_TIMER_PERIOD_US_GET(TICKS) ((1000ul * 1000ul * (TICKS)) / APP_TIMER_CLOCK_FREQ)

#define MODEL_TIMER_TICKS_GET_MS(MS_TIME) \
 ((uint64_t)ROUNDED_DIV((MS_TIME) * (uint64_t)APP_TIMER_CLOCK_FREQ, \
 1000 * (APP_TIMER_CONFIG_RTC_FREQUENCY + 1)))

#define MODEL_TIMER_TICKS_GET_US(US_TIME) \
 ((uint64_t)ROUNDED_DIV( \
 (US_TIME) * (uint64_t)APP_TIMER_CLOCK_FREQ, \
 1000 * 1000 * (APP_TIMER_CONFIG_RTC_FREQUENCY + 1)))

typedef struct
{
 uint32_t transition_time_ms; 
 uint32_t delay_ms; 
} model_transition_t;

typedef struct
{
 uint16_t src;
 uint16_t dst;
 uint32_t message_id;
 uint8_t old_tid;
 bool new_transaction;
 timer_event_t tid_expiry_timer;
} tid_tracker_t;

typedef enum
{
 MODEL_TIMER_MODE_SINGLE_SHOT,
 MODEL_TIMER_MODE_REPEATED
} model_timer_mode_t;

typedef void(*model_timer_cb_t)(void * p_context);

typedef struct
{
 model_timer_mode_t mode;
 uint64_t timeout_rtc_ticks;
 void * p_context;
 model_timer_cb_t cb;
 uint64_t total_rtc_ticks;

 app_timer_id_t const * p_timer_id;

 uint64_t remaining_ticks;
 uint32_t last_rtc_stamp;
 bool cb_active;
} model_timer_t;


uint32_t model_transition_time_decode(uint8_t enc_transition_time);

uint8_t model_transition_time_encode(uint32_t transition_time);

bool model_transition_time_is_valid(uint8_t enc_transition_time);

uint32_t model_delay_decode(uint8_t enc_delay);

uint8_t model_delay_encode(uint32_t delay);

bool model_tid_validate(tid_tracker_t * p_tid_tracker, const access_message_rx_meta_t * p_meta,
 uint32_t message_id, uint8_t tid);

bool model_transaction_is_new(tid_tracker_t * p_tid_tracker);

uint32_t model_timer_schedule(model_timer_t * p_timer);

void model_timer_abort(model_timer_t * p_timer);

uint64_t model_timer_elapsed_ticks_get(model_timer_t * p_timer);

uint32_t model_timer_create(model_timer_t * p_timer);

#endif /* MODEL_COMMON_H__ */