mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2026-10-02 14:23:19 +08:00
补充 components\utilities\libadt中Kconfig的help内容#10960
This commit is contained in:
Huang Ziyang
@@ -5,27 +5,57 @@ menu "Timezone and Daylight Saving Time"
|
||||
bool "Enable fully version timezone and daylight saving time with database"
|
||||
select PKG_USING_TZ_DATABASE # select timezone database software package
|
||||
default n
|
||||
help
|
||||
RT_LIBC_USING_FULL_TZ_DST controls whether "full timezone and daylight saving time functionality with database" is enabled.
|
||||
|
||||
Essentially, it allows RT-Thread to support precise time conversion based on a global timezone database.
|
||||
|
||||
Features:
|
||||
Global timezone adaptation
|
||||
Automatic daylight saving time (DST) handling
|
||||
Standard time interface compatibility
|
||||
|
||||
Dependencies:
|
||||
Once enabled (disabled by default), it automatically enables the tz_database package in the RT-Thread software package.
|
||||
|
||||
After enabling RT_LIBC_USING_FULL_TZ_DST, the project will automatically import the tz_database code and data files.
|
||||
|
||||
|
||||
config RT_LIBC_USING_LIGHT_TZ_DST
|
||||
bool "Enable lightweight timezone and daylight saving time"
|
||||
depends on !RT_LIBC_USING_FULL_TZ_DST
|
||||
default y
|
||||
help
|
||||
RT_LIBC_USING_LIGHT_TZ_DST is a lightweight timezone and daylight saving time configuration option within the C standard library (libc) component of RT-Thread.
|
||||
It is a lightweight alternative to RT_LIBC_USING_FULL_TZ_DST (the full timezone solution).
|
||||
|
||||
It achieves local timezone conversion using a fixed time offset, rather than relying on a large timezone database.
|
||||
|
||||
This option is enabled by default, but only one of RT_LIBC_USING_FULL_TZ_DST can be enabled at a time.
|
||||
When enabled, three sub-configuration options will be displayed.
|
||||
|
||||
|
||||
if RT_LIBC_USING_LIGHT_TZ_DST
|
||||
config RT_LIBC_TZ_DEFAULT_HOUR
|
||||
int "Set the default local timezone (hour)"
|
||||
range -12 12
|
||||
default 8
|
||||
help
|
||||
The hour offset of the local time zone relative to UTC (range -12~12, default 8, corresponding to UTC+8 Beijing time).
|
||||
|
||||
config RT_LIBC_TZ_DEFAULT_MIN
|
||||
int "Set the default local timezone (minute)"
|
||||
range -59 59
|
||||
default 0
|
||||
|
||||
help
|
||||
Minute offset (range -59~59, default 0)
|
||||
config RT_LIBC_TZ_DEFAULT_SEC
|
||||
int "Set the default local timezone (second)"
|
||||
range -59 59
|
||||
default 0
|
||||
help
|
||||
Second offset (range -59~59, default 0)
|
||||
|
||||
endif
|
||||
endmenu
|
||||
|
||||
|
||||
@@ -1,6 +1,13 @@
|
||||
menuconfig RT_USING_CPLUSPLUS
|
||||
bool "Enable C++ features"
|
||||
default n
|
||||
help
|
||||
RT_USING_CPLUSPLUS is the master switch for enabling C++ support.
|
||||
|
||||
It is off by default. Once enabled, RT-Thread's build system ensures that a C++ compiler is used to compile .cpp files,
|
||||
and it links C++ standard libraries (such as libstdc++ or libc++) into the final firmware.
|
||||
Other C++-related configuration items that depend on it become visible and configurable.
|
||||
|
||||
|
||||
if RT_USING_CPLUSPLUS
|
||||
|
||||
@@ -11,13 +18,26 @@ if RT_USING_CPLUSPLUS
|
||||
select RT_USING_POSIX_STDIO
|
||||
select RT_USING_PTHREADS
|
||||
select RT_USING_RTC
|
||||
help
|
||||
RT_USING_CPLUSPLUS11 controls whether support for multithreading features in the C++11 standard is enabled.
|
||||
|
||||
It is disabled by default. Once enabled, RT_USING_POSIX_FS, RT_USING_POSIX_STDIO, RT_USING_PTHREADS, and RT_USING_RTC will also be enabled.
|
||||
|
||||
config RT_USING_CPP_WRAPPER
|
||||
bool "Enable RT-Thread APIs C++ wrapper"
|
||||
default n
|
||||
help
|
||||
RT_USING_CPP_WRAPPER is used to enable the C++ wrapper for the RT-Thread core API.
|
||||
|
||||
When this option is enabled (Off by default), RT-Thread provides an additional set of C++ code that encapsulates the underlying C API using classes and objects.
|
||||
config RT_USING_CPP_EXCEPTIONS
|
||||
bool "Enable C++ exceptions (will increase overhead)"
|
||||
default n
|
||||
help
|
||||
RT_USING_CPP_EXCEPTIONS is used to enable C++ exception handling.
|
||||
|
||||
It is disabled by default. Enabling this option pulls in the C++ exception runtime support, which typically increases
|
||||
code size (flash/ROM usage), RAM consumption, and may add extra runtime overhead for stack unwinding and exception
|
||||
bookkeeping. On resource-constrained or strict real-time systems, this additional overhead should be evaluated carefully
|
||||
before turning the option on.
|
||||
endif
|
||||
|
||||
@@ -1,36 +1,73 @@
|
||||
menuconfig RT_USING_AT
|
||||
bool "Enable AT commands"
|
||||
default n
|
||||
help
|
||||
RT_USING_AT is the master switch for the "AT command framework" in the RT-Thread system.
|
||||
The AT command component provides a standardized framework for AT command parsing, registration, and response, adapting to various peripherals that support AT commands.
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
if RT_USING_AT
|
||||
|
||||
config AT_DEBUG
|
||||
bool "Enable debug log output"
|
||||
default n
|
||||
help
|
||||
AT_DEBUG is a switch that enables debug logging output for the AT command framework.
|
||||
When enabled, it prints logs of AT commands, including "sent/received content," "parsing process," "response result," and "error reason."
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
config AT_USING_SERVER
|
||||
bool "Enable AT commands server"
|
||||
default n
|
||||
help
|
||||
AT_USING_SERVER is the AT server function switch.
|
||||
Its core function is to expand the AT command framework from "local serial port interaction mode" to "network/multi-channel service mode."
|
||||
When enabled, AT commands are no longer limited to local serial port transmission and reception.
|
||||
They can also receive and respond to AT commands through network channels such as TCP/UDP/virtual serial ports, enabling "remote AT debugging/control."
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
if AT_USING_SERVER
|
||||
|
||||
config AT_SERVER_DEVICE
|
||||
string "Server device name"
|
||||
default "uart3"
|
||||
help
|
||||
The core function of AT_SERVER_DEVICE is to specify the "underlying data transceiver device name" of the AT server.
|
||||
The command interaction of the AT server ultimately needs to be bound to a physical/virtual device as a data channel (such as a serial port or network device).
|
||||
|
||||
By default, it is "uart3".
|
||||
|
||||
config AT_SERVER_RECV_BUFF_LEN
|
||||
int "The maximum length of server data accepted"
|
||||
default 256
|
||||
help
|
||||
The core function of AT_SERVER_RECV_BUFF_LEN is to define the "maximum buffer length" for the AT server to receive a single AT command.
|
||||
When receiving remote/serial AT commands, the AT server first stores the data in this buffer, and then parses it after the command is fully received.
|
||||
|
||||
The default value is 256.
|
||||
|
||||
config AT_SERVER_SEND_BUFF_LEN
|
||||
int "The maximum length of server commands buffer"
|
||||
default 256
|
||||
help
|
||||
The core function of AT_SERVER_SEND_BUFF_LEN is to define the "maximum buffer length" for the AT server to send AT command responses/issue commands.
|
||||
When the AT server returns command responses to a remote terminal/serial port or issues AT commands to a module, it first stores the data in this buffer before sending it in batches.
|
||||
|
||||
The default value is 256.
|
||||
|
||||
endif
|
||||
|
||||
config AT_USING_CLIENT
|
||||
bool "Enable AT commands client"
|
||||
default n
|
||||
help
|
||||
The core function of AT_USING_CLIENT is to switch the AT framework from a "passive command response mode" to an "active command initiation mode."
|
||||
When enabled, the AT framework can act as an "AT client," actively sending AT commands to external AT devices and waiting for/parsing responses.
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
if AT_USING_CLIENT
|
||||
|
||||
@@ -38,18 +75,32 @@ if RT_USING_AT
|
||||
int "The maximum number of supported clients"
|
||||
default 1
|
||||
range 1 65535
|
||||
help
|
||||
The core function of AT_CLIENT_NUM_MAX is to define the maximum number of AT client instances that can be created simultaneously within the AT framework.
|
||||
|
||||
By default, the value range is 1-65535.
|
||||
|
||||
config AT_USING_SOCKET
|
||||
bool "Enable BSD Socket API support by AT commnads"
|
||||
select RT_USING_SAL
|
||||
select SAL_USING_AT
|
||||
default n
|
||||
help
|
||||
AT_USING_SOCKET is an AT socket adaptation switch within the AT command framework. Its core function is to enable the AT framework to provide a "BSD Socket standard API wrapper."
|
||||
When enabled, network modules adapted to AT commands can directly call the standard BSD Socket API without needing to concern themselves with the underlying AT command details.
|
||||
|
||||
It is disabled by default; enabling it will also enable RT_USING_SAL and SAL_USING_AT.
|
||||
|
||||
if AT_USING_SOCKET
|
||||
|
||||
config AT_USING_SOCKET_SERVER
|
||||
bool "Enable BSD Socket API support about AT server"
|
||||
default n
|
||||
help
|
||||
AT_USING_SOCKET_SERVER is used to enable the AT socket server function within the AT command framework.
|
||||
When enabled, the AT server can be accessed through BSD Socket API.
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
endif
|
||||
|
||||
@@ -61,10 +112,22 @@ if RT_USING_AT
|
||||
bool "Enable CLI(Command-Line Interface) for AT commands"
|
||||
default y
|
||||
depends on RT_USING_FINSH
|
||||
help
|
||||
AT_USING_CLI is the AT command-line interaction switch within the AT framework.
|
||||
Its core function is to integrate AT commands into the RT-Thread FinSH command-line console.
|
||||
When enabled, AT commands can be entered directly in the FinSH terminal without requiring an additional serial port/network channel.
|
||||
|
||||
It is enabled by default, but RT_USING_FINSH must be enabled.
|
||||
|
||||
config AT_PRINT_RAW_CMD
|
||||
bool "Enable print RAW format AT command communication data"
|
||||
default n
|
||||
help
|
||||
AT_PRINT_RAW_CMD is a switch for printing raw AT data within the AT command framework.
|
||||
Its core function is to print the raw binary/character data during AT command interaction.
|
||||
When enabled, it outputs unfiltered, unformatted AT transmit and receive data.
|
||||
|
||||
It is disabled by default.
|
||||
|
||||
endif
|
||||
|
||||
|
||||
+388
-1
File diff suppressed because it is too large
Load Diff
@@ -1,33 +1,81 @@
|
||||
menuconfig RT_USING_NETDEV
|
||||
bool "Enable network interface device"
|
||||
default n
|
||||
help
|
||||
RT_USING_NETDEV is used in the RT-Thread operating system to enable the Network Device Driver Framework.
|
||||
|
||||
Features:
|
||||
Compiles the core code of the network device framework
|
||||
Provides a unified interface for operating network devices
|
||||
Supports multiple network device types
|
||||
Enables related network tools and commands
|
||||
|
||||
Disabled by default; RT_USING_NETDEV is available once enabled.
|
||||
if RT_USING_NETDEV
|
||||
|
||||
config NETDEV_USING_IFCONFIG
|
||||
bool "Enable ifconfig features"
|
||||
default y
|
||||
help
|
||||
NETDEV_USING_IFCONFIG is used to enable or disable the ifconfig command functionality in the system.
|
||||
|
||||
NETDEV_USING_IFCONFIG is enabled by default. When enabled, ifconfig can be used to perform the following functions:
|
||||
View network interface information;
|
||||
Configure network interface parameters.
|
||||
config NETDEV_USING_PING
|
||||
bool "Enable ping features"
|
||||
default y
|
||||
help
|
||||
NETDEV_USING_PING enables or disables the ping command functionality on the system.
|
||||
|
||||
Function Description:
|
||||
Ping is a commonly used network diagnostic tool used to test connectivity between two network devices.
|
||||
|
||||
It is disabled by default; once enabled, the ping function can be used.
|
||||
|
||||
config NETDEV_USING_NETSTAT
|
||||
bool "Enable netstat features"
|
||||
default y
|
||||
help
|
||||
NETDEV_USING_NETSTAT enables or disables the netstat command functionality on your system.
|
||||
|
||||
netstat is a command-line tool used to display network connectivity status, routing tables, and network interface statistics.
|
||||
|
||||
It is enabled by default. Once enabled, you can use the netstat command in the shell (FinSH/MSH) to perform the following operations:
|
||||
View network connectivity status
|
||||
View network interface statistics
|
||||
View routing tables
|
||||
config NETDEV_USING_AUTO_DEFAULT
|
||||
bool "Enable default netdev automatic change features"
|
||||
default y
|
||||
|
||||
help
|
||||
NETDEV_USING_AUTO_DEFAULT enables or disables automatic switching of the default network interface.
|
||||
|
||||
Enabled by default. When enabled, the system automatically monitors the status of all network interfaces.
|
||||
When a new network interface is enabled and successfully obtains an IP address, the system automatically sets this new interface as the default network interface.
|
||||
If the current default network interface becomes disconnected, the system will attempt to select one from other connected network interfaces as the new default interface.
|
||||
config NETDEV_USING_LINK_STATUS_CALLBACK
|
||||
bool "Enable netdev callback on link status change"
|
||||
default n
|
||||
|
||||
help
|
||||
NETDEV_USING_LINK_STATUS_CALLBACK enables the network link state change callback mechanism.
|
||||
|
||||
It is disabled by default. Once enabled, the netdev framework provides a set of link state change callback registration/deregistration interfaces,
|
||||
allowing users to execute custom business logic when the link state of network devices changes.
|
||||
|
||||
config NETDEV_USING_IPV6
|
||||
bool "Enable IPV6 protocol support"
|
||||
default n
|
||||
help
|
||||
NETDEV_USING_IPv6 enables IPv6 protocol stack adaptation.
|
||||
|
||||
Features:
|
||||
Adds IPv6 address management to network devices;
|
||||
Supports IPv6 link layer adaptation;
|
||||
Adapts to the RT-Thread kernel IPv6 protocol stack, providing IPv6 tools such as ping6 and ifconfig6;
|
||||
Unifies the operation interface for IPv4/IPv6 devices.
|
||||
|
||||
Disabled by default. Once enabled, the netdev framework expands from "IPv4 only" to "dual-stack (IPv4+IPv6)/pure IPv6" mode.
|
||||
config NETDEV_IPV4
|
||||
int
|
||||
default 1
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -2,23 +2,88 @@ menuconfig RT_USING_ADT
|
||||
bool "Enable ADT(abstract data type)"
|
||||
default y if ARCH_MM_MMU
|
||||
default n
|
||||
help
|
||||
ADT(abstract data type) are a set of general interfaces that encapsulate commonly used data structures.
|
||||
|
||||
ADT's Core Functions and Components:
|
||||
AVL Tree (RT_USING_ADT_AVL)
|
||||
Bitmap (RT_USING_ADT_BITMAP)
|
||||
Hash Table (RT_USING_ADT_HASHMAP)
|
||||
Reference Counting API (RT_USING_ADT_REF)
|
||||
|
||||
Features and Advantages of ADT:
|
||||
Abstract Interface: Hides the implementation details of data structures; only a unified interface needs to be called.
|
||||
Customizability: Reduces system resource consumption through Kconfig configuration.
|
||||
Generality: Applicable to various scenarios.
|
||||
|
||||
Once enabled, you can use the AVL tree, bitmap, hash table, and reference counting APIs.
|
||||
|
||||
config RT_USING_ADT_AVL
|
||||
bool "AVL tree"
|
||||
depends on RT_USING_ADT
|
||||
default y
|
||||
help
|
||||
An AVL tree (RT_USING_ADT_AVL) is a self-balancing binary search tree.
|
||||
|
||||
Core capabilities:
|
||||
Supports efficient insertion, deletion, and search operations;
|
||||
Data is naturally ordered, facilitating range queries.
|
||||
|
||||
Typical scenarios:
|
||||
Task priority sorting;
|
||||
Log timestamp indexing;
|
||||
Ordered management of dynamic configuration items.
|
||||
|
||||
Once enabled, AVL trees can be used (ADT must be enabled).
|
||||
|
||||
config RT_USING_ADT_BITMAP
|
||||
bool "Bitmap"
|
||||
depends on RT_USING_ADT
|
||||
default y
|
||||
help
|
||||
A bitmap (RT_USING_ADT_BITMAP) represents a set of states using consecutive binary bits.
|
||||
|
||||
Core capabilities:
|
||||
Extreme memory efficiency;
|
||||
Fast set, clear, and query operations based on bitwise operations.
|
||||
|
||||
Typical scenarios:
|
||||
Resource allocation flags;
|
||||
Permission switches;
|
||||
State set management.
|
||||
|
||||
Once enabled, bitmaps can be used (ADT must be enabled).
|
||||
|
||||
config RT_USING_ADT_HASHMAP
|
||||
bool "HashMap"
|
||||
depends on RT_USING_ADT
|
||||
default y
|
||||
help
|
||||
Hash Table (RT_USING_ADT_HASHMAP) is a storage structure based on key-value mapping.
|
||||
|
||||
Core capabilities:
|
||||
Average lookup, insertion, and deletion times are close to O(1);
|
||||
Supports custom hash functions and key comparison rules, adapting to different key types.
|
||||
|
||||
Typical scenarios:
|
||||
Scenarios requiring fast object lookup using unique identifiers;
|
||||
String key-value pair configuration;
|
||||
High-frequency query scenarios.
|
||||
|
||||
Once enabled, HashMap can be used (ADT must be enabled).
|
||||
|
||||
config RT_USING_ADT_REF
|
||||
bool "Reference API"
|
||||
depends on RT_USING_ADT
|
||||
default y
|
||||
help
|
||||
The Reference Counting API (RT_USING_ADT_REF) is a mechanism for managing object lifecycles through a counter.
|
||||
|
||||
Core capabilities:
|
||||
Simplifies the release logic of shared resources across multiple modules;
|
||||
automatically maintains the lifecycle without requiring manual tracking of object users.
|
||||
|
||||
Typical scenarios:
|
||||
Multi-threaded/multi-module shared resources.
|
||||
|
||||
Once enabled, Reference API can be used (ADT must be enabled).
|
||||
|
||||
@@ -2,24 +2,55 @@
|
||||
menuconfig RT_USING_RT_LINK
|
||||
bool "RT-Link"
|
||||
default n
|
||||
help
|
||||
RT-Link is a lightweight, portable data link layer transport protocol.
|
||||
|
||||
Key Features:
|
||||
Supports data retransmission mechanism
|
||||
Frame sequence number and status synchronization
|
||||
Provides a unified API interface
|
||||
Supports adaptation to various underlying hardware
|
||||
Built-in CRC checksum
|
||||
|
||||
Typical Application Scenarios:
|
||||
Short-range communication between low-power devices
|
||||
Device firmware upgrades, log feedback, etc.
|
||||
|
||||
Not enabled by default,Once enabled, RT-Link components can be used (requires enabling UART or other related hardware transmission media).
|
||||
|
||||
if RT_USING_RT_LINK
|
||||
choice RT_LINK_USING_CRC
|
||||
prompt"use hw crc device or not"
|
||||
default RT_LINK_USING_SF_CRC
|
||||
help
|
||||
In RT-Thread's RT-Link protocol:
|
||||
CRC check verifies whether the data has been tampered with or corrupted during transmission by calculating the CRC value of the data.
|
||||
|
||||
Once enabled, CRC checksums in RT-Link can be used (software CRC checksums are enabled by default).
|
||||
You can choose to enable either software CRC checksums or hardware CRC checksums.
|
||||
|
||||
config RT_LINK_USING_SF_CRC
|
||||
bool "use software crc table"
|
||||
help
|
||||
Once enabled, software CRC checksums in RT-Link can be used.
|
||||
config RT_LINK_USING_HW_CRC
|
||||
bool "use hardware crc device"
|
||||
help
|
||||
Once enabled, hardware CRC checksums in RT-Link can be used.
|
||||
endchoice
|
||||
|
||||
menu "rt link debug option"
|
||||
config USING_RT_LINK_DEBUG
|
||||
bool "Enable RT-Link debug"
|
||||
default n
|
||||
help
|
||||
USING_RT_LINK_DEBUG enables RT-Link core debugging.
|
||||
Once enabled, it will output debugging information for the RT-Link protocol layer (disabled by default).
|
||||
config USING_RT_LINK_HW_DEBUG
|
||||
bool "Enable RT-Link hw debug"
|
||||
default n
|
||||
help
|
||||
USING_RT_LINK_HW_DEBUG enables RT-Link hardware debugging.
|
||||
Once enabled, it will output debugging information about the underlying RT-Link hardware (disabled by default).
|
||||
endmenu
|
||||
endif
|
||||
|
||||
@@ -4,5 +4,10 @@ config RT_UTEST_SELF_PASS
|
||||
bool "UTEST Framework Test"
|
||||
select RT_USING_UTEST
|
||||
default n
|
||||
help
|
||||
RT_UTEST_SELF_PASS controls whether the Utest framework's self-test functionality is enabled.
|
||||
Once enabled, RT_USING_UTEST will be enabled automatically, and the self-test code included with the Utest framework will also be compiled.
|
||||
|
||||
Application scenario:
|
||||
Verifying whether the Utest framework functions correctly.
|
||||
endmenu
|
||||
|
||||
Reference in New Issue
Block a user