| 1 | /*
|
|---|
| 2 | * kern/rt_timer.h - real-time timer interface
|
|---|
| 3 | *
|
|---|
| 4 | * Copyright (c) 2008,2009,2010,2011,2012 Ghassan Almaless
|
|---|
| 5 | * Copyright (c) 2011,2012 UPMC Sorbonne Universites
|
|---|
| 6 | *
|
|---|
| 7 | * This file is part of ALMOS-kernel.
|
|---|
| 8 | *
|
|---|
| 9 | * ALMOS-kernel is free software; you can redistribute it and/or modify it
|
|---|
| 10 | * under the terms of the GNU General Public License as published by
|
|---|
| 11 | * the Free Software Foundation; version 2.0 of the License.
|
|---|
| 12 | *
|
|---|
| 13 | * ALMOS-kernel is distributed in the hope that it will be useful, but
|
|---|
| 14 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 16 | * General Public License for more details.
|
|---|
| 17 | *
|
|---|
| 18 | * You should have received a copy of the GNU General Public License
|
|---|
| 19 | * along with ALMOS-kernel; if not, write to the Free Software Foundation,
|
|---|
| 20 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|---|
| 21 | */
|
|---|
| 22 |
|
|---|
| 23 | #ifndef _RT_TIMER_H_
|
|---|
| 24 | #define _RT_TIMER_H_
|
|---|
| 25 |
|
|---|
| 26 | #include <types.h>
|
|---|
| 27 |
|
|---|
| 28 | /** Real-Time timer commands */
|
|---|
| 29 | #define RT_TIMER_STOP 0x00
|
|---|
| 30 | #define RT_TIMER_RUN 0x01
|
|---|
| 31 | #define RT_TIMER_ADJUST 0x02
|
|---|
| 32 |
|
|---|
| 33 | /** Real-Time timer parameters */
|
|---|
| 34 | struct rt_params_s
|
|---|
| 35 | {
|
|---|
| 36 | uint_t rt_cmd;
|
|---|
| 37 | sint_t rt_value;
|
|---|
| 38 | void *pv_data;
|
|---|
| 39 | };
|
|---|
| 40 |
|
|---|
| 41 | /** Initialize Real-Time timer source */
|
|---|
| 42 | error_t rt_timer_init(uint_t period, uint_t withIrq);
|
|---|
| 43 |
|
|---|
| 44 | /** Read Real-Time timer current value */
|
|---|
| 45 | error_t rt_timer_read(uint_t *time);
|
|---|
| 46 |
|
|---|
| 47 | /** Set Real-Time timer's current value */
|
|---|
| 48 | error_t rt_timer_set(uint_t time);
|
|---|
| 49 |
|
|---|
| 50 | /** Set Real-Time timer's period */
|
|---|
| 51 | error_t rt_timer_setperiod(uint_t period);
|
|---|
| 52 |
|
|---|
| 53 | /** Send commands to Real-Time timer device */
|
|---|
| 54 | error_t rt_timer_ctrl(struct rt_params_s *param);
|
|---|
| 55 |
|
|---|
| 56 | #endif /* _RT_TIMER_H_ */
|
|---|
