1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*
* Copyright (c) 2015-2016, ARM Limited and Contributors. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* Neither the name of ARM nor the names of its contributors may be used
* to endorse or promote products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __TIMER_H__
#define __TIMER_H__
#include <irq.h>
typedef struct plat_timer {
int (*program)(unsigned long time_out_ms);
int (*cancel)(void);
int (*handler)(void);
/*
* Duration of the atomic time slice in milliseconds. All timer
* requests within the same time slice are merged into one. This value
* should be chosen such that it is greater than the time required to
* program the timer.
*/
unsigned int timer_step_value;
unsigned int timer_irq;
} plat_timer_t;
/*
* Gets the platform specific timer implementation information and initialises
* the timer framework and peripheral.
* Returns 0 on success or return value of timer peripheral intialisation
* function.
*/
int tftf_initialise_timer(void);
/*
* Requests the timer framework to send an interrupt after milli_secs.
* The interrupt is sent to the calling core of this api. The actual
* time the interrupt is received by the core can be greater than
* the requested time.
* Returns 0 on success and -1 on failure.
*/
int tftf_program_timer(unsigned long milli_secs);
/*
* Requests the timer framework to send an interrupt after milli_secs and to
* suspend the CPU to the desired power state. The interrupt is sent to the
* calling core of this api. The actual time the interrupt is received by the
* core can be greater than the requested time.
* Returns 0 on success and -1 on failure.
*/
int tftf_program_timer_and_suspend(unsigned long milli_secs,
unsigned int pwr_state);
/*
* Suspends the calling CPU for specified milliseconds.
*
* Returns 0 on success, and -1 otherwise.
*/
int tftf_timer_sleep(unsigned long milli_secs);
/*
* Common handler for servicing all the timer interrupts. It in turn calls the
* peripheral specific handler. It also sends WAKE_SGI to all the cores which
* requested an interrupt within a time frame of timer_step_value.
* Also, if there are pending interrupt requests, reprograms the timer
* accordingly to fire an interrupt at the right time.
*
* Returns 0 on success.
*/
int tftf_timer_framework_handler(void *data);
/*
* Cancels the previously programmed value by the called core.
* This api should be used only for cancelling the self interrupt request
* by a core.
* Returns 0 on success, negative value otherwise.
*/
int tftf_cancel_timer(void);
/*
* It is used to register a handler which needs to be called when a timer
* interrupt is fired.
* Returns 0 on success, negative value otherwise.
*/
int tftf_timer_register_handler(irq_handler_t irq_handler);
/*
* It is used to unregister a previously registered handler.
* Returns 0 on success, negative value otherwise.
*/
int tftf_timer_unregister_handler(void);
/*
* Return the IRQ Number of the registered timer interrupt
*/
unsigned int tftf_get_timer_irq(void);
/*
* Returns the timer step value in a platform and is used by test cases.
*/
unsigned int tftf_get_timer_step_value(void);
/*
* Restore the GIC state after wake-up from system suspend
*/
void tftf_timer_gic_state_restore(void);
#endif /* __TIMER_H__ */
|
