os_cputime.h

/*
 * 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.
 */
 
#ifndef H_OS_CPUTIME_
#define H_OS_CPUTIME_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "../syscfg/syscfg.h"
#include "../hal/hal_timer.h"
 
/*
 * NOTE: these definitions allow one to override the cputime frequency used.
 * The reason these definitions exist is to make the code more
 * efficient/smaller when CPUTIME counts at 1 MHz.
 *
 * For those who want a different cputime frequency, you can set the config
 * definition for OS_CPUTIME_FREQ to the desired frequency in your project,
 * target or bsp.
 */
#if (MYNEWT_VAL(OS_CPUTIME_FREQ) == 1000000)
 
#define OS_CPUTIME_FREQ_1MHZ
 
#elif MYNEWT_VAL(OS_CPUTIME_FREQ) == 256        ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 512        ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 1024       ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 2048       ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 4096       ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 8192       ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 16384      ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 32768      ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 32000      ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 65536      ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 131072     ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 262144     ||  \
      MYNEWT_VAL(OS_CPUTIME_FREQ) == 524288
 
#define OS_CPUTIME_FREQ_PWR2
 
#elif MYNEWT_VAL(OS_CPUTIME_FREQ) > 1000000
 
#define OS_CPUTIME_FREQ_HIGH
 
#else
 
#error "Invalid OS_CPUTIME_FREQ value.  Value must be one of a) a power of 2" \
       ">= 256Hz, or b) any value >= 1MHz"
 
#endif
 
#if defined(OS_CPUTIME_FREQ_HIGH)
/* CPUTIME data. */
struct os_cputime_data
{
    uint32_t ticks_per_usec;    /* number of ticks per usec */
};
extern struct os_cputime_data g_os_cputime;
#endif
 
/* Helpful macros to compare cputimes */
#define CPUTIME_LT(__t1, __t2) ((int32_t)   ((__t1) - (__t2)) < 0)
#define CPUTIME_GT(__t1, __t2) ((int32_t)   ((__t1) - (__t2)) > 0)
#define CPUTIME_GEQ(__t1, __t2) ((int32_t)  ((__t1) - (__t2)) >= 0)
#define CPUTIME_LEQ(__t1, __t2) ((int32_t)  ((__t1) - (__t2)) <= 0)
 
int os_cputime_init(uint32_t clock_freq);
 
uint32_t os_cputime_get32(void);
 
#if !defined(OS_CPUTIME_FREQ_PWR2)
uint32_t os_cputime_nsecs_to_ticks(uint32_t nsecs);
 
uint32_t os_cputime_ticks_to_nsecs(uint32_t ticks);
 
void os_cputime_delay_nsecs(uint32_t nsecs);
#endif
 
#if defined(OS_CPUTIME_FREQ_1MHZ)
#define os_cputime_usecs_to_ticks(x)    (x)
#define os_cputime_ticks_to_usecs(x)    (x)
#else
 
uint32_t os_cputime_usecs_to_ticks(uint32_t usecs);
 
uint32_t os_cputime_ticks_to_usecs(uint32_t ticks);
#endif
 
void os_cputime_delay_ticks(uint32_t ticks);
 
void os_cputime_delay_usecs(uint32_t usecs);
 
void os_cputime_timer_init(struct hal_timer *timer, hal_timer_cb fp,
                           void *arg);
 
int os_cputime_timer_start(struct hal_timer *timer, uint32_t cputime);
 
int os_cputime_timer_relative(struct hal_timer *timer, uint32_t usecs);
 
void os_cputime_timer_stop(struct hal_timer *timer);
 
#ifdef __cplusplus
}
#endif
 
#endif /* H_OS_CPUTIME_ */