clockgen4.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 CLOCKGEN4_H
#define CLOCKGEN4_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define CLOCKGEN4_REG_DEV_ID         0x01
#define CLOCKGEN4_REG_DEV_CTL        0x02
#define CLOCKGEN4_REG_DEV_CFG_1      0x03
#define CLOCKGEN4_REG_GLOB_CFG       0x05
#define CLOCKGEN4_REG_M_MSB          0x06
#define CLOCKGEN4_REG_L_MSB          0x07
#define CLOCKGEN4_REG_M_LSB          0x08
#define CLOCKGEN4_REG_L_LSB          0x09
#define CLOCKGEN4_REG_FNC_CFG_1      0x16
#define CLOCKGEN4_REG_FNC_CFG_2      0x17
 
 // clockgen4_reg
 
#define CLOCKGEN4_INCR_ENABLE        0x80
#define CLOCKGEN4_INCR_DISABLE       0x00
 
#define CLOCKGEN4_PLL_UNLOCKED       0x00
#define CLOCKGEN4_PLL_LOCKED         0x80
#define CLOCKGEN4_AUX_OUT_EN         0x00
#define CLOCKGEN4_AUX_OUT_DIS        0x02
#define CLOCKGEN4_CLK_OUT_EN         0x00
#define CLOCKGEN4_CLK_OUT_DIS        0x01
 
#define CLOCKGEN4_R_MOD_SEL_L_0      0x00
#define CLOCKGEN4_R_MOD_SEL_L_1      0x20
#define CLOCKGEN4_R_MOD_SEL_L_2      0x40
#define CLOCKGEN4_R_MOD_SEL_L_3      0x60
#define CLOCKGEN4_R_MOD_SEL_R_1      0x80
#define CLOCKGEN4_R_MOD_SEL_R_2      0xA0
#define CLOCKGEN4_R_MOD_SEL_R_3      0xC0
#define CLOCKGEN4_R_MOD_SEL_R_4      0xE0
#define CLOCKGEN4_REG_CLK            0x00
#define CLOCKGEN4_CLK_OUT            0x04
#define CLOCKGEN4_PLL_STAT_IND       0x06
#define CLOCKGEN4_DEV_CFG_1_EN       0x01
#define CLOCKGEN4_DEV_CFG_1_DIS      0x00
 
#define CLOCKGEN4_DEV_CFG_FRZ        0x00
#define CLOCKGEN4_DEV_CFG_UNFRZ      0x08
#define CLOCKGEN4_DEV_CFG_2_EN       0x01
#define CLOCKGEN4_DEV_CFG_2_DIS      0x00
 
#define CLOCKGEN4_AUX_OUT_ACT_H      0x00 
#define CLOCKGEN4_AUX_OUT_ACT_L      0x40 
#define CLOCKGEN4_REF_CLK_DIV_4      0x00 
#define CLOCKGEN4_REF_CLK_DIV_2      0x08 
#define CLOCKGEN4_REF_CLK_DIV_1      0x10 
 
#define CLOCKGEN4_CLK_OUT_UNL_L      0x00
#define CLOCKGEN4_CLK_OUT_UNL_U      0x10
 
#define CLOCKGEN4_REF_CLK_25_MHZ     25.0
 
#define CLOCKGEN4_I2C_ADR_GND    0x4E
#define CLOCKGEN4_I2C_ADR_VCC    0x4F
 
#define CLOCKGEN4_SPI_CHIP_ADR   0x9E
#define CLOCKGEN4_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CLOCKGEN4_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 // clockgen4_set
 
#define CLOCKGEN4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
 
 // clockgen4_map
 // clockgen4
 
typedef enum
{
   CLOCKGEN4_DRV_SEL_SPI,      
   CLOCKGEN4_DRV_SEL_I2C       
} clockgen4_drv_t;
 
typedef err_t ( *clockgen4_master_io_t )( struct clockgen4_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct clockgen4_s
{
    i2c_master_t  i2c;                                  
    spi_master_t  spi;                                  
    uint8_t     slave_address;                          
    pin_name_t  chip_select;                            
    clockgen4_drv_t  drv_sel;                           
    clockgen4_master_io_t  write_f;                     
    clockgen4_master_io_t  read_f;                      
} clockgen4_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
   clockgen4_drv_t  drv_sel;                            
} clockgen4_cfg_t;
 
typedef enum
{
   CLOCKGEN4_OK = 0,
   CLOCKGEN4_ERROR = -1
 
} clockgen4_return_value_t;
 
void clockgen4_cfg_setup ( clockgen4_cfg_t *cfg );
 
void clockgen4_drv_interface_selection ( clockgen4_cfg_t *cfg, clockgen4_drv_t drv_sel );
 
err_t clockgen4_init ( clockgen4_t *ctx, clockgen4_cfg_t *cfg );
 
err_t clockgen4_default_cfg ( clockgen4_t *ctx );
 
err_t clockgen4_generic_write ( clockgen4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t clockgen4_generic_read ( clockgen4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void clockgen4_dev_ctl ( clockgen4_t *ctx, uint8_t dev_ctl );
 
void clockgen4_dev_cfg ( clockgen4_t *ctx, uint8_t dev_cfg );
 
void clockgen4_glob_cfg ( clockgen4_t *ctx, uint8_t glob_cfg );
 
void clockgen4_fnc_cfg_1 ( clockgen4_t *ctx, uint8_t fnc_cfg );
 
void clockgen4_fnc_cfg_2 ( clockgen4_t *ctx, uint8_t fnc_cfg );
 
uint32_t clockgen4_set_ratio ( clockgen4_t *ctx, float ratio );
 
 
#ifdef __cplusplus
}
#endif
#endif // CLOCKGEN4_H
 
 // clockgen4
 
// ------------------------------------------------------------------------ END