1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/kernelhwsrv/kernel/eka/include/e32utrace.inl	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,105 @@
     1.4 +/**
     1.5 +* Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Trace API
    1.19 +* ---------------TTraceContext-----------------------
    1.20 +*
    1.21 +*/
    1.22 +
    1.23 +
    1.24 +
    1.25 +
    1.26 +/**
    1.27 + @file
    1.28 + @publishedPartner
    1.29 + @prototype
    1.30 + 
    1.31 + Define the context of a trace packet by setting its attributes.
    1.32 + 
    1.33 + The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
    1.34 + The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
    1.35 + The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
    1.36 + 
    1.37 + @param aClassification 	@see TClassification
    1.38 + 
    1.39 +*/
    1.40 +TTraceContext::TTraceContext(const TClassification aClassification)
    1.41 +:iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
    1.42 +	{
    1.43 +	}
    1.44 +
    1.45 +/**
    1.46 + * Define the context of a trace packet by setting its attributes.
    1.47 + *
    1.48 + * The HasThreadIdentification is defaulted to the FW_DEFAULT_HAS_THREAD_IDENTIFICATION definition.
    1.49 + * The HasProgramCounter is defaulted to the FW_DEFAULT_HAS_PC definition.
    1.50 + * 
    1.51 + * @param aModuleUid		@see TModuleUid
    1.52 + * @param aClassification	@see TClassification
    1.53 + */
    1.54 +TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification)
    1.55 +:iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(FW_DEFAULT_HAS_THREAD_IDENTIFICATION), iHasProgramCounter(FW_DEFAULT_HAS_PC), iReserved1(0), iReserved2(0)
    1.56 +	{
    1.57 +	}
    1.58 +
    1.59 +/**
    1.60 + * Define the context of a trace packet by setting its attributes.
    1.61 + * 
    1.62 + * The module UID is defaulted according to the FW_DEFAULT_MODULEUID definition.
    1.63 + * 
    1.64 + * @param aClassification 	@see TClassification
    1.65 + * @param aHasThreadIdentification	Set whether to add thread identification automatically in the trace packet.
    1.66 + * @param aHasProgramCounter			Set whether to add PC (program counter) automatically in the trace packet.
    1.67 + */
    1.68 +TTraceContext::TTraceContext(const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
    1.69 +:iModuleUid(FW_DEFAULT_MODULEUID), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
    1.70 +	{
    1.71 +	}
    1.72 +
    1.73 +
    1.74 +/**
    1.75 + * Define the context of a trace packet by setting its attributes.
    1.76 + *
    1.77 + * @param aModuleUid 		@see TModuleUid
    1.78 + * @param aClassification 	@see TClassification
    1.79 + * @param aHasThreadIdentification	Set whether to add thread identification automatically in the trace packet.
    1.80 + * @param aHasProgramCounter		Set whether to add PC (program counter) automatically in the trace packet.
    1.81 + */
    1.82 +TTraceContext::TTraceContext(const TModuleUid aModuleUid, const TClassification aClassification, const THasThreadIdentification aHasThreadIdentification, const THasProgramCounter aHasProgramCounter)
    1.83 +:iModuleUid(aModuleUid), iClassification(aClassification), iHasThreadIdentification(aHasThreadIdentification), iHasProgramCounter(aHasProgramCounter), iReserved1(0), iReserved2(0)
    1.84 +	{
    1.85 +	}
    1.86 +
    1.87 +//------------------ Trace -----------------------
    1.88 +/**
    1.89 +Outputs a trace packet containing variable length data.
    1.90 +
    1.91 +If the specified data is too big to fit into a single
    1.92 +trace record a multipart trace is generated.
    1.93 +
    1.94 +@param aContext 	Attributes of the trace point. 
    1.95 +@param aFormatId	A format identifier as specified by @see TFormatId
    1.96 +@param aData		Additional data to add to trace packet.
    1.97 +					Must be word aligned, i.e. a multiple of 4.
    1.98 +
    1.99 +@return 			The trace packet was/was not logged.
   1.100 +
   1.101 +@See BTrace::TMultipart
   1.102 +*/
   1.103 +template<typename T>
   1.104 +TBool Trace(const TTraceContext& aContext, TFormatId aFormatId, const T& aData)
   1.105 +	{
   1.106 +	return Trace(aContext, aFormatId, &aData, sizeof(aData));
   1.107 +	}
   1.108 +