blob: 29fd751143fb9ecd59bc17e2caec6627fe75694b [file] [log] [blame]
/* HopeRF Electronic HP206C precision barometer and altimeter driver
*
* Copyright (c) 2016 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*
* Datasheet:
* http://www.hoperf.com/upload/sensor/HP206C_DataSheet_EN_V2.0.pdf
*/
#define DT_DRV_COMPAT hoperf_hp206c
#include <zephyr/init.h>
#include <zephyr/drivers/sensor.h>
#include <zephyr/drivers/i2c.h>
#include <zephyr/sys/byteorder.h>
#include <zephyr/kernel.h>
#include <zephyr/logging/log.h>
#include "hp206c.h"
LOG_MODULE_REGISTER(HP206C, CONFIG_SENSOR_LOG_LEVEL);
static inline int hp206c_bus_config(const struct device *dev)
{
const struct hp206c_device_config *cfg = dev->config;
uint32_t i2c_cfg;
i2c_cfg = I2C_MODE_CONTROLLER | I2C_SPEED_SET(I2C_SPEED_STANDARD);
return i2c_configure(cfg->i2c.bus, i2c_cfg);
}
static int hp206c_read(const struct device *dev, uint8_t cmd, uint8_t *data,
uint8_t len)
{
const struct hp206c_device_config *cfg = dev->config;
hp206c_bus_config(dev);
if (i2c_burst_read_dt(&cfg->i2c, cmd, data, len) < 0) {
return -EIO;
}
return 0;
}
static int hp206c_read_reg(const struct device *dev, uint8_t reg_addr,
uint8_t *reg_val)
{
uint8_t cmd = HP206C_CMD_READ_REG | (reg_addr & HP206C_REG_ADDR_MASK);
return hp206c_read(dev, cmd, reg_val, 1);
}
static int hp206c_write(const struct device *dev, uint8_t cmd, uint8_t *data,
uint8_t len)
{
const struct hp206c_device_config *cfg = dev->config;
hp206c_bus_config(dev);
if (i2c_burst_write_dt(&cfg->i2c, cmd, data, len) < 0) {
return -EIO;
}
return 0;
}
static int hp206c_write_reg(const struct device *dev, uint8_t reg_addr,
uint8_t reg_val)
{
uint8_t cmd = HP206C_CMD_WRITE_REG | (reg_addr & HP206C_REG_ADDR_MASK);
return hp206c_write(dev, cmd, &reg_val, 1);
}
static int hp206c_cmd_send(const struct device *dev, uint8_t cmd)
{
const struct hp206c_device_config *cfg = dev->config;
hp206c_bus_config(dev);
return i2c_write_dt(&cfg->i2c, &cmd, 1);
}
/*
* The conversion times in this map were rounded up. The reason for doing that
* is merely to spare 24 bytes that, otherwise, would've been taken by having
* the times converted to microseconds. The trade-off is 900us added to the
* conversion wait time which looks like a good compromise provided the highest
* precision computation takes 131.1ms.
*/
static uint8_t hp206c_adc_time_ms[] = {
/* conversion time(ms), OSR */
132, /* 4096 */
66, /* 2048 */
34, /* 1024 */
17, /* 512 */
9, /* 256 */
5, /* 128 */
};
static int hp206c_osr_set(const struct device *dev, uint16_t osr)
{
struct hp206c_device_data *hp206c = dev->data;
uint8_t i;
/* the following code translates OSR values to an index */
for (i = 0U; i < 6 && BIT(12 - i) != osr; i++) {
}
if (i == 6U) {
return -ENOTSUP;
}
hp206c->osr = i;
return 0;
}
static int hp206c_altitude_offs_set(const struct device *dev, int16_t offs)
{
uint8_t reg_val;
reg_val = offs & 0xff;
if (hp206c_write_reg(dev, HP206C_REG_ALT_OFF_LSB, reg_val) < 0) {
return -EIO;
}
reg_val = (offs & 0xff00) >> 8;
if (hp206c_write_reg(dev, HP206C_REG_ALT_OFF_MSB, reg_val) < 0) {
return -EIO;
}
return hp206c_write_reg(dev, HP206C_REG_PARA, HP206C_COMPENSATION_EN);
}
static int hp206c_attr_set(const struct device *dev, enum sensor_channel chan,
enum sensor_attribute attr,
const struct sensor_value *val)
{
#ifdef CONFIG_HP206C_OSR_RUNTIME
if (attr == SENSOR_ATTR_OVERSAMPLING) {
return hp206c_osr_set(dev, val->val1);
}
#endif
#ifdef CONFIG_HP206C_ALT_OFFSET_RUNTIME
if (attr == SENSOR_ATTR_OFFSET) {
if (chan != SENSOR_CHAN_ALTITUDE) {
return -ENOTSUP;
}
return hp206c_altitude_offs_set(dev, val->val1);
}
#endif
return -ENOTSUP;
}
static int hp206c_wait_dev_ready(const struct device *dev,
uint32_t timeout_ms)
{
struct hp206c_device_data *hp206c = dev->data;
uint8_t int_src;
k_timer_start(&hp206c->tmr, K_MSEC(timeout_ms), K_NO_WAIT);
k_timer_status_sync(&hp206c->tmr);
if (hp206c_read_reg(dev, HP206C_REG_INT_SRC, &int_src) < 0) {
return -EIO;
}
if (int_src & HP206C_DEV_RDY) {
return 0;
}
return -EBUSY;
}
static int hp206c_adc_acquire(const struct device *dev,
enum sensor_channel chan)
{
struct hp206c_device_data *hp206c = dev->data;
if (hp206c_cmd_send(dev, HP206C_CMD_ADC_CVT | (hp206c->osr << 2)) < 0) {
return -EIO;
}
return hp206c_wait_dev_ready(dev, hp206c_adc_time_ms[hp206c->osr]);
}
static int32_t hp206c_buf_convert(uint8_t *buf, bool signed_val)
{
int32_t tmp = 0;
if (signed_val && (buf[0] & 0x08)) {
tmp |= (0xff << 24) | (0xf0 << 16);
}
tmp |= ((buf[0] & 0x0f) << 16) | (buf[1] << 8) | buf[2];
return tmp;
}
static int hp206c_val_get(const struct device *dev,
uint8_t cmd, struct sensor_value *val)
{
uint8_t buf[3];
int32_t temp = 0;
if (hp206c_read(dev, cmd, buf, 3) < 0) {
return -EIO;
}
/*
* According to documentation, pressure and altitude are 20 bit unsigned
* values whereas temperature is a signed.
*/
if (cmd == HP206C_CMD_READ_T) {
temp = hp206c_buf_convert(buf, true);
} else {
temp = hp206c_buf_convert(buf, false);
}
if (cmd == HP206C_CMD_READ_P) {
val->val1 = temp / 1000;
val->val2 = temp % 1000 * 1000;
} else {
val->val1 = temp / 100;
val->val2 = temp % 100 * 10000;
}
return 0;
}
static inline int hp206c_pressure_get(const struct device *dev,
struct sensor_value *val)
{
return hp206c_val_get(dev, HP206C_CMD_READ_P, val);
}
static inline int hp206c_altitude_get(const struct device *dev,
struct sensor_value *val)
{
return hp206c_val_get(dev, HP206C_CMD_READ_A, val);
}
static inline int hp206c_temperature_get(const struct device *dev,
struct sensor_value *val)
{
return hp206c_val_get(dev, HP206C_CMD_READ_T, val);
}
static int hp206c_channel_get(const struct device *dev,
enum sensor_channel chan,
struct sensor_value *val)
{
switch (chan) {
case SENSOR_CHAN_AMBIENT_TEMP:
return hp206c_temperature_get(dev, val);
case SENSOR_CHAN_PRESS:
return hp206c_pressure_get(dev, val);
case SENSOR_CHAN_ALTITUDE:
return hp206c_altitude_get(dev, val);
default:
return -ENOTSUP;
}
return 0;
}
static const struct sensor_driver_api hp206c_api = {
.attr_set = hp206c_attr_set,
.sample_fetch = hp206c_adc_acquire,
.channel_get = hp206c_channel_get,
};
static int hp206c_init(const struct device *dev)
{
struct hp206c_device_data *hp206c = dev->data;
const struct hp206c_device_config *cfg = dev->config;
if (!device_is_ready(cfg->i2c.bus)) {
LOG_ERR("Bus device is not ready");
return -EINVAL;
}
/* reset the chip */
if (hp206c_cmd_send(dev, HP206C_CMD_SOFT_RST) < 0) {
LOG_ERR("Cannot reset chip.");
return -EIO;
}
k_timer_init(&hp206c->tmr, NULL, NULL);
k_busy_wait(500);
if (hp206c_osr_set(dev, HP206C_DEFAULT_OSR) < 0) {
LOG_ERR("OSR value is not supported.");
return -ENOTSUP;
}
if (hp206c_altitude_offs_set(dev, HP206C_DEFAULT_ALT_OFFSET) < 0) {
return -EIO;
}
return 0;
}
#define HP206C_DEFINE(inst) \
static struct hp206c_device_data hp206c_data_##inst; \
\
static const struct hp206c_device_config hp206c_config_##inst = { \
.i2c = I2C_DT_SPEC_INST_GET(inst), \
}; \
\
SENSOR_DEVICE_DT_INST_DEFINE(inst, hp206c_init, NULL, \
&hp206c_data_##inst, &hp206c_config_##inst, POST_KERNEL, \
CONFIG_SENSOR_INIT_PRIORITY, &hp206c_api); \
DT_INST_FOREACH_STATUS_OKAY(HP206C_DEFINE)