| /* |
| * Copyright (c) 2016 Intel Corporation |
| * |
| * Copyright (c) 2004, Swedish Institute of Computer Science. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the Institute nor the names of its contributors |
| * may be used to endorse or promote products derived from this software |
| * without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND |
| * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE |
| * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * |
| * This file is part of the Contiki operating system. |
| * |
| * Author: Adam Dunkels <adam@sics.se> |
| * |
| */ |
| |
| /** |
| * \defgroup clock Clock library |
| * |
| * The clock library is the interface between Contiki and the platform |
| * specific clock functionality. The clock library defines a macro, |
| * CLOCK_SECOND, to convert seconds into the tick resolution of the platform. |
| * Typically this is 1-10 milliseconds, e.g. 4*CLOCK_SECOND could be 512. |
| * A 16 bit counter would thus overflow every 1-10 minutes. |
| * Platforms use the tick interrupt to maintain a long term count |
| * of seconds since startup. |
| * |
| */ |
| |
| #ifndef OC_CLOCK_H |
| #define OC_CLOCK_H |
| |
| #include <stdint.h> |
| |
| #include "os/mynewt.h" |
| |
| #include "oic/port/mynewt/config.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif |
| |
| /** |
| * A second, measured in system clock time. |
| * |
| * \hideinitializer |
| */ |
| #ifndef OC_CLOCK_CONF_TICKS_PER_SECOND |
| #error "Please define OC_CLOCK_CONF_TICKS_PER_SECOND in config.h" |
| #else |
| #define OC_CLOCK_SECOND OC_CLOCK_CONF_TICKS_PER_SECOND |
| #endif |
| |
| /** |
| * Initialize the clock library. |
| * |
| * This function initializes the clock library and should be called |
| * from the main() function of the system. |
| * |
| */ |
| void oc_clock_init(void); |
| |
| /** |
| * Get the current clock time. |
| * |
| * This function returns the current system clock time. |
| * |
| * \return The current clock time, measured in system ticks. |
| */ |
| oc_clock_time_t oc_clock_time(void); |
| |
| /** |
| * Get the current value of the platform seconds. |
| * |
| * This could be the number of seconds since startup, or |
| * since a standard epoch. |
| * |
| * \return The value. |
| */ |
| unsigned long oc_clock_seconds(void); |
| |
| /** |
| * Wait for a given number of ticks. |
| * \param t How many ticks. |
| * |
| */ |
| void oc_clock_wait(oc_clock_time_t t); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| #endif /* OC_CLOCK_H */ |