waveform3.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 WAVEFORM3_H
#define WAVEFORM3_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"
    
#define WAVEFORM3_REG_B28_BIT                                   1 << 13
 
#define WAVEFORM3_REG_HLB_BIT                                   1 << 12
 
#define WAVEFORM3_REG_FSEL_BIT                                  1 << 11
 
#define WAVEFORM3_REG_PSEL_BIT                                  1 << 10
 
#define WAVEFORM3_REG_RESET_BIT                                 1 << 8
 
#define WAVEFORM3_REG_SLEEP1_BIT                                1 << 7
 
#define WAVEFORM3_REG_SLEEP12_BIT                               1 << 6
 
#define WAVEFORM3_REG_OPBITEN_BIT                               1 << 5
 
#define WAVEFORM3_REG_DIV2_BIT                                  1 << 3
 
#define WAVEFORM3_REG_MODE_BIT                                  1 << 1
 
#define WAVEFORM3_REG_RESET_CLEAR                               0x0000
 
 // waveform3_reg
 
#define WAVEFORM3_CFG_MODE_SINUSOIDAL                           0x00
 
#define WAVEFORM3_CFG_MODE_TRIANGLE                             0x01
 
#define WAVEFORM3_CFG_MODE_DAC_2                                0x02
 
#define WAVEFORM3_CFG_MODE_DAC                                  0x03
 
 // mode
 
#define WAVEFORM3_CFG_FREQ_REG0                                 0x00
 
#define WAVEFORM3_CFG_FREQ_REG1                                 0x01
 
 // freq_reg
 
#define WAVEFORM3_CFG_PHASE_REG0                                0x00
 
#define WAVEFORM3_CFG_PHASE_REG1                                0x01
 
 // phase_reg
 
#define WAVEFORM3_DEFAULT_FREQ0                                 0
 
#define WAVEFORM3_DEFAULT_FREQ1                                 0
 
#define WAVEFORM3_DEFAULT_PHASE0                                0
 
#define WAVEFORM3_DEFAULT_PHASE1                                0
 
 // waveform3_default_settings
 
#define WAVEFORM3_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 )
 
 // waveform3_map
 // waveform3
 
typedef struct
{
    // Modules
 
    spi_master_t  spi;                                   
    pin_name_t  chip_select;                             
} waveform3_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t  miso;                                    
    pin_name_t  mosi;                                    
    pin_name_t  sck;                                     
    pin_name_t  cs;                                      
    // static variable
 
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} waveform3_cfg_t;
 
typedef enum
{
    WAVEFORM3_OK = 0,
    WAVEFORM3_ERROR = -1
 
} waveform3_return_value_t;
 
void waveform3_cfg_setup ( waveform3_cfg_t *cfg );
 
err_t waveform3_init ( waveform3_t *ctx, waveform3_cfg_t *cfg );
 
void waveform3_default_cfg ( waveform3_t *ctx );
 
void waveform3_write_register ( waveform3_t *ctx, uint16_t data_in );
 
void waveform3_reset ( waveform3_t *ctx );
 
uint32_t waveform3_set_freq ( waveform3_t *ctx, uint32_t frequency, uint8_t freq_reg );
 
uint16_t waveform3_set_phase ( waveform3_t *ctx, float phase, uint8_t phase_reg );
 
void waveform3_set_mode ( waveform3_t *ctx, uint8_t mode, uint8_t freq_reg, uint8_t phase_reg );
 
#ifdef __cplusplus
}
#endif
#endif // WAVEFORM3_H
 
 // waveform3
 
// ------------------------------------------------------------------------ END