include/Port.h

   1 /* -------------------------------- Arctic Core ------------------------------
   2  * Arctic Core - the open source AUTOSAR platform http://arccore.com
   3  *
   4  * Copyright (C) 2009  ArcCore AB <contact@arccore.com>
   5  *
   6  * This source code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published by the
   8  * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  12  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * for more details.
  14  * -------------------------------- Arctic Core ------------------------------*/
  15
  16 /** @addtogroup Port Port Driver
  17  *  @{ */
  18
  19 /** @file Port.h
  20  * API and type definitions for Port Driver.
  21  */
  22
  23 #ifndef PORT_H_\r
  24 #define PORT_H_\r
  25
  26 #define PORT_SW_MAJOR_VERSION           1
  27 #define PORT_SW_MINOR_VERSION           0
  28 #define PORT_SW_PATCH_VERSION           0
  29
  30 #define PORT_AR_MAJOR_VERSION     3
  31 #define PORT_AR_MINOR_VERSION     0
  32 #define PORT_AR_PATCH_VERSION     2
  33 \r
  34 #include "Port_Cfg.h"
  35 \r
  36 #if PORT_VERSION_INFO_API == STD_ON\r
  37 void Port_GetVersionInfo( Std_VersionInfoType *versionInfo );\r
  38 #endif \r
  39
  40 /** @name Error Codes */
  41 //@{
  42 #define PORT_E_PARAM_PIN                                               0x0a\r
  43 #define PORT_E_DIRECTION_UNCHANGEABLE            0x0b\r
  44 #define PORT_E_PARAM_CONFIG                                          0x0c\r
  45 #define PORT_E_PARAM_INVALID_MODE                          0x0d\r
  46 #define PORT_E_MODE_UNCHANGEABLE                           0x0e\r
  47 #define PORT_E_UNINIT                                                    0x0f\r
  48 //@}
  49
  50 /** @name Service id's */
  51 //@{
  52 #define PORT_INIT_ID                                                     0x00\r
  53 #define PORT_SET_PIN_DIRECTION_ID                          0x01\r
  54 #define PORT_REFRESH_PORT_DIRECTION_ID   0x02\r
  55 #define PORT_GET_VERSION_INFO_ID         0x03\r
  56 #define PORT_SET_PIN_MODE_ID                           0x04\r
  57 //@}
  58 \r
  59 /**
  60  * PORT046: The type Port_PinDirectionType is a type for defining the direction of a Port Pin. \r
  61  * PORT_PIN_IN Sets port pin as input. \r
  62  * PORT_PIN_OUT  Sets port pin as output. \r
  63  */\r
  64 typedef enum\r
  65 {\r
  66   PORT_PIN_IN = 0,\r
  67   PORT_PIN_OUT,\r
  68 } Port_PinDirectionType;\r
  69 \r
  70 typedef uint32 Port_PinModeType;\r
  71 typedef enum\r
  72 {\r
  73   PORT_UNINITIALIZED = 0,\r
  74   PORT_INITIALIZED,\r
  75 } Port_StateType;\r
  76 \r
  77 void Port_Init( const Port_ConfigType *configType );\r
  78 void Port_SetPinDirection( Port_PinType pin, Port_PinDirectionType direction );\r
  79 void Port_RefreshPortDirection( void );\r
  80 void Port_SetPinMode( Port_PinType Pin, Port_PinModeType Mode );\r
  81 \r
  82 #endif /*PORT_H_*/\r
  83 /** @} */