hodcap.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 HODCAP_H
#define HODCAP_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 HODCAP_REG_SENSOR_ID                          0x01
#define HODCAP_REG_STATUS                             0x02
#define HODCAP_REG_I_DATA                             0x03
#define HODCAP_REG_Q_DATA                             0x04
#define HODCAP_REG_ADC_STATUS                         0x05
#define HODCAP_REG_EDIV                               0x20
#define HODCAP_REG_FREQ                               0x21
#define HODCAP_REG_TXV                                0x22
#define HODCAP_REG_MUX_CTRL                           0x23
#define HODCAP_REG_SDG                                0x24
#define HODCAP_REG_CBG                                0x25
#define HODCAP_REG_DCLK                               0x26
#define HODCAP_REG_PGA                                0x27
#define HODCAP_REG_PGA_OFFSET_I                       0x28
#define HODCAP_REG_PGA_OFFSET_Q                       0x29
#define HODCAP_REG_ADCTL                              0x2A
#define HODCAP_REG_BLANK                              0x2B
#define HODCAP_REG_DIAG_MUX_CTRL                      0x2C
#define HODCAP_REG_QUICK_READ                         0x90
 
#define HODCAP_CMD_WRITE                              0x10
#define HODCAP_CMD_READ                               0x00
#define HODCAP_CMD_QUICK_READ                         0x90
 
 // hodcap_reg
 
#define HODCAP_SENSOR_ID                              0xA431u
 
#define HODCAP_ADC_DATA_READY                         0x0001u
 
#define HODCAP_SET_EDIV_12                            0x0000u
#define HODCAP_SET_EDIV_11                            0x0001u
#define HODCAP_SET_EDIV_10                            0x0002u
#define HODCAP_SET_EDIV_9                             0x0003u
#define HODCAP_SET_EDIV_8                             0x0004u
#define HODCAP_SET_EDIV_7                             0x0005u
#define HODCAP_SET_EDIV_6                             0x0006u
#define HODCAP_SET_EDIV_5                             0x0007u
#define HODCAP_SET_EDIV_4                             0x0008u
#define HODCAP_SET_EDIV_3                             0x0009u
#define HODCAP_SET_EDIV_2                             0x000Au
#define HODCAP_SET_EDIV_1                             0x000Bu
#define HODCAP_SET_EDIV_BIT_MASK                      0x000Fu
 
#define HODCAP_SET_FREQ_45_45KHZ                      0x0000u
#define HODCAP_SET_FREQ_71_4KHZ                       0x0001u
#define HODCAP_SET_FREQ_100KHZ                        0x0002u
#define HODCAP_SET_FREQ_125KHZ                        0x0003u
 
#define HODCAP_SET_TXV_0V                             0x0000u
#define HODCAP_SET_TXV_0_5V                           0x0001u
#define HODCAP_SET_TXV_1V                             0x0002u
 
#define HODCAP_SET_MUX_CTRL_MODE_OPEN                 0x0000u
#define HODCAP_SET_MUX_CTRL_MODE_SENSOR_DRV           0x0001u
#define HODCAP_SET_MUX_CTRL_MODE_COMMON               0x0002u
#define HODCAP_SET_MUX_CTRL_MODE_NO_OP                0x0003u
#define HODCAP_SET_MUX_CTRL_SEL_SEN0                  0x0000u
#define HODCAP_SET_MUX_CTRL_SEL_SEN1                  0x0004u
#define HODCAP_SET_MUX_CTRL_SEL_SEN2                  0x0008u
#define HODCAP_SET_MUX_CTRL_SEL_SEN3                  0x000Cu
#define HODCAP_SET_MUX_CTRL_SEL_SEN4                  0x0010u
#define HODCAP_SET_MUX_CTRL_SEL_SEN5                  0x0014u
#define HODCAP_SET_MUX_CTRL_SEL_SEN6                  0x0018u
#define HODCAP_SET_MUX_CTRL_SEL_SEN7                  0x001Cu
#define HODCAP_SET_MUX_CTRL_SEL_SEN8                  0x0020u
#define HODCAP_SET_MUX_CTRL_SEL_SEN9                  0x0024u
#define HODCAP_SET_MUX_CTRL_SEL_NONE                  0x0028u
#define HODCAP_SET_MUX_CTRL_SEL_VAR_SEN               0x002Cu
#define HODCAP_SET_MUX_CTRL_SEL_BIT_MASK              0x003Cu
 
#define HODCAP_TOTAL_NUMBER_OF_CHANNELS                   10
 
#define HODCAP_SET_PGA_GAIN_36                        0x0000u
#define HODCAP_SET_PGA_GAIN_24                        0x0001u
#define HODCAP_SET_PGA_GAIN_16                        0x0002u
#define HODCAP_SET_PGA_GAIN_10_67                     0x0003u
#define HODCAP_SET_PGA_GAIN_7_11                      0x0004u
#define HODCAP_SET_PGA_GAIN_4_74                      0x0005u
#define HODCAP_SET_PGA_GAIN_3_16                      0x0006u
#define HODCAP_SET_PGA_GAIN_2_11                      0x0007u
 
