| 1 |
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\ |
| 2 |
|
| 3 |
File: oct6100_conf_bridge_priv.h |
| 4 |
|
| 5 |
Copyright (c) 2001-2007 Octasic Inc. |
| 6 |
|
| 7 |
Description: |
| 8 |
|
| 9 |
File containing all private defines, macros, structures and prototypes |
| 10 |
pertaining to the file oct6100_conf_bridge.c. All elements defined in this |
| 11 |
file are for private usage of the API. All public elements are defined |
| 12 |
in the oct6100_conf_bridge_pub.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: 30 $ |
| 31 |
|
| 32 |
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/ |
| 33 |
|
| 34 |
#ifndef __OCT6100_CONF_BRIDGE_PRIV_H__ |
| 35 |
#define __OCT6100_CONF_BRIDGE_PRIV_H__ |
| 36 |
|
| 37 |
/***************************** INCLUDE FILES *******************************/ |
| 38 |
|
| 39 |
|
| 40 |
/***************************** DEFINES *************************************/ |
| 41 |
|
| 42 |
#define mOCT6100_GET_CONF_BRIDGE_LIST_PNT( pSharedInfo, pList ) \ |
| 43 |
pList = ( tPOCT6100_API_CONF_BRIDGE )(( PUINT8 )pSharedInfo + pSharedInfo->ulConfBridgeListOfst); |
| 44 |
|
| 45 |
#define mOCT6100_GET_CONF_BRIDGE_ENTRY_PNT( pSharedInfo, pEntry, ulIndex ) \ |
| 46 |
pEntry = (( tPOCT6100_API_CONF_BRIDGE )(( PUINT8 )pSharedInfo + pSharedInfo->ulConfBridgeListOfst)) + ulIndex; |
| 47 |
|
| 48 |
#define mOCT6100_GET_CONF_BRIDGE_ALLOC_PNT( pSharedInfo, pAlloc ) \ |
| 49 |
pAlloc = ( PVOID )(( PUINT8 )pSharedInfo + pSharedInfo->ulConfBridgeAllocOfst); |
| 50 |
|
| 51 |
#define mOCT6100_GET_FLEX_CONF_PARTICIPANT_LIST_PNT( pSharedInfo, pList ) \ |
| 52 |
pList = ( tPOCT6100_API_FLEX_CONF_PARTICIPANT )(( PUINT8 )pSharedInfo + pSharedInfo->ulFlexConfParticipantListOfst); |
| 53 |
|
| 54 |
#define mOCT6100_GET_FLEX_CONF_PARTICIPANT_ENTRY_PNT( pSharedInfo, pEntry, ulIndex ) \ |
| 55 |
pEntry = (( tPOCT6100_API_FLEX_CONF_PARTICIPANT )(( PUINT8 )pSharedInfo + pSharedInfo->ulFlexConfParticipantListOfst)) + ulIndex; |
| 56 |
|
| 57 |
#define mOCT6100_GET_FLEX_CONF_PARTICIPANT_ALLOC_PNT( pSharedInfo, pAlloc ) \ |
| 58 |
pAlloc = ( PVOID )(( PUINT8 )pSharedInfo + pSharedInfo->ulFlexConfParticipantAllocOfst); |
| 59 |
|
| 60 |
|
| 61 |
/***************************** TYPES ***************************************/ |
| 62 |
|
| 63 |
|
| 64 |
/************************** FUNCTION PROTOTYPES *****************************/ |
| 65 |
|
| 66 |
UINT32 Oct6100ApiGetConfBridgeSwSizes( |
| 67 |
IN OUT tPOCT6100_CHIP_OPEN f_pOpenChip, |
| 68 |
OUT tPOCT6100_API_INSTANCE_SIZES f_pInstSizes ); |
| 69 |
|
| 70 |
UINT32 Oct6100ApiConfBridgeSwInit( |
| 71 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst ); |
| 72 |
|
| 73 |
UINT32 Oct6100ConfBridgeOpenSer( |
| 74 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 75 |
IN OUT tPOCT6100_CONF_BRIDGE_OPEN f_pConfBridgeOpen ); |
| 76 |
|
| 77 |
UINT32 Oct6100ApiCheckBridgeParams( |
| 78 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 79 |
IN OUT tPOCT6100_CONF_BRIDGE_OPEN f_pConfBridgeOpen ); |
| 80 |
|
| 81 |
UINT32 Oct6100ApiReserveBridgeResources( |
| 82 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 83 |
OUT PUINT16 f_pusBridgeIndex ); |
| 84 |
|
| 85 |
UINT32 Oct6100ApiUpdateBridgeEntry( |
| 86 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 87 |
IN tPOCT6100_CONF_BRIDGE_OPEN f_pConfBridgeOpen, |
| 88 |
IN UINT16 f_usBridgeIndex ); |
| 89 |
|
| 90 |
UINT32 Oct6100ConfBridgeCloseSer( |
| 91 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 92 |
IN tPOCT6100_CONF_BRIDGE_CLOSE f_pConfBridgeClose ); |
| 93 |
|
| 94 |
UINT32 Oct6100ApiAssertBridgeParams( |
| 95 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 96 |
IN tPOCT6100_CONF_BRIDGE_CLOSE f_pConfBridgeClose, |
| 97 |
OUT PUINT16 f_pusBridgeIndex ); |
| 98 |
|
| 99 |
UINT32 Oct6100ApiReleaseBridgeResources( |
| 100 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 101 |
IN UINT16 f_usBridgeIndex ); |
| 102 |
|
| 103 |
UINT32 Oct6100ConfBridgeChanAddSer( |
| 104 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 105 |
IN tPOCT6100_CONF_BRIDGE_CHAN_ADD f_pConfBridgeAdd ); |
| 106 |
|
| 107 |
UINT32 Oct6100ApiCheckBridgeAddParams( |
| 108 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 109 |
IN tPOCT6100_CONF_BRIDGE_CHAN_ADD f_pConfBridgeAdd, |
| 110 |
OUT PUINT16 f_pusBridgeIndex, |
| 111 |
OUT PUINT16 f_pusChannelIndex, |
| 112 |
OUT PUINT8 f_pfMute, |
| 113 |
OUT PUINT32 f_pulInputPort, |
| 114 |
OUT PUINT8 f_pfFlexibleConfBridge, |
| 115 |
OUT PUINT32 f_pulListenerMaskIndex, |
| 116 |
OUT PUINT32 f_pulListenerMask, |
| 117 |
OUT PUINT8 f_pfTap, |
| 118 |
OUT PUINT16 f_pusTapChannelIndex ); |
| 119 |
|
| 120 |
UINT32 Oct6100ApiReserveBridgeAddResources( |
| 121 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 122 |
IN UINT16 f_usBridgeIndex, |
| 123 |
IN UINT16 f_usChanIndex, |
| 124 |
IN UINT32 f_ulInputPort, |
| 125 |
IN UINT8 f_fFlexibleConfBridge, |
| 126 |
IN UINT32 f_ulListenerMaskIndex, |
| 127 |
IN UINT32 f_ulListenerMask, |
| 128 |
IN UINT8 f_fTap, |
| 129 |
OUT PUINT16 f_pusLoadEventIndex, |
| 130 |
OUT PUINT16 f_pusSubStoreEventIndex, |
| 131 |
OUT PUINT16 f_pusCopyEventIndex, |
| 132 |
OUT PUINT16 f_pusTapBridgeIndex ); |
| 133 |
|
| 134 |
UINT32 Oct6100ApiBridgeEventAdd( |
| 135 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 136 |
IN UINT16 f_usBridgeIndex, |
| 137 |
IN UINT16 f_usChannelIndex, |
| 138 |
IN UINT8 f_fFlexibleConfBridge, |
| 139 |
IN UINT16 f_usLoadEventIndex, |
| 140 |
IN UINT16 f_usSubStoreEventIndex, |
| 141 |
IN UINT16 f_usCopyEventIndex, |
| 142 |
IN UINT32 f_ulInputPort, |
| 143 |
IN UINT8 f_fMute, |
| 144 |
IN UINT32 f_ulListenerMaskIndex, |
| 145 |
IN UINT32 f_ulListenerMask, |
| 146 |
IN UINT8 f_fTap, |
| 147 |
IN UINT16 f_usTapBridgeIndex, |
| 148 |
IN UINT16 f_usTapChanIndex ); |
| 149 |
|
| 150 |
UINT32 Oct6100ApiBridgeAddParticipantToChannel( |
| 151 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 152 |
IN UINT16 f_usBridgeIndex, |
| 153 |
IN UINT16 f_usSourceChannelIndex, |
| 154 |
IN UINT16 f_usDestinationChannelIndex, |
| 155 |
IN UINT16 f_usLoadOrAccumulateEventIndex, |
| 156 |
IN UINT16 f_usStoreEventIndex, |
| 157 |
IN UINT16 f_usCopyEventIndex, |
| 158 |
IN UINT32 f_ulSourceInputPort, |
| 159 |
IN UINT32 f_ulDestinationInputPort ); |
| 160 |
|
| 161 |
UINT32 Oct6100ConfBridgeChanRemoveSer( |
| 162 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 163 |
IN tPOCT6100_CONF_BRIDGE_CHAN_REMOVE f_pConfBridgeRemove ); |
| 164 |
|
| 165 |
UINT32 Oct6100ApiCheckChanRemoveParams( |
| 166 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 167 |
IN tPOCT6100_CONF_BRIDGE_CHAN_REMOVE f_pConfBridgeRemove, |
| 168 |
OUT PUINT16 f_pusBridgeIndex, |
| 169 |
OUT PUINT16 f_pusChannelIndex, |
| 170 |
OUT PUINT8 f_pfFlexibleConfBridge, |
| 171 |
OUT PUINT8 f_pfTap, |
| 172 |
OUT PUINT16 f_pusLoadEventIndex, |
| 173 |
OUT PUINT16 f_pusSubStoreEventIndex, |
| 174 |
OUT PUINT16 f_pusCopyEventIndex ); |
| 175 |
|
| 176 |
UINT32 Oct6100ApiReleaseChanEventResources( |
| 177 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 178 |
IN tPOCT6100_CONF_BRIDGE_CHAN_REMOVE f_pConfBridgeRemove, |
| 179 |
IN UINT16 f_usBridgeIndex, |
| 180 |
IN UINT16 f_usChanIndex, |
| 181 |
IN UINT8 f_fFlexibleConfBridge, |
| 182 |
IN UINT16 f_usLoadEventIndex, |
| 183 |
IN UINT16 f_usSubStoreEventIndex, |
| 184 |
IN UINT16 f_usCopyEventIndex ); |
| 185 |
|
| 186 |
UINT32 Oct6100ApiBridgeEventRemove ( |
| 187 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 188 |
IN tPOCT6100_CONF_BRIDGE_CHAN_REMOVE f_pConfBridgeRemove, |
| 189 |
IN UINT16 f_usBridgeIndex, |
| 190 |
IN UINT16 f_usChannelIndex, |
| 191 |
IN UINT8 f_fFlexibleConfBridge, |
| 192 |
IN UINT16 f_usLoadEventIndex, |
| 193 |
IN UINT16 f_usSubStoreEventIndex, |
| 194 |
IN UINT16 f_usCopyEventIndex, |
| 195 |
IN UINT8 f_fTap ); |
| 196 |
|
| 197 |
UINT32 Oct6100ApiBridgeRemoveParticipantFromChannel( |
| 198 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 199 |
IN UINT16 f_usBridgeIndex, |
| 200 |
IN UINT16 f_usSourceChannelIndex, |
| 201 |
IN UINT16 f_usDestinationChannelIndex, |
| 202 |
IN UINT8 f_fRemovePermanently ); |
| 203 |
|
| 204 |
UINT32 Oct6100ConfBridgeChanMuteSer( |
| 205 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 206 |
IN tPOCT6100_CONF_BRIDGE_CHAN_MUTE f_pConfBridgeMute ); |
| 207 |
|
| 208 |
UINT32 Oct6100ApiUpdateBridgeMuteResources( |
| 209 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 210 |
IN UINT16 f_usChanIndex, |
| 211 |
IN UINT16 f_usLoadEventIndex, |
| 212 |
IN UINT16 f_usSubStoreEventIndex, |
| 213 |
IN UINT8 f_fFlexibleConfBridge ); |
| 214 |
|
| 215 |
UINT32 Oct6100ApiCheckBridgeMuteParams( |
| 216 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 217 |
IN tPOCT6100_CONF_BRIDGE_CHAN_MUTE f_pConfBridgeMute, |
| 218 |
OUT PUINT16 f_pusChannelIndex, |
| 219 |
OUT PUINT16 f_pusLoadEventIndex, |
| 220 |
OUT PUINT16 f_pusSubStoreEventIndex, |
| 221 |
OUT PUINT8 f_pfFlexibleConfBridge ); |
| 222 |
|
| 223 |
UINT32 Oct6100ConfBridgeChanUnMuteSer( |
| 224 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 225 |
IN tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE f_pConfBridgeUnMute ); |
| 226 |
|
| 227 |
UINT32 Oct6100ApiCheckBridgeUnMuteParams( |
| 228 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 229 |
IN tPOCT6100_CONF_BRIDGE_CHAN_UNMUTE f_pConfBridgeUnMute, |
| 230 |
OUT PUINT16 f_pusChannelIndex, |
| 231 |
OUT PUINT16 f_pusLoadEventIndex, |
| 232 |
OUT PUINT16 f_pusSubStoreEventIndex, |
| 233 |
OUT PUINT8 f_pfFlexibleConfBridge ); |
| 234 |
|
| 235 |
UINT32 Oct6100ApiUpdateBridgeUnMuteResources( |
| 236 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 237 |
IN UINT16 f_usChanIndex, |
| 238 |
IN UINT16 f_usLoadEventIndex, |
| 239 |
IN UINT16 f_usSubStoreEventIndex, |
| 240 |
IN UINT8 f_fFlexibleConfBridge ); |
| 241 |
|
| 242 |
UINT32 Oct6100ConfBridgeDominantSpeakerSetSer( |
| 243 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 244 |
IN tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET f_pConfBridgeDominantSpeaker ); |
| 245 |
|
| 246 |
UINT32 Oct6100ApiCheckBridgeDominantSpeakerParams( |
| 247 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 248 |
IN tPOCT6100_CONF_BRIDGE_DOMINANT_SPEAKER_SET f_pConfBridgeDominantSpeaker, |
| 249 |
OUT PUINT16 f_pusChannelIndex, |
| 250 |
OUT PUINT16 f_pusBridgeIndex ); |
| 251 |
|
| 252 |
UINT32 Oct6100ApiUpdateBridgeDominantSpeakerResources( |
| 253 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 254 |
IN UINT16 f_usChanIndex, |
| 255 |
IN UINT16 f_usBridgeIndex ); |
| 256 |
|
| 257 |
UINT32 Oct6100ConfBridgeMaskChangeSer( |
| 258 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 259 |
IN tPOCT6100_CONF_BRIDGE_MASK_CHANGE f_pConfBridgeMaskChange ); |
| 260 |
|
| 261 |
UINT32 Oct6100ApiCheckBridgeMaskChangeParams( |
| 262 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 263 |
IN tPOCT6100_CONF_BRIDGE_MASK_CHANGE f_pConfBridgeMaskChange, |
| 264 |
OUT PUINT16 f_pusChannelIndex, |
| 265 |
OUT PUINT16 f_pusBridgeIndex, |
| 266 |
OUT PUINT32 f_pulNewParticipantMask ); |
| 267 |
|
| 268 |
UINT32 Oct6100ApiUpdateMaskModifyResources( |
| 269 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 270 |
IN UINT16 f_usBridgeIndex, |
| 271 |
IN UINT16 f_usChanIndex, |
| 272 |
IN UINT32 f_ulNewListenerMask ); |
| 273 |
|
| 274 |
UINT32 Oct6100ApiBridgeUpdateMask( |
| 275 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 276 |
IN UINT16 f_usBridgeIndex, |
| 277 |
IN UINT16 f_usChanIndex, |
| 278 |
IN UINT32 f_ulNewListenerMask ); |
| 279 |
|
| 280 |
UINT32 Oct6100ConfBridgeGetStatsSer( |
| 281 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 282 |
IN OUT tPOCT6100_CONF_BRIDGE_STATS f_pConfBridgeStats ); |
| 283 |
|
| 284 |
UINT32 Oct6100ApiReserveBridgeEntry( |
| 285 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 286 |
OUT PUINT16 f_pusConfBridgeIndex ); |
| 287 |
|
| 288 |
UINT32 Oct6100ApiReleaseBridgeEntry( |
| 289 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 290 |
IN UINT16 f_usConfBridgeIndex ); |
| 291 |
|
| 292 |
UINT32 Oct6100ApiGetPrevLastSubStoreEvent( |
| 293 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 294 |
IN UINT16 f_usBridgeIndex, |
| 295 |
IN UINT16 f_usBridgeFirstLoadEventPtr, |
| 296 |
OUT PUINT16 f_pusLastSubStoreEventIndex ); |
| 297 |
|
| 298 |
UINT32 Oct6100ApiGetPreviousEvent( |
| 299 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 300 |
IN UINT16 f_usStartIndex, |
| 301 |
IN UINT16 f_usSearchedIndex, |
| 302 |
IN UINT16 f_usLoopCnt, |
| 303 |
OUT PUINT16 f_pusPreviousIndex ); |
| 304 |
|
| 305 |
UINT32 Oct6100ApiBridgeSetDominantSpeaker( |
| 306 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 307 |
IN UINT16 f_usChannelIndex, |
| 308 |
IN UINT16 f_usDominantSpeakerIndex ); |
| 309 |
|
| 310 |
UINT32 Oct6100ApiReserveFlexConfParticipantEntry( |
| 311 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 312 |
OUT PUINT16 f_pusParticipantIndex ); |
| 313 |
|
| 314 |
UINT32 Oct6100ApiReleaseFlexConfParticipantEntry( |
| 315 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInst, |
| 316 |
IN UINT16 f_usParticipantIndex ); |
| 317 |
|
| 318 |
#endif /* __OCT6100_CONF_BRIDGE_PRIV_H__ */ |