Skip to content

Commit 84aba62

Browse files
eren-terziogluxiaoxiang781216
eren-terzioglu
authored and
xiaoxiang781216
committed
Docs/platforms: Add missing defconfig docs for esp32[-c3|-c6|-h2]
Add missing defconfig docs for risc-v based Espressif devices
1 parent 80312db commit 84aba62

4 files changed

Lines changed: 161 additions & 0 deletions

File tree

‎Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -464,6 +464,18 @@ To test it, just execute the ``pwm`` application::
464464
pwm_main: starting output with frequency: 10000 duty: 00008000
465465
pwm_main: stopping output
466466

467+
random
468+
------
469+
470+
This configuration shows the use of the ESP32-C3's True Random Number Generator.
471+
To test it, just run ``rand`` to get 32 randomly generated bytes::
472+
473+
nsh> rand
474+
Reading 8 random numbers
475+
Random values (0x3ffe0b00):
476+
0000 98 b9 66 a2 a2 c0 a2 ae 09 70 93 d1 b5 91 86 c8 ..f......p......
477+
0010 8f 0e 0b 04 29 64 21 72 01 92 7c a2 27 60 6f 90 ....)d!r..|.'`o.
478+
467479
rmt
468480
---
469481

@@ -660,6 +672,20 @@ using WPA2.
660672

661673
The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
662674

675+
temperature_sensor
676+
------------------
677+
678+
This configuration enables the on-chip temperature sensor driver. The sensor is
679+
exposed through the uORB interface and can be read with the ``sensortest``
680+
utility::
681+
682+
nsh> sensortest temp
683+
684+
tickless
685+
--------
686+
687+
This configuration enables the support for tickless scheduler mode.
688+
663689
timer
664690
-----
665691

‎Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitc/index.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -556,6 +556,18 @@ using 1 second delay)::
556556

557557
nsh> qe
558558

559+
random
560+
------
561+
562+
This configuration shows the use of the ESP32-C6's True Random Number Generator.
563+
To test it, just run ``rand`` to get 32 randomly generated bytes::
564+
565+
nsh> rand
566+
Reading 8 random numbers
567+
Random values (0x3ffe0b00):
568+
0000 98 b9 66 a2 a2 c0 a2 ae 09 70 93 d1 b5 91 86 c8 ..f......p......
569+
0010 8f 0e 0b 04 29 64 21 72 01 92 7c a2 27 60 6f 90 ....)d!r..|.'`o.
570+
559571
rmt
560572
---
561573

@@ -687,6 +699,25 @@ If SPI peripherals are already in use you can also use bitbang driver which is a
687699
software implemented SPI peripheral by enabling `CONFIG_ESPRESSIF_SPI_BITBANG`
688700
option.
689701

702+
spislv
703+
------
704+
705+
This configuration enables the SPI2 peripheral in **slave mode** and
706+
provides the ``spislv`` example application to test data exchange with an
707+
external SPI master.
708+
709+
After building and flashing the firmware, run the following command on the
710+
board terminal::
711+
712+
nsh> spislv -x 5 1a2b3c4d5e
713+
714+
This command enqueues the data sequence ``1a2b3c4d5e`` in the slave buffer.
715+
On the next transfer, the external SPI master should receive this data back
716+
from the slave.
717+
718+
By default, SPI2 is used with chip select on GPIO16. The pin mapping can be
719+
adjusted through ``menuconfig`` under *System type → SPI configuration*.
720+
690721
sdmmc_spi
691722
---------
692723

@@ -752,6 +783,20 @@ using WPA2.
752783

753784
The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
754785

786+
temperature_sensor
787+
------------------
788+
789+
This configuration enables the on-chip temperature sensor driver. The sensor is
790+
exposed through the uORB interface and can be read with the ``sensortest``
791+
utility::
792+
793+
nsh> sensortest temp
794+
795+
tickless
796+
--------
797+
798+
This configuration enables the support for tickless scheduler mode.
799+
755800
timer
756801
-----
757802

‎Documentation/platforms/risc-v/esp32c6/boards/esp32c6-devkitm/index.rst‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,18 @@ To test it, just execute the ``pwm`` application::
324324
pwm_main: starting output with frequency: 10000 duty: 00008000
325325
pwm_main: stopping output
326326

327+
random
328+
------
329+
330+
This configuration shows the use of the ESP32-C6's True Random Number Generator.
331+
To test it, just run ``rand`` to get 32 randomly generated bytes::
332+
333+
nsh> rand
334+
Reading 8 random numbers
335+
Random values (0x3ffe0b00):
336+
0000 98 b9 66 a2 a2 c0 a2 ae 09 70 93 d1 b5 91 86 c8 ..f......p......
337+
0010 8f 0e 0b 04 29 64 21 72 01 92 7c a2 27 60 6f 90 ....)d!r..|.'`o.
338+
327339
rmt
328340
---
329341

