| 1 |
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\ |
| 2 |
|
| 3 |
File: oct6100_debug_inst.h |
| 4 |
|
| 5 |
Copyright (c) 2001-2007 Octasic Inc. |
| 6 |
|
| 7 |
Description: |
| 8 |
|
| 9 |
File containing all defines, macros, and structures pertaining to the file |
| 10 |
oct6100_debug.c. All elements defined in this file are for public |
| 11 |
usage of the API. All private elements are defined in the |
| 12 |
oct6100_debug_priv.h file. |
| 13 |
|
| 14 |
This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is |
| 15 |
free software; you can redistribute it and/or modify it under the terms of |
| 16 |
the GNU General Public License as published by the Free Software Foundation; |
| 17 |
either version 2 of the License, or (at your option) any later version. |
| 18 |
|
| 19 |
The OCT6100 GPL API is distributed in the hope that it will be useful, but |
| 20 |
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| 21 |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 22 |
for more details. |
| 23 |
|
| 24 |
You should have received a copy of the GNU General Public License |
| 25 |
along with the OCT6100 GPL API; if not, write to the Free Software |
| 26 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 27 |
|
| 28 |
$Octasic_Release: OCT612xAPI-01.00-PR49 $ |
| 29 |
|
| 30 |
$Octasic_Revision: 10 $ |
| 31 |
|
| 32 |
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/ |
| 33 |
|
| 34 |
#ifndef __OCT6100_DEBUG_INST_H__ |
| 35 |
#define __OCT6100_DEBUG_INST_H__ |
| 36 |
|
| 37 |
/***************************** INCLUDE FILES *******************************/ |
| 38 |
|
| 39 |
|
| 40 |
/***************************** DEFINES *************************************/ |
| 41 |
|
| 42 |
|
| 43 |
/***************************** TYPES ***************************************/ |
| 44 |
|
| 45 |
typedef struct _OCT6100_API_DEBUG_ |
| 46 |
{ |
| 47 |
/* Information from the TLVs. */ |
| 48 |
UINT32 ulDebugEventSize; |
| 49 |
UINT32 ulMatrixBaseAddress; |
| 50 |
UINT32 ulDebugChanStatsByteSize; |
| 51 |
UINT32 ulDebugChanLiteStatsByteSize; |
| 52 |
UINT32 ulHotChannelSelectBaseAddress; |
| 53 |
UINT32 ulMatrixTimestampBaseAddress; |
| 54 |
UINT32 ulAfWritePtrByteOffset; |
| 55 |
UINT32 ulRecordedPcmEventByteSize; |
| 56 |
UINT32 ulMatrixWpBaseAddress; |
| 57 |
|
| 58 |
/* Pouch counter presence in the image. */ |
| 59 |
UINT8 fPouchCounter; |
| 60 |
|
| 61 |
/* Record channel indexes. */ |
| 62 |
UINT16 usRecordMemIndex; |
| 63 |
UINT16 usRecordChanIndex; |
| 64 |
|
| 65 |
UINT16 usRecordRinRoutTsiMemIndex; |
| 66 |
UINT16 usRecordSinSoutTsiMemIndex; |
| 67 |
|
| 68 |
/* Debug channel information.*/ |
| 69 |
UINT16 usCurrentDebugChanIndex; |
| 70 |
|
| 71 |
/* Matrix event mask. */ |
| 72 |
UINT16 usMatrixCBMask; |
| 73 |
|
| 74 |
/* If data is being dumped now. */ |
| 75 |
UINT8 fDebugDataBeingDumped; |
| 76 |
|
| 77 |
/* Index of the last event retrieved. */ |
| 78 |
UINT16 usLastDebugEventIndex; |
| 79 |
|
| 80 |
/* Number of events to retrieve. */ |
| 81 |
UINT16 usNumEvents; |
| 82 |
|
| 83 |
/* Chip debug event write ptr. */ |
| 84 |
UINT16 usChipDebugEventWritePtr; |
| 85 |
|
| 86 |
/* Hot channel read data. */ |
| 87 |
UINT16 ausHotChannelData[ 2 ]; |
| 88 |
|
| 89 |
/* Last PCM sample index. */ |
| 90 |
UINT32 ulLastPcmSampleIndex; |
| 91 |
|
| 92 |
/* Last AF log read pointer. */ |
| 93 |
UINT16 usLastAfLogReadPtr; |
| 94 |
|
| 95 |
/* AF log hardware write pointer. */ |
| 96 |
UINT16 usAfLogWritePtr; |
| 97 |
|
| 98 |
/* Last tone event index retrieved. */ |
| 99 |
UINT16 usLastToneEventIndex; |
| 100 |
|
| 101 |
/* Whether the image version string has been copied in the user buffer. */ |
| 102 |
BOOL fImageVersionCopied; |
| 103 |
|
| 104 |
/* Whether the api version string has been copied in the user buffer. */ |
| 105 |
BOOL fApiVersionCopied; |
| 106 |
|
| 107 |
/* Total number of bytes that will be returned for the current dump. */ |
| 108 |
UINT32 ulDebugDataTotalNumBytes; |
| 109 |
|
| 110 |
/* Field to detect if the ISR is called present? */ |
| 111 |
BOOL fIsIsrCalledField; |
| 112 |
|
| 113 |
/* Remaining number of bytes that will be returned for the current dump. */ |
| 114 |
UINT32 ulDebugDataRemainingNumBytes; |
| 115 |
|
| 116 |
/* AF events control block size. */ |
| 117 |
UINT32 ulAfEventCbByteSize; |
| 118 |
|
| 119 |
/* Current user selected data mode. Must be kept constant throughout a debug session. */ |
| 120 |
UINT32 ulCurrentGetDataMode; |
| 121 |
|
| 122 |
} tOCT6100_API_DEBUG, *tPOCT6100_API_DEBUG; |
| 123 |
|
| 124 |
#endif /* __OCT6100_DEBUG_INST_H__ */ |