timer.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef TIMER_H
#define TIMER_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define TIMER_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.evt = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.alm = MIKROBUS( mikrobus, MIKROBUS_INT )
#define TIMER_RETVAL  uint8_t
 
#define TIMER_OK           0x00
#define TIMER_INIT_ERROR   0xFF
#define TIMER_I2C_ADDR                                 0x6B
#define TIMER_REG_CONFIG                               0x00
#define TIMER_REG_ALARM                                0x01
#define TIMER_REG_ELAPSED                              0x05
#define TIMER_REG_EVT_CNTR                             0x09
#define TIMER_REG_EEPROM                               0x0B
#define TIMER_REG_RESET                                0x1D
#define TIMER_REG_WRITE_DISABLE                        0x1E
#define TIMER_REG_WRITE_MEM_DISABLE                    0x1F
#define TIMER_ECMSB_BIT                                0x01
#define TIMER_AP_BIT                                   0x02
#define TIMER_RE_BIT                                   0x04
#define TIMER_AOS_BIT                                  0x08
#define TIMER_WMDF_BIT                                 0x10
#define TIMER_WDF_BIT                                  0x20
#define TIMER_AF_BIT                                   0x40
#define TIMER_EEPROM_SIZE                               10
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t evt;
 
    // Input pins 
 
    digital_in_t alm;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} timer_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t evt;
    pin_name_t alm;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} timer_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void timer_cfg_setup ( timer_cfg_t *cfg );
 
TIMER_RETVAL timer_init ( timer_t *ctx, timer_cfg_t *cfg );
 
void timer_generic_write ( timer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void timer_generic_read ( timer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void timer_hw_reset ( timer_t *ctx );
 
void timer_read_eeprom ( timer_t *ctx );
 
void timer_write_byte_eeprom ( timer_t *ctx, uint8_t location, uint8_t write_data );
 
uint8_t timer_read_byte_eeprom ( timer_t *ctx, uint8_t location );
 
uint8_t timer_get_configuration ( timer_t *ctx );
 
uint32_t timer_get_etc_data ( timer_t *ctx );
 
void timer_set_etc_data ( timer_t *ctx, uint32_t etc_value );
 
uint32_t timer_get_etc_seconds ( timer_t *ctx );
 
void timer_get_time ( timer_t *ctx, uint16_t *time_days, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
 
void timer_set_etc_seconds ( timer_t *ctx, uint32_t etc_seconds );
 
uint16_t timer_get_ec_data ( timer_t *ctx );
 
void timer_set_ec_data ( timer_t *ctx, uint16_t ec_value );
 
uint16_t timer_get_ec_seconds ( timer_t *ctx );
 
void timer_set_ec_seconds ( timer_t *ctx, uint16_t ec_seconds );
 
uint32_t timer_get_alarm_data ( timer_t *ctx );
 
void timer_set_alarm_data ( timer_t *ctx, uint32_t a_data );
 
uint32_t timer_get_alarm_seconds ( timer_t *ctx  );
 
void timer_get_alarm_time ( timer_t *ctx, uint16_t *time_days, uint8_t *time_hours, uint8_t *time_minutes, uint8_t *time_seconds );
 
void timer_set_alarm_seconds ( timer_t *ctx, uint32_t alarm_seconds );
 
uint8_t timer_check_write_disable ( timer_t *ctx );
 
void timer_disable_write ( timer_t *ctx );
 
void timer_enable_write ( timer_t *ctx );
 
void timer_alarm_output_select ( timer_t *ctx );
 
void timer_reset_enable ( timer_t *ctx );
 
void timer_set_alarm_polarity ( timer_t *ctx );
 
uint8_t timer_get_alarm_flag ( timer_t *ctx );
 
void timer_soft_reset ( timer_t *ctx );
 
uint8_t timer_check_interrupt ( timer_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _TIMER_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END