mcp47xx.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef MCP47XX_H
#define MCP47XX_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdbool.h>
#include <stdint.h>
 
#include "kernel_defines.h"
#include "periph/dac.h"
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#define MCP47XX_BASE_ADDR   (0x60)  
#define MCP4706_CHN_NUM     (1)  
#define MCP4716_CHN_NUM     (1)  
#define MCP4725_CHN_NUM     (1)  
#define MCP4726_CHN_NUM     (1)  
#define MCP4728_CHN_NUM     (4)  
#define MCP47XX_CHN_NUM_MAX (4)  
typedef enum {
    MCP47XX_OK,                 
    MCP47XX_ERROR_I2C,          
    MCP47XX_ERROR_NOT_AVAIL,    
} mcp47xx_error_codes_t;
 
typedef enum {
    MCP4706,    
    MCP4716,    
    MCP4725,    
    MCP4726,    
    MCP4728,    
} mcp47xx_variant_t;
 
typedef enum {
    MCP47XX_GAIN_1X = 0,  
    MCP47XX_GAIN_2X = 1,  
} mcp47xx_gain_t;
 
typedef enum {
    MCP47XX_VREF_VDD = 0,   
    MCP47XX_VREF_INT = 1,   
    MCP47XX_VREF_PIN = 2,   
    MCP47XX_VREF_BUF = 3,   
} mcp47xx_vref_t;
 
typedef enum {
    MCP47XX_NORMAL = 0,     
    MCP47XX_PD_SMALL = 1,   
    MCP47XX_PD_MEDIUM = 2,  
    MCP47XX_PD_LARGE = 3,   
} mcp47xx_pd_mode_t;
 
typedef struct {
 
    i2c_t    dev;       
    uint16_t addr;      
    mcp47xx_variant_t   variant;    
    mcp47xx_gain_t      gain;       
    mcp47xx_vref_t      vref;       
    mcp47xx_pd_mode_t   pd_mode;    
} mcp47xx_params_t;
 
typedef struct {
    mcp47xx_params_t params;              
    uint16_t values[MCP47XX_CHN_NUM_MAX]; 
} mcp47xx_t;
 
#if IS_USED(MODULE_SAUL) || DOXYGEN
typedef struct {
    const char *name;   
    unsigned int dev;   
    uint8_t channel;    
    uint16_t initial;   
} mcp47xx_saul_dac_params_t;
#endif
 
int mcp47xx_init(mcp47xx_t *dev, const mcp47xx_params_t *params);
 
int mcp47xx_dac_init(mcp47xx_t *dev, uint8_t chn);
 
void mcp47xx_dac_set(mcp47xx_t *dev, uint8_t chn, uint16_t value);
 
void mcp47xx_dac_get(mcp47xx_t *dev, uint8_t chn, uint16_t *value);
 
void mcp47xx_dac_poweron(mcp47xx_t *dev, uint8_t chn);
 
void mcp47xx_dac_poweroff(mcp47xx_t *dev, uint8_t chn);
 
uint8_t mcp47xx_dac_channels(mcp47xx_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* MCP47XX_H */