diff --git a/drivers/sensors/Kconfig b/drivers/sensors/Kconfig index 1d8bfd24fd..9d61c4fd8d 100644 --- a/drivers/sensors/Kconfig +++ b/drivers/sensors/Kconfig @@ -276,6 +276,18 @@ config INA219_I2C_FREQUENCY default 400000 depends on SENSORS_INA219 +config SENSORS_INA226 + bool "INA226 current and voltage monitor" + default n + select I2C + ---help--- + Enable driver support for the Texas Instruments INA226 power monitor. + +config INA226_I2C_FREQUENCY + int "INA226 I2C frequency" + default 400000 + depends on SENSORS_INA226 + config SENSORS_INA3221 bool "INA3221 current and voltage monitor" default n diff --git a/drivers/sensors/Make.defs b/drivers/sensors/Make.defs index ca1260a9c2..381272202c 100644 --- a/drivers/sensors/Make.defs +++ b/drivers/sensors/Make.defs @@ -1,7 +1,7 @@ ############################################################################ # drivers/sensors/Make.defs # -# Copyright (C) 2011-2012, 2015-2017 Gregory Nutt. All rights reserved. +# Copyright (C) 2011-2012, 2015-2018 Gregory Nutt. All rights reserved. # Author: Gregory Nutt # # Redistribution and use in source and binary forms, with or without @@ -145,6 +145,10 @@ ifeq ($(CONFIG_SENSORS_INA219),y) CSRCS += ina219.c endif +ifeq ($(CONFIG_SENSORS_INA226),y) + CSRCS += ina226.c +endif + ifeq ($(CONFIG_SENSORS_INA3221),y) CSRCS += ina3221.c endif diff --git a/drivers/sensors/ina226.c b/drivers/sensors/ina226.c new file mode 100644 index 0000000000..83aa991a1d --- /dev/null +++ b/drivers/sensors/ina226.c @@ -0,0 +1,419 @@ +/**************************************************************************** + * drivers/sensors/ina226.c + * Character driver for the INA226 Power Sensor + * + * Copyright (C) 2017 Sebastien Lorquet. All rights reserved. + * Author: Sebastien Lorquet + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include + +#include +#include +#include + +#include +#include +#include +#include + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +#if !defined(CONFIG_I2C) +# error i2c support required +#endif + +#ifndef CONFIG_INA226_I2C_FREQUENCY +# define CONFIG_INA226_I2C_FREQUENCY 400000 +#endif + +#define I2C_NOSTARTSTOP_MSGS 2 +#define I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX 0 +#define I2C_NOSTARTSTOP_DATA_MSG_INDEX 1 + +#define BV_LSB 1250LU /* Bus voltage LSB in microvolts */ +#define SV_LSB 250LU /* Shunt voltage LSB in microvolts times 10 */ + +/**************************************************************************** + * Private Types + ****************************************************************************/ + +struct ina226_dev_s +{ + FAR struct i2c_master_s *i2c; /* I2C interface */ + uint8_t addr; /* I2C address */ + uint16_t config; /* INA226 config shadow */ + int32_t shunt_resistor_value; /* micro-ohms, max 2.15 kohms */ +}; + +/**************************************************************************** + * Private Function Prototypes + ****************************************************************************/ + +/* I2C Helpers */ + +static int ina226_write16(FAR struct ina226_dev_s *priv, uint8_t regaddr, + FAR uint16_t regvalue); +static int ina226_read16(FAR struct ina226_dev_s *priv, uint8_t regaddr, + FAR uint16_t *regvalue); +static int ina226_readpower(FAR struct ina226_dev_s *priv, + FAR struct ina226_s *buffer); + +/* Character driver methods */ + +static int ina226_open(FAR struct file *filep); +static int ina226_close(FAR struct file *filep); +static ssize_t ina226_read(FAR struct file *filep, FAR char *buffer, + size_t buflen); +static ssize_t ina226_write(FAR struct file *filep, FAR const char *buffer, + size_t buflen); +static int ina226_ioctl(FAR struct file *filep, int cmd, + unsigned long arg); + +/**************************************************************************** + * Private Data + ****************************************************************************/ + +static const struct file_operations g_ina226fops = +{ + ina226_open, + ina226_close, + ina226_read, + ina226_write, + NULL, + ina226_ioctl +#ifndef CONFIG_DISABLE_POLL + , NULL +#endif +#ifndef CONFIG_DISABLE_PSEUDOFS_OPERATIONS + , NULL +#endif +}; + +/**************************************************************************** + * Private Functions + ****************************************************************************/ + +static int ina226_access(FAR struct ina226_dev_s *priv, + uint8_t start_register_address, bool reading, + FAR uint8_t* register_value, uint8_t data_length) +{ + struct i2c_msg_s msg[I2C_NOSTARTSTOP_MSGS]; + int ret; + + msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].frequency = CONFIG_INA226_I2C_FREQUENCY; + + msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].addr = priv->addr; + msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].flags = 0; + msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].buffer = &start_register_address; + msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].length = 1; + + msg[I2C_NOSTARTSTOP_DATA_MSG_INDEX].addr = msg[I2C_NOSTARTSTOP_ADDRESS_MSG_INDEX].addr; + msg[I2C_NOSTARTSTOP_DATA_MSG_INDEX].flags = reading ? I2C_M_READ : 0; + msg[I2C_NOSTARTSTOP_DATA_MSG_INDEX].buffer = register_value; + msg[I2C_NOSTARTSTOP_DATA_MSG_INDEX].length = data_length; + + ret = I2C_TRANSFER(priv->i2c, msg, I2C_NOSTARTSTOP_MSGS); + + sninfo("start_register_address: " + "0x%02X data_length: %d register_value: 0x%02x (0x%04x) ret: %d\n", + start_register_address, data_length, *register_value, + *((uint16_t*)register_value), ret); + + return ret; +} + +static int ina226_read16(FAR struct ina226_dev_s *priv, uint8_t regaddr, + FAR uint16_t* regvalue) +{ + uint8_t buf[2]; + + int ret = ina226_access(priv, regaddr, true, buf, 2); + + if (ret == 0) + { + *regvalue = ((uint16_t)buf[0] << 8) | (uint16_t)buf[1]; + } + + return ret; +} + +static int ina226_write16(FAR struct ina226_dev_s *priv, uint8_t regaddr, + FAR uint16_t regvalue) +{ + uint8_t buf[2]; + + int ret; + + buf[0] = (regvalue >> 8) & 0xff; + buf[1] = regvalue & 0xff; + + ret = ina226_access(priv, regaddr, false, buf, 2); + + return ret; +} + +/**************************************************************************** + * Name: ina226_readpower + * + * Description: + * Read the current and voltage register with special scaling + * + ****************************************************************************/ + +static int ina226_readpower(FAR struct ina226_dev_s *priv, + FAR struct ina226_s *buffer) +{ + uint16_t reg; + int64_t tmp; + + int ret; + + /* Read the raw bus voltage */ + + ret = ina226_read16(priv, INA226_REG_BUS_VOLTAGE, ®); + if (ret < 0) + { + snerr("ERROR: ina226_read16 failed: %d\n", ret); + return ret; + } + + /* Convert register value to bus voltage */ + + buffer->voltage = ((uint32_t)reg) * BV_LSB; /* 1 LSB 1,25mV*/ + + /* Read the raw shunt voltage */ + + ret = ina226_read16(priv, INA226_REG_SHUNT_VOLTAGE, ®); + if (ret < 0) + { + snerr("ERROR: ina226_read16 failed: %d\n", ret); + return ret; + } + + tmp = ((int64_t)(int16_t)reg); + + /* Convert shunt voltage to current across the shunt resistor. + * I(uA) = U(uV)/R(ohms) + * = U(uV)/(R(uohms)/1000000) + * = U(uV) * 1000000 / R(uohms) + * + * U(uV) = tmp*2,5 + * + * We use a temporary 64-bit accumulator to avoid overflows. + */ + + tmp = tmp * 2500000LL; + tmp = tmp / (int64_t)priv->shunt_resistor_value; + + buffer->current = (int32_t)tmp; + + return OK; +} + +/**************************************************************************** + * Name: ina226_open + * + * Description: + * This function is called whenever the INA226 device is opened. + * + ****************************************************************************/ + +static int ina226_open(FAR struct file *filep) +{ + FAR struct inode *inode = filep->f_inode; + FAR struct ina226_dev_s *priv = inode->i_private; + + return ina226_write16(priv, INA226_REG_CONFIG, + priv->config | INA226_CONFIG_MODE_SBCONT); +} + +/**************************************************************************** + * Name: ina226_close + * + * Description: + * This routine is called when the INA226 device is closed. + * + ****************************************************************************/ + +static int ina226_close(FAR struct file *filep) +{ + FAR struct inode *inode = filep->f_inode; + FAR struct ina226_dev_s *priv = inode->i_private; + + return ina226_write16(priv, INA226_REG_CONFIG, + priv->config | INA226_CONFIG_MODE_PWRDOWN); +} + +/**************************************************************************** + * Name: ina226_read + ****************************************************************************/ + +static ssize_t ina226_read(FAR struct file *filep, FAR char *buffer, + size_t buflen) +{ + FAR struct inode *inode = filep->f_inode; + FAR struct ina226_dev_s *priv = inode->i_private; + FAR struct ina226_s *ptr; + ssize_t nsamples; + int i; + int ret; + + /* How many samples were requested to get? */ + + nsamples = buflen / sizeof(struct ina226_s); + ptr = (FAR struct ina226_s *)buffer; + + sninfo("buflen: %d nsamples: %d\n", buflen, nsamples); + + /* Get the requested number of samples */ + + for (i = 0; i < nsamples; i++) + { + struct ina226_s pwr; + + /* Read the next struct ina226_s power value */ + + ret = ina226_readpower(priv, &pwr); + if (ret < 0) + { + snerr("ERROR: ina226_readpower failed: %d\n", ret); + return (ssize_t)ret; + } + + /* Save the power value in the user buffer */ + + *ptr++ = pwr; + } + + return nsamples * sizeof(struct ina226_s); +} + +/**************************************************************************** + * Name: ina226_write + ****************************************************************************/ + +static ssize_t ina226_write(FAR struct file *filep, FAR const char *buffer, + size_t buflen) +{ + return -ENOSYS; +} + +/**************************************************************************** + * Name: ina226_ioctl + ****************************************************************************/ + +static int ina226_ioctl(FAR struct file *filep, int cmd, unsigned long arg) +{ + return -ENOTTY; +} + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: ina226_register + * + * Description: + * Register the INA226 character device as 'devpath' + * + * Input Parameters: + * devpath - The full path to the driver to register. E.g., "/dev/pwrmntr0" + * i2c - An instance of the I2C interface to use to communicate with INA226 + * addr - The I2C address of the INA226. + * shuntval - the shunt resistor value in micro-ohms. + * config - a combination of the constants defined earlier in this file. + * + * Returned Value: + * Zero (OK) on success; a negated errno value on failure. + * + ****************************************************************************/ + +int ina226_register(FAR const char *devpath, FAR struct i2c_master_s *i2c, + uint8_t addr, int32_t shuntval, uint16_t config) +{ + FAR struct ina226_dev_s *priv; + int ret = 0; + + /* Sanity check */ + + DEBUGASSERT(i2c != NULL); + + /* Initialize the ina226 device structure */ + + priv = (FAR struct ina226_dev_s *)kmm_malloc(sizeof(struct ina226_dev_s)); + if (priv == NULL) + { + snerr("ERROR: Failed to allocate instance\n"); + return -ENOMEM; + } + + priv->i2c = i2c; + priv->addr = addr; + priv->shunt_resistor_value = shuntval; + + /* Save the config (except opmode) */ + + priv->config = config & ~INA226_CONFIG_MODE_MASK; + + /* Apply config, keep chip switched off */ + + ret = ina226_write16(priv, INA226_REG_CONFIG, + priv->config | INA226_CONFIG_MODE_PWRDOWN); + if (ret < 0) + { + snerr("ERROR: Failed to apply config: %d\n", ret); + goto errout; + } + + /* Register the character driver */ + + ret = register_driver(devpath, &g_ina226fops, 0666, priv); + if (ret < 0) + { + snerr("ERROR: Failed to register driver: %d\n", ret); + goto errout; + } + + sninfo("(addr=0x%02x) registered at %s\n", priv->addr, devpath); + return ret; + +errout: + kmm_free(priv); + return ret; +} diff --git a/include/nuttx/sensors/ina226.h b/include/nuttx/sensors/ina226.h new file mode 100644 index 0000000000..9e9e733a86 --- /dev/null +++ b/include/nuttx/sensors/ina226.h @@ -0,0 +1,168 @@ +/**************************************************************************** + * include/nuttx/sensors/ina226.h + * Character driver for the INA226 Power Sensor + * + * Copyright (C) 2017 Giorgio Groß. All rights reserved. + * Author: Giorgio Groß + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * 3. Neither the name NuttX nor the names of its contributors may be + * used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS + * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, + * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS + * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED + * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN + * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + ****************************************************************************/ + +#ifndef __INCLUDE_NUTTX_SENSORS_INA226_H +#define __INCLUDE_NUTTX_SENSORS_INA226_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include +#include + +#if defined(CONFIG_I2C) && defined(CONFIG_SENSORS_INA226) + +/**************************************************************************** + * Pre-processor Definitions + ****************************************************************************/ + +/* INA226 Register Definitions ***********************************************/ + +#define INA226_REG_CONFIG 0 /* See below */ +#define INA226_REG_SHUNT_VOLTAGE 1 /* Shunt voltage in 2.5 uV units */ +#define INA226_REG_BUS_VOLTAGE 2 /* Bus votlage in 1.25 mV units */ +#define INA226_REG_POWER 3 /* Requires prior calibration */ +#define INA226_REG_CURRENT 4 /* Requires prior calibration */ +#define INA226_REG_CALIBRATION 5 /* Calibration value to compute current */ +#define INA226_REG_MASK_ENABLE 6 /* Sets Alert pin function */ +#define INA226_REG_ALERT_LIMIT 7 /* Sets Alert pin limits */ + +/* INA226 Config Register bits */ + +/* Averaging mode */ + +#define INA226_CONFIG_AVG_SHIFT 9 +#define INA226_CONFIG_AVG_MASK (7 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_1 (0 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_4 (1 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_16 (2 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_64 (3 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_128 (4 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_256 (5 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_512 (6 << INA226_CONFIG_AVG_SHIFT) +#define INA226_CONFIG_AVG_1024 (7 << INA226_CONFIG_AVG_SHIFT) + +/* Bus voltage conversion time */ + +#define INA226_CONFIG_VBUSCT_SHIFT 6 +#define INA226_CONFIG_VBUSCT_MASK (7 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_140US (0 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_204US (1 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_332US (2 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_588US (3 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_1100US (4 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_2116US (5 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_4156US (6 << INA226_CONFIG_VBUSCT_SHIFT) +#define INA226_CONFIG_VBUSCT_8244US (7 << INA226_CONFIG_VBUSCT_SHIFT) + +/* Shunt voltage conversion time */ + +#define INA226_CONFIG_VSHCT_SHIFT 3 +#define INA226_CONFIG_VSHCT_MASK (7 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_140US (0 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_204US (1 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_332US (2 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_588US (3 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_1100US (4 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_2116US (5 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_4156US (6 << INA226_CONFIG_VSHCT_SHIFT) +#define INA226_CONFIG_VSHCT_8244US (7 << INA226_CONFIG_VSHCT_SHIFT) + +/* Operating mode */ + +#define INA226_CONFIG_MODE_SHIFT 0 +#define INA226_CONFIG_MODE_MASK (7 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_PWRDOWN (0 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_STRIG (1 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_BTRIG (2 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_SBTRIG (3 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_SCONT (5 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_BCONT (6 << INA226_CONFIG_MODE_SHIFT) +#define INA226_CONFIG_MODE_SBCONT (7 << INA226_CONFIG_MODE_SHIFT) + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +struct i2c_master_s; + +struct ina226_s +{ + uint32_t voltage; /* FS range: 40.96V; LSB: 1.25mV; Device max: 36V. */ + int32_t current; /* [microampere] max 2.1 kA - sensor is bidirectional */ +}; + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +#ifdef __cplusplus +#define EXTERN extern "C" +extern "C" +{ +#else +#define EXTERN extern +#endif + +/**************************************************************************** + * Name: ina226_register + * + * Description: + * Register the INA226 character device as 'devpath' + * + * Input Parameters: + * devpath - The full path to the driver to register. E.g., "/dev/pwrmntr0" + * i2c - An instance of the I2C interface to use to communicate with INA226 + * addr - The I2C address of the INA226. + * shuntval - resistor value in microohms + * config - a combination of the constants defined earlier in this file. + * + * Returned Value: + * Zero (OK) on success; a negated errno value on failure. + * + ****************************************************************************/ + +int ina226_register(FAR const char *devpath, FAR struct i2c_master_s *i2c, + uint8_t addr, int32_t shuntval, uint16_t config); + +#undef EXTERN +#ifdef __cplusplus +} +#endif + +#endif /* CONFIG_I2C && CONFIG_SENSORS_INA226 */ +#endif /* __INCLUDE_NUTTX_SENSORS_INA226_H */