counter.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 COUNTER_H
#define COUNTER_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_spi_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define COUNTER_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso    = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi    = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck     = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs      = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.en      = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define COUNTER_RETVAL  uint8_t
 
#define COUNTER_OK           0x00
#define COUNTER_INIT_ERROR   0xFF
#define COUNTER_CMD_CLR               0x00    
#define COUNTER_CMD_WR                0x80    
#define COUNTER_CMD_LOAD              0xC0    
#define COUNTER_CMD_RD                0X40    
#define COUNTER_MDR0                  0x08    
#define COUNTER_MDR1                  0x10    
#define COUNTER_DTR                   0x18    
#define COUNTER_CNTR                  0x20    
#define COUNTER_OTR                   0x28    
#define COUNTER_STR                   0x30    
#define COUNTER_NON_QUAD              0x00    
#define COUNTER_1X_QUAD               0x01    
#define COUNTER_2X_QUAD               0x02    
#define COUNTER_4X_QUAD               0x03    
#define COUNTER_FREE_RUN              0x00    
#define COUNTER_SINGLE_COUNT          0x04    
#define COUNTER_RANGE_LIMIT           0x08    
#define COUNTER_N_MODULE              0x0C    
#define COUNTER_INDEX_DISABLED        0x00    
#define COUNTER_INDEX_LOAD_CNTR       0x10     
#define COUNTER_INDEX_RESET_CNTR      0x20     
#define COUNTER_INDEX_LOAD_OTR        0x30     
#define COUNTER_INDEX_NEG             0x00    
#define COUNTER_INDEX_POS             0x40    
#define COUNTER_FILTER_CLOCK_DIV1     0x00    
#define COUNTER_FILTER_CLOCK_DIV2     0x80    
#define COUNTER_MODE_32               0x00    
#define COUNTER_MODE_24               0x01    
#define COUNTER_MODE_16               0x02    
#define COUNTER_MODE_8                0x03    
#define COUNTER_ENABLE                0x00    
#define COUNTER_DISABLE               0x04    
 
#define COUNTER_FLAG_DISABLE          0x00    
#define COUNTER_FLAG_IDX              0x10    
#define COUNTER_FLAG_CMP              0x20    
#define COUNTER_FLAG_BW               0x40    
#define COUNTER_FLAG_FY               0x80    
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t en;
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
    // Variables 
 
    uint8_t buffer_size;
 
} counter_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t en;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} counter_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void counter_cfg_setup ( counter_cfg_t *cfg );
 
COUNTER_RETVAL counter_init ( counter_t *ctx, counter_cfg_t *cfg );
 
void counter_default_cfg ( counter_t *ctx );
 
void counter_generic_transfer 
( 
    counter_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void counter_write_mdr0 ( counter_t *ctx, uint8_t settings );
 
void counter_write_mdr1 ( counter_t *ctx, uint8_t settings );
 
void counter_write_dtr ( counter_t *ctx, uint8_t* buffer );
 
void counter_load_cntr ( counter_t *ctx );
 
void counter_load_otr ( counter_t *ctx );
 
uint8_t counter_read_mdr0 ( counter_t *ctx );
 
uint8_t counter_read_mdr1 ( counter_t *ctx );
 
int32_t counter_read_otr ( counter_t *ctx );
 
int32_t counter_read_cntr ( counter_t *ctx );
 
int32_t counter_read_dtr ( counter_t *ctx );
 
uint8_t counter_read_str ( counter_t *ctx );
 
void counter_clear_mrd0 ( counter_t *ctx );
 
void counter_clead_mrd1 ( counter_t *ctx );
 
void counter_clear_cntr ( counter_t *ctx );
 
void counter_clear_str ( counter_t *ctx );
 
void counter_initialisation ( counter_t *ctx );
 
void counter_init_advanced ( counter_t *ctx, uint8_t mdr0_set, uint8_t mdr1_set );
 
void counter_enable ( counter_t *ctx );
 
void counter_disable ( counter_t *ctx );
 
void counter_chip_enable ( counter_t *ctx );
 
void counter_chip_disable ( counter_t *ctx );
 
uint8_t get_int_state ( counter_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _COUNTER_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END