clockgen3.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 CLOCKGEN3_H
#define CLOCKGEN3_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 CLOCKGEN3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );
#define CLOCKGEN3_OK                    0
#define CLOCKGEN3_ERROR                -1
#define CLOCKGEN3_OCT_0                 0
#define CLOCKGEN3_OCT_1                 1
#define CLOCKGEN3_OCT_2                 2
#define CLOCKGEN3_OCT_3                 3
#define CLOCKGEN3_OCT_4                 4
#define CLOCKGEN3_OCT_5                 5
#define CLOCKGEN3_OCT_6                 6
#define CLOCKGEN3_OCT_7                 7
#define CLOCKGEN3_OCT_8                 8
#define CLOCKGEN3_OCT_9                 9
#define CLOCKGEN3_OCT_10                10
#define CLOCKGEN3_OCT_11                11
#define CLOCKGEN3_OCT_12                12
#define CLOCKGEN3_OCT_13                13
#define CLOCKGEN3_OCT_14                14
#define CLOCKGEN3_OCT_15                15
#define CLOCKGEN3_SLAVE_ADDRESS_GND     0x17
#define CLOCKGEN3_SLAVE_ADDRESS_VCC     0x16
#define CLOCKGEN3_CFG_ON_CLK_180        0x00
#define CLOCKGEN3_CFG_OFF_ON            0x01
#define CLOCKGEN3_CFG_ON_OFF            0x02
#define CLOCKGEN3_CFG_POWER_DOWN        0x03
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t cs;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
 
    uint8_t dev_config;
 
} clockgen3_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
    pin_name_t cs;
 
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} clockgen3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void clockgen3_cfg_setup ( clockgen3_cfg_t *cfg );
 
err_t clockgen3_init ( clockgen3_t *ctx, clockgen3_cfg_t *cfg );
 
void clockgen3_config ( clockgen3_t *ctx, uint8_t cfg );
 
void clockgen3_set_cs_pin ( clockgen3_t *ctx, uint8_t state );
 
void clockgen3_generic_write ( clockgen3_t *ctx, uint8_t *data_buf, uint8_t len );
 
void clockgen3_generic_read ( clockgen3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void clockgen3_set_freq ( clockgen3_t *ctx, float freq );
 
#ifdef __cplusplus
}
#endif
#endif  // _CLOCKGEN3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END