up_rtc_gettime: add spinlock to protect up_rtc_gettime

[hujun260]

Summary

up_rtc_gettime: add spinlock to protect up_rtc_gettime

Impact

up_rtc_gettime

Testing

ci

[nuttxpr]

[Experimental Bot, please feedback here]

No, this PR does not fully meet the NuttX requirements. While it provides a summary of the change, it lacks crucial details. Here's a breakdown:

Missing Information:

• Summary: While the title mentions adding a spinlock, the why is missing. What race condition or problem does this fix? Which part of the code is changed (the specific function is mentioned, but a more general area like "RTC driver" would be helpful)? How does the spinlock solve the problem? Issue numbers are missing.
• Impact: The impact section is severely lacking. It just repeats the function name. All the YES/NO questions need to be answered with explanations. Does this change affect any particular architectures, boards, or drivers? Does it change the API? Does it require documentation updates? Are there security implications of adding this lock?
• Testing: "ci" is insufficient. What specific targets were tested? What tests were run? Actual log output (or a link to it) demonstrating the problem before the change and the successful operation after the change is needed. Host build environment information is also missing.

Example of how to improve the Summary:

"The up_rtc_gettime function was prone to race conditions when accessed concurrently from multiple threads, potentially leading to incorrect time readings. This change adds a spinlock to protect access to the RTC hardware during the up_rtc_gettime operation within the common RTC driver code. This fixes [Issue #XYZ]. This change also affects the up_rtc_settime function, which now also acquires the same spinlock.

Example of how to improve the Impact:

• Is new feature added? NO
• Is existing feature changed? YES, the up_rtc_gettime and up_rtc_settime functions are now thread-safe.
• Impact on user (will user need to adapt to change)? NO
• Impact on build (will build process change)? NO
• Impact on hardware (will arch(s) / board(s) / driver(s) change)? NO. This change is within the common RTC driver code, so all architectures using this driver benefit.
• Impact on documentation (is update required / provided)? YES, the documentation for up_rtc_gettime and up_rtc_settime should mention the thread-safety improvements. A documentation update is included in this PR.
• Impact on security (any sort of implications)? NO
• Impact on compatibility (backward/forward/interoperability)? NO
• Anything else to consider? The addition of the spinlock introduces a small performance overhead.

Example of how to improve the Testing:

• Build Host(s): Linux (Ubuntu 20.04), x86_64, GCC 9.4.0
• Target(s): sim:qemu-arm, stm32f4discovery:nsh

Testing logs before change: (demonstrate the race condition - e.g., inconsistent time readings from two threads accessing the RTC simultaneously)

... log output showing the problem ...

Testing logs after change: (show consistent time readings and no errors)

... log output showing the fix ...

Or:
Testing logs are available in the CI run for this PR: [Link to CI run]

By providing this level of detail, reviewers can quickly understand the change, its impact, and verify its correctness, leading to a faster and smoother review process.

[lupyuen]

Sorry @hujun260 could you check if the PR above is causing these build errors in sim:segger? Thanks :-)
https://github.com/NuttX/nuttx/actions/runs/12637024742/job/35210493873#step:7:287

Configuration/Tool: sim/segger
In file included from segger/SystemView/SEGGER/SEGGER_SYSVIEW.h:65,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW_Int.h:64,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:146:
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c: In function '_VPrintHost':
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:557:51: error: implicit declaration of function 'SEGGER_RTT_LOCK'; did you mean 'SEGGER_RTT_Read'? [-Werror=implicit-function-declaration]
  557 |   #define SEGGER_SYSVIEW_LOCK()                   SEGGER_RTT_LOCK()
      |                                                   ^~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:387:35: note: in expansion of macro 'SEGGER_SYSVIEW_LOCK'
  387 | #define RECORD_START(PacketSize)  SEGGER_SYSVIEW_LOCK();                            \
      |                                   ^~~~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:1005:5: note: in expansion of macro 'RECORD_START'
 1005 |     RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32);
      |     ^~~~~~~~~~~~
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:570:51: error: implicit declaration of function 'SEGGER_RTT_UNLOCK'; did you mean 'SEGGER_RTT_Init'? [-Werror=implicit-function-declaration]
  570 |   #define SEGGER_SYSVIEW_UNLOCK()                 SEGGER_RTT_UNLOCK()
      |                                                   ^~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:390:35: note: in expansion of macro 'SEGGER_SYSVIEW_UNLOCK'
  390 | #define RECORD_END()              SEGGER_SYSVIEW_UNLOCK()
      |                                   ^~~~~~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:1015:5: note: in expansion of macro 'RECORD_END'
 1015 |     RECORD_END();
      |     ^~~~~~~~~~

