mcp73213.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 MCP73213_H
#define MCP73213_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 MCP73213_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 )
#define MCP73213_RETVAL  uint8_t
 
#define MCP73213_OK           0x00
#define MCP73213_INIT_ERROR   0xFF
#define MCP73213_SPI_CMD_READ                                      0x0C
#define MCP73213_SPI_CMD_WRITE                                     0x00
#define MCP73213_VOLATILE_WIPER_0                                  0x00
#define MCP73213_VOLATILE_WIPER_1                                  0x01
#define MCP73213_NON_VOLATILE_WIPER_0                              0x02
#define MCP73213_NON_VOLATILE_WIPER_1                              0x03
#define MCP73213_VOLATILE_TCON_REGISTER                            0x04
#define MCP73213_STATUS_REGISTER                                   0x05
#define MCP73213_DATA_EEPROM_6                                     0x06
#define MCP73213_DATA_EEPROM_7                                     0x07
#define MCP73213_DATA_EEPROM_8                                     0x08
#define MCP73213_DATA_EEPROM_9                                     0x09
#define MCP73213_DATA_EEPROM_A                                     0x0A
#define MCP73213_DATA_EEPROM_B                                     0x0B
#define MCP73213_DATA_EEPROM_C                                     0x0C
#define MCP73213_DATA_EEPROM_D                                     0x0D
#define MCP73213_DATA_EEPROM_E                                     0x0E
#define MCP73213_DATA_EEPROM_F                                     0x0F
//#define MCP73213_DATA_WRITE_CMD                                    0x00
#define P73213_VREF_3V3                                            3.30
#define P73213_VREF_5V                                             5.00
#define MCP73213_OUTPUT_130_mA                                     0x00
#define MCP73213_OUTPUT_250_mA                                     0x82
#define MCP73213_OUTPUT_550_mA                                     0xCC
#define MCP73213_OUTPUT_1100_mA                                    0xE9
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
 
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} mcp73213_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t   spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} mcp73213_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void mcp73213_cfg_setup ( mcp73213_cfg_t *cfg );
 
MCP73213_RETVAL mcp73213_init ( mcp73213_t *ctx, mcp73213_cfg_t *cfg );
 
void mcp73213_generic_transfer 
( 
    mcp73213_t *ctx, 
    uint8_t *wr_buf, 
    uint16_t wr_len, 
    uint8_t *rd_buf, 
    uint16_t rd_len 
);
 
void mcp73213_write_data ( mcp73213_t *ctx, uint8_t command, uint8_t write_data );
 
uint8_t mcp73213_read_data ( mcp73213_t *ctx, uint8_t command );
 
void mcp73213_set_current_output ( mcp73213_t *ctx, uint8_t out_data );
 
uint8_t mcp73213_get_status ( mcp73213_t *ctx );
 
float mcp73213_convert_output ( uint8_t value_adc, float v_ref );
 
#ifdef __cplusplus
}
#endif
#endif  // _MCP73213_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END