/* * Copyright (c) 2019 Vestas Wind Systems A/S * Copyright (c) 2020 Innoseis BV * * SPDX-License-Identifier: Apache-2.0 */ #include #include #include #include #include #include #include #include #define ADC_CONTEXT_USES_KERNEL_TIMER 1 #include "adc_context.h" #define DT_DRV_COMPAT ti_ads1119 LOG_MODULE_REGISTER(ADS1119, CONFIG_ADC_LOG_LEVEL); #define ADS1119_CONFIG_VREF(x) ((x) & BIT(0)) #define ADS1119_CONFIG_CM(x) ((x) & BIT(1)) #define ADS1119_CONFIG_DR(x) ((x) & (BIT_MASK(2) << 2)) #define ADS1119_CONFIG_GAIN(x) ((x) & BIT(4)) #define ADS1119_CONFIG_MUX(x) ((x) & (BIT_MASK(3) << 5)) #define ADS1119_STATUS_MASK_ID BIT_MASK(7) #define ADS1119_STATUS_MASK_READY BIT(7) #define ADS1119_REG_SHIFT 2 #define ADS1119_RESOLUTION 16 #define ADS1119_REF_INTERNAL 2048 enum ads1119_cmd { ADS1119_CMD_RESET = 0x06, ADS1119_CMD_START_SYNC = 0x08, ADS1119_CMD_POWER_DOWN = 0x02, ADS1119_CMD_READ_DATA = 0x10, ADS1119_CMD_READ_REG = 0x20, ADS1119_CMD_WRITE_REG = 0x40, }; enum ads1119_reg { ADS1119_REG_CONFIG = 0 << ADS1119_REG_SHIFT, ADS1119_REG_STATUS = 1 << ADS1119_REG_SHIFT, }; enum { ADS1119_CONFIG_VREF_INTERNAL = 0, ADS1119_CONFIG_VREF_EXTERNAL = 1, }; enum { ADS1119_CONFIG_MUX_DIFF_0_1 = 0, ADS1119_CONFIG_MUX_DIFF_2_3 = 1, ADS1119_CONFIG_MUX_DIFF_1_2 = 2, ADS1119_CONFIG_MUX_SINGLE_0 = 3, ADS1119_CONFIG_MUX_SINGLE_1 = 4, ADS1119_CONFIG_MUX_SINGLE_2 = 5, ADS1119_CONFIG_MUX_SINGLE_3 = 6, ADS1119_CONFIG_MUX_SHORTED = 7, }; enum { ADS1119_CONFIG_DR_20 = 0, ADS1119_CONFIG_DR_90 = 1, ADS1119_CONFIG_DR_330 = 2, ADS1119_CONFIG_DR_1000 = 3, ADS1119_CONFIG_DR_DEFAULT = ADS1119_CONFIG_DR_20, }; enum { ADS1119_CONFIG_GAIN_1 = 0, ADS1119_CONFIG_GAIN_4 = 1, }; enum { ADS1119_CONFIG_CM_SINGLE = 0, ADS1119_CONFIG_CM_CONTINUOUS = 1, }; struct ads1119_config { const struct i2c_dt_spec bus; #if CONFIG_ADC_ASYNC k_thread_stack_t *stack; #endif }; struct ads1119_data { struct adc_context ctx; k_timeout_t ready_time; struct k_sem acq_sem; int16_t *buffer; int16_t *buffer_ptr; #if CONFIG_ADC_ASYNC struct k_thread thread; #endif bool differential; }; static int ads1119_read_reg(const struct device *dev, enum ads1119_reg reg_addr, uint8_t *reg_val) { const struct ads1119_config *config = dev->config; return i2c_reg_read_byte_dt(&config->bus, ADS1119_CMD_READ_REG | reg_addr, reg_val); } static int ads1119_write_reg(const struct device *dev, uint8_t reg) { const struct ads1119_config *config = dev->config; return i2c_reg_write_byte_dt(&config->bus, ADS1119_CMD_WRITE_REG, reg); } static inline int ads1119_acq_time_to_dr(const struct device *dev, uint16_t acq_time) { struct ads1119_data *data = dev->data; int odr = -EINVAL; uint16_t acq_value = ADC_ACQ_TIME_VALUE(acq_time); uint16_t ready_time_us = 0; if (acq_time == ADC_ACQ_TIME_DEFAULT) { acq_value = ADS1119_CONFIG_DR_DEFAULT; } else if (ADC_ACQ_TIME_UNIT(acq_time) != ADC_ACQ_TIME_TICKS) { return -EINVAL; } switch (acq_value) { case ADS1119_CONFIG_DR_20: odr = ADS1119_CONFIG_DR_20; ready_time_us = (1000*1000) / 20; break; case ADS1119_CONFIG_DR_90: odr = ADS1119_CONFIG_DR_90; ready_time_us = (1000*1000) / 90; break; case ADS1119_CONFIG_DR_330: odr = ADS1119_CONFIG_DR_330; ready_time_us = (1000*1000) / 330; break; case ADS1119_CONFIG_DR_1000: odr = ADS1119_CONFIG_DR_1000; ready_time_us = (1000*1000) / 1000; break; default: break; } /* As per datasheet acquisition time is a bit longer wait a bit more * to ensure data ready at first try */ data->ready_time = K_USEC(ready_time_us + 10); return odr; } static int ads1119_send_start_read(const struct device *dev) { const struct ads1119_config *config = dev->config; const uint8_t cmd = ADS1119_CMD_START_SYNC; return i2c_write_dt(&config->bus, &cmd, sizeof(cmd)); } static int ads1119_wait_data_ready(const struct device *dev) { int rc; struct ads1119_data *data = dev->data; k_sleep(data->ready_time); uint8_t status = 0; rc = ads1119_read_reg(dev, ADS1119_REG_STATUS, &status); if (rc != 0) { return rc; } while ((status & ADS1119_STATUS_MASK_READY) == 0) { k_sleep(K_USEC(100)); rc = ads1119_read_reg(dev, ADS1119_REG_STATUS, &status); if (rc != 0) { return rc; } } return 0; } static int ads1119_read_sample(const struct device *dev, uint16_t *buff) { int res; uint8_t rx_bytes[2]; const struct ads1119_config *config = dev->config; const uint8_t cmd = ADS1119_CMD_READ_DATA; res = i2c_write_read_dt(&config->bus, &cmd, sizeof(cmd), rx_bytes, sizeof(rx_bytes)); *buff = sys_get_be16(rx_bytes); return res; } static int ads1119_channel_setup(const struct device *dev, const struct adc_channel_cfg *channel_cfg) { struct ads1119_data *data = dev->data; uint8_t config = 0; int dr = 0; if (channel_cfg->channel_id != 0) { return -EINVAL; } switch (channel_cfg->reference) { case ADC_REF_EXTERNAL0: config |= ADS1119_CONFIG_VREF(ADS1119_CONFIG_VREF_EXTERNAL); break; case ADC_REF_INTERNAL: config |= ADS1119_CONFIG_VREF(ADS1119_CONFIG_VREF_INTERNAL); break; default: return -EINVAL; } if (channel_cfg->differential) { if (channel_cfg->input_positive == 0 && channel_cfg->input_negative == 1) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_DIFF_0_1); } else if (channel_cfg->input_positive == 1 && channel_cfg->input_negative == 2) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_DIFF_1_2); } else if (channel_cfg->input_positive == 2 && channel_cfg->input_negative == 3) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_DIFF_2_3); } else { return -EINVAL; } } else { if (channel_cfg->input_positive == 0) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_SINGLE_0); } else if (channel_cfg->input_positive == 1) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_SINGLE_1); } else if (channel_cfg->input_positive == 2) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_SINGLE_2); } else if (channel_cfg->input_positive == 3) { config |= ADS1119_CONFIG_MUX(ADS1119_CONFIG_MUX_SINGLE_3); } else { return -EINVAL; } } data->differential = channel_cfg->differential; dr = ads1119_acq_time_to_dr(dev, channel_cfg->acquisition_time); if (dr < 0) { return dr; } config |= ADS1119_CONFIG_DR(dr); switch (channel_cfg->gain) { case ADC_GAIN_1: config |= ADS1119_CONFIG_GAIN(ADS1119_CONFIG_GAIN_1); break; case ADC_GAIN_4: config |= ADS1119_CONFIG_GAIN(ADS1119_CONFIG_GAIN_4); break; default: return -EINVAL; } config |= ADS1119_CONFIG_CM(ADS1119_CONFIG_CM_SINGLE); /* Only single shot supported */ return ads1119_write_reg(dev, config); } static int ads1119_validate_buffer_size(const struct adc_sequence *sequence) { size_t needed = sizeof(int16_t); if (sequence->options) { needed *= (1 + sequence->options->extra_samplings); } if (sequence->buffer_size < needed) { return -ENOMEM; } return 0; } static int ads1119_validate_sequence(const struct device *dev, const struct adc_sequence *sequence) { const struct ads1119_data *data = dev->data; const uint8_t resolution = data->differential ? ADS1119_RESOLUTION : ADS1119_RESOLUTION - 1; if (sequence->resolution != resolution) { return -EINVAL; } if (sequence->channels != BIT(0)) { return -EINVAL; } if (sequence->oversampling) { return -EINVAL; } return ads1119_validate_buffer_size(sequence); } static void adc_context_update_buffer_pointer(struct adc_context *ctx, bool repeat_sampling) { struct ads1119_data *data = CONTAINER_OF(ctx, struct ads1119_data, ctx); if (repeat_sampling) { data->buffer = data->buffer_ptr; } } static void adc_context_start_sampling(struct adc_context *ctx) { struct ads1119_data *data = CONTAINER_OF(ctx, struct ads1119_data, ctx); data->buffer_ptr = data->buffer; k_sem_give(&data->acq_sem); } static int ads1119_adc_start_read(const struct device *dev, const struct adc_sequence *sequence, bool wait) { int rc; struct ads1119_data *data = dev->data; rc = ads1119_validate_sequence(dev, sequence); if (rc != 0) { return rc; } data->buffer = sequence->buffer; adc_context_start_read(&data->ctx, sequence); if (wait) { rc = adc_context_wait_for_completion(&data->ctx); } return rc; } static int ads1119_adc_perform_read(const struct device *dev) { int rc; struct ads1119_data *data = dev->data; k_sem_take(&data->acq_sem, K_FOREVER); rc = ads1119_send_start_read(dev); if (rc) { adc_context_complete(&data->ctx, rc); return rc; } rc = ads1119_wait_data_ready(dev); if (rc != 0) { adc_context_complete(&data->ctx, rc); return rc; } rc = ads1119_read_sample(dev, data->buffer); if (rc != 0) { adc_context_complete(&data->ctx, rc); return rc; } data->buffer++; adc_context_on_sampling_done(&data->ctx, dev); return rc; } #if CONFIG_ADC_ASYNC static int ads1119_adc_read_async(const struct device *dev, const struct adc_sequence *sequence, struct k_poll_signal *async) { int rc; struct ads1119_data *data = dev->data; adc_context_lock(&data->ctx, true, async); rc = ads1119_adc_start_read(dev, sequence, true); adc_context_release(&data->ctx, rc); return rc; } static int ads1119_read(const struct device *dev, const struct adc_sequence *sequence) { int rc; struct ads1119_data *data = dev->data; adc_context_lock(&data->ctx, false, NULL); rc = ads1119_adc_start_read(dev, sequence, true); adc_context_release(&data->ctx, rc); return rc; } #else static int ads1119_read(const struct device *dev, const struct adc_sequence *sequence) { int rc; struct ads1119_data *data = dev->data; adc_context_lock(&data->ctx, false, NULL); rc = ads1119_adc_start_read(dev, sequence, false); while (rc == 0 && k_sem_take(&data->ctx.sync, K_NO_WAIT) != 0) { rc = ads1119_adc_perform_read(dev); } adc_context_release(&data->ctx, rc); return rc; } #endif #if CONFIG_ADC_ASYNC static void ads1119_acquisition_thread(void *p1, void *p2, void *p3) { ARG_UNUSED(p2); ARG_UNUSED(p3); const struct device *dev = p1; while (true) { ads1119_adc_perform_read(dev); } } #endif static int ads1119_init(const struct device *dev) { int rc; uint8_t status; const struct ads1119_config *config = dev->config; struct ads1119_data *data = dev->data; adc_context_init(&data->ctx); k_sem_init(&data->acq_sem, 0, 1); if (!device_is_ready(config->bus.bus)) { return -ENODEV; } rc = ads1119_read_reg(dev, ADS1119_REG_STATUS, &status); if (rc) { LOG_ERR("Could not get %s status", dev->name); return rc; } #if CONFIG_ADC_ASYNC k_tid_t tid = k_thread_create(&data->thread, config->stack, CONFIG_ADC_ADS1119_ACQUISITION_THREAD_STACK_SIZE, ads1119_acquisition_thread, (void *)dev, NULL, NULL, CONFIG_ADC_ADS1119_ASYNC_THREAD_INIT_PRIO, 0, K_NO_WAIT); k_thread_name_set(tid, "adc_ads1119"); #endif adc_context_unlock_unconditionally(&data->ctx); return rc; } static const struct adc_driver_api api = { .channel_setup = ads1119_channel_setup, .read = ads1119_read, .ref_internal = ADS1119_REF_INTERNAL, #ifdef CONFIG_ADC_ASYNC .read_async = ads1119_adc_read_async, #endif }; #define ADC_ADS1119_INST_DEFINE(n) \ IF_ENABLED(CONFIG_ADC_ASYNC, \ (static \ K_KERNEL_STACK_DEFINE(thread_stack_##n, \ CONFIG_ADC_ADS1119_ACQUISITION_THREAD_STACK_SIZE);)) \ static const struct ads1119_config config_##n = { \ .bus = I2C_DT_SPEC_GET(DT_DRV_INST(n)), \ IF_ENABLED(CONFIG_ADC_ASYNC, (.stack = thread_stack_##n)) \ }; \ static struct ads1119_data data_##n; \ DEVICE_DT_INST_DEFINE(n, ads1119_init, \ NULL, &data_##n, &config_##n, \ POST_KERNEL, CONFIG_ADC_INIT_PRIORITY, \ &api); DT_INST_FOREACH_STATUS_OKAY(ADC_ADS1119_INST_DEFINE);