clockgen2.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 CLOCKGEN2_H
#define CLOCKGEN2_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 CLOCKGEN2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.pdn = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.oe = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.dtr = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define CLOCKGEN2_RETVAL  uint8_t
 
#define CLOCKGEN2_OK           0x00
#define CLOCKGEN2_INIT_ERROR   0xFF
// A0 = A1 = A2 = 0
#define CLOCKGEN2_ADDR                      0x58
 
#define CLOCKGEN2_PRESCALER_REG             0x02
#define CLOCKGEN2_ADDR_CHANGE_REG           0x0D
#define CLOKCGEN2_AUTO_PRESERVE_ENABLE      0
#define CLOCKGEN2_AUTO_PRESERVE_DISABLE     1
#define CLOCKGEN2_WRITE_EE_REG              0x3F
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t pdn;
    digital_out_t oe;
    digital_out_t dtr;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} clockgen2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t pdn;
    pin_name_t oe;
    pin_name_t dtr;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} clockgen2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void clockgen2_cfg_setup ( clockgen2_cfg_t *cfg );
 
CLOCKGEN2_RETVAL clockgen2_init ( clockgen2_t *ctx, clockgen2_cfg_t *cfg );
 
void clockgen2_generic_write ( clockgen2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void clockgen2_generic_read ( clockgen2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void clockgen2_set_dtr_pin ( clockgen2_t *ctx, uint8_t state );
 
void clockgen2_set_pdn_pin ( clockgen2_t *ctx, uint8_t state );
 
void clockgen2_set_oe_pin ( clockgen2_t *ctx, uint8_t state );
 
void clockgen2_write ( clockgen2_t *ctx, uint8_t w_reg, uint8_t w_data );
 
void clockgen2_set_prescaler ( clockgen2_t *ctx, uint8_t val );
 
void clockgen2_change_address ( clockgen2_t *ctx, uint8_t new_addr );
 
void clockgen2_store_config ( clockgen2_t *ctx );
 
void clockgen2_auto_setting_preserve ( clockgen2_t *ctx, uint8_t state );
 
void clockgen2_output_enable ( clockgen2_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif  // _CLOCKGEN2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END