tracesrv/tracecore/btrace_handler/inc/TraceCoreOstLddIf.h
author hgs
Fri, 08 Oct 2010 14:56:39 +0300
changeset 56 aa2539c91954
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56
hgs
parents:
diff changeset
     1
// Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
// Interface class for the TraceCoreOstLdd component. 
hgs
parents:
diff changeset
    15
// 
hgs
parents:
diff changeset
    16
hgs
parents:
diff changeset
    17
#ifndef __TraceCoreOstLddIf_H__
hgs
parents:
diff changeset
    18
#define __TraceCoreOstLddIf_H__
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// Include files
hgs
parents:
diff changeset
    22
#include <kernel/kernel.h>
hgs
parents:
diff changeset
    23
#include "TraceCoreMediaIf.h"
hgs
parents:
diff changeset
    24
#include "TraceCoreOstConnectionIf.h"
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
 * ETraceCoreOstLddIfGetSet function to choosed in DTraceCoreOstLddI::GetSet.
hgs
parents:
diff changeset
    28
 */
hgs
parents:
diff changeset
    29
enum TTraceCoreOstLddIfGetSet
hgs
parents:
diff changeset
    30
    {
hgs
parents:
diff changeset
    31
    EGetDfc = 0, // Return type TDfc*
hgs
parents:
diff changeset
    32
    EGetBuf = 1,     // Return type TDes8*
hgs
parents:
diff changeset
    33
    ESetWriter = 2,   // Return type 0
hgs
parents:
diff changeset
    34
    ERegister  // Return type 0
hgs
parents:
diff changeset
    35
    };
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
/**
hgs
parents:
diff changeset
    38
 * Interface class for XTI
hgs
parents:
diff changeset
    39
 */
hgs
parents:
diff changeset
    40
