-/* -------------------------------- Arctic Core ------------------------------
- * Arctic Core - the open source AUTOSAR platform http://arccore.com
- *
- * Copyright (C) 2009 ArcCore AB <contact@arccore.com>
- *
- * This source code is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License version 2 as published by the
- * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
- * for more details.
- * -------------------------------- Arctic Core ------------------------------*/
-
-
-
-
-
-
-
-
-#ifndef GPT_H_
-#define GPT_H_
-
-#include "Std_Types.h"
-//#include "EcuM.h" mahi: What for ???
-
-/* ERROR CODES */
-#define GPT_E_UNINIT 0x0a
-#define GPT_E_BUSY 0x0b
-#define GPT_E_NOT_STARTED 0x0c
-#define GPT_E_ALREADY_INITIALIZED 0x0d
-#define GPT_E_PARAM_CHANNEL 0x14
-#define GPT_E_PARAM_VALUE 0x15
-#define GPT_E_PARAM_MODE 0x1f
-#define GPT_E_PARAM_CONFIG 0x0e // TODO: Not in spec. Find real value
-
-/* SERVICE_ID's */
-#define GPT_INIT_SERVICE_ID 0x01
-#define GPT_DEINIT_SERVICE_ID 0x02
-#define GPT_GETTIMEELAPSED_SERVICE_ID 0x03
-#define GPT_GETTIMEREMAINING_SERVICE_ID 0x04
-#define GPT_STARTTIMER_SERVICE_ID 0x05
-#define GPT_STOPTIMER_SERVICE_ID 0x06
-#define GPT_ENABLENOTIFICATION_SERVICE_ID 0x07
-#define GPT_DISABLENOTIFICATION_SERVICE_ID 0x08
-#define GPT_SETMODE_SERVIVCE_ID 0x09
-#define GPT_DISABLEWAKEUP_SERVICE_ID 0x0a
-#define GPT_ENABLEWAKEUP_SERVICE_ID 0x0b
-#define GPT_CBK_CHECKWAKEUP_SERVICE_ID 0x0c
-
-typedef uint8_t Gpt_ChannelType;
-
-typedef uint32_t Gpt_ValueType;
-
-typedef enum
-{
- GPT_MODE_ONESHOT=0,
- GPT_MODE_CONTINUOUS
-} Gpt_ChannelMode;
-
-typedef enum
-{
- GPT_MODE_NORMAL=0,
- GPT_MODE_SLEEP
-} Gpt_ModeType;
-
-#include "Gpt_Cfg.h"
-
-#if (GPT_VERSION_INFO_API == STD_ON)
-
-#define GPT_VENDOR_ID 1
-#define GPT_MODULE_ID 1
-#define GPT_SW_MAJOR_VERSION 1
-#define GPT_SW_MINOR_VERSION 0
-#define GPT_SW_PATCH_VERSION 0
-#define GPT_AR_MAJOR_VERSION 2
-#define GPT_AR_MINOR_VERSION 2
-#define GPT_AR_PATCH_VERSION 1
-
-#define Gpt_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,GPT)
-#endif
-
-void Gpt_Init( const Gpt_ConfigType * );
-
-#if GPT_DEINIT_API == STD_ON
-void Gpt_DeInit( void );
-#endif
-
-#if ( GPT_TIME_ELAPSED_API == STD_ON )
-Gpt_ValueType Gpt_GetTimeElapsed(Gpt_ChannelType channel);
-#endif
-
-#if ( GPT_TIME_REMAINING_API == STD_ON )
-Gpt_ValueType Gpt_GetTimeRemaining( Gpt_ChannelType channel );
-#endif
-
-void Gpt_StartTimer(Gpt_ChannelType channel, Gpt_ValueType value);
-
-void Gpt_StopTimer(Gpt_ChannelType channel);
-
-#if ( GPT_ENABLE_DISABLE_NOTIFICATION_API == STD_ON )
-void Gpt_EnableNotification( Gpt_ChannelType channel);
-
-void Gpt_DisableNotification( Gpt_ChannelType channel);
-#endif
-
-#if ( GPT_WAKEUP_FUNCTIONALITY_API == STD_ON )
-void Gpt_SetMode( Gpt_ModeType mode );
-
-void Gpt_DisableWakeup( Gpt_ChannelType channel );
-
-void Gpt_EnableWakeup( Gpt_ChannelType channel );
-
-void Gpt_Cbk_CheckWakeup( EcuM_WakeupSourceType wakeupSource );
-#endif
-
-#endif /*GPT_H_*/
+/* -------------------------------- Arctic Core ------------------------------\r
+ * Arctic Core - the open source AUTOSAR platform http://arccore.com\r
+ *\r
+ * Copyright (C) 2009 ArcCore AB <contact@arccore.com>\r
+ *\r
+ * This source code is free software; you can redistribute it and/or modify it\r
+ * under the terms of the GNU General Public License version 2 as published by the\r
+ * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.\r
+ *\r
+ * This program is distributed in the hope that it will be useful, but\r
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License\r
+ * for more details.\r
+ * -------------------------------- Arctic Core ------------------------------*/\r
+\r
+\r
+/*\r
+ * Include structure:\r
+ *\r
+ *\r
+ * Gpt.h\r
+ * ^\r
+ * |\r
+ * `---------- Gpt_xxx.c ---> Memmap.h\r
+ *\r
+ *\r
+ */\r
+\r
+/** @addtogroup Gpt GPT Driver\r
+ * @{ */\r
+\r
+/** @file Gpt.h\r
+ * API and type definitions for GPT Driver.\r
+ */\r
+\r
+#ifndef GPT_H_\r
+#define GPT_H_\r
+\r
+#include "Std_Types.h"\r
+\r
+\r
+/** @name Error Codes */\r
+//@{\r
+#define GPT_E_UNINIT 0x0a\r
+#define GPT_E_BUSY 0x0b\r
+#define GPT_E_NOT_STARTED 0x0c\r
+#define GPT_E_ALREADY_INITIALIZED 0x0d\r
+#define GPT_E_PARAM_CHANNEL 0x14\r
+#define GPT_E_PARAM_VALUE 0x15\r
+#define GPT_E_PARAM_MODE 0x1f\r
+#define GPT_E_PARAM_CONFIG 0x0e // TODO: Not in spec. Find real value\r
+//@}\r
+\r
+/** @name Service id's */\r
+//@{\r
+#define GPT_INIT_SERVICE_ID 0x01\r
+#define GPT_DEINIT_SERVICE_ID 0x02\r
+#define GPT_GETTIMEELAPSED_SERVICE_ID 0x03\r
+#define GPT_GETTIMEREMAINING_SERVICE_ID 0x04\r
+#define GPT_STARTTIMER_SERVICE_ID 0x05\r
+#define GPT_STOPTIMER_SERVICE_ID 0x06\r
+#define GPT_ENABLENOTIFICATION_SERVICE_ID 0x07\r
+#define GPT_DISABLENOTIFICATION_SERVICE_ID 0x08\r
+#define GPT_SETMODE_SERVIVCE_ID 0x09\r
+#define GPT_DISABLEWAKEUP_SERVICE_ID 0x0a\r
+#define GPT_ENABLEWAKEUP_SERVICE_ID 0x0b\r
+#define GPT_CBK_CHECKWAKEUP_SERVICE_ID 0x0c\r
+//@}\r
+\r
+/** Channel time value type */\r
+typedef uint32_t Gpt_ValueType;\r
+\r
+/** Channel behavior */\r
+typedef enum\r
+{\r
+ GPT_MODE_ONESHOT=0,\r
+ GPT_MODE_CONTINUOUS\r
+} Gpt_ChannelMode;\r
+\r
+typedef enum\r
+{\r
+ GPT_MODE_NORMAL=0,\r
+ GPT_MODE_SLEEP\r
+} Gpt_ModeType;\r
+\r
+/** Channel id type */\r
+typedef uint8_t Gpt_ChannelType;\r
+\r
+#define GPT_VENDOR_ID 1\r
+#define GPT_MODULE_ID 1\r
+\r
+#define GPT_SW_MAJOR_VERSION 1\r
+#define GPT_SW_MINOR_VERSION 0\r
+#define GPT_SW_PATCH_VERSION 1\r
+\r
+#define GPT_AR_MAJOR_VERSION 2\r
+#define GPT_AR_MINOR_VERSION 2\r
+#define GPT_AR_PATCH_VERSION 1\r
+\r
+/* Needs Gpt_ConfigType */\r
+#include "Gpt_Cfg.h" /* @req 4.0.3/GPT259 */\r
+\r
+/* The config needs EcuM_WakeupSourceType from EcuM */\r
+\r
+#if (GPT_VERSION_INFO_API == STD_ON)\r
+#define Gpt_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,GPT)\r
+#endif\r
+\r
+void Gpt_Init( const Gpt_ConfigType * );\r
+\r
+#if GPT_DEINIT_API == STD_ON\r
+void Gpt_DeInit( void );\r
+#endif\r
+\r
+#if ( GPT_TIME_ELAPSED_API == STD_ON )\r
+Gpt_ValueType Gpt_GetTimeElapsed(Gpt_ChannelType channel);\r
+#endif\r
+\r
+#if ( GPT_TIME_REMAINING_API == STD_ON )\r
+Gpt_ValueType Gpt_GetTimeRemaining( Gpt_ChannelType channel );\r
+#endif\r
+\r
+void Gpt_StartTimer(Gpt_ChannelType channel, Gpt_ValueType value);\r
+\r
+void Gpt_StopTimer(Gpt_ChannelType channel);\r
+\r
+#if ( GPT_ENABLE_DISABLE_NOTIFICATION_API == STD_ON )\r
+void Gpt_EnableNotification( Gpt_ChannelType channel);\r
+\r
+void Gpt_DisableNotification( Gpt_ChannelType channel);\r
+#endif\r
+\r
+#if ( GPT_WAKEUP_FUNCTIONALITY_API == STD_ON )\r
+void Gpt_SetMode( Gpt_ModeType mode );\r
+\r
+void Gpt_DisableWakeup( Gpt_ChannelType channel );\r
+\r
+void Gpt_EnableWakeup( Gpt_ChannelType channel );\r
+\r
+void Gpt_Cbk_CheckWakeup( EcuM_WakeupSourceType wakeupSource );\r
+#endif\r
+\r
+/** GPT292 */\r
+extern void Gpt_Notification_0( void );\r
+extern void Gpt_Notification_1( void );\r
+extern void Gpt_Notification_2( void );\r
+extern void Gpt_Notification_3( void );\r
+\r
+#endif /*GPT_H_*/\r
+/** @} */\r
projects / arc.git / blobdiff