timer.h

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed 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.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
/* etcpal_timer.h: Platform-neutral implementation of system timers. */
 
#ifndef ETCPAL_TIMER_H_
#define ETCPAL_TIMER_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct EtcPalTimer
{
  uint32_t reset_time; 
  uint32_t interval;   
} EtcPalTimer;
 
#define ETCPAL_TIME_ELAPSED_SINCE(start_time) (uint32_t)(etcpal_getms() - (uint32_t)start_time)
 
/* Function with platform-specific definition */
 
uint32_t etcpal_getms(void);
 
/* Functions with platform-neutral definitions */
 
void     etcpal_timer_start(EtcPalTimer* timer, uint32_t interval);
void     etcpal_timer_reset(EtcPalTimer* timer);
uint32_t etcpal_timer_elapsed(const EtcPalTimer* timer);
bool     etcpal_timer_is_expired(const EtcPalTimer* timer);
uint32_t etcpal_timer_remaining(const EtcPalTimer* timer);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ETCPAL_TIMER_H_ */