@@ -475,6 +487,25 @@ If SPI peripherals are already in use you can also use bitbang driver which is a
475487
software implemented SPI peripheral by enabling `CONFIG_ESPRESSIF_SPI_BITBANG`
476488
option.
477489

490+
spislv
491+
------
492+
493+
This configuration enables the SPI2 peripheral in **slave mode** and
494+
provides the ``spislv`` example application to test data exchange with an
495+
external SPI master.
496+
497+
After building and flashing the firmware, run the following command on the
498+
board terminal::
499+
500+
nsh> spislv -x 5 1a2b3c4d5e
501+
502+
This command enqueues the data sequence ``1a2b3c4d5e`` in the slave buffer.
503+
On the next transfer, the external SPI master should receive this data back
504+
from the slave.
505+
506+
By default, SPI2 is used with chip select on GPIO1. The pin mapping can be
507+
adjusted through ``menuconfig`` under *System type → SPI configuration*.
508+
478509
spiflash
479510
--------
480511

@@ -507,6 +538,11 @@ using WPA2.
507538

508539
The ``dhcpd_start`` is necessary to let your board to associate an IP to your smartphone.
509540

541+
tickless
542+
--------
543+
544+
This configuration enables the support for tickless scheduler mode.
545+
510546
timer
511547
-----
512548

‎Documentation/platforms/risc-v/esp32h2/boards/esp32h2-devkit/index.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,22 @@ the ``buttons`` application and pressing the ``BOOT`` button on the board::
240240
nsh> Sample = 1
241241
Sample = 0
242242

243+
capture
244+
--------
245+
246+
The capture configuration enables the capture driver and the capture example, allowing
247+
the user to measure duty cycle and frequency of a signal. Default pin is GPIO12 with
248+
an internal pull-up resistor enabled. When connecting a 50 Hz pulse with 50% duty cycle,
249+
the following output is expected::
250+
251+
nsh> cap
252+
cap_main: Hardware initialized. Opening the capture device: /dev/capture0
253+
cap_main: Number of samples: 0
254+
pwm duty cycle: 50 %
255+
pwm frequency: 50 Hz
256+
pwm duty cycle: 50 %
257+
pwm frequency: 50 Hz
258+
243259
coremark
244260
--------
245261

@@ -416,6 +432,18 @@ This configuration is the same as the ``nsh`` configuration, but it generates th
416432
image in a format that can be used by MCUboot. It also makes the ``make bootloader`` command to
417433
build the MCUboot bootloader image using the Espressif HAL.
418434

435+
motor
436+
-------
437+
438+
The motor configuration enables the MCPWM peripheral with support to brushed DC motor
439+
control.
440+
441+
It creates a ``/dev/motor0`` device with speed and direction control capabilities
442+
by using two GPIOs (GPIO10 and GPIO11) for PWM output. PWM frequency is configurable
443+
from 25 Hz to 3 kHz, however it defaults to 1 kHz.
444+
There is also support for an optional fault GPIO (defaults to GPIO9), which can be used
445+
for quick motor braking. All GPIOs are configurable in ``menuconfig``.
446+
419447
nsh
420448
---
421449

@@ -514,6 +542,18 @@ using 1 second delay)::
514542

515543
nsh> qe
516544

545+
random
546+
------
547+
548+
This configuration shows the use of the ESP32-H2's hardware True Random Number Generator.
549+
To test it, just run ``rand`` to get 32 randomly generated bytes::
550+
551+
nsh> rand
552+
Reading 8 random numbers
553+
Random values (0x3ffe0b00):
554+
0000 98 b9 66 a2 a2 c0 a2 ae 09 70 93 d1 b5 91 86 c8 ..f......p......
555+
0010 8f 0e 0b 04 29 64 21 72 01 92 7c a2 27 60 6f 90 ....)d!r..|.'`o.
556+
517557
rmt
518558
---
519559

@@ -703,6 +743,20 @@ To test it, just run the following::
703743

704744
Where x in the timer instance.
705745

746+
temperature_sensor
747+
------------------
748+
749+
This configuration enables the on-chip temperature sensor driver. The sensor is
750+
exposed through the uORB interface and can be read with the ``sensortest``
751+
utility::
752+
753+
nsh> sensortest temp
754+
755+
tickless
756+
--------
757+
758+
This configuration enables the support for tickless scheduler mode.
759+
706760
twai
707761
----
708762

0 commit comments

Comments
 (0)