/** mbed Microcontroller Library ****************************************************************************** * @file timer_api.h * @author * @version V1.0.0 * @brief This file provides following mbed I2C API ****************************************************************************** * @attention * * Copyright (c) 2006-2013 ARM Limited * * 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. ****************************************************************************** */ #ifndef MBED_EXT_TIMER_API_EXT_H #define MBED_EXT_TIMER_API_EXT_H #include "device.h" #ifdef __cplusplus extern "C" { #endif /** @addtogroup timer TIMER * @ingroup hal * @brief timer functions * @{ */ ///@name Ameba Common ///@{ typedef struct gtimer_s gtimer_t; typedef void (*gtimer_irq_handler)(uint32_t id); /** * @brief Initializes the timer, including clock/function/timer registers. * @param obj: gtimer object defined in application software. * @param tid: the timer struct ID defined in gtimer structure. * @retval none */ void gtimer_init (gtimer_t *obj, uint32_t tid); /** * @brief Deinitializes the timer, including clock/function/timer registers. * @param obj: gtimer object defined in application software. * @retval none */ void gtimer_deinit (gtimer_t *obj); /** * @brief Read current timer tick in Gtimer clock(0~32768). * @param obj: gtimer object defined in application software. * @retval 32 bit tick time */ uint32_t gtimer_read_tick (gtimer_t *obj); /** * @brief Read current timer tick in microsecond. * @param obj: gtimer object defined in application software. * @retval 64 bit tick time */ uint64_t gtimer_read_us (gtimer_t *obj); /** * @brief Reload timer * @param obj: gtimer object defined in application software. * @param duration_us: the time in microsecond of gtimer to reload. * @retval none */ void gtimer_reload (gtimer_t *obj, uint32_t duration_us); /** * @brief Start the timer * @param obj: gtimer object defined in application software. * @retval none */ void gtimer_start (gtimer_t *obj); /** * @brief Set up a shout timer, including clock/function/timer registers. * @param obj: gtimer object defined in application software. * @param duration_us: the period in microsecond of gtimer. * @param handler: The Pointer to the function that program runs into when timer is up. * @param hid: the timer struct ID defined in gtimer structure. * @retval none */ void gtimer_start_one_shout (gtimer_t *obj, uint32_t duration_us, void* handler, uint32_t hid); /** * @brief Set up a periodic timer, including clock/function/timer registers. * @param obj: gtimer object defined in application software. * @param duration_us: the period in microsecond of gtimer. * @param handler: The Pointer to function that program runs into when timer is up. * @param hid: the timer struct ID defined in gtimer structure. * @retval none */ void gtimer_start_periodical (gtimer_t *obj, uint32_t duration_us, void* handler, uint32_t hid); /** * @brief Stop the timer, including clock/function/timer registers. * @param obj: gtimer object defined in application software. * @retval none */ void gtimer_stop (gtimer_t *obj); #if defined(CONFIG_PLATFORM_8195A) && (CONFIG_PLATFORM_8195A == 1) ///@name Ameba Only ///@{ enum { TIMER0 = 2, TIMER1 = 3, TIMER2 = 4, TIMER3 = 5, TIMER4 = 0, GTIMER_MAX = 5 }; ///@} #endif //CONFIG_PLATFORM_8195A #if (defined(CONFIG_PLATFORM_8711B) && (CONFIG_PLATFORM_8711B == 1)) || (defined(CONFIG_PLATFORM_8721D) && (CONFIG_PLATFORM_8721D == 1)) ///@name AmebaZ and AmebaD Only ///@{ enum { TIMER0 = 0, /*!< GTimer 0, 32k timer, share with us_tick(wait_ms()) functions. This timer is reserved and users are not recommended to use it */ TIMER1 = 1, /*!< GTimer 1, 32k timer, share with APP_TIM_ID */ TIMER2 = 2, /*!< GTimer 2, 32k timer, users can use it */ TIMER3 = 3, /*!< GTimer 3, 32k timer, users can use it */ GTIMER_MAX = 4 }; ///@} #endif //CONFIG_PLATFORM_8711B || CONFIG_PLATFORM_8721D #if (defined(CONFIG_PLATFORM_8195BHP) && (CONFIG_PLATFORM_8195BHP == 1)) || (defined(CONFIG_PLATFORM_8195BLP) && (CONFIG_PLATFORM_8195BLP == 1)) \ || (defined(CONFIG_PLATFORM_8710C) && (CONFIG_PLATFORM_8710C == 1)) ///@name AmebaPro and AmebaZ2 Only ///@{ #if defined (CONFIG_PLATFORM_8195BLP) || defined (CONFIG_PLATFORM_8710C) enum { TIMER0 = 1, TIMER1 = 2, TIMER2 = 3, TIMER3 = 4, TIMER4 = 5, TIMER5 = 6, TIMER6 = 7, GTIMER_MAX = 7 }; #elif defined (CONFIG_PLATFORM_8195BHP) #if defined (CONFIG_BUILD_NONSECURE) enum { TIMER0 = 9, TIMER1 = 10, TIMER2 = 11, TIMER3 = 12, TIMER4 = 13, TIMER5 = 14, TIMER6 = 15, GTIMER_MAX = 15 }; #elif defined (CONFIG_BUILD_SECURE) enum { TIMER0 = 1, TIMER1 = 2, TIMER2 = 3, TIMER3 = 4, TIMER4 = 5, TIMER5 = 6, TIMER6 = 7, GTIMER_MAX = 7 }; #else enum { TIMER0 = 1, TIMER1 = 2, TIMER2 = 3, TIMER3 = 4, TIMER4 = 5, TIMER5 = 6, TIMER6 = 7, TIMER7 = 8, TIMER8 = 9, TIMER9 = 10, TIMER10 = 11, TIMER11 = 12, TIMER12 = 13, TIMER13 = 14, TIMER14 = 15, GTIMER_MAX = 15 }; #endif #endif // define the G-Timer Alarm ID, a G-Timer has 4 alarm typedef enum { TIMER_ALARM0 = GTimerMatchEvent0, TIMER_ALARM1 = GTimerMatchEvent1, TIMER_ALARM2 = GTimerMatchEvent2, TIMER_ALARM3 = GTimerMatchEvent3, TIMER_ALARM_NUM = 4 } alarmid_t; void gtimer_enable_alarm (gtimer_t *obj, alarmid_t almid, uint32_t time_us, void *handler, uint32_t hid); void gtimer_disable_alarm (gtimer_t *obj, alarmid_t almid); ///@} #endif // end of "#if defined(CONFIG_PLATFORM_8195BHP) || defined(CONFIG_PLATFORM_8195BLP) || defined(CONFIG_PLATFORM_8710C)" #ifdef __cplusplus } #endif #endif/* MBED_TIMER_API_H */