| 1 |
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\ |
| 2 |
|
| 3 |
File: oct6100_chip_open_pub.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_chip_open.c. All elements defined in this file are for public |
| 11 |
usage of the API. All private elements are defined in the |
| 12 |
oct6100_chip_open_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: 54 $ |
| 31 |
|
| 32 |
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/ |
| 33 |
|
| 34 |
#ifndef __OCT6100_CHIP_OPEN_PUB_H__ |
| 35 |
#define __OCT6100_CHIP_OPEN_PUB_H__ |
| 36 |
|
| 37 |
/***************************** INCLUDE FILES *******************************/ |
| 38 |
|
| 39 |
|
| 40 |
/***************************** DEFINES *************************************/ |
| 41 |
|
| 42 |
|
| 43 |
/***************************** TYPES ***************************************/ |
| 44 |
|
| 45 |
typedef struct _OCT6100_CHIP_OPEN_ |
| 46 |
{ |
| 47 |
UINT32 ulUserChipId; |
| 48 |
BOOL fMultiProcessSystem; |
| 49 |
PVOID pProcessContext; |
| 50 |
|
| 51 |
UINT32 ulMaxRwAccesses; |
| 52 |
|
| 53 |
unsigned char const *pbyImageFile; /* Byte pointer to the image file to be uploaded into the chip. */ |
| 54 |
UINT32 ulImageSize; /* Size of the image file (in bytes). */ |
| 55 |
|
| 56 |
UINT32 ulMemClkFreq; /* 10 - 133.3 MHz. */ |
| 57 |
UINT32 ulUpclkFreq; /* 1 - 66.6 MHz. */ |
| 58 |
BOOL fEnableMemClkOut; |
| 59 |
|
| 60 |
UINT32 ulMemoryType; /* SDRAM or DDR type external memory. */ |
| 61 |
UINT32 ulNumMemoryChips; /* Number of memory chips present. */ |
| 62 |
UINT32 ulMemoryChipSize; /* The size of the memory chips. */ |
| 63 |
|
| 64 |
UINT32 ulTailDisplacement; /* Tail displacement supported by the chip. */ |
| 65 |
|
| 66 |
BOOL fEnableAcousticEcho;/* Acoustic echo cancellation enabled. */ |
| 67 |
|
| 68 |
/* Resource allocation parameters. */ |
| 69 |
UINT32 ulMaxChannels; |
| 70 |
UINT32 ulMaxTsiCncts; |
| 71 |
UINT32 ulMaxBiDirChannels; |
| 72 |
UINT32 ulMaxConfBridges; |
| 73 |
UINT32 ulMaxFlexibleConfParticipants; |
| 74 |
UINT32 ulMaxPlayoutBuffers; |
| 75 |
|
| 76 |
|
| 77 |
UINT32 ulMaxPhasingTssts; |
| 78 |
UINT32 ulMaxAdpcmChannels; |
| 79 |
BOOL fUseSynchTimestamp; |
| 80 |
UINT32 aulTimestampTimeslots[ 4 ]; |
| 81 |
UINT32 aulTimestampStreams[ 4 ]; |
| 82 |
UINT32 ulInterruptPolarity; |
| 83 |
tOCT6100_INTERRUPT_CONFIGURE InterruptConfig; |
| 84 |
|
| 85 |
UINT32 aulTdmStreamFreqs[ cOCT6100_TDM_STREAM_MAX_GROUPS ]; |
| 86 |
UINT32 ulMaxTdmStreams; |
| 87 |
UINT32 ulTdmSampling; |
| 88 |
|
| 89 |
BOOL fEnableFastH100Mode; |
| 90 |
|
| 91 |
UINT32 ulSoftToneEventsBufSize; /* In events. */ |
| 92 |
BOOL fEnableExtToneDetection; |
| 93 |
BOOL fEnable2100StopEvent; |
| 94 |
|
| 95 |
|
| 96 |
UINT32 ulSoftBufferPlayoutEventsBufSize; /* In events. */ |
| 97 |
UINT32 ulMaxRemoteDebugSessions; |
| 98 |
|
| 99 |
BOOL fEnableChannelRecording; |
| 100 |
|
| 101 |
BOOL fEnableProductionBist; |
| 102 |
UINT32 ulProductionBistMode; |
| 103 |
UINT32 ulNumProductionBistLoops; |
| 104 |
|
| 105 |
} tOCT6100_CHIP_OPEN, *tPOCT6100_CHIP_OPEN; |
| 106 |
|
| 107 |
typedef struct _OCT6100_GET_INSTANCE_SIZE_ |
| 108 |
{ |
| 109 |
UINT32 ulApiInstanceSize; |
| 110 |
|
| 111 |
} tOCT6100_GET_INSTANCE_SIZE, *tPOCT6100_GET_INSTANCE_SIZE; |
| 112 |
|
| 113 |
typedef struct _OCT6100_CHIP_CLOSE_ |
| 114 |
{ |
| 115 |
UINT32 ulDummyVariable; |
| 116 |
|
| 117 |
} tOCT6100_CHIP_CLOSE, *tPOCT6100_CHIP_CLOSE; |
| 118 |
|
| 119 |
typedef struct _OCT6100_CREATE_LOCAL_INSTANCE_ |
| 120 |
{ |
| 121 |
tPOCT6100_INSTANCE_API pApiInstShared; |
| 122 |
tPOCT6100_INSTANCE_API pApiInstLocal; |
| 123 |
PVOID pProcessContext; |
| 124 |
UINT32 ulUserChipId; |
| 125 |
|
| 126 |
} tOCT6100_CREATE_LOCAL_INSTANCE, *tPOCT6100_CREATE_LOCAL_INSTANCE; |
| 127 |
|
| 128 |
typedef struct _OCT6100_DESTROY_LOCAL_INSTANCE_ |
| 129 |
{ |
| 130 |
UINT32 ulDummy; |
| 131 |
|
| 132 |
} tOCT6100_DESTROY_LOCAL_INSTANCE, *tPOCT6100_DESTROY_LOCAL_INSTANCE; |
| 133 |
|
| 134 |
typedef struct _OCT6100_GET_HW_REVISION_ |
| 135 |
{ |
| 136 |
UINT32 ulUserChipId; |
| 137 |
PVOID pProcessContext; |
| 138 |
UINT32 ulRevisionNum; |
| 139 |
|
| 140 |
} tOCT6100_GET_HW_REVISION, *tPOCT6100_GET_HW_REVISION; |
| 141 |
|
| 142 |
typedef struct _OCT6100_FREE_RESOURCES_ |
| 143 |
{ |
| 144 |
BOOL fFreeTsiConnections; |
| 145 |
BOOL fFreeConferenceBridges; |
| 146 |
BOOL fFreePlayoutBuffers; |
| 147 |
BOOL fFreePhasingTssts; |
| 148 |
BOOL fFreeAdpcmChannels; |
| 149 |
|
| 150 |
} tOCT6100_FREE_RESOURCES, *tPOCT6100_FREE_RESOURCES; |
| 151 |
|
| 152 |
typedef struct _OCT6100_PRODUCTION_BIST_ |
| 153 |
{ |
| 154 |
UINT32 ulCurrentAddress; |
| 155 |
UINT32 ulCurrentLoop; |
| 156 |
UINT32 ulCurrentTest; |
| 157 |
UINT32 ulBistStatus; |
| 158 |
UINT32 ulFailedAddress; |
| 159 |
UINT32 ulReadValue; |
| 160 |
UINT32 ulExpectedValue; |
| 161 |
|
| 162 |
} tOCT6100_PRODUCTION_BIST, *tPOCT6100_PRODUCTION_BIST; |
| 163 |
|
| 164 |
typedef struct _OCT6100_API_GET_VERSION_ |
| 165 |
{ |
| 166 |
UINT8 achApiVersion[ cOCT6100_API_VERSION_STRING_LENGTH ]; |
| 167 |
|
| 168 |
} tOCT6100_API_GET_VERSION, *tPOCT6100_API_GET_VERSION; |
| 169 |
|
| 170 |
typedef struct _OCT6100_API_GET_CAPACITY_PINS_ |
| 171 |
{ |
| 172 |
UINT32 ulUserChipId; |
| 173 |
PVOID pProcessContext; |
| 174 |
UINT32 ulMemoryType; /* SDRAM or DDR type external memory. */ |
| 175 |
BOOL fEnableMemClkOut; |
| 176 |
UINT32 ulMemClkFreq; |
| 177 |
UINT32 ulCapacityValue; |
| 178 |
} tOCT6100_API_GET_CAPACITY_PINS, *tPOCT6100_API_GET_CAPACITY_PINS; |
| 179 |
|
| 180 |
/************************** FUNCTION PROTOTYPES *****************************/ |
| 181 |
|
| 182 |
UINT32 Oct6100ChipOpenDef( |
| 183 |
OUT tPOCT6100_CHIP_OPEN f_pChipOpen ); |
| 184 |
UINT32 Oct6100ChipOpen( |
| 185 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 186 |
IN OUT tPOCT6100_CHIP_OPEN f_pChipOpen ); |
| 187 |
|
| 188 |
UINT32 Oct6100ChipCloseDef( |
| 189 |
OUT tPOCT6100_CHIP_CLOSE f_pChipClose ); |
| 190 |
UINT32 Oct6100ChipClose( |
| 191 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 192 |
IN OUT tPOCT6100_CHIP_CLOSE f_pChipClose ); |
| 193 |
|
| 194 |
UINT32 Oct6100GetInstanceSizeDef( |
| 195 |
OUT tPOCT6100_GET_INSTANCE_SIZE f_pInstanceSize ); |
| 196 |
UINT32 Oct6100GetInstanceSize( |
| 197 |
IN OUT tPOCT6100_CHIP_OPEN f_pChipOpen, |
| 198 |
IN OUT tPOCT6100_GET_INSTANCE_SIZE f_pInstanceSize ); |
| 199 |
|
| 200 |
UINT32 Oct6100CreateLocalInstanceDef( |
| 201 |
OUT tPOCT6100_CREATE_LOCAL_INSTANCE f_pCreateLocal ); |
| 202 |
UINT32 Oct6100CreateLocalInstance( |
| 203 |
IN OUT tPOCT6100_CREATE_LOCAL_INSTANCE f_pCreateLocal ); |
| 204 |
|
| 205 |
UINT32 Oct6100DestroyLocalInstanceDef( |
| 206 |
OUT tPOCT6100_DESTROY_LOCAL_INSTANCE f_pDestroyLocal ); |
| 207 |
UINT32 Oct6100DestroyLocalInstance( |
| 208 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 209 |
IN OUT tPOCT6100_DESTROY_LOCAL_INSTANCE f_pDestroyLocal ); |
| 210 |
|
| 211 |
UINT32 Oct6100ApiGetVersionDef( |
| 212 |
OUT tPOCT6100_API_GET_VERSION f_pApiGetVersion ); |
| 213 |
UINT32 Oct6100ApiGetVersion( |
| 214 |
IN OUT tPOCT6100_API_GET_VERSION f_pApiGetVersion ); |
| 215 |
|
| 216 |
UINT32 Oct6100GetHwRevisionDef( |
| 217 |
OUT tPOCT6100_GET_HW_REVISION f_pRevision ); |
| 218 |
UINT32 Oct6100GetHwRevision( |
| 219 |
IN OUT tPOCT6100_GET_HW_REVISION f_pRevision ); |
| 220 |
|
| 221 |
UINT32 Oct6100FreeResourcesDef( |
| 222 |
OUT tPOCT6100_FREE_RESOURCES f_pFreeResources ); |
| 223 |
UINT32 Oct6100FreeResources( |
| 224 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 225 |
IN OUT tPOCT6100_FREE_RESOURCES f_pFreeResources ); |
| 226 |
|
| 227 |
UINT32 Oct6100ProductionBistDef( |
| 228 |
OUT tPOCT6100_PRODUCTION_BIST f_pProductionBist ); |
| 229 |
UINT32 Oct6100ProductionBist( |
| 230 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 231 |
IN OUT tPOCT6100_PRODUCTION_BIST f_pProductionBist ); |
| 232 |
|
| 233 |
UINT32 Oct6100ApiGetCapacityPinsDef( |
| 234 |
tPOCT6100_API_GET_CAPACITY_PINS f_pGetCapacityPins); |
| 235 |
|
| 236 |
UINT32 Oct6100ApiGetCapacityPins( |
| 237 |
tPOCT6100_API_GET_CAPACITY_PINS f_pGetCapacityPins ); |
| 238 |
|
| 239 |
|
| 240 |
#endif /* __OCT6100_CHIP_OPEN_PUB_H__ */ |
| 241 |
|