79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| boards | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _mcux_acmp: NXP MCUX Analog Comparator (ACMP) ################################# Overview ******** This sample show how to use the NXP MCUX Analog Comparator (ACMP) driver. The sample supports the :ref:`twr_ke18f`, :ref:`mimxrt1170_evk`. The input voltage for the the negative input of the analog comparator is provided by the ACMP Digital-to-Analog Converter (DAC). The input voltage for the positive input can be adjusted by turning the on-board potentiometer for :ref:`twr_ke18f` board, for :ref:`mimxrt1170_evk` the voltage signal is captured on J25-13, need change the external voltage signal to check the output. The output value of the analog comparator is reported on the console. Building and Running ******************** Building and Running for TWR-KE18F ================================== Build the application for the :ref:`twr_ke18f` board, and adjust the ACMP input voltage by turning the on-board potentiometer. .. zephyr-app-commands:: :zephyr-app: samples/drivers/mcux_acmp :board: twr_ke18f :goals: flash :compact: Building and Running for MIMXRT1170-EVK ======================================= Build the application for the MIMXRT1170-EVK board, and adjust the ACMP input voltage by changing the voltage input to J25-13. .. zephyr-app-commands:: :zephyr-app: samples/drivers/mcux_acmp :board: mimxrt1170_evk_cm7 :goals: flash :compact: