sys: clock: rename k_clock functions to sys_clock

Rename K_CLOCK_* and k_clock_*() to SYS_CLOCK_* and sys_clock_*().

Signed-off-by: Chris Friedt <[email protected]>

Author: cfriedt

include/zephyr/kernel.h

@@ -69,8 +69,6 @@ BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
 #define Z_DECL_POLL_EVENT
 #endif
 
-struct timespec;
-
 struct k_thread;
 struct k_mutex;
 struct k_sem;
@@ -6488,92 +6486,6 @@ void k_sys_runtime_stats_enable(void);
  */
 void k_sys_runtime_stats_disable(void);
 
-/**
- * @defgroup kernel_clock_apis Kernel Clock APIs
- * @ingroup kernel_apis
- * @{
- */
-
-/**
- * @brief The real-time clock (i.e. "wall clock")
- *
- * This clock is used to measure time since the epoch (1970-01-01 00:00:00 UTC).
- *
- * It is not a steady clock; i.e. it may be adjusted for a number of reasons from initialization
- * of a hardware real-time-clock, to network-time synchronization, to manual adjustment from the
- * application.
- */
-#define K_CLOCK_REALTIME 1
-
-/**
- * @brief The monotonic clock
- *
- * This steady clock is used to measure time since the system booted. Time from this clock is
- * always monotonically increasing, modulo the upper bound of `{.tv_sec = INT64_MAX, .tv_nsec =
- * 1000000000}`.
- */
-#define K_CLOCK_MONOTONIC 4
-
-/**
- * @brief The flag used for specifying absolute timeouts
- *
- * This flag may be passed to @ref k_clock_nanosleep to indicate the requested timeout is an
- * absolute time with respect to the specified clock.
- */
-#define K_TIMER_ABSTIME 4
-
-/**
- * @brief Get the current time from the specified clock
- *
- * @param clock_id The clock from which to query time.
- * @param tp Pointer to memory where time will be written.
- * @retval 0 on success.
- * @retval -EINVAL when an invalid @a clock_id is specified.
- */
-__syscall int k_clock_gettime(int clock_id, struct timespec *tp);
-
-/**
- * @brief Set the current time for the specified clock
- *
- * @param clock_id The clock for which the time should be set.
- * @param tp Pointer to memory specifying the desired time.
- * @retval 0 on success.
- * @retval -EINVAL when an invalid @a clock_id is specified or when @a tp contains nanoseconds
- * outside of the range `[0, 999999999]`.
- */
-__syscall int k_clock_settime(int clock_id, const struct timespec *tp);
-
-/**
- * @brief Sleep for the specified amount of time with respect to the specified clock.
- *
- * This function will cause the calling thread to sleep either
- * - until the absolute time specified by @a rqtp (if @a flags includes @ref K_TIMER_ABSTIME), or
- * - until the relative time specified by @a rqtp (if @a flags does not include
- *   @ref K_TIMER_ABSTIME).
- *
- * The accepted values for @a clock_id include
- * - @ref K_CLOCK_REALTIME
- * - @ref K_CLOCK_MONOTONIC
- *
- * If @a rmtp is not NULL, and the thread is awoken prior to the time specified by @a rqtp, then
- * any remaining time will be written to @a rmtp. If the thread has slept for at least the time
- * specified by @a rqtp, then @a rmtp will be set to zero.
- *
- * @param clock_id The clock to by which to sleep.
- * @param flags Flags to modify the behavior of the sleep operation.
- * @param rqtp Pointer to the requested time to sleep.
- * @param rmtp Pointer to memory into which to copy the remaining time, if any.
- *
- * @retval 0 on success.
- * @retval -EINVAL when an invalid @a clock_id, when @a rqtp contains nanoseconds outside of the
- *         range `[0, 999999999]`, or when @a rqtp contains a negative value.
- */
-__syscall int k_clock_nanosleep(int clock_id, int flags, const struct timespec *rqtp,
-				struct timespec *rmtp);
-/**
- * @}
- */
-
 #ifdef __cplusplus
 }
 #endif

include/zephyr/posix/time.h

