clockgen5.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 CLOCKGEN5_H
#define CLOCKGEN5_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_spi_master.h"
#include "spi_specifics.h"
    
#define CLOCKGEN5_OCT_0                                           0
#define CLOCKGEN5_OCT_1                                           1
#define CLOCKGEN5_OCT_2                                           2
#define CLOCKGEN5_OCT_3                                           3
#define CLOCKGEN5_OCT_4                                           4
#define CLOCKGEN5_OCT_5                                           5
#define CLOCKGEN5_OCT_6                                           6
#define CLOCKGEN5_OCT_7                                           7
#define CLOCKGEN5_OCT_8                                           8
#define CLOCKGEN5_OCT_9                                           9
#define CLOCKGEN5_OCT_10                                          10
#define CLOCKGEN5_OCT_11                                          11
#define CLOCKGEN5_OCT_12                                          12
#define CLOCKGEN5_OCT_13                                          13
#define CLOCKGEN5_OCT_14                                          14
#define CLOCKGEN5_OCT_15                                          15
 
#define CLOCKGEN5_OUTPUT_DISABLE                                  0x00
#define CLOCKGEN5_OUTPUT_ENABLE                                   0x01
 
#define CLOCKGEN5_CFG_ON_CLK_180                                  0x00
#define CLOCKGEN5_CFG_OFF_ON                                      0x01
#define CLOCKGEN5_CFG_ON_OFF                                      0x02
#define CLOCKGEN5_CFG_POWER_DOWN                                  0x03
 
#define CLOCKGEN5_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CLOCKGEN5_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // clockgen5_set
 
#define CLOCKGEN5_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.oe = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // clockgen5_map
 // clockgen5
 
typedef struct
{
    // Output pins
    digital_out_t  oe;                               
    // Modules
    spi_master_t  spi;                               
    pin_name_t  chip_select;                         
    uint8_t dev_config;
    
} clockgen5_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  oe;                                      
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} clockgen5_cfg_t;
 
typedef enum
{
   CLOCKGEN5_OK = 0,
   CLOCKGEN5_ERROR = -1
 
} clockgen5_return_value_t;
 
void clockgen5_cfg_setup ( clockgen5_cfg_t *cfg );
 
err_t clockgen5_init ( clockgen5_t *ctx, clockgen5_cfg_t *cfg );
 
void clockgen5_out_enable ( clockgen5_t *ctx, uint8_t en_out );
 
void clockgen5_set_config ( clockgen5_t *ctx, uint8_t cfg );
 
void clockgen5_set_freq ( clockgen5_t *ctx, float freq );
 
#ifdef __cplusplus
}
#endif
#endif // CLOCKGEN5_H
 
 // clockgen5
 
// ------------------------------------------------------------------------ END