From aedb846a20de2fdcc1ee937593a922d2e93ec839 Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Thu, 20 Jan 2022 13:29:16 +0100 Subject: [PATCH 1/2] Tools: IDF Monitor follows the UART console baud rate by default --- components/esptool_py/Kconfig.projbuild | 12 ++++++------ docs/en/migration-guides/index.rst | 9 +++++---- docs/en/migration-guides/tools.rst | 7 +++++++ docs/zh_CN/migration-guides/index.rst | 1 + docs/zh_CN/migration-guides/tools.rst | 1 + 5 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 docs/en/migration-guides/tools.rst create mode 100644 docs/zh_CN/migration-guides/tools.rst diff --git a/components/esptool_py/Kconfig.projbuild b/components/esptool_py/Kconfig.projbuild index 095ed206de..22cd35b657 100644 --- a/components/esptool_py/Kconfig.projbuild +++ b/components/esptool_py/Kconfig.projbuild @@ -176,13 +176,13 @@ menu "Serial flasher config" choice ESPTOOLPY_MONITOR_BAUD prompt "'idf.py monitor' baud rate" - default ESPTOOLPY_MONITOR_BAUD_115200B + default ESPTOOLPY_MONITOR_BAUD_CONSOLE help - Baud rate to use when running 'idf.py monitor' or 'make monitor' + Baud rate to use when running 'idf.py monitor' to view serial output from a running chip. - If "Same as UART Console baud rate" is chosen then the value will - follow the "UART Console baud rate" config item. + The default is the "Same as UART Console baud rate" and it follows + the "UART Console baud rate" config item. Can override by setting the MONITORBAUD environment variable. @@ -211,10 +211,10 @@ menu "Serial flasher config" config ESPTOOLPY_MONITOR_BAUD int - default ESP_CONSOLE_UART_BAUDRATE if ESPTOOLPY_MONITOR_BAUD_CONSOLE + default ESP_CONSOLE_UART_BAUDRATE if ESP_CONSOLE_UART && ESPTOOLPY_MONITOR_BAUD_CONSOLE default 9600 if ESPTOOLPY_MONITOR_BAUD_9600B default 57600 if ESPTOOLPY_MONITOR_BAUD_57600B - default 115200 if ESPTOOLPY_MONITOR_BAUD_115200B + default 115200 if ESPTOOLPY_MONITOR_BAUD_115200B || !ESP_CONSOLE_UART default 230400 if ESPTOOLPY_MONITOR_BAUD_230400B default 921600 if ESPTOOLPY_MONITOR_BAUD_921600B default 2000000 if ESPTOOLPY_MONITOR_BAUD_2MB diff --git a/docs/en/migration-guides/index.rst b/docs/en/migration-guides/index.rst index 47e68c19f3..caf6d70abe 100644 --- a/docs/en/migration-guides/index.rst +++ b/docs/en/migration-guides/index.rst @@ -5,10 +5,11 @@ ESP-IDF 5.0 Migration Guides .. toctree:: :maxdepth: 1 - Environment Setup on Windows - Peripherals Build System - System - FreeRTOS + Environment Setup on Windows Ethernet + FreeRTOS + Peripherals Removed or deprecated components + System + Tools diff --git a/docs/en/migration-guides/tools.rst b/docs/en/migration-guides/tools.rst new file mode 100644 index 0000000000..92f0204693 --- /dev/null +++ b/docs/en/migration-guides/tools.rst @@ -0,0 +1,7 @@ +Migrate Tools to ESP-IDF 5.0 +============================ + +IDF Monitor +----------- + +IDF Monitor follows the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200. That means if a custom UART baud-rate is set then one doesn't have to change the monitor baud-rate (:ref:`CONFIG_ESPTOOLPY_MONITOR_BAUD`) to match it. diff --git a/docs/zh_CN/migration-guides/index.rst b/docs/zh_CN/migration-guides/index.rst index b640a65780..a965dbd4bb 100644 --- a/docs/zh_CN/migration-guides/index.rst +++ b/docs/zh_CN/migration-guides/index.rst @@ -12,3 +12,4 @@ ESP-IDF 5.0 迁移指南 FreeRTOS 以太网 Removed or deprecated components + Tools diff --git a/docs/zh_CN/migration-guides/tools.rst b/docs/zh_CN/migration-guides/tools.rst new file mode 100644 index 0000000000..33bde247f4 --- /dev/null +++ b/docs/zh_CN/migration-guides/tools.rst @@ -0,0 +1 @@ +.. include:: ../../en/migration-guides/tools.rst From 36a4011ff8985bfbae08ba0272194e6c3ef93bbf Mon Sep 17 00:00:00 2001 From: Roland Dobai Date: Mon, 24 Jan 2022 17:54:04 +0100 Subject: [PATCH 2/2] Tools: Custom baud-rate setup is not possible for IDF Monitor from menuconfig anymore IDF Monitor follows the console baud rate by default. Other baud rate can be set from command line by "idf.py monitor -B " or through environment variables. Run "idf.py monitor --help" for more information. --- components/esptool_py/Kconfig.projbuild | 46 +------------------ components/esptool_py/sdkconfig.rename | 8 ---- .../mdns/test_afl_fuzz_host/sdkconfig.h | 4 -- docs/en/migration-guides/tools.rst | 2 +- 4 files changed, 3 insertions(+), 57 deletions(-) diff --git a/components/esptool_py/Kconfig.projbuild b/components/esptool_py/Kconfig.projbuild index 22cd35b657..0e660ef2e9 100644 --- a/components/esptool_py/Kconfig.projbuild +++ b/components/esptool_py/Kconfig.projbuild @@ -174,50 +174,8 @@ menu "Serial flasher config" default "hard_reset" if ESPTOOLPY_AFTER_RESET default "no_reset" if ESPTOOLPY_AFTER_NORESET - choice ESPTOOLPY_MONITOR_BAUD - prompt "'idf.py monitor' baud rate" - default ESPTOOLPY_MONITOR_BAUD_CONSOLE - help - Baud rate to use when running 'idf.py monitor' - to view serial output from a running chip. - - The default is the "Same as UART Console baud rate" and it follows - the "UART Console baud rate" config item. - - Can override by setting the MONITORBAUD environment variable. - - config ESPTOOLPY_MONITOR_BAUD_CONSOLE - bool "Same as UART console baud rate" - config ESPTOOLPY_MONITOR_BAUD_9600B - bool "9600 bps" - config ESPTOOLPY_MONITOR_BAUD_57600B - bool "57600 bps" - config ESPTOOLPY_MONITOR_BAUD_115200B - bool "115200 bps" - config ESPTOOLPY_MONITOR_BAUD_230400B - bool "230400 bps" - config ESPTOOLPY_MONITOR_BAUD_921600B - bool "921600 bps" - config ESPTOOLPY_MONITOR_BAUD_2MB - bool "2 Mbps" - config ESPTOOLPY_MONITOR_BAUD_OTHER - bool "Custom baud rate" - - endchoice - - config ESPTOOLPY_MONITOR_BAUD_OTHER_VAL - int "Custom baud rate value" if ESPTOOLPY_MONITOR_BAUD_OTHER - default 115200 - config ESPTOOLPY_MONITOR_BAUD int - default ESP_CONSOLE_UART_BAUDRATE if ESP_CONSOLE_UART && ESPTOOLPY_MONITOR_BAUD_CONSOLE - default 9600 if ESPTOOLPY_MONITOR_BAUD_9600B - default 57600 if ESPTOOLPY_MONITOR_BAUD_57600B - default 115200 if ESPTOOLPY_MONITOR_BAUD_115200B || !ESP_CONSOLE_UART - default 230400 if ESPTOOLPY_MONITOR_BAUD_230400B - default 921600 if ESPTOOLPY_MONITOR_BAUD_921600B - default 2000000 if ESPTOOLPY_MONITOR_BAUD_2MB - default ESPTOOLPY_MONITOR_BAUD_OTHER_VAL if ESPTOOLPY_MONITOR_BAUD_OTHER - + default ESP_CONSOLE_UART_BAUDRATE if ESP_CONSOLE_UART + default 115200 if !ESP_CONSOLE_UART endmenu diff --git a/components/esptool_py/sdkconfig.rename b/components/esptool_py/sdkconfig.rename index caa5c32b82..c478ba27fa 100644 --- a/components/esptool_py/sdkconfig.rename +++ b/components/esptool_py/sdkconfig.rename @@ -7,11 +7,3 @@ CONFIG_FLASHMODE_DIO CONFIG_ESPTOOLPY_FLASHMODE_DIO CONFIG_FLASHMODE_DOUT CONFIG_ESPTOOLPY_FLASHMODE_DOUT CONFIG_MONITOR_BAUD CONFIG_ESPTOOLPY_MONITOR_BAUD -CONFIG_MONITOR_BAUD_9600B CONFIG_ESPTOOLPY_MONITOR_BAUD_9600B -CONFIG_MONITOR_BAUD_57600B CONFIG_ESPTOOLPY_MONITOR_BAUD_57600B -CONFIG_MONITOR_BAUD_115200B CONFIG_ESPTOOLPY_MONITOR_BAUD_115200B -CONFIG_MONITOR_BAUD_230400B CONFIG_ESPTOOLPY_MONITOR_BAUD_230400B -CONFIG_MONITOR_BAUD_921600B CONFIG_ESPTOOLPY_MONITOR_BAUD_921600B -CONFIG_MONITOR_BAUD_2MB CONFIG_ESPTOOLPY_MONITOR_BAUD_2MB -CONFIG_MONITOR_BAUD_OTHER CONFIG_ESPTOOLPY_MONITOR_BAUD_OTHER -CONFIG_MONITOR_BAUD_OTHER_VAL CONFIG_ESPTOOLPY_MONITOR_BAUD_OTHER_VAL diff --git a/components/mdns/test_afl_fuzz_host/sdkconfig.h b/components/mdns/test_afl_fuzz_host/sdkconfig.h index 6f24c61662..4a0e2c54c1 100644 --- a/components/mdns/test_afl_fuzz_host/sdkconfig.h +++ b/components/mdns/test_afl_fuzz_host/sdkconfig.h @@ -32,9 +32,6 @@ #define CONFIG_ESPTOOLPY_BEFORE "default_reset" #define CONFIG_ESPTOOLPY_AFTER_RESET 1 #define CONFIG_ESPTOOLPY_AFTER "hard_reset" -#define CONFIG_ESPTOOLPY_MONITOR_BAUD_115200B 1 -#define CONFIG_ESPTOOLPY_MONITOR_BAUD_OTHER_VAL 115200 -#define CONFIG_ESPTOOLPY_MONITOR_BAUD 115200 #define CONFIG_PARTITION_TABLE_SINGLE_APP 1 #define CONFIG_PARTITION_TABLE_CUSTOM_FILENAME "partitions.csv" #define CONFIG_PARTITION_TABLE_FILENAME "partitions_singleapp.csv" @@ -384,7 +381,6 @@ #define CONFIG_MB_TIMER_GROUP CONFIG_FMB_TIMER_GROUP #define CONFIG_MB_TIMER_INDEX CONFIG_FMB_TIMER_INDEX #define CONFIG_MB_TIMER_PORT_ENABLED CONFIG_FMB_TIMER_PORT_ENABLED -#define CONFIG_MONITOR_BAUD_115200B CONFIG_ESPTOOLPY_MONITOR_BAUD_115200B #define CONFIG_OPTIMIZATION_ASSERTIONS_ENABLED CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_ENABLE #define CONFIG_OPTIMIZATION_LEVEL_DEBUG CONFIG_COMPILER_OPTIMIZATION_DEFAULT #define CONFIG_POST_EVENTS_FROM_IRAM_ISR CONFIG_ESP_EVENT_POST_FROM_IRAM_ISR diff --git a/docs/en/migration-guides/tools.rst b/docs/en/migration-guides/tools.rst index 92f0204693..880ac373b4 100644 --- a/docs/en/migration-guides/tools.rst +++ b/docs/en/migration-guides/tools.rst @@ -4,4 +4,4 @@ Migrate Tools to ESP-IDF 5.0 IDF Monitor ----------- -IDF Monitor follows the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200. That means if a custom UART baud-rate is set then one doesn't have to change the monitor baud-rate (:ref:`CONFIG_ESPTOOLPY_MONITOR_BAUD`) to match it. +IDF Monitor follows the custom console baud-rate (:ref:`CONFIG_ESP_CONSOLE_UART_BAUDRATE`) by default instead of 115200. Setting a custom baud rate is not supported from menuconfig anymore. A custom baud-rate can be specified from command line with the ``idf.py monitor -B `` command or through setting environment variables. Run ``idf.py monitor --help`` for more information.