#define HODCAP_SET_DEFAULT_PGA_OFFSET_I                  96
#define HODCAP_SET_DEFAULT_PGA_OFFSET_Q                 144
 
#define HODCAP_SET_ADCTL_MODE_RESET_STOP              0x0000u
#define HODCAP_SET_ADCTL_MODE_START_SINGLE_CONVO      0x0001u
#define HODCAP_SET_ADCTL_MODE_START_CONT_CONVO        0x0002u
#define HODCAP_SET_ADCTL_MODE_STOP_CURRENT_CONVO      0x0003u
#define HODCAP_SET_ADCTL_MODE_BIT_MASK                0x0003u
#define HODCAP_SET_ADCTL_CS_CLK_250KHZ                0x0000u
#define HODCAP_SET_ADCTL_CS_CLK_500KHZ                0x0004u
#define HODCAP_SET_ADCTL_CS_CLK_1000KHZ               0x0008u
#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_4       0x0000u
#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_8       0x0010u
#define HODCAP_SET_ADCTL_ACCU_NUMB_OF_SAMPLES_16      0x0020u
#define HODCAP_SET_ADCTL_TS_400US                     0x0000u
#define HODCAP_SET_ADCTL_TS_576US                     0x0040u
#define HODCAP_SET_ADCTL_TS_664US                     0x0080u
 
#define HODCAP_SET_MUX_CTRL_PLUS_SEN0                 0x0000u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN1                 0x0001u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN2                 0x0002u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN3                 0x0003u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN4                 0x0004u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN5                 0x0005u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN6                 0x0006u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN7                 0x0007u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN8                 0x0008u
#define HODCAP_SET_MUX_CTRL_PLUS_SEN9                 0x0009u
#define HODCAP_SET_MUX_CTRL_PLUS_VAR_SEN              0x000Bu
#define HODCAP_SET_MUX_CTRL_PLUS_NONE                 0x000Fu
#define HODCAP_SET_MUX_CTRL_MINUS_SEN0                0x0000u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN1                0x0010u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN2                0x0020u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN3                0x0030u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN4                0x0040u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN5                0x0050u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN6                0x0060u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN7                0x0070u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN8                0x0080u
#define HODCAP_SET_MUX_CTRL_MINUS_SEN9                0x0090u
#define HODCAP_SET_MUX_CTRL_MINUS_VAR_SEN             0x00B0u
#define HODCAP_SET_MUX_CTRL_MINUS_NONE                0x00F0u
 
#define HODCAP_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define HODCAP_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // hodcap_set
 
#define HODCAP_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.clk  = MIKROBUS( mikrobus, MIKROBUS_PWM )
 
 // hodcap_map
 // hodcap
 
typedef struct
{
    // Output pins
    digital_out_t clk;           
    // Modules
    spi_master_t spi;            
    pin_name_t   chip_select;    
} hodcap_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 clk;             
    // static variable
    uint32_t                          spi_speed;    
    spi_master_mode_t                 spi_mode;     
    spi_master_chip_select_polarity_t cs_polarity;  
} hodcap_cfg_t;
 
typedef struct
{
    uint8_t    r_ediv;    
    uint8_t    otpf;      
    uint8_t    ppsf;      
    uint8_t    bpff;      
    uint8_t    regf;      
    uint8_t    ocsld;     
    uint8_t    ocsen;     
    uint8_t    test;      
    uint8_t    tx1f;      
    uint8_t    tx2f;      
    uint8_t    pga1f;     
    uint8_t    pga2f;     
    uint8_t    nclk;      
    uint8_t    cbf;       
} hodcap_status_t;
 
typedef enum
{
    HODCAP_OK = 0,
    HODCAP_ERROR = -1
 
} hodcap_return_value_t;
 
void hodcap_cfg_setup ( hodcap_cfg_t *cfg );
 
err_t hodcap_init ( hodcap_t *ctx, hodcap_cfg_t *cfg );
 
err_t hodcap_default_cfg ( hodcap_t *ctx );
 
err_t hodcap_generic_write ( hodcap_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t hodcap_generic_read ( hodcap_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t hodcap_write_reg ( hodcap_t *ctx, uint8_t reg, uint16_t data_in );
 
err_t hodcap_read_reg ( hodcap_t *ctx, uint8_t reg, uint16_t *data_out );
 
err_t hodcap_get_sensor_id ( hodcap_t *ctx, uint16_t *sensor_id );
 
err_t hodcap_get_status ( hodcap_t *ctx, hodcap_status_t *status );
 
err_t hodcap_check_adc_data_ready ( hodcap_t *ctx, uint16_t *data_ready );
 
err_t hodcap_set_adc_op_mode ( hodcap_t *ctx, uint16_t adc_op_mode );
 
err_t hodcap_mux_channel_selection ( hodcap_t *ctx, uint8_t sen_pos );
 
err_t hodcap_get_i_q_data ( hodcap_t *ctx, uint16_t *i_data, uint16_t *q_data );
 
err_t hodcap_wait_adc_data_ready ( hodcap_t *ctx );
 
void hodcap_set_clk_state ( hodcap_t *ctx, uint8_t clk_state );
 
#ifdef __cplusplus
}
#endif
#endif // HODCAP_H
 
 // hodcap
 
// ------------------------------------------------------------------------ END