summaryrefslogtreecommitdiff
path: root/documentation/6.components
AgeCommit message (Collapse)Author
2026-07-27[dm][tee] support Trusted Execution Environment (TEE)GuEe-GUI
Signed-off-by: GuEe-GUI <[email protected]>
2026-07-22[documentation][finsh] Clarify variable export supportcoyaSONG
Signed-off-by: coyaSONG <[email protected]>
2026-06-29[dm][ptp] support Precision Time Protocol (PTP) IEEE 1588 clockGuEe-GUI
Signed-off-by: GuEe-GUI <[email protected]>
2026-06-23[dm][dvfs] support Dynamic Voltage and Frequency Scaling (DVFS)GuEe-GUI
1. Support DVFS and finsh cmd, there are 6 governors: - conservative - freedom - performance - powersave - schedutil 2. Support DVFS for SCMI. 3. Port the Cooling device for DVFS. 4. Port the PM with DVFS. Signed-off-by: GuEe-GUI <[email protected]>
2026-06-17[doc]Fixed the issue of incorrect display of Chinese characters in the ↵Rbb666
Doxygen documentation directory.
2026-06-12utest: move utestcases Kconfig to utest componentCYFS
Signed-off-by: CYFS <[email protected]>
2026-05-28[docs] device-driver: add DM subsystem docs and expand INDEXGuEe-GUI
Add Doxygen pages for RT-Thread device-model drivers: platform/OFW, DM core (bus, dm, power), clk/regulator/reset/power-domain, PCI/PIC, Phye, DMA/hwcache, block/SCSI/ATA/NVMe/UFS/SDIO, SCMI, RPMsg, mailbox, NVMem, NUMA, syscon, thermal, input/LED/IIO/graphic, and related power/charger/supply docs. Expand device-driver INDEX.md with ~90 @subpage entries so all new pages appear in the driver chapter navigation. Update existing UART/SPI/RTC/pin/framework/dtc pages: UART docs moved from serial/ to uart/ (uart + uart_dm + uart_earlycon); SPI and RTC gain DM companion pages; pin links to pin_dm; framework points at DM topics. Focus on registration/probe flow and in-tree APIs; no standalone VirtIO subsystem page (transport code still incomplete). Test plan: build Doxygen for documentation/ and verify device-driver INDEX links resolve without missing @ref/@subpage warnings. Signed-off-by: GuEe-GUI <[email protected]>
2026-01-31[components][clock_time] Refactor time subsystem around clock_time (#11111)Bernard Xiong
* [components][clock_time] Refactor time subsystem around clock_time Introduce the clock_time core with clock source/event separation, high-resolution scheduling, and boot-time helpers, plus clock_timer adapters for timer peripherals. Remove legacy ktime/cputime/hwtimer implementations and migrate arch and BSP time paths to the new subsystem while keeping POSIX time integration functional. Update drivers, Kconfig/SConscript wiring, documentation, and tests; add clock_time overview docs and align naming to clock_boottime/clock_hrtimer/clock_timer. * [components][clock_time] Use BSP-provided clock timer frequency on riscv64 * [risc-v] Use runtime clock timer frequency for tick and delays * [bsp] Add clock timer frequency hooks for riscv64 boards * [bsp] Update Renesas RA driver doc clock_timer link * [bsp] Sync zynqmp-r5-axu4ev rtconfig after config refresh * [bsp][rk3500] Update rk3500 clock configuration * [bsp][hpmicro] Add rt_hw_us_delay hook and update board delays * [bsp][stm32l496-st-nucleo] enable clock_time for hwtimer sample in ci * [bsp][hpmicro] Fix rtconfig include scope for hpm6750evk Move rtconfig.h include outside the ENET_MULTIPLE_PORT guard for hpm6750evk and hpm6750evk2 so configuration macros are available regardless of ENET settings. * [bsp][raspi3] select clock time for systimer * [bsp][hpm5300evk] Trim trailing blank line * [bsp][hpm5301evklite] Trim trailing blank line * [bsp][hpm5e00evk] Trim trailing blank line * [bsp][hpm6200evk] Trim trailing blank line * [bsp][hpm6300evk] Trim trailing blank line * [bsp][hpm6750evk] Trim trailing blank line * [bsp][hpm6750evk2] Trim trailing blank line * [bsp][hpm6750evkmini] Trim trailing blank line * [bsp][hpm6800evk] Trim trailing blank line * [bsp][hpm6e00evk] Trim trailing blank line * [bsp][nxp] switch lpc178x to gcc and remove mcx timer source * [bsp][stm32] fix the CONFIG_RT_USING_CLOCK_TIME issue. * [docs][clock_time] add clock time documentation * [docs][clock_time] Update clock time subsystem documentation - Update device driver index to use correct page reference - Clarify upper layer responsibilities in architecture overview - Update README to describe POSIX/libc, Soft RTC, and device driver usage - Refine architecture diagram with improved layout and color scheme - Remove obsolete clock_timer.md file * [kernel][utest] Trim trailing space * [clock_time] Fix hrtimer wrap handling * [clock_time] fix the static rt_inline issue * [clock_time] fix the rt_clock_hrtimer_control result issue
2025-10-20utest/msh: supports autocomplete of utest cases for utest_run (#10701)Yuqiang Wang
* utest/msh: supports autocomplete of utest cases for utest_run * docs/utest: explanation of adding the automatic completion function for utest_run * fix[utest]: Improvement of annotation description * remove outdated code
2025-10-15doxygen: update doc for utest for config naming ruleChen Wang
Configuration options naming rule for utest is changed from "RT_UTEST_TC_USING_XXXX" to "RT_UTEST_XXXX". Signed-off-by: Chen Wang <[email protected]>
2025-10-10doxygen: fix two issues when building with doxygen 1.9.8 (#10768)Chen Wang
* doxygen: remove @return command if function return void When doxygen is upgraded to v1.9.8 (on ubuntu 24.04), doxygen reports: "doxygen error: found documented return type for xxx that does not return anything" for those functions which return void but declare "@return" in doxygen comment. Solution: remove "@return" for those cases, and update guide document for how to write doxgen comment for functions. Signed-off-by: Chen Wang <[email protected]> * doxygen: fixed a minor typo for uart doc This error is found when building with doxygen 1.9.8, but not detecetd on 1.9.1. Signed-off-by: Chen Wang <[email protected]>
2025-09-26utest: remove RT_UTEST_USING_ALL_CASESChen Wang
Many modules' utests currently don't support enabling all tests at once. Furthermore, some modules' tests are complex, for example due to their numerous dependencies on other modules. This makes it nearly impossible to enable all tests with a single global switch. Consequently, the previously defined `RT_UTEST_USING_ALL_CASES` has lost its original meaning. We recommend deprecating this configuration switch. If a module needs to enable a group of functional tests through its own configuration, this local enable all switch should be implemented by the module itself, and a global RTT enable switch will no longer be provided. If such a requirement arises in the future, we recommend careful design, especially considering how to ensure that turning on a single switch enables all dependencies for all involved modules for ease of use. Signed-off-by: Chen Wang <[email protected]>
2025-09-15doxygen: update naming rule for utest-caseChen Wang
More details see PR #10681. As utest cases are currently moving out of `examples/utest/testcases` into their own module directories, the naming rule needs to change accordingly. Signed-off-by: Chen Wang <[email protected]>
2025-08-26doxygen: add howto for utestChen Wang
After "utest: re-org utest framework (initial version)" (PR #10534) was merged, adding a document to introduce how to add utest-cases for your module. Signed-off-by: Chen Wang <[email protected]>
2025-07-22doxygen: group name all in lowcase (part 2) (#10530)Chen Wang
* doxygen: fs: unify groupname to lowercase Signed-off-by: Chen Wang <[email protected]> * doxygen: drivers: unify groupname to lowercase Signed-off-by: Chen Wang <[email protected]> * doxygen: signal: unify groupname to lowercase Signed-off-by: Chen Wang <[email protected]> --------- Signed-off-by: Chen Wang <[email protected]>
2025-06-30[TOOLS] Add DTC (Devicetree Compiler) toolsGuEe-GUI
Signed-off-by: GuEe-GUI <[email protected]>
2025-05-29doxygen: move device_driver under to components for pagesChen Wang
In line with the layout of the source code, the Device-Driver submodule should belong to components. The doxygen Module part has been adjusted. This commit modifies the markdown document part and moves the device-driver pages under to components. Signed-off-by: Chen Wang <[email protected]>
2025-02-25doxygen: reorganize directory structureChen Wang
The original directory structure was too flat and inconvenient to view. The directory is now reorganized according to the first-level chapters, and some sub-chapters are moved to the second-level directory. Note: documentation/env is not moved to documentation/4.tool because there are too many external places that reference this path, especially in bsp, so this directory path remains as it is. Signed-off-by: Chen Wang <[email protected]>
2025-02-13doxygen: add prefix for page name (#9989)Chen Wang
Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang <[email protected]>
2025-01-26doxygen: create framework to unify markdown and source code part (#9946)Chen Wang
* doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <[email protected]> Co-authored-by: Supper Thomas <[email protected]>