Also for at32f437-mini:systemview
https://github.com/NuttX/nuttx/actions/runs/12637024742/job/35210486919#step:7:128

Configuration/Tool: at32f437-mini/systemview,CONFIG_ARM_TOOLCHAIN_GNU_EABI
In file included from segger/SystemView/SEGGER/SEGGER_SYSVIEW.h:65,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW_Int.h:64,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:146:
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c: In function '_VPrintHost':
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:557:51: error: implicit declaration of function 'SEGGER_RTT_LOCK'; did you mean 'SEGGER_RTT_Read'? [-Werror=implicit-function-declaration]
  557 |   #define SEGGER_SYSVIEW_LOCK()                   SEGGER_RTT_LOCK()
      |                                                   ^~~~~~~~~~~~~~~

[hujun260]

Sorry @hujun260 could you check if the PR above is causing these build errors in sim:segger? Thanks :-) https://github.com/NuttX/nuttx/actions/runs/12637024742/job/35210493873#step:7:287

Configuration/Tool: sim/segger
In file included from segger/SystemView/SEGGER/SEGGER_SYSVIEW.h:65,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW_Int.h:64,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:146:
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c: In function '_VPrintHost':
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:557:51: error: implicit declaration of function 'SEGGER_RTT_LOCK'; did you mean 'SEGGER_RTT_Read'? [-Werror=implicit-function-declaration]
  557 |   #define SEGGER_SYSVIEW_LOCK()                   SEGGER_RTT_LOCK()
      |                                                   ^~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:387:35: note: in expansion of macro 'SEGGER_SYSVIEW_LOCK'
  387 | #define RECORD_START(PacketSize)  SEGGER_SYSVIEW_LOCK();                            \
      |                                   ^~~~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:1005:5: note: in expansion of macro 'RECORD_START'
 1005 |     RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + SEGGER_SYSVIEW_MAX_STRING_LEN + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_ARGUMENTS * SEGGER_SYSVIEW_QUANTA_U32);
      |     ^~~~~~~~~~~~
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:570:51: error: implicit declaration of function 'SEGGER_RTT_UNLOCK'; did you mean 'SEGGER_RTT_Init'? [-Werror=implicit-function-declaration]
  570 |   #define SEGGER_SYSVIEW_UNLOCK()                 SEGGER_RTT_UNLOCK()
      |                                                   ^~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:390:35: note: in expansion of macro 'SEGGER_SYSVIEW_UNLOCK'
  390 | #define RECORD_END()              SEGGER_SYSVIEW_UNLOCK()
      |                                   ^~~~~~~~~~~~~~~~~~~~~
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:1015:5: note: in expansion of macro 'RECORD_END'
 1015 |     RECORD_END();
      |     ^~~~~~~~~~

Also for at32f437-mini:systemview https://github.com/NuttX/nuttx/actions/runs/12637024742/job/35210486919#step:7:128

Configuration/Tool: at32f437-mini/systemview,CONFIG_ARM_TOOLCHAIN_GNU_EABI
In file included from segger/SystemView/SEGGER/SEGGER_SYSVIEW.h:65,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW_Int.h:64,
                 from segger/SystemView/SEGGER/SEGGER_SYSVIEW.c:146:
segger/SystemView/SEGGER/SEGGER_SYSVIEW.c: In function '_VPrintHost':
Error: segger/SystemView/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h:557:51: error: implicit declaration of function 'SEGGER_RTT_LOCK'; did you mean 'SEGGER_RTT_Read'? [-Werror=implicit-function-declaration]
  557 |   #define SEGGER_SYSVIEW_LOCK()                   SEGGER_RTT_LOCK()
      |                                                   ^~~~~~~~~~~~~~~

ok