nuttx/sched/clock/clock_getres.c

/****************************************************************************
 * sched/clock/clock_getres.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 <stdint.h>
#include <time.h>
#include <errno.h>
#include <nuttx/debug.h>

#include <nuttx/clock.h>
#include <nuttx/fs/fs.h>
#include <nuttx/timers/ptp_clock.h>

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

/****************************************************************************
 * Name: clock_getres
 *
 * Description:
 *   Clock Functions based on POSIX APIs
 *
 ****************************************************************************/

int clock_getres(clockid_t clock_id, struct timespec *res)
{
  clockid_t clock_type = clock_id & CLOCK_MASK;
  int       ret = OK;

  sinfo("clock_id=%d, clock_type=%d\n", clock_id, clock_type);

  switch (clock_type)
    {
      default:
        serr("Returning ERROR\n");
        set_errno(EINVAL);
        ret = ERROR;
        break;

      case CLOCK_MONOTONIC:
      case CLOCK_BOOTTIME:
      case CLOCK_REALTIME:
      case CLOCK_PROCESS_CPUTIME_ID:
      case CLOCK_THREAD_CPUTIME_ID:

        /* Form the timspec using clock resolution in nanoseconds */

        res->tv_sec  = 0;
        res->tv_nsec = NSEC_PER_TICK;

        sinfo("Returning res=(%jd,%ld)\n",
              (intmax_t)res->tv_sec, res->tv_nsec);
        break;

#ifdef CONFIG_PTP_CLOCK
      case 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_GETRES, res);
          file_put(filep);
        }
        break;
#endif
    }

  return ret;
}