esp-idf/examples/peripherals
Michael (XIAO Xufeng) 562af8f65e global: move the soc component out of the common list
This MR removes the common dependency from every IDF components to the SOC component.

Currently, in the ``idf_functions.cmake`` script, we include the header path of SOC component by default for all components.
But for better code organization (or maybe also benifits to the compiling speed), we may remove the dependency to SOC components for most components except the driver and kernel related components.

In CMAKE, we have two kinds of header visibilities (set by include path visibility):

(Assume component A --(depends on)--> B, B is the current component)

1. public (``COMPONENT_ADD_INCLUDEDIRS``): means this path is visible to other depending components (A) (visible to A and B)
2. private (``COMPONENT_PRIV_INCLUDEDIRS``): means this path is only visible to source files inside the component (visible to B only)

and we have two kinds of depending ways:

(Assume component A --(depends on)--> B --(depends on)--> C, B is the current component)

1. public (```COMPONENT_REQUIRES```): means B can access to public include path of C. All other components rely on you (A) will also be available for the public headers. (visible to A, B)
2. private (``COMPONENT_PRIV_REQUIRES``): means B can access to public include path of C, but don't propagate this relation to other components (A). (visible to B)

1. remove the common requirement in ``idf_functions.cmake``, this makes the SOC components invisible to all other components by default.
2. if a component (for example, DRIVER) really needs the dependency to SOC, add a private dependency to SOC for it.
3. some other components that don't really depends on the SOC may still meet some errors saying "can't find header soc/...", this is because it's depended component (DRIVER) incorrectly include the header of SOC in its public headers. Moving all this kind of #include into source files, or private headers
4. Fix the include requirements for some file which miss sufficient #include directives. (Previously they include some headers by the long long long header include link)

This is a breaking change. Previous code may depends on the long include chain.
You may need to include the following headers for some files after this commit:

- soc/soc.h
- soc/soc_memory_layout.h
- driver/gpio.h
- esp_sleep.h

The major broken include chain includes:

1. esp_system.h no longer includes esp_sleep.h. The latter includes driver/gpio.h and driver/touch_pad.h.
2. ets_sys.h no longer includes soc/soc.h
3. freertos/portmacro.h no longer includes soc/soc_memory_layout.h

some peripheral headers no longer includes their hw related headers, e.g. rom/gpio.h no longer includes soc/gpio_pins.h and soc/gpio_reg.h

BREAKING CHANGE
2019-04-16 13:21:15 +08:00
..
adc doc(adc): Update README.md file of adc example. 2018-12-06 12:20:29 +08:00
adc2 Correct Kconfigs according to the coding style 2019-01-29 13:37:01 +01:00
can CAN: Add functions to clear queues and fix multiple bugs 2019-02-18 21:31:33 +08:00
gpio cmake: make main a component again 2018-09-11 09:44:12 +08:00
i2c examples: don't enable buffering on stdout in console examples 2019-03-13 20:32:37 +08:00
i2s doc(i2s): update README.md file of i2s related examples. 2018-12-10 10:33:41 +08:00
i2s_adc_dac Merge branch 'bugfix/i2s_pdm_adc_use_apll' into 'master' 2019-02-26 11:47:49 +08:00
ledc doc(ledc): Update LEDC example README.md file. 2018-11-28 07:15:56 +00:00
mcpwm Update README.md 2019-03-24 19:54:00 +01:00
pcnt doc(pcnt): Update pcnt example README.md file. 2018-12-06 12:16:45 +08:00
rmt_nec_tx_rx doc(rmt): fixed some typos in rmt example readme file 2018-09-17 10:21:07 +08:00
rmt_tx doc(rmt): fixed some typos in rmt example readme file 2018-09-17 10:21:07 +08:00
sdio sdio: support SDIO over spi in the example 2019-04-12 02:24:29 +08:00
sigmadelta Implemented the first round of review comments 2018-09-28 14:04:22 +08:00
spi_master separate rom from esp32 component to esp_rom 2019-03-21 18:51:45 +08:00
spi_slave global: move the soc component out of the common list 2019-04-16 13:21:15 +08:00
timer_group cmake: make main a component again 2018-09-11 09:44:12 +08:00
touch_pad_interrupt cmake: make main a component again 2018-09-11 09:44:12 +08:00
touch_pad_read cmake: make main a component again 2018-09-11 09:44:12 +08:00
uart global: move the soc component out of the common list 2019-04-16 13:21:15 +08:00
README.md Replace all DOS line endings with Unix 2018-07-12 19:10:37 +08:00

Peripherals Examples

This section provides examples how to configure and use ESP32s internal peripherals like GPIO, UART, I2C, SPI, timers, counters, ADC / DAC, PWM, etc.

See the README.md file in the upper level examples directory for more information about examples.