drivers/staging/epl/edrv.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:  interface for ethernetdriver
   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: edrv.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.6 $  $Date: 2008/04/17 21:36:32 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                 Dev C++ and GNU-Compiler for m68k
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2005/08/01 m.b.:   start of implementation
  68
  69 ****************************************************************************/
  70
  71 #ifndef _EDRV_H_
  72 #define _EDRV_H_
  73
  74 #include "EplInc.h"
  75 #include "EplFrame.h"
  76
  77 //---------------------------------------------------------------------------
  78 // const defines
  79 //---------------------------------------------------------------------------
  80 // --------------------------------------------------------------------------
  81 #define MAX_ETH_DATA_SIZE       1500
  82 #define MIN_ETH_DATA_SIZE         46
  83
  84 #define ETH_HDR_OFFSET   0      // Ethernet header at the top of the frame
  85 #define ETH_HDR_SIZE    14      // size of Ethernet header
  86 #define MIN_ETH_SIZE     (MIN_ETH_DATA_SIZE + ETH_HDR_SIZE)    // without CRC
  87
  88 #define ETH_CRC_SIZE     4      // size of Ethernet CRC, i.e. FCS
  89
  90
  91
  92 //---------------------------------------------------------------------------
  93 // types
  94 //---------------------------------------------------------------------------
  95
  96 // position of a buffer in an ethernet-frame
  97 typedef enum
  98 {
  99     kEdrvBufferFirstInFrame   = 0x01,  // first data buffer in an ethernet frame
 100     kEdrvBufferMiddleInFrame  = 0x02,  // a middle data buffer in an ethernet frame
 101     kEdrvBufferLastInFrame    = 0x04   // last data buffer in an ethernet frame
 102 } tEdrvBufferInFrame;
 103
 104
 105 // format of a tx-buffer
 106 typedef struct _tEdrvTxBuffer
 107 {
 108     tEplMsgType     m_EplMsgType;           // IN: type of EPL message, set by calling function
 109     unsigned int    m_uiTxMsgLen;           // IN: length of message to be send (set for each transmit call)
 110     // ----------------------
 111     unsigned int    m_uiBufferNumber;       // OUT: number of the buffer, set by ethernetdriver
 112     BYTE  *         m_pbBuffer;             // OUT: pointer to the buffer, set by ethernetdriver
 113     tEplNetTime     m_NetTime;              // OUT: Timestamp of end of transmission, set by ethernetdriver
 114     // ----------------------
 115     unsigned int    m_uiMaxBufferLen;       // IN/OUT: maximum length of the buffer
 116 } tEdrvTxBuffer;
 117
 118 // format of a rx-buffer
 119 typedef struct _tEdrvRxBuffer
 120 {
 121     tEdrvBufferInFrame m_BufferInFrame;   // OUT position of received buffer in an ethernet-frame
 122     unsigned int       m_uiRxMsgLen;        // OUT: length of received buffer (without CRC)
 123     BYTE  *            m_pbBuffer;          // OUT: pointer to the buffer, set by ethernetdriver
 124     tEplNetTime        m_NetTime;           // OUT: Timestamp of end of receiption
 125
 126 } tEdrvRxBuffer;
 127
 128
 129
 130 //typedef void (*tEdrvRxHandler) (BYTE bBufferInFrame_p, tBufferDescr * pbBuffer_p);
 131 //typedef void (*tEdrvRxHandler) (BYTE bBufferInFrame_p, BYTE * pbEthernetData_p, WORD wDataLen_p);
 132 typedef void (*tEdrvRxHandler) (tEdrvRxBuffer * pRxBuffer_p);
 133 typedef void (*tEdrvTxHandler) (tEdrvTxBuffer * pTxBuffer_p);
 134
 135
 136 // format of init structure
 137 typedef struct
 138 {
 139     BYTE            m_abMyMacAddr[6];       // the own MAC address
 140
 141 //    BYTE            m_bNoOfRxBuffDescr;     // number of entries in rx bufferdescriptor table
 142 //    tBufferDescr *  m_pRxBuffDescrTable;    // rx bufferdescriptor table
 143 //    WORD            m_wRxBufferSize;        // size of the whole rx buffer
 144
 145     tEdrvRxHandler  m_pfnRxHandler;
 146     tEdrvTxHandler  m_pfnTxHandler;
 147
 148 } tEdrvInitParam;
 149
 150
 151 //---------------------------------------------------------------------------
 152 // function prototypes
 153 //---------------------------------------------------------------------------
 154
 155
 156 tEplKernel EdrvInit                   (tEdrvInitParam* pEdrvInitParam_p);
 157
 158 tEplKernel EdrvShutdown               (void);
 159
 160 tEplKernel EdrvDefineRxMacAddrEntry   (BYTE * pbMacAddr_p);
 161 tEplKernel EdrvUndefineRxMacAddrEntry (BYTE * pbMacAddr_p);
 162
 163 //tEplKernel EdrvDefineUnicastEntry     (BYTE * pbUCEntry_p);
 164 //tEplKernel EdrvUndfineUnicastEntry    (BYTE * pbUCEntry_p);
 165
 166 tEplKernel EdrvAllocTxMsgBuffer       (tEdrvTxBuffer * pBuffer_p);
 167 tEplKernel EdrvReleaseTxMsgBuffer     (tEdrvTxBuffer * pBuffer_p);
 168
 169 //tEplKernel EdrvWriteMsg               (tBufferDescr * pbBuffer_p);
 170 tEplKernel EdrvSendTxMsg              (tEdrvTxBuffer * pBuffer_p);
 171 tEplKernel EdrvTxMsgReady              (tEdrvTxBuffer * pBuffer_p);
 172 tEplKernel EdrvTxMsgStart              (tEdrvTxBuffer * pBuffer_p);
 173
 174 //tEplKernel EdrvReadMsg                (void);
 175
 176 // interrupt handler called by target specific interrupt handler
 177 void        EdrvInterruptHandler       (void);
 178
 179
 180
 181 #endif  // #ifndef _EDRV_H_
 182
 183