1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/kernelhwsrv/kernel/eka/include/kernperflogger.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,77 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +// Definition of some macros that can be used for simple profiling device drivers etc. They are for use from kernel side only.
    1.18 +// The macros create timestamped entries in the BTrace log buffer, see <e32BTrace.h> for details.
    1.19 +// Note that for the succcessfull logging category BTrace::EKernPerfLog shall be enabled along with whole tracing.
    1.20 +// See "BTrace" and "BTracemode" keywords in appropriate "header.iby" file.
    1.21 +// 
    1.22 +//
    1.23 +
    1.24 +/**
    1.25 + @file
    1.26 + @publishedPartner
    1.27 + @released
    1.28 +*/
    1.29 +
    1.30 +#ifndef KERN_PERF_LOGGER_H
    1.31 +#define KERN_PERF_LOGGER_H
    1.32 +
    1.33 +
    1.34 +#ifdef __KERNEL_MODE__
    1.35 +
    1.36 +#include <e32btrace.h>
    1.37 +
    1.38 +
    1.39 +/*
    1.40 +Logging with zero user data parameters.
    1.41 +The trace will consist of: Fast Counter Timestamp, Context, PC value and Tick Count
    1.42 +
    1.43 +@param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
    1.44 +*/
    1.45 +#define PERF_LOG0(aSubCategory)  BTraceContextPc4(BTrace::EKernPerfLog, (aSubCategory), NKern::TickCount())
    1.46 +
    1.47 +
    1.48 +/*
    1.49 +Logging with one user data word parameter.
    1.50 +The trace will consist of: Fast Counter Timestamp, Context, PC value, aUserData value and Tick Count
    1.51 +
    1.52 +
    1.53 +@param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
    1.54 +@param  aUserData       32-bit user data
    1.55 +*/
    1.56 +#define PERF_LOG1(aSubCategory,aUserData)   BTraceContextPc8(BTrace::EKernPerfLog, (aSubCategory), (aUserData),  NKern::TickCount())
    1.57 +
    1.58 +
    1.59 +/*
    1.60 +Logging with 2 user data words parameters.
    1.61 +The trace will consist of: Fast Counter Timestamp, Context, PC value, aUserData, aUserData2 values and Tick Count
    1.62 +
    1.63 +
    1.64 +@param  aSubCategory    8-bit  integer that specifies logging subcategory. Logging category is BTrace::EKernPerfLog
    1.65 +@param  aUserData       32-bit user data, word 1
    1.66 +@param  aUserData2      32-bit user data, word 2
    1.67 +*/
    1.68 +#define PERF_LOG2(aSubCategory,aUserData,aUserData2)   BTraceContextPc12(BTrace::EKernPerfLog, (aSubCategory), (aUserData), (aUserData2), NKern::TickCount())
    1.69 +
    1.70 +
    1.71 +/** default trace, just for simplicity */
    1.72 +#define PERF_LOG PERF_LOG2
    1.73 +
    1.74 +
    1.75 +
    1.76 +#endif //__KERNEL_MODE__
    1.77 +
    1.78 +#endif //KERN_PERF_LOGGER_H
    1.79 +
    1.80 +