analogmux3.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 ANALOGMUX3_H
#define ANALOGMUX3_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 "drv_analog_in.h"
 
#define ANALOGMUX3_SET_CHANNEL_0                  0x00
#define ANALOGMUX3_SET_CHANNEL_1                  0x01
#define ANALOGMUX3_SET_CHANNEL_2                  0x02
#define ANALOGMUX3_SET_CHANNEL_3                  0x03
#define ANALOGMUX3_SET_CHANNEL_4                  0x04
#define ANALOGMUX3_SET_CHANNEL_5                  0x05
#define ANALOGMUX3_SET_CHANNEL_6                  0x06
#define ANALOGMUX3_SET_CHANNEL_7                  0x07
#define ANALOGMUX3_SET_NO_CHANNEL                 0xFF
 
#define ANALOGMUX3_VAL_CHANNEL_OFF                0x00
#define ANALOGMUX3_VAL_CHANNEL_0                  0x01
#define ANALOGMUX3_VAL_CHANNEL_1                  0x02
#define ANALOGMUX3_VAL_CHANNEL_2                  0x04
#define ANALOGMUX3_VAL_CHANNEL_3                  0x08
#define ANALOGMUX3_VAL_CHANNEL_4                  0x10
#define ANALOGMUX3_VAL_CHANNEL_5                  0x20
#define ANALOGMUX3_VAL_CHANNEL_6                  0x40
#define ANALOGMUX3_VAL_CHANNEL_7                  0x80
 
#define ANALOGMUX3_SET_DEV_ADDR_0                 0x4C
#define ANALOGMUX3_SET_DEV_ADDR_1                 0x4D
#define ANALOGMUX3_SET_DEV_ADDR_2                 0x4E
#define ANALOGMUX3_SET_DEV_ADDR_3                 0x4F
 
 // analogmux3_set
 
#define ANALOGMUX3_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.an = MIKROBUS( mikrobus, MIKROBUS_AN );     \
     cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ) 
 
 // analogmux3_map
 // analogmux3
 
typedef struct
{
    // Output pins
 
    digital_out_t  rst;         
    // Modules
 
    analog_in_t  adc;           
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} analogmux3_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  an;         
    // Additional gpio pins
 
    pin_name_t  rst;        
    // Static variable
 
    uint32_t                           spi_speed;      
    spi_master_mode_t                  spi_mode;       
    spi_master_chip_select_polarity_t  cs_polarity;    
    analog_in_resolution_t  resolution;                
    float                   vref;                      
} analogmux3_cfg_t;
 
typedef enum
{
    ANALOGMUX3_OK = 0,
    ANALOGMUX3_ERROR = -1
 
} analogmux3_return_value_t;
 
void analogmux3_cfg_setup ( analogmux3_cfg_t *cfg );
 
err_t analogmux3_init ( analogmux3_t *ctx, analogmux3_cfg_t *cfg );
 
err_t analogmux3_default_cfg ( analogmux3_t *ctx );
 
err_t analogmux3_generic_write ( analogmux3_t *ctx, uint8_t data_in );
 
void analogmux3_hw_reset ( analogmux3_t *ctx );
 
err_t analogmux3_set_channel ( analogmux3_t *ctx, uint8_t mux_ch );
 
err_t analogmux3_read_an_pin_value ( analogmux3_t *ctx, uint16_t *data_out );
 
err_t analogmux3_read_an_pin_voltage ( analogmux3_t *ctx, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // ANALOGMUX3_H
 
 // analogmux3
 
// ------------------------------------------------------------------------ END