mcp16331inv.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 MCP16331INV_H
#define MCP16331INV_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 MCP16331INV_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 )
#define MCP16331INV_RETVAL  uint8_t
 
#define MCP16331INV_OK           0x00
#define MCP16331INV_INIT_ERROR   0xFF
#define  MCP16331INV_ENABLE_VIN_PULL_UP     1
#define  MCP16331INV_DISABLE_VIN_PULL_UP    0
#define  MCP16331INV_GAIN_1X_VREF    1
#define  MCP16331INV_GAIN_2X_VREF    0
#define  MCP16331INV_ACTIVE_MODE      1
#define  MCP16331INV_SHUTDOWN_MODE    0
#define MCP16331INV_MIN_2715_MV_1X_GAIN    0x0000
#define MCP16331INV_2900_MV_1X_GAIN        0x00F5
#define MCP16331INV_3000_MV_1X_GAIN        0x017A
#define MCP16331INV_3100_MV_1X_GAIN        0x01FE
#define MCP16331INV_3300_MV_1X_GAIN        0x02FE
#define MCP16331INV_3500_MV_1X_GAIN        0x03FF
#define MCP16331INV_3700_MV_1X_GAIN        0x04FF
#define MCP16331INV_3900_MV_1X_GAIN        0x05FF
#define MCP16331INV_4000_MV_1X_GAIN        0x0690
#define MCP16331INV_4300_MV_1X_GAIN        0x0810
#define MCP16331INV_5000_MV_1X_GAIN        0x0BAE
#define MCP16331INV_5200_MV_1X_GAIN        0x0CAF
#define MCP16331INV_5300_MV_1X_GAIN        0x0D3F
#define MCP16331INV_MAX_5400_MV_1X_GAIN    0x0FFF
#define MCP16331INV_MIN_2715_MV_2X_GAIN    0x0000
#define MCP16331INV_3000_MV_2X_GAIN        0x00B8
#define MCP16331INV_3500_MV_2X_GAIN        0x01FF
#define MCP16331INV_3900_MV_2X_GAIN        0x02FF
#define MCP16331INV_4400_MV_2X_GAIN        0x044F
#define MCP16331INV_4800_MV_2X_GAIN        0x0558
#define MCP16331INV_4900_MV_2X_GAIN        0x0590
#define MCP16331INV_5000_MV_2X_GAIN        0x05D0
#define MCP16331INV_5300_MV_2X_GAIN        0x0690
#define MCP16331INV_MAX_5400_MV_2X_GAIN    0x0FFF
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t an;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} mcp16331inv_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 an;
    pin_name_t rst;
 
    // static variable 
 
    uint32_t spi_speed;
    uint8_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} mcp16331inv_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void mcp16331inv_cfg_setup ( mcp16331inv_cfg_t *cfg );
 
MCP16331INV_RETVAL mcp16331inv_init ( mcp16331inv_t *ctx, mcp16331inv_cfg_t *cfg );
 
void mcp16331inv_generic_transfer 
( 
    mcp16331inv_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void mcp16331inv_set_dac_vout ( mcp16331inv_t *ctx, uint16_t dac_value, uint8_t gain_value, uint8_t mode );
 
void mcp16331inv_enable_vin ( mcp16331inv_t *ctx, uint8_t state );
 
#ifdef __cplusplus
}
#endif
#endif  // _MCP16331INV_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END