include/CanIf.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 CANIF_H_\r
  18 #define CANIF_H_\r
  19 #include "Modules.h"\r
  20 \r
  21 #if defined(USE_PDUR)\r
  22 #include "PduR.h"\r
  23 #endif\r
  24 \r
  25 #if defined(USE_COM)\r
  26 #include "Com.h"\r
  27 #endif\r
  28 \r
  29 #define CANIF_VENDOR_ID          VENDOR_ID_ARCCORE\r
  30 #define CANIF_MODULE_ID          MODULE_ID_CANIF\r
  31 #define CANIF_AR_MAJOR_VERSION   3\r
  32 #define CANIF_AR_MINOR_VERSION   1\r
  33 #define CANIF_AR_PATCH_VERSION   5\r
  34 \r
  35 #define CANIF_SW_MAJOR_VERSION   1\r
  36 #define CANIF_SW_MINOR_VERSION   3\r
  37 #define CANIF_SW_PATCH_VERSION   0\r
  38 \r
  39 #if defined(USE_DET)\r
  40 #include "Det.h"\r
  41 #endif\r
  42 #include "CanIf_Types.h"\r
  43 #include "CanIf_SpecialPdus.h"\r
  44 #include "CanIf_Cfg.h"\r
  45 \r
  46 \r
  47 // Service IDs\r
  48 #define CANIF_INIT_ID                0x01\r
  49 #define CANIF_INIT_CONTROLLER_ID     0x02\r
  50 #define CANIF_SET_CONTROLLER_MODE_ID 0x03\r
  51 #define CANIF_GET_CONTROLLER_MODE_ID 0x04\r
  52 #define CANIF_TRANSMIT_ID            0x05\r
  53 #define CANIF_READTXPDUDATA_ID       0x06\r
  54 #define CANIF_READTXNOTIFSTATUS_ID   0x07\r
  55 #define CANIF_READRXNOTIFSTATUS_ID   0x08\r
  56 #define CANIF_SETPDUMODE_ID          0x09\r
  57 #define CANIF_GETPDUMODE_ID          0x0A\r
  58 #define CANIF_SETDYNAMICTX_ID        0x0C\r
  59 #define CANIF_SET_TRANSCEIVERMODE_ID     0x0D\r
  60 #define CANIF_GET_TRANSCEIVERMODE_ID     0x0E\r
  61 #define CANIF_GET_TRCVMODEREASON_ID      0x0F\r
  62 #define CANIF_SET_TRANSCEIVERWAKEMODE_ID 0x10\r
  63 #define CANIF_CHECKWAKEUP_ID          0x11\r
  64 #define CANIF_CHECKVALIDATION_ID      0x12\r
  65 #define CANIF_TXCONFIRMATION_ID       0x13\r
  66 #define CANIF_RXINDICATION_ID         0x14\r
  67 #define CANIF_CANCELTXCONFIRMATION_ID 0x15\r
  68 #define CANIF_CONTROLLER_BUSOFF_ID    0x16\r
  69 \r
  70 #define CANIF_SETWAKEUPEVENT_ID       0x40\r
  71 #define CANIF_ARCERROR_ID           0x41\r
  72 \r
  73 void CanIf_Init(const CanIf_ConfigType *ConfigPtr);\r
  74 \r
  75 void CanIf_InitController(uint8  Controller,\r
  76             uint8  ConfigurationIndex);\r
  77 \r
  78 Std_ReturnType CanIf_SetControllerMode(uint8 Controller,\r
  79                 CanIf_ControllerModeType ControllerMode);\r
  80 \r
  81 Std_ReturnType CanIf_GetControllerMode(uint8 Controller,\r
  82                 CanIf_ControllerModeType *ControllerModePtr);\r
  83 \r
  84 Std_ReturnType CanIf_Transmit(PduIdType CanTxPduId,\r
  85                 const PduInfoType *PduInfoPtr);\r
  86 \r
  87 #if ( CANIF_READRXPDU_DATA_API == STD_ON )\r
  88 Std_ReturnType CanIf_ReadRxPduData(PduIdType CanRxPduId,\r
  89                 PduInfoType *PduInfoPtr);\r
  90 #endif\r
  91 \r
  92 #if ( CANIF_READTXPDU_NOTIFY_STATUS_API == STD_ON )\r
  93 CanIf_NotifStatusType CanIf_ReadTxNotifStatus(PduIdType CanTxPduId);\r
  94 #endif\r
  95 \r
  96 #if ( CANIF_READTXPDU_NOTIFY_STATUS_API == STD_ON )\r
  97 CanIf_NotifStatusType CanIf_ReadRxNotifStatus(PduIdType CanRxPduId);\r
  98 #endif\r
  99 \r
 100 Std_ReturnType CanIf_SetPduMode( uint8 Controller, CanIf_ChannelSetModeType PduModeRequest );\r
 101 Std_ReturnType CanIf_GetPduMode( uint8 Controller, CanIf_ChannelGetModeType *PduModePtr );\r
 102 \r
 103 #if ( CANIF_ARC_RUNTIME_PDU_CONFIGURATION == STD_ON )
 104 void CanIf_SetDynamicTxId( PduIdType CanTxPduId, Can_IdType CanId );\r
 105 CanIf_TxPduConfigType * CanIf_FindTxPduEntry(PduIdType id);
 106 CanIf_RxPduConfigType * CanIf_FindRxPduEntry(PduIdType id);
 107 const CanIf_HrhConfigType* CanIf_Arc_GetReceiveHandler(CanIf_Arc_ChannelIdType Channel);
 108 const CanIf_HthConfigType* CanIf_Arc_GetTransmitHandler(CanIf_Arc_ChannelIdType Channel);
 109 #endif\r
 110 \r
 111 #if ( CANIF_TRANSCEIVER_API == STD_ON )\r
 112 Std_ReturnType CanIf_SetTransceiverMode( uint8 Transceiver, CanIf_TransceiverModeType TransceiverMode );\r
 113 Std_ReturnType CanIf_GetTransceiverMode( uint8 Transceiver, CanIf_TransceiverModeType *TransceiverModePtr );\r
 114 Std_ReturnType CanIf_GetTrcvWakeupReason( uint8 Transceiver, CanIf_TrcvWakeupReasonType *TrcvWuReasonPtr );\r
 115 Std_ReturnType CanIf_SetTransceiverWakeupMode( uint8 Transceiver, CanIf_TrcvWakeupModeType *TrcvWakeupMode );\r
 116 #endif\r
 117 \r
 118 #if ( CANIF_WAKEUP_EVENT_API == STD_ON )\r
 119 Std_ReturnType CanIf_CheckWakeup( EcuM_WakeupSourceType WakeupSource );\r
 120 Std_ReturnType CanIf_CheckValidation( EcuM_WakeupSourceType WakeupSource );\r
 121 #endif\r
 122 \r
 123 #if ( CANIF_VERSION_INFO_API == STD_ON )\r
 124 #define CanIf_GetVersionInfo(_vi) STD_GET_VERSION_INFO(_vi,CANIF)\r
 125 #endif\r
 126 \r
 127 uint8 CanIf_Arc_GetChannelDefaultConfIndex(CanIf_Arc_ChannelIdType Channel);
 128
 129 #endif /*CANIF_H_*/\r