class DTraceCoreOstLddIf : public DTraceCoreMediaIf
hgs
parents:
diff changeset
    41
    {
hgs
parents:
diff changeset
    42
public:
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
     * Constructor
hgs
parents:
diff changeset
    46
     */
hgs
parents:
diff changeset
    47
    DTraceCoreOstLddIf();
hgs
parents:
diff changeset
    48
    
hgs
parents:
diff changeset
    49
    /**
hgs
parents:
diff changeset
    50
     * Destructor
hgs
parents:
diff changeset
    51
     */
hgs
parents:
diff changeset
    52
    ~DTraceCoreOstLddIf();
hgs
parents:
diff changeset
    53
    
hgs
parents:
diff changeset
    54
    /**
hgs
parents:
diff changeset
    55
     * Initializes this interface
hgs
parents:
diff changeset
    56
     * 
hgs
parents:
diff changeset
    57
     * @param aCallback Callback interface which is notified when a message is received from the XTI driver
hgs
parents:
diff changeset
    58
     */
hgs
parents:
diff changeset
    59
	TInt Init( MTraceCoreMediaIfCallback& aCallback );
hgs
parents:
diff changeset
    60
	
hgs
parents:
diff changeset
    61
	/**
hgs
parents:
diff changeset
    62
	 * Sends a message
hgs
parents:
diff changeset
    63
	 *
hgs
parents:
diff changeset
    64
	 * @param aMessage The message to be sent
hgs
parents:
diff changeset
    65
	 */
hgs
parents:
diff changeset
    66
	TInt Send( TTraceMessage &aMessage );
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
	/**
hgs
parents:
diff changeset
    69
	 * 
hgs
parents:
diff changeset
    70
	 * @param aFunc Function choosed (@see ETraceCoreOstLddIfGetSet)
hgs
parents:
diff changeset
    71
	 * @return TDfc* if aFunc is EGetDfc, TDes8* EGetBuf and 0 with ESetWriter.
hgs
parents:
diff changeset
    72
	 */
hgs
parents:
diff changeset
    73
	IMPORT_C static TUint32 GetSet(TTraceCoreOstLddIfGetSet aFunc, TUint32 aParam);
hgs
parents:
diff changeset
    74
	
hgs
parents:
diff changeset
    75
private:
hgs
parents:
diff changeset
    76
    
hgs
parents:
diff changeset
    77
    /**
hgs
parents:
diff changeset
    78
     * DFC function for incoming data from XTI driver
hgs
parents:
diff changeset
    79
     */
hgs
parents:
diff changeset
    80
    static void ReceiveDfc( TAny* aPtr );
hgs
parents:
diff changeset
    81
    
hgs
parents:
diff changeset
    82
    /**
hgs
parents:
diff changeset
    83
     * Called from the static DFC function to process incoming data
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
    void ReceiveDfc();
hgs
parents:
diff changeset
    86
    
hgs
parents:
diff changeset
    87
    /**
hgs
parents:
diff changeset
    88
     * Forwards incoming message to callback
hgs
parents:
diff changeset
    89
     */
hgs
parents:
diff changeset
    90
    void NotifyCallback();
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
     * Sends message to XTI
hgs
parents:
diff changeset
    94
     * 
hgs
parents:
diff changeset
    95
     * @param aMsg Message to be sent.
hgs
parents:
diff changeset
    96
     * @return KErrNone if send successful
hgs
parents:
diff changeset
    97
     */
hgs
parents:
diff changeset
    98
    void SendData( TTraceMessage& aMsg );
hgs
parents:
diff changeset
    99
   
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
    * Similar to send, except does not generate traces, since they would loop back to this function
hgs
parents:
diff changeset
   102
    * 
hgs
parents:
diff changeset
   103
    * @param aMsg Message to be sent.
hgs
parents:
diff changeset
   104
    * @return KErrNone if send successful
hgs
parents:
diff changeset
   105
    */
hgs
parents:
diff changeset
   106
    TInt SendTrace( const TDesC8& aMsg );
hgs
parents:
diff changeset
   107
    
hgs
parents:
diff changeset
   108
private:
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
    /**
hgs
parents:
diff changeset
   111
     * DFC which is used for incoming ISI-messages
hgs
parents:
diff changeset
   112
     */
hgs
parents:
diff changeset
   113
    TDfc iReceiveDfc;
hgs
parents:
diff changeset
   114
    
hgs
parents:
diff changeset
   115
    /**
hgs
parents:
diff changeset
   116
     * ISA Kernel IF Initialisation status
hgs
parents:
diff changeset
   117
     */
hgs
parents:
diff changeset
   118
    TInt iStatus;
hgs
parents:
diff changeset
   119
    
hgs
parents:
diff changeset
   120
    /** 
hgs
parents:
diff changeset
   121
     * Length variable for ISA Kernel interface usage
hgs
parents:
diff changeset
   122
     */
hgs
parents:
diff changeset
   123
    TUint16 iNeededLength;
hgs
parents:
diff changeset
   124
    
hgs
parents:
diff changeset
   125
    TBool iTraceCoreOstConnectionRegistered;
hgs
parents:
diff changeset
   126
    
hgs
parents:
diff changeset
   127
     /**
hgs
parents:
diff changeset
   128
     * Buffer for sending data
hgs
parents:
diff changeset
   129
     **/
hgs
parents:
diff changeset
   130
    TBuf8< 8204 > iSendBuffer;
hgs
parents:
diff changeset
   131
       
hgs
parents:
diff changeset
   132
    /**
hgs
parents:
diff changeset
   133
     * Buffer for incoming data
hgs
parents:
diff changeset
   134
     **/
hgs
parents:
diff changeset
   135
    TBuf8< 8204 > iReceiveBuffer;
hgs
parents:
diff changeset
   136
    
hgs
parents:
diff changeset
   137
    /**
hgs
parents:
diff changeset
   138
     * Pointer to TraceCoreOstConnectionIf
hgs
parents:
diff changeset
   139
     **/
hgs
parents:
diff changeset
   140
    MTraceCoreOstConnectionIf *iTraceCoreOstConnection;
hgs
parents:
diff changeset
   141
    
hgs
parents:
diff changeset
   142
    };
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
#endif // __TraceCoreOstLddIf_H__
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
// End of File