analogmux.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 ANALOGMUX_H
#define ANALOGMUX_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_analog_in.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
 
#define ANALOGMUX_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.an_pin  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.s0 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.s3 = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.s1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
  cfg.s2 = MIKROBUS( mikrobus, MIKROBUS_INT )
#define ANALOGMUX_RETVAL  uint8_t
 
#define ANALOGMUX_OK           0x00
#define ANALOGMUX_INIT_ERROR   0xFF
#define ANALOGMUX_CHANNEL_0     0x00
#define ANALOGMUX_CHANNEL_1     0x01
#define ANALOGMUX_CHANNEL_2     0x02
#define ANALOGMUX_CHANNEL_3     0x03
#define ANALOGMUX_CHANNEL_4     0x04
#define ANALOGMUX_CHANNEL_5     0x05
#define ANALOGMUX_CHANNEL_6     0x06
#define ANALOGMUX_CHANNEL_7     0x07
#define ANALOGMUX_CHANNEL_8     0x08
#define ANALOGMUX_CHANNEL_9     0x09
#define ANALOGMUX_CHANNEL_10    0x10
#define ANALOGMUX_CHANNEL_11    0x11
#define ANALOGMUX_CHANNEL_12    0x12
#define ANALOGMUX_CHANNEL_13    0x13
#define ANALOGMUX_CHANNEL_14    0x14
#define ANALOGMUX_CHANNEL_15    0x15
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t s0;
    digital_out_t s3;
    digital_out_t s1;
    digital_out_t s2;
    
    // Modules 
 
    analog_in_t adc;
 
} analogmux_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t an_pin;
    
    // Additional gpio pins 
 
    pin_name_t s0;
    pin_name_t s3;
    pin_name_t s1;
    pin_name_t s2;
 
    // static variable 
 
    analog_in_resolution_t  resolution;   // Resolution
    float vref;   // VRef    
 
} analogmux_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void analogmux_cfg_setup ( analogmux_cfg_t *cfg );
 
ANALOGMUX_RETVAL analogmux_init ( analogmux_t *ctx, analogmux_cfg_t *cfg );
 
uint16_t analogmux_generic_read ( analogmux_t *ctx );
 
float analogmux_generic_read_voltage ( analogmux_t *ctx );
 
void analogmux_set_channel ( analogmux_t *ctx, uint8_t cfg );
 
#ifdef __cplusplus
}
#endif
#endif  // _ANALOGMUX_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------ END