From c0435b5eb2f625356b42f9e35b897ac4cd1b21b4 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 3 Sep 2021 16:55:18 +0200 Subject: rtems: Document time of day constraints Update #4338. --- cpukit/include/rtems/rtems/clock.h | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'cpukit') diff --git a/cpukit/include/rtems/rtems/clock.h b/cpukit/include/rtems/rtems/clock.h index 1eeb0ce54c..d5005133f1 100644 --- a/cpukit/include/rtems/rtems/clock.h +++ b/cpukit/include/rtems/rtems/clock.h @@ -101,10 +101,13 @@ extern "C" { * range-checked, and an error is returned if any one is out of its valid * range. * - * RTEMS can represent time points of this clock in nanoseconds ranging from - * 1988-01-01T00:00:00.000000000Z to 2514-05-31T01:53:03.999999999Z. The - * future uptime of the system shall be in this range, otherwise the system - * behaviour is undefined. + * RTEMS can represent time points of the CLOCK_REALTIME clock in nanoseconds + * ranging from 1988-01-01T00:00:00.000000000Z to + * 2514-05-31T01:53:03.999999999Z. The future uptime of the system shall be in + * this range, otherwise the system behaviour is undefined. Due to + * implementation constraints, the time of day set by the directive shall be + * before 2100-01-01:00:00.000000000Z. The latest valid time of day accepted + * by the POSIX clock_settime() is 2400-01-01T00:00:00.999999999Z. * * The specified time is based on the configured clock tick rate, see the * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option. @@ -133,6 +136,12 @@ extern "C" { * * * The directive may unblock a task. This may cause the calling task to be * preempted. + * + * * The time of day set by the directive shall be + * 1988-01-01T00:00:00.000000000Z or later. + * + * * The time of day set by the directive shall be before + * 2100-01-01T00:00:00.000000000Z. * @endparblock */ rtems_status_code rtems_clock_set( const rtems_time_of_day *time_of_day ); -- cgit v1.2.3