/* ST Microelectronics IIS2ICLX 2-axis accelerometer sensor driver * * Copyright (c) 2020 STMicroelectronics * * SPDX-License-Identifier: Apache-2.0 * * Datasheet: * https://www.st.com/resource/en/datasheet/iis2iclx.pdf */ #define DT_DRV_COMPAT st_iis2iclx #include #include #include #include #include #include #include #include "iis2iclx.h" LOG_MODULE_REGISTER(IIS2ICLX, CONFIG_SENSOR_LOG_LEVEL); static const uint16_t iis2iclx_odr_map[] = {0, 12, 26, 52, 104, 208, 416, 833, 1660, 3330, 6660}; static int iis2iclx_freq_to_odr_val(uint16_t freq) { size_t i; for (i = 0; i < ARRAY_SIZE(iis2iclx_odr_map); i++) { if (freq <= iis2iclx_odr_map[i]) { return i; } } return -EINVAL; } static int iis2iclx_odr_to_freq_val(uint16_t odr) { /* for valid index, return value from map */ if (odr < ARRAY_SIZE(iis2iclx_odr_map)) { return iis2iclx_odr_map[odr]; } /* invalid index, return last entry */ return iis2iclx_odr_map[ARRAY_SIZE(iis2iclx_odr_map) - 1]; } static const uint16_t iis2iclx_accel_fs_map[] = {500, 3000, 1000, 2000}; /* fs in mg */ static const uint16_t iis2iclx_accel_fs_sens[] = {1, 8, 2, 4}; static int iis2iclx_accel_range_to_fs_val(int32_t range) { size_t i; for (i = 0; i < ARRAY_SIZE(iis2iclx_accel_fs_map); i++) { if (range == iis2iclx_accel_fs_map[i]) { return i; } } return -EINVAL; } static inline int iis2iclx_reboot(const struct device *dev) { const struct iis2iclx_config *cfg = dev->config; if (iis2iclx_boot_set((stmdev_ctx_t *)&cfg->ctx, 1) < 0) { return -EIO; } /* Wait sensor turn-on time as per datasheet */ k_msleep(35); return 0; } static int iis2iclx_accel_set_fs_raw(const struct device *dev, uint8_t fs) { const struct iis2iclx_config *cfg = dev->config; struct iis2iclx_data *data = dev->data; if (iis2iclx_xl_full_scale_set((stmdev_ctx_t *)&cfg->ctx, fs) < 0) { return -EIO; } data->accel_fs = fs; return 0; } static int iis2iclx_accel_set_odr_raw(const struct device *dev, uint8_t odr) { const struct iis2iclx_config *cfg = dev->config; struct iis2iclx_data *data = dev->data; if (iis2iclx_xl_data_rate_set((stmdev_ctx_t *)&cfg->ctx, odr) < 0) { return -EIO; } data->accel_freq = iis2iclx_odr_to_freq_val(odr); return 0; } static int iis2iclx_accel_odr_set(const struct device *dev, uint16_t freq) { int odr; odr = iis2iclx_freq_to_odr_val(freq); if (odr < 0) { return odr; } if (iis2iclx_accel_set_odr_raw(dev, odr) < 0) { LOG_ERR("failed to set accelerometer sampling rate"); return -EIO; } return 0; } static int iis2iclx_accel_range_set(const struct device *dev, int32_t range) { int fs; struct iis2iclx_data *data = dev->data; fs = iis2iclx_accel_range_to_fs_val(range * 1000); /* pass range in mg */ if (fs < 0) { return fs; } if (iis2iclx_accel_set_fs_raw(dev, fs) < 0) { LOG_ERR("failed to set accelerometer full-scale"); return -EIO; } data->acc_gain = (iis2iclx_accel_fs_sens[fs] * GAIN_UNIT_XL); return 0; } static int iis2iclx_accel_config(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, const struct sensor_value *val) { switch (attr) { case SENSOR_ATTR_FULL_SCALE: return iis2iclx_accel_range_set(dev, sensor_ms2_to_g(val)); case SENSOR_ATTR_SAMPLING_FREQUENCY: return iis2iclx_accel_odr_set(dev, val->val1); default: LOG_ERR("Accel attribute not supported."); return -ENOTSUP; } return 0; } static int iis2iclx_attr_set(const struct device *dev, enum sensor_channel chan, enum sensor_attribute attr, const struct sensor_value *val) { #if defined(CONFIG_IIS2ICLX_SENSORHUB) struct iis2iclx_data *data = dev->data; #endif /* CONFIG_IIS2ICLX_SENSORHUB */ switch (chan) { case SENSOR_CHAN_ACCEL_XYZ: return iis2iclx_accel_config(dev, chan, attr, val); #if defined(CONFIG_IIS2ICLX_SENSORHUB) case SENSOR_CHAN_MAGN_XYZ: case SENSOR_CHAN_PRESS: case SENSOR_CHAN_HUMIDITY: if (!data->shub_inited) { LOG_ERR("shub not inited."); return -ENOTSUP; } return iis2iclx_shub_config(dev, chan, attr, val); #endif /* CONFIG_IIS2ICLX_SENSORHUB */ default: LOG_ERR("attr_set() not supported on this channel."); return -ENOTSUP; } return 0; } static int iis2iclx_sample_fetch_accel(const struct device *dev) { const struct iis2iclx_config *cfg = dev->config; struct iis2iclx_data *data = dev->data; int16_t buf[2]; if (iis2iclx_acceleration_raw_get((stmdev_ctx_t *)&cfg->ctx, buf) < 0) { LOG_ERR("Failed to read sample"); return -EIO; } data->acc[0] = buf[0]; data->acc[1] = buf[1]; return 0; } #if defined(CONFIG_IIS2ICLX_ENABLE_TEMP) static int iis2iclx_sample_fetch_temp(const struct device *dev) { struct iis2iclx_data *data = dev->data; const struct iis2iclx_config *cfg = dev->config; int16_t buf; if (iis2iclx_temperature_raw_get((stmdev_ctx_t *)&cfg->ctx, &buf) < 0) { LOG_ERR("Failed to read sample"); return -EIO; } data->temp_sample = buf; return 0; } #endif #if defined(CONFIG_IIS2ICLX_SENSORHUB) static int iis2iclx_sample_fetch_shub(const struct device *dev) { if (iis2iclx_shub_fetch_external_devs(dev) < 0) { LOG_ERR("failed to read ext shub devices"); return -EIO; } return 0; } #endif /* CONFIG_IIS2ICLX_SENSORHUB */ static int iis2iclx_sample_fetch(const struct device *dev, enum sensor_channel chan) { #if defined(CONFIG_IIS2ICLX_SENSORHUB) struct iis2iclx_data *data = dev->data; #endif /* CONFIG_IIS2ICLX_SENSORHUB */ switch (chan) { case SENSOR_CHAN_ACCEL_XYZ: iis2iclx_sample_fetch_accel(dev); break; #if defined(CONFIG_IIS2ICLX_ENABLE_TEMP) case SENSOR_CHAN_DIE_TEMP: iis2iclx_sample_fetch_temp(dev); break; #endif case SENSOR_CHAN_ALL: iis2iclx_sample_fetch_accel(dev); #if defined(CONFIG_IIS2ICLX_ENABLE_TEMP) iis2iclx_sample_fetch_temp(dev); #endif #if defined(CONFIG_IIS2ICLX_SENSORHUB) if (data->shub_inited) { iis2iclx_sample_fetch_shub(dev); } #endif break; default: return -ENOTSUP; } return 0; } static inline void iis2iclx_accel_convert(struct sensor_value *val, int raw_val, uint32_t sensitivity) { int64_t dval; /* Sensitivity is exposed in ug/LSB */ /* Convert to m/s^2 */ dval = (int64_t)(raw_val) * sensitivity; sensor_ug_to_ms2(dval, val); } static inline int iis2iclx_accel_get_channel(enum sensor_channel chan, struct sensor_value *val, struct iis2iclx_data *data, uint32_t sensitivity) { uint8_t i; switch (chan) { case SENSOR_CHAN_ACCEL_X: iis2iclx_accel_convert(val, data->acc[0], sensitivity); break; case SENSOR_CHAN_ACCEL_Y: iis2iclx_accel_convert(val, data->acc[1], sensitivity); break; case SENSOR_CHAN_ACCEL_XYZ: for (i = 0; i < 2; i++) { iis2iclx_accel_convert(val++, data->acc[i], sensitivity); } break; default: return -ENOTSUP; } return 0; } static int iis2iclx_accel_channel_get(enum sensor_channel chan, struct sensor_value *val, struct iis2iclx_data *data) { return iis2iclx_accel_get_channel(chan, val, data, data->acc_gain); } #if defined(CONFIG_IIS2ICLX_ENABLE_TEMP) static void iis2iclx_temp_channel_get(struct sensor_value *val, struct iis2iclx_data *data) { /* val = temp_sample / 256 + 25 */ val->val1 = data->temp_sample / 256 + 25; val->val2 = (data->temp_sample % 256) * (1000000 / 256); } #endif #if defined(CONFIG_IIS2ICLX_SENSORHUB) static inline void iis2iclx_magn_convert(struct sensor_value *val, int raw_val, uint16_t sensitivity) { double dval; /* Sensitivity is exposed in ugauss/LSB */ dval = (double)(raw_val * sensitivity); val->val1 = (int32_t)dval / 1000000; val->val2 = (int32_t)dval % 1000000; } static inline int iis2iclx_magn_get_channel(enum sensor_channel chan, struct sensor_value *val, struct iis2iclx_data *data) { int16_t sample[3]; int idx; idx = iis2iclx_shub_get_idx(data->dev, SENSOR_CHAN_MAGN_XYZ); if (idx < 0) { LOG_ERR("external magn not supported"); return -ENOTSUP; } sample[0] = (int16_t)(data->ext_data[idx][0] | (data->ext_data[idx][1] << 8)); sample[1] = (int16_t)(data->ext_data[idx][2] | (data->ext_data[idx][3] << 8)); sample[2] = (int16_t)(data->ext_data[idx][4] | (data->ext_data[idx][5] << 8)); switch (chan) { case SENSOR_CHAN_MAGN_X: iis2iclx_magn_convert(val, sample[0], data->magn_gain); break; case SENSOR_CHAN_MAGN_Y: iis2iclx_magn_convert(val, sample[1], data->magn_gain); break; case SENSOR_CHAN_MAGN_Z: iis2iclx_magn_convert(val, sample[2], data->magn_gain); break; case SENSOR_CHAN_MAGN_XYZ: iis2iclx_magn_convert(val, sample[0], data->magn_gain); iis2iclx_magn_convert(val + 1, sample[1], data->magn_gain); iis2iclx_magn_convert(val + 2, sample[2], data->magn_gain); break; default: return -ENOTSUP; } return 0; } static inline void iis2iclx_hum_convert(struct sensor_value *val, struct iis2iclx_data *data) { float rh; int16_t raw_val; struct hts221_data *ht = &data->hts221; int idx; idx = iis2iclx_shub_get_idx(data->dev, SENSOR_CHAN_HUMIDITY); if (idx < 0) { LOG_DBG("external press/temp not supported"); return; } raw_val = ((int16_t)(data->ext_data[idx][0] | (data->ext_data[idx][1] << 8))); /* find relative humidty by linear interpolation */ rh = (ht->y1 - ht->y0) * raw_val + ht->x1 * ht->y0 - ht->x0 * ht->y1; rh /= (ht->x1 - ht->x0); /* convert humidity to integer and fractional part */ val->val1 = rh; val->val2 = rh * 1000000; } static inline void iis2iclx_press_convert(struct sensor_value *val, struct iis2iclx_data *data) { int32_t raw_val; int idx; idx = iis2iclx_shub_get_idx(data->dev, SENSOR_CHAN_PRESS); if (idx < 0) { LOG_DBG("external press/temp not supported"); return; } raw_val = (int32_t)(data->ext_data[idx][0] | (data->ext_data[idx][1] << 8) | (data->ext_data[idx][2] << 16)); /* Pressure sensitivity is 4096 LSB/hPa */ /* Convert raw_val to val in kPa */ val->val1 = (raw_val >> 12) / 10; val->val2 = (raw_val >> 12) % 10 * 100000 + (((int32_t)((raw_val) & 0x0FFF) * 100000L) >> 12); } static inline void iis2iclx_temp_convert(struct sensor_value *val, struct iis2iclx_data *data) { int16_t raw_val; int idx; idx = iis2iclx_shub_get_idx(data->dev, SENSOR_CHAN_PRESS); if (idx < 0) { LOG_DBG("external press/temp not supported"); return; } raw_val = (int16_t)(data->ext_data[idx][3] | (data->ext_data[idx][4] << 8)); /* Temperature sensitivity is 100 LSB/deg C */ val->val1 = raw_val / 100; val->val2 = (int32_t)raw_val % 100 * (10000); } #endif static int iis2iclx_channel_get(const struct device *dev, enum sensor_channel chan, struct sensor_value *val) { struct iis2iclx_data *data = dev->data; switch (chan) { case SENSOR_CHAN_ACCEL_X: case SENSOR_CHAN_ACCEL_Y: case SENSOR_CHAN_ACCEL_Z: case SENSOR_CHAN_ACCEL_XYZ: iis2iclx_accel_channel_get(chan, val, data); break; #if defined(CONFIG_IIS2ICLX_ENABLE_TEMP) case SENSOR_CHAN_DIE_TEMP: iis2iclx_temp_channel_get(val, data); break; #endif #if defined(CONFIG_IIS2ICLX_SENSORHUB) case SENSOR_CHAN_MAGN_X: case SENSOR_CHAN_MAGN_Y: case SENSOR_CHAN_MAGN_Z: case SENSOR_CHAN_MAGN_XYZ: if (!data->shub_inited) { LOG_ERR("attr_set() shub not inited."); return -ENOTSUP; } iis2iclx_magn_get_channel(chan, val, data); break; case SENSOR_CHAN_HUMIDITY: if (!data->shub_inited) { LOG_ERR("attr_set() shub not inited."); return -ENOTSUP; } iis2iclx_hum_convert(val, data); break; case SENSOR_CHAN_PRESS: if (!data->shub_inited) { LOG_ERR("attr_set() shub not inited."); return -ENOTSUP; } iis2iclx_press_convert(val, data); break; case SENSOR_CHAN_AMBIENT_TEMP: if (!data->shub_inited) { LOG_ERR("attr_set() shub not inited."); return -ENOTSUP; } iis2iclx_temp_convert(val, data); break; #endif default: return -ENOTSUP; } return 0; } static DEVICE_API(sensor, iis2iclx_driver_api) = { .attr_set = iis2iclx_attr_set, #if CONFIG_IIS2ICLX_TRIGGER .trigger_set = iis2iclx_trigger_set, #endif .sample_fetch = iis2iclx_sample_fetch, .channel_get = iis2iclx_channel_get, }; static int iis2iclx_init_chip(const struct device *dev) { const struct iis2iclx_config * const cfg = dev->config; struct iis2iclx_data *iis2iclx = dev->data; uint8_t chip_id; uint8_t odr = cfg->odr; uint8_t fs = cfg->range; iis2iclx->dev = dev; if (iis2iclx_device_id_get((stmdev_ctx_t *)&cfg->ctx, &chip_id) < 0) { LOG_ERR("Failed reading chip id"); return -EIO; } LOG_INF("chip id 0x%x", chip_id); if (chip_id != IIS2ICLX_ID) { LOG_ERR("Invalid chip id 0x%x", chip_id); return -EIO; } /* reset device */ if (iis2iclx_reset_set((stmdev_ctx_t *)&cfg->ctx, 1) < 0) { return -EIO; } k_usleep(100); LOG_DBG("range is %d", fs); if (iis2iclx_accel_set_fs_raw(dev, fs) < 0) { LOG_ERR("failed to set accelerometer full-scale"); return -EIO; } iis2iclx->acc_gain = (iis2iclx_accel_fs_sens[fs] * GAIN_UNIT_XL); LOG_DBG("odr is %d", odr); if (iis2iclx_accel_set_odr_raw(dev, odr) < 0) { LOG_ERR("failed to set accelerometer sampling rate"); return -EIO; } /* Set FIFO bypass mode */ if (iis2iclx_fifo_mode_set((stmdev_ctx_t *)&cfg->ctx, IIS2ICLX_BYPASS_MODE) < 0) { LOG_ERR("failed to set FIFO mode"); return -EIO; } if (iis2iclx_block_data_update_set((stmdev_ctx_t *)&cfg->ctx, 1) < 0) { LOG_ERR("failed to set BDU mode"); return -EIO; } return 0; } static int iis2iclx_init(const struct device *dev) { #ifdef CONFIG_IIS2ICLX_TRIGGER const struct iis2iclx_config *cfg = dev->config; #endif struct iis2iclx_data *data = dev->data; LOG_INF("Initialize device %s", dev->name); data->dev = dev; if (iis2iclx_init_chip(dev) < 0) { LOG_ERR("failed to initialize chip"); return -EIO; } #ifdef CONFIG_IIS2ICLX_TRIGGER if (cfg->trig_enabled) { if (iis2iclx_init_interrupt(dev) < 0) { LOG_ERR("Failed to initialize interrupt."); return -EIO; } } #endif #ifdef CONFIG_IIS2ICLX_SENSORHUB data->shub_inited = true; if (iis2iclx_shub_init(dev) < 0) { LOG_INF("shub: no external chips found"); data->shub_inited = false; } #endif return 0; } #if DT_NUM_INST_STATUS_OKAY(DT_DRV_COMPAT) == 0 #warning "IIS2ICLX driver enabled without any devices" #endif /* * Device creation macro, shared by IIS2ICLX_DEFINE_SPI() and * IIS2ICLX_DEFINE_I2C(). */ #define IIS2ICLX_DEVICE_INIT(inst) \ SENSOR_DEVICE_DT_INST_DEFINE(inst, \ iis2iclx_init, \ NULL, \ &iis2iclx_data_##inst, \ &iis2iclx_config_##inst, \ POST_KERNEL, \ CONFIG_SENSOR_INIT_PRIORITY, \ &iis2iclx_driver_api); /* * Instantiation macros used when a device is on a SPI bus. */ #ifdef CONFIG_IIS2ICLX_TRIGGER #define IIS2ICLX_CFG_IRQ(inst) \ .trig_enabled = true, \ .gpio_drdy = GPIO_DT_SPEC_INST_GET(inst, drdy_gpios), \ .int_pin = DT_INST_PROP(inst, int_pin) #else #define IIS2ICLX_CFG_IRQ(inst) #endif /* CONFIG_IIS2ICLX_TRIGGER */ #define IIS2ICLX_CONFIG_COMMON(inst) \ .odr = DT_INST_PROP(inst, odr), \ .range = DT_INST_PROP(inst, range), \ COND_CODE_1(DT_INST_NODE_HAS_PROP(inst, drdy_gpios), \ (IIS2ICLX_CFG_IRQ(inst)), ()) #define IIS2ICLX_SPI_OPERATION (SPI_WORD_SET(8) | \ SPI_OP_MODE_MASTER | \ SPI_MODE_CPOL | \ SPI_MODE_CPHA) \ #define IIS2ICLX_CONFIG_SPI(inst) \ { \ STMEMSC_CTX_SPI(&iis2iclx_config_##inst.stmemsc_cfg), \ .stmemsc_cfg = { \ .spi = SPI_DT_SPEC_INST_GET(inst, \ IIS2ICLX_SPI_OPERATION, \ 0), \ }, \ IIS2ICLX_CONFIG_COMMON(inst) \ } /* * Instantiation macros used when a device is on an I2C bus. */ #define IIS2ICLX_CONFIG_I2C(inst) \ { \ STMEMSC_CTX_I2C(&iis2iclx_config_##inst.stmemsc_cfg), \ .stmemsc_cfg = { \ .i2c = I2C_DT_SPEC_INST_GET(inst), \ }, \ IIS2ICLX_CONFIG_COMMON(inst) \ } /* * Main instantiation macro. Use of COND_CODE_1() selects the right * bus-specific macro at preprocessor time. */ #define IIS2ICLX_DEFINE(inst) \ static struct iis2iclx_data iis2iclx_data_##inst; \ static const struct iis2iclx_config iis2iclx_config_##inst = \ COND_CODE_1(DT_INST_ON_BUS(inst, spi), \ (IIS2ICLX_CONFIG_SPI(inst)), \ (IIS2ICLX_CONFIG_I2C(inst))); \ IIS2ICLX_DEVICE_INIT(inst) DT_INST_FOREACH_STATUS_OKAY(IIS2ICLX_DEFINE)