FreeCalypso > hg > freecalypso-citrine

comparison bsp/rtc/rtc_i.h @ 0:75a11d740a02

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial import of gsm-fw from freecalypso-sw rev 1033:5ab737ac3ad7
author Mychaela Falconia <falcon@freecalypso.org>
date Thu, 09 Jun 2016 00:02:41 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:75a11d740a02
1 /******************************************************************************/
2 /* */
3 /* File Name: rtc_i.h */
4 /* */
5 /* Purpose: This file contains the structures, constants and prototypes */
6 /* dedicated to RTC. */
7 /* */
8 /* Note: None. */
9 /* */
10 /* Revision History: */
11 /* 03/20/01 Laurent Sollier Create. */
12 /* */
13 /* (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved */
14 /* */
15 /******************************************************************************/
16
17 #ifndef _RTC_I_H_
18 #define _RTC_I_H_
19
20 #include "../../riviera/rvm/rvm_gen.h"
21 #include "../../riviera/rvf/rvf_api.h"
22
23 /******************************************************************************/
24 /* */
25 /* Define a structure used to store all the informations related to RTC's task*/
26 /* & MBs identifiers. */
27 /* */
28 /******************************************************************************/
29
30 typedef struct
31 {
32 T_RVF_MB_ID prim_id;
33 T_RVF_ADDR_ID addr_id;
34 void* msg_alarm_event;
35 } T_RTC_ENV_CTRL_BLK;
36
37 /*******************************************************************************
38 *
39 * RTC_Initialize
40 *
41 * Purpose : Initializes the RTC driver.
42 *
43 * Arguments: In : none
44 * Out: none
45 *
46 * Returns: RVF_OK if initialisation is ok
47 * RVF_INTERNAL_ERROR else
48 *
49 ******************************************************************************/
50
51 T_RVF_RET RTC_Initialize(void);
52
53
54 /*******************************************************************************
55 *
56 * RTC_ProcessAlarmEvent
57 *
58 * Purpose : Call MMI when SW RTC module receive alarm event
59 *
60 * Arguments: In : none
61 * Out: none
62 *
63 * Returns: none
64 *
65 *
66 ******************************************************************************/
67
68 void RTC_ProcessAlarmEvent(void);
69
70 /*******************************************************************************
71 *
72 * RTC_ItTimerHandle
73 *
74 * Purpose : Compute an average value for compensation register
75 *
76 * Arguments: In : none
77 * Out: none
78 *
79 * Returns: none
80 *
81 *
82 ******************************************************************************/
83
84 void RTC_ItTimerHandle(void);
85
86
87 /*******************************************************************************
88 *
89 * RTC_ItAlarmHandle
90 *
91 * Purpose : Activate HISR which will send a message in the RTC mailbox to
92 * inform that time alarm is reached
93 *
94 * Arguments: In : none
95 * Out: none
96 *
97 * Returns: none
98 *
99 *
100 ******************************************************************************/
101
102 void RTC_ItAlarmHandle(void);
103
104
105 /*******************************************************************************
106 *
107 * RTC_GaugingHandler
108 *
109 * Purpose : This function is called when a gauging is finished (started by
110 * layer1). It save clock counter for average value computation
111 * ( done by RTC_ItTimerHandle)
112 *
113 * Arguments: In : none
114 * Out: none
115 *
116 * Returns: none
117 *
118 *
119 ******************************************************************************/
120
121 void RTC_GaugingHandler(void);
122
123
124 #endif /* #ifndef _RTC_I_H_ */