@@ -60,13 +60,14 @@ struct itimerspec {
 #include <errno.h>
 #include <zephyr/posix/posix_types.h>
 #include <zephyr/posix/signal.h>
+#include <zephyr/sys/clock.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 #ifndef CLOCK_REALTIME
-#define CLOCK_REALTIME K_CLOCK_REALTIME
+#define CLOCK_REALTIME SYS_CLOCK_REALTIME
 #endif
 
 #ifndef CLOCK_PROCESS_CPUTIME_ID
@@ -78,11 +79,11 @@ extern "C" {
 #endif
 
 #ifndef CLOCK_MONOTONIC
-#define CLOCK_MONOTONIC K_CLOCK_MONOTONIC
+#define CLOCK_MONOTONIC SYS_CLOCK_MONOTONIC
 #endif
 
 #ifndef TIMER_ABSTIME
-#define TIMER_ABSTIME 4
+#define TIMER_ABSTIME SYS_TIMER_ABSTIME
 #endif
 
 int clock_gettime(clockid_t clock_id, struct timespec *ts);

include/zephyr/sys/clock.h

@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2025 Tenstorrent AI ULC
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @file
+ *
+ * @ingroup public sys_clock APIs
+ */
+
+#ifndef ZEPHYR_INCLUDE_SYSCLOCK_H_
+#define ZEPHYR_INCLUDE_SYSCLOCK_H_
+
+#include <time.h>
+
+#include <zephyr/internal/syscall_handler.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @defgroup sys_clock_apis System Clock APIs
+ * @{
+ */
+
+/**
+ * @brief The real-time clock (i.e. "wall clock")
+ *
+ * This clock is used to measure time since the epoch (1970-01-01 00:00:00 UTC).
+ *
+ * It is not a steady clock; i.e. it may be adjusted for a number of reasons from initialization
+ * of a hardware real-time-clock, to network-time synchronization, to manual adjustment from the
+ * application.
+ */
+#define SYS_CLOCK_REALTIME 1
+
+/**
+ * @brief The monotonic clock
+ *
+ * This steady clock is used to measure time since the system booted. Time from this clock is
+ * always monotonically increasing, modulo the upper bound of `{.tv_sec = INT64_MAX, .tv_nsec =
+ * 1000000000}`.
+ */
+#define SYS_CLOCK_MONOTONIC 4
+
+/**
+ * @brief The flag used for specifying absolute timeouts
+ *
+ * This flag may be passed to @ref sys_clock_nanosleep to indicate the requested timeout is an
+ * absolute time with respect to the specified clock.
+ */
+#define SYS_TIMER_ABSTIME 4
+
+/**
+ * @brief Get the current time from the specified clock
+ *
+ * @param clock_id The clock from which to query time.
+ * @param tp Pointer to memory where time will be written.
+ * @retval 0 on success.
+ * @retval -EINVAL when an invalid @a clock_id is specified.
+ */
+__syscall int sys_clock_gettime(int clock_id, struct timespec *tp);
+
+/**
+ * @brief Set the current time for the specified clock
+ *
+ * @param clock_id The clock for which the time should be set.
+ * @param tp Pointer to memory specifying the desired time.
+ * @retval 0 on success.
+ * @retval -EINVAL when an invalid @a clock_id is specified or when @a tp contains nanoseconds
+ * outside of the range `[0, 999999999]`.
+ */
+__syscall int sys_clock_settime(int clock_id, const struct timespec *tp);
+
+/**
+ * @brief Sleep for the specified amount of time with respect to the specified clock.
+ *
+ * This function will cause the calling thread to sleep either
+ * - until the absolute time specified by @a rqtp (if @a flags includes @ref SYS_TIMER_ABSTIME), or
+ * - until the relative time specified by @a rqtp (if @a flags does not include
+ *   @ref SYS_TIMER_ABSTIME).
+ *
+ * The accepted values for @a clock_id include
+ * - @ref SYS_CLOCK_REALTIME
+ * - @ref SYS_CLOCK_MONOTONIC
+ *
+ * If @a rmtp is not NULL, and the thread is awoken prior to the time specified by @a rqtp, then
+ * any remaining time will be written to @a rmtp. If the thread has slept for at least the time
+ * specified by @a rqtp, then @a rmtp will be set to zero.
+ *
+ * @param clock_id The clock to by which to sleep.
+ * @param flags Flags to modify the behavior of the sleep operation.
+ * @param rqtp Pointer to the requested time to sleep.
+ * @param rmtp Pointer to memory into which to copy the remaining time, if any.
+ *
+ * @retval 0 on success.
+ * @retval -EINVAL when an invalid @a clock_id, when @a rqtp contains nanoseconds outside of the
+ *         range `[0, 999999999]`, or when @a rqtp contains a negative value.
+ */
+__syscall int sys_clock_nanosleep(int clock_id, int flags, const struct timespec *rqtp,
+				  struct timespec *rmtp);
+
+/**
+ * @}
+ */
+
+#include <zephyr/syscalls/clock.h>
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

kernel/CMakeLists.txt

@@ -51,7 +51,6 @@ list(APPEND kernel_files
   main_weak.c
   banner.c
   busy_wait.c
-  clock.c
   device.c
   errno.c
   fatal.c

lib/libc/common/source/thrd/thrd.c

@@ -10,6 +10,7 @@
 #include <zephyr/kernel.h>
 #include <zephyr/posix/pthread.h>
 #include <zephyr/posix/sched.h>
+#include <zephyr/sys/clock.h>
 
 struct thrd_trampoline_arg {
 	thrd_start_t func;
@@ -44,7 +45,7 @@ thrd_t thrd_current(void)
 
 int thrd_sleep(const struct timespec *duration, struct timespec *remaining)
 {
-	if (k_clock_nanosleep(K_CLOCK_MONOTONIC, 0, duration, remaining) != 0) {
+	if (sys_clock_nanosleep(SYS_CLOCK_REALTIME, 0, duration, remaining) != 0) {
 		return thrd_error;
 	}
 

lib/libc/common/source/time/time.c

@@ -7,14 +7,14 @@
 
 #include <time.h>
 
-#include <zephyr/kernel.h>
+#include <zephyr/sys/clock.h>
 
 time_t time(time_t *tloc)
 {
 	struct timespec ts;
 	int ret;
 
-	ret = k_clock_gettime(K_CLOCK_REALTIME, &ts);
+	ret = sys_clock_gettime(SYS_CLOCK_REALTIME, &ts);
 	if (ret < 0) {
 		errno = -ret;
 		return (time_t) -1;

lib/os/CMakeLists.txt

@@ -1,11 +1,13 @@
 # SPDX-License-Identifier: Apache-2.0
 
 zephyr_syscall_header(
+  ${ZEPHYR_BASE}/include/zephyr/sys/clock.h
   ${ZEPHYR_BASE}/include/zephyr/sys/mutex.h
 )
 
 zephyr_sources(
   cbprintf_packaged.c
+  clock.c
   printk.c
   sem.c
   thread_entry.c