gp8xxx.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2025 Bas Stottelaar <basstottelaar@gmail.com>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include "periph/i2c.h"
 
#include "gp8xxx_info.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#if MODULE_GP8503 || MODULE_GP8512 || MODULE_GP8403 || MODULE_GP8413 || \
    MODULE_GP8211S
#  define GP8XXX_HAS_VDAC 1
#endif
#if MODULE_GP8302
#  define GP8XXX_HAS_IDAC 1
#endif

typedef enum {
    GP8XXX_CHANNEL_0    = 0,    
    GP8XXX_CHANNEL_1    = 1,    
    GP8XXX_CHANNEL_ALL  = 2     
} gp8xxx_channel_t;

typedef enum {
    GP8XXX_OUTPUT_RANGE_2_5V    = 2500,     
    GP8XXX_OUTPUT_RANGE_VCC     = 3300,     
    GP8XXX_OUTPUT_RANGE_5V      = 5000,     
    GP8XXX_OUTPUT_RANGE_10V     = 10000,    
    GP8XXX_OUTPUT_RANGE_25_MA   = 25000,    
} gp8xxx_output_range_t;

typedef struct {
    i2c_t i2c_dev;                  
    uint8_t address;                
#if GP8XXX_HAS_VDAC || DOXYGEN
    gp8xxx_output_range_t range;    
#endif /* GP8XXX_HAS_VDAC || DOXYGEN */
    const gp8xxx_info_t *info;      
} gp8xxx_params_t;

typedef struct {
    char *name;                     
    uint8_t dev;                    
    gp8xxx_channel_t channel;       
} gp8xxx_saul_params_t;

typedef struct {
    gp8xxx_params_t params;         
    gp8xxx_output_range_t range;    
#if GP8XXX_HAS_IDAC || DOXYGEN
    uint16_t calibration_4ma;       
    uint16_t calibration_20ma;      
#endif /* GP8XXX_HAS_IDAC || DOXYGEN */
} gp8xxx_t;

typedef struct {
    gp8xxx_t *dev;                  
    gp8xxx_channel_t channel;       
} gp8xxx_saul_t;

int gp8xxx_init(gp8xxx_t *dev, const gp8xxx_params_t *params);

int gp8xxx_set_dac(gp8xxx_t *dev, gp8xxx_channel_t channel, uint16_t value);
 
#if GP8XXX_HAS_VDAC || DOXYGEN
int gp8xxx_set_voltage_range(gp8xxx_t *dev, gp8xxx_output_range_t value);

int gp8xxx_set_voltage(gp8xxx_t *dev, gp8xxx_channel_t channel, uint16_t voltage);
#endif /* GP8XXX_HAS_VDAC || DOXYGEN */
 
#if GP8XXX_HAS_IDAC || DOXYGEN
void gp8xxx_set_current_calibration(gp8xxx_t *dev, uint16_t calibration_4ma,
                                    uint16_t calibration_20ma);

int gp8xxx_set_current(gp8xxx_t *dev, gp8xxx_channel_t channel, uint16_t current);
#endif /* GP8XXX_HAS_IDAC || DOXYGEN */
 
#ifdef __cplusplus
}
#endif