drivers/staging/epl/EplPdokCal.c

   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:  source file for kernel PDO Communication Abstraction Layer module
   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: EplPdokCal.c,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.6 $  $Date: 2008/10/17 15:32:32 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                     GCC V3.4
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2006/06/27 d.k.:   start of the implementation, version 1.00
  68
  69 ****************************************************************************/
  70
  71 #include "kernel/EplPdokCal.h"
  72
  73 #if (((EPL_MODULE_INTEGRATION) & (EPL_MODULE_PDOK)) != 0)
  74
  75
  76 /***************************************************************************/
  77 /*                                                                         */
  78 /*                                                                         */
  79 /*          G L O B A L   D E F I N I T I O N S                            */
  80 /*                                                                         */
  81 /*                                                                         */
  82 /***************************************************************************/
  83
  84 //---------------------------------------------------------------------------
  85 // const defines
  86 //---------------------------------------------------------------------------
  87
  88 //---------------------------------------------------------------------------
  89 // local types
  90 //---------------------------------------------------------------------------
  91
  92 //---------------------------------------------------------------------------
  93 // modul globale vars
  94 //---------------------------------------------------------------------------
  95
  96 //---------------------------------------------------------------------------
  97 // local function prototypes
  98 //---------------------------------------------------------------------------
  99
 100
 101 /***************************************************************************/
 102 /*                                                                         */
 103 /*                                                                         */
 104 /*          C L A S S  EplPdokCal                                          */
 105 /*                                                                         */
 106 /*                                                                         */
 107 /***************************************************************************/
 108 //
 109 // Description:
 110 //
 111 //
 112 /***************************************************************************/
 113
 114
 115 //=========================================================================//
 116 //                                                                         //
 117 //          P R I V A T E   D E F I N I T I O N S                          //
 118 //                                                                         //
 119 //=========================================================================//
 120
 121 //---------------------------------------------------------------------------
 122 // const defines
 123 //---------------------------------------------------------------------------
 124
 125 //---------------------------------------------------------------------------
 126 // local types
 127 //---------------------------------------------------------------------------
 128
 129 typedef struct
 130 {
 131     BOOL            m_fTpdosValid;
 132
 133 } tEplPdokCalInstance;
 134
 135 //---------------------------------------------------------------------------
 136 // local vars
 137 //---------------------------------------------------------------------------
 138
 139 static tEplPdokCalInstance  EplPdokCalInstance_g;
 140
 141 //---------------------------------------------------------------------------
 142 // local function prototypes
 143 //---------------------------------------------------------------------------
 144
 145
 146 //=========================================================================//
 147 //                                                                         //
 148 //          P U B L I C   F U N C T I O N S                                //
 149 //                                                                         //
 150 //=========================================================================//
 151
 152 //---------------------------------------------------------------------------
 153 //
 154 // Function:    EplPdokCalAddInstance()
 155 //
 156 // Description: add and initialize new instance of EPL stack
 157 //
 158 // Parameters:  none
 159 //
 160 // Returns:     tEplKernel              = error code
 161 //
 162 //
 163 // State:
 164 //
 165 //---------------------------------------------------------------------------
 166
 167 tEplKernel EplPdokCalAddInstance(void)
 168 {
 169
 170     EPL_MEMSET(&EplPdokCalInstance_g, 0, sizeof(EplPdokCalInstance_g));
 171
 172     return kEplSuccessful;
 173 }
 174
 175 //---------------------------------------------------------------------------
 176 //
 177 // Function:    EplPdokCalDelInstance()
 178 //
 179 // Description: deletes an instance of EPL stack
 180 //
 181 // Parameters:  none
 182 //
 183 // Returns:     tEplKernel              = error code
 184 //
 185 //
 186 // State:
 187 //
 188 //---------------------------------------------------------------------------
 189
 190 tEplKernel EplPdokCalDelInstance(void)
 191 {
 192
 193     return kEplSuccessful;
 194 }
 195
 196
 197 //---------------------------------------------------------------------------
 198 //
 199 // Function:    EplPdokCalSetTpdosValid()
 200 //
 201 // Description: This function sets the validity flag for TPDOs to the
 202 //              specified value.
 203 //
 204 // Parameters:  fValid_p                = validity flag
 205 //
 206 // Returns:     tEplKernel              = error code
 207 //
 208 //
 209 // State:
 210 //
 211 //---------------------------------------------------------------------------
 212
 213 tEplKernel EplPdokCalSetTpdosValid(BOOL fValid_p)
 214 {
 215 tEplKernel      Ret = kEplSuccessful;
 216
 217     EplPdokCalInstance_g.m_fTpdosValid = fValid_p;
 218
 219     return Ret;
 220 }
 221
 222 //---------------------------------------------------------------------------
 223 //
 224 // Function:    EplPdokCalAreTpdosValid()
 225 //
 226 // Description: This function returns the validity flag for TPDOs.
 227 //
 228 // Parameters:  pfValid_p               = OUT: validity flag
 229 //
 230 // Returns:     tEplKernel              = error code
 231 //
 232 //
 233 // State:
 234 //
 235 //---------------------------------------------------------------------------
 236
 237 tEplKernel EplPdokCalAreTpdosValid(BOOL * pfValid_p)
 238 {
 239 tEplKernel      Ret = kEplSuccessful;
 240
 241     *pfValid_p = EplPdokCalInstance_g.m_fTpdosValid;
 242
 243     return Ret;
 244 }
 245
 246
 247 //=========================================================================//
 248 //                                                                         //
 249 //          P R I V A T E   F U N C T I O N S                              //
 250 //                                                                         //
 251 //=========================================================================//
 252
 253 //---------------------------------------------------------------------------
 254 //
 255 // Function:
 256 //
 257 // Description:
 258 //
 259 //
 260 //
 261 // Parameters:
 262 //
 263 //
 264 // Returns:
 265 //
 266 //
 267 // State:
 268 //
 269 //---------------------------------------------------------------------------
 270
 271 #endif
 272
 273 // EOF
 274