* sched/clock/clock_adjtime.c
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#ifdef CONFIG_CLOCK_ADJTIME
#include <sys/time.h>
#include <stdint.h>
#include <time.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/irq.h>
#include <nuttx/arch.h>
#include <nuttx/fs/fs.h>
#include <nuttx/spinlock.h>
#include <nuttx/timers/ptp_clock.h>
#include "clock/clock.h"
* Pre-processor Definitions
****************************************************************************/
* Private Data
****************************************************************************/
static struct wdog_s g_adjtime_wdog;
static long g_adjtime_ppb;
static spinlock_t g_adjtime_lock = SP_UNLOCKED;
* Private Functions
****************************************************************************/
static void adjtime_wdog_callback(wdparm_t arg)
{
irqstate_t flags;
UNUSED(arg);
flags = spin_lock_irqsave(&g_adjtime_lock);
#ifdef CONFIG_ARCH_HAVE_ADJTIME
up_adjtime(0);
#endif
#ifdef CONFIG_RTC_ADJTIME
up_rtc_adjtime(0);
#endif
g_adjtime_ppb = 0;
spin_unlock_irqrestore(&g_adjtime_lock, flags);
}
static long long adjtime_remaining_usec(void)
{
return (long long)g_adjtime_ppb
* TICK2MSEC(wd_gettime(&g_adjtime_wdog))
/ (MSEC_PER_SEC * NSEC_PER_USEC);
}
static int adjtime_start(long long adjust_usec)
{
long long ppb;
long long ppb_limit;
irqstate_t flags;
int ret = OK;
* CONFIG_CLOCK_ADJTIME_PERIOD_MS.
*/
ppb = adjust_usec * NSEC_PER_USEC;
ppb = ppb * MSEC_PER_SEC / CONFIG_CLOCK_ADJTIME_PERIOD_MS;
ppb_limit = CONFIG_CLOCK_ADJTIME_SLEWLIMIT_PPM * 1000;
if (ppb > ppb_limit)
{
ppb = ppb_limit;
}
else if (ppb < -ppb_limit)
{
ppb = -ppb_limit;
}
flags = spin_lock_irqsave_nopreempt(&g_adjtime_lock);
g_adjtime_ppb = ppb;
#ifdef CONFIG_ARCH_HAVE_ADJTIME
up_adjtime(g_adjtime_ppb);
#endif
#ifdef CONFIG_RTC_ADJTIME
ret = up_rtc_adjtime(g_adjtime_ppb);
#endif
if (g_adjtime_ppb != 0)
{
wd_start(&g_adjtime_wdog, MSEC2TICK(CONFIG_CLOCK_ADJTIME_PERIOD_MS),
adjtime_wdog_callback, 0);
}
else
{
wd_cancel(&g_adjtime_wdog);
}
spin_unlock_irqrestore_nopreempt(&g_adjtime_lock, flags);
return ret;
}
* Public Functions
****************************************************************************/
* Name: adjtime
*
* Description:
* The adjtime() function gradually adjusts the system clock (as returned
* by gettimeofday(2)). The amount of time by which the clock is to be
* adjusted is specified in the structure pointed to by delta.
*
* This structure has the following form:
*
* struct timeval
* {
* time_t tv_sec; (seconds)
* long tv_usec; (microseconds)
* };
*
* If the adjustment in delta is positive, then the system clock is
* speeded up by some small percentage until the adjustment has been
* completed. If the adjustment in delta is negative, then the clock is
* slowed down in a similar fashion.
*
* If a clock adjustment from an earlier adjtime() call is already in
* progress at the time of a later adjtime() call, and delta is not NULL
* for the later call, then the earlier adjustment is stopped, but any
* already completed part of that adjustment is not undone.
*
* If olddelta is not NULL, then the buffer that it points to is used to
* return the amount of time remaining from any previous adjustment that
* has not yet been completed.
*
* NOTE: This is not a POSIX interface but derives from 4.3BSD, System V.
* It is also supported for Linux compatibility.
*
****************************************************************************/
int adjtime(FAR const struct timeval *delta, FAR struct timeval *olddelta)
{
long long adjust_usec = 0;
long long adjust_usec_old = 0;
int ret = OK;
if (olddelta)
{
adjust_usec_old = adjtime_remaining_usec();
olddelta->tv_sec = adjust_usec_old / USEC_PER_SEC;
olddelta->tv_usec = adjust_usec_old;
}
if (delta)
{
adjust_usec = (long long)delta->tv_sec * USEC_PER_SEC + delta->tv_usec;
ret = adjtime_start(adjust_usec);
}
if (ret < 0)
{
set_errno(-ret);
return -1;
}
else
{
return OK;
}
}
* Name: nxclock_adjtime
*
* Description:
* Adjust the frequency and/or phase of a clock.
* This function allows the adjustment of the frequency and/or phase of a
* specified clock. It can be used to synchronize the clock with an
* external time source or to apply a frequency offset.
*
* Input Parameters:
* clk_id - The identifier of the clock to be adjusted. This is typically
* one of the predefined clock IDs such as CLOCK_REALTIME,
* CLOCK_MONOTONIC, or CLOCK_BOOTTIME.
*
* buf - A pointer to a `timex` structure that specifies the adjustment
* parameters. This structure includes fields for the frequency
* adjustment (`freq`), the maximum frequency error (`maxerror`),
* the estimated error (`esterror`), the phase offset (`offset`),
* and flags to indicate the type of adjustment (`status`).
*
* Returned Value:
* Return On success, the function returns 0. On error, it returns
* -1 and sets 'errno` to indicate the specific error that
* occurred.
*
****************************************************************************/
int nxclock_adjtime(clockid_t clock_id, FAR struct timex *buf)
{
int ret = -EINVAL;
#ifdef CONFIG_PTP_CLOCK
if ((clock_id & CLOCK_MASK) == CLOCK_FD)
{
FAR struct file *filep;
ret = ptp_clockid_to_filep(clock_id, &filep);
if (ret < 0)
{
return ret;
}
ret = file_ioctl(filep, PTP_CLOCK_ADJTIME,
(unsigned long)(uintptr_t)buf);
file_put(filep);
}
#endif
return ret;
}
* Name: clock_adjtime
*
* Description:
* Adjust the frequency and/or phase of a clock.
* This function allows the adjustment of the frequency and/or phase of a
* specified clock. It can be used to synchronize the clock with an
* external time source or to apply a frequency offset.
*
* Input Parameters:
* clk_id - The identifier of the clock to be adjusted. This is typically
* one of the predefined clock IDs such as CLOCK_REALTIME,
* CLOCK_MONOTONIC, or CLOCK_BOOTTIME.
*
* buf - A pointer to a `timex` structure that specifies the adjustment
* parameters. This structure includes fields for the frequency
* adjustment (`freq`), the maximum frequency error (`maxerror`),
* the estimated error (`esterror`), the phase offset (`offset`),
* and flags to indicate the type of adjustment (`status`).
*
* Returned Value:
* Return On success, the function returns 0. On error, it returns
* -1 and sets 'errno` to indicate the specific error that
* occurred.
*
****************************************************************************/
int clock_adjtime(clockid_t clk_id, FAR struct timex *buf)
{
int ret;
ret = nxclock_adjtime(clk_id, buf);
if (ret < 0)
{
set_errno(-ret);
return ERROR;
}
return ret;
}
#endif