drivers/staging/epl/EplApiLinux.h

   1 /****************************************************************************
   2
   3   (c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29
   4       www.systec-electronic.com
   5
   6   Project:      openPOWERLINK
   7
   8   Description:  include file for EPL API layer for Linux (kernel and user space)
   9
  10   License:
  11
  12     Redistribution and use in source and binary forms, with or without
  13     modification, are permitted provided that the following conditions
  14     are met:
  15
  16     1. Redistributions of source code must retain the above copyright
  17        notice, this list of conditions and the following disclaimer.
  18
  19     2. Redistributions in binary form must reproduce the above copyright
  20        notice, this list of conditions and the following disclaimer in the
  21        documentation and/or other materials provided with the distribution.
  22
  23     3. Neither the name of SYSTEC electronic GmbH nor the names of its
  24        contributors may be used to endorse or promote products derived
  25        from this software without prior written permission. For written
  26        permission, please contact info@systec-electronic.com.
  27
  28     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  31     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  32     COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  33     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  34     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  35     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  36     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  38     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39     POSSIBILITY OF SUCH DAMAGE.
  40
  41     Severability Clause:
  42
  43         If a provision of this License is or becomes illegal, invalid or
  44         unenforceable in any jurisdiction, that shall not affect:
  45         1. the validity or enforceability in that jurisdiction of any other
  46            provision of this License; or
  47         2. the validity or enforceability in other jurisdictions of that or
  48            any other provision of this License.
  49
  50   -------------------------------------------------------------------------
  51
  52                 $RCSfile: EplApiLinux.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.5 $  $Date: 2008/08/25 12:17:41 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                 KEIL uVision 2
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2006/10/11 d.k.:   start of the implementation, version 1.00
  68
  69 ****************************************************************************/
  70
  71 #ifndef _EPL_API_LINUX_H_
  72 #define _EPL_API_LINUX_H_
  73
  74 //---------------------------------------------------------------------------
  75 // const defines
  76 //---------------------------------------------------------------------------
  77
  78 #define EPLLIN_DEV_NAME     "epl"       // used for "/dev" and "/proc" entry
  79
  80 //---------------------------------------------------------------------------
  81 //  Commands for <ioctl>
  82 //---------------------------------------------------------------------------
  83
  84 #define EPLLIN_CMD_INITIALIZE               0   // ulArg_p ~ tEplApiInitParam*
  85 #define EPLLIN_CMD_PI_IN                    1   // ulArg_p ~ tEplApiProcessImage*
  86 #define EPLLIN_CMD_PI_OUT                   2   // ulArg_p ~ tEplApiProcessImage*
  87 #define EPLLIN_CMD_WRITE_OBJECT             3   // ulArg_p ~ tEplLinSdoObject*
  88 #define EPLLIN_CMD_READ_OBJECT              4   // ulArg_p ~ tEplLinSdoObject*
  89 #define EPLLIN_CMD_WRITE_LOCAL_OBJECT       5   // ulArg_p ~ tEplLinLocalObject*
  90 #define EPLLIN_CMD_READ_LOCAL_OBJECT        6   // ulArg_p ~ tEplLinLocalObject*
  91 #define EPLLIN_CMD_FREE_SDO_CHANNEL         7   // ulArg_p ~ tEplSdoComConHdl
  92 #define EPLLIN_CMD_NMT_COMMAND              8   // ulArg_p ~ tEplNmtEvent
  93 #define EPLLIN_CMD_GET_EVENT                9   // ulArg_p ~ tEplLinEvent*
  94 #define EPLLIN_CMD_MN_TRIGGER_STATE_CHANGE 10   // ulArg_p ~ tEplLinNodeCmdObject*
  95 #define EPLLIN_CMD_PI_SETUP                11   // ulArg_p ~ 0
  96 #define EPLLIN_CMD_SHUTDOWN                12   // ulArg_p ~ 0
  97
  98 //---------------------------------------------------------------------------
  99 // typedef
 100 //---------------------------------------------------------------------------
 101
 102 typedef struct {
 103         unsigned int m_uiEventArgSize;
 104         tEplApiEventArg *m_pEventArg;
 105         tEplApiEventType *m_pEventType;
 106         tEplKernel m_RetCbEvent;
 107
 108 } tEplLinEvent;
 109
 110 typedef struct {
 111         tEplSdoComConHdl m_SdoComConHdl;
 112         BOOL m_fValidSdoComConHdl;
 113         unsigned int m_uiNodeId;
 114         unsigned int m_uiIndex;
 115         unsigned int m_uiSubindex;
 116         void *m_le_pData;
 117         unsigned int m_uiSize;
 118         tEplSdoType m_SdoType;
 119         void *m_pUserArg;
 120
 121 } tEplLinSdoObject;
 122
 123 typedef struct {
 124         unsigned int m_uiIndex;
 125         unsigned int m_uiSubindex;
 126         void *m_pData;
 127         unsigned int m_uiSize;
 128
 129 } tEplLinLocalObject;
 130
 131 typedef struct {
 132         unsigned int m_uiNodeId;
 133         tEplNmtNodeCommand m_NodeCommand;
 134
 135 } tEplLinNodeCmdObject;
 136
 137 //---------------------------------------------------------------------------
 138 // function prototypes
 139 //---------------------------------------------------------------------------
 140
 141 #endif // #ifndef _EPL_API_LINUX_H_