153 lines
6.4 KiB
C
153 lines
6.4 KiB
C
/****************************************************************************
|
|
* include/nuttx/sensors/ina226.h
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_SENSORS_INA226_H
|
|
#define __INCLUDE_NUTTX_SENSORS_INA226_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <nuttx/sensors/ioctl.h>
|
|
|
|
#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 */
|