aux_clk.h

/*
 *  aux_clk.c : Module to handle auxiliary clock used by different modules
 *  Copyright (C) 2019  Appiko
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *  
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef AUX_CLK_H
#define AUX_CLK_H

#include "stdint.h"
#include "nrf_util.h"
#include "nrf.h"

#if SYS_CFG_PRESENT == 1
#include "sys_config.h"
#endif 

#ifndef AUX_CLK_PPI_CHANNELS_USED 
#define AUX_CLK_PPI_CHANNELS_USED 2
#endif

#ifndef AUX_CLK_PPI_CHANNEL_BASE
#define AUX_CLK_PPI_CHANNEL_BASE 5
#endif

#ifndef AUX_CLK_PPI_CHANNEL_0
#define AUX_CLK_PPI_CHANNEL_0 (AUX_CLK_PPI_CHANNEL_BASE + 0)
#endif

#ifndef AUX_CLK_PPI_CHANNEL_1
#define AUX_CLK_PPI_CHANNEL_1 (AUX_CLK_PPI_CHANNEL_BASE + 1)
#endif

#if (AUX_CLK_PPI_CHANNELS_USED > 2)
#ifndef AUX_CLK_PPI_CHANNEL_2
#define AUX_CLK_PPI_CHANNEL_2 (AUX_CLK_PPI_CHANNEL_BASE + 2)
#endif

#if (AUX_CLK_PPI_CHANNELS_USED > 3)
#ifndef AUX_CLK_PPI_CHANNEL_3
#define AUX_CLK_PPI_CHANNEL_3 (AUX_CLK_PPI_CHANNEL_BASE + 3)
#endif

#if (AUX_CLK_PPI_CHANNELS_USED > 4)
#error "Auxiliary clock module cannot handle more than 4 PPI channels"
#endif
#endif
#endif

#ifndef AUX_CLK_LFCLK_RTC_USED
#define AUX_CLK_LFCLK_RTC_USED 0
#endif

#ifndef AUX_CLK_HFCLK_TIMER_USED
#define AUX_CLK_HFCLK_TIMER_USED 2
#endif

#ifndef AUX_CLK_HFCLK_SOLO_MODULE 
#define AUX_CLK_HFCLK_SOLO_MODULE 1
#endif
#define AUX_CLK_NO_IRQ 0xFFFFFFFF

#define AUX_CLK_MAX_CHANNELS 4



typedef enum
{
    AUX_CLK_SRC_LFCLK,
    AUX_CLK_SRC_HFCLK,
}aux_clk_source_t;

typedef enum
{
    AUX_CLK_EVT_NON = 0x00,
    AUX_CLK_EVT_CC0 = 0x01,
    AUX_CLK_EVT_CC1 = 0x02,
    AUX_CLK_EVT_CC2 = 0x04,
    AUX_CLK_EVT_CC3 = 0x08,
}aux_clk_evt_t;

typedef enum
{
    AUX_CLK_TASKS_START,
    AUX_CLK_TASKS_STOP,
    AUX_CLK_TASKS_CLEAR,
}aux_clk_tsk_t;

typedef struct
{
    uint32_t event;
    uint32_t task1;
    uint32_t task2;
}aux_clk_ppi_t;

typedef struct
{
    aux_clk_source_t source;
    app_irq_priority_t irq_priority;
    void (* callback_handler) (uint8_t events);
    uint32_t arr_cc_ms[AUX_CLK_MAX_CHANNELS];
    uint8_t events_en;
    aux_clk_ppi_t arr_ppi_cnf[AUX_CLK_PPI_CHANNELS_USED];
}aux_clk_setup_t;

void aux_clk_set (aux_clk_setup_t * aux_clk);

void aux_clk_select_src (aux_clk_source_t source);

void aux_clk_update_cc (uint32_t cc_id,uint32_t new_val_ms);

void aux_clk_update_ppi (uint32_t ppi_channel, aux_clk_ppi_t * new_ppi);

uint32_t aux_clk_get_ms (void);

void aux_clk_start ();

void aux_clk_stop ();

void aux_clk_clear ();

void aux_clk_en_evt (uint8_t events);

void aux_clk_dis_evt (uint8_t events);

void aux_clk_update_irq_priority (app_irq_priority_t new_priority);

#endif /* AUX_CLK_H */