Introduce reworked API for ADC drivers #7691

anangl · 2018-05-21T15:08:23Z

This replaces #6176 and introduces a new API for ADC drivers basing on the feedback gathered there.
Implementations of drivers for ADC peripherals present in nRF chips are included, as well as updated and extended adc_api test to present the way the API is supposed to be used.

Marked as DNM, since existing ADC drivers (and "grove" sensors) need to be updated for this one to be merged.

List of drivers to be converted

Fixes #3980

codecov-io · 2018-05-21T15:36:18Z

Codecov Report

Merging #7691 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #7691   +/-   ##
=======================================
  Coverage   52.12%   52.12%           
=======================================
  Files         212      212           
  Lines       25939    25939           
  Branches     5590     5590           
=======================================
  Hits        13521    13521           
  Misses      10177    10177           
  Partials     2241     2241

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b0c3b35...47dfd81. Read the comment docs.

tbursztyka · 2018-05-24T07:37:34Z

include/adc.h

+	u8_t channel_id   : 5;
+
+	/** Channel type: single-ended or differential. */
+	bool differential : 1;


Keep u8_t here, I am not entirely sure compiler will properly pack it with previous byte.

anangl · 2018-06-26T14:21:35Z

refactored the test a bit, added one more test case for asynchronous calls
added an atomic variable to handle triggering of another sampling while the previous one is still in progress
added the possibility to perform multiple samplings with zero interval (as fast as possible)

galak

Use DT for IRQ info, should have DT nodes for adc controllers.

galak · 2018-06-26T17:39:12Z

drivers/adc/adc_nrfx_adc.c

+		return -EBUSY;
+	}
+
+	IRQ_CONNECT(ADC_IRQn, CONFIG_ADC_0_IRQ_PRI,


We should get IRQ info from DT

galak · 2018-06-26T17:40:51Z

drivers/adc/adc_nrfx_adc.c

+static nrfx_adc_channel_t m_channels[CONFIG_ADC_NRFX_ADC_CHANNEL_COUNT];
+
+
+static int adc_nrfx_channel_setup(struct device *dev,


use nrfx_adc_ as a function prefix, its a bit confusing when seeing adc_ and thinking maybe that's an adc core function, and not a driver specific one.

But the nrfx_ prefix is used for stuff that comes from nrfx, and in particular all API functions of the nrfx driver for ADC peripheral are prefixed with nrfx_adc_. So that would be confusing as well. On the other hand, adc_nrfx_ is consistent with the scheme we use for naming implementation files.
And as I see such approach is commonly used. See for example: spi_dw_transceive, i2c_mcux_configure, uart_stm32_poll_in. Thus, I would prefer to stay with this naming.

ok, that makes sense.

I guess my comment is about being consistent in this file, so either everything should be prefixed adc_nrfx_ or not.

galak · 2018-06-26T17:42:14Z

drivers/adc/adc_nrfx_saadc.c

+	nrf_saadc_int_enable(NRF_SAADC_INT_END);
+	NRFX_IRQ_ENABLE(SAADC_IRQn);
+
+	IRQ_CONNECT(SAADC_IRQn, CONFIG_ADC_0_IRQ_PRI,


IRQ num and priority should come from DT.

anangl · 2018-06-29T07:33:37Z

rebased on the latest master to get the support for nRF52810 and update its "ADC affected" files in this PR
added DTS entries as requested by @galak
minor editorial changes: used BIT and BIT_MASK macros instead of shifting in ADC_ACQ_TIME macros, renamed ADC_DEV_NAME TO ADC_DEVICE_NAME in the "adc_api" test

anangl · 2018-07-02T12:57:29Z

removed syscalls from the API since read functions cannot use them, because of the callback that is executed in the ISR context, and there is a little sense in having syscall only for channel configuration

anangl · 2018-07-03T07:54:50Z

Rebased on master to resolve a conflict in "boards/arm/nrf52_pca20020/Kconfig.board".

galak

Some comments on the DTS support and minor comments on code style for the NRF drivers.

galak · 2018-07-03T18:06:40Z

boards/arm/nrf51_pca10028/Kconfig.board

@@ -6,4 +6,5 @@

 config BOARD_NRF51_PCA10028
 	bool "nRF51 PCA10028"
+	select HAS_DTS_ADC


select HAS_DTS_ADC, should be with the driver, not the board.

galak · 2018-07-03T18:07:05Z

boards/arm/nrf52810_pca10040/Kconfig.board

@@ -6,5 +6,6 @@

 config  BOARD_NRF52810_PCA10040
 	bool "nRF52810 PCA10040"
+	select HAS_DTS_ADC


remove this, just do the select in the driver's Kconfig.

galak · 2018-07-03T18:08:43Z

drivers/adc/adc_nrfx_adc.c

+static nrfx_adc_channel_t m_channels[CONFIG_ADC_NRFX_ADC_CHANNEL_COUNT];
+
+
+static int adc_nrfx_channel_setup(struct device *dev,


I guess my comment is about being consistent in this file, so either everything should be prefixed adc_nrfx_ or not.

galak · 2018-07-03T18:10:41Z

drivers/adc/adc_nrfx_saadc.c

+	 */
+	channel_id = 0;
+	do {
+		if (channels & 1) {


seems like the 1 here could be replaced w/define or some support. Is this an enable bit?

Bits set to 1 in this bit-mask indicate that the corresponding channels are selected for the sampling sequence.
I refactored a bit this part of code (in both implementations). Hopefully, it will be clearer now.

galak · 2018-07-03T18:11:58Z

drivers/adc/Kconfig

@@ -13,10 +13,16 @@ menuconfig ADC
 	bool
 	prompt "ADC drivers"


add select HAS_DTS_ADC so that all ADC drivers require DTS support.

But what would be the point in having HAS_DTS_ADC at all then? Right now it only excludes from Kconfig the options providing information that can be taken from DT, and these options are dependent on the same menuconfig entry that would select HAS_DTS_ADC. They should be rather removed then.
And this would be inconsistent with what we've got in other drivers. Is this a new approach that we want to take?

As agreed on the API call, I'll add another commit with this change.

dbkinder

Doc change LGTM. Commit message should be updated (still talks about being marked as DNM).

MaureenHelm · 2018-08-28T19:01:00Z

Commit message should be updated (still talks about being marked as DNM).

Which commit?

mnkp · 2018-08-29T08:27:49Z

I am aware that I am very late to the review, unfortunately I was not able to devote much time to the Zephyr project in last months.

The new ADC API is definitely the step in the right direction, however its design has some problems. The main one is the lack of support for triggers. ADC hardware comes in an overwhelming variety of design variants often with a distinctively different architectures. It makes it difficult to design universal API, there are however some fairly common features. One of such features is the concept of a trigger. Once the ADC module is configured - using the nomenclature of this API - the sequence is defined, the measurement can be started by a trigger whereas trigger is typically:

a software trigger
a timer trigger
a pin
a trigger of some internal trigger subsystem

of those the new API supports software trigger and makes an attempt to support timer trigger. The pin trigger and subsystem trigger is missing. The subsystem trigger is popular on many low power MCUs where it is possible to start ADC measurement on some internal, predefined condition without waking up the CPU.

Unfortunately this API can not be easily extended. The next time a project needs to trigger ADC measurement on the pin level change the ADC API would need to be completely reworked.

In Linux the ADC driver is handled by Industrial I/O driver (IIO) subsystem. Its API is build around the concept of triggers.

This commit adds ADC nodes to DTS files for nRF SoCs and introduces corresponding bindings for these nodes. Signed-off-by: Andrzej Głąbek <[email protected]>

ADC nodes are enabled in DTS for the following nRF development kits: - nrf51_pca10028 - nrf52_pca10040 - nrf52_pca20020 - nrf52810_pca10040 - nrf52840_pca10056 Signed-off-by: Andrzej Głąbek <[email protected]>

This commit replaces the API for ADC drivers with a reworked one. As requested in the issue zephyrproject-rtos#3980, the adc_enable/adc_disable functions are removed. Additionaly, some new features are introduced, like: - asynchronous calls - configuration of channels - multi-channel sampling Common parts of code that are supposed to appear in each implementation of the driver (like locking, synchronization, triggering of consecutive samplings) are provided in the "adc_context.h" file to keep consistency with the SPI driver. Syscalls are no longer present in the API because the functions starting read requests cannot use them, since they can be provided with a callback that is executed in the ISR context, and there is no point in supporting syscalls only for the channels configuration. "adc_api" test is updated and extended with additional test cases, with intention to show how the API is supposed to be used. "adc_simple" test is removed as it does not seem to add much value. Signed-off-by: Andrzej Głąbek <[email protected]>

This commit adds translation layers to make nrfx drivers for the nRF ADC (nRF51 series) and SAADC (nRF52 series) peripherals accessible via the Zephyr's API. The SAADC peripheral is accessed using nrfx HAL only as it turns out that usage of the nrfx driver in this case would be inconvenient and would unnecessarily complicate the shim. Signed-off-by: Andrzej Głąbek <[email protected]>

This adds to the adc_api test board-specific configurations for the following boards: - nrf51_pca10028 - nrf52_pca10040 - nrf52840_pca10056 "adc" is indicated as supported in the yaml files for these boards so that they are included in sanitycheck. Signed-off-by: Andrzej Głąbek <[email protected]>

To require relevant DTS entries on all platforms providing the ADC driver. Signed-off-by: Andrzej Głąbek <[email protected]>

Major rework of the mcux adc16 driver to convert it to the new adc api. Currently supports a subset of the api features including synchronous and asynchronous reads, and consecutive reads triggered by the kernel timer. Does not yet support some of the channel configuration options such as gain and reference voltage because the hardware only allows these options to be configured by peripheral instance rather than by channel. The values are currently hardcoded in the driver, but in the future we could introduce some flexibility per instance via device tree attributes. Does not yet support consecutive reads triggered by a hardware timer. Signed-off-by: Maureen Helm <[email protected]>

Adds board-specific macros to enable the adc_api test to run on kinetis boards. This restores the test to support all the nxp boards that were supported before the new adc api was introduced. Signed-off-by: Maureen Helm <[email protected]>

Updated to work with new ADC API. Signed-off-by: Justin Watson <[email protected]>

Remove adc_qmsi_ss to use designware driver for sensor subsystem Signed-off-by: Punit Vara <[email protected]>

Get required data from dts tree. Signed-off-by: Punit Vara <[email protected]>

Enable ADC node in dts. Signed-off-by: Punit Vara <[email protected]>

Replace new ADC apis for designware driver Signed-off-by: Punit Vara <[email protected]>

Remove Kconfig which are replaced by dts and unnecessary macros which is not useful anymore. Signed-off-by: Punit Vara <[email protected]>

Replace old ADC apis with new ones. Signed-off-by: Punit Vara <[email protected]>

Replace old ADC driver APIs with new ones. Signed-off-by: Punit Vara <[email protected]>

Add ARC related parameters and modified test case to work this test case on arc sensor subsystem. Signed-off-by: Punit Vara <[email protected]>

check return value for sample fetch. Conditional printk added to print adc value. Signed-off-by: Punit Vara <[email protected]>

Use Kconfig to get device name. Make LIBC conditional to get output. Signed-off-by: Punit Vara <[email protected]>

Remove ADC support from d2000 as it is not migrated to new ADC apis. Signed-off-by: Punit Vara <[email protected]>

Remove unnecessary sample width scenario. Signed-off-by: Punit Vara <[email protected]>

anangl requested review from nashif, tbursztyka, MaureenHelm, carlescufi and galak May 21, 2018 15:08

anangl mentioned this pull request May 21, 2018

[RFC][DNM] drivers: adc: new API proposal #6176

Closed

galak mentioned this pull request May 21, 2018

Driver API review/cleanup/rework #5697

Closed

33 tasks

anangl force-pushed the adc_api_rework branch 2 times, most recently from c657298 to 7a19df3 Compare May 22, 2018 07:52

tbursztyka reviewed May 24, 2018

View reviewed changes

nashif added this to the v1.13.0 milestone May 29, 2018

anangl force-pushed the adc_api_rework branch 2 times, most recently from 9878e45 to 1a8b1f1 Compare June 4, 2018 13:37

MaureenHelm added area: ADC Analog-to-Digital Converter (ADC) area: API Changes to public APIs labels Jun 19, 2018

anangl force-pushed the adc_api_rework branch from 1a8b1f1 to 4c3a729 Compare June 26, 2018 14:10

galak requested changes Jun 26, 2018

View reviewed changes

galak mentioned this pull request Jun 28, 2018

stm32f4 uart and adc enhancement #8624

Closed

anangl force-pushed the adc_api_rework branch from 4c3a729 to 77f8105 Compare June 29, 2018 07:24

rodrigopex mentioned this pull request Jun 29, 2018

Add SAADC driver for nRF52 #8643

Closed

anangl force-pushed the adc_api_rework branch from 77f8105 to 6cd8828 Compare July 2, 2018 12:53

anangl force-pushed the adc_api_rework branch from 6cd8828 to b2cae0f Compare July 3, 2018 07:53

galak requested a review from fallrisk July 3, 2018 18:04

galak requested changes Jul 3, 2018

View reviewed changes

anangl force-pushed the adc_api_rework branch from b2cae0f to 160d968 Compare July 10, 2018 12:54

nashif approved these changes Aug 27, 2018

View reviewed changes

dbkinder approved these changes Aug 28, 2018

View reviewed changes

anangl and others added 21 commits August 29, 2018 11:06

dts: nrf: Add ADC nodes and bindings for nRF SoCs

18c1554

This commit adds ADC nodes to DTS files for nRF SoCs and introduces corresponding bindings for these nodes. Signed-off-by: Andrzej Głąbek <[email protected]>

boards: nrf: Enable ADC nodes in DTS for nRF boards

54a10cf

ADC nodes are enabled in DTS for the following nRF development kits: - nrf51_pca10028 - nrf52_pca10040 - nrf52_pca20020 - nrf52810_pca10040 - nrf52840_pca10056 Signed-off-by: Andrzej Głąbek <[email protected]>

drivers: adc: Select HAS_DTS_ADC for all ADC drivers

174940a

To require relevant DTS entries on all platforms providing the ADC driver. Signed-off-by: Andrzej Głąbek <[email protected]>

tests: adc_api: Add support for kinetis boards

c371d6d

Adds board-specific macros to enable the adc_api test to run on kinetis boards. This restores the test to support all the nxp boards that were supported before the new adc api was introduced. Signed-off-by: Maureen Helm <[email protected]>

sam: adc: Updated SAM ADC driver.

b465ef3

Updated to work with new ADC API. Signed-off-by: Justin Watson <[email protected]>

drivers: Use Designware driver for sensor subsystem

d623676

Remove adc_qmsi_ss to use designware driver for sensor subsystem Signed-off-by: Punit Vara <[email protected]>

dts: arc: Use dts tree for designware driver

c0f499b

Get required data from dts tree. Signed-off-by: Punit Vara <[email protected]>

boards: quark_se_c1000_ss_devboard: Enable ADC node

49d26d7

Enable ADC node in dts. Signed-off-by: Punit Vara <[email protected]>

drivers: adc: Update new ADC APIs

0c35d44

Replace new ADC apis for designware driver Signed-off-by: Punit Vara <[email protected]>

drivers: Kconfig.dw: Remove unnecessary Kconfig

f211236

Remove Kconfig which are replaced by dts and unnecessary macros which is not useful anymore. Signed-off-by: Punit Vara <[email protected]>

drivers: grove: Modify light sensor

9c4852a

Replace old ADC apis with new ones. Signed-off-by: Punit Vara <[email protected]>

drivers: grove: Update temperature driver

21f2efc

Replace old ADC driver APIs with new ones. Signed-off-by: Punit Vara <[email protected]>

tests: adc_api: Add ARC related parameters for ADC

92dc94e

Add ARC related parameters and modified test case to work this test case on arc sensor subsystem. Signed-off-by: Punit Vara <[email protected]>

samples: grove_light: Provide device name from Kconfig

735b709

check return value for sample fetch. Conditional printk added to print adc value. Signed-off-by: Punit Vara <[email protected]>

samples: grove_temperature: Use device name from Kconfig

6766f3f

Use Kconfig to get device name. Make LIBC conditional to get output. Signed-off-by: Punit Vara <[email protected]>

boards: quark_d2000_crb: Remove adc support

642e234

Remove ADC support from d2000 as it is not migrated to new ADC apis. Signed-off-by: Punit Vara <[email protected]>

tests: adc_api: Remove sample width test scenario

47dfd81

Remove unnecessary sample width scenario. Signed-off-by: Punit Vara <[email protected]>

MaureenHelm force-pushed the adc_api_rework branch from ec5676f to 47dfd81 Compare August 29, 2018 16:09

nashif merged commit 108b539 into zephyrproject-rtos:master Aug 29, 2018

anangl deleted the adc_api_rework branch December 3, 2018 12:10

anangl mentioned this pull request Apr 1, 2019

Add missing system calls for ADC driver subsystem #15001

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce reworked API for ADC drivers #7691

Introduce reworked API for ADC drivers #7691

anangl commented May 21, 2018 •

edited by MaureenHelm

Loading

codecov-io commented May 21, 2018 •

edited

Loading

tbursztyka May 24, 2018

anangl commented Jun 26, 2018

galak left a comment

galak Jun 26, 2018

anangl Jun 29, 2018

galak Jun 26, 2018

anangl Jun 29, 2018

galak Jul 3, 2018

galak Jul 3, 2018

galak Jun 26, 2018

anangl Jun 29, 2018

anangl commented Jun 29, 2018

anangl commented Jul 2, 2018 •

edited

Loading

anangl commented Jul 3, 2018 •

edited

Loading

galak left a comment

galak Jul 3, 2018

galak Jul 3, 2018

galak Jul 3, 2018

galak Jul 3, 2018

anangl Jul 10, 2018

galak Jul 3, 2018

anangl Jul 10, 2018

anangl Jul 10, 2018

anangl Jul 11, 2018

dbkinder left a comment

MaureenHelm commented Aug 28, 2018

mnkp commented Aug 29, 2018 •

edited

Loading

		static nrfx_adc_channel_t m_channels[CONFIG_ADC_NRFX_ADC_CHANNEL_COUNT];


		static int adc_nrfx_channel_setup(struct device *dev,

Introduce reworked API for ADC drivers #7691

Introduce reworked API for ADC drivers #7691

Conversation

anangl commented May 21, 2018 • edited by MaureenHelm Loading

codecov-io commented May 21, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

anangl commented Jun 26, 2018

galak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anangl commented Jun 29, 2018

anangl commented Jul 2, 2018 • edited Loading

anangl commented Jul 3, 2018 • edited Loading

galak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dbkinder left a comment

Choose a reason for hiding this comment

MaureenHelm commented Aug 28, 2018

mnkp commented Aug 29, 2018 • edited Loading

anangl commented May 21, 2018 •

edited by MaureenHelm

Loading

codecov-io commented May 21, 2018 •

edited

Loading

anangl commented Jul 2, 2018 •

edited

Loading

anangl commented Jul 3, 2018 •

edited

Loading

mnkp commented Aug 29, 2018 •

edited

Loading