riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

boards/esp32: fix spelling of periph_i2c

Browse Source 
Also change to single quotes for inline verbatim.
This commit is contained in:
Erik Ekman 2020-07-11 20:52:50 +02:00
parent b3197dea28
commit d9c40ba47a
8 changed files with 37 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
boards/esp32-heltec-lora32-v2/include/periph_conf.h
View File

@ -75,7 +75,7 @@
* Only I2C interface I2C_DEV(0) is used. * Only I2C interface I2C_DEV(0) is used.
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module `perpih_i2c` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -96,7 +96,7 @@
* @name PWM channel configuration * @name PWM channel configuration
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -117,7 +117,7 @@
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* *

4
boards/esp32-mh-et-live-minikit/include/board_modules.h
View File

@ -34,7 +34,7 @@ extern "C" {
/** /**
* @name MRF24J40 shield configuration * @name MRF24J40 shield configuration
* *
* Configuration for the MRF24J40 shield when module ```mrf24j40``` is used. * Configuration for the MRF24J40 shield when module `mrf24j40` is used.
* *
* MRF24J40 module uses SPI_DEV(0) and according pins on this board to be * MRF24J40 module uses SPI_DEV(0) and according pins on this board to be
* compatible with the Wemos D1 mini MRF24J40 shield. * compatible with the Wemos D1 mini MRF24J40 shield.
@ -64,7 +64,7 @@ extern "C" {
/** /**
* @name SD-Card shield configuration * @name SD-Card shield configuration
* *
* Configuration of the SD-Card interface when module ```sdcard_spi``` is used. * Configuration of the SD-Card interface when module `sdcard_spi` is used.
* *
* SD card interface uses SPI_DEV(0) on this board to be compatible with the * SD card interface uses SPI_DEV(0) on this board to be compatible with the
* Wemos D1 mini micro SD card shield. The D8 pin (GPIO5) is used as default * Wemos D1 mini micro SD card shield. The D8 pin (GPIO5) is used as default

10
boards/esp32-mh-et-live-minikit/include/periph_conf.h
View File

@ -46,7 +46,7 @@
* @brief Declaration of GPIOs that can be used as ADC channels * @brief Declaration of GPIOs that can be used as ADC channels
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef ADC_GPIOS #ifndef ADC_GPIOS
@ -57,7 +57,7 @@
* @brief Declaration of GPIOs that can be used as DAC channels * @brief Declaration of GPIOs that can be used as DAC channels
* *
* @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC * @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC
* channels with the ```dac_init``` function, they can be used for other * channels with the `dac_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef DAC_GPIOS #ifndef DAC_GPIOS
@ -72,7 +72,7 @@
* Only I2C interface I2C_DEV(0) is used. * Only I2C interface I2C_DEV(0) is used.
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module ```perpih_i2c``` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -93,7 +93,7 @@
* @name PWM channel configuration * @name PWM channel configuration
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -114,7 +114,7 @@
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* *

18
boards/esp32-olimex-evb/include/periph_conf.h
View File

@ -44,7 +44,7 @@ extern "C" {
* @name ADC and DAC channel configuration * @name ADC and DAC channel configuration
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* *
* purposes. * purposes.
* @{ * @{
@ -53,7 +53,7 @@ extern "C" {
* @brief Declaration of GPIOs that can be used as ADC channels * @brief Declaration of GPIOs that can be used as ADC channels
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef ADC_GPIOS #ifndef ADC_GPIOS
@ -83,12 +83,12 @@ extern "C" {
/** /**
* @name I2C configuration * @name I2C configuration
* *
* Olimex ESP32-EVB/GATEWAY have one I2C interface ```I2C_DEV(0)```. However, * Olimex ESP32-EVB/GATEWAY have one I2C interface `I2C_DEV(0)`. However,
* they use different GPIOs. Olimex ESP32-EVB, the interface is also available * they use different GPIOs. Olimex ESP32-EVB, the interface is also available
* at the [UEXT] connector. * at the [UEXT] connector.
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module ```perpih_i2c``` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -119,14 +119,14 @@ extern "C" {
* @name PWM channel configuration * @name PWM channel configuration
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
*/ */
/** /**
* In DOUT and DIO flash mode, GPIO9 and GIO10 are available and can be used * In DOUT and DIO flash mode, GPIO9 and GIO10 are available and can be used
* as PWM channels with ```PWM_DEV(0)```. * as PWM channels with `PWM_DEV(0)`.
*/ */
#ifndef PWM0_GPIOS #ifndef PWM0_GPIOS
#if FLASH_MODE_DOUT || FLASH_MODE_DIO || DOXYGEN #if FLASH_MODE_DOUT || FLASH_MODE_DIO || DOXYGEN
@ -154,14 +154,14 @@ extern "C" {
* It is available at the [UEXT] connector on Olimex ESP32-EVB. * It is available at the [UEXT] connector on Olimex ESP32-EVB.
* *
* Although the SD card interface of the Olimex ESP32-EVB is also available at * Although the SD card interface of the Olimex ESP32-EVB is also available at
* the ```SPI_DEV(0)``` interface, it does not have a CS signal. Therefore, * the `SPI_DEV(0)` interface, it does not have a CS signal. Therefore,
* it cannot be used in SPI mode with the ```sdcard_spi``` module. Olimex * it cannot be used in SPI mode with the `sdcard_spi` module. Olimex
* ESP32-GATEWAY uses the integrated SD card interface with another GPIO for * ESP32-GATEWAY uses the integrated SD card interface with another GPIO for
* the CS signal. * the CS signal.
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
*/ */

6
boards/esp32-ttgo-t-beam/include/periph_conf.h
View File

@ -80,7 +80,7 @@
* Only I2C interface I2C_DEV(0) is used. * Only I2C interface I2C_DEV(0) is used.
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module `perpih_i2c` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -101,7 +101,7 @@
* @name PWM channel configuration * @name PWM channel configuration
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -117,7 +117,7 @@
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* *

10
boards/esp32-wemos-lolin-d32-pro/include/periph_conf.h
View File

@ -60,7 +60,7 @@
* GPIO35 is used to measure V_BAT and is therefore not broken out. * GPIO35 is used to measure V_BAT and is therefore not broken out.
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef ADC_GPIOS #ifndef ADC_GPIOS
@ -75,7 +75,7 @@
* @brief Declaration of GPIOs that can be used as DAC channels * @brief Declaration of GPIOs that can be used as DAC channels
* *
* @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC * @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC
* channels with the ```dac_init``` function, they can be used for other * channels with the `dac_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef DAC_GPIOS #ifndef DAC_GPIOS
@ -90,7 +90,7 @@
* Only I2C interface I2C_DEV(0) is used. * Only I2C interface I2C_DEV(0) is used.
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module ```perpih_i2c``` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -111,7 +111,7 @@
* @name PWM channel configuration * @name PWM channel configuration
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -134,7 +134,7 @@
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* *

10
boards/esp32-wroom-32/include/periph_conf.h
View File

@ -48,7 +48,7 @@ extern "C" {
* channels. * channels.
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef ADC_GPIOS #ifndef ADC_GPIOS
@ -64,7 +64,7 @@ extern "C" {
* DAC channels. * DAC channels.
* *
* @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC * @note As long as the GPIOs listed in DAC_GPIOS are not initialized as DAC
* channels with the ```dac_init``` function, they can be used for other * channels with the `dac_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef DAC_GPIOS #ifndef DAC_GPIOS
@ -78,7 +78,7 @@ extern "C" {
* For generic boards, only one I2C interface I2C_DEV(0) is defined. * For generic boards, only one I2C interface I2C_DEV(0) is defined.
* *
* The GPIOs listed in the configuration are only initialized as I2C signals * The GPIOs listed in the configuration are only initialized as I2C signals
* when module ```perpih_i2c``` is used. Otherwise they are not allocated and * when module `periph_i2c` is used. Otherwise they are not allocated and
* can be used for other purposes. * can be used for other purposes.
* *
* @{ * @{
@ -102,7 +102,7 @@ extern "C" {
* Generally, all outputs pins could be used as PWM channels. * Generally, all outputs pins could be used as PWM channels.
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -130,7 +130,7 @@ extern "C" {
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* @{ * @{

10
boards/esp32-wrover-kit/include/periph_conf.h
View File

@ -63,7 +63,7 @@
* as ADC channels. * as ADC channels.
* *
* @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC * @note As long as the GPIOs listed in ADC_GPIOS are not initialized as ADC
* channels with the ```adc_init``` function, they can be used for other * channels with the `adc_init` function, they can be used for other
* purposes. * purposes.
*/ */
#ifndef ADC_GPIOS #ifndef ADC_GPIOS
@ -89,7 +89,7 @@
* @name I2C configuration * @name I2C configuration
* *
* @note The GPIOs listed in the configuration are only initialized as I2C * @note The GPIOs listed in the configuration are only initialized as I2C
* signals when module ```perpih_i2c``` is used. Otherwise they are not * signals when module `periph_i2c` is used. Otherwise they are not
* allocated and can be used for other purposes. * allocated and can be used for other purposes.
* *
* @{ * @{
@ -115,7 +115,7 @@
* purposes. * purposes.
* *
* @note As long as the according PWM device is not initialized with * @note As long as the according PWM device is not initialized with
* the ```pwm_init```, the GPIOs declared for this device can be used * the `pwm_init`, the GPIOs declared for this device can be used
* for other purposes. * for other purposes.
* *
* @{ * @{
@ -140,7 +140,7 @@
* *
* SPI configuration depends on configured/connected components. * SPI configuration depends on configured/connected components.
* *
* HSPI is is always available and therefore used as SPI_DEV(0) * HSPI is always available and therefore used as SPI_DEV(0)
* VSPI is only available when the camera is not plugged. * VSPI is only available when the camera is not plugged.
* *
* @{ * @{
@ -169,7 +169,7 @@
* *
* @note The GPIOs listed in the configuration are first initialized as SPI * @note The GPIOs listed in the configuration are first initialized as SPI
* signals when the corresponding SPI interface is used for the first time * signals when the corresponding SPI interface is used for the first time
* by either calling the ```spi_init_cs``` function or the ```spi_acquire``` * by either calling the `spi_init_cs` function or the `spi_acquire`
* function. That is, they are not allocated as SPI signals before and can * function. That is, they are not allocated as SPI signals before and can
* be used for other purposes as long as the SPI interface is not used. * be used for other purposes as long as the SPI interface is not used.
* *