clockgen6.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 CLOCKGEN6_H
#define CLOCKGEN6_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 CLOCKGEN6_DIGIPOT_POSITION_MAX  255
#define CLOCKGEN6_DIGIPOT_POSITION_MIN  0
 
#define CLOCKGEN6_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define CLOCKGEN6_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // clockgen6_set
 
#define CLOCKGEN6_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 );
 
 // clockgen6_map
 // clockgen6
 
typedef struct
{
    digital_out_t en;       
    // Modules
    spi_master_t spi;       
    pin_name_t chip_select; 
} clockgen6_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t miso;        
    pin_name_t mosi;        
    pin_name_t sck;         
    pin_name_t cs;          
    pin_name_t en;          
    // static variable
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
} clockgen6_cfg_t;
 
typedef enum
{
    CLOCKGEN6_OK = 0,
    CLOCKGEN6_ERROR = -1
 
} clockgen6_return_value_t;
 
void clockgen6_cfg_setup ( clockgen6_cfg_t *cfg );
 
err_t clockgen6_init ( clockgen6_t *ctx, clockgen6_cfg_t *cfg );
 
err_t clockgen6_default_cfg ( clockgen6_t *ctx );
 
err_t clockgen6_set_digipot ( clockgen6_t *ctx, uint8_t position );
 
void clockgen6_enable_output ( clockgen6_t *ctx );
 
void clockgen6_disable_output ( clockgen6_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CLOCKGEN6_H
 
 // clockgen6
 
// ------------------------------------------------------------------------ END