waveform2.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 WAVEFORM2_H
#define WAVEFORM2_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 WAVEFORM2_CFG_B28_MSK             0x2000
#define WAVEFORM2_CFG_HLB_MSK             0x1000
#define WAVEFORM2_CFG_FSEL_MSK            0x0800
#define WAVEFORM2_CFG_PSEK_MSK            0x0400
#define WAVEFORM2_CFG_PIN_SW_MSK          0x0200
#define WAVEFORM2_CFG_RESET_MSK           0x0100
#define WAVEFORM2_CFG_SLEEP1_MSK          0x0080
#define WAVEFORM2_CFG_SLEEP12_MSK         0x0040
#define WAVEFORM2_CFG_OPBITEN_MSK         0x0020
#define WAVEFORM2_CFG_SIGN_PIB_MSK        0x0010
#define WAVEFORM2_CFG_DIV2_MSK            0x0008
#define WAVEFORM2_CFG_MODE_MSK            0x0002
 
#define OUTPUT_TRIANGLE                   0x01
#define OUTPUT_SINUSOID                   0x00
 
#define WAVEFORM2_DEVICE_SLAVE_ADDR_GND   0x50
#define WAVEFORM2_DEVICE_SLAVE_ADDR_VCC   0x51
 
#define WAVEFORM2_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define WAVEFORM2_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // waveform2_set
 
#define WAVEFORM2_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 ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // waveform2_map
 // waveform2
 
typedef struct waveform2_s
{
    digital_out_t  rst;     
    digital_out_t  en;      
    i2c_master_t  i2c;                              
    spi_master_t  spi;                              
    uint8_t     slave_address;                      
    pin_name_t  chip_select;                        
    uint8_t mode_output; 
 
} waveform2_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;         
    pin_name_t  rst;        
    pin_name_t  en;         
    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;     
} waveform2_cfg_t;
 
typedef enum
{
   WAVEFORM2_OK = 0,
   WAVEFORM2_ERROR = -1
 
} waveform2_return_value_t;
 
void waveform2_cfg_setup ( waveform2_cfg_t *cfg );
 
err_t waveform2_init ( waveform2_t *ctx, waveform2_cfg_t *cfg );
 
err_t waveform2_default_cfg ( waveform2_t *ctx );
 
err_t waveform2_i2c_write ( waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t waveform2_i2c_read ( waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t waveform2_spi_write ( waveform2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t waveform2_spi_read ( waveform2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
uint8_t waveform2_eeprom_read_byte ( waveform2_t *ctx, uint16_t addr );
 
uint16_t waveform2_eeprom_read_word ( waveform2_t *ctx, uint16_t addr );
 
uint32_t waveform2_eeprom_read_long ( waveform2_t *ctx, uint16_t addr );
 
void waveform2_eeprom_read_string ( waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len );
 
void waveform2_eeprom_write_byte ( waveform2_t *ctx, uint16_t addr, uint8_t tx_data );
 
void waveform2_eeprom_write_word ( waveform2_t *ctx, uint16_t addr, uint16_t tx_data );
 
void waveform2_eeprom_write_long ( waveform2_t *ctx, uint16_t addr, uint32_t tx_data );
 
void waveform2_eeprom_write_string ( waveform2_t *ctx, uint16_t addr, uint8_t *data_buf, uint16_t len );
 
void waveform2_mclk_enable ( waveform2_t *ctx );
 
void waveform2_mclk_disable ( waveform2_t *ctx );
 
void waveform2_hw_reset ( waveform2_t *ctx );
 
void waveform2_set_freq ( waveform2_t *ctx, uint32_t freq );
 
void waveform2_configuration ( waveform2_t *ctx, uint16_t cfg );
 
void waveform2_sine_output ( waveform2_t *ctx );
 
void waveform2_triangle_output ( waveform2_t *ctx );
 
void waveform2_output_off ( waveform2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // WAVEFORM2_H
 
 // waveform2
 
// ------------------------------------------------------------------------ END