summaryrefslogtreecommitdiff
path: root/software/include/oct6100api/oct6100_debug_inst.h
blob: c5db58552ffbc6ce89cd3eec3ec668d6776ac040 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\

File:  oct6100_debug_inst.h

    Copyright (c) 2001-2011 Octasic Inc.
    
Description: 

	File containing all defines, macros, and structures pertaining to the file
	oct6100_debug.c.  All elements defined in this file are for public
	usage of the API.  All private elements are defined in the
	oct6100_debug_priv.h file.

This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API  is 
free software; you can redistribute it and/or modify it under the terms of 
the GNU General Public License as published by the Free Software Foundation; 
either version 2 of the License, or (at your option) any later version.

The OCT6100 GPL API is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
for more details. 

You should have received a copy of the GNU General Public License 
along with the OCT6100 GPL API; if not, write to the Free Software 
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

$Octasic_Release: OCT612xAPI-01.04.05 $

$Octasic_Revision: 15 $

\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/

#ifndef __OCT6100_DEBUG_INST_H__
#define __OCT6100_DEBUG_INST_H__

/*****************************  INCLUDE FILES  *******************************/


/*****************************  DEFINES  *************************************/


/*****************************  TYPES  ***************************************/

typedef struct _OCT6100_API_DEBUG_
{
	/* Information from the TLVs. */
	UINT32	ulDebugEventSize;
	UINT32	ulMatrixBaseAddress;
	UINT32	ulDebugChanStatsByteSize;
	UINT32	ulDebugChanLiteStatsByteSize;
	UINT32	ulHotChannelSelectBaseAddress;
	UINT32	ulMatrixTimestampBaseAddress;
	UINT32	ulAfWritePtrByteOffset;
	UINT32	ulRecordedPcmEventByteSize;
	UINT32	ulMatrixWpBaseAddress;

	/* Pouch counter presence in the image. */
	UINT8	fPouchCounter;

	/* Record channel indexes. */
	UINT16	usRecordMemIndex;
	UINT16	usRecordChanIndex;

	UINT16	usRecordRinRoutTsiMemIndex;
	UINT16	usRecordSinSoutTsiMemIndex;
	
	/* Debug channel information.*/
	UINT16	usCurrentDebugChanIndex;

	/* Matrix event mask. */
	UINT16	usMatrixCBMask;

	/* If data is being dumped now. */
	UINT8	fDebugDataBeingDumped;

	/* Index of the last event retrieved. */
	UINT16	usLastDebugEventIndex;

	/* Number of events to retrieve. */
	UINT16	usNumEvents;

	/* Chip debug event write ptr. */
	UINT16	usChipDebugEventWritePtr;

	/* Hot channel read data. */
	UINT16	ausHotChannelData[ 2 ];

	/* Last PCM sample index. */
	UINT32	ulLastPcmSampleIndex;

	/* Last AF log read pointer. */
	UINT16	usLastAfLogReadPtr;

	/* Last core dump memory offset. */
	UINT32	ulLastMemoryOffset;



	/* AF log hardware write pointer. */
	UINT16	usAfLogWritePtr;

	/* Last tone event index retrieved. */
	UINT16	usLastToneEventIndex;

	/* Whether the image version string has been copied in the user buffer. */
	BOOL	fImageVersionCopied;

	/* Whether the api version string has been copied in the user buffer. */
	BOOL	fApiVersionCopied;

	/* Whether the chip's internal & external memories have been added to the dump. */
	BOOL	fCoreDumped;



	/* Total number of bytes that will be returned for the current dump. */
	UINT32	ulDebugDataTotalNumBytes;

	/* Field to detect if the ISR is called present? */
	BOOL	fIsIsrCalledField;

	/* Remaining number of bytes that will be returned for the current dump. */
	UINT32	ulDebugDataRemainingNumBytes;

	/* AF events control block size. */
	UINT32	ulAfEventCbByteSize;

	/* Current user selected data mode.  Must be kept constant throughout a debug session. */
	UINT32	ulCurrentGetDataMode;

	BOOL	fRecordChanUp;

} tOCT6100_API_DEBUG, *tPOCT6100_API_DEBUG;

#endif /* __OCT6100_DEBUG_INST_H__ */