]> rtime.felk.cvut.cz Git - arc.git/blob - include/Gpt.h
ab33f8674b418f9254bd472519ab8d27a711a02c
[arc.git] / include / Gpt.h
1 /* -------------------------------- Arctic Core ------------------------------\r
2  * Arctic Core - the open source AUTOSAR platform http://arccore.com\r
3  *\r
4  * Copyright (C) 2009  ArcCore AB <contact@arccore.com>\r
5  *\r
6  * This source code is free software; you can redistribute it and/or modify it\r
7  * under the terms of the GNU General Public License version 2 as published by the\r
8  * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.\r
9  *\r
10  * This program is distributed in the hope that it will be useful, but\r
11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License\r
13  * for more details.\r
14  * -------------------------------- Arctic Core ------------------------------*/\r
15 \r
16 /** @addtogroup Gpt GPT Driver\r
17  *  @{ */\r
18 \r
19 /** @file Gpt.h\r
20  * API and type definitions for GPT Driver.\r
21  */\r
22 \r
23 #ifndef GPT_H_\r
24 #define GPT_H_\r
25 \r
26 #include "Std_Types.h"\r
27 \r
28 /* "forward" declare types due to circular dependency chain */\r
29 /** Channel id type */\r
30 typedef uint8_t Gpt_ChannelType;\r
31 \r
32 #include "EcuM.h"\r
33 \r
34 /** @name Error Codes */\r
35 //@{\r
36 #define GPT_E_UNINIT                        0x0a\r
37 #define GPT_E_BUSY                                                0x0b\r
38 #define GPT_E_NOT_STARTED                                   0x0c\r
39 #define GPT_E_ALREADY_INITIALIZED           0x0d\r
40 #define GPT_E_PARAM_CHANNEL                 0x14\r
41 #define GPT_E_PARAM_VALUE                                   0x15\r
42 #define GPT_E_PARAM_MODE                                      0x1f\r
43 #define GPT_E_PARAM_CONFIG                  0x0e // TODO: Not in spec. Find real value\r
44 //@}\r
45 \r
46 /** @name Service id's */\r
47 //@{\r
48 #define GPT_INIT_SERVICE_ID                 0x01\r
49 #define GPT_DEINIT_SERVICE_ID               0x02\r
50 #define GPT_GETTIMEELAPSED_SERVICE_ID       0x03\r
51 #define GPT_GETTIMEREMAINING_SERVICE_ID     0x04\r
52 #define GPT_STARTTIMER_SERVICE_ID           0x05\r
53 #define GPT_STOPTIMER_SERVICE_ID            0x06\r
54 #define GPT_ENABLENOTIFICATION_SERVICE_ID   0x07\r
55 #define GPT_DISABLENOTIFICATION_SERVICE_ID  0x08\r
56 #define GPT_SETMODE_SERVIVCE_ID             0x09\r
57 #define GPT_DISABLEWAKEUP_SERVICE_ID        0x0a\r
58 #define GPT_ENABLEWAKEUP_SERVICE_ID         0x0b\r
59 #define GPT_CBK_CHECKWAKEUP_SERVICE_ID      0x0c\r
60 //@}\r
61 \r
62 /** Channel time value type */\r
63 typedef uint32_t Gpt_ValueType;\r
64 \r
65 /** Channel behavior */\r
66 typedef enum\r
67 {\r
68   GPT_MODE_ONESHOT=0,\r
69   GPT_MODE_CONTINUOUS\r
70 } Gpt_ChannelMode;\r
71 \r
72 typedef enum\r
73 {\r
74   GPT_MODE_NORMAL=0,\r
75   GPT_MODE_SLEEP\r
76 } Gpt_ModeType;\r
77 \r
78 \r
79 #define GPT_VENDOR_ID             1\r
80 #define GPT_MODULE_ID                    1\r
81 \r
82 #define GPT_SW_MAJOR_VERSION    1\r
83 #define GPT_SW_MINOR_VERSION    0\r
84 #define GPT_SW_PATCH_VERSION    1\r
85 \r
86 #define GPT_AR_MAJOR_VERSION     2\r
87 #define GPT_AR_MINOR_VERSION     2\r
88 #define GPT_AR_PATCH_VERSION     1\r
89 \r
90 #include "Gpt_Cfg.h"\r
91 \r
92 #if (GPT_VERSION_INFO_API == STD_ON)\r
93 #define Gpt_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,GPT)\r
94 #endif\r
95 \r
96 void Gpt_Init( const Gpt_ConfigType * );\r
97 \r
98 #if GPT_DEINIT_API == STD_ON\r
99 void Gpt_DeInit( void );\r
100 #endif\r
101 \r
102 #if ( GPT_TIME_ELAPSED_API == STD_ON )\r
103 Gpt_ValueType Gpt_GetTimeElapsed(Gpt_ChannelType channel);\r
104 #endif\r
105 \r
106 #if ( GPT_TIME_REMAINING_API == STD_ON )\r
107 Gpt_ValueType Gpt_GetTimeRemaining( Gpt_ChannelType channel );\r
108 #endif\r
109 \r
110 void Gpt_StartTimer(Gpt_ChannelType channel, Gpt_ValueType value);\r
111 \r
112 void Gpt_StopTimer(Gpt_ChannelType channel);\r
113 \r
114 #if ( GPT_ENABLE_DISABLE_NOTIFICATION_API == STD_ON )\r
115 void Gpt_EnableNotification( Gpt_ChannelType channel);\r
116 \r
117 void Gpt_DisableNotification( Gpt_ChannelType channel);\r
118 #endif\r
119 \r
120 #if ( GPT_WAKEUP_FUNCTIONALITY_API == STD_ON )\r
121 void Gpt_SetMode( Gpt_ModeType mode );\r
122 \r
123 void Gpt_DisableWakeup( Gpt_ChannelType channel );\r
124 \r
125 void Gpt_EnableWakeup( Gpt_ChannelType channel );\r
126 \r
127 void Gpt_Cbk_CheckWakeup( EcuM_WakeupSourceType wakeupSource );\r
128 #endif\r
129 \r
130 /** GPT292 */\r
131 extern void Gpt_Notification_0( void );\r
132 extern void Gpt_Notification_1( void );\r
133 extern void Gpt_Notification_2( void );\r
134 extern void Gpt_Notification_3( void );\r
135 \r
136 #endif /*GPT_H_*/\r
137 /** @} */\r