linklayerprotocols/slipnif/SRC/SLIP.H
changeset 0 af10295192d8
child 5 1422c6cd3f0c
equal deleted inserted replaced
-1:000000000000 0:af10295192d8
       
     1 /**
       
     2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 /**
       
    21  @file SLIP.H
       
    22  @internalComponent
       
    23 */
       
    24 
       
    25 #if !defined(__SLIP_H__)
       
    26 #define __SLIP_H__
       
    27 
       
    28 #include <es_mbuf.h>
       
    29 #include <comms-infras/nifif.h>
       
    30 #include <nifutl.h>
       
    31 
       
    32 ////////////////////////////////////////////////////////////////////////////////
       
    33 
       
    34 const TInt KSlipDefaultMtu = 576; ///< default Maximum transmit unit
       
    35 const TUint KSlipEndCh = 0300;    ///< End of frame
       
    36 const TUint KSlipEscCh = 0333;
       
    37 const TUint KSlipEscEndCh = 0334;
       
    38 const TUint KSlipEscEscCh = 0335;
       
    39 const TUint KSlipWriterPrority = 20;
       
    40 const TUint KSlipReaderPrority = 10;
       
    41 
       
    42 ////////////////////////////////////////////////////////////////////////////////
       
    43 
       
    44 enum TSlipPanic {	PanicSlipAssert1,
       
    45 					PanicSlipAssert2,
       
    46 					PanicSlipAssert3,
       
    47 					PanicSlipAssert4,
       
    48 					PanicSlipAssert5,
       
    49 					PanicSlipAssert6,
       
    50 					PanicSlipAssert7,
       
    51 					PanicSlipAssert8
       
    52 
       
    53 				};
       
    54 void SlipPanic(TSlipPanic aPanic);
       
    55 
       
    56 enum TSlipFault {};
       
    57 
       
    58 void SlipFault(TSlipFault aFault);
       
    59 
       
    60 ////////////////////////////////////////////////////////////////////////////////
       
    61 // SLIP Protocol Factory
       
    62 ////////////////////////////////////////////////////////////////////////////////
       
    63 
       
    64 NONSHARABLE_CLASS(CSlipIfFactory) : public CNifIfFactory
       
    65 /**
       
    66 @internalComponent
       
    67 */
       
    68 	{
       
    69 protected:
       
    70 	virtual void InstallL();
       
    71 	virtual CNifIfBase* NewInterfaceL(const TDesC& aName);
       
    72 	TInt Info(TNifIfInfo& aInfo, TInt aIndex) const;
       
    73 	};
       
    74 
       
    75 ////////////////////////////////////////////////////////////////////////////////
       
    76 // Slip Interface
       
    77 ////////////////////////////////////////////////////////////////////////////////
       
    78 
       
    79 const TUint KSlipBufSize = 1024;
       
    80 
       
    81 class TSlipBuf : public TBuf8<KSlipBufSize>
       
    82 /**
       
    83 @internalComponent
       
    84 */
       
    85 	{
       
    86 public:
       
    87 #ifndef _DEBUG
       
    88 	inline const TUint8 &operator[](TInt aIndex) const
       
    89 		{ return iBuf[aIndex]; }
       
    90 	inline TUint8 &operator[](TInt aIndex)
       
    91 		{ return iBuf[aIndex]; }
       
    92 #endif
       
    93 	};
       
    94 
       
    95 const TUint KSlipIsUp = 0x01;
       
    96 const TUint KSlipSendBusy = 0x02;
       
    97 const TUint KSlipSendInUse = 0x04;
       
    98 const TUint KSlipRecvEscPend = 0x08;
       
    99 const TUint KSlipCommConfigOk = 0x10;
       
   100 
       
   101 NONSHARABLE_CLASS(CSlip) : public CNifIfLink, public MComm
       
   102 /**
       
   103 @internalComponent
       
   104 */
       
   105 	{
       
   106 public:
       
   107 	CSlip(CNifIfFactory& aFactory);
       
   108 	~CSlip();
       
   109 
       
   110 	virtual void BindL(TAny *aId);
       
   111 	virtual TInt State();
       
   112 	virtual TInt Control(TUint aLevel,TUint aName,TDes8& aOption, TAny* aSource=0);
       
   113 	virtual TInt Send(RMBufChain& aPdu, TAny* aSource=0);
       
   114 	virtual TInt Start();
       
   115 	virtual void Stop(TInt aReason, MNifIfNotify::TAction aAction);
       
   116 	virtual CNifIfBase* GetBinderL(const TDesC& aName);
       
   117 	virtual void Info(TNifIfInfo& aInfo) const;
       
   118 	virtual TInt Notification(TAgentToNifEventType aEvent, void * aInfo);
       
   119 	virtual void Restart(CNifIfBase* aIf);
       
   120 	static void FillInInfo(TNifIfInfo& aInfo);
       
   121 	//
       
   122 	void CommReadComplete(TInt aStatus);
       
   123 	void CommWriteComplete(TInt aStatus);
       
   124 	
       
   125 	// Slip Family 
       
   126 	static void FillinInfo(TServerProtocolDesc &aEntry);
       
   127 private:
       
   128 	void DoRecv();
       
   129 	void DoSend();
       
   130 	void LinkDown(TInt aReason);
       
   131 	TInt PacketModeOn();
       
   132 	TInt PacketModeOff();
       
   133 	TInt SpeedMetric();
       
   134 private:
       
   135 	TCommConfig iOrigConfig;
       
   136 	TUint iFlags;
       
   137 	CProtocolBase* iIpProtocol;
       
   138 	
       
   139 	/** Sender */
       
   140 	CAsyncCallBack* iSendCallBack;
       
   141 
       
   142 	RMBufPktQ iSendPktQ;
       
   143 	RMBufChain iSendPkt;
       
   144 	RMBuf* iSendMBuf;
       
   145 	TUint8* iSendMPtr;
       
   146 	TSlipBuf iSendBuf;
       
   147 
       
   148 	TInt iSendMBufs;	///< Send current level 
       
   149 	TInt iSendLoWat;	///< Send flow on level 
       
   150 	TInt iSendHiWat;	///< Send flow off level 
       
   151 	TSlipBuf iRecvBuf;	///< Receiver 
       
   152 
       
   153 	TInt iRecvLen;
       
   154 	RMBuf* iRecvMBuf;
       
   155 	TUint8* iRecvMPtr;
       
   156 	RMBufQ iRecvQ;
       
   157 	};
       
   158 
       
   159 #endif