fnet_timer.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community
*
***************************************************************************
*
*  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.
*
***************************************************************************
*
*  FNET Timer API.
*
***************************************************************************/

#ifndef _FNET_TIMER_H

#define _FNET_TIMER_H

/**************************************************************************/ 
#define FNET_TIMER_PERIOD_MS        (10U) /* It may be 1-100ms */

/**************************************************************************/ 
#define FNET_TIMER_MS_IN_SEC        (1000U)

/**************************************************************************/ 
#define FNET_TIMER_MS_IN_MIN        (FNET_TIMER_MS_IN_SEC*60U)

/**************************************************************************/ 
#define FNET_TIMER_MS_IN_HOUR       (FNET_TIMER_MS_IN_MIN*60U)

#if defined(__cplusplus)
extern "C" {
#endif

/**************************************************************************/ 
typedef fnet_uint32_t fnet_time_t;

/***************************************************************************/ 
fnet_time_t fnet_timer_get_ms( void );

/***************************************************************************/ 
void fnet_timer_delay( fnet_time_t delay_ms );

/***************************************************************************/ 
void fnet_timer_poll(void);

#if FNET_CFG_TIME || defined(__DOXYGEN__)
#include <time.h>

#define fnet_time   time  /* Compliance with <time.h> */

/***************************************************************************/ 
void fnet_time_set(time_t sec);

/***************************************************************************/ 
time_t fnet_time(time_t *sec);

#endif /* FNET_CFG_TIME */

#if !FNET_CFG_TIMER_ALT  /* Use bare-metal timer */

#ifndef  FNET_HW_TIMER_INIT
#define FNET_HW_TIMER_INIT    fnet_cpu_timer_init
#endif
#ifndef  FNET_HW_TIMER_RELEASE
#define FNET_HW_TIMER_RELEASE fnet_cpu_timer_release
#endif

#endif /* !FNET_CFG_TIMER_ALT */

#if defined(__cplusplus)
}
#endif

#endif /* _FNET_TIMER_H */