hal_timer.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_HAL_TIMER_
#define H_HAL_TIMER_
 
#include <inttypes.h>
#include "../os/queue.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* HAL timer callback */
typedef void (*hal_timer_cb)(void *arg);
 
struct hal_timer {
    void                *bsp_timer;
    hal_timer_cb        cb_func;
    void                *cb_arg;
    uint32_t            expiry;
    TAILQ_ENTRY(hal_timer) link;    /* Queue linked list structure */
};
 
int hal_timer_init(int timer_num, void *cfg);
 
int hal_timer_deinit(int timer_num);
 
int hal_timer_config(int timer_num, uint32_t freq_hz);
 
uint32_t hal_timer_get_resolution(int timer_num);
 
uint32_t hal_timer_read(int timer_num);
 
int hal_timer_delay(int timer_num, uint32_t ticks);
 
int hal_timer_set_cb(int timer_num, struct hal_timer *tmr, hal_timer_cb cb_func,
                     void *arg);
 
int hal_timer_start(struct hal_timer *tmr, uint32_t ticks);
 
int hal_timer_start_at(struct hal_timer *tmr, uint32_t tick);
 
int hal_timer_stop(struct hal_timer *tmr);
 
#ifdef __cplusplus
}
#endif
 
#endif /* H_HAL_TIMER_ */