Symaptic: os/kernelhwsrv/kernel/eka/include/e32btrace.h@260cb5ec6c19 (annotated)

sl@0	1	// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0	2	// All rights reserved.
sl@0	3	// This component and the accompanying materials are made available
sl@0	4	// under the terms of the License "Eclipse Public License v1.0"
sl@0	5	// which accompanies this distribution, and is available
sl@0	6	// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0	7	//
sl@0	8	// Initial Contributors:
sl@0	9	// Nokia Corporation - initial contribution.
sl@0	10	//
sl@0	11	// Contributors:
sl@0	12	//
sl@0	13	// Description:
sl@0	14	// e32\include\e32btrace.h
sl@0	15	//
sl@0	16	// WARNING: This file contains some APIs which are internal and are subject
sl@0	17	// to change without notice. Such APIs should therefore not be used
sl@0	18	// outside the Kernel and Hardware Services package.
sl@0	19	//
sl@0	20
sl@0	21	#ifndef E32BTRACE_H
sl@0	22	#define E32BTRACE_H
sl@0	23
sl@0	24	#ifdef __KERNEL_MODE__
sl@0	25	class TSpinLock;
sl@0	26	#endif
sl@0	27
sl@0	28	/**
sl@0	29	Class for handling fast tracing.
sl@0	30
sl@0	31	A trace record consists of three parts: a header, header extensions,
sl@0	32	and the trace data itself.
sl@0	33
sl@0	34	The header consists of four bytes containing:
sl@0	35
sl@0	36	-# Size of the record in bytes. (Maximum value is KMaxBTraceRecordSize.)
sl@0	37	-# Flags. See enum TFlags.
sl@0	38	-# Category. Category value from enum BTrace::TCategory.
sl@0	39	-# Sub-category. The meaning of this is dependent on the value of Category.
sl@0	40
sl@0	41	When trace records are stored in memory they are stored word (32 bit) aligned.
sl@0	42	Therefore the size must be rounded up to a multiple of four when calculating
sl@0	43	the address of the next record. E.g.
sl@0	44	@code
sl@0	45	TUint8* record; // pointer to trace record
sl@0	46	TInt size = record[BTrace::ESizeIndex];
sl@0	47	record += (size+3)&~3; // move record pointer on to next record.
sl@0	48	@endcode
sl@0	49	The NextRecord() method is provided to do this operation.
sl@0	50
sl@0	51	Following the header are optionally a number of 32 bit 'header extension' values.
sl@0	52	These are present in the order shown below but only exist if the appropriate flag bit
sl@0	53	is set in the Header.
sl@0	54
sl@0	55	-# Header2. Contains flag values from enum Flags2.
sl@0	56	This value is only present if the EHeader2Present flag is set.
sl@0	57	-# Timestamp. A timestamp value indicating when the trace was generated.
sl@0	58	The format and resolution of this value are platform-dependent, but
sl@0	59	typically will contain the same values as would be returned by
sl@0	60	User::FastCounter() or NKern::FastCounter().
sl@0	61	This value is only present if the ETimestampPresent flag is set.
sl@0	62	-# Timestamp2. Additional timestamp information. E.g. the most significant
sl@0	63	half of a 64bit timestamp value. Note, it is valid for a Timestamp2 value
sl@0	64	to be present even if the previous Timestamp is absent.
sl@0	65	This value is only present if the ETimestamp2Present flag is set.
sl@0	66	-# Context ID. This value indicates the context in which the trace was generated.
sl@0	67	The meaning of the id is dependent on the contents of the two
sl@0	68	least significant bits:
sl@0	69	- 00 indicates the value is the address of the NThread object for
sl@0	70	the currently executing thread.
sl@0	71	- 01 indicates Fast Interrupt (FIQ) context.
sl@0	72	Other bits of the value are currently reserved for future use.
sl@0	73	- 10 indicates Interrupt (IRQ) context. Other bits of the value
sl@0	74	are currently reserved for future use.
sl@0	75	- 11 indicates Immediate Delayed Function Call (IDFC) context.
sl@0	76	Other bits of the value are currently reserved for future use.
sl@0	77	.
sl@0	78	This value is only present if the EContextIdPresent flag is set.
sl@0	79	-# Program Counter. This is the memory address of the instruction after the location
sl@0	80	the trace was output.
sl@0	81	This value is only present if the EPcPresent flag is set.
sl@0	82	-# Extra. An extra value used for different purposes depending on the trace type.
sl@0	83	This value is only present if the EExtraPresent flag is set.
sl@0	84
sl@0	85	Following the header extensions are 0 or more bytes of trace data specified when the trace
sl@0	86	was output.
sl@0	87
sl@0	88	To output a trace, the following macros can be used:
sl@0	89	- BTrace0
sl@0	90	- BTrace4
sl@0	91	- BTrace8
sl@0	92	- BTrace12
sl@0	93	- BTraceN
sl@0	94	- BTraceBig
sl@0	95	- BTracePc0
sl@0	96	- BTracePc4
sl@0	97	- BTracePc8
sl@0	98	- BTracePc12
sl@0	99	- BTracePcN
sl@0	100	- BTracePcBig
sl@0	101	- BTraceContext0
sl@0	102	- BTraceContext4
sl@0	103	- BTraceContext8
sl@0	104	- BTraceContext12
sl@0	105	- BTraceContextN
sl@0	106	- BTraceContextBig
sl@0	107	- BTraceContextPc0
sl@0	108	- BTraceContextPc4
sl@0	109	- BTraceContextPc8
sl@0	110	- BTraceContextPc12
sl@0	111	- BTraceContextPcN
sl@0	112	- BTraceContextPcBig
sl@0	113
sl@0	114	Whenever a trace is output, the trace handler is called with the arguments specified.
sl@0	115	See typedef THandler and SetHandler().
sl@0	116
sl@0	117	Each tracing category has a filter bit, which if set to zero means that traces in that category
sl@0	118	are discarded, see SetFilter(). This filtering is performed before the trace handler is
sl@0	119	called. This filter may also be initialised from boot time by using the 'btrace' keyword in
sl@0	120	an OBY file used to build a ROM image.
sl@0	121
sl@0	122	Traces may also be additionally sent through a second level of filtering. This examines the
sl@0	123	first 32 bits of data in the trace and if this value isn't present in the list maintained
sl@0	124	in the secondary filter, the trace is discarded. The contents of the secondary filter are
sl@0	125	set using the SetFilter2 methods.
sl@0	126
sl@0	127	Values used for secondary filtering must be Symbian Unique Identifiers (UIDs) allocated
sl@0	128	using the normal UID allocation process. Note, the following non-valid UID value ranges
sl@0	129	are reserved.
sl@0	130	- 0x00000000..0x007fffff Reserved for platform specific use.
sl@0	131	- 0x00800000..0x00ffffff Reserved for use by Symbian.
sl@0	132
sl@0	133	To generate traces which are to be processed by the secondary filter, the following
sl@0	134	macros can be used:
sl@0	135
sl@0	136	- BTraceFiltered4
sl@0	137	- BTraceFiltered8
sl@0	138	- BTraceFiltered12
sl@0	139	- BTraceFilteredN
sl@0	140	- BTraceFilteredBig
sl@0	141	- BTraceFilteredPc4
sl@0	142	- BTraceFilteredPc8
sl@0	143	- BTraceFilteredPc12
sl@0	144	- BTraceFilteredPcN
sl@0	145	- BTraceFilteredPcBig
sl@0	146	- BTraceFilteredContext4
sl@0	147	- BTraceFilteredContext8
sl@0	148	- BTraceFilteredContext12
sl@0	149	- BTraceFilteredContextN
sl@0	150	- BTraceFilteredContextBig
sl@0	151	- BTraceFilteredContextPc4
sl@0	152	- BTraceFilteredContextPc8
sl@0	153	- BTraceFilteredContextPc12
sl@0	154	- BTraceFilteredContextPcN
sl@0	155	- BTraceFilteredContextPcBig
sl@0	156
sl@0	157	Traces generated using the above methods will be filtered twice; once using the primary
sl@0	158	filter which checks the trace's category, and once using the secondary filter which checks
sl@0	159	the 32 bit UID value at the start of the trace data. Therefore the trace must pass both filter
sl@0	160	checks for it to be sent to the trace handler for output.
sl@0	161
sl@0	162	@publishedPartner
sl@0	163	@released
sl@0	164	*/
sl@0	165	class BTrace
sl@0	166	{
sl@0	167	public:
sl@0	168	/**
sl@0	169	Byte indices into the trace header for specific fields.
sl@0	170	*/
sl@0	171	enum THeaderStructure
sl@0	172	{
sl@0	173	/**
sl@0	174	Size of record in bytes.
sl@0	175	*/
sl@0	176	ESizeIndex = 0,
sl@0	177
sl@0	178	/**
sl@0	179	Bitfield of flags from enum TFlags. E.g. to detect if a timestamp is present in
sl@0	180	the record, code like this could be used.
sl@0	181	@code
sl@0	182	TUint8* record; // pointer to trace record
sl@0	183	if(record[BTrace::EFlagsIndex]&BTrace::ETimestampPresent)
sl@0	184	TimestampPresent();
sl@0	185	else
sl@0	186	TimestampNotPresent();
sl@0	187	@endcode
sl@0	188	*/
sl@0	189	EFlagsIndex = 1,
sl@0	190
sl@0	191	/**
sl@0	192	Category value from enum BTrace::TCategory.
sl@0	193	*/
sl@0	194	ECategoryIndex = 2,
sl@0	195
sl@0	196	/**
sl@0	197	Sub-category value. The meaning of this is dependent on the Category.
sl@0	198	*/
sl@0	199	ESubCategoryIndex = 3,
sl@0	200	};
sl@0	201
sl@0	202	/**
sl@0	203	Bit flags which indicate state of a trace record.
sl@0	204	*/
sl@0	205	enum TFlags
sl@0	206	{
sl@0	207	/**
sl@0	208	Header2 is present in the trace record.
sl@0	209	*/
sl@0	210	EHeader2Present = 1<<0,
sl@0	211
sl@0	212	/**
sl@0	213	A timestamp value is present in the trace record.
sl@0	214	*/
sl@0	215	ETimestampPresent = 1<<1,
sl@0	216
sl@0	217	/**
sl@0	218	A second timestamp value is present in the trace record.
sl@0	219	*/
sl@0	220	ETimestamp2Present = 1<<2,
sl@0	221
sl@0	222	/**
sl@0	223	A context ID is present in the trace record.
sl@0	224	*/
sl@0	225	EContextIdPresent = 1<<3,
sl@0	226
sl@0	227	/**
sl@0	228	A CPU program counter (PC) value is present in the trace record.
sl@0	229	*/
sl@0	230	EPcPresent = 1<<4,
sl@0	231
sl@0	232	/**
sl@0	233	An 'extra' value is present in the trace record.
sl@0	234	*/
sl@0	235	EExtraPresent = 1<<5,
sl@0	236
sl@0	237	/**
sl@0	238	Indicates that the data in this trace record was truncated to keep the size
sl@0	239	within the maximum permissible.
sl@0	240	*/
sl@0	241	ERecordTruncated = 1<<6,
sl@0	242
sl@0	243	/**
sl@0	244	Indicates that trace record(s) before this one are missing.
sl@0	245	This can happen if the trace buffer was full when a trace output was attempted.
sl@0	246	*/
sl@0	247	EMissingRecord = 1<<7
sl@0	248	};
sl@0	249
sl@0	250	/**
sl@0	251	Bit flags present in the Flags2 value of the header extension.
sl@0	252	*/
sl@0	253	enum TFlags2
sl@0	254	{
sl@0	255	/**
sl@0	256	Masks out the bits for the multipart trace type. (See enum TMultiPart.)
sl@0	257	*/
sl@0	258	EMultipartFlagMask = 3<<0,
sl@0	259
sl@0	260	/**
sl@0	261	Masks out the bits for the CPU ID for SMP systems (zero if present on non SMP systems)
sl@0	262	*/
sl@0	263	ECpuIdMask = 0xfff<<20,
sl@0	264	};
sl@0	265
sl@0	266	/**
sl@0	267	Values for multipart trace indicator. These values are stored in Flags2 an
sl@0	268	are obtained by ANDing with the value EMultipartFlagMask.
sl@0	269
sl@0	270	If a 'Big' trace is generated which doesn't fit into a single trace record
sl@0	271	then its data is split into several separate trace records; a multipart trace.
sl@0	272
sl@0	273	In multipart traces the 'extra' trace value is present in the header extension.
sl@0	274	(EExtraPresent is set.) This extra value contains a unique trace identifier
sl@0	275	which is the same is all parts of the trace.
sl@0	276
sl@0	277	The structure of the data part of each trace record in a multipart trace is described
sl@0	278	below. In this description, the following labels are used.
sl@0	279	- A is the initial 4 bytes of data; the a1 argument of BTraceBig.
sl@0	280	- D is the array of bytes of additional data; the aData argument of BTraceBig.
sl@0	281	- N is the size of D; the aDataSize argument of BTraceBig
sl@0	282	- X is the maximum number of additional bytes which will fit into a trace record.
sl@0	283	This is usually KMaxBTraceDataArray but this should not be assumed, instead
sl@0	284	the size and other information present in each trace record should be examined.
sl@0	285
sl@0	286	For the first part of a multipart trace, the data in a trace record has the following
sl@0	287	structure:
sl@0	288
sl@0	289	- 4 bytes containing N.
sl@0	290	- 4 bytes containing A.
sl@0	291	- X bytes containing D[0..X-1]
sl@0	292
sl@0	293	If the parts are numbered 0 through to 'j', then a middle part of a multipart trace
sl@0	294	is numbered 'i' where 0<i<j. The data in these parts has the structure:
sl@0	295
sl@0	296	- 4 bytes containing N.
sl@0	297	- 4 bytes containing X*i. I.e. the offset within D for the data in this trace record.
sl@0	298	- X bytes containing D[Xi..Xi+X-1]
sl@0	299
sl@0	300	For the last part of a multipart trace, the data has the structure:
sl@0	301
sl@0	302	- 4 bytes containing N.
sl@0	303	- 4 bytes containing X*j. I.e. the offset within D for the data in this trace record.
sl@0	304	- N modulo X bytes containing D[X*j..N-1]. I.e. the final bytes of the trace data.
sl@0	305	*/
sl@0	306	enum TMultiPart
sl@0	307	{
sl@0	308	/**
sl@0	309	Indicates that this trace is the first part of a multipart trace.
sl@0	310	*/
sl@0	311	EMultipartFirst = 1,
sl@0	312
sl@0	313	/**
sl@0	314	Indicates that this trace is a middle part of a multipart trace.
sl@0	315	I.e. it is not the first or last part.
sl@0	316	*/
sl@0	317	EMultipartMiddle = 2,
sl@0	318
sl@0	319	/**
sl@0	320	Indicates that this trace is the last part of a multipart trace.
sl@0	321	*/
sl@0	322	EMultipartLast = 3,
sl@0	323	};
sl@0	324
sl@0	325	/**
sl@0	326	Enumeration of trace categories.
sl@0	327	*/
sl@0	328	enum TCategory
sl@0	329	{
sl@0	330	/**
sl@0	331	Trace generated by all calls to RDebug::Printf.
sl@0	332
sl@0	333	The first 4 bytes of trace data contain the thread ID, RThread::Id(), for the
sl@0	334	thread which caused this trace to be emitted. If the trace wasn't generated in
sl@0	335	thread context, this id has the value KNullThreadId.
sl@0	336
sl@0	337	Subsequent bytes of data contain the ASCII text for the formatted string
sl@0	338	generated by Kern::Printf.
sl@0	339
sl@0	340	These traces also contain a context ID, i.e. the EContextIdPresent flag is
sl@0	341	set and a context ID value is present in the extended header.
sl@0	342
sl@0	343	If the trace text doesn't fit completely into one trace record, then
sl@0	344	a multipart trace is generated. See enum TMultiPart.
sl@0	345	*/
sl@0	346	ERDebugPrintf = 0,
sl@0	347
sl@0	348	/**
sl@0	349	Trace generated by all calls to Kern::Printf.
sl@0	350	Trace records in this category have the same structure as ERDebugPrintf.
sl@0	351	*/
sl@0	352	EKernPrintf = 1,
sl@0	353
sl@0	354	/**
sl@0	355	Trace generated by platform security diagnostic messages.
sl@0	356	Trace records in this category have the same structure as ERDebugPrintf.
sl@0	357	*/
sl@0	358	EPlatsecPrintf = 2,
sl@0	359
sl@0	360	/**
sl@0	361	Trace generated for the purpose of associating thread context ids with
sl@0	362	the textual names of threads. These traces are usually generated when a
sl@0	363	thread is created, renamed or destroyed.
sl@0	364
sl@0	365	If #Prime is called with this category, traces will be generated for all
sl@0	366	threads currently extant.
sl@0	367
sl@0	368	@see enum TThreadIdentification
sl@0	369	*/
sl@0	370	EThreadIdentification = 3,
sl@0	371
sl@0	372	/**
sl@0	373	Trace generated when the CPU usage changes state, e.g. at thread context switch
sl@0	374	or during interrupt and DFC processing.
sl@0	375
sl@0	376	The purpose of this trace category is to profile CPU usage.
sl@0	377
sl@0	378	@see enum TCpuUsage
sl@0	379	*/
sl@0	380	ECpuUsage = 4,
sl@0	381
sl@0	382	/**
sl@0	383	Category used for profiling device drivers, kernel extensions etc.
sl@0	384	Used by PERF_LOG macro.
sl@0	385	@prototype 9.3
sl@0	386	*/
sl@0	387	EKernPerfLog = 5,
sl@0	388
sl@0	389	/**
sl@0	390	Trace generated when client-server activity takes place such as server creation,
sl@0	391	session management, message handling, etc.
sl@0	392
sl@0	393	If #Prime is called with this category, traces will be generated for all
sl@0	394	servers currently running and their sessions.
sl@0	395	*/
sl@0	396	EClientServer = 6,
sl@0	397
sl@0	398	/**
sl@0	399	Trace generated on thread request completion.
sl@0	400	*/
sl@0	401	ERequests = 7,
sl@0	402
sl@0	403	/**
sl@0	404	Trace generated when chunks are created and destroyed, and when memory
sl@0	405	is committed and decommitted to and from chunks.
sl@0	406
sl@0	407	If #Prime is called with this category, traces will be generated for all
sl@0	408	chunks currently extant.
sl@0	409
sl@0	410	@see TChunks
sl@0	411	*/
sl@0	412	EChunks = 8,
sl@0	413
sl@0	414	/**
sl@0	415	Trace generated when code segments are created and destroyed, mapped
sl@0	416	into out of processes, and when memory is committed and decommitted to
sl@0	417	and from them.
sl@0	418
sl@0	419	If #Prime is called with this category, traces will be generated for all
sl@0	420	code segments currently extant.
sl@0	421
sl@0	422	@see TCodeSegs
sl@0	423	*/
sl@0	424	ECodeSegs = 9,
sl@0	425
sl@0	426	/**
sl@0	427	Trace generated by Demand Paging.
sl@0	428	@prototype 9.3
sl@0	429	*/
sl@0	430	EPaging = 10,
sl@0	431
sl@0	432	/**
sl@0	433	Trace generated when thread and process priorities are modified, whether
sl@0	434	directly or through priority inheritance, aging or other mechanisms used
sl@0	435	by the kernel.
sl@0	436
sl@0	437	The purpose of this category is to enable system-wide study of thread
sl@0	438	priority usage.
sl@0	439
sl@0	440	If #Prime is called with this category, traces will be generated for all
sl@0	441	threads currently extant.
sl@0	442
sl@0	443	@see enum TThreadPriority
sl@0	444	@internalTechnology
sl@0	445	@prototype 9.3
sl@0	446	*/
sl@0	447	EThreadPriority = 11,
sl@0	448
sl@0	449	/**
sl@0	450	Trace generated by processing Paging requests in the Media subsystem and Media drivers.
sl@0	451	@prototype 9.3
sl@0	452	*/
sl@0	453	EPagingMedia = 12,
sl@0	454
sl@0	455	/**
sl@0	456	Trace generated by the kernel for memory regions which don't belong to any chunk.
sl@0	457	@see enum TKernelMemory
sl@0	458	@prototype 9.4
sl@0	459	*/
sl@0	460	EKernelMemory = 13,
sl@0	461
sl@0	462	/**
sl@0	463	Trace generated by user-mode heap usage.
sl@0	464
sl@0	465	Unlike other trace categories, capturing heap trace involves an additional step
sl@0	466	depending on how much trace is required. To enable heap trace for a single process
sl@0	467	from the moment it starts, add the following line to the .exe's project (.mmp) file:
sl@0	468
sl@0	469	firstlib eexe_instrumented_heap.lib
sl@0	470
sl@0	471	This overrides the build tools default implicit link (for .exe projects) against eexe.lib.
sl@0	472
sl@0	473	Alternatively, to enable heap trace for all processes at once you can enable the
sl@0	474	KUSERHEAPTRACE bit (#96) of the kernel trace flags. You can set this flag either at
sl@0	475	ROM-building time (look for the 'kerneltrace' line generally in \epoc32\rom\<platform>\header.iby)
sl@0	476	or at runtime by running the following at the Eshell command prompt:
sl@0	477
sl@0	478	trace 0 0 1
sl@0	479
sl@0	480	Note that changing this flag at runtime only affects processes created after the flag
sl@0	481	is set or unset. It will not affect running processes.
sl@0	482
sl@0	483	@see enum THeap
sl@0	484	@prototype 9.4
sl@0	485	*/
sl@0	486	EHeap = 14,
sl@0	487
sl@0	488	/**
sl@0	489	Meta trace. Trace that is only useful to programs which use or display BTrace-based data.
sl@0	490	@see enum TMetaTrace
sl@0	491	@prototype 9.4
sl@0	492	*/
sl@0	493	EMetaTrace = 15,
sl@0	494
sl@0	495	/**
sl@0	496	Trace generated by the ram allocator to allow the physical layout of RAM
sl@0	497	to be tracked.
sl@0	498	@internalTechnology
sl@0	499	*/
sl@0	500	ERamAllocator = 16,
sl@0	501
sl@0	502	/**
sl@0	503	Trace generated by the Fast Mutex in the Nkern.
sl@0	504	*/
sl@0	505	EFastMutex = 17,
sl@0	506
sl@0	507
sl@0	508	/**
sl@0	509	Trace generated by any sampling profiler.
sl@0	510	@see enum TProfiling
sl@0	511	*/
sl@0	512	EProfiling = 18,
sl@0	513
sl@0	514	/**
sl@0	515	Trace generated by Power Resource Manager.
sl@0	516	@prototype 9.5
sl@0	517	*/
sl@0	518	EResourceManager = 19,
sl@0	519
sl@0	520
sl@0	521	/**
sl@0	522	Trace generated by Power Resource Manager User-Side API.
sl@0	523	@prototype 9.5
sl@0	524	*/
sl@0	525	EResourceManagerUs = 20,
sl@0	526
sl@0	527	/**
sl@0	528	Trace generated by Raw Event subsystem APIs
sl@0	529	@see enum TRawEventTrace
sl@0	530	@prototype 9.5
sl@0	531	*/
sl@0	532	ERawEvent =21,
sl@0	533
sl@0	534	/**
sl@0	535	Trace generated by USB communications (Client, Host and OTG) where use
sl@0	536	of standard logging (conditional Kern::Printf() calls) is sufficiently
sl@0	537	time-consuming that the required device timings mandated by the core
sl@0	538	USB standards cannot be achieved
sl@0	539	@prototype 9.5
sl@0	540	*/
sl@0	541	EUsb = 22,
sl@0	542
sl@0	543	/**
sl@0	544	Trace generated by Symbian OS kernel synchronization objects.
sl@0	545	@prototype 9.5
sl@0	546	*/
sl@0	547	ESymbianKernelSync = 23,
sl@0	548
sl@0	549	/**
sl@0	550	Trace generated by the flexible memory model.
sl@0	551	*/
sl@0	552	EFlexibleMemModel = 24,
sl@0	553
sl@0	554	/**
sl@0	555	Trace generated by IIC bus.
sl@0	556	@prototype 9.6
sl@0	557	*/
sl@0	558	EIic = 25,
sl@0	559
sl@0	560	/**
sl@0	561	First category value in the range reserved for platform specific use;
sl@0	562	the end of this range is #EPlatformSpecificLast.
sl@0	563	Symbian's code will not generate any traces with categories in this range.
sl@0	564
sl@0	565	It is strongly recommended that platforms reserve the first half of this range
sl@0	566	(128..143) for definition and use by base-port (kernel-side) code. Any general
sl@0	567	trace framework built on top of BTrace APIs should use the second half of the range.
sl@0	568	This allows fast (primary filtered only) BTrace categories to be used in device drivers
sl@0	569	and other base-port code, without clashing with more general trace frameworks implemented
sl@0	570	for application layer code.
sl@0	571	*/
sl@0	572	EPlatformSpecificFirst = 128,
sl@0	573
sl@0	574	/**
sl@0	575	Last category value in the range reserved for platform specific use.
sl@0	576	@see EPlatformSpecificFirst
sl@0	577	*/
sl@0	578	EPlatformSpecificLast = 191,
sl@0	579
sl@0	580	/**
sl@0	581	First category value in the range reserved for Symbian tools and future trace framework
sl@0	582	implementations; the end of this range is #ESymbianExtentionsLast.
sl@0	583	*/
sl@0	584	ESymbianExtentionsFirst = 192,
sl@0	585
sl@0	586	/**
sl@0	587	Last category value in the range reserved for Symbian tools and future trace framework
sl@0	588	implementations.
sl@0	589	@see ESymbianExtentionsFirst
sl@0	590	*/
sl@0	591	ESymbianExtentionsLast = 253,
sl@0	592
sl@0	593	/**
sl@0	594	Used for testing purposes.
sl@0	595
sl@0	596	This may be used for ad-hoc testing purposes, e.g. special builds of components
sl@0	597	with tracing enabled for diagnostic purposes.
sl@0	598
sl@0	599	This category is also used by the E32 BTrace unit tests.
sl@0	600	@test
sl@0	601	*/
sl@0	602	ETest1 = 254,
sl@0	603
sl@0	604	/**
sl@0	605	Used for testing purposes.
sl@0	606
sl@0	607	This may be used for ad-hoc testing purposes, e.g. special builds of components
sl@0	608	with tracing enabled for diagnostic purposes.
sl@0	609
sl@0	610	This category is also used by the E32 BTrace unit tests.
sl@0	611	@test
sl@0	612	*/
sl@0	613	ETest2 = 255
sl@0	614	};
sl@0	615
sl@0	616	/**
sl@0	617	Enumeration of sub-category values for trace category EThreadIdentification.
sl@0	618	@see EThreadIdentification
sl@0	619	*/
sl@0	620	enum TThreadIdentification
sl@0	621	{
sl@0	622	/**
sl@0	623	A nano-kernel thread (NThread) has been created.
sl@0	624
sl@0	625	Trace data format:
sl@0	626	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	627	*/
sl@0	628	ENanoThreadCreate,
sl@0	629
sl@0	630	/**
sl@0	631	A nano-kernel thread (NThread) has been destroyed.
sl@0	632
sl@0	633	Trace data format:
sl@0	634	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	635	*/
sl@0	636	ENanoThreadDestroy,
sl@0	637
sl@0	638	/**
sl@0	639	A thread (DThread) has been created.
sl@0	640
sl@0	641	Trace data format:
sl@0	642	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	643	- 4 bytes containing trace id (a DProcess*) for the process to which this thread belongs.
sl@0	644	- Remaining data is the ASCII name of the thread.
sl@0	645	*/
sl@0	646	EThreadCreate,
sl@0	647
sl@0	648	/**
sl@0	649	A thread (DThread) has been destroyed.
sl@0	650
sl@0	651	Trace data format:
sl@0	652	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	653	- 4 bytes containing trace id for the process to which this thread belongs.
sl@0	654	- 4 bytes containing thread ID, as returned by RThread::Id().
sl@0	655	*/
sl@0	656	EThreadDestroy,
sl@0	657
sl@0	658	/**
sl@0	659	A thread (DThread) has been renamed.
sl@0	660	This trace may also be output by the tracing system at initialisation
sl@0	661	in order to identify threads already in existence.
sl@0	662
sl@0	663	Trace data format:
sl@0	664	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	665	- 4 bytes containing trace id (a DProcess*) for the process to which this thread belongs.
sl@0	666	- Remaining data is the ASCII name of the thread.
sl@0	667	*/
sl@0	668	EThreadName,
sl@0	669
sl@0	670	/**
sl@0	671	A process has been renamed.
sl@0	672	This trace may also be output together with EThreadCreate or EThreadName traces
sl@0	673	to help identify the name of the process to which the thread belongs.
sl@0	674
sl@0	675	Trace data format:
sl@0	676	- 4 bytes containing zero, or if this trace is generated together with EThreadName
sl@0	677	or EThreadCreate, this contains the context id (an NThread*) for the thread.
sl@0	678	- 4 bytes containing trace id (a DProcess*) for process.
sl@0	679	- Remaining data is the ASCII name of the process.
sl@0	680	*/
sl@0	681	EProcessName,
sl@0	682
sl@0	683	/**
sl@0	684	Informational trace giving a threads ID, as returned by RThread::Id().
sl@0	685	Trace data format:
sl@0	686	- 4 bytes containing the context id (an NThread*) for this thread.
sl@0	687	- 4 bytes containing trace id (a DProcess*) for the process to which this thread belongs.
sl@0	688	- 4 bytes containing thread ID, as returned by RThread::Id().
sl@0	689	*/
sl@0	690	EThreadId,
sl@0	691
sl@0	692	/**
sl@0	693	A process has been created.
sl@0	694
sl@0	695	Trace data format:
sl@0	696	- 4 bytes containing trace id (a DProcess*) for the process.
sl@0	697	*/
sl@0	698	EProcessCreate,
sl@0	699
sl@0	700	/**
sl@0	701	A process has been destroyed.
sl@0	702
sl@0	703	Trace data format:
sl@0	704	- 4 bytes containing trace id (a DProcess*) for the process.
sl@0	705	*/
sl@0	706	EProcessDestroy
sl@0	707
sl@0	708	};
sl@0	709
sl@0	710	/**
sl@0	711	Enumeration of sub-category values for trace category ECpuUsage.
sl@0	712	@see ECpuUsage
sl@0	713	*/
sl@0	714	enum TCpuUsage
sl@0	715	{
sl@0	716	/**
sl@0	717	Trace output at start of Interrupt (IRQ) dispatch.
sl@0	718
sl@0	719	On platforms which support nested interrupts, traces for these will also
sl@0	720	be nested.
sl@0	721	*/
sl@0	722	EIrqStart,
sl@0	723
sl@0	724	/**
sl@0	725	Trace output at end of Interrupt (IRQ) dispatch.
sl@0	726
sl@0	727	Note, this trace isn't generated if an Interrupt Service Routine queues
sl@0	728	a DFC or causes a thread to be scheduled. In these cases, the traces for
sl@0	729	these events (EIDFCStart or ENewThreadContext) should be taken to indicate
sl@0	730	that interrupt servicing has ended.
sl@0	731	*/
sl@0	732	EIrqEnd,
sl@0	733
sl@0	734	/**
sl@0	735	Trace output at start of Fast Interrupt (FIQ) dispatch.
sl@0	736
sl@0	737	On platforms which support nested interrupts, traces for these will also
sl@0	738	be nested.
sl@0	739	*/
sl@0	740	EFiqStart,
sl@0	741
sl@0	742	/**
sl@0	743	Trace output at end of Fast Interrupt (FIQ) dispatch.
sl@0	744
sl@0	745	Note, this trace isn't generated if an Interrupt Service Routine queues
sl@0	746	a DFC or causes a thread to be scheduled. In these cases, the traces for
sl@0	747	these events (EIDFCStart or ENewThreadContext) should be taken to indicate
sl@0	748	that interrupt servicing has ended.
sl@0	749	*/
sl@0	750	EFiqEnd,
sl@0	751
sl@0	752	/**
sl@0	753	Trace output at start of Immediate Delayed Function Call (IDFC) processing.
sl@0	754	This processing also includes moving DFCs to their final queue, so the trace
sl@0	755	does not necessarily indicate that any IDFCs have been executed.
sl@0	756	*/
sl@0	757	EIDFCStart,
sl@0	758
sl@0	759	/**
sl@0	760	Trace output at end of Immediate Delayed Function Call (IDFC) processing.
sl@0	761	*/
sl@0	762	EIDFCEnd,
sl@0	763
sl@0	764	/**
sl@0	765	Trace output when a thread is scheduled to run.
sl@0	766	The context id (NThread*) in this trace is that of the thread being scheduled.
sl@0	767	*/
sl@0	768	ENewThreadContext
sl@0	769	};
sl@0	770
sl@0	771	/**
sl@0	772	@internalTechnology
sl@0	773	@prototype 9.3
sl@0	774	*/
sl@0	775	enum TClientServer
sl@0	776	{
sl@0	777	/**
sl@0	778	Trace generated whenever a server is created and during prime.
sl@0	779
sl@0	780	Trace data format:
sl@0	781	- 4 bytes containing the server id (a DServer*).
sl@0	782	- 4 bytes containing the owning thread pointer (a DThread*).
sl@0	783	- Remaining data is the ASCII name of the server.
sl@0	784
sl@0	785	*/
sl@0	786	EServerCreate,
sl@0	787
sl@0	788	/**
sl@0	789	Trace generated whenever a server is destroyed.
sl@0	790
sl@0	791	Trace data format:
sl@0	792	- 4 bytes containing the server id (a DServer*).
sl@0	793
sl@0	794	*/
sl@0	795	EServerDestroy,
sl@0	796
sl@0	797	/**
sl@0	798	Trace generated whenever a new session is attached to a server and during prime.
sl@0	799	I.e. a new session has been created.
sl@0	800
sl@0	801	Trace data format:
sl@0	802	- 4 bytes containing the session id (a DSession*).
sl@0	803	- 4 bytes containing the server id (a DServer*).
sl@0	804	- 4 bytes containing the owner id (a DObject*).
sl@0	805
sl@0	806	The context id (NThread*) in this trace is that of the thread creating the session
sl@0	807	(apart from during prime when it is NULL).
sl@0	808	*/
sl@0	809	ESessionAttach,
sl@0	810
sl@0	811	/**
sl@0	812	Trace generated whenever a server session is detached from a server.
sl@0	813	I.e. a session has been closed.
sl@0	814
sl@0	815	Trace data format:
sl@0	816	- 4 bytes containing the session id (a DSession*).
sl@0	817	- 4 bytes containing the reasons (error code) for the session being closed.
sl@0	818
sl@0	819	*/
sl@0	820	ESessionDetach,
sl@0	821
sl@0	822	/**
sl@0	823	Trace generated whenever a new message is sent to a server.
sl@0	824
sl@0	825	Trace data format:
sl@0	826	- 4 bytes containing the message handle.
sl@0	827	- 4 bytes containing the iFunction value for the message.
sl@0	828	- 4 bytes containing the session id (a DSession*).
sl@0	829
sl@0	830	The context id (NThread*) in this trace is that of the thread which sent the message.
sl@0	831	*/
sl@0	832	EMessageSend,
sl@0	833
sl@0	834	/**
sl@0	835	Trace generated when a server receives a new message.
sl@0	836
sl@0	837	Trace data format:
sl@0	838	- 4 bytes containing the message handle.
sl@0	839	*/
sl@0	840	EMessageReceive,
sl@0	841
sl@0	842	/**
sl@0	843	Trace generated whenever a message is completed using RMessagePtr2::Complete.
sl@0	844
sl@0	845	Trace data format:
sl@0	846	- 4 bytes containing the message handle.
sl@0	847	- 4 bytes containing the completion reason, or object handle, value.
sl@0	848	(The object handle value is that which is delivered to the sender of the
sl@0	849	message, not that supplied by the server actually completing the request.)
sl@0	850
sl@0	851	The context id (NThread*) in this trace is that of the thread which completed the message.
sl@0	852	*/
sl@0	853	EMessageComplete
sl@0	854	};
sl@0	855
sl@0	856
sl@0	857	/**
sl@0	858	@internalTechnology
sl@0	859	@prototype 9.3
sl@0	860	*/
sl@0	861	enum TRequests
sl@0	862	{
sl@0	863	/**
sl@0	864	Trace generated whenever a request status is completed.
sl@0	865
sl@0	866	Trace data format:
sl@0	867	- 4 bytes containing the thread id (NThread*) of the thread being signalled.
sl@0	868	- 4 bytes containing the address of the TRequestStatus object.
sl@0	869	- 4 bytes containing the completion reason.
sl@0	870
sl@0	871	The context id (NThread*) in this trace is that of the thread which completed the request.
sl@0	872	*/
sl@0	873	ERequestComplete
sl@0	874	};
sl@0	875
sl@0	876
sl@0	877	/**
sl@0	878	Enumeration of sub-category values for trace category EChunks.
sl@0	879	@see EChunks
sl@0	880	*/
sl@0	881	enum TChunks
sl@0	882	{
sl@0	883	/**
sl@0	884	Trace output when a chunk is created.
sl@0	885
sl@0	886	Trace data format:
sl@0	887	- 4 bytes containing the chunk id (a DChunk*).
sl@0	888	- 4 bytes containing the maximum size of the chunk.
sl@0	889	- The ASCII name of the chunk.
sl@0	890	*/
sl@0	891	EChunkCreated,
sl@0	892
sl@0	893	/**
sl@0	894	@internalTechnology
sl@0	895
sl@0	896	Trace output when a chunk is created containing extra chunk information.
sl@0	897
sl@0	898	Note that the meaning of the data in this trace is different between
sl@0	899	memory models, and may change without warning.
sl@0	900
sl@0	901	Trace data format:
sl@0	902	- 4 bytes containing the chunk id (a DChunk*).
sl@0	903	- 4 bytes containing the chunk type.
sl@0	904	- 4 bytes containing the chunk's attributes.
sl@0	905	*/
sl@0	906	EChunkInfo,
sl@0	907
sl@0	908	/**
sl@0	909	Trace output when a chunk is destroyed.
sl@0	910
sl@0	911	Trace data format:
sl@0	912	- 4 bytes containing the chunk id (a DChunk*)
sl@0	913	*/
sl@0	914	EChunkDestroyed,
sl@0	915
sl@0	916	/**
sl@0	917	Trace output when memory is allocated and committed to a chunk.
sl@0	918
sl@0	919	Trace data format:
sl@0	920	- 4 bytes containing the chunk id (a DChunk*).
sl@0	921	- 4 bytes containing the offset into the chunk.
sl@0	922	- 4 bytes containing the size of the memory committed.
sl@0	923	*/
sl@0	924	EChunkMemoryAllocated,
sl@0	925
sl@0	926	/**
sl@0	927	Trace output when memory is decommitted from a chunk and deallocated.
sl@0	928
sl@0	929	Trace data format:
sl@0	930	- 4 bytes containing the chunk id (a DChunk*).
sl@0	931	- 4 bytes containing the offset into the chunk.
sl@0	932	- 4 bytes containing the size of the memory decommitted.
sl@0	933	*/
sl@0	934	EChunkMemoryDeallocated,
sl@0	935
sl@0	936	/**
sl@0	937	Trace output when un-owned memory is committed to a chunk.
sl@0	938
sl@0	939	Trace data format:
sl@0	940	- 4 bytes containing the chunk id (a DChunk*).
sl@0	941	- 4 bytes containing the offset into the chunk.
sl@0	942	- 4 bytes containing the size of the memory committed.
sl@0	943	*/
sl@0	944	EChunkMemoryAdded,
sl@0	945
sl@0	946	/**
sl@0	947	Trace output when un-owned memory is decommitted to a chunk.
sl@0	948
sl@0	949	Trace data format:
sl@0	950	- 4 bytes containing the chunk id (a DChunk*).
sl@0	951	- 4 bytes containing the offset into the chunk.
sl@0	952	- 4 bytes containing the size of the memory decommitted.
sl@0	953	*/
sl@0	954	EChunkMemoryRemoved,
sl@0	955
sl@0	956	/**
sl@0	957	Trace to indicate the owning process of a chunk - only for local (private) chunks.
sl@0	958
sl@0	959	Trace data format:
sl@0	960	- 4 bytes containing the chunk id (a DChunk*).
sl@0	961	- 4 bytes containing the process id of the owner (a DProcess*).
sl@0	962	*/
sl@0	963	EChunkOwner
sl@0	964	};
sl@0	965
sl@0	966	/**
sl@0	967	Enumeration of sub-category values for trace category ECodeSegs.
sl@0	968	@see ECodeSegs
sl@0	969	*/
sl@0	970	enum TCodeSegs
sl@0	971	{
sl@0	972	/**
sl@0	973	Trace output when a code segment is created to associate a code segment
sl@0	974	id with a filename.
sl@0	975
sl@0	976	Trace data format:
sl@0	977	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	978	- The ASCII filename.
sl@0	979	*/
sl@0	980	ECodeSegCreated,
sl@0	981
sl@0	982	/**
sl@0	983	Trace output when a code segment is created.
sl@0	984
sl@0	985	Trace data format:
sl@0	986	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	987	- 4 bytes containing the attributes.
sl@0	988	- 4 bytes containing the code base address (.text).
sl@0	989	- 4 bytes containing the size of the code section (.text).
sl@0	990	- 4 bytes containing the base address of the constant data section (.rodata).
sl@0	991	- 4 bytes containing the size of the constant data section (.rodata).
sl@0	992	- 4 bytes containing the base address of the initialised data section (.data).
sl@0	993	- 4 bytes containing the size of the initialised data section (.data).
sl@0	994	- 4 bytes containing the base address of the uninitialised data section (.bss).
sl@0	995	- 4 bytes containing the size of the uninitialised data section (.bss).
sl@0	996	*/
sl@0	997	ECodeSegInfo,
sl@0	998
sl@0	999	/**
sl@0	1000	Trace output when a code segment is destroyed.
sl@0	1001
sl@0	1002	Trace data format:
sl@0	1003	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	1004	*/
sl@0	1005	ECodeSegDestroyed,
sl@0	1006
sl@0	1007	/**
sl@0	1008	Trace output when a code segment is mapped into a process.
sl@0	1009
sl@0	1010	Trace data format:
sl@0	1011	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	1012	- 4 bytes containing the process id (a DProcess*).
sl@0	1013	*/
sl@0	1014	ECodeSegMapped,
sl@0	1015
sl@0	1016	/**
sl@0	1017	Trace output when a code segment is unmapped from a process.
sl@0	1018
sl@0	1019	Trace data format:
sl@0	1020	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	1021	- 4 bytes containing the process id (a DProcess*).
sl@0	1022	*/
sl@0	1023	ECodeSegUnmapped,
sl@0	1024
sl@0	1025	/**
sl@0	1026	Trace output when memory is allocated to a code segment.
sl@0	1027
sl@0	1028	Under the multiple memory model, code segments for RAM-loaded user code
sl@0	1029	own the RAM pages the code occupies. The pages are not owned by any
sl@0	1030	chunk, but are mapped into the code chunk of each process that uses the
sl@0	1031	code segment.
sl@0	1032
sl@0	1033	Trace data format:
sl@0	1034	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	1035	- 4 bytes containing the size of the memory allocated.
sl@0	1036	*/
sl@0	1037	ECodeSegMemoryAllocated,
sl@0	1038
sl@0	1039	/**
sl@0	1040	Trace output when memory is deallocated from a code segment.
sl@0	1041
sl@0	1042	Under the multiple memory model, code segments for RAM-loaded user code
sl@0	1043	own the RAM pages the code occupies. The pages are not owned by any
sl@0	1044	chunk, but are mapped into the code chunk of each process that uses the
sl@0	1045	code segment.
sl@0	1046
sl@0	1047	Trace data format:
sl@0	1048	- 4 bytes containing the code segment id (a DCodeSeg*).
sl@0	1049	- 4 bytes containing the size of the memory deallocated.
sl@0	1050	*/
sl@0	1051	ECodeSegMemoryDeallocated
sl@0	1052	};
sl@0	1053
sl@0	1054
sl@0	1055	/**
sl@0	1056	Enumeration of sub-category values for trace category EPaging.
sl@0	1057	@see EPaging
sl@0	1058	*/
sl@0	1059	enum TPaging
sl@0	1060	{
sl@0	1061	/**
sl@0	1062	This event indicates the beginning of the 'page in' activity.
sl@0	1063	The end of this activity is indicated by one of the following events:
sl@0	1064	- EPagingPageInUnneeded
sl@0	1065	- EPagingPageInROM
sl@0	1066	- EPagingPageInCode
sl@0	1067	- EPagingPageIn (flexible memory model)
sl@0	1068
sl@0	1069	Trace data format:
sl@0	1070	- 4 bytes containing the virtual address which was accessed, causing this paging event.
sl@0	1071	- 4 bytes containing the virtual address of the instruction which caused this paging event.
sl@0	1072	(The PC value.)
sl@0	1073
sl@0	1074	On the flexible memory model, the following addition trace data is also present:
sl@0	1075	- 1 byte containing the required access permissions, as defined by TMappingPermissions.
sl@0	1076	- 3 spare bytes, currently zero
sl@0	1077
sl@0	1078	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1079	*/
sl@0	1080	EPagingPageInBegin,
sl@0	1081
sl@0	1082	/**
sl@0	1083	Event which terminates the 'page in' activity when the required page was found to have been
sl@0	1084	paged in by another thread while the current thread was processing the fault (see
sl@0	1085	EPagingPageInBegin).
sl@0	1086
sl@0	1087	Trace data format:
sl@0	1088	- 0 bytes. (No extra data.)
sl@0	1089
sl@0	1090	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1091	*/
sl@0	1092	EPagingPageInUnneeded,
sl@0	1093
sl@0	1094	/**
sl@0	1095	A ROM page has been paged in.
sl@0	1096	This event indicates the end of the 'page in' activity. (See EPagingPageInBegin.)
sl@0	1097
sl@0	1098	Trace data format:
sl@0	1099	- 4 bytes containing the physical address of the page 'paged in'.
sl@0	1100	- 4 bytes containing the virtual address of the page 'paged in'.
sl@0	1101
sl@0	1102	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1103
sl@0	1104	This trace is not emitted on the flexible memory model - EPagingPageIn is used instead.
sl@0	1105	*/
sl@0	1106	EPagingPageInROM,
sl@0	1107
sl@0	1108	/**
sl@0	1109	A ROM page has been 'paged out'. I.e. removed from the live list to be either
sl@0	1110	reused or returned to free pool.
sl@0	1111
sl@0	1112	Trace data format:
sl@0	1113	- 4 bytes containing the physical address of the page being 'paged out'.
sl@0	1114	- 4 bytes containing the virtual address of the page being 'paged out'.
sl@0	1115
sl@0	1116	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1117
sl@0	1118	This trace is not emitted on the flexible memory model - EPagingPageOut is used instead.
sl@0	1119	*/
sl@0	1120	EPagingPageOutROM,
sl@0	1121
sl@0	1122	/**
sl@0	1123	A Free page has been 'paged in'. I.e. added to the live list.
sl@0	1124
sl@0	1125	Trace data format:
sl@0	1126	- 4 bytes containing the physical address of the page being 'paged in'.
sl@0	1127
sl@0	1128	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1129	*/
sl@0	1130	EPagingPageInFree,
sl@0	1131
sl@0	1132	/**
sl@0	1133	A Free page has been 'paged out'. I.e. removed from the live list to be either
sl@0	1134	reused or returned to free pool.
sl@0	1135
sl@0	1136	Trace data format:
sl@0	1137	- 4 bytes containing the physical address of the page being 'paged out'.
sl@0	1138
sl@0	1139	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1140
sl@0	1141	This trace is not emitted on the flexible memory model - EPagingPageOut is used instead.
sl@0	1142	*/
sl@0	1143	EPagingPageOutFree,
sl@0	1144
sl@0	1145	/**
sl@0	1146	A page has been made 'young' again because it was accessed.
sl@0	1147
sl@0	1148	Trace data format:
sl@0	1149	- 4 bytes containing the physical address of the page being rejuvenated, (made young).
sl@0	1150	- 4 bytes containing the virtual address which was accessed, causing this paging event.
sl@0	1151	- 4 bytes containing the virtual address of the instruction which caused this paging event.
sl@0	1152	(The PC value.)
sl@0	1153
sl@0	1154	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1155	*/
sl@0	1156	EPagingRejuvenate,
sl@0	1157
sl@0	1158	/**
sl@0	1159	A page fault was found to have already been previously serviced.
sl@0	1160
sl@0	1161	Trace data format:
sl@0	1162	- 4 bytes containing the physical address of the page accessed.
sl@0	1163	- 4 bytes containing the virtual address which was accessed, causing this paging event.
sl@0	1164	- 4 bytes containing the virtual address of the instruction which caused this paging event.
sl@0	1165	(The PC value.)
sl@0	1166
sl@0	1167	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1168
sl@0	1169	This trace is not emitted on the flexible memory model.
sl@0	1170	*/
sl@0	1171	EPagingPageNop,
sl@0	1172
sl@0	1173	/**
sl@0	1174	A page has been locked.
sl@0	1175
sl@0	1176	Trace data format:
sl@0	1177	- 4 bytes containing the physical address of the page being locked.
sl@0	1178	- 4 bytes containing the value of the lock count after the paged was locked.
sl@0	1179
sl@0	1180	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1181	*/
sl@0	1182	EPagingPageLock,
sl@0	1183
sl@0	1184	/**
sl@0	1185	A page has been unlocked.
sl@0	1186
sl@0	1187	Trace data format:
sl@0	1188	- 4 bytes containing the physical address of the page being unlocked.
sl@0	1189	- 4 bytes containing the value of the lock count before the paged was unlocked.
sl@0	1190
sl@0	1191	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1192	*/
sl@0	1193	EPagingPageUnlock,
sl@0	1194
sl@0	1195	/**
sl@0	1196	A page containing RAM cache has been 'paged out'. I.e. removed from the live list to be
sl@0	1197	either reused or returned to free pool.
sl@0	1198
sl@0	1199	Trace data format:
sl@0	1200	- 4 bytes containing the physical address of the page being 'paged out'.
sl@0	1201	- 4 bytes containing the virtual address of the page being 'paged out'.
sl@0	1202
sl@0	1203	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1204
sl@0	1205	This trace is not emitted on the flexible memory model - EPagingPageOut is used instead.
sl@0	1206	*/
sl@0	1207	EPagingPageOutCache,
sl@0	1208
sl@0	1209	/**
sl@0	1210	A page containing RAM-loaded code has been paged in.
sl@0	1211	This event indicates the end of the 'page in' activity. (See EPagingPageInBegin.)
sl@0	1212
sl@0	1213	Trace data format:
sl@0	1214	- 4 bytes containing the physical address of the page 'paged in'.
sl@0	1215	- 4 bytes containing the virtual address of the page 'paged in'.
sl@0	1216
sl@0	1217	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1218
sl@0	1219	This trace is not emitted on the flexible memory model - EPagingPageIn is used instead.
sl@0	1220	*/
sl@0	1221	EPagingPageInCode,
sl@0	1222
sl@0	1223	/**
sl@0	1224	A page containing RAM-loaded code has been 'paged out'. I.e. removed from the live list to be
sl@0	1225	either reused or returned to free pool.
sl@0	1226
sl@0	1227	Trace data format:
sl@0	1228	- 4 bytes containing the physical address of the page being 'paged out'.
sl@0	1229	- 4 bytes containing the virtual address of the page being 'paged out'.
sl@0	1230
sl@0	1231	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1232
sl@0	1233	This trace is not emitted on the flexible memory model - EPagingPageOut is used instead.
sl@0	1234	*/
sl@0	1235	EPagingPageOutCode,
sl@0	1236
sl@0	1237	/**
sl@0	1238	A page of RAM-loaded code was found to already be 'paged in' but not mapped in
sl@0	1239	the faulting process.
sl@0	1240
sl@0	1241	Trace data format:
sl@0	1242	- 4 bytes containing the physical address of the page 'paged in'.
sl@0	1243	- 4 bytes containing the virtual address which was accessed, causing this paging event.
sl@0	1244
sl@0	1245	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1246
sl@0	1247	This trace is only emitted on the multiple memory model.
sl@0	1248	*/
sl@0	1249	EPagingMapCode,
sl@0	1250
sl@0	1251	/**
sl@0	1252	A page has been made 'old' because it was the last young page to be accessed.
sl@0	1253
sl@0	1254	This trace is only produced when the kernel is compiled with the #BTRACE_PAGING_VERBOSE
sl@0	1255	macro defined.
sl@0	1256
sl@0	1257	Trace data format:
sl@0	1258	- 4 bytes containing the physical address of the page being aged, (made old).
sl@0	1259
sl@0	1260	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1261	*/
sl@0	1262	EPagingAged,
sl@0	1263
sl@0	1264	/**
sl@0	1265	Trace emitted at the start of decompression of demand paged data.
sl@0	1266
sl@0	1267	This trace is only produced when the kernel is compiled with the #BTRACE_PAGING_VERBOSE
sl@0	1268	macro defined.
sl@0	1269
sl@0	1270	Trace data format:
sl@0	1271	- 4 bytes containing an integer which indicates the compression type being used:
sl@0	1272	0, no compression;
sl@0	1273	1, bytepair compression.
sl@0	1274
sl@0	1275	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1276	*/
sl@0	1277	EPagingDecompressStart,
sl@0	1278
sl@0	1279	/**
sl@0	1280	Trace emitted at the end of decompression of demand paged data.
sl@0	1281
sl@0	1282	This trace is only produced when the kernel is compiled with the #BTRACE_PAGING_VERBOSE
sl@0	1283	macro defined.
sl@0	1284
sl@0	1285	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1286	*/
sl@0	1287	EPagingDecompressEnd,
sl@0	1288
sl@0	1289	/**
sl@0	1290	Information about the kernel's memory model.
sl@0	1291
sl@0	1292	Trace data format:
sl@0	1293	- 4 bytes containing the memory model as defined by TMemModelAttributes.
sl@0	1294	*/
sl@0	1295	EPagingMemoryModel,
sl@0	1296
sl@0	1297	/**
sl@0	1298	A page has been donated to the paging cache via RChunk::Unlock().
sl@0	1299
sl@0	1300	Trace data format:
sl@0	1301	- 4 bytes containing the chunk id (a DChunk*).
sl@0	1302	- 4 bytes containing the page index of the page within the chunk.
sl@0	1303
sl@0	1304	This trace is not emitted on the flexible memory model.
sl@0	1305	@see EPagingDonatePage
sl@0	1306	*/
sl@0	1307	EPagingChunkDonatePage,
sl@0	1308
sl@0	1309	/**
sl@0	1310	A page has been reclaimed from the paging cache via RChunk::Lock().
sl@0	1311
sl@0	1312	Trace data format:
sl@0	1313	- 4 bytes containing the chunk id (a DChunk*).
sl@0	1314	- 4 bytes containing the page index of the page within the chunk.
sl@0	1315
sl@0	1316	This trace is not emitted on the flexible memory model.
sl@0	1317	@see EPagingReclaimPage.
sl@0	1318	*/
sl@0	1319	EPagingChunkReclaimPage,
sl@0	1320
sl@0	1321	// Traces specific to the flexible memory model
sl@0	1322
sl@0	1323	/**
sl@0	1324	A page has been paged in.
sl@0	1325	This event indicates the end of the 'page in' activity. (See EPagingPageInBegin.)
sl@0	1326
sl@0	1327	Trace data format:
sl@0	1328	- 4 bytes containing the physical address of the page 'paged in'.
sl@0	1329	- 4 bytes containing the memory object id (DMemoryObject*).
sl@0	1330	- 4 bytes containing the page index of the page within the memory object.
sl@0	1331
sl@0	1332	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1333
sl@0	1334	This trace is only emitted on the flexible memory model.
sl@0	1335	*/
sl@0	1336	EPagingPageIn,
sl@0	1337
sl@0	1338	/**
sl@0	1339	A page has been 'paged out'. I.e. removed from the live list to be either
sl@0	1340	reused or returned to free pool.
sl@0	1341
sl@0	1342	Trace data format:
sl@0	1343	- 4 bytes containing the physical address of the page being 'paged out'.
sl@0	1344
sl@0	1345	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1346
sl@0	1347	This trace is only emitted on the flexible memory model.
sl@0	1348	*/
sl@0	1349	EPagingPageOut,
sl@0	1350
sl@0	1351	/**
sl@0	1352	Event which terminates the 'page in' activity when the required page was found to
sl@0	1353	already be paged in but not mapped in the faulting process (see EPagingPageInBegin).
sl@0	1354
sl@0	1355	Trace data format:
sl@0	1356	- 4 bytes containing the physical address of the page 'paged in'.
sl@0	1357
sl@0	1358	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1359
sl@0	1360	This trace is only emitted on the flexible memory model.
sl@0	1361	*/
sl@0	1362	EPagingMapPage,
sl@0	1363
sl@0	1364	/**
sl@0	1365	A page has been donated to the paging cache via RChunk::Unlock().
sl@0	1366
sl@0	1367	Trace data format:
sl@0	1368	- 4 bytes containing the physical address of the page.
sl@0	1369	- 4 bytes containing the memory object id (DMemoryObject*).
sl@0	1370	- 4 bytes containing the page index of the page within the memory object.
sl@0	1371
sl@0	1372	This trace is only emitted on the flexible memory model.
sl@0	1373	@see EPagingChunkDonatePage.
sl@0	1374	*/
sl@0	1375	EPagingDonatePage,
sl@0	1376
sl@0	1377	/**
sl@0	1378	A page has been reclaimed from the paging cache via RChunk::Lock().
sl@0	1379
sl@0	1380	Trace data format:
sl@0	1381	- 4 bytes containing the physical address of the page.
sl@0	1382
sl@0	1383	This trace is only emitted on the flexible memory model.
sl@0	1384	@see EPagingChunkReclaimPage.
sl@0	1385	*/
sl@0	1386	EPagingReclaimPage,
sl@0	1387
sl@0	1388	/**
sl@0	1389	A page has been moved to the oldest clean list because it was the last old page and
sl@0	1390	it was clean.
sl@0	1391
sl@0	1392	This trace is only produced when the kernel is compiled with the #BTRACE_PAGING_VERBOSE
sl@0	1393	macro defined.
sl@0	1394
sl@0	1395	Trace data format:
sl@0	1396	- 4 bytes containing the physical address of the page being moved to the oldest clean list.
sl@0	1397
sl@0	1398	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1399	*/
sl@0	1400	EPagingAgedClean,
sl@0	1401
sl@0	1402	/**
sl@0	1403	A page has been moved to the oldest dirty list because it was the last old page and
sl@0	1404	it was dirty.
sl@0	1405
sl@0	1406	This trace is only produced when the kernel is compiled with the #BTRACE_PAGING_VERBOSE
sl@0	1407	macro defined.
sl@0	1408
sl@0	1409	Trace data format:
sl@0	1410	- 4 bytes containing the physical address of the page being moved to the oldest dirty list.
sl@0	1411
sl@0	1412	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1413	*/
sl@0	1414	EPagingAgedDirty,
sl@0	1415
sl@0	1416	/**
sl@0	1417	A page has been allocated to hold the MMU page tables required to map demand paged memory.
sl@0	1418
sl@0	1419	Trace data format:
sl@0	1420	- 4 bytes containing the physical address of the page allocated.
sl@0	1421
sl@0	1422	The context id (NThread*) in this trace is that of the thread caused this paging event.
sl@0	1423
sl@0	1424	This trace is only emitted on the flexible memory model.
sl@0	1425	*/
sl@0	1426	EPagingPageTableAlloc,
sl@0	1427	};
sl@0	1428
sl@0	1429	/**
sl@0	1430	Enumeration of sub-category values for trace category EResourceManager.
sl@0	1431	@see EResourceManager
sl@0	1432	@prototype 9.5
sl@0	1433	*/
sl@0	1434	enum TResourceManager
sl@0	1435	{
sl@0	1436	/**
sl@0	1437	Trace output for resource registration.
sl@0	1438
sl@0	1439	Trace data format:
sl@0	1440	- 4 bytes containing the Resource Id.
sl@0	1441	- 4 bytes containing the Resource address.
sl@0	1442	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1443	- 4 bytes containing the Resource Minimum Level
sl@0	1444	- 4 bytes containing the Resource Maximum Level
sl@0	1445	- 4 bytes containing the Resource Default Level
sl@0	1446	*/
sl@0	1447	ERegisterResource = 0,
sl@0	1448
sl@0	1449	/**
sl@0	1450	Trace output for client registration
sl@0	1451
sl@0	1452	Trace data format:
sl@0	1453	- 4 bytes containing clientId
sl@0	1454	- 4 bytes containing client address
sl@0	1455	- N bytes containing client name, where 0 < N < 32
sl@0	1456	*/
sl@0	1457	ERegisterClient,
sl@0	1458
sl@0	1459	/**
sl@0	1460	Trace output for client deregistration
sl@0	1461
sl@0	1462	Trace data format:
sl@0	1463	- 4 bytes containing clientId
sl@0	1464	- 4 bytes containing client address
sl@0	1465	- N bytes containing client name, where 0 < N < 32
sl@0	1466	*/
sl@0	1467	EDeRegisterClient,
sl@0	1468
sl@0	1469	/**
sl@0	1470	Trace output for resource state change start operation
sl@0	1471
sl@0	1472	Trace data format:
sl@0	1473	- 4 bytes containing clientId
sl@0	1474	- 4 bytes containing the Resource Id.
sl@0	1475	- N bytes containing client name, where 0 < N < 32
sl@0	1476	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1477	- 4 bytes containing the Resource state
sl@0	1478	*/
sl@0	1479	ESetResourceStateStart,
sl@0	1480
sl@0	1481	/**
sl@0	1482	Trace output for resource state change end operation
sl@0	1483
sl@0	1484	Trace data format:
sl@0	1485	- 4 bytes containing clientId
sl@0	1486	- 4 bytes containing the Resource Id.
sl@0	1487	- N bytes containing client name, where 0 < N < 32
sl@0	1488	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1489	- 4 bytes containing return value.
sl@0	1490	- 4 bytes containing the Resource state.
sl@0	1491	*/
sl@0	1492	ESetResourceStateEnd,
sl@0	1493
sl@0	1494	/**
sl@0	1495	Trace output for registration for post notification
sl@0	1496
sl@0	1497	Trace data format:
sl@0	1498	- 4 bytes containing clientId
sl@0	1499	- 4 bytes containing the Resource Id.
sl@0	1500	- 4 bytest containing the callback address
sl@0	1501	- 4 bytes containing return value.
sl@0	1502	*/
sl@0	1503	EPostNotificationRegister,
sl@0	1504
sl@0	1505	/**
sl@0	1506	Trace output for deregistration for post notification
sl@0	1507
sl@0	1508	Trace data format:
sl@0	1509	- 4 bytes containing clientId
sl@0	1510	- 4 bytes containing the Resource Id.
sl@0	1511	- 4 bytes containing the callback address
sl@0	1512	- 4 bytes containing the return value.
sl@0	1513	*/
sl@0	1514	EPostNotificationDeRegister,
sl@0	1515
sl@0	1516	/**
sl@0	1517	Trace output for post notification sent.
sl@0	1518
sl@0	1519	Trace data format:
sl@0	1520	- 4 bytes containing clientId
sl@0	1521	- 4 bytes containing the Resource Id.
sl@0	1522	*/
sl@0	1523	EPostNotificationSent,
sl@0	1524
sl@0	1525	/**
sl@0	1526	Trace output for Callback complete
sl@0	1527
sl@0	1528	Trace data format:
sl@0	1529	- 4 bytes containing clientId
sl@0	1530	- 4 bytes containing the Resource Id.
sl@0	1531	*/
sl@0	1532	ECallbackComplete,
sl@0	1533
sl@0	1534	/**
sl@0	1535	Trace output for resource manager memory usage
sl@0	1536
sl@0	1537	Trace data format:
sl@0	1538	- 4 bytes containing memory allocated in bytes.
sl@0	1539	*/
sl@0	1540	EMemoryUsage,
sl@0	1541
sl@0	1542	/**
sl@0	1543	Trace output for get resource state start operation
sl@0	1544
sl@0	1545	Trace data format:
sl@0	1546	- 4 bytes containing clientId
sl@0	1547	- 4 bytes containing the Resource Id.
sl@0	1548	- N bytes containing client name, where 0 < N < 32
sl@0	1549	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1550	*/
sl@0	1551	EGetResourceStateStart,
sl@0	1552
sl@0	1553	/**
sl@0	1554	Trace output for get resource state end operation
sl@0	1555
sl@0	1556	Trace data format:
sl@0	1557	- 4 bytes containing clientId
sl@0	1558	- 4 bytes containing the Resource Id.
sl@0	1559	- N bytes containing client name, where 0 < N < 32
sl@0	1560	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1561	- 4 bytes containing the Resource state
sl@0	1562	- 4 bytes containing return value.
sl@0	1563	*/
sl@0	1564	EGetResourceStateEnd,
sl@0	1565
sl@0	1566	/**
sl@0	1567	Trace output for cancellation of long latency operation
sl@0	1568
sl@0	1569	Trace data format:
sl@0	1570	- 4 bytes containing clientId
sl@0	1571	- 4 bytes containing the Resource Id.
sl@0	1572	- N bytes containing client name, where 0 < N < 32
sl@0	1573	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1574	- 4 bytes containing return value
sl@0	1575	*/
sl@0	1576	ECancelLongLatencyOperation,
sl@0	1577
sl@0	1578	/**
sl@0	1579	Trace output for booting of resource manager
sl@0	1580
sl@0	1581	Trace data format:
sl@0	1582	- 4 bytes containing entry point
sl@0	1583	*/
sl@0	1584	EBooting,
sl@0	1585
sl@0	1586	/**
sl@0	1587	Trace output for PSL resource state change operation
sl@0	1588
sl@0	1589	Trace data format:
sl@0	1590	- 4 bytes containing clientId
sl@0	1591	- 4 bytes containing the Resource Id.
sl@0	1592	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1593	- 4 bytes containing the Resource current state
sl@0	1594	- 4 bytes containing the resource requested state
sl@0	1595	*/
sl@0	1596	EPslChangeResourceStateStart,
sl@0	1597
sl@0	1598	/**
sl@0	1599	Trace output for PSL resource state change operation
sl@0	1600
sl@0	1601	Trace data format:
sl@0	1602	- 4 bytes containing clientId
sl@0	1603	- 4 bytes containing the Resource Id.
sl@0	1604	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1605	- 4 bytes containing the Resource current state
sl@0	1606	- 4 bytes containing the resource requested state
sl@0	1607	- 4 bytes containing return value
sl@0	1608	*/
sl@0	1609	EPslChangeResourceStateEnd,
sl@0	1610
sl@0	1611	/**
sl@0	1612	Trace output for get resource state start operation in PSL
sl@0	1613
sl@0	1614	Trace data format:
sl@0	1615	- 4 bytes containing clientId
sl@0	1616	- 4 bytes containing the Resource Id.
sl@0	1617	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1618	*/
sl@0	1619	EPslGetResourceStateStart,
sl@0	1620
sl@0	1621	/**
sl@0	1622	Trace output for get resource state end operation in PSL
sl@0	1623
sl@0	1624	Trace data format:
sl@0	1625	- 4 bytes containing clientId
sl@0	1626	- 4 bytes containing the Resource Id.
sl@0	1627	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1628	- 4 bytes containing the Resource state
sl@0	1629	- 4 bytes containing return value.
sl@0	1630	*/
sl@0	1631	EPslGetResourceStateEnd,
sl@0	1632
sl@0	1633	/**
sl@0	1634	Trace output for resource creation
sl@0	1635
sl@0	1636	Trace data format:
sl@0	1637	- 4 bytes containing minimum value of resource
sl@0	1638	- 4 bytes containing maximum value of resource
sl@0	1639	- 4 bytes containing the default value of resource
sl@0	1640	- 4 bytes containing the properties of the resource
sl@0	1641	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1642	*/
sl@0	1643	EPslResourceCreate,
sl@0	1644
sl@0	1645	/**
sl@0	1646	Trace output for static resource with dependency registration
sl@0	1647
sl@0	1648	Trace data format:
sl@0	1649	- 4 bytes containing the Resource Id
sl@0	1650	- 4 bytes containing the Resource address
sl@0	1651	- N bytes containing the Resource name, where 0 < N < 32
sl@0	1652	- 4 bytes containing the minimum value of resource
sl@0	1653	- 4 bytes containing the maximum value of resource
sl@0	1654	- 4 bytes containing the default value of resource
sl@0	1655	*/
sl@0	1656	ERegisterStaticResourceWithDependency,
sl@0	1657
sl@0	1658	/**
sl@0	1659	Trace output for dynamic resource registration
sl@0	1660
sl@0	1661	Trace data format:
sl@0	1662	- 4 bytes containing clientId
sl@0	1663	- 4 bytes containing the Resource Id
sl@0	1664	- N bytes containing the client name, where 0 < N < 32
sl@0	1665	- N bytes containing the resource name, where 0 < N < 32
sl@0	1666	- 4 bytes containing the resouce address
sl@0	1667	*/
sl@0	1668	ERegisterDynamicResource,
sl@0	1669
sl@0	1670	/**
sl@0	1671	Trace output for dynamic resource deregistration
sl@0	1672
sl@0	1673	Trace data format:
sl@0	1674	- 4 bytes containing clientId
sl@0	1675	- 4 bytes containing the Resource Id
sl@0	1676	- N bytes containing the client name, where 0 < N < 32
sl@0	1677	- N bytes containing the resource name, where 0 < N < 32
sl@0	1678	- 4 bytes containing the resource address
sl@0	1679	- 4 bytes containing the resource level.
sl@0	1680	*/
sl@0	1681	EDeRegisterDynamicResource,
sl@0	1682
sl@0	1683	/**
sl@0	1684	Trace output for resource dependency registration
sl@0	1685
sl@0	1686	Trace data format:
sl@0	1687	- 4 bytes containing clientId
sl@0	1688	- 4 bytes containing the Resource Id of first dependent resource
sl@0	1689	- N bytes containing the client name, where 0 < N < 32
sl@0	1690	- N bytes containing the resource name of first dependent resource, where 0 < N < 32
sl@0	1691	- 4 bytes containing the Resource Id of second dependent resource
sl@0	1692	- N bytes containing the resource name of second dependent resource, where 0 < N < 32
sl@0	1693	- 4 bytes containing the address of first dependent resource
sl@0	1694	- 4 bytes containing the address of second dependent resource
sl@0	1695	*/
sl@0	1696	ERegisterResourceDependency,
sl@0	1697
sl@0	1698	/**
sl@0	1699	Trace output for resource dependency deregistration
sl@0	1700
sl@0	1701	Trace data format:
sl@0	1702	- 4 bytes containing clientId
sl@0	1703	- 4 bytes containing the Resource Id of first dependent resource
sl@0	1704	- N bytes containing the client name, where 0 < N < 32
sl@0	1705	- N bytes containing the resource name of first dependent resource, where 0 < N < 32
sl@0	1706	- 4 bytes containing the resource id of second dependent resource
sl@0	1707	- N bytes containing the resource name of second dependent resource, where 0 < N < 32
sl@0	1708	- 4 bytes containing the address of first dependent resource
sl@0	1709	- 4 bytes containing the address of second dependent resource
sl@0	1710	*/
sl@0	1711	EDeRegisterResourceDependency
sl@0	1712	};
sl@0	1713	/**
sl@0	1714	Enumeration of sub-category values for trace category EResourceManagerUs.
sl@0	1715	@see EResourceManagerUs
sl@0	1716	@prototype 9.5
sl@0	1717	*/
sl@0	1718	enum TResourceManagerUs
sl@0	1719	{
sl@0	1720	/**
sl@0	1721	Trace output for the start of opening a channel to the Resource Controller.
sl@0	1722
sl@0	1723	Trace data format:
sl@0	1724	- 4 bytes unused (displays 0)
sl@0	1725	- 4 bytes containing the client thread identifier.
sl@0	1726	- N bytes containing the client name, where 0 < N < 32
sl@0	1727	*/
sl@0	1728	EOpenChannelUsStart = 0,
sl@0	1729	/**
sl@0	1730	Trace output for the end of opening a channel to the Resource Controller.
sl@0	1731
sl@0	1732	Trace data format:
sl@0	1733	- 4 bytes unused (displays 0)
sl@0	1734	- 4 bytes containing the client identifier provided by the Resource Controller
sl@0	1735	- N bytes containing the client name, where 0 < N < 32
sl@0	1736	*/
sl@0	1737	EOpenChannelUsEnd,
sl@0	1738	/**
sl@0	1739	Trace output for the start of registering a client with the Resource Controller.
sl@0	1740
sl@0	1741	Trace data format:
sl@0	1742	- 4 bytes the number of concurrent change resource state operations to be supported
sl@0	1743	- 4 bytes the number of concurrent notification requests to be supported
sl@0	1744	- N bytes containing the client name, where 0 < N < 32
sl@0	1745	- 4 bytes the number of concurrent get resource state operations to be supported
sl@0	1746	*/
sl@0	1747	ERegisterClientUsStart,
sl@0	1748	/**
sl@0	1749	Trace output for the end of registering a client with the Resource Controller.
sl@0	1750
sl@0	1751	Trace data format:
sl@0	1752	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1753	- 4 bytes specifying the value returned from the call to Resource Controller's AllocReserve method
sl@0	1754	*/
sl@0	1755	ERegisterClientUsEnd,
sl@0	1756	/**
sl@0	1757	Trace output for the start of de-registering a client with the Resource Controller.
sl@0	1758
sl@0	1759	Trace data format:
sl@0	1760	- 4 bytes unused (displays 0)
sl@0	1761	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1762	- N bytes containing the client name, where 0 < N < 32
sl@0	1763	*/
sl@0	1764	EDeRegisterClientUsStart,
sl@0	1765	/**
sl@0	1766	Trace output for the end of registering a client with the Resource Controller.
sl@0	1767
sl@0	1768	Trace data format:
sl@0	1769	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1770	*/
sl@0	1771	EDeRegisterClientUsEnd,
sl@0	1772	/**
sl@0	1773	Trace output for the start of a GetResourceState request to the Resource Controller.
sl@0	1774
sl@0	1775	Trace data format:
sl@0	1776	- 4 bytes specifying the resource ID
sl@0	1777	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1778	- N bytes containing the client name, where 0 < N < 32
sl@0	1779	*/
sl@0	1780	EGetResourceStateUsStart,
sl@0	1781	/**
sl@0	1782	Trace output for the end of a GetResourceState request to the Resource Controller.
sl@0	1783
sl@0	1784	Trace data format:
sl@0	1785	- 4 bytes specifying the resource ID
sl@0	1786	- 4 bytes specifying the resource level
sl@0	1787	- 4 bytes containing the client identifier
sl@0	1788	- 4 bytes specifying the success code returned by the Resource Controller.
sl@0	1789	*/
sl@0	1790	EGetResourceStateUsEnd,
sl@0	1791	/**
sl@0	1792	Trace output for the start of a ChangeResourceState request to the Resource Controller.
sl@0	1793
sl@0	1794	Trace data format:
sl@0	1795	- 4 bytes specifying the resource ID
sl@0	1796	- 4 bytes specifying the required state
sl@0	1797	- N bytes containing the client name, where 0 < N < 32
sl@0	1798	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1799	*/
sl@0	1800	ESetResourceStateUsStart,
sl@0	1801	/**
sl@0	1802	Trace output for the end of a ChangeResourceState request to the Resource Controller.
sl@0	1803
sl@0	1804	Trace data format:
sl@0	1805	- 4 bytes specifying the resource ID
sl@0	1806	- 4 bytes specifying the requested state
sl@0	1807	- 4 bytes containing the client identifier
sl@0	1808	- 4 bytes specifying the success code returned by the Resource Controller.
sl@0	1809	*/
sl@0	1810	ESetResourceStateUsEnd,
sl@0	1811	/**
sl@0	1812	Trace output for the start of a cancel GetResourceState request to the Resource Controller.
sl@0	1813
sl@0	1814	Trace data format:
sl@0	1815	- 4 bytes specifying the resource ID
sl@0	1816	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1817	- N bytes containing the client name, where 0 < N < 32
sl@0	1818	*/
sl@0	1819	ECancelGetResourceStateUsStart,
sl@0	1820	/**
sl@0	1821	Trace output for the end of a cancel GetResourceState request to the Resource Controller.
sl@0	1822
sl@0	1823	Trace data format:
sl@0	1824	- 4 bytes specifying the resource ID
sl@0	1825	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1826	- N bytes containing the client name, where 0 < N < 32
sl@0	1827	*/
sl@0	1828	ECancelGetResourceStateUsEnd,
sl@0	1829	/**
sl@0	1830	Trace output for the start of a cancel ChangeResourceState request to the Resource Controller.
sl@0	1831
sl@0	1832	Trace data format:
sl@0	1833	- 4 bytes specifying the resource ID
sl@0	1834	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1835	- N bytes containing the client name, where 0 < N < 32
sl@0	1836	*/
sl@0	1837	ECancelSetResourceStateUsStart,
sl@0	1838	/**
sl@0	1839	Trace output for the end of a cancel ChangeResourceState request to the Resource Controller.
sl@0	1840
sl@0	1841	Trace data format:
sl@0	1842	- 4 bytes specifying the resource ID
sl@0	1843	- 4 bytes containing the client identifier provided by the Resource Controller.
sl@0	1844	- N bytes containing the client name, where 0 < N < 32
sl@0	1845	*/
sl@0	1846	ECancelSetResourceStateUsEnd
sl@0	1847	};
sl@0	1848
sl@0	1849	/**
sl@0	1850	Enumeration of sub-category values for trace category EThreadPriority.
sl@0	1851	@see EThreadPriority
sl@0	1852	@internalTechnology
sl@0	1853	@prototype 9.3
sl@0	1854	*/
sl@0	1855	enum TThreadPriority
sl@0	1856	{
sl@0	1857	/**
sl@0	1858	Trace output when a nanothread priority is changed.
sl@0	1859
sl@0	1860	Trace data format:
sl@0	1861	- 4 bytes containing the context id (an NThread*) for the thread whose priority is changing.
sl@0	1862	- 4 bytes containing the new absolute priority.
sl@0	1863	*/
sl@0	1864	ENThreadPriority=0,
sl@0	1865
sl@0	1866	/**
sl@0	1867	Trace output when a DThread's default priority is set.
sl@0	1868
sl@0	1869	Trace data format:
sl@0	1870	- 4 bytes containing the context id (an NThread*) for the thread whose priority is changing.
sl@0	1871	- 4 bytes containing the iThreadPriority member - a value from enum ::TThrdPriority.
sl@0	1872	- 4 bytes containing the new default absolute priority.
sl@0	1873	*/
sl@0	1874	EDThreadPriority=1,
sl@0	1875
sl@0	1876	/**
sl@0	1877	Trace output when a DProcess priority is changed.
sl@0	1878
sl@0	1879	Trace data format:
sl@0	1880	- 4 bytes containing trace id (a DProcess*) for process.
sl@0	1881	- 4 bytes containing the new process priority, a value from enum ::TProcPriority
sl@0	1882	*/
sl@0	1883	EProcessPriority=2
sl@0	1884	};
sl@0	1885
sl@0	1886	/**
sl@0	1887	Enumeration of sub-category values for trace category EPagingMedia.
sl@0	1888	@see EPagingMedia
sl@0	1889	*/
sl@0	1890	enum TPagingMedia
sl@0	1891	{
sl@0	1892	/**
sl@0	1893	Event generated when a request to 'page in' data is received by the Local Media Subsystem.
sl@0	1894
sl@0	1895	Trace data format:
sl@0	1896	- 4 bytes containing the linear address of the buffer to where the data is to be written.
sl@0	1897	- 4 bytes containing the offset from start of the partition to where the data to be paged in resides.
sl@0	1898	- 4 bytes containing the number of bytes to be read off the media.
sl@0	1899	- 4 bytes containing local drive number for the drive where the data to be paged in resides (-1 if ROM paging).
sl@0	1900	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1901
sl@0	1902	The context id (NThread*) in this trace is that of the thread that took the page fault that caused this event.
sl@0	1903	*/
sl@0	1904	EPagingMediaLocMedPageInBegin,
sl@0	1905
sl@0	1906	/**
sl@0	1907	Event generated by the Local Media Subsystem when a request to page data in or out has completed.
sl@0	1908
sl@0	1909	Trace data format:
sl@0	1910	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1911	- 4 bytes containing the completion code to be returned.
sl@0	1912	- 4 bytes containing a code qualifying this request as either a ROM or Code 'page in' (see TPagingRequestId) or a data page-in/out.
sl@0	1913
sl@0	1914	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1915	*/
sl@0	1916	EPagingMediaLocMedPageInPagedIn,
sl@0	1917
sl@0	1918	/**
sl@0	1919	Event generated by the Local Media Subsystem when a request to 'page in' data is deferred.
sl@0	1920
sl@0	1921	Trace data format:
sl@0	1922	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1923	- 4 bytes containing a code qualifying this request as either a ROM or Code 'page in' (see TPagingRequestId) or a data page-in/out..
sl@0	1924
sl@0	1925	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1926	*/
sl@0	1927	EPagingMediaLocMedPageInDeferred,
sl@0	1928
sl@0	1929	/**
sl@0	1930	Event generated by the Local Media Subsystem when a request to 'page in' data that has been deferred is re-posted.
sl@0	1931
sl@0	1932	Trace data format:
sl@0	1933	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1934	- 4 bytes containing a code qualifying this request as either a ROM or Code 'page in' (see TPagingRequestId) or a data page-in/out..
sl@0	1935
sl@0	1936	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1937	*/
sl@0	1938	EPagingMediaLocMedPageInDeferredReposted,
sl@0	1939
sl@0	1940	/**
sl@0	1941	Event generated by the Local Media Subsystem when a request to 'page in' data is re-deferred.
sl@0	1942
sl@0	1943	Trace data format:
sl@0	1944	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1945	- 4 bytes containing a code qualifying this request as either a ROM or Code 'page in' (see TPagingRequestId) or a data page-in/out..
sl@0	1946
sl@0	1947	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1948	*/
sl@0	1949	EPagingMediaLocMedPageInReDeferred,
sl@0	1950
sl@0	1951	/**
sl@0	1952	Event generated by the Local Media Subsystem when a request to 'page in' data is issued when the media is not yet open.
sl@0	1953
sl@0	1954	Trace data format:
sl@0	1955	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1956	- 4 bytes containing the state of the media (one of TMediaState).
sl@0	1957	- 4 bytes containing a code qualifying this request as either a ROM or Code 'page in' (see TPagingRequestId) or a data page-in/out..
sl@0	1958
sl@0	1959	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1960	*/
sl@0	1961	EPagingMediaLocMedPageInQuietlyDeferred,
sl@0	1962
sl@0	1963	/**
sl@0	1964	Event generated by the Local Media Subsystem when a fragment of a Write request is created and is ready to be sent to the Media
sl@0	1965	Driver thread .
sl@0	1966
sl@0	1967	Trace data format:
sl@0	1968	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1969	- 4 bytes containing the ID of this fragment (middle or last).
sl@0	1970	- 4 bytes containing the length of data in this request fragment.
sl@0	1971	- 4 bytes containing the offset within the original request to the start of data in this fragment.
sl@0	1972	- 4 bytes containing the offset from start of the partition to where the data in this fragment is to be written.
sl@0	1973	- 4 bytes containing the address of the DThread object representing the thread that issued the original Write request.
sl@0	1974
sl@0	1975	The context id (NThread*) in this trace is that of the File Server drive thread that issued the original Write request.
sl@0	1976	*/
sl@0	1977	EPagingMediaLocMedFragmentBegin,
sl@0	1978
sl@0	1979	/**
sl@0	1980	Event generated by the Local Media Subsystem when a Write fragment is completed .
sl@0	1981
sl@0	1982	Trace data format:
sl@0	1983	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1984	- 4 bytes containing the completion code to be returned.
sl@0	1985
sl@0	1986	The context id (NThread*) in this trace is that of the File Server drive thread that issued the original Write request.
sl@0	1987	*/
sl@0	1988	EPagingMediaLocMedFragmentEnd,
sl@0	1989
sl@0	1990	/**
sl@0	1991	Event generated when the Media Driver starts processing a request to 'page in' data in its specific Request(..) function.
sl@0	1992
sl@0	1993	Trace data format:
sl@0	1994	- 4 bytes containing a code describing the type of the media (one of TMediaDevice).
sl@0	1995	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	1996
sl@0	1997	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	1998	*/
sl@0	1999	EPagingMediaPagingMedDrvBegin,
sl@0	2000
sl@0	2001	/**
sl@0	2002	Event generated by the Media Driver when the data read by a 'page in' request is written to the paging buffer.
sl@0	2003
sl@0	2004	Trace data format:
sl@0	2005	- 4 bytes containing a code describing the type of the media (one of TMediaDevice).
sl@0	2006	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	2007	- 4 bytes containing the linear address of the buffer to where the data is to be written.
sl@0	2008	- 4 bytes containing the offset within the buffer to where the data will be written.
sl@0	2009	- 4 bytes containing the length of data to be written.
sl@0	2010
sl@0	2011	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	2012	*/
sl@0	2013	EPagingMediaMedDrvWriteBack,
sl@0	2014
sl@0	2015	/**
sl@0	2016	Event generated when a request to 'page in' data is put on hold because the Media Driver is performing some background
sl@0	2017	operation (not another request) and cannot service the request.
sl@0	2018
sl@0	2019	Trace data format:
sl@0	2020	- 4 bytes containing a code describing the type of the media (one of TMediaDevice).
sl@0	2021	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	2022
sl@0	2023	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	2024	*/
sl@0	2025	EPagingMediaMedDrvOnHold,
sl@0	2026
sl@0	2027	/**
sl@0	2028	Event generated by the Media Driver when the data read by a 'page out' request is read from the paging buffer.
sl@0	2029
sl@0	2030	Trace data format:
sl@0	2031	- 4 bytes containing a code describing the type of the media (one of TMediaDevice).
sl@0	2032	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	2033	- 4 bytes containing the linear address of the buffer to where the data is to be written.
sl@0	2034	- 4 bytes containing the offset within the buffer to where the data will be written.
sl@0	2035	- 4 bytes containing the length of data to be written.
sl@0	2036
sl@0	2037	The context id (NThread*) in this trace is that of the media driver thread that services this 'page in' request.
sl@0	2038	*/
sl@0	2039	EPagingMediaMedDrvRead,
sl@0	2040
sl@0	2041	/**
sl@0	2042	Event generated when a request to 'page out' data is received by the Local Media Subsystem.
sl@0	2043
sl@0	2044	Trace data format:
sl@0	2045	- 4 bytes containing the linear address of the buffer from where the data is to be read.
sl@0	2046	- 4 bytes containing the offset from start of the partition to where the data to be paged out resides.
sl@0	2047	- 4 bytes containing the number of bytes to be written to the media.
sl@0	2048	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	2049
sl@0	2050	The context id (NThread*) in this trace is that of the thread that took the page fault that caused this event.
sl@0	2051	*/
sl@0	2052	EPagingMediaLocMedPageOutBegin,
sl@0	2053
sl@0	2054	/**
sl@0	2055	Event generated when a request to mark an area of the swap file as deleted is received by the Local Media Subsystem.
sl@0	2056
sl@0	2057	Trace data format:
sl@0	2058	- 4 bytes containing NULL
sl@0	2059	- 4 bytes containing the offset from start of the partition to where the data to be paged out resides.
sl@0	2060	- 4 bytes containing the number of bytes to be marked as deleted
sl@0	2061	- 4 bytes containing the linear address in memory where this request object resides.
sl@0	2062
sl@0	2063	The context id (NThread*) in this trace is that of the thread that took the page fault that caused this event.
sl@0	2064	*/
sl@0	2065	EPagingMediaLocMedDeleteNotifyBegin,
sl@0	2066
sl@0	2067	};
sl@0	2068
sl@0	2069	/**
sl@0	2070	Enumeration of sub-category values for trace category EKernelMemory.
sl@0	2071	@see EKernelMemory
sl@0	2072	*/
sl@0	2073	enum TKernelMemory
sl@0	2074	{
sl@0	2075	/**
sl@0	2076	Event recorded during startup and prime which details the initial amount of free RAM.
sl@0	2077
sl@0	2078	Trace data format:
sl@0	2079	- 4 bytes containing the number of bytes of RAM the system started with.
sl@0	2080	*/
sl@0	2081	EKernelMemoryInitialFree,
sl@0	2082
sl@0	2083	/**
sl@0	2084	Event recorded during prime which records the then-current amount of free RAM.
sl@0	2085
sl@0	2086	Trace data format:
sl@0	2087	- 4 bytes containing the number of bytes of free RAM.
sl@0	2088	*/
sl@0	2089	EKernelMemoryCurrentFree,
sl@0	2090
sl@0	2091	/**
sl@0	2092	Event recorded when a miscellaneous kernel allocation is made. These include:
sl@0	2093	- Memory for MMU page table contents
sl@0	2094	- Memory for MMU SPageTableInfos
sl@0	2095	- Memory for shadow pages
sl@0	2096
sl@0	2097	Trace data format:
sl@0	2098	- 4 bytes containing the size, in bytes, of the allocation.
sl@0	2099	*/
sl@0	2100	EKernelMemoryMiscAlloc,
sl@0	2101
sl@0	2102	/**
sl@0	2103	Event recorded when a miscellaneous kernel allocation (see EKernelMemoryMiscAlloc
sl@0	2104	above) is freed.
sl@0	2105
sl@0	2106	Trace data format:
sl@0	2107	- 4 bytes containing the size, in bytes, of the freed allocation.
sl@0	2108	*/
sl@0	2109	EKernelMemoryMiscFree,
sl@0	2110
sl@0	2111	/**
sl@0	2112	The amount of memory reserved for the minimum demand paging cache. The actual DP cache
sl@0	2113	also uses free memory, only this minimum amount is permanently reserved for that purpose.
sl@0	2114	This event is recorded during prime and when the amount changes.
sl@0	2115
sl@0	2116	Trace data format:
sl@0	2117	- 4 bytes containing the minimum size, in bytes, of the demand paging cache.
sl@0	2118	*/
sl@0	2119	EKernelMemoryDemandPagingCache,
sl@0	2120
sl@0	2121	/**
sl@0	2122	Physically contiguous memory allocated by device drivers via one of:
sl@0	2123	Epoc::AllocPhysicalRam()
sl@0	2124	Epoc::ZoneAllocPhysicalRam()
sl@0	2125	Epoc::ClaimPhysicalRam()
sl@0	2126	TRamDefragRequest::ClaimRamZone()
sl@0	2127
sl@0	2128	Trace data format:
sl@0	2129	- 4 bytes containing the size of the allocated memory.
sl@0	2130	- 4 bytes containing the physical base address of allocated memory.
sl@0	2131
sl@0	2132	NB: The prime function logs a EKernelMemoryDrvPhysAlloc record where the physical
sl@0	2133	address is -1 and should be ignored.
sl@0	2134	*/
sl@0	2135	EKernelMemoryDrvPhysAlloc,
sl@0	2136
sl@0	2137	/**
sl@0	2138	Memory freed by device drivers via calls to all versions of
sl@0	2139	Epoc::FreePhysicalRam().
sl@0	2140
sl@0	2141	Trace data format:
sl@0	2142	- 4 bytes containing the size of the freed memory.
sl@0	2143	- 4 bytes containing the physical base address of freed memory.
sl@0	2144	*/
sl@0	2145	EKernelMemoryDrvPhysFree,
sl@0	2146	};
sl@0	2147
sl@0	2148	/**
sl@0	2149	Enumeration of sub-category values for trace category EHeap.
sl@0	2150	@see EHeap
sl@0	2151	*/
sl@0	2152	enum THeap
sl@0	2153	{
sl@0	2154	/**
sl@0	2155	Event recorded during process startup which logs the point of heap creation.
sl@0	2156
sl@0	2157	Trace data format:
sl@0	2158	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2159	- 2 bytes containing the size of header overhead, per allocation (0xFFFF indicates a variable size)
sl@0	2160	- 2 bytes containing the size of footer overhead, per allocation (0xFFFF indicates a variable size)
sl@0	2161	*/
sl@0	2162	EHeapCreate,
sl@0	2163
sl@0	2164	/**
sl@0	2165	Event recorded during process startup which details the chunk being used as a heap.
sl@0	2166
sl@0	2167	Trace data format:
sl@0	2168	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2169	- 4 bytes containing the chunk ID (The RHandleBase* of the chunk)
sl@0	2170	*/
sl@0	2171	EHeapChunkCreate,
sl@0	2172
sl@0	2173	/**
sl@0	2174	Event recorded when RHeap::Alloc() is called.
sl@0	2175
sl@0	2176	Trace data format:
sl@0	2177	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2178	- 4 bytes containing the address of the allocation
sl@0	2179	- 4 bytes containing the size of the allocation
sl@0	2180	- 4 bytes containing the requested size of allocation
sl@0	2181	*/
sl@0	2182	EHeapAlloc,
sl@0	2183
sl@0	2184	/**
sl@0	2185	Event recorded when RHeap::ReAlloc() is called.
sl@0	2186
sl@0	2187	Trace data format:
sl@0	2188	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2189	- 4 bytes containing the address of the new allocation
sl@0	2190	- 4 bytes containing the size of the allocation
sl@0	2191	- 4 bytes containing the requested size of allocation
sl@0	2192	- 4 bytes containing the address of the old allocation
sl@0	2193	*/
sl@0	2194	EHeapReAlloc,
sl@0	2195
sl@0	2196	/**
sl@0	2197	Event recorded when RHeap::Free() is called.
sl@0	2198
sl@0	2199	Trace data format:
sl@0	2200	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2201	- 4 bytes containing the address of the free'd allocation
sl@0	2202	*/
sl@0	2203	EHeapFree,
sl@0	2204
sl@0	2205	/**
sl@0	2206	Event recorded when RHeap::Alloc() fails.
sl@0	2207
sl@0	2208	Trace data format:
sl@0	2209	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2210	- 4 bytes containing the requested size of allocation
sl@0	2211	*/
sl@0	2212	EHeapAllocFail,
sl@0	2213
sl@0	2214	/**
sl@0	2215	Event recorded when RHeap::ReAlloc() fails.
sl@0	2216
sl@0	2217	Trace data format:
sl@0	2218	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2219	- 4 bytes containing the address of the old allocation
sl@0	2220	- 4 bytes containing the requested size of allocation
sl@0	2221	*/
sl@0	2222	EHeapReAllocFail,
sl@0	2223
sl@0	2224	/**
sl@0	2225	Event recorded when heap memory corruption occurs.
sl@0	2226
sl@0	2227	Trace data format:
sl@0	2228	- 4 bytes containing the heap ID (The RAllocator*)
sl@0	2229	- 4 bytes containing address of the corrupted memory block
sl@0	2230	- 4 bytes containing length of the corrupted memory block
sl@0	2231	*/
sl@0	2232	EHeapCorruption,
sl@0	2233
sl@0	2234	/**
sl@0	2235	Trace to provide additional heap debugging information.
sl@0	2236
sl@0	2237	This trace (if present) is generated by Symbian OS memory debug tools, and
sl@0	2238	will follow one of the other THeap events (e.g. EHeapAlloc, EHeapFree, etc.).
sl@0	2239	It is intended to provide a stack trace for the preceding heap event,
sl@0	2240	to indicate how the previous heap event was generated.
sl@0	2241
sl@0	2242	On many systems exact stack frames are not available, and the values
sl@0	2243	will be extracted from the stack using heuristics, so there may be some
sl@0	2244	spurious values and some missing values.
sl@0	2245
sl@0	2246	Trace data format:
sl@0	2247	- 4 bytes containing the heap ID (the RAllocator*)
sl@0	2248	- sequence of 4-byte PC values representing the call stack, with the top-most
sl@0	2249	(most recent call) first.
sl@0	2250	*/
sl@0	2251	EHeapCallStack,
sl@0	2252	};
sl@0	2253
sl@0	2254	/**
sl@0	2255	Enumeration of sub-category values for trace category EMetaTrace.
sl@0	2256	@see EMetaTrace
sl@0	2257	*/
sl@0	2258	enum TMetaTrace
sl@0	2259	{
sl@0	2260	/**
sl@0	2261	Information about timestamps used for tracing.
sl@0	2262
sl@0	2263	Trace data format:
sl@0	2264	- 4 bytes containing the period of the Timestamp value.
sl@0	2265	- 4 bytes containing the period of the Timestamp2 value.
sl@0	2266	- 4 bytes containing a set of bit flags with the following meaning:
sl@0	2267	- Bit 0, if true, indicates that Timestamp and Timestamp2 are two halves
sl@0	2268	of a single 64bit timestamp value; Timestamp2 is the most significant part.
sl@0	2269	- All other bits are presently undefined.
sl@0	2270
sl@0	2271	The format of the timestamp period data is a period in seconds given using an exponent and mantissa
sl@0	2272	format, where the most significant 8 bits are the signed power-of-two value for the exponent, and
sl@0	2273	the least significant 24 bits are the integer value of the mantissa. The binary point is to the right
sl@0	2274	of the least significant mantissa bit, and the mantissa may not be in normalised form.
sl@0	2275
sl@0	2276	Example code for decoding the period:
sl@0	2277	@code
sl@0	2278	TInt32 period; // value from trace record
sl@0	2279	int exponent = (signed char)(period>>24);
sl@0	2280	int mantissa = period&0xffffff;
sl@0	2281	double periodInSeconds = (double)mantissa*pow(2,exponent);
sl@0	2282	@endcode
sl@0	2283	*/
sl@0	2284	EMetaTraceTimestampsInfo,
sl@0	2285
sl@0	2286	/**
sl@0	2287	Trace indicating the start of a test case being measured.
sl@0	2288
sl@0	2289	Trace data format:
sl@0	2290	- 4 bytes containing measurement specific value.
sl@0	2291	- 4 bytes containing a further measurement specific value.
sl@0	2292	- Remaining data is ASCII text providing human readable information.
sl@0	2293	*/
sl@0	2294	EMetaTraceMeasurementStart,
sl@0	2295
sl@0	2296	/**
sl@0	2297	Trace indicating the end of a test case being measured.
sl@0	2298
sl@0	2299	Trace data format:
sl@0	2300	- 4 bytes containing measurement specific identifying value.
sl@0	2301	- 4 bytes containing a further measurement specific identifying value.
sl@0	2302
sl@0	2303	The values contained in this trace must be identical to those in the corresponding
sl@0	2304	ETraceInfoMeasurementStart trace.
sl@0	2305	*/
sl@0	2306	EMetaTraceMeasurementEnd,
sl@0	2307
sl@0	2308	/**
sl@0	2309	Trace indicating a change in state of the primary filter.
sl@0	2310
sl@0	2311	Trace data format:
sl@0	2312	- 1 byte containing a trace category number.
sl@0	2313	- 1 byte containing the new filter state for the category. (0=off, 1=on).
sl@0	2314	- 2 byte padding. (Should be output as zeros.)
sl@0	2315	*/
sl@0	2316	EMetaTraceFilterChange,
sl@0	2317	};
sl@0	2318
sl@0	2319	/**
sl@0	2320	Enumeration of sub-category values for trace category ERamAllocator.
sl@0	2321	@see BTrace::ERamAllocator
sl@0	2322	*/
sl@0	2323	enum TRamAllocator
sl@0	2324	{
sl@0	2325	/**
sl@0	2326	The number of RAM zones.
sl@0	2327
sl@0	2328	Trace data format:
sl@0	2329	- 4 bytes containing the number of RAM zones.
sl@0	2330	*/
sl@0	2331	ERamAllocZoneCount,
sl@0	2332
sl@0	2333	/**
sl@0	2334	Information on the layout of a RAM zone.
sl@0	2335
sl@0	2336	Trace data format:
sl@0	2337	- 4 bytes containing the number of pages in the zone
sl@0	2338	- 4 bytes containing the physical base address of the zone
sl@0	2339	- 4 bytes containing the ID of the zone
sl@0	2340	- 1 bytes containing the preference of the zone
sl@0	2341	- 1 bytes containing the flags of the zone
sl@0	2342	- 2 bytes reserved for future use
sl@0	2343	*/
sl@0	2344	ERamAllocZoneConfig,
sl@0	2345
sl@0	2346	/**
sl@0	2347	This trace is sent for every contiguous block of RAM that was allocated
sl@0	2348	during the kernel boot process.
sl@0	2349
sl@0	2350	Trace data format:
sl@0	2351	- 4 bytes containing the number of contiguous pages allocated for the block
sl@0	2352	- 4 bytes containing the physical base address of the block
sl@0	2353	*/
sl@0	2354	ERamAllocBootAllocation,
sl@0	2355
sl@0	2356
sl@0	2357	/**
sl@0	2358	This trace marks the end of the boot allocations
sl@0	2359
sl@0	2360	Trace data format:
sl@0	2361	- no extra bytes are sent
sl@0	2362	*/
sl@0	2363	ERamAllocBootAllocationEnd,
sl@0	2364
sl@0	2365	/**
sl@0	2366	Event generated when a RAM zone's flags have been modified
sl@0	2367	This could occur when a RAM zone is blocked/unblocked from further
sl@0	2368	allocations from all/certain page types.
sl@0	2369
sl@0	2370	Trace data format:
sl@0	2371	- 4 bytes containing the ID of the zone
sl@0	2372	- 4 bytes containing the flags of the zone
sl@0	2373	*/
sl@0	2374	ERamAllocZoneFlagsModified,
sl@0	2375
sl@0	2376	/**
sl@0	2377	Event generated when DRamAllocator::ClaimPhysicalRam has successfully
sl@0	2378	claimed the specified RAM pages.
sl@0	2379
sl@0	2380	Trace data format:
sl@0	2381	- 4 bytes containing the number of contiguous pages
sl@0	2382	- 4 bytes containing the base address of the pages
sl@0	2383	*/
sl@0	2384	ERamAllocClaimRam,
sl@0	2385
sl@0	2386	/**
sl@0	2387	Event generated when DRamAllocator::MarkPageAllocated has successfully
sl@0	2388	marked the specified page as allocated.
sl@0	2389
sl@0	2390	Trace data format:
sl@0	2391	- 4 bytes containing the TZonePageType type of the page
sl@0	2392	- 4 bytes containing the address of the page
sl@0	2393	*/
sl@0	2394	ERamAllocMarkAllocated,
sl@0	2395
sl@0	2396	/**
sl@0	2397	Event generated when DRamAllocator::AllocContiguousRam successfully
sl@0	2398	allocates the requested number of pages.
sl@0	2399
sl@0	2400	Trace data format:
sl@0	2401	- 4 bytes containing the TZonePageType type of the pages
sl@0	2402	- 4 bytes containing the number of contiguous pages
sl@0	2403	- 4 bytes containing the base address of the pages
sl@0	2404	*/
sl@0	2405	ERamAllocContiguousRam,
sl@0	2406
sl@0	2407	/**
sl@0	2408	Event generated when DRamAllocator::FreePage has successfully freed
sl@0	2409	the specified RAM page.
sl@0	2410
sl@0	2411	Trace data format:
sl@0	2412	- 4 bytes containing the TZonePageType type of the page
sl@0	2413	- 4 bytes containing the address of the page
sl@0	2414	*/
sl@0	2415	ERamAllocFreePage,
sl@0	2416
sl@0	2417	/**
sl@0	2418	Event generated when DRamAllocator::FreePhysical successfully freed
sl@0	2419	the specified RAM page(s).
sl@0	2420
sl@0	2421	Trace data format:
sl@0	2422	- 4 bytes containing the number of contiguous pages
sl@0	2423	- 4 bytes containing the base address of the pages
sl@0	2424	*/
sl@0	2425	ERamAllocFreePhysical,
sl@0	2426
sl@0	2427	/**
sl@0	2428	Event generated for each contiguous block of pages when
sl@0	2429	DRamAllocator::AllocRamPages or DRamAllocator::ZoneAllocRamPages
sl@0	2430	are attempting to fulfil a request.
sl@0	2431
sl@0	2432	Trace data format:
sl@0	2433	- 4 bytes containing the TZonePageType type of the pages
sl@0	2434	- 4 bytes containing the number of contiguous pages
sl@0	2435	- 4 bytes containing the base address of the pages
sl@0	2436	*/
sl@0	2437	ERamAllocRamPages,
sl@0	2438
sl@0	2439	/**
sl@0	2440	Event generated for contiguous block of pages when
sl@0	2441	DRamAllocator::FreeRamPages is invoked.
sl@0	2442
sl@0	2443	Trace data format:
sl@0	2444	- 4 bytes containing the TZonePageType type of the pages
sl@0	2445	- 4 bytes containing the number of contiguous pages
sl@0	2446	- 4 bytes containing the base address of the pages
sl@0	2447	*/
sl@0	2448	ERamAllocFreePages,
sl@0	2449
sl@0	2450	/**
sl@0	2451	Event generated when DRamAllocator::AllocRamPages has successfully
sl@0	2452	allocated all the requested number of RAM pages. If DRamAllocator::AllocRamPages
sl@0	2453	couldn't allocate all the requested pages then this event is not generated.
sl@0	2454
sl@0	2455	Trace data format:
sl@0	2456	- no extra bytes sent
sl@0	2457	*/
sl@0	2458	ERamAllocRamPagesEnd,
sl@0	2459
sl@0	2460	/**
sl@0	2461	Event generated when all ERamAllocFreePages events for a particular
sl@0	2462	call of DRamAllocator::FreeRamPages have been generated.
sl@0	2463
sl@0	2464	Trace data format:
sl@0	2465	- no extra bytes sent
sl@0	2466	*/
sl@0	2467	ERamAllocFreePagesEnd,
sl@0	2468
sl@0	2469	/**
sl@0	2470	Event generated when DRamAllocator::ChangePageType is has successfully
sl@0	2471	updated the type of the specified page.
sl@0	2472
sl@0	2473	Trace data format:
sl@0	2474	- 4 bytes containing the new TZonePageType type of the page
sl@0	2475	- 4 bytes containing the physical address of the page
sl@0	2476	*/
sl@0	2477	ERamAllocChangePageType,
sl@0	2478
sl@0	2479	/**
sl@0	2480	Event generated when DRamAllocator::ZoneAllocContiguousRam has
sl@0	2481	successfully allocated the required number of pages.
sl@0	2482
sl@0	2483	Trace data format:
sl@0	2484	- 4 bytes containing the TZonePageType type of the pages
sl@0	2485	- 4 bytes containing the number of contiguous pages
sl@0	2486	- 4 bytes containing the base address of the pages
sl@0	2487	*/
sl@0	2488	ERamAllocZoneContiguousRam,
sl@0	2489
sl@0	2490	/**
sl@0	2491	Event generated when DRamAllocator::ZoneAllocRamPages has successfully
sl@0	2492	allocated all the requested RAM pages. If DRamAllocator::ZoneAllocRamPages
sl@0	2493	couldn't allocate all the requested pages then this event is not generated.
sl@0	2494
sl@0	2495	Trace data format:
sl@0	2496	- no extra bytes sent
sl@0	2497	*/
sl@0	2498	ERamAllocZoneRamPagesEnd,
sl@0	2499
sl@0	2500	/**
sl@0	2501	Event generated when Epoc::ClaimRamZone has successfully claimed
sl@0	2502	the requested zone.
sl@0	2503
sl@0	2504	Trace data format:
sl@0	2505	- 4 bytes containing the ID of the zone that has been claimed.
sl@0	2506	*/
sl@0	2507	ERamAllocClaimZone,
sl@0	2508	};
sl@0	2509
sl@0	2510	enum TFastMutex
sl@0	2511	{
sl@0	2512	/**
sl@0	2513	Event generated when a thread acquires a fast mutex, (waits on it).
sl@0	2514
sl@0	2515	Trace data format:
sl@0	2516	- 4 bytes containing the fast mutex id, (an NFastMutex*).
sl@0	2517	*/
sl@0	2518	EFastMutexWait,
sl@0	2519
sl@0	2520	/**
sl@0	2521	Event generated when a thread releases a fast mutex, (signals it).
sl@0	2522
sl@0	2523	Trace data format:
sl@0	2524	- 4 bytes containing the fast mutex id, (an NFastMutex*).
sl@0	2525	*/
sl@0	2526	EFastMutexSignal,
sl@0	2527
sl@0	2528	/**
sl@0	2529	Event generated when a fast mutex is 'flashed' (signalled then immediately
sl@0	2530	waited on again). E.g the operation performed by NKern::FlashSystem.
sl@0	2531
sl@0	2532	Trace data format:
sl@0	2533	- 4 bytes containing the fast mutex id, (an NFastMutex*).
sl@0	2534	*/
sl@0	2535	EFastMutexFlash,
sl@0	2536
sl@0	2537	/**
sl@0	2538	Trace to associate a fast mutex with a textual name.
sl@0	2539
sl@0	2540	Trace data format:
sl@0	2541	- 4 bytes containing the fast mutex id, (an NFastMutex*).
sl@0	2542	- 4 bytes containing unspecified data (should be output as zero).
sl@0	2543	- Remaining data is the ASCII name for the fast mutex.
sl@0	2544	*/
sl@0	2545	EFastMutexName,
sl@0	2546
sl@0	2547	/**
sl@0	2548	Event generated when a thread blocks on a fast mutex.
sl@0	2549
sl@0	2550	Trace data format:
sl@0	2551	- 4 bytes containing the fast mutex id, (an NFastMutex*).
sl@0	2552	*/
sl@0	2553	EFastMutexBlock,
sl@0	2554	};
sl@0	2555
sl@0	2556	/**
sl@0	2557	Enumeration of sub-category values for trace category EProfiling.
sl@0	2558	@see BTrace::EProfiling
sl@0	2559	*/
sl@0	2560	enum TProfiling
sl@0	2561	{
sl@0	2562	/**
sl@0	2563	CPU sample including program counter and thread context.
sl@0	2564
sl@0	2565	Trace data format:
sl@0	2566	- 4 bytes containing the program counter.
sl@0	2567	- 4 bytes containing thread context (an NThread*).
sl@0	2568	*/
sl@0	2569	ECpuFullSample = 0,
sl@0	2570
sl@0	2571	/**
sl@0	2572	Optimised CPU sample including program counter.
sl@0	2573	Doesn't include a thread context id as it hasn't changed since
sl@0	2574	the last sample.
sl@0	2575
sl@0	2576	Trace data format:
sl@0	2577	- 4 bytes containing the program counter.
sl@0	2578	*/
sl@0	2579	ECpuOptimisedSample,
sl@0	2580
sl@0	2581	/**
sl@0	2582	CPU sample from iDFC including program counter.
sl@0	2583
sl@0	2584	Trace data format:
sl@0	2585	- 4 bytes containing the program counter.
sl@0	2586	*/
sl@0	2587	ECpuIdfcSample,
sl@0	2588
sl@0	2589	/**
sl@0	2590	CPU sample from non-Symbian thread.
sl@0	2591
sl@0	2592	Trace data format:
sl@0	2593	- no extra bytes are sent
sl@0	2594	*/
sl@0	2595	ECpuNonSymbianThreadSample
sl@0	2596
sl@0	2597	};
sl@0	2598
sl@0	2599	/**
sl@0	2600	Enumeration of sub-category values for trace category ERawEvent.
sl@0	2601	@see BTrace::ERawEvent
sl@0	2602	*/
sl@0	2603	enum TRawEventTrace
sl@0	2604	{
sl@0	2605
sl@0	2606	/**
sl@0	2607	For all the set Functions in the TRawEvent class.
sl@0	2608	Trace Data Format Varies depends which of the Overloaded Set Method from where its set .
sl@0	2609	Trace data format:
sl@0	2610	if there are only one 4 byte data
sl@0	2611
sl@0	2612	--The Following oder is folloed for data.
sl@0	2613	- 4 bytes containing the event type
sl@0	2614
sl@0	2615	if there are 2*4 byte data
sl@0	2616	- 4 bytes containing the event type
sl@0	2617	- 4 bytes containing the scan code
sl@0	2618
sl@0	2619	if there are 3*4 byte data
sl@0	2620	- 4 bytes containing the event type
sl@0	2621	--4 bytes containining the X co-ordinate
sl@0	2622	--4 bytes containining the Y co-ordinate
sl@0	2623
sl@0	2624	if there are 4*4 byte data
sl@0	2625	- 4 bytes containing the event type
sl@0	2626	--4 bytes containining the X co-ordinate
sl@0	2627	--4 bytes containining the Y co-ordinate
sl@0	2628	--4 bytes containining the Z co-ordinate
sl@0	2629
sl@0	2630	if there are 5*4 byte data
sl@0	2631	- 4 bytes containing the event type
sl@0	2632	--4 bytes containining the X co-ordinate
sl@0	2633	--4 bytes containining the Y co-ordinate
sl@0	2634	--4 bytes containining the Z co-ordinate
sl@0	2635	--4 bytes containining the PointerNumber
sl@0	2636
sl@0	2637	if there are 7*4 byte data
sl@0	2638	- 4 bytes containing the event type
sl@0	2639	--4 bytes containining the X co-ordinate
sl@0	2640	--4 bytes containining the Y co-ordinate
sl@0	2641	--4 bytes containining the Z co-ordinate
sl@0	2642	--4 bytes containining the Phi polar coordinate.
sl@0	2643	--4 bytes containining the Theta polar coordinate.
sl@0	2644	--4 bytes containining the rotation angle(alpha)
sl@0	2645	*/
sl@0	2646
sl@0	2647	ESetEvent = 1,
sl@0	2648
sl@0	2649	/**
sl@0	2650	For user side SetTip Events
sl@0	2651	Trace data format:
sl@0	2652	- 4 bytes to state containing Tip Info.
sl@0	2653	*/
sl@0	2654	ESetTipEvent,
sl@0	2655
sl@0	2656	/**
sl@0	2657	For SetTilt Events
sl@0	2658	Trace data format:
sl@0	2659	- 4 bytes containing the event type
sl@0	2660	--4 bytes containining the Phi polar coordinate.
sl@0	2661	--4 bytes containining the Theta polar coordinate.
sl@0	2662	*/
sl@0	2663	ESetTiltEvent,
sl@0	2664
sl@0	2665	/**
sl@0	2666	For SetRotation Events
sl@0	2667	Trace data format:
sl@0	2668	- 4 bytes containing the event type
sl@0	2669	--4 bytes containining the rotation angle (alpha)
sl@0	2670	*/
sl@0	2671	ESetRotationtEvent,
sl@0	2672
sl@0	2673	/**
sl@0	2674	For SetPointerNumber Events
sl@0	2675	Trace data format:
sl@0	2676	- 4 bytes containing the Pointer Number
sl@0	2677	*/
sl@0	2678	ESetPointerNumberEvent,
sl@0	2679
sl@0	2680	/**
sl@0	2681	For user side addevents (User::AddEvent)
sl@0	2682	Trace data format:
sl@0	2683	- 4 bytes containing the event type
sl@0	2684	*/
sl@0	2685	EUserAddEvent,
sl@0	2686
sl@0	2687	/**
sl@0	2688	For kernal side addevents (Kern::AddEvent)
sl@0	2689	Trace data format:
sl@0	2690	- 4 bytes containing the event type
sl@0	2691	*/
sl@0	2692	EKernelAddEvent
sl@0	2693	};
sl@0	2694
sl@0	2695	enum TSymbianKernelSync
sl@0	2696	{
sl@0	2697	/**
sl@0	2698	A semaphore (DSemaphore) has been created.
sl@0	2699
sl@0	2700	Trace data format:
sl@0	2701	- 4 bytes containing trace id (a DSemaphore*) for this semaphore.
sl@0	2702	- 4 bytes containing the owning DThread* or DProcess*
sl@0	2703	- Remaining data is the ASCII name of the semaphore.
sl@0	2704	*/
sl@0	2705	ESemaphoreCreate=0x00,
sl@0	2706
sl@0	2707	/**
sl@0	2708	A semaphore (DSemaphore) has been destroyed.
sl@0	2709
sl@0	2710	Trace data format:
sl@0	2711	- 4 bytes containing trace id (a DSemaphore*) for this semaphore.
sl@0	2712	*/
sl@0	2713	ESemaphoreDestroy=0x01,
sl@0	2714
sl@0	2715	/**
sl@0	2716	A semaphore (DSemaphore) has been acquired.
sl@0	2717
sl@0	2718	Trace data format:
sl@0	2719	- 4 bytes containing trace id (a DSemaphore*) for this semaphore.
sl@0	2720	*/
sl@0	2721	ESemaphoreAcquire=0x02,
sl@0	2722
sl@0	2723	/**
sl@0	2724	A semaphore (DSemaphore) has been released.
sl@0	2725
sl@0	2726	Trace data format:
sl@0	2727	- 4 bytes containing trace id (a DSemaphore*) for this semaphore.
sl@0	2728	*/
sl@0	2729	ESemaphoreRelease=0x03,
sl@0	2730
sl@0	2731	/**
sl@0	2732	A thread has blocked on a semaphore (DSemaphore)
sl@0	2733
sl@0	2734	Trace data format:
sl@0	2735	- 4 bytes containing trace id (a DSemaphore*) for this semaphore.
sl@0	2736	*/
sl@0	2737	ESemaphoreBlock=0x04,
sl@0	2738
sl@0	2739
sl@0	2740	/**
sl@0	2741	A mutex (DMutex) has been created.
sl@0	2742
sl@0	2743	Trace data format:
sl@0	2744	- 4 bytes containing trace id (a DMutex*) for this mutex.
sl@0	2745	- 4 bytes containing the owning DThread* or DProcess*
sl@0	2746	- Remaining data is the ASCII name of the mutex.
sl@0	2747	*/
sl@0	2748	EMutexCreate=0x10,
sl@0	2749
sl@0	2750	/**
sl@0	2751	A mutex (DMutex) has been destroyed.
sl@0	2752
sl@0	2753	Trace data format:
sl@0	2754	- 4 bytes containing trace id (a DMutex*) for this mutex.
sl@0	2755	*/
sl@0	2756	EMutexDestroy=0x11,
sl@0	2757
sl@0	2758	/**
sl@0	2759	A mutex (DMutex) has been acquired.
sl@0	2760
sl@0	2761	Trace data format:
sl@0	2762	- 4 bytes containing trace id (a DMutex*) for this mutex.
sl@0	2763	*/
sl@0	2764	EMutexAcquire=0x12,
sl@0	2765
sl@0	2766	/**
sl@0	2767	A mutex (DMutex) has been released.
sl@0	2768
sl@0	2769	Trace data format:
sl@0	2770	- 4 bytes containing trace id (a DMutex*) for this mutex.
sl@0	2771	*/
sl@0	2772	EMutexRelease=0x13,
sl@0	2773
sl@0	2774	/**
sl@0	2775	A thread has blocked on a mutex (DMutex)
sl@0	2776
sl@0	2777	Trace data format:
sl@0	2778	- 4 bytes containing trace id (a DMutex*) for this mutex.
sl@0	2779	*/
sl@0	2780	EMutexBlock=0x14,
sl@0	2781
sl@0	2782
sl@0	2783	/**
sl@0	2784	A condition variable (DCondVar) has been created.
sl@0	2785
sl@0	2786	Trace data format:
sl@0	2787	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2788	- 4 bytes containing the owning DThread* or DProcess*
sl@0	2789	- Remaining data is the ASCII name of the condition variable.
sl@0	2790	*/
sl@0	2791	ECondVarCreate=0x20,
sl@0	2792
sl@0	2793	/**
sl@0	2794	A condition variable (DCondVar) has been destroyed.
sl@0	2795
sl@0	2796	Trace data format:
sl@0	2797	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2798	*/
sl@0	2799	ECondVarDestroy=0x21,
sl@0	2800
sl@0	2801	/**
sl@0	2802	A thread has blocked on a condition variable (DCondVar)
sl@0	2803
sl@0	2804	Trace data format:
sl@0	2805	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2806	- 4 bytes containing trace id (DMutex*) for the associated mutex.
sl@0	2807	*/
sl@0	2808	ECondVarBlock=0x22,
sl@0	2809
sl@0	2810	/**
sl@0	2811	A thread has been released from a condition variable (DCondVar) wait
sl@0	2812
sl@0	2813	Trace data format:
sl@0	2814	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2815	- 4 bytes containing trace id (DMutex*) for the associated mutex.
sl@0	2816	*/
sl@0	2817	ECondVarWakeUp=0x23,
sl@0	2818
sl@0	2819	/**
sl@0	2820	A condition variable (DCondVar) has been signalled
sl@0	2821
sl@0	2822	Trace data format:
sl@0	2823	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2824	- 4 bytes containing trace id (DMutex*) for the associated mutex.
sl@0	2825	*/
sl@0	2826	ECondVarSignal=0x24,
sl@0	2827
sl@0	2828	/**
sl@0	2829	A condition variable (DCondVar) has been signalled in broadcast mode.
sl@0	2830
sl@0	2831	Trace data format:
sl@0	2832	- 4 bytes containing trace id (a DCondVar*) for this condition variable.
sl@0	2833	- 4 bytes containing trace id (DMutex*) for the associated mutex.
sl@0	2834	*/
sl@0	2835	ECondVarBroadcast=0x25,
sl@0	2836
sl@0	2837	};
sl@0	2838
sl@0	2839	enum TFlexibleMemModel
sl@0	2840	{
sl@0	2841	/**
sl@0	2842	A memory object has been created.
sl@0	2843
sl@0	2844	Trace data format:
sl@0	2845	- 4 bytes containing the memory object id (DMemoryObject*).
sl@0	2846	- 4 bytes containing the size of the memory in pages.
sl@0	2847	*/
sl@0	2848	EMemoryObjectCreate,
sl@0	2849
sl@0	2850	/**
sl@0	2851	A memory object has been destroyed.
sl@0	2852
sl@0	2853	Trace data format:
sl@0	2854	- 4 bytes containing the memory object id (DMemoryObject*).
sl@0	2855	*/
sl@0	2856	EMemoryObjectDestroy,
sl@0	2857
sl@0	2858	/**
sl@0	2859	A memory mapping has been created.
sl@0	2860
sl@0	2861	Trace data format:
sl@0	2862	- 4 bytes containing the memory mapping id (DMemoryMapping*).
sl@0	2863	- 4 bytes containing the memory object id (DMemoryObject*).
sl@0	2864	- 4 bytes containing the offset of the mapping into the memory object, in pages
sl@0	2865	- 4 bytes containing the size of the mapping in pages
sl@0	2866	- 2 bytes containing the ASID
sl@0	2867	- 2 spare bytes, currently zero
sl@0	2868	- 4 bytes containing the virtual address the mapping
sl@0	2869	*/
sl@0	2870	EMemoryMappingCreate,
sl@0	2871
sl@0	2872	/**
sl@0	2873	A memory mapping has been destroyed.
sl@0	2874
sl@0	2875	Trace data format:
sl@0	2876	- 4 bytes containing the memory mapping id (DMemoryMapping*).
sl@0	2877	*/
sl@0	2878	EMemoryMappingDestroy,
sl@0	2879
sl@0	2880	// The following traces associate memory model objects with the kernel objects that use them
sl@0	2881
sl@0	2882	/**
sl@0	2883	A memory object is being used for the contents of a chunk.
sl@0	2884
sl@0	2885	Trace data format:
sl@0	2886	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2887	- 4 bytes containing the chunk id (a DChunk*)
sl@0	2888	*/
sl@0	2889	EMemoryObjectIsChunk,
sl@0	2890
sl@0	2891	/**
sl@0	2892	A memory object is being used for the contents of a code segment.
sl@0	2893
sl@0	2894	Trace data format:
sl@0	2895	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2896	- 4 bytes containing the code segment id (a DCodeSeg*)
sl@0	2897	*/
sl@0	2898	EMemoryObjectIsCodeSeg,
sl@0	2899
sl@0	2900	/**
sl@0	2901	A memory object is being used for process static data.
sl@0	2902
sl@0	2903	Trace data format:
sl@0	2904	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2905	- 4 bytes containing the process id (a DProcess*)
sl@0	2906	*/
sl@0	2907	EMemoryObjectIsProcessStaticData,
sl@0	2908
sl@0	2909	/**
sl@0	2910	A memory object is being used for DLL static data.
sl@0	2911
sl@0	2912	Trace data format:
sl@0	2913	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2914	- 4 bytes containing the code segment id (a DCodeSeg*)
sl@0	2915	- 4 bytes containing the process id (a DProcess*)
sl@0	2916	*/
sl@0	2917	EMemoryObjectIsDllStaticData,
sl@0	2918
sl@0	2919	/**
sl@0	2920	A memory object is being used for a thread's supervisor stack.
sl@0	2921
sl@0	2922	Trace data format:
sl@0	2923	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2924	- 4 bytes containing the thread id (a DThread*)
sl@0	2925	*/
sl@0	2926	EMemoryObjectIsSupervisorStack,
sl@0	2927
sl@0	2928	/**
sl@0	2929	A memory object is being used for a thread's user stack.
sl@0	2930
sl@0	2931	Trace data format:
sl@0	2932	- 4 bytes containing the memory object id (a DMemoryObject*).
sl@0	2933	- 4 bytes containing the thread id (a DThread*)
sl@0	2934	*/
sl@0	2935	EMemoryObjectIsUserStack,
sl@0	2936
sl@0	2937	/**
sl@0	2938	Identifies the Address Space ID (ASID) used for a process.
sl@0	2939
sl@0	2940	Trace data format:
sl@0	2941	- 4 bytes containing the process id (a DProcess*)
sl@0	2942	- 2 bytes containing the ASID
sl@0	2943	- 2 spare bytes, currently zero
sl@0	2944	*/
sl@0	2945	EAddressSpaceId
sl@0	2946	};
sl@0	2947
sl@0	2948	/**
sl@0	2949	Enumeration of sub-category values for trace category EIic.
sl@0	2950	@see EIic
sl@0	2951	@prototype 9.6
sl@0	2952	*/
sl@0	2953	enum TIic
sl@0	2954	{
sl@0	2955	/**
sl@0	2956	Trace output for the invocation by the PSL of registering an array of pointers to channels with the IIC bus controller.
sl@0	2957
sl@0	2958	Trace data format:
sl@0	2959	- 4 bytes containing the address of the array
sl@0	2960	- 4 bytes containing the number of channels in the array
sl@0	2961	*/
sl@0	2962	ERegisterChansStartPsl = 0,
sl@0	2963
sl@0	2964	/**
sl@0	2965	Trace output for the start of the PIL registering an array of pointers to channels with the IIC bus controller.
sl@0	2966
sl@0	2967	Trace data format:
sl@0	2968	- 4 bytes containing the address of the array
sl@0	2969	- 4 bytes containing the number of channels in the array
sl@0	2970	- 4 bytes containing the number of channels registered with the controller prior to this point
sl@0	2971	*/
sl@0	2972	ERegisterChansStartPil = 1,
sl@0	2973
sl@0	2974	/**
sl@0	2975	Trace output for the end of the PIL registering an array of pointers to channels with the IIC bus controller.
sl@0	2976
sl@0	2977	Trace data format:
sl@0	2978	- 4 bytes containing the address of the array
sl@0	2979	- 4 bytes containing the number of channels now registered with the controller
sl@0	2980	*/
sl@0	2981	ERegisterChansEndPil = 2,
sl@0	2982
sl@0	2983	/**
sl@0	2984	Trace output for the end of the PSL registering an array of pointers to channels with the IIC bus controller.
sl@0	2985
sl@0	2986	Trace data format:
sl@0	2987	- 4 bytes containing the address of the array
sl@0	2988	- 4 bytes containing the number of channels in the array
sl@0	2989	- 4 bytes containing the error code returned by the IIC bus controller
sl@0	2990	*/
sl@0	2991	ERegisterChansEndPsl = 3,
sl@0	2992
sl@0	2993	/**
sl@0	2994	Trace output for the start of the PSL de-registering a channel with the IIC bus controller.
sl@0	2995
sl@0	2996	Trace data format:
sl@0	2997	- 4 bytes containing the address of the channel
sl@0	2998	*/
sl@0	2999	EDeRegisterChanStartPsl = 4,
sl@0	3000
sl@0	3001	/**
sl@0	3002	Trace output for the start of the PIL de-registering a channel with the IIC bus controller.
sl@0	3003
sl@0	3004	Trace data format:
sl@0	3005	- 4 bytes containing the address of the channel
sl@0	3006	- 4 bytes containing the number of channels registered with the controller prior to this point
sl@0	3007	*/
sl@0	3008	EDeRegisterChanStartPil = 5,
sl@0	3009
sl@0	3010	/**
sl@0	3011	Trace output for the end of the PSL de-registering a channel with the IIC bus controller.
sl@0	3012
sl@0	3013	Trace data format:
sl@0	3014	- 4 bytes containing the address of the channel
sl@0	3015	- 4 bytes containing the number of channels now registered with the controller
sl@0	3016	*/
sl@0	3017	EDeRegisterChanEndPil = 6,
sl@0	3018
sl@0	3019	/**
sl@0	3020	Trace output for the end of the PSL de-registering a channel with the IIC bus controller.
sl@0	3021
sl@0	3022	Trace data format:
sl@0	3023	- 4 bytes containing the address of the channel
sl@0	3024	- 4 bytes containing the error code returned by the IIC bus controller
sl@0	3025	*/
sl@0	3026	EDeRegisterChanEndPsl = 7,
sl@0	3027
sl@0	3028	/**
sl@0	3029	Trace output for the start of a synchronous queue transaction request in the PIL.
sl@0	3030
sl@0	3031	Trace data format:
sl@0	3032	- 4 bytes containing the bus realisation variability token
sl@0	3033	- 4 bytes containing the pointer to the transaction object
sl@0	3034	*/
sl@0	3035	EMQTransSyncStartPil = 8,
sl@0	3036
sl@0	3037	/**
sl@0	3038	Trace output for the end of a synchronous queue transaction request in the PIL.
sl@0	3039
sl@0	3040	Trace data format:
sl@0	3041	- 4 bytes containing the bus realisation variability token
sl@0	3042	- 4 bytes containing the error code returned by the controller
sl@0	3043	*/
sl@0	3044	EMQTransSyncEndPil = 9,
sl@0	3045
sl@0	3046	/**
sl@0	3047	Trace output for the start of a synchronous queue transaction request in the PIL.
sl@0	3048
sl@0	3049	Trace data format:
sl@0	3050	- 4 bytes containing the bus realisation variability token
sl@0	3051	- 4 bytes containing the pointer to the transaction object
sl@0	3052	- 4 bytes containing the pointer to the callback object
sl@0	3053	*/
sl@0	3054	EMQTransAsyncStartPil = 10,
sl@0	3055
sl@0	3056	/**
sl@0	3057	Trace output for the end of a synchronous queue transaction request in the PIL.
sl@0	3058
sl@0	3059	Trace data format:
sl@0	3060	- 4 bytes containing the bus realisation variability token
sl@0	3061	- 4 bytes containing the error code returned by the controller
sl@0	3062	*/
sl@0	3063	EMQTransAsyncEndPil = 11,
sl@0	3064
sl@0	3065	/**
sl@0	3066	Trace output for the start of cancelling an asynchronous queue transaction request in the PIL.
sl@0	3067
sl@0	3068	Trace data format:
sl@0	3069	- 4 bytes containing the bus realisation variability token
sl@0	3070	- 4 bytes containing the pointer to the transaction object
sl@0	3071	*/
sl@0	3072	EMCancelTransStartPil = 12,
sl@0	3073
sl@0	3074	/**
sl@0	3075	Trace output for the end of cancelling an asynchronous queue transaction request in the PIL.
sl@0	3076
sl@0	3077	Trace data format:
sl@0	3078	- 4 bytes containing the pointer to the transaction object
sl@0	3079	- 4 bytes containing the error code returned by the controller
sl@0	3080	*/
sl@0	3081	EMCancelTransEndPil = 13,
sl@0	3082
sl@0	3083	/**
sl@0	3084	Trace output for the start of processing a transaction request in the PIL.
sl@0	3085
sl@0	3086	Trace data format:
sl@0	3087	- 4 bytes containing the address of the channel
sl@0	3088	- 4 bytes containing the pointer to the transaction object
sl@0	3089	*/
sl@0	3090	EMProcessTransStartPil = 14,
sl@0	3091
sl@0	3092	/**
sl@0	3093	Trace output for the start of processing a transaction request in the PSL.
sl@0	3094
sl@0	3095	Trace data format:
sl@0	3096	- 4 bytes containing the pointer to the transaction object
sl@0	3097	*/
sl@0	3098	EMProcessTransStartPsl = 15,
sl@0	3099
sl@0	3100	/**
sl@0	3101	Trace output for the end of processing a transaction request in the PSL.
sl@0	3102
sl@0	3103	Trace data format:
sl@0	3104	- 4 bytes containing the result code
sl@0	3105	*/
sl@0	3106	EMProcessTransEndPsl = 16,
sl@0	3107
sl@0	3108	/**
sl@0	3109	Trace output for the end of processing a transaction request in the PIL.
sl@0	3110
sl@0	3111	Trace data format:
sl@0	3112	- 4 bytes containing the address of the channel
sl@0	3113	- 4 bytes containing the pointer to the transaction object
sl@0	3114	- 4 bytes containing the result code
sl@0	3115	- 4 bytes containing the pointer to the client callback object
sl@0	3116	*/
sl@0	3117	EMProcessTransEndPil = 17,
sl@0	3118
sl@0	3119	/**
sl@0	3120	Trace output for the start of synchronously capturing a Slave channel in the PIL.
sl@0	3121
sl@0	3122	Trace data format:
sl@0	3123	- 4 bytes containing the bus realisation variability
sl@0	3124	- 4 bytes containing a pointer to device specific configuration option applicable to all transactions
sl@0	3125	*/
sl@0	3126	ESCaptChanSyncStartPil = 18,
sl@0	3127
sl@0	3128	/**
sl@0	3129	Trace output for the start of synchronously capturing a Slave channel in the PSL.
sl@0	3130
sl@0	3131	Trace data format:
sl@0	3132	- 4 bytes containing the address of the channel
sl@0	3133	- 4 bytes containing a pointer to device specific configuration option applicable to all transactions
sl@0	3134	*/
sl@0	3135	ESCaptChanSyncStartPsl = 19,
sl@0	3136
sl@0	3137	/**
sl@0	3138	Trace output for the end of synchronously capturing a Slave channel in the PSL.
sl@0	3139
sl@0	3140	Trace data format:
sl@0	3141	- 4 bytes containing the address of the channel
sl@0	3142	- 4 bytes containing the result code
sl@0	3143	*/
sl@0	3144	ESCaptChanSyncEndPsl = 20,
sl@0	3145
sl@0	3146	/**
sl@0	3147	Trace output for the end of synchronously capturing a Slave channel in the PIL.
sl@0	3148
sl@0	3149	Trace data format:
sl@0	3150	- 4 bytes containing the bus realisation variability
sl@0	3151	- 4 bytes containing the platform-specific cookie that uniquely identifies the channel
sl@0	3152	- 4 bytes containing the result code
sl@0	3153	*/
sl@0	3154	ESCaptChanSyncEndPil = 21,
sl@0	3155
sl@0	3156	/**
sl@0	3157	Trace output for the start of asynchronously capturing a Slave channel in the PIL.
sl@0	3158
sl@0	3159	Trace data format:
sl@0	3160	- 4 bytes containing the bus realisation variability
sl@0	3161	- 4 bytes containing a pointer to device specific configuration option applicable to all transactions
sl@0	3162	- 4 bytes containing the pointer to the client callback object
sl@0	3163	*/
sl@0	3164	ESCaptChanASyncStartPil = 22,
sl@0	3165
sl@0	3166	/**
sl@0	3167	Trace output for the start of asynchronously capturing a Slave channel in the PSL.
sl@0	3168
sl@0	3169	Trace data format:
sl@0	3170	- 4 bytes containing a pointer to the channel object
sl@0	3171	- 4 bytes containing a pointer to device specific configuration option applicable to all transactions
sl@0	3172	*/
sl@0	3173	ESCaptChanASyncStartPsl = 23,
sl@0	3174
sl@0	3175	/**
sl@0	3176	Trace output for the end of asynchronously capturing a Slave channel in the PSL.
sl@0	3177
sl@0	3178	Trace data format:
sl@0	3179	- 4 bytes containing a pointer to the channel object
sl@0	3180	- 4 bytes containing the result code
sl@0	3181	*/
sl@0	3182	ESCaptChanASyncEndPsl = 24,
sl@0	3183
sl@0	3184	/**
sl@0	3185	Trace output for the end of asynchronously capturing a Slave channel in the PIL.
sl@0	3186
sl@0	3187	Trace data format:
sl@0	3188	- 4 bytes containing a pointer to the channel object
sl@0	3189	- 4 bytes containing the result code
sl@0	3190	*/
sl@0	3191	ESCaptChanASyncEndPil = 25,
sl@0	3192
sl@0	3193	/**
sl@0	3194	Trace output for the start of releasing a Slave channel in the PIL.
sl@0	3195
sl@0	3196	Trace data format:
sl@0	3197	- 4 bytes containing the channel identifier cookie
sl@0	3198	*/
sl@0	3199	ESRelChanStartPil = 26,
sl@0	3200
sl@0	3201	/**
sl@0	3202	Trace output for the start of releasing a Slave channel in the PSL.
sl@0	3203
sl@0	3204	Trace data format:
sl@0	3205	- 4 bytes containing a pointer to the channel object
sl@0	3206	*/
sl@0	3207	ESRelChanStartPsl = 27,
sl@0	3208
sl@0	3209	/**
sl@0	3210	Trace output for the end of releasing a Slave channel in the PSL.
sl@0	3211
sl@0	3212	Trace data format:
sl@0	3213	- 4 bytes containing a pointer to the channel object
sl@0	3214	- 4 bytes containing the result code
sl@0	3215	*/
sl@0	3216	ESRelChanEndPsl = 28,
sl@0	3217
sl@0	3218	/**
sl@0	3219	Trace output for the end of releasing a Slave channel in the PIL.
sl@0	3220
sl@0	3221	Trace data format:
sl@0	3222	- 4 bytes containing the channel identifier cookie
sl@0	3223	- 4 bytes containing the result code
sl@0	3224	*/
sl@0	3225	ESRelChanEndPil = 29,
sl@0	3226
sl@0	3227	/**
sl@0	3228	Trace output for the start of registering an Rx buffer for a Slave channel in the PIL.
sl@0	3229
sl@0	3230	Trace data format:
sl@0	3231	- 4 bytes containing a pointer to the receive buffer
sl@0	3232	- 4 bytes containing the number of buffer bytes used to store a word.
sl@0	3233	- 4 bytes containing the number of words expected to be received.
sl@0	3234	- 4 bytes containing offset from the start of the buffer where to store the received data.
sl@0	3235	*/
sl@0	3236	ESRegRxBufStartPil = 30,
sl@0	3237
sl@0	3238	/**
sl@0	3239	Trace output for the start of registering an Rx buffer for a Slave channel in the PSL.
sl@0	3240
sl@0	3241	Trace data format:
sl@0	3242	- 4 bytes containing a pointer to the channel object
sl@0	3243	- 4 bytes containing a pointer to the receive buffer
sl@0	3244	- 4 bytes containing the number of buffer bytes used to store a word.
sl@0	3245	- 4 bytes containing the number of words expected to be received.
sl@0	3246	- 4 bytes containing offset from the start of the buffer where to store the received data.
sl@0	3247	*/
sl@0	3248	ESRegRxBufStartPsl = 31,
sl@0	3249
sl@0	3250	/**
sl@0	3251	Trace output for the end of registering an Rx buffer for a Slave channel in the PSL.
sl@0	3252
sl@0	3253	Trace data format:
sl@0	3254	- 4 bytes containing a pointer to the channel object
sl@0	3255	- 4 bytes containing the result code
sl@0	3256	*/
sl@0	3257	ESRegRxBufEndPsl = 32,
sl@0	3258
sl@0	3259	/**
sl@0	3260	Trace output for the end of registering an Rx buffer for a Slave channel in the PIL.
sl@0	3261
sl@0	3262	Trace data format:
sl@0	3263	- 4 bytes containing the result code
sl@0	3264	*/
sl@0	3265	ESRegRxBufEndPil = 33,
sl@0	3266
sl@0	3267	/**
sl@0	3268	Trace output for the start of registering an Tx buffer for a Slave channel in the PIL.
sl@0	3269
sl@0	3270	Trace data format:
sl@0	3271	- 4 bytes containing a pointer to the transmit buffer
sl@0	3272	- 4 bytes containing the number of buffer bytes used to store a word.
sl@0	3273	- 4 bytes containing the number of words expected to be transmitted.
sl@0	3274	- 4 bytes containing offset from the start of the buffer from where to transmit data.
sl@0	3275	*/
sl@0	3276	ESRegTxBufStartPil = 34,
sl@0	3277
sl@0	3278	/**
sl@0	3279	Trace output for the start of registering an Tx buffer for a Slave channel in the PSL.
sl@0	3280
sl@0	3281	Trace data format:
sl@0	3282	- 4 bytes containing a pointer to the channel object
sl@0	3283	- 4 bytes containing a pointer to the transmit buffer
sl@0	3284	- 4 bytes containing the number of buffer bytes used to store a word.
sl@0	3285	- 4 bytes containing the number of words expected to be transmitted.
sl@0	3286	- 4 bytes containing offset from the start of the buffer from where to transmit data.
sl@0	3287	*/
sl@0	3288	ESRegTxBufStartPsl = 35,
sl@0	3289
sl@0	3290	/**
sl@0	3291	Trace output for the end of registering an Tx buffer for a Slave channel in the PSL.
sl@0	3292
sl@0	3293	Trace data format:
sl@0	3294	- 4 bytes containing a pointer to the channel object
sl@0	3295	- 4 bytes containing the result code
sl@0	3296	*/
sl@0	3297	ESRegTxBufEndPsl = 36,
sl@0	3298
sl@0	3299	/**
sl@0	3300	Trace output for the start of setting a notification for a Slave channel in the PIL.
sl@0	3301
sl@0	3302	Trace data format:
sl@0	3303	- 4 bytes containing the result code
sl@0	3304	*/
sl@0	3305	ESRegTxBufEndPil = 37,
sl@0	3306
sl@0	3307	/**
sl@0	3308	Trace output for the start of setting a notification for a Slave channel in the PIL.
sl@0	3309
sl@0	3310	Trace data format:
sl@0	3311	- 4 bytes containing the channel identifier cookie
sl@0	3312	- 4 bytes containing the trigger value
sl@0	3313	*/
sl@0	3314	ESNotifTrigStartPil = 38,
sl@0	3315
sl@0	3316	/**
sl@0	3317	Trace output for the start of setting a notification for a Slave channel in the PSL.
sl@0	3318
sl@0	3319	Trace data format:
sl@0	3320	- 4 bytes containing the trigger value
sl@0	3321	*/
sl@0	3322	ESNotifTrigStartPsl = 39,
sl@0	3323
sl@0	3324	/**
sl@0	3325	Trace output for the end of setting a notification for a Slave channel in the PSL.
sl@0	3326
sl@0	3327	Trace data format:
sl@0	3328	- 4 bytes containing the result code
sl@0	3329	*/
sl@0	3330	ESNotifTrigEndPsl = 40,
sl@0	3331
sl@0	3332	/**
sl@0	3333	Trace output for the end of setting a notification for a Slave channel in the PIL.
sl@0	3334
sl@0	3335	Trace data format:
sl@0	3336	- 4 bytes containing the channel identifier cookie
sl@0	3337	- 4 bytes containing the result code
sl@0	3338	*/
sl@0	3339	ESNotifTrigEndPil = 41,
sl@0	3340
sl@0	3341	/**
sl@0	3342	Trace output for the start of a StaticExtension operaton for a MasterSlave channel in the PIL.
sl@0	3343
sl@0	3344	Trace data format:
sl@0	3345	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3346	- 4 bytes containing a function identifier
sl@0	3347	- 4 bytes containing an argument to be passed to the function
sl@0	3348	- 4 bytes containing an argument to be passed to the function
sl@0	3349	*/
sl@0	3350	EMSStatExtStartPil = 42,
sl@0	3351
sl@0	3352	/**
sl@0	3353	Trace output for the end of a StaticExtension operation for a MasterSlave channel in the PIL.
sl@0	3354
sl@0	3355	Trace data format:
sl@0	3356	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3357	- 4 bytes containing a function identifier
sl@0	3358	- 4 bytes containing the result code
sl@0	3359	*/
sl@0	3360	EMSStatExtEndPil = 43,
sl@0	3361
sl@0	3362	/**
sl@0	3363	Trace output for the start of a StaticExtension operation for a Master channel in the PIL.
sl@0	3364
sl@0	3365	Trace data format:
sl@0	3366	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3367	- 4 bytes containing a function identifier
sl@0	3368	- 4 bytes containing an argument to be passed to the function
sl@0	3369	- 4 bytes containing an argument to be passed to the function
sl@0	3370	*/
sl@0	3371	EMStatExtStartPil = 44,
sl@0	3372
sl@0	3373	/**
sl@0	3374	Trace output for the start of a StaticExtension operation for a Master channel in the PSL.
sl@0	3375
sl@0	3376	Trace data format:
sl@0	3377	- 4 bytes containing a pointer to the channel object
sl@0	3378	- 4 bytes containing a function identifier
sl@0	3379	- 4 bytes containing an argument to be passed to the function
sl@0	3380	- 4 bytes containing an argument to be passed to the function
sl@0	3381	*/
sl@0	3382	EMStatExtStartPsl = 45,
sl@0	3383
sl@0	3384	/**
sl@0	3385	Trace output for the end of a StaticExtension operation for a Master channel in the PSL.
sl@0	3386
sl@0	3387	Trace data format:
sl@0	3388	- 4 bytes containing a pointer to the channel object
sl@0	3389	- 4 bytes containing a function identifier
sl@0	3390	- 4 bytes containing the result code
sl@0	3391	*/
sl@0	3392	EMStatExtEndPsl = 46,
sl@0	3393
sl@0	3394	/**
sl@0	3395	Trace output for the end of a StaticExtension operation for a Master channel in the PIL.
sl@0	3396
sl@0	3397	Trace data format:
sl@0	3398	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3399	- 4 bytes containing a function identifier
sl@0	3400	- 4 bytes containing the result code
sl@0	3401	*/
sl@0	3402	EMStatExtEndPil = 47,
sl@0	3403
sl@0	3404	/**
sl@0	3405	Trace output for the start of a StaticExtension operation for a Slave channel in the PIL.
sl@0	3406
sl@0	3407	Trace data format:
sl@0	3408	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3409	- 4 bytes containing a function identifier
sl@0	3410	- 4 bytes containing an argument to be passed to the function
sl@0	3411	- 4 bytes containing an argument to be passed to the function
sl@0	3412	*/
sl@0	3413	ESStatExtStartPil = 48,
sl@0	3414
sl@0	3415	/**
sl@0	3416	Trace output for the start of a StaticExtension operation for a Slave channel in the PSL.
sl@0	3417
sl@0	3418	Trace data format:
sl@0	3419	- 4 bytes containing a pointer to the channel object
sl@0	3420	- 4 bytes containing a function identifier
sl@0	3421	- 4 bytes containing an argument to be passed to the function
sl@0	3422	- 4 bytes containing an argument to be passed to the function
sl@0	3423	*/
sl@0	3424	ESStatExtStartPsl = 49,
sl@0	3425
sl@0	3426	/**
sl@0	3427	Trace output for the end of a StaticExtension operation for a Slave channel in the PSL.
sl@0	3428
sl@0	3429	Trace data format:
sl@0	3430	- 4 bytes containing a pointer to the channel object
sl@0	3431	- 4 bytes containing a function identifier
sl@0	3432	- 4 bytes containing the result code
sl@0	3433	*/
sl@0	3434	ESStatExtEndPsl = 50,
sl@0	3435	/**
sl@0	3436	Trace output for the end of a StaticExtension operation for a Slave channel in the PIL.
sl@0	3437
sl@0	3438	Trace data format:
sl@0	3439	- 4 bytes containing a token containing the bus realisation variability or the channel identifier cookie for this client.
sl@0	3440	- 4 bytes containing a function identifier
sl@0	3441	- 4 bytes containing the result code
sl@0	3442	*/
sl@0	3443	ESStatExtEndPil = 51
sl@0	3444	};
sl@0	3445
sl@0	3446	/**
sl@0	3447	Calculate the address of the next trace record.
sl@0	3448	@param aCurrentRecord A pointer to a trace record.
sl@0	3449	@return The address of the trace record which follows aCurrentRecord.
sl@0	3450	*/
sl@0	3451	inline static TUint8* NextRecord(TAny* aCurrentRecord);
sl@0	3452
sl@0	3453	#ifdef __KERNEL_MODE__
sl@0	3454
sl@0	3455	/**
sl@0	3456	Create initial trace output required for the specified trace category.
sl@0	3457	E.g. For the EThreadIdentification category, this will cause traces which identify
sl@0	3458	all threads already in existence at this point.
sl@0	3459
sl@0	3460	@aCategory The trace category, or -1 to indicate all trace categories.
sl@0	3461
sl@0	3462	@publishedPartner
sl@0	3463	@released
sl@0	3464	*/
sl@0	3465	IMPORT_C static void Prime(TInt aCategory=-1);
sl@0	3466
sl@0	3467	/**
sl@0	3468	Prototype for function which is called to output trace records.
sl@0	3469	I.e. as set by SetHandler().
sl@0	3470
sl@0	3471	The handler function should output all values which are appropriate for the
sl@0	3472	trace as specified in aHeader.
sl@0	3473
sl@0	3474	@param aHeader The 4 bytes for the trace header.
sl@0	3475	@param aHeader2 The second header word.
sl@0	3476	(If EHeader2Present is set in the header flags.)
sl@0	3477	@param aContext The context id.
sl@0	3478	(If EContextIdPresent is set in the header flags.)
sl@0	3479	@param a1 The first four bytes of trace data.
sl@0	3480	(Only if the header size indicates that this is present.)
sl@0	3481	@param a2 The second four bytes of trace data.
sl@0	3482	(Only if the header size indicates that this is present.)
sl@0	3483	@param a3 This is either the third four bytes of trace data, if
sl@0	3484	the header size indicates there is between 9 and 12 bytes
sl@0	3485	of trace data. If more than 12 of trace data are indicated, then
sl@0	3486	a3 contains a pointer to the remaining trace data, bytes 8 trough to N.
sl@0	3487	This trace data is word aligned.
sl@0	3488	@param aExtra The 'extra' value.
sl@0	3489	(If EExtraPresent is set in the header flags.)
sl@0	3490	@param aPc The Program Counter value.
sl@0	3491	(If EPcPresent is set in the header flags.)
sl@0	3492
sl@0	3493	@return True, if the trace handler is enabled and outputting trace.
sl@0	3494	False otherwise.
sl@0	3495
sl@0	3496	Here is an example implementation of a trace handler:
sl@0	3497
sl@0	3498	@code
sl@0	3499	TInt size = (aHeader>>BTrace::ESizeIndex*8)&0xff;
sl@0	3500	TInt flags = (aHeader>>BTrace::EFlagsIndex*8)&0xff;
sl@0	3501	Output(aHeader), size -= 4;
sl@0	3502	if(flags&BTrace::EHeader2Present)
sl@0	3503	Output(aHeader2), size -= 4;
sl@0	3504	if(flags&BTrace::EContextIdPresent)
sl@0	3505	Output(aContext), size -= 4;
sl@0	3506	if(flags&BTrace::EPcPresent)
sl@0	3507	Output(aPc), size -= 4;
sl@0	3508	if(flags&BTrace::EExtraPresent)
sl@0	3509	Output(aExtra), size -= 4;
sl@0	3510	if(size<=0)
sl@0	3511	return ETrue;
sl@0	3512	Output(a1), size -= 4;
sl@0	3513	if(size<=0)
sl@0	3514	return ETrue;
sl@0	3515	Output(a2), size -= 4;
sl@0	3516	if(size<=0)
sl@0	3517	return ETrue;
sl@0	3518	if(size<=4)
sl@0	3519	Output(a3);
sl@0	3520	else
sl@0	3521	{
sl@0	3522	TUint32* data = (TUint32*)a3;
sl@0	3523	TUint32* end = (TUint32*)(a3+size);
sl@0	3524	do Output(*data++); while(data<end);
sl@0	3525	}
sl@0	3526	return ETrue;
sl@0	3527	@endcode
sl@0	3528
sl@0	3529	The trace handler may add timestamp values to the trace it outputs, in which case
sl@0	3530	it should modify the flags and size in aHeader accordingly, before outputting this value.
sl@0	3531	The Timestamp and/or Timestamp2 should be output, in that order, between the Header2 and
sl@0	3532	Context ID values.
sl@0	3533
sl@0	3534	IMPORTANT NOTES.
sl@0	3535	- The handler must not make use of any kernel APIs, apart from TDfc::RawAdd(). (This is
sl@0	3536	because kernel APIs may contain tracing and this would result in deadlock of the system.)
sl@0	3537	- The trace handler must not access or modify arguments which are not indicated as
sl@0	3538	being present by their flag in aHeader or aHeader2.
sl@0	3539	In particular, on ARM CPUs, the values a2, a3, aExtra and aPc are stored on the stack
sl@0	3540	and the caller of this function may not have created these arguments before calling the
sl@0	3541	trace handler.
sl@0	3542	- The handler may be called in any context and in a re-entrant manner. Implementations must
sl@0	3543	be designed to cope with this.
sl@0	3544	- The interrupt disable status must not be reduced by the trace handler during its operation.
sl@0	3545	E.g. if IRQs are disabled on entry, the handler must not cause them to become enabled
sl@0	3546	at any point.
sl@0	3547
sl@0	3548	@pre Call in any context.
sl@0	3549	@post Interrupt enable status unchanged.
sl@0	3550
sl@0	3551	@publishedPartner
sl@0	3552	@released
sl@0	3553	*/
sl@0	3554	typedef TBool(*THandler)(TUint32 aHeader,TUint32 aHeader2,const TUint32 aContext,const TUint32 a1,const TUint32 a2,const TUint32 a3,const TUint32 aExtra,const TUint32 aPc);
sl@0	3555
sl@0	3556
sl@0	3557	/**
sl@0	3558	Set the function which will receive all trace records.
sl@0	3559	@return The handler function which existed before this function was called.
sl@0	3560	@publishedPartner
sl@0	3561	@released
sl@0	3562	*/
sl@0	3563	IMPORT_C static BTrace::THandler SetHandler(BTrace::THandler aHandler);
sl@0	3564
sl@0	3565
sl@0	3566	/**
sl@0	3567	Set the trace filter bit for the specified category.
sl@0	3568
sl@0	3569	@param aCategory A category value from enum BTrace::TCategory.
sl@0	3570	@param aValue The new filter value for the category.
sl@0	3571	1 means traces of this category are output, 0 means they are suppressed.
sl@0	3572	Other values must not be used.
sl@0	3573
sl@0	3574	@return The previous value of the filter for the category, 0 or 1.
sl@0	3575	Or KErrNotSupported if this category is not supported by this build of the kernel.
sl@0	3576	@publishedPartner
sl@0	3577	@released
sl@0	3578	*/
sl@0	3579	IMPORT_C static TInt SetFilter(TUint aCategory, TBool aValue);
sl@0	3580
sl@0	3581
sl@0	3582	/**
sl@0	3583	Modify the secondary trace filter to add or remove the specified UID.
sl@0	3584
sl@0	3585	This method can not be used to disable a UID key if SetFilter2(TInt aGlobalFilter)
sl@0	3586	has been used to set the filter to pass all traces. Such attempts result in a return
sl@0	3587	code of KErrNotSupported.
sl@0	3588
sl@0	3589	@param aUid The UID to filter.
sl@0	3590	@param aValue The new filter value for the UID.
sl@0	3591	1 means traces with this UID are output, 0 means they are suppressed.
sl@0	3592	Other values must not be used.
sl@0	3593
sl@0	3594	@return The previous value of the filter for the UID, 0 or 1, if operation is successful.
sl@0	3595	Otherwise, a negative number representing a system wide error code.
sl@0	3596	(E.g. KErrNoMemory.)
sl@0	3597
sl@0	3598	@pre Call in a thread context.
sl@0	3599
sl@0	3600	@publishedPartner
sl@0	3601	@released
sl@0	3602	*/
sl@0	3603	IMPORT_C static TInt SetFilter2(TUint32 aUid, TBool aValue);
sl@0	3604
sl@0	3605
sl@0	3606	/**
sl@0	3607	Set the secondary trace filter to include only the specified UIDs.
sl@0	3608
sl@0	3609	@param aUids Pointer to array of UIDs.
sl@0	3610	@param aNumUids Number of UID values pointer to by \a aUid.
sl@0	3611
sl@0	3612	@return KErrNone on success.
sl@0	3613	Otherwise, a negative number representing a system wide error code.
sl@0	3614	(E.g. KErrNoMemory.)
sl@0	3615
sl@0	3616	@pre Call in a thread context.
sl@0	3617
sl@0	3618	@publishedPartner
sl@0	3619	@released
sl@0	3620	*/
sl@0	3621	IMPORT_C static TInt SetFilter2(const TUint32* aUids, TInt aNumUids);
sl@0	3622
sl@0	3623
sl@0	3624	/**
sl@0	3625	Set the secondary trace filter to pass or reject every trace.
sl@0	3626
sl@0	3627	@param aGlobalFilter If 0, the secondary filter will reject
sl@0	3628	all traces; if 1, all traces are passed
sl@0	3629	by the filter.
sl@0	3630	Other values have no effect.
sl@0	3631
sl@0	3632	@return The previous value of the global filter, or -1 if the global filter
sl@0	3633	was not previously set.
sl@0	3634
sl@0	3635	@pre Call in a thread context.
sl@0	3636
sl@0	3637	@publishedPartner
sl@0	3638	@released
sl@0	3639	*/
sl@0	3640	IMPORT_C static TInt SetFilter2(TInt aGlobalFilter);
sl@0	3641
sl@0	3642
sl@0	3643	/**
sl@0	3644	Get the contents of the secondary trace filter.
sl@0	3645
sl@0	3646	@param[out] aUids Pointer to array of UIDs contained in the secondary filter.
sl@0	3647	Ownership of this array is passed to the caller of this
sl@0	3648	function, which is then responsible for deleting it.
sl@0	3649	If filter is empty, \a aUid equals zero.
sl@0	3650	@param[out] aGlobalFilter Set to 1 if the secondary filter passes all traces.
sl@0	3651	Set to 0 if the secondary filter rejects all traces.
sl@0	3652	Set to -1 if the secondary filter operates by UIDs contained in traces.
sl@0	3653
sl@0	3654	@return Number of UIDs in returned array, if operation is successful.
sl@0	3655	Otherwise, a negative number representing a system wide error code.
sl@0	3656
sl@0	3657
sl@0	3658	@pre Call in a thread context.
sl@0	3659	@pre Calling thread must be in a critical section.
sl@0	3660
sl@0	3661	@publishedPartner
sl@0	3662	@released
sl@0	3663	*/
sl@0	3664	IMPORT_C static TInt Filter2(TUint32*& aUids, TInt& aGlobalFilter);
sl@0	3665
sl@0	3666
sl@0	3667	/**
sl@0	3668	Get the trace filter bit for the specified category.
sl@0	3669
sl@0	3670	@param aCategory A category value from enum BTrace::TCategory,
sl@0	3671	@return The value of the filter for the category, 0 or 1.
sl@0	3672	Or KErrNotSupported if this category is not supported by this build of the kernel.
sl@0	3673
sl@0	3674	@publishedPartner
sl@0	3675	@released
sl@0	3676	*/
sl@0	3677	inline static TInt Filter(TUint aCategory);
sl@0	3678
sl@0	3679	/**
sl@0	3680	Get a pointer to the spinlock used to serialise BTrace output on SMP systems.
sl@0	3681
sl@0	3682	@internalComponent
sl@0	3683	*/
sl@0	3684	IMPORT_C static TSpinLock* LockPtr();
sl@0	3685
sl@0	3686
sl@0	3687	/**
sl@0	3688	Enumeration of control functions which can be implemented by the BTrace handler.
sl@0	3689
sl@0	3690	These values are passed to #Control to indicate the requested operation and are
sl@0	3691	passed unaltered to the BTrace implementation's control function as specified by
sl@0	3692	SetHandlers().
sl@0	3693
sl@0	3694	@see #Control
sl@0	3695	@see #TControlFunction
sl@0	3696	*/
sl@0	3697	enum TControl
sl@0	3698	{
sl@0	3699	/**
sl@0	3700	Called to indicate that the system has crashed. Typical response to this call
sl@0	3701	is to disable tracing so that debug monitor activity doesn't generate any additional
sl@0	3702	trace.
sl@0	3703
sl@0	3704	As this function is called after the system is crashed its implementation must not
sl@0	3705	make use of any APIs which require a running system, it must also not re-enable
sl@0	3706	interrupts.
sl@0	3707
sl@0	3708	ControlFunction argument meaning: None, ignore.
sl@0	3709
sl@0	3710	ControlFunction returns nothing, ignore.
sl@0	3711	*/
sl@0	3712	ECtrlSystemCrashed,
sl@0	3713
sl@0	3714	/**
sl@0	3715	Called by crash monitor to request first block of data from any memory resident
sl@0	3716	trace buffer. A size of zero should be returned if the buffer is empty.
sl@0	3717
sl@0	3718	This should be a non-destructive operation if possible. I.e. the contents of the
sl@0	3719	buffer should be capable of being read multiple times by issuing repeated
sl@0	3720	ECtrlCrashReadFirst/ECtrlCrashReadNext sequences.
sl@0	3721
sl@0	3722	As this function is called after the system is crashed its implementation must not
sl@0	3723	make use of any APIs which require a running system, it must also not re-enable
sl@0	3724	interrupts.
sl@0	3725
sl@0	3726	ControlFunction argument meaning:
sl@0	3727	- aArg1 should be treated as a TUint8*& and set to the start address of the trace data.
sl@0	3728	- aArg2 should be treated as a TUint& and set to the length of the trace data.
sl@0	3729
sl@0	3730	ControlFunction returns KErrNone if successful, otherwise one of the other system wide
sl@0	3731	error codes.
sl@0	3732	*/
sl@0	3733	ECtrlCrashReadFirst,
sl@0	3734
sl@0	3735	/**
sl@0	3736	Called by crash monitor after using ECrashReadFirst, to request subsequent
sl@0	3737	blocks of data from the trace buffer. A size of zero should be returned if
sl@0	3738	the end of the buffer has been reached.
sl@0	3739
sl@0	3740	As this function is called after the system is crashed its implementation must not
sl@0	3741	make use of any APIs which require a running system, it must also not re-enable
sl@0	3742	interrupts.
sl@0	3743
sl@0	3744	ControlFunction argument meaning:
sl@0	3745	aArg1 should be treated as a TUint8** and set to the start address of the trace data.
sl@0	3746	aArg2 should be treated as a TUint* and set to the length of the trace data.
sl@0	3747
sl@0	3748	ControlFunction returns KErrNone if successful, otherwise one of the other system wide
sl@0	3749	error codes.
sl@0	3750	*/
sl@0	3751	ECtrlCrashReadNext
sl@0	3752	};
sl@0	3753
sl@0	3754	/**
sl@0	3755	Prototype for function callback called by #Control.
sl@0	3756	I.e. as set by SetHandlers().
sl@0	3757	*/
sl@0	3758	typedef TInt(TControlFunction)(TControl aFunction, TAny aArg1, TAny* aArg2);
sl@0	3759
sl@0	3760	/**
sl@0	3761	Call the BTrace handlers control function to perform the function.
sl@0	3762
sl@0	3763	@param aFunction A value from TControl specifying the requested operation.
sl@0	3764	@param aArg1 First argument for the operation. See enum TControl.
sl@0	3765	@param aArg1 Second argument for the operation. See enum TControl.
sl@0	3766
sl@0	3767	@return KErrNone if successful,
sl@0	3768	KErrNotSupported if the function isn't supported.
sl@0	3769	otherwise one of the other system wide error codes.
sl@0	3770
sl@0	3771	@see TControl.
sl@0	3772	*/
sl@0	3773	IMPORT_C static TInt Control(TControl aFunction, TAny* aArg1=0, TAny* aArg2=0);
sl@0	3774
sl@0	3775	/**
sl@0	3776	Set both the function which will receive all trace records, and the
sl@0	3777	control function which will be called by each use of #Control.
sl@0	3778
sl@0	3779	@param aNewHandler The new handler to receive trace.
sl@0	3780	@param aNewControl The new handler for control functions.
sl@0	3781	@param aOldHandler The trace handler which existed prior to this function being called.
sl@0	3782	@param aOldControl The control handler which existed prior to this function being called.
sl@0	3783	*/
sl@0	3784	IMPORT_C static void SetHandlers(BTrace::THandler aNewHandler, BTrace::TControlFunction aNewControl, BTrace::THandler& aOldHandler, BTrace::TControlFunction& aOldControl);
sl@0	3785
sl@0	3786	#endif // __KERNEL_MODE__
sl@0	3787
sl@0	3788	/**
sl@0	3789	Check the trace filters to see if a trace with a given category
sl@0	3790	would be output.
sl@0	3791
sl@0	3792	@param aCategory A category value from enum BTrace::TCategory.
sl@0	3793	Only the 8 least significant bits in this value are used;
sl@0	3794	other bits are ignored.
sl@0	3795
sl@0	3796	@return True if a trace with this specification would be passed by the filters.
sl@0	3797	False if a trace with this specification would be dropped by the filters.
sl@0	3798
sl@0	3799	@publishedPartner
sl@0	3800	@released
sl@0	3801	*/
sl@0	3802	IMPORT_C static TBool CheckFilter(TUint32 aCategory);
sl@0	3803
sl@0	3804	/**
sl@0	3805	Check the trace filters to see if a trace with a given category
sl@0	3806	and filter UID would be output.
sl@0	3807
sl@0	3808	@param aCategory A category value from enum BTrace::TCategory.
sl@0	3809	Only the 8 least significant bits in this value are used;
sl@0	3810	other bits are ignored.
sl@0	3811	@param aUid A UID to filter on.
sl@0	3812
sl@0	3813	@return True if a trace with this specification would be passed by the filters.
sl@0	3814	False if a trace with this specification would be dropped by the filters.
sl@0	3815
sl@0	3816	@publishedPartner
sl@0	3817	@released
sl@0	3818	*/
sl@0	3819	IMPORT_C static TBool CheckFilter2(TUint32 aCategory,TUint32 aUid);
sl@0	3820
sl@0	3821	/**
sl@0	3822	Common function for BTrace macros.
sl@0	3823	@internalComponent
sl@0	3824	*/
sl@0	3825	IMPORT_C static TBool Out(TUint32 a0,TUint32 a1,TUint32 a2,TUint32 a3);
sl@0	3826
sl@0	3827	/**
sl@0	3828	Common function for BTrace macros.
sl@0	3829	@internalComponent
sl@0	3830	*/
sl@0	3831	IMPORT_C static TBool OutX(TUint32 a0,TUint32 a1,TUint32 a2,TUint32 a3);
sl@0	3832
sl@0	3833	/**
sl@0	3834	Common function for BTrace macros.
sl@0	3835	@internalComponent
sl@0	3836	*/
sl@0	3837	IMPORT_C static TBool OutN(TUint32 a0, TUint32 a1, TUint32 a2, const TAny* aData, TInt aDataSize);
sl@0	3838
sl@0	3839	/**
sl@0	3840	Common function for BTrace macros.
sl@0	3841	@internalComponent
sl@0	3842	*/
sl@0	3843	IMPORT_C static TBool OutNX(TUint32 a0, TUint32 a1, TUint32 a2, const TAny* aData, TInt aDataSize);
sl@0	3844
sl@0	3845	/**
sl@0	3846	Common function for BTrace macros.
sl@0	3847	@internalComponent
sl@0	3848	*/
sl@0	3849	IMPORT_C static TBool OutBig(TUint32 a0, TUint32 a1, const TAny* aData, TInt aDataSize);
sl@0	3850
sl@0	3851	/**
sl@0	3852	Common function for BTrace macros.
sl@0	3853	@internalComponent
sl@0	3854	*/
sl@0	3855	IMPORT_C static TBool OutFiltered(TUint32 a0,TUint32 a1,TUint32 a2,TUint32 a3);
sl@0	3856
sl@0	3857	/**
sl@0	3858	Common function for BTrace macros.
sl@0	3859	@internalComponent
sl@0	3860	*/
sl@0	3861	IMPORT_C static TBool OutFilteredX(TUint32 a0,TUint32 a1,TUint32 a2,TUint32 a3);
sl@0	3862
sl@0	3863	/**
sl@0	3864	Common function for BTrace macros.
sl@0	3865	@internalComponent
sl@0	3866	*/
sl@0	3867	IMPORT_C static TBool OutFilteredN(TUint32 a0, TUint32 a1, TUint32 a2, const TAny* aData, TInt aDataSize);
sl@0	3868
sl@0	3869	/**
sl@0	3870	Common function for BTrace macros.
sl@0	3871	@internalComponent
sl@0	3872	*/
sl@0	3873	IMPORT_C static TBool OutFilteredNX(TUint32 a0, TUint32 a1, TUint32 a2, const TAny* aData, TInt aDataSize);
sl@0	3874
sl@0	3875	/**
sl@0	3876	Common function for BTrace macros.
sl@0	3877	@internalComponent
sl@0	3878	*/
sl@0	3879	IMPORT_C static TBool OutFilteredBig(TUint32 a0, TUint32 a1, const TAny* aData, TInt aDataSize);
sl@0	3880
sl@0	3881	/**
sl@0	3882	@internalComponent
sl@0	3883	*/
sl@0	3884	static void Init0();
sl@0	3885
sl@0	3886	/**
sl@0	3887	@internalComponent
sl@0	3888	*/
sl@0	3889	typedef TBool(*TBTrace1)(TUint32);
sl@0	3890
sl@0	3891	/**
sl@0	3892	@internalComponent
sl@0	3893	*/
sl@0	3894	typedef TBool(*TBTrace2)(TUint32,TUint32);
sl@0	3895
sl@0	3896	/**
sl@0	3897	@internalComponent
sl@0	3898	*/
sl@0	3899	typedef TBool(*TBTrace3)(TUint32,TUint32,TUint32);
sl@0	3900
sl@0	3901	/**
sl@0	3902	@internalComponent
sl@0	3903	*/
sl@0	3904	struct SExecExtension
sl@0	3905	{
sl@0	3906	TUint32 iA2;
sl@0	3907	TUint32 iA3;
sl@0	3908	TUint32 iPc;
sl@0	3909	};
sl@0	3910
sl@0	3911	/**
sl@0	3912	@internalComponent
sl@0	3913	*/
sl@0	3914	static TBool DoOutBig(TUint32 a0, TUint32 a1, const TAny* aData, TInt aDataSize, TUint32 aContext, TUint32 aPc);
sl@0	3915
sl@0	3916	/**
sl@0	3917	@internalComponent
sl@0	3918	*/
sl@0	3919	static TUint32 BigTraceId;
sl@0	3920
sl@0	3921	/**
sl@0	3922	@internalComponent
sl@0	3923	*/
sl@0	3924	static TBool IsSupported(TUint aCategory);
sl@0	3925
sl@0	3926	/**
sl@0	3927	Common function for UTrace calls, that need to set both program counter and format id as well as the normal parameters.
sl@0	3928
sl@0	3929	@param aHeader The header (a0) of the trace record.
sl@0	3930	@param aModuleUid A uid (a1) to filter on
sl@0	3931	@param aPc A program counter
sl@0	3932	@param aFormatId A format id
sl@0	3933	@param aData The data to output
sl@0	3934	@param aDataSize The size of the data
sl@0	3935
sl@0	3936	@return ETrue if a trace was successfully sent and dealt with by the handler.
sl@0	3937
sl@0	3938	@internalComponent
sl@0	3939	@prototype
sl@0	3940	*/
sl@0	3941	IMPORT_C static TBool OutFilteredPcFormatBig(TUint32 aHeader, TUint32 aModuleUid, TUint32 aPc, TUint16 aFormatId, const TAny* aData, TInt aDataSize);
sl@0	3942
sl@0	3943	};
sl@0	3944
sl@0	3945
sl@0	3946	/**
sl@0	3947	@internalComponent
sl@0	3948	*/
sl@0	3949	class DBTraceFilter2
sl@0	3950	{
sl@0	3951	public:
sl@0	3952	TUint iNumUids;
sl@0	3953	TInt iAccessCount;
sl@0	3954	TUint32 iUids[1];
sl@0	3955
sl@0	3956	TBool Check(TUint32 aUid);
sl@0	3957
sl@0	3958	static DBTraceFilter2* New(TInt aNumUids);
sl@0	3959	static DBTraceFilter2* Open(DBTraceFilter2*volatile& aFilter2);
sl@0	3960	void Close();
sl@0	3961
sl@0	3962	DBTraceFilter2* iCleanupLink;
sl@0	3963	static DBTraceFilter2* iCleanupHead;
sl@0	3964	static void Cleanup();
sl@0	3965	};
sl@0	3966
sl@0	3967
sl@0	3968
sl@0	3969
sl@0	3970	//
sl@0	3971	// BTraceX macros
sl@0	3972	//
sl@0	3973
sl@0	3974	/**
sl@0	3975	@internalComponent
sl@0	3976	*/
sl@0	3977	#define BTRACE_HEADER(aSize,aCategory,aSubCategory) \
sl@0	3978	(((aSize)<<BTrace::ESizeIndex*8) \
sl@0	3979	+((aCategory)<<BTrace::ECategoryIndex*8) \
sl@0	3980	+((aSubCategory)<<BTrace::ESubCategoryIndex*8))
sl@0	3981
sl@0	3982	/**
sl@0	3983	@internalComponent
sl@0	3984	*/
sl@0	3985	#define BTRACE_HEADER_C(aSize,aCategory,aSubCategory) \
sl@0	3986	((((aSize)+4)<<BTrace::ESizeIndex*8) \
sl@0	3987	+((BTrace::EContextIdPresent)<<BTrace::EFlagsIndex*8) \
sl@0	3988	+((aCategory)<<BTrace::ECategoryIndex*8) \
sl@0	3989	+((aSubCategory)<<BTrace::ESubCategoryIndex*8))
sl@0	3990
sl@0	3991	/**
sl@0	3992	@internalComponent
sl@0	3993	*/
sl@0	3994	#define BTRACE_HEADER_P(aSize,aCategory,aSubCategory) \
sl@0	3995	((((aSize)+4)<<BTrace::ESizeIndex*8) \
sl@0	3996	+((BTrace::EPcPresent)<<BTrace::EFlagsIndex*8) \
sl@0	3997	+((aCategory)<<BTrace::ECategoryIndex*8) \
sl@0	3998	+((aSubCategory)<<BTrace::ESubCategoryIndex*8))
sl@0	3999
sl@0	4000	/**
sl@0	4001	@internalComponent
sl@0	4002	*/
sl@0	4003	#define BTRACE_HEADER_CP(aSize,aCategory,aSubCategory) \
sl@0	4004	((((aSize)+8)<<BTrace::ESizeIndex*8) \
sl@0	4005	+((BTrace::EContextIdPresent\|BTrace::EPcPresent)<<BTrace::EFlagsIndex*8) \
sl@0	4006	+((aCategory)<<BTrace::ECategoryIndex*8) \
sl@0	4007	+((aSubCategory)<<BTrace::ESubCategoryIndex*8))
sl@0	4008
sl@0	4009
sl@0	4010
sl@0	4011	/**
sl@0	4012	Output a trace record of the specified category.
sl@0	4013
sl@0	4014	The trace record data is 0 bytes in size.
sl@0	4015
sl@0	4016	@param aCategory A value from enum BTrace::TCategory,
sl@0	4017	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4018	The meaning of this is dependent on the Category.
sl@0	4019
sl@0	4020	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4021	@publishedPartner
sl@0	4022	@released
sl@0	4023	*/
sl@0	4024	#define BTrace0(aCategory,aSubCategory) \
sl@0	4025	((BTrace::TBTrace1)BTrace::Out) \
sl@0	4026	(BTRACE_HEADER(4,(aCategory),(aSubCategory)))
sl@0	4027
sl@0	4028	/**
sl@0	4029	Output a trace record of the specified category.
sl@0	4030
sl@0	4031	The trace record data is 4 bytes in size.
sl@0	4032
sl@0	4033	@param aCategory A value from enum BTrace::TCategory,
sl@0	4034	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4035	The meaning of this is dependent on the Category.
sl@0	4036	@param a1 The 32bit quantity which forms the data of this trace record.
sl@0	4037
sl@0	4038	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4039	@publishedPartner
sl@0	4040	@released
sl@0	4041	*/
sl@0	4042	#define BTrace4(aCategory,aSubCategory,a1) \
sl@0	4043	((BTrace::TBTrace2)BTrace::Out) \
sl@0	4044	(BTRACE_HEADER(8,(aCategory),(aSubCategory)),(TUint32)(a1))
sl@0	4045
sl@0	4046	/**
sl@0	4047	Output a trace record of the specified category.
sl@0	4048
sl@0	4049	The trace record data is 8 bytes in size.
sl@0	4050
sl@0	4051	@param aCategory A value from enum BTrace::TCategory,
sl@0	4052	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4053	The meaning of this is dependent on the Category.
sl@0	4054	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4055	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4056
sl@0	4057	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4058	@publishedPartner
sl@0	4059	@released
sl@0	4060	*/
sl@0	4061	#define BTrace8(aCategory,aSubCategory,a1,a2) \
sl@0	4062	((BTrace::TBTrace3)BTrace::Out) \
sl@0	4063	(BTRACE_HEADER(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2))
sl@0	4064
sl@0	4065	/**
sl@0	4066	Output a trace record of the specified category.
sl@0	4067
sl@0	4068	The trace record data is 12 bytes in size.
sl@0	4069
sl@0	4070	@param aCategory A value from enum BTrace::TCategory,
sl@0	4071	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4072	The meaning of this is dependent on the Category.
sl@0	4073	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4074	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4075	@param a3 The third 32bit quantity which forms the data of this trace record.
sl@0	4076
sl@0	4077	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4078	@publishedPartner
sl@0	4079	@released
sl@0	4080	*/
sl@0	4081	#define BTrace12(aCategory,aSubCategory,a1,a2,a3) \
sl@0	4082	BTrace::Out \
sl@0	4083	(BTRACE_HEADER(16,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),(TUint32)(a3))
sl@0	4084
sl@0	4085	/**
sl@0	4086	Output a trace record of the specified category.
sl@0	4087
sl@0	4088	@param aCategory A value from enum BTrace::TCategory,
sl@0	4089	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4090	The meaning of this is dependent on the Category.
sl@0	4091	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4092	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4093	@param aData Address of addition data to add to trace.
sl@0	4094	Must be word aligned, i.e. a multiple of 4.
sl@0	4095	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4096	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4097	flag ERecordTruncated is set in the record.
sl@0	4098
sl@0	4099	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4100	@publishedPartner
sl@0	4101	@released
sl@0	4102	*/
sl@0	4103	#define BTraceN(aCategory,aSubCategory,a1,a2,aData,aDataSize) \
sl@0	4104	BTrace::OutN \
sl@0	4105	(BTRACE_HEADER(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),aData,aDataSize)
sl@0	4106
sl@0	4107	/**
sl@0	4108	Output a trace record of the specified category.
sl@0	4109
sl@0	4110	If the specified data is too big to find into a single trace record, then a
sl@0	4111	multipart trace is generated. See TMultiPart.
sl@0	4112
sl@0	4113	@param aCategory A value from enum BTrace::TCategory,
sl@0	4114	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4115	The meaning of this is dependent on the Category.
sl@0	4116	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4117	@param aData Address of addition data to add to trace.
sl@0	4118	Must be word aligned, i.e. a multiple of 4.
sl@0	4119	@param aDataSize Number of bytes of additional data.
sl@0	4120
sl@0	4121	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4122	@publishedPartner
sl@0	4123	@released
sl@0	4124	*/
sl@0	4125	#define BTraceBig(aCategory,aSubCategory,a1,aData,aDataSize) \
sl@0	4126	BTrace::OutBig \
sl@0	4127	(BTRACE_HEADER(8,(aCategory),(aSubCategory)),(TUint32)(a1),aData,(TInt)(aDataSize))
sl@0	4128
sl@0	4129
sl@0	4130
sl@0	4131	/**
sl@0	4132	Output a trace record of the specified category.
sl@0	4133
sl@0	4134	The trace record data is 0 bytes in size.
sl@0	4135
sl@0	4136	@param aCategory A value from enum BTrace::TCategory,
sl@0	4137	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4138	The meaning of this is dependent on the Category.
sl@0	4139
sl@0	4140	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4141	@publishedPartner
sl@0	4142	@released
sl@0	4143	*/
sl@0	4144	#define BTraceContext0(aCategory,aSubCategory) \
sl@0	4145	((BTrace::TBTrace1)BTrace::OutX) \
sl@0	4146	(BTRACE_HEADER_C(4,(aCategory),(aSubCategory)))
sl@0	4147
sl@0	4148	/**
sl@0	4149	Output a trace record of the specified category which also includes a Context ID.
sl@0	4150
sl@0	4151	The trace record data is 4 bytes in size.
sl@0	4152
sl@0	4153	@param aCategory A value from enum BTrace::TCategory,
sl@0	4154	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4155	The meaning of this is dependent on the Category.
sl@0	4156	@param a1 The 32bit quantity which forms the data of this trace record.
sl@0	4157
sl@0	4158	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4159	@publishedPartner
sl@0	4160	@released
sl@0	4161	*/
sl@0	4162	#define BTraceContext4(aCategory,aSubCategory,a1) \
sl@0	4163	((BTrace::TBTrace2)BTrace::OutX) \
sl@0	4164	(BTRACE_HEADER_C(8,(aCategory),(aSubCategory)),(TUint32)(a1))
sl@0	4165
sl@0	4166	/**
sl@0	4167	Output a trace record of the specified category which also includes a Context ID.
sl@0	4168
sl@0	4169	The trace record data is 8 bytes in size.
sl@0	4170
sl@0	4171	@param aCategory A value from enum BTrace::TCategory,
sl@0	4172	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4173	The meaning of this is dependent on the Category.
sl@0	4174	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4175	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4176
sl@0	4177	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4178	@publishedPartner
sl@0	4179	@released
sl@0	4180	*/
sl@0	4181	#define BTraceContext8(aCategory,aSubCategory,a1,a2) \
sl@0	4182	((BTrace::TBTrace3)BTrace::OutX) \
sl@0	4183	(BTRACE_HEADER_C(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2))
sl@0	4184
sl@0	4185	/**
sl@0	4186	Output a trace record of the specified category which also includes a Context ID.
sl@0	4187
sl@0	4188	The trace record data is 12 bytes in size.
sl@0	4189
sl@0	4190	@param aCategory A value from enum BTrace::TCategory,
sl@0	4191	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4192	The meaning of this is dependent on the Category.
sl@0	4193	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4194	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4195	@param a3 The third 32bit quantity which forms the data of this trace record.
sl@0	4196
sl@0	4197	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4198	@publishedPartner
sl@0	4199	@released
sl@0	4200	*/
sl@0	4201	#define BTraceContext12(aCategory,aSubCategory,a1,a2,a3) \
sl@0	4202	BTrace::OutX \
sl@0	4203	(BTRACE_HEADER_C(16,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),(TUint32)(a3))
sl@0	4204
sl@0	4205	/**
sl@0	4206	Output a trace record of the specified category which also includes a Context ID.
sl@0	4207
sl@0	4208	@param aCategory A value from enum BTrace::TCategory,
sl@0	4209	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4210	The meaning of this is dependent on the Category.
sl@0	4211	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4212	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4213	@param aData Address of addition data to add to trace.
sl@0	4214	Must be word aligned, i.e. a multiple of 4.
sl@0	4215	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4216	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4217	flag ERecordTruncated is set in the record.
sl@0	4218
sl@0	4219	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4220	@publishedPartner
sl@0	4221	@released
sl@0	4222	*/
sl@0	4223	#define BTraceContextN(aCategory,aSubCategory,a1,a2,aData,aDataSize) \
sl@0	4224	BTrace::OutNX \
sl@0	4225	(BTRACE_HEADER_C(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),aData,aDataSize)
sl@0	4226
sl@0	4227	/**
sl@0	4228	Output a trace record of the specified category which also includes a Context ID.
sl@0	4229
sl@0	4230	If the specified data is too big to find into a single trace record, then a
sl@0	4231	multipart trace is generated. See TMultiPart.
sl@0	4232
sl@0	4233	@param aCategory A value from enum BTrace::TCategory,
sl@0	4234	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4235	The meaning of this is dependent on the Category.
sl@0	4236	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4237	@param aData Address of addition data to add to trace.
sl@0	4238	Must be word aligned, i.e. a multiple of 4.
sl@0	4239	@param aDataSize Number of bytes of additional data.
sl@0	4240
sl@0	4241	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4242	@publishedPartner
sl@0	4243	@released
sl@0	4244	*/
sl@0	4245	#define BTraceContextBig(aCategory,aSubCategory,a1,aData,aDataSize) \
sl@0	4246	BTrace::OutBig \
sl@0	4247	(BTRACE_HEADER_C(8,(aCategory),(aSubCategory)),(TUint32)(a1),aData,(TInt)(aDataSize))
sl@0	4248
sl@0	4249
sl@0	4250
sl@0	4251	/**
sl@0	4252	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4253
sl@0	4254	The trace record data is 0 bytes in size.
sl@0	4255
sl@0	4256	@param aCategory A value from enum BTrace::TCategory,
sl@0	4257	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4258	The meaning of this is dependent on the Category.
sl@0	4259
sl@0	4260	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4261	@publishedPartner
sl@0	4262	@released
sl@0	4263	*/
sl@0	4264	#define BTracePc0(aCategory,aSubCategory) \
sl@0	4265	((BTrace::TBTrace1)BTrace::Out) \
sl@0	4266	(BTRACE_HEADER_P(4,(aCategory),(aSubCategory)))
sl@0	4267
sl@0	4268	/**
sl@0	4269	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4270
sl@0	4271	The trace record data is 4 bytes in size.
sl@0	4272
sl@0	4273	@param aCategory A value from enum BTrace::TCategory,
sl@0	4274	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4275	The meaning of this is dependent on the Category.
sl@0	4276	@param a1 The 32bit quantity which forms the data of this trace record.
sl@0	4277
sl@0	4278	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4279	@publishedPartner
sl@0	4280	@released
sl@0	4281	*/
sl@0	4282	#define BTracePc4(aCategory,aSubCategory,a1) \
sl@0	4283	((BTrace::TBTrace2)BTrace::Out) \
sl@0	4284	(BTRACE_HEADER_P(8,(aCategory),(aSubCategory)),(TUint32)(a1))
sl@0	4285
sl@0	4286	/**
sl@0	4287	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4288
sl@0	4289	The trace record data is 8 bytes in size.
sl@0	4290
sl@0	4291	@param aCategory A value from enum BTrace::TCategory,
sl@0	4292	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4293	The meaning of this is dependent on the Category.
sl@0	4294	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4295	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4296
sl@0	4297	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4298	@publishedPartner
sl@0	4299	@released
sl@0	4300	*/
sl@0	4301	#define BTracePc8(aCategory,aSubCategory,a1,a2) \
sl@0	4302	((BTrace::TBTrace3)BTrace::Out) \
sl@0	4303	(BTRACE_HEADER_P(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2))
sl@0	4304
sl@0	4305	/**
sl@0	4306	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4307
sl@0	4308	The trace record data is 12 bytes in size.
sl@0	4309
sl@0	4310	@param aCategory A value from enum BTrace::TCategory,
sl@0	4311	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4312	The meaning of this is dependent on the Category.
sl@0	4313	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4314	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4315	@param a3 The third 32bit quantity which forms the data of this trace record.
sl@0	4316
sl@0	4317	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4318	@publishedPartner
sl@0	4319	@released
sl@0	4320	*/
sl@0	4321	#define BTracePc12(aCategory,aSubCategory,a1,a2,a3) \
sl@0	4322	BTrace::Out \
sl@0	4323	(BTRACE_HEADER_P(16,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),(TUint32)(a3))
sl@0	4324
sl@0	4325	/**
sl@0	4326	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4327
sl@0	4328	@param aCategory A value from enum BTrace::TCategory,
sl@0	4329	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4330	The meaning of this is dependent on the Category.
sl@0	4331	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4332	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4333	@param aData Address of addition data to add to trace.
sl@0	4334	Must be word aligned, i.e. a multiple of 4.
sl@0	4335	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4336	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4337	flag ERecordTruncated is set in the record.
sl@0	4338
sl@0	4339	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4340	@publishedPartner
sl@0	4341	@released
sl@0	4342	*/
sl@0	4343	#define BTracePcN(aCategory,aSubCategory,a1,a2,aData,aDataSize) \
sl@0	4344	BTrace::OutN \
sl@0	4345	(BTRACE_HEADER_P(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),aData,aDataSize)
sl@0	4346
sl@0	4347	/**
sl@0	4348	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4349
sl@0	4350	If the specified data is too big to find into a single trace record, then a
sl@0	4351	multipart trace is generated. See TMultiPart.
sl@0	4352
sl@0	4353	@param aCategory A value from enum BTrace::TCategory,
sl@0	4354	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4355	The meaning of this is dependent on the Category.
sl@0	4356	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4357	@param aData Address of addition data to add to trace.
sl@0	4358	Must be word aligned, i.e. a multiple of 4.
sl@0	4359	@param aDataSize Number of bytes of additional data.
sl@0	4360
sl@0	4361	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4362	@publishedPartner
sl@0	4363	@released
sl@0	4364	*/
sl@0	4365	#define BTracePcBig(aCategory,aSubCategory,a1,aData,aDataSize) \
sl@0	4366	BTrace::OutBig \
sl@0	4367	(BTRACE_HEADER_P(8,(aCategory),(aSubCategory)),(TUint32)(a1),aData,(TInt)(aDataSize))
sl@0	4368
sl@0	4369
sl@0	4370
sl@0	4371
sl@0	4372	/**
sl@0	4373	Output a trace record of the specified category which also includes
sl@0	4374	Context ID and Program Counter values.
sl@0	4375
sl@0	4376	The trace record data is 0 bytes in size.
sl@0	4377
sl@0	4378	@param aCategory A value from enum BTrace::TCategory,
sl@0	4379	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4380	The meaning of this is dependent on the Category.
sl@0	4381
sl@0	4382	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4383	@publishedPartner
sl@0	4384	@released
sl@0	4385	*/
sl@0	4386	#define BTraceContextPc0(aCategory,aSubCategory) \
sl@0	4387	((BTrace::TBTrace1)BTrace::OutX) \
sl@0	4388	(BTRACE_HEADER_CP(4,(aCategory),(aSubCategory)))
sl@0	4389
sl@0	4390	/**
sl@0	4391	Output a trace record of the specified category which also includes
sl@0	4392	Context ID and Program Counter values.
sl@0	4393
sl@0	4394	The trace record data is 4 bytes in size.
sl@0	4395
sl@0	4396	@param aCategory A value from enum BTrace::TCategory,
sl@0	4397	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4398	The meaning of this is dependent on the Category.
sl@0	4399	@param a1 The 32bit quantity which forms the data of this trace record.
sl@0	4400
sl@0	4401	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4402	@publishedPartner
sl@0	4403	@released
sl@0	4404	*/
sl@0	4405	#define BTraceContextPc4(aCategory,aSubCategory,a1) \
sl@0	4406	((BTrace::TBTrace2)BTrace::OutX) \
sl@0	4407	(BTRACE_HEADER_CP(8,(aCategory),(aSubCategory)),(TUint32)(a1))
sl@0	4408
sl@0	4409	/**
sl@0	4410	Output a trace record of the specified category which also includes
sl@0	4411	Context ID and Program Counter values.
sl@0	4412
sl@0	4413	The trace record data is 8 bytes in size.
sl@0	4414
sl@0	4415	@param aCategory A value from enum BTrace::TCategory,
sl@0	4416	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4417	The meaning of this is dependent on the Category.
sl@0	4418	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4419	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4420
sl@0	4421	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4422	@publishedPartner
sl@0	4423	@released
sl@0	4424	*/
sl@0	4425	#define BTraceContextPc8(aCategory,aSubCategory,a1,a2) \
sl@0	4426	((BTrace::TBTrace3)BTrace::OutX) \
sl@0	4427	(BTRACE_HEADER_CP(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2))
sl@0	4428
sl@0	4429	/**
sl@0	4430	Output a trace record of the specified category which also includes
sl@0	4431	Context ID and Program Counter values.
sl@0	4432
sl@0	4433	The trace record data is 12 bytes in size.
sl@0	4434
sl@0	4435	@param aCategory A value from enum BTrace::TCategory,
sl@0	4436	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4437	The meaning of this is dependent on the Category.
sl@0	4438	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4439	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4440	@param a3 The third 32bit quantity which forms the data of this trace record.
sl@0	4441
sl@0	4442	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4443	@publishedPartner
sl@0	4444	@released
sl@0	4445	*/
sl@0	4446	#define BTraceContextPc12(aCategory,aSubCategory,a1,a2,a3) \
sl@0	4447	BTrace::OutX \
sl@0	4448	(BTRACE_HEADER_CP(16,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),(TUint32)(a3))
sl@0	4449
sl@0	4450	/**
sl@0	4451	Output a trace record of the specified category which also includes
sl@0	4452	Context ID and Program Counter values.
sl@0	4453
sl@0	4454	@param aCategory A value from enum BTrace::TCategory,
sl@0	4455	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4456	The meaning of this is dependent on the Category.
sl@0	4457	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4458	@param a2 The second 32bit quantity which forms the data of this trace record.
sl@0	4459	@param aData Address of addition data to add to trace.
sl@0	4460	Must be word aligned, i.e. a multiple of 4.
sl@0	4461	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4462	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4463	flag ERecordTruncated is set in the record.
sl@0	4464
sl@0	4465	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4466	@publishedPartner
sl@0	4467	@released
sl@0	4468	*/
sl@0	4469	#define BTraceContextPcN(aCategory,aSubCategory,a1,a2,aData,aDataSize) \
sl@0	4470	BTrace::OutNX \
sl@0	4471	(BTRACE_HEADER_CP(12,(aCategory),(aSubCategory)),(TUint32)(a1),(TUint32)(a2),aData,aDataSize)
sl@0	4472
sl@0	4473	/**
sl@0	4474	Output a trace record of the specified category which also includes
sl@0	4475	Context ID and Program Counter values.
sl@0	4476
sl@0	4477	If the specified data is too big to find into a single trace record, then a
sl@0	4478	multipart trace is generated. See TMultiPart.
sl@0	4479
sl@0	4480	@param aCategory A value from enum BTrace::TCategory,
sl@0	4481	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4482	The meaning of this is dependent on the Category.
sl@0	4483	@param a1 The first 32bit quantity which forms the data of this trace record.
sl@0	4484	@param aData Address of addition data to add to trace.
sl@0	4485	Must be word aligned, i.e. a multiple of 4.
sl@0	4486	@param aDataSize Number of bytes of additional data.
sl@0	4487
sl@0	4488	@return True if trace is enabled for aCategory, false otherwise.
sl@0	4489	@publishedPartner
sl@0	4490	@released
sl@0	4491	*/
sl@0	4492	#define BTraceContextPcBig(aCategory,aSubCategory,a1,aData,aDataSize) \
sl@0	4493	BTrace::OutBig \
sl@0	4494	(BTRACE_HEADER_CP(8,(aCategory),(aSubCategory)),(TUint32)(a1),aData,(TInt)(aDataSize))
sl@0	4495
sl@0	4496
sl@0	4497
sl@0	4498	/**
sl@0	4499	Output a trace record of the specified category.
sl@0	4500
sl@0	4501	The trace record data is 4 bytes in size.
sl@0	4502
sl@0	4503	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4504
sl@0	4505	@param aCategory A value from enum BTrace::TCategory,
sl@0	4506	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4507	The meaning of this is dependent on the Category.
sl@0	4508	@param aUid The 32bit quantity which forms the data of this trace record.
sl@0	4509
sl@0	4510	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4511	@publishedPartner
sl@0	4512	@released
sl@0	4513	*/
sl@0	4514	#define BTraceFiltered4(aCategory,aSubCategory,aUid) \
sl@0	4515	((BTrace::TBTrace2)BTrace::OutFiltered) \
sl@0	4516	(BTRACE_HEADER(8,(aCategory),(aSubCategory)),(TUint32)(aUid))
sl@0	4517
sl@0	4518	/**
sl@0	4519	Output a trace record of the specified category.
sl@0	4520
sl@0	4521	The trace record data is 8 bytes in size.
sl@0	4522
sl@0	4523	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4524
sl@0	4525	@param aCategory A value from enum BTrace::TCategory,
sl@0	4526	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4527	The meaning of this is dependent on the Category.
sl@0	4528	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4529	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4530
sl@0	4531	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4532	@publishedPartner
sl@0	4533	@released
sl@0	4534	*/
sl@0	4535	#define BTraceFiltered8(aCategory,aSubCategory,aUid,a1) \
sl@0	4536	((BTrace::TBTrace3)BTrace::OutFiltered) \
sl@0	4537	(BTRACE_HEADER(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1))
sl@0	4538
sl@0	4539	/**
sl@0	4540	Output a trace record of the specified category.
sl@0	4541
sl@0	4542	The trace record data is 12 bytes in size.
sl@0	4543
sl@0	4544	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4545
sl@0	4546	@param aCategory A value from enum BTrace::TCategory,
sl@0	4547	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4548	The meaning of this is dependent on the Category.
sl@0	4549	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4550	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4551	@param a2 The third 32bit quantity which forms the data of this trace record.
sl@0	4552
sl@0	4553	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4554	@publishedPartner
sl@0	4555	@released
sl@0	4556	*/
sl@0	4557	#define BTraceFiltered12(aCategory,aSubCategory,aUid,a1,a2) \
sl@0	4558	BTrace::OutFiltered \
sl@0	4559	(BTRACE_HEADER(16,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),(TUint32)(a2))
sl@0	4560
sl@0	4561	/**
sl@0	4562	Output a trace record of the specified category.
sl@0	4563
sl@0	4564	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4565
sl@0	4566	@param aCategory A value from enum BTrace::TCategory,
sl@0	4567	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4568	The meaning of this is dependent on the Category.
sl@0	4569	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4570	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4571	@param aData Address of addition data to add to trace.
sl@0	4572	Must be word aligned, i.e. a multiple of 4.
sl@0	4573	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4574	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4575	flag ERecordTruncated is set in the record.
sl@0	4576
sl@0	4577	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4578	@publishedPartner
sl@0	4579	@released
sl@0	4580	*/
sl@0	4581	#define BTraceFilteredN(aCategory,aSubCategory,aUid,a1,aData,aDataSize) \
sl@0	4582	BTrace::OutFilteredN \
sl@0	4583	(BTRACE_HEADER(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),aData,aDataSize)
sl@0	4584
sl@0	4585	/**
sl@0	4586	Output a trace record of the specified category.
sl@0	4587
sl@0	4588	If the specified data is too big to find into a single trace record, then a
sl@0	4589	multipart trace is generated. See TMultiPart.
sl@0	4590
sl@0	4591	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4592
sl@0	4593	@param aCategory A value from enum BTrace::TCategory,
sl@0	4594	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4595	The meaning of this is dependent on the Category.
sl@0	4596	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4597	@param aData Address of addition data to add to trace.
sl@0	4598	Must be word aligned, i.e. a multiple of 4.
sl@0	4599	@param aDataSize Number of bytes of additional data.
sl@0	4600
sl@0	4601	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4602	@publishedPartner
sl@0	4603	@released
sl@0	4604	*/
sl@0	4605	#define BTraceFilteredBig(aCategory,aSubCategory,aUid,aData,aDataSize) \
sl@0	4606	BTrace::OutFilteredBig \
sl@0	4607	(BTRACE_HEADER(8,(aCategory),(aSubCategory)),(TUint32)(aUid),aData,(TInt)(aDataSize))
sl@0	4608
sl@0	4609
sl@0	4610
sl@0	4611	/**
sl@0	4612	Output a trace record of the specified category which also includes a Context ID.
sl@0	4613
sl@0	4614	The trace record data is 4 bytes in size.
sl@0	4615
sl@0	4616	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4617
sl@0	4618	@param aCategory A value from enum BTrace::TCategory,
sl@0	4619	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4620	The meaning of this is dependent on the Category.
sl@0	4621	@param aUid The 32bit quantity which forms the data of this trace record.
sl@0	4622
sl@0	4623	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4624	@publishedPartner
sl@0	4625	@released
sl@0	4626	*/
sl@0	4627	#define BTraceFilteredContext4(aCategory,aSubCategory,aUid) \
sl@0	4628	((BTrace::TBTrace2)BTrace::OutFilteredX) \
sl@0	4629	(BTRACE_HEADER_C(8,(aCategory),(aSubCategory)),(TUint32)(aUid))
sl@0	4630
sl@0	4631	/**
sl@0	4632	Output a trace record of the specified category which also includes a Context ID.
sl@0	4633
sl@0	4634	The trace record data is 8 bytes in size.
sl@0	4635
sl@0	4636	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4637
sl@0	4638	@param aCategory A value from enum BTrace::TCategory,
sl@0	4639	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4640	The meaning of this is dependent on the Category.
sl@0	4641	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4642	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4643
sl@0	4644	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4645	@publishedPartner
sl@0	4646	@released
sl@0	4647	*/
sl@0	4648	#define BTraceFilteredContext8(aCategory,aSubCategory,aUid,a1) \
sl@0	4649	((BTrace::TBTrace3)BTrace::OutFilteredX) \
sl@0	4650	(BTRACE_HEADER_C(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1))
sl@0	4651
sl@0	4652	/**
sl@0	4653	Output a trace record of the specified category which also includes a Context ID.
sl@0	4654
sl@0	4655	The trace record data is 12 bytes in size.
sl@0	4656
sl@0	4657	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4658
sl@0	4659	@param aCategory A value from enum BTrace::TCategory,
sl@0	4660	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4661	The meaning of this is dependent on the Category.
sl@0	4662	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4663	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4664	@param a2 The third 32bit quantity which forms the data of this trace record.
sl@0	4665
sl@0	4666	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4667	@publishedPartner
sl@0	4668	@released
sl@0	4669	*/
sl@0	4670	#define BTraceFilteredContext12(aCategory,aSubCategory,aUid,a1,a2) \
sl@0	4671	BTrace::OutFilteredX \
sl@0	4672	(BTRACE_HEADER_C(16,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),(TUint32)(a2))
sl@0	4673
sl@0	4674	/**
sl@0	4675	Output a trace record of the specified category which also includes a Context ID.
sl@0	4676
sl@0	4677	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4678
sl@0	4679	@param aCategory A value from enum BTrace::TCategory,
sl@0	4680	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4681	The meaning of this is dependent on the Category.
sl@0	4682	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4683	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4684	@param aData Address of addition data to add to trace.
sl@0	4685	Must be word aligned, i.e. a multiple of 4.
sl@0	4686	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4687	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4688	flag ERecordTruncated is set in the record.
sl@0	4689
sl@0	4690	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4691	@publishedPartner
sl@0	4692	@released
sl@0	4693	*/
sl@0	4694	#define BTraceFilteredContextN(aCategory,aSubCategory,aUid,a1,aData,aDataSize) \
sl@0	4695	BTrace::OutFilteredNX \
sl@0	4696	(BTRACE_HEADER_C(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),aData,aDataSize)
sl@0	4697
sl@0	4698	/**
sl@0	4699	Output a trace record of the specified category which also includes a Context ID.
sl@0	4700
sl@0	4701	If the specified data is too big to find into a single trace record, then a
sl@0	4702	multipart trace is generated. See TMultiPart.
sl@0	4703
sl@0	4704	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4705
sl@0	4706	@param aCategory A value from enum BTrace::TCategory,
sl@0	4707	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4708	The meaning of this is dependent on the Category.
sl@0	4709	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4710	@param aData Address of addition data to add to trace.
sl@0	4711	Must be word aligned, i.e. a multiple of 4.
sl@0	4712	@param aDataSize Number of bytes of additional data.
sl@0	4713
sl@0	4714	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4715	@publishedPartner
sl@0	4716	@released
sl@0	4717	*/
sl@0	4718	#define BTraceFilteredContextBig(aCategory,aSubCategory,aUid,aData,aDataSize) \
sl@0	4719	BTrace::OutFilteredBig \
sl@0	4720	(BTRACE_HEADER_C(8,(aCategory),(aSubCategory)),(TUint32)(aUid),aData,(TInt)(aDataSize))
sl@0	4721
sl@0	4722
sl@0	4723
sl@0	4724	/**
sl@0	4725	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4726
sl@0	4727	The trace record data is 4 bytes in size.
sl@0	4728
sl@0	4729	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4730
sl@0	4731	@param aCategory A value from enum BTrace::TCategory,
sl@0	4732	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4733	The meaning of this is dependent on the Category.
sl@0	4734	@param aUid The 32bit quantity which forms the data of this trace record.
sl@0	4735
sl@0	4736	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4737	@publishedPartner
sl@0	4738	@released
sl@0	4739	*/
sl@0	4740	#define BTraceFilteredPc4(aCategory,aSubCategory,aUid) \
sl@0	4741	((BTrace::TBTrace2)BTrace::OutFiltered) \
sl@0	4742	(BTRACE_HEADER_P(8,(aCategory),(aSubCategory)),(TUint32)(aUid))
sl@0	4743
sl@0	4744	/**
sl@0	4745	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4746
sl@0	4747	The trace record data is 8 bytes in size.
sl@0	4748
sl@0	4749	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4750
sl@0	4751	@param aCategory A value from enum BTrace::TCategory,
sl@0	4752	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4753	The meaning of this is dependent on the Category.
sl@0	4754	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4755	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4756
sl@0	4757	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4758	@publishedPartner
sl@0	4759	@released
sl@0	4760	*/
sl@0	4761	#define BTraceFilteredPc8(aCategory,aSubCategory,aUid,a1) \
sl@0	4762	((BTrace::TBTrace3)BTrace::OutFiltered) \
sl@0	4763	(BTRACE_HEADER_P(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1))
sl@0	4764
sl@0	4765	/**
sl@0	4766	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4767
sl@0	4768	The trace record data is 12 bytes in size.
sl@0	4769
sl@0	4770	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4771
sl@0	4772	@param aCategory A value from enum BTrace::TCategory,
sl@0	4773	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4774	The meaning of this is dependent on the Category.
sl@0	4775	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4776	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4777	@param a2 The third 32bit quantity which forms the data of this trace record.
sl@0	4778
sl@0	4779	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4780	@publishedPartner
sl@0	4781	@released
sl@0	4782	*/
sl@0	4783	#define BTraceFilteredPc12(aCategory,aSubCategory,aUid,a1,a2) \
sl@0	4784	BTrace::OutFiltered \
sl@0	4785	(BTRACE_HEADER_P(16,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),(TUint32)(a2))
sl@0	4786
sl@0	4787	/**
sl@0	4788	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4789
sl@0	4790	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4791
sl@0	4792	@param aCategory A value from enum BTrace::TCategory,
sl@0	4793	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4794	The meaning of this is dependent on the Category.
sl@0	4795	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4796	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4797	@param aData Address of addition data to add to trace.
sl@0	4798	Must be word aligned, i.e. a multiple of 4.
sl@0	4799	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4800	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4801	flag ERecordTruncated is set in the record.
sl@0	4802
sl@0	4803	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4804	@publishedPartner
sl@0	4805	@released
sl@0	4806	*/
sl@0	4807	#define BTraceFilteredPcN(aCategory,aSubCategory,aUid,a1,aData,aDataSize) \
sl@0	4808	BTrace::OutFilteredN \
sl@0	4809	(BTRACE_HEADER_P(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),aData,aDataSize)
sl@0	4810
sl@0	4811	/**
sl@0	4812	Output a trace record of the specified category which also includes a Program Counter value.
sl@0	4813
sl@0	4814	If the specified data is too big to find into a single trace record, then a
sl@0	4815	multipart trace is generated. See TMultiPart.
sl@0	4816
sl@0	4817	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4818
sl@0	4819	@param aCategory A value from enum BTrace::TCategory,
sl@0	4820	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4821	The meaning of this is dependent on the Category.
sl@0	4822	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4823	@param aData Address of addition data to add to trace.
sl@0	4824	Must be word aligned, i.e. a multiple of 4.
sl@0	4825	@param aDataSize Number of bytes of additional data.
sl@0	4826
sl@0	4827	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4828	@publishedPartner
sl@0	4829	@released
sl@0	4830	*/
sl@0	4831	#define BTraceFilteredPcBig(aCategory,aSubCategory,aUid,aData,aDataSize) \
sl@0	4832	BTrace::OutFilteredBig \
sl@0	4833	(BTRACE_HEADER_P(8,(aCategory),(aSubCategory)),(TUint32)(aUid),aData,(TInt)(aDataSize))
sl@0	4834
sl@0	4835
sl@0	4836
sl@0	4837
sl@0	4838	/**
sl@0	4839	Output a trace record of the specified category which also includes
sl@0	4840	Context ID and Program Counter values.
sl@0	4841
sl@0	4842	The trace record data is 4 bytes in size.
sl@0	4843
sl@0	4844	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4845
sl@0	4846	@param aCategory A value from enum BTrace::TCategory,
sl@0	4847	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4848	The meaning of this is dependent on the Category.
sl@0	4849	@param aUid The 32bit quantity which forms the data of this trace record.
sl@0	4850
sl@0	4851	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4852	@publishedPartner
sl@0	4853	@released
sl@0	4854	*/
sl@0	4855	#define BTraceFilteredContextPc4(aCategory,aSubCategory,aUid) \
sl@0	4856	((BTrace::TBTrace2)BTrace::OutFilteredX) \
sl@0	4857	(BTRACE_HEADER_CP(8,(aCategory),(aSubCategory)),(TUint32)(aUid))
sl@0	4858
sl@0	4859	/**
sl@0	4860	Output a trace record of the specified category which also includes
sl@0	4861	Context ID and Program Counter values.
sl@0	4862
sl@0	4863	The trace record data is 8 bytes in size.
sl@0	4864
sl@0	4865	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4866
sl@0	4867	@param aCategory A value from enum BTrace::TCategory,
sl@0	4868	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4869	The meaning of this is dependent on the Category.
sl@0	4870	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4871	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4872
sl@0	4873	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4874	@publishedPartner
sl@0	4875	@released
sl@0	4876	*/
sl@0	4877	#define BTraceFilteredContextPc8(aCategory,aSubCategory,aUid,a1) \
sl@0	4878	((BTrace::TBTrace3)BTrace::OutFilteredX) \
sl@0	4879	(BTRACE_HEADER_CP(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1))
sl@0	4880
sl@0	4881	/**
sl@0	4882	Output a trace record of the specified category which also includes
sl@0	4883	Context ID and Program Counter values.
sl@0	4884
sl@0	4885	The trace record data is 12 bytes in size.
sl@0	4886
sl@0	4887	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4888
sl@0	4889	@param aCategory A value from enum BTrace::TCategory,
sl@0	4890	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4891	The meaning of this is dependent on the Category.
sl@0	4892	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4893	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4894	@param a2 The third 32bit quantity which forms the data of this trace record.
sl@0	4895
sl@0	4896	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4897	@publishedPartner
sl@0	4898	@released
sl@0	4899	*/
sl@0	4900	#define BTraceFilteredContextPc12(aCategory,aSubCategory,aUid,a1,a2) \
sl@0	4901	BTrace::OutFilteredX \
sl@0	4902	(BTRACE_HEADER_CP(16,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),(TUint32)(a2))
sl@0	4903
sl@0	4904	/**
sl@0	4905	Output a trace record of the specified category which also includes
sl@0	4906	Context ID and Program Counter values.
sl@0	4907
sl@0	4908	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4909
sl@0	4910	@param aCategory A value from enum BTrace::TCategory,
sl@0	4911	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4912	The meaning of this is dependent on the Category.
sl@0	4913	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4914	@param a1 The second 32bit quantity which forms the data of this trace record.
sl@0	4915	@param aData Address of addition data to add to trace.
sl@0	4916	Must be word aligned, i.e. a multiple of 4.
sl@0	4917	@param aDataSize Number of bytes of additional data. If this value is greater than
sl@0	4918	KMaxBTraceDataArray then data is truncated to this size and the
sl@0	4919	flag ERecordTruncated is set in the record.
sl@0	4920
sl@0	4921	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4922	@publishedPartner
sl@0	4923	@released
sl@0	4924	*/
sl@0	4925	#define BTraceFilteredContextPcN(aCategory,aSubCategory,aUid,a1,aData,aDataSize) \
sl@0	4926	BTrace::OutFilteredNX \
sl@0	4927	(BTRACE_HEADER_CP(12,(aCategory),(aSubCategory)),(TUint32)(aUid),(TUint32)(a1),aData,aDataSize)
sl@0	4928
sl@0	4929	/**
sl@0	4930	Output a trace record of the specified category which also includes
sl@0	4931	Context ID and Program Counter values.
sl@0	4932
sl@0	4933	If the specified data is too big to find into a single trace record, then a
sl@0	4934	multipart trace is generated. See TMultiPart.
sl@0	4935
sl@0	4936	If the value of \a aUid is not contained in the secondary filter then the trace is discarded.
sl@0	4937
sl@0	4938	@param aCategory A value from enum BTrace::TCategory,
sl@0	4939	@param aSubCategory Sub-category value between 0 and 255.
sl@0	4940	The meaning of this is dependent on the Category.
sl@0	4941	@param aUid The first 32bit quantity which forms the data of this trace record.
sl@0	4942	@param aData Address of addition data to add to trace.
sl@0	4943	Must be word aligned, i.e. a multiple of 4.
sl@0	4944	@param aDataSize Number of bytes of additional data.
sl@0	4945
sl@0	4946	@return True if trace is enabled for aCategory and aUid, false otherwise.
sl@0	4947	@publishedPartner
sl@0	4948	@released
sl@0	4949	*/
sl@0	4950	#define BTraceFilteredContextPcBig(aCategory,aSubCategory,aUid,aData,aDataSize) \
sl@0	4951	BTrace::OutFilteredBig \
sl@0	4952	(BTRACE_HEADER_CP(8,(aCategory),(aSubCategory)),(TUint32)(aUid),aData,(TInt)(aDataSize))
sl@0	4953
sl@0	4954
sl@0	4955
sl@0	4956	//
sl@0	4957	// Inline methods
sl@0	4958	//
sl@0	4959
sl@0	4960	inline TUint8* BTrace::NextRecord(TAny* aCurrentRecord)
sl@0	4961	{
sl@0	4962	TUint size = ((TUint8*)aCurrentRecord)[ESizeIndex];
sl@0	4963	(TUint)&aCurrentRecord += 3;
sl@0	4964	(TUint)&aCurrentRecord += size;
sl@0	4965	(TUint)&aCurrentRecord &= ~3;
sl@0	4966	return (TUint8*)aCurrentRecord;
sl@0	4967	}
sl@0	4968
sl@0	4969	#ifdef __KERNEL_MODE__
sl@0	4970
sl@0	4971	inline TInt BTrace::Filter(TUint aCategory)
sl@0	4972	{
sl@0	4973	return SetFilter(aCategory,-1);
sl@0	4974	}
sl@0	4975
sl@0	4976	#endif
sl@0	4977
sl@0	4978	/**
sl@0	4979	The maximum permissible value for aDataSize in trace outputs.
sl@0	4980	@see BTraceN BTracePcN BTraceContextN BTraceContextPcN
sl@0	4981	@publishedPartner
sl@0	4982	@released
sl@0	4983	*/
sl@0	4984	const TUint KMaxBTraceDataArray = 80;
sl@0	4985
sl@0	4986
sl@0	4987
sl@0	4988	/**
sl@0	4989	The maximum total number of bytes in a trace record.
sl@0	4990	@publishedPartner
sl@0	4991	@released
sl@0	4992	*/
sl@0	4993	const TInt KMaxBTraceRecordSize = 7*4+8+KMaxBTraceDataArray;
sl@0	4994
sl@0	4995
sl@0	4996	#ifdef __MARM__
sl@0	4997	#define BTRACE_MACHINE_CODED
sl@0	4998	#endif
sl@0	4999
sl@0	5000	#endif

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200 (2014-06-10)
changeset 1	260cb5ec6c19
permissions	-rw-r--r--