Registered User mNo edit summary |
Registered User No edit summary |
||
(One intermediate revision by one other user not shown) | |||
Line 1: | Line 1: | ||
{{ApplicableFor | |||
|MPUs list=STM32MP13x, STM32MP15x | |MPUs list=STM32MP13x, STM32MP15x, STM32MP25x | ||
|MPUs checklist=STM32MP13x,STM32MP15x | |MPUs checklist=STM32MP13x, STM32MP15x, STM32MP25x | ||
}}</noinclude> | }} | ||
<noinclude></noinclude> | |||
This article gives information about the Linux<sup>®</sup> RTC framework. The RTC framework is involved in precise time countdown. | This article gives information about the Linux<sup>®</sup> RTC framework. The RTC framework is involved in precise time countdown. | ||
== Framework purpose == | == Framework purpose == | ||
The RTC keeps the system time up to date and can wake up the system from the standby power mode at a programmed time. | The RTC keeps the system time up-to-date and can wake up the system from the standby power mode at a programmed time. | ||
<BR><BR> | <BR><BR> | ||
Line 35: | Line 36: | ||
* '''User application''' | * '''User application''' | ||
: The user application can be | : The user application can be a user built application or an community application such as hwclock. | ||
=== API description === | === API description === | ||
Line 41: | Line 42: | ||
== Configuration== | == Configuration== | ||
=== Kernel | === Kernel configuration === | ||
Activate '''rtc-stm32''' driver in kernel configuration using the Linux Menuconfig tool: [[Menuconfig or how to configure kernel]] | Activate '''rtc-stm32''' driver in kernel configuration using the Linux Menuconfig tool: [[Menuconfig or how to configure kernel]] | ||
Device drivers ---> | Device drivers ---> | ||
Line 48: | Line 49: | ||
=== Device tree configuration === | === Device tree configuration === | ||
Refer to the [[RTC_device_tree_configuration | RTC device tree configuration]]. | |||
==How to use the framework== | ==How to use the framework== | ||
Refer to the [[How_to_use_the_RTC | How to use the RTC]]. | |||
==How to trace and debug the framework== | ==How to trace and debug the framework== | ||
=== How to trace=== | === How to trace=== | ||
Dynamic debug traces can be added using the following | Dynamic debug traces can be added using the following command: | ||
echo -n 'file rtc-stm32.c +p'>/sys/kernel/debug/dynamic_debug/control | echo -n 'file rtc-stm32.c +p'>/sys/kernel/debug/dynamic_debug/control | ||
Line 75: | Line 76: | ||
<noinclude> | <noinclude> | ||
[[Category:RTC|0]] | [[Category:RTC|0]] | ||
{{PublicationRequestId | | | {{PublicationRequestId | 22118 | 2022-01-04 | }} | ||
{{ArticleBasedOnModel|Framework overview article model}} | {{ArticleBasedOnModel|Framework overview article model}} | ||
</noinclude> | </noinclude> |
Revision as of 12:59, 26 October 2023
This article gives information about the Linux® RTC framework. The RTC framework is involved in precise time countdown.
1. Framework purpose[edit | edit source]
The RTC keeps the system time up-to-date and can wake up the system from the standby power mode at a programmed time.
A general presentation of the RTC framework is available in the Linux RTC documentation [1].
2. System overview[edit | edit source]
2.1. Component description[edit | edit source]
- RTC (hardware)
- RTC dedicated hardware block in STM32MPU product.
- rtc-stm32
- RTC ST driver.
- rtc
- Linux RTC framework, it provides API to RTC driver and interfaces to user.
- Sysfs interface
- Sysfs interface is accessible via /sys/class/rtc/rtcX/.
- Procfs interface
- Procfs interface is accessible via /proc/driver/rtc.
- Char device interface
- Device interface is accessible via /dev/rtcX.
- User application
- The user application can be a user built application or an community application such as hwclock.
2.2. API description[edit | edit source]
API is described in Linux RTC documentation [1].
3. Configuration[edit | edit source]
3.1. Kernel configuration[edit | edit source]
Activate rtc-stm32 driver in kernel configuration using the Linux Menuconfig tool: Menuconfig or how to configure kernel
RTCDevice drivers ---> -*- Real Time Clock ---> <*> STM32
3.2. Device tree configuration[edit | edit source]
Refer to the RTC device tree configuration.
4. How to use the framework[edit | edit source]
Refer to the How to use the RTC.
5. How to trace and debug the framework[edit | edit source]
5.1. How to trace[edit | edit source]
Dynamic debug traces can be added using the following command:
echo -n 'file rtc-stm32.c +p'>/sys/kernel/debug/dynamic_debug/control
6. Source code location[edit | edit source]
- rtc-stm32: drivers/rtc/rtc-stm32.c
- api: include/linux/rtc.h
- framework:
- device-tree bindings constants: include/dt-bindings/rtc/rtc-stm32.h
7. References[edit | edit source]