nuttx/sched/clock/clock_settime.c

/****************************************************************************
 * sched/clock/clock_settime.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>

#include <time.h>
#include <assert.h>
#include <errno.h>
#include <nuttx/debug.h>
#include <sys/time.h>

#include <nuttx/arch.h>
#include <nuttx/fs/fs.h>
#include <nuttx/clock_notifier.h>
#include <nuttx/irq.h>
#include <nuttx/spinlock.h>
#include <nuttx/timers/ptp_clock.h>

#include "clock/clock.h"
#ifdef CONFIG_CLOCK_TIMEKEEPING
#  include "clock/clock_timekeeping.h"
#endif

#if defined(CONFIG_RTC) && defined(CONFIG_SCHED_LPWORK)
static struct work_s g_rtc_work;
static struct timespec g_rtc_to_set;
#endif

/****************************************************************************
 * Private Functions
 ****************************************************************************/

#if defined(CONFIG_RTC) && defined(CONFIG_SCHED_LPWORK)
static void rtc_worker(FAR void *arg)
{
  up_rtc_settime(arg);
}
#endif

static void nxclock_set_realtime(FAR const struct timespec *tp)
{
#ifndef CONFIG_CLOCK_TIMEKEEPING
  struct timespec bias;
  irqstate_t flags;
#  ifdef CONFIG_CLOCK_ADJTIME
  const struct timeval zerodelta = {
    0, 0
  };
#  endif

  /* Interrupts are disabled here so that the in-memory time
   * representation and the RTC setting will be as close as
   * possible.
   */

  /* Get the elapsed time since power up (in milliseconds).  This is a
   * bias value that we need to use to correct the base time.
   */

  clock_systime_timespec(&bias);

  flags = spin_lock_irqsave(&g_basetime_lock);

  clock_timespec_subtract(tp, &bias, &g_basetime);
  clock_notifier_call_chain(CLOCK_REALTIME, tp);

  spin_unlock_irqrestore(&g_basetime_lock, flags);

  /* Setup the RTC (lo- or high-res) */

#  ifdef CONFIG_RTC
  if (g_rtc_enabled)
    {
#    ifdef CONFIG_SCHED_LPWORK
      /* Setting the current time in RTC may be a blocking operation (driver
       * needs to wait for oscillator stabilization after reset and so on).
       * This may cause the unwanted effect of clock_settime blocking the
       * code execution for a considerable amount of time.
       *
       * The solution is to plan a low priority work that takes care
       * of setting the time in RTC and let clock_settime continue. We don't
       * have to check if the work is available, just cancel it if there
       * is a new time set request.
       */

      g_rtc_to_set = *tp;
      work_queue(LPWORK, &g_rtc_work, rtc_worker,
                 (FAR void *)&g_rtc_to_set, 0);
#    else
      up_rtc_settime(tp);
#    endif
    }
#  endif

#  ifdef CONFIG_CLOCK_ADJTIME
  /* Cancel any ongoing adjustment */

  adjtime(&zerodelta, NULL);
#  endif
#else
  clock_timekeeping_set_wall_time(tp);
#endif
}

/****************************************************************************
 * Public Functions
 ****************************************************************************/

/****************************************************************************
 * Name: clock_settime
 *
 * Description:
 *   Clock Functions based on POSIX APIs
 *
 *   CLOCK_REALTIME - POSIX demands this to be present. This is the wall
 *   time clock.
 *
 ****************************************************************************/

int clock_settime(clockid_t clock_id, FAR const struct timespec *tp)
{
  int ret = -EINVAL;

  if (tp != NULL && tp->tv_nsec >= 0 && tp->tv_nsec < 1000000000)
    {
      if (clock_id == CLOCK_REALTIME)
        {
          nxclock_set_realtime(tp);
          ret = 0;
        }
#ifdef CONFIG_PTP_CLOCK
      else if ((clock_id & CLOCK_MASK) == CLOCK_FD)
        {
          FAR struct file *filep;

          ret = ptp_clockid_to_filep(clock_id, &filep);
          if (ret >= 0)
            {
              ret = file_ioctl(filep, PTP_CLOCK_SETTIME, tp);
              file_put(filep);
            }
        }
#endif
    }

  if (ret < 0)
    {
      set_errno(-ret);
      return ERROR;
    }

  return OK;
}