waveform.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 WAVEFORM_H
#define WAVEFORM_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_spi_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define WAVEFORM_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.rst   = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.pwm   = MIKROBUS( mikrobus, MIKROBUS_PWM )
#define WAVEFORM_OK                         0
#define WAVEFORM_ERROR                     -1
#define WAVEFORM_CR_B28_BITMASK             0x2000
#define WAVEFORM_CR_HLB_BITMASK             0x1000
#define WAVEFORM_CR_FSELECT_BITMASK         0x0800
#define WAVEFORM_CR_PSELECT_BITMASK         0x0400
#define WAVEFORM_CR_RESET_BITMASK           0x0100 
#define WAVEFORM_CR_SLEEP1_BITMASK          0x0080 
#define WAVEFORM_CR_SLEEP12_BITMASK         0x0040 
#define WAVEFORM_CR_OPBITEN_BITMASK         0x0020 
#define WAVEFORM_CR_DIV2_BITMASK            0x0008 
#define WAVEFORM_CR_MODE_BITMASK            0x0002 
#define WAVEFORM_SINE_OUT                   0x01
#define WAVEFORM_TRIANGLE_OUT               0x02
#define WAVEFORM_SQUARE_OUT                 0x03
#define WAVEFORM_OSC_FREQUENCY              25000000ul
#define WAVEFORM_FREQ_RESOLUTION            0x0FFFFFFFul
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
    digital_out_t rst;
    digital_out_t pwm;
    
    // Modules 
    spi_master_t spi;
    pin_name_t chip_select;
    
} waveform_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 rst;
    pin_name_t pwm;
 
    // static variable 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} waveform_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void waveform_cfg_setup ( waveform_cfg_t *cfg );
 
err_t waveform_init ( waveform_t *ctx, waveform_cfg_t *cfg );
 
void waveform_digipot_dec ( waveform_t *ctx );
 
void waveform_digipot_inc ( waveform_t *ctx );
 
void waveform_write_reg ( waveform_t *ctx, uint16_t reg_setting );
 
void waveform_write_frequency ( waveform_t *ctx, uint32_t freq );
 
void waveform_sine_output ( waveform_t *ctx, uint32_t freq );
 
void waveform_triangle_output ( waveform_t *ctx, uint32_t freq );
 
void waveform_square_output ( waveform_t *ctx, uint32_t freq );
 
#ifdef __cplusplus
}
#endif
#endif  // _WAVEFORM_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END