sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Definition of some macros that can be used for simple profiling device drivers etc. They are for use from kernel side only.
sl@0: // The macros create timestamped entries in the BTrace log buffer, see <e32BTrace.h> for details.
sl@0: // Note that for the succcessfull logging category BTrace::EKernPerfLog shall be enabled along with whole tracing.
sl@0: // See "BTrace" and "BTracemode" keywords in appropriate "header.iby" file.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef KERN_PERF_LOGGER_H
sl@0: #define KERN_PERF_LOGGER_H
sl@0: 
sl@0: 
sl@0: #ifdef __KERNEL_MODE__
sl@0: 
sl@0: #include <e32btrace.h>
sl@0: 
sl@0: 
sl@0: /*
sl@0: Logging with zero user data parameters.
sl@0: The trace will consist of: Fast Counter Timestamp, Context, PC value and Tick Count
sl@0: 
sl@0: @param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
sl@0: */
sl@0: #define PERF_LOG0(aSubCategory)  BTraceContextPc4(BTrace::EKernPerfLog, (aSubCategory), NKern::TickCount())
sl@0: 
sl@0: 
sl@0: /*
sl@0: Logging with one user data word parameter.
sl@0: The trace will consist of: Fast Counter Timestamp, Context, PC value, aUserData value and Tick Count
sl@0: 
sl@0: 
sl@0: @param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
sl@0: @param  aUserData       32-bit user data
sl@0: */
sl@0: #define PERF_LOG1(aSubCategory,aUserData)   BTraceContextPc8(BTrace::EKernPerfLog, (aSubCategory), (aUserData),  NKern::TickCount())
sl@0: 
sl@0: 
sl@0: /*
sl@0: Logging with 2 user data words parameters.
sl@0: The trace will consist of: Fast Counter Timestamp, Context, PC value, aUserData, aUserData2 values and Tick Count
sl@0: 
sl@0: 
sl@0: @param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
sl@0: @param  aUserData       32-bit user data, word 1
sl@0: @param  aUserData2      32-bit user data, word 2
sl@0: */
sl@0: #define PERF_LOG2(aSubCategory,aUserData,aUserData2)   BTraceContextPc12(BTrace::EKernPerfLog, (aSubCategory), (aUserData), (aUserData2), NKern::TickCount())
sl@0: 
sl@0: 
sl@0: /** default trace, just for simplicity */
sl@0: #define PERF_LOG PERF_LOG2
sl@0: 
sl@0: 
sl@0: 
sl@0: #endif //__KERNEL_MODE__
sl@0: 
sl@0: #endif //KERN_PERF_LOGGER_H
sl@0: 
sl@0: