digipot9.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 DIGIPOT9_H
#define DIGIPOT9_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"
 
#define DIGIPOT9_CMD_NOP                        0
#define DIGIPOT9_CMD_RESTORE_EEMEM              1
#define DIGIPOT9_CMD_STORE_RDAC                 2
#define DIGIPOT9_CMD_STORE_USER_DATA            3
#define DIGIPOT9_CMD_DECREMENT_6DB              4
#define DIGIPOT9_CMD_DECREMENT_ALL_6DB          5
#define DIGIPOT9_CMD_DECREMENT_ONE_STEP         6
#define DIGIPOT9_CMD_DECREMENT_ALL_ONE_STEP     7
#define DIGIPOT9_CMD_RESET_EEMEM                8
#define DIGIPOT9_CMD_READ_EEMEM                 9
#define DIGIPOT9_CMD_READ_RDAC                  10
#define DIGIPOT9_CMD_WRITE_DATA                 11
#define DIGIPOT9_CMD_INCREMENT_6DB              12
#define DIGIPOT9_CMD_INCREMENT_ALL_6DB          13
#define DIGIPOT9_CMD_INCREMENT_ONE_STEP         14
#define DIGIPOT9_CMD_INCREMENT_ALL_ONE_STEP     15
 
#define DIGIPOT9_ADDRESS_RDAC1                  0
#define DIGIPOT9_ADDRESS_RDAC2                  1
#define DIGIPOT9_ADDRESS_USER_DATA_0            2
#define DIGIPOT9_ADDRESS_USER_DATA_1            3
#define DIGIPOT9_ADDRESS_USER_DATA_2            4
#define DIGIPOT9_ADDRESS_USER_DATA_3            5
#define DIGIPOT9_ADDRESS_USER_DATA_4            6
#define DIGIPOT9_ADDRESS_USER_DATA_5            7
#define DIGIPOT9_ADDRESS_USER_DATA_6            8
#define DIGIPOT9_ADDRESS_USER_DATA_7            9
#define DIGIPOT9_ADDRESS_USER_DATA_8            10
#define DIGIPOT9_ADDRESS_USER_DATA_9            11
#define DIGIPOT9_ADDRESS_USER_DATA_10           12
#define DIGIPOT9_ADDRESS_USER_DATA_11           13
#define DIGIPOT9_ADDRESS_USER_DATA_12           14
#define DIGIPOT9_ADDRESS_FACTORY_USAGE          15
 
 // digipot9_cmd
 
#define DIGIPOT9_WIPER_FULL_SCALE               1023
#define DIGIPOT9_WIPER_MID_SCALE                512
#define DIGIPOT9_WIPER_ZERO_SCALE               0
 
 // digipot9_set
 
#define DIGIPOT9_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.pr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.wp = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // digipot9_map
 // digipot9
 
typedef struct
{
    // Output pins
    digital_out_t  pr;          
    digital_out_t  wp;          
    // Input pins
    digital_in_t  rdy;          
    // Modules
    spi_master_t  spi;          
    pin_name_t  chip_select;    
} digipot9_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  pr;                                   
    pin_name_t  wp;                                   
    pin_name_t  rdy;                                  
    // static variable
    uint32_t                           spi_speed;     
    spi_master_mode_t                  spi_mode;      
    spi_master_chip_select_polarity_t  cs_polarity;   
} digipot9_cfg_t;
 
typedef enum
{
    DIGIPOT9_OK = 0,
    DIGIPOT9_ERROR = -1
 
} digipot9_return_value_t;
 
void digipot9_cfg_setup ( digipot9_cfg_t *cfg );
 
err_t digipot9_init ( digipot9_t *ctx, digipot9_cfg_t *cfg );
 
void digipot9_default_cfg ( digipot9_t *ctx );
 
err_t digipot9_generic_write ( digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t data_in );
 
err_t digipot9_generic_read ( digipot9_t *ctx, uint8_t command, uint8_t address, uint16_t *data_out );
 
err_t digipot9_set_wiper_1 ( digipot9_t *ctx, uint16_t data_in );
 
err_t digipot9_set_wiper_2 ( digipot9_t *ctx, uint16_t data_in );
 
void digipot9_set_pr_pin ( digipot9_t *ctx, uint8_t state );
 
void digipot9_set_wp_pin ( digipot9_t *ctx, uint8_t state );
 
uint8_t digipot9_get_rdy_pin ( digipot9_t *ctx );
 
err_t digipot9_write_user_data ( digipot9_t *ctx, uint8_t address, uint16_t data_in );
 
err_t digipot9_read_user_data ( digipot9_t *ctx, uint8_t address, uint16_t *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // DIGIPOT9_H
 
 // digipot9
 
// ------------------------------------------------------------------------ END