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 \r
  17 /*\r
  18  * Include structure:\r
  19  *\r
  20  *\r
  21  *                    Gpt.h\r
  22  *                      ^\r
  23  *                      |\r
  24  *       `---------- Gpt_xxx.c ---> Memmap.h\r
  25  *\r
  26  *\r
  27  */\r
  28 \r
  29 /** @addtogroup Gpt GPT Driver\r
  30  *  @{ */\r
  31 \r
  32 /** @file Gpt.h\r
  33  * API and type definitions for GPT Driver.\r
  34  */\r
  35 \r
  36 #ifndef GPT_H_\r
  37 #define GPT_H_\r
  38 \r
  39 #include "Std_Types.h"\r
  40 #include "Modules.h"\r
  41 \r
  42 #define GPT_VENDOR_ID             VENDOR_ID_ARCCORE\r
  43 #define GPT_MODULE_ID                    1\r
  44 \r
  45 #define GPT_SW_MAJOR_VERSION    1\r
  46 #define GPT_SW_MINOR_VERSION    0\r
  47 #define GPT_SW_PATCH_VERSION    1\r
  48 \r
  49 #define GPT_AR_MAJOR_VERSION     3\r
  50 #define GPT_AR_MINOR_VERSION     1\r
  51 #define GPT_AR_PATCH_VERSION     5\r
  52 \r
  53 /** @name Error Codes */\r
  54 //@{\r
  55 #define GPT_E_UNINIT                        0x0a\r
  56 #define GPT_E_BUSY                                                0x0b\r
  57 #define GPT_E_NOT_STARTED                                   0x0c\r
  58 #define GPT_E_ALREADY_INITIALIZED           0x0d\r
  59 #define GPT_E_PARAM_CHANNEL                 0x14\r
  60 #define GPT_E_PARAM_VALUE                                   0x15\r
  61 #define GPT_E_PARAM_MODE                                      0x1f\r
  62 #define GPT_E_PARAM_CONFIG                  0x0e // TODO: Not in spec. Find real value\r
  63 //@}\r
  64 \r
  65 /** @name Service id's */\r
  66 //@{\r
  67 #define GPT_INIT_SERVICE_ID                 0x01\r
  68 #define GPT_DEINIT_SERVICE_ID               0x02\r
  69 #define GPT_GETTIMEELAPSED_SERVICE_ID       0x03\r
  70 #define GPT_GETTIMEREMAINING_SERVICE_ID     0x04\r
  71 #define GPT_STARTTIMER_SERVICE_ID           0x05\r
  72 #define GPT_STOPTIMER_SERVICE_ID            0x06\r
  73 #define GPT_ENABLENOTIFICATION_SERVICE_ID   0x07\r
  74 #define GPT_DISABLENOTIFICATION_SERVICE_ID  0x08\r
  75 #define GPT_SETMODE_SERVIVCE_ID             0x09\r
  76 #define GPT_DISABLEWAKEUP_SERVICE_ID        0x0a\r
  77 #define GPT_ENABLEWAKEUP_SERVICE_ID         0x0b\r
  78 #define GPT_CBK_CHECKWAKEUP_SERVICE_ID      0x0c\r
  79 //@}\r
  80 \r
  81 /** Channel time value type */\r
  82 typedef uint32_t Gpt_ValueType;\r
  83 \r
  84 /** Channel behavior */\r
  85 typedef enum\r
  86 {\r
  87   GPT_MODE_ONESHOT=0,\r
  88   GPT_MODE_CONTINUOUS\r
  89 } Gpt_ChannelMode;\r
  90 \r
  91 typedef enum\r
  92 {\r
  93   GPT_MODE_NORMAL=0,\r
  94   GPT_MODE_SLEEP\r
  95 } Gpt_ModeType;\r
  96 \r
  97 /** Channel id type */\r
  98 typedef uint8_t Gpt_ChannelType;\r
  99 \r
 100 /* Needs Gpt_ConfigType */\r
 101 #include "Gpt_Cfg.h"            /* @req 4.0.3/GPT259 */\r
 102 \r
 103 /* The config needs EcuM_WakeupSourceType from EcuM */\r
 104 \r
 105 #if (GPT_VERSION_INFO_API == STD_ON)\r
 106 #define Gpt_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,GPT)\r
 107 #endif\r
 108 \r
 109 void Gpt_Init( const Gpt_ConfigType * );\r
 110 \r
 111 #if GPT_DEINIT_API == STD_ON\r
 112 void Gpt_DeInit( void );\r
 113 #endif\r
 114 \r
 115 #if ( GPT_TIME_ELAPSED_API == STD_ON )\r
 116 Gpt_ValueType Gpt_GetTimeElapsed(Gpt_ChannelType channel);\r
 117 #endif\r
 118 \r
 119 #if ( GPT_TIME_REMAINING_API == STD_ON )\r
 120 Gpt_ValueType Gpt_GetTimeRemaining( Gpt_ChannelType channel );\r
 121 #endif\r
 122 \r
 123 void Gpt_StartTimer(Gpt_ChannelType channel, Gpt_ValueType value);\r
 124 \r
 125 void Gpt_StopTimer(Gpt_ChannelType channel);\r
 126 \r
 127 #if ( GPT_ENABLE_DISABLE_NOTIFICATION_API == STD_ON )\r
 128 void Gpt_EnableNotification( Gpt_ChannelType channel);\r
 129 \r
 130 void Gpt_DisableNotification( Gpt_ChannelType channel);\r
 131 #endif\r
 132 \r
 133 #if ( GPT_WAKEUP_FUNCTIONALITY_API == STD_ON )\r
 134 void Gpt_SetMode( Gpt_ModeType mode );\r
 135 \r
 136 void Gpt_DisableWakeup( Gpt_ChannelType channel );\r
 137 \r
 138 void Gpt_EnableWakeup( Gpt_ChannelType channel );\r
 139 \r
 140 void Gpt_Cbk_CheckWakeup( EcuM_WakeupSourceType wakeupSource );\r
 141 #endif\r
 142 \r
 143 /** GPT292 */\r
 144 extern void Gpt_Notification_0( void );\r
 145 extern void Gpt_Notification_1( void );\r
 146 extern void Gpt_Notification_2( void );\r
 147 extern void Gpt_Notification_3( void );\r
 148 \r
 149 #endif /*GPT_H_*/\r
 150 /** @} */\r