Staging: add epl stack

This is the openPOWERLINK network stack from systec electronic.

It's a bit messed up as there is a driver mixed into the
middle of it, lots of work needs to be done to unwind the
different portions to make it sane.

Cc: Daniel Krueger <daniel.krueger@systec-electronic.com>
Cc: Ronald Sieber <Ronald.Sieber@systec-electronic.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

1 files changed, 472 insertions, 0 deletions

diff --git a/drivers/staging/epl/EplTimeruLinuxKernel.c b/drivers/staging/epl/EplTimeruLinuxKernel.c
new file mode 100644
index 00000000000..41dfb616d7d
--- /dev/null
+++ b/drivers/staging/epl/EplTimeruLinuxKernel.c
@@ -0,0 +1,472 @@
+/****************************************************************************
+
+  (c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29
+      www.systec-electronic.com
+
+  Project:      openPOWERLINK
+
+  Description:  source file for EPL User Timermodule for Linux kernel module
+
+  License:
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in the
+       documentation and/or other materials provided with the distribution.
+
+    3. Neither the name of SYSTEC electronic GmbH nor the names of its
+       contributors may be used to endorse or promote products derived
+       from this software without prior written permission. For written
+       permission, please contact info@systec-electronic.com.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+
+    Severability Clause:
+
+        If a provision of this License is or becomes illegal, invalid or
+        unenforceable in any jurisdiction, that shall not affect:
+        1. the validity or enforceability in that jurisdiction of any other
+           provision of this License; or
+        2. the validity or enforceability in other jurisdictions of that or
+           any other provision of this License.
+
+  -------------------------------------------------------------------------
+
+                $RCSfile: EplTimeruLinuxKernel.c,v $
+
+                $Author: D.Krueger $
+
+                $Revision: 1.6 $  $Date: 2008/04/17 21:36:32 $
+
+                $State: Exp $
+
+                Build Environment:
+                KEIL uVision 2
+
+  -------------------------------------------------------------------------
+
+  Revision History:
+
+  2006/09/12 d.k.:   start of the implementation
+
+****************************************************************************/
+
+#include "user/EplTimeru.h"
+#include <linux/timer.h>
+
+/***************************************************************************/
+/*                                                                         */
+/*                                                                         */
+/*          G L O B A L   D E F I N I T I O N S                            */
+/*                                                                         */
+/*                                                                         */
+/***************************************************************************/
+
+//---------------------------------------------------------------------------
+// const defines
+//---------------------------------------------------------------------------
+
+//---------------------------------------------------------------------------
+// local types
+//---------------------------------------------------------------------------
+typedef struct
+{
+    struct timer_list   m_Timer;
+    tEplTimerArg        TimerArgument;
+
+} tEplTimeruData;
+
+//---------------------------------------------------------------------------
+// modul globale vars
+//---------------------------------------------------------------------------
+
+//---------------------------------------------------------------------------
+// local function prototypes
+//---------------------------------------------------------------------------
+static void PUBLIC EplTimeruCbMs(unsigned long ulParameter_p);
+
+/***************************************************************************/
+/*                                                                         */
+/*                                                                         */
+/*          C L A S S  <Epl Userspace-Timermodule for Linux Kernel>              */
+/*                                                                         */
+/*                                                                         */
+/***************************************************************************/
+//
+// Description: Epl Userspace-Timermodule for Linux Kernel
+//
+//
+/***************************************************************************/
+
+//=========================================================================//
+//                                                                         //
+//          P U B L I C   F U N C T I O N S                                //
+//                                                                         //
+//=========================================================================//
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruInit
+//
+// Description: function inits first instance
+//
+// Parameters:  void
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruInit()
+{
+tEplKernel  Ret;
+
+    Ret = EplTimeruAddInstance();
+
+    return Ret;
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruAddInstance
+//
+// Description: function inits additional instance
+//
+// Parameters:  void
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruAddInstance()
+{
+tEplKernel Ret;
+
+    Ret = kEplSuccessful;
+
+    return Ret;
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruDelInstance
+//
+// Description: function deletes instance
+//              -> under Linux nothing to do
+//              -> no instance table needed
+//
+// Parameters:  void
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruDelInstance()
+{
+tEplKernel  Ret;
+
+    Ret = kEplSuccessful;
+
+    return Ret;
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruSetTimerMs
+//
+// Description: function creates a timer and returns the corresponding handle
+//
+// Parameters:  pTimerHdl_p = pointer to a buffer to fill in the handle
+//              ulTime_p    = time for timer in ms
+//              Argument_p  = argument for timer
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruSetTimerMs(tEplTimerHdl*     pTimerHdl_p,
+                                        unsigned long   ulTime_p,
+                                        tEplTimerArg    Argument_p)
+{
+tEplKernel          Ret = kEplSuccessful;
+tEplTimeruData*     pData;
+
+    // check pointer to handle
+    if(pTimerHdl_p == NULL)
+    {
+        Ret = kEplTimerInvalidHandle;
+        goto Exit;
+    }
+
+    pData = (tEplTimeruData*) EPL_MALLOC(sizeof (tEplTimeruData));
+    if (pData == NULL)
+    {
+        Ret = kEplNoResource;
+        goto Exit;
+    }
+
+    init_timer(&pData->m_Timer);
+    pData->m_Timer.function = EplTimeruCbMs;
+    pData->m_Timer.data = (unsigned long) pData;
+    pData->m_Timer.expires = jiffies + ulTime_p * HZ / 1000;
+
+    EPL_MEMCPY(&pData->TimerArgument, &Argument_p, sizeof(tEplTimerArg));
+
+    add_timer(&pData->m_Timer);
+
+    *pTimerHdl_p = (tEplTimerHdl) pData;
+
+Exit:
+    return Ret;
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruModifyTimerMs
+//
+// Description: function changes a timer and returns the corresponding handle
+//
+// Parameters:  pTimerHdl_p = pointer to a buffer to fill in the handle
+//              ulTime_p    = time for timer in ms
+//              Argument_p  = argument for timer
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruModifyTimerMs(tEplTimerHdl*     pTimerHdl_p,
+                                        unsigned long     ulTime_p,
+                                        tEplTimerArg      Argument_p)
+{
+tEplKernel          Ret = kEplSuccessful;
+tEplTimeruData*     pData;
+
+    // check pointer to handle
+    if(pTimerHdl_p == NULL)
+    {
+        Ret = kEplTimerInvalidHandle;
+        goto Exit;
+    }
+
+    // check handle itself, i.e. was the handle initialized before
+    if (*pTimerHdl_p == 0)
+    {
+        Ret = EplTimeruSetTimerMs(pTimerHdl_p, ulTime_p, Argument_p);
+        goto Exit;
+    }
+    pData = (tEplTimeruData*) *pTimerHdl_p;
+    if ((tEplTimeruData*)pData->m_Timer.data != pData)
+    {
+        Ret = kEplTimerInvalidHandle;
+        goto Exit;
+    }
+
+    mod_timer(&pData->m_Timer, (jiffies + ulTime_p * HZ / 1000));
+
+    // copy the TimerArg after the timer is restarted,
+    // so that a timer occured immediately before mod_timer
+    // won't use the new TimerArg and
+    // therefore the old timer cannot be distinguished from the new one.
+    // But if the new timer is too fast, it may get lost.
+    EPL_MEMCPY(&pData->TimerArgument, &Argument_p, sizeof(tEplTimerArg));
+
+    // check if timer is really running
+    if (timer_pending(&pData->m_Timer) == 0)
+    {   // timer is not running
+        // retry starting it
+        add_timer(&pData->m_Timer);
+    }
+
+    // set handle to pointer of tEplTimeruData
+//    *pTimerHdl_p = (tEplTimerHdl) pData;
+
+Exit:
+    return Ret;
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruDeleteTimer
+//
+// Description: function deletes a timer
+//
+// Parameters:  pTimerHdl_p = pointer to a buffer to fill in the handle
+//
+// Returns:     tEplKernel  = errorcode
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+tEplKernel PUBLIC EplTimeruDeleteTimer(tEplTimerHdl*     pTimerHdl_p)
+{
+tEplKernel          Ret = kEplSuccessful;
+tEplTimeruData*     pData;
+
+    // check pointer to handle
+    if(pTimerHdl_p == NULL)
+    {
+        Ret = kEplTimerInvalidHandle;
+        goto Exit;
+    }
+
+    // check handle itself, i.e. was the handle initialized before
+    if (*pTimerHdl_p == 0)
+    {
+        Ret = kEplSuccessful;
+        goto Exit;
+    }
+    pData = (tEplTimeruData*) *pTimerHdl_p;
+    if ((tEplTimeruData*)pData->m_Timer.data != pData)
+    {
+        Ret = kEplTimerInvalidHandle;
+        goto Exit;
+    }
+
+/*    if (del_timer(&pData->m_Timer) == 1)
+    {
+        kfree(pData);
+    }
+*/
+    // try to delete the timer
+    del_timer(&pData->m_Timer);
+    // free memory in any case
+    kfree(pData);
+
+    // uninitialize handle
+    *pTimerHdl_p = 0;
+
+Exit:
+    return Ret;
+
+}
+
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruIsTimerActive
+//
+// Description: checks if the timer referenced by the handle is currently
+//              active.
+//
+// Parameters:  TimerHdl_p  = handle of the timer to check
+//
+// Returns:     BOOL        = TRUE, if active;
+//                            FALSE, otherwise
+//
+// State:
+//
+//---------------------------------------------------------------------------
+
+BOOL PUBLIC EplTimeruIsTimerActive(tEplTimerHdl TimerHdl_p)
+{
+BOOL        fActive = FALSE;
+tEplTimeruData*     pData;
+
+    // check handle itself, i.e. was the handle initialized before
+    if (TimerHdl_p == 0)
+    {   // timer was not created yet, so it is not active
+        goto Exit;
+    }
+    pData = (tEplTimeruData*) TimerHdl_p;
+    if ((tEplTimeruData*)pData->m_Timer.data != pData)
+    {   // invalid timer
+        goto Exit;
+    }
+
+    // check if timer is running
+    if (timer_pending(&pData->m_Timer) == 0)
+    {   // timer is not running
+        goto Exit;
+    }
+
+    fActive = TRUE;
+
+Exit:
+    return fActive;
+}
+
+
+//=========================================================================//
+//                                                                         //
+//          P R I V A T E   F U N C T I O N S                              //
+//                                                                         //
+//=========================================================================//
+
+//---------------------------------------------------------------------------
+//
+// Function:    EplTimeruCbMs
+//
+// Description: function to process timer
+//
+//
+//
+// Parameters:  lpParameter = pointer to structur of type tEplTimeruData
+//
+//
+// Returns:     (none)
+//
+//
+// State:
+//
+//---------------------------------------------------------------------------
+static void PUBLIC EplTimeruCbMs(unsigned long ulParameter_p)
+{
+tEplKernel          Ret = kEplSuccessful;
+tEplTimeruData*     pData;
+tEplEvent           EplEvent;
+tEplTimerEventArg   TimerEventArg;
+
+    pData = (tEplTimeruData*) ulParameter_p;
+
+    // call event function
+    TimerEventArg.m_TimerHdl = (tEplTimerHdl)pData;
+    TimerEventArg.m_ulArg = pData->TimerArgument.m_ulArg;
+
+    EplEvent.m_EventSink = pData->TimerArgument.m_EventSink;
+    EplEvent.m_EventType = kEplEventTypeTimer;
+    EPL_MEMSET(&EplEvent.m_NetTime, 0x00, sizeof(tEplNetTime));
+    EplEvent.m_pArg = &TimerEventArg;
+    EplEvent.m_uiSize = sizeof(TimerEventArg);
+
+    Ret = EplEventuPost(&EplEvent);
+
+    // d.k. do not free memory, user has to call EplTimeruDeleteTimer()
+    //kfree(pData);
+
+}
+
+
+// EOF
+