max538x.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __MAX538x_H__
#define __MAX538x_H__
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
#include "no_os_i2c.h"
#include "no_os_util.h"
 
/******************************************************************************/
/************************** max538x Definitions *******************************/
/******************************************************************************/
/* MAX5380 default resolution */
#define MAX538X_RESOLUTION      0xFF
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
enum max538x_type {
    MAX5380L,
    MAX5380M,
    MAX5380N,
    MAX5380K,
    MAX5381L,
    MAX5381M,
    MAX5381N,
    MAX5381K,
    MAX5382L,
    MAX5382M,
    MAX5382N,
    MAX5382K,
};
 
struct max538x_chip_info {
    uint8_t vfactor;
    uint8_t addr;
};
 
struct max538x_dev {
    /* I2C */
    struct no_os_i2c_desc   *i2c_desc;
    /* Device Settings*/
    enum max538x_type active_device;
    /* Device VDD (for MAX5382 variant) */
    uint8_t max538x_vdd ;
    /* Device VREF */
    uint8_t max538x_vref ;
};
 
struct max538x_init_param {
    /* I2C */
    struct no_os_i2c_init_param i2c_init;
    /* Device Settings*/
    enum max538x_type active_device;
    /* Device VDD (for MAX5382 variant) */
    uint8_t max538x_vdd ;
    /* Device VREF */
    uint8_t max538x_vref ;
};
 
extern const struct max538x_chip_info chip_info[];
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initializes the communications peripheral and checks if the device is present. */
int max538x_init(struct max538x_dev **device,
         struct max538x_init_param init_param);
 
/* Free the resources allocated by max538x_init(). */
int max538x_remove(struct max538x_dev *dev);
 
/* Sets the DAC output using VOUT */
int max538x_set_voutput(struct max538x_dev *dev, float vout);
 
#endif  /* __MAX538x_H__ */