include/Ea.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 #ifndef EA_H_\r
  18 #define EA_H_\r
  19 \r
  20 #define EA_MODULE_ID                    MODULE_ID_EA\r
  21 #define EA_VENDOR_ID                    1\r
  22 \r
  23 #define EA_SW_MAJOR_VERSION     1\r
  24 #define EA_SW_MINOR_VERSION     0\r
  25 #define EA_SW_PATCH_VERSION     0\r
  26 #define EA_AR_MAJOR_VERSION     4   // Implemented after the 4.0.2 specification due to the poor quality of 3.1 specification\r
  27 #define EA_AR_MINOR_VERSION     0\r
  28 #define EA_AR_PATCH_VERSION     2\r
  29 \r
  30 #include "Eep.h"\r
  31 #include "Ea_Cfg.h"\r
  32 \r
  33 /*\r
  34  *  API parameter checking\r
  35  */\r
  36 /** @req EA139 */\r
  37 #define EA_E_NOT_INITIALIZED            0x01\r
  38 /** @req EA140 */\r
  39 #define EA_E_INVALID_BLOCK_NO           0x02\r
  40 \r
  41 /*\r
  42  * EA Module Service ID Macro Collection\r
  43 */\r
  44 typedef enum {\r
  45          EA_INIT_ID = 0x00,\r
  46          EA_SETMODE_ID,\r
  47          EA_READ_ID,\r
  48          EA_WRITE_ID,\r
  49          EA_CANCEL_ID,\r
  50          EA_GETSTATUS_ID,\r
  51          EA_GETJOBRESULT_ID,\r
  52          EA_INVALIDATEBLOCK_ID,\r
  53          EA_GETVERSIONINFO_ID,\r
  54          EA_ERASEIMMEDIATEBLOCK_ID,\r
  55          EA_MAIN_ID = 0x12\r
  56 } Ea_APIServiceIDType;\r
  57 \r
  58 /*@req <EA061> */\r
  59 /*@req <EA062> */\r
  60 /*@req <EA082> */\r
  61 #if ( EA_VERSION_INFO_API == STD_ON )\r
  62 #define Ea_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi, EA)    /** @req EA092 */\r
  63 #endif /* EA_VERSION_INFO_API */\r
  64 \r
  65 void Ea_MainFunction(void);     /** @req EA096 */\r
  66 \r
  67 void Ea_Init(void);     /** @req EA084 */\r
  68 void Ea_SetMode(MemIf_ModeType Mode);   /** @req EA085 */\r
  69 Std_ReturnType Ea_Read(uint16 BlockNumber, uint16 BlockOffset, uint8* DataBufferPtr, uint16 Length); /** @req EA086 */\r
  70 Std_ReturnType Ea_Write(uint16 BlockNumber, uint8* DataBufferPtr); /** @req EA087 */\r
  71 void Ea_Cancel(void);   /** @req EA088 */\r
  72 MemIf_StatusType Ea_GetStatus(void);    /** @req EA089 */\r
  73 MemIf_JobResultType Ea_GetJobResult(void);      /** @req EA090 */\r
  74 Std_ReturnType Ea_InvalidateBlock(uint16 BlockNumber);  /** @req EA091 */\r
  75 Std_ReturnType Ea_EraseImmediateBlock(uint16 BlockNumber);      /** @req EA093 */\r
  76 \r
  77 \r
  78 \r
  79 #endif /*EA_H_*/\r