| 1 |
/*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\ |
| 2 |
|
| 3 |
File: oct6100_tsst_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_tsst.c. All elements defined in |
| 11 |
this file are for private usage of the API. |
| 12 |
|
| 13 |
This file is part of the Octasic OCT6100 GPL API . The OCT6100 GPL API is |
| 14 |
free software; you can redistribute it and/or modify it under the terms of |
| 15 |
the GNU General Public License as published by the Free Software Foundation; |
| 16 |
either version 2 of the License, or (at your option) any later version. |
| 17 |
|
| 18 |
The OCT6100 GPL API is distributed in the hope that it will be useful, but |
| 19 |
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY |
| 20 |
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 21 |
for more details. |
| 22 |
|
| 23 |
You should have received a copy of the GNU General Public License |
| 24 |
along with the OCT6100 GPL API; if not, write to the Free Software |
| 25 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 26 |
|
| 27 |
$Octasic_Release: OCT612xAPI-01.00-PR49 $ |
| 28 |
|
| 29 |
$Octasic_Revision: 14 $ |
| 30 |
|
| 31 |
\*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/ |
| 32 |
|
| 33 |
#ifndef __OCT6100_TSST_PRIV_H__ |
| 34 |
#define __OCT6100_TSST_PRIV_H__ |
| 35 |
|
| 36 |
/***************************** INCLUDE FILES *******************************/ |
| 37 |
|
| 38 |
|
| 39 |
/***************************** DEFINES *************************************/ |
| 40 |
|
| 41 |
/* TSST allocation and serialization pointer macros. */ |
| 42 |
#define mOCT6100_GET_TSST_ALLOC_PNT( pSharedInfo, pAlloc ) \ |
| 43 |
pAlloc = ( PUINT32 )(( PUINT8 )pSharedInfo + pSharedInfo->ulTsstAllocOfst); |
| 44 |
|
| 45 |
#define mOCT6100_GET_TSST_LIST_PNT( pSharedInfo, pList ) \ |
| 46 |
pList = ( tPOCT6100_API_TSST_ENTRY )(( PUINT8 )pSharedInfo + pSharedInfo->ulTsstListOfst ); |
| 47 |
|
| 48 |
#define mOCT6100_GET_TSST_LIST_ENTRY_PNT( pSharedInfo, pEntry, ulIndex ) \ |
| 49 |
pEntry = (( tPOCT6100_API_TSST_ENTRY )(( PUINT8 )pSharedInfo + pSharedInfo->ulTsstListOfst)) + ulIndex; |
| 50 |
|
| 51 |
#define mOCT6100_GET_TSST_LIST_ALLOC_PNT( pSharedInfo, pAlloc ) \ |
| 52 |
pAlloc = ( PVOID )(( PUINT8 )pSharedInfo + pSharedInfo->ulTsstListAllocOfst); |
| 53 |
|
| 54 |
/***************************** TYPES ***************************************/ |
| 55 |
|
| 56 |
|
| 57 |
/************************** FUNCTION PROTOTYPES *****************************/ |
| 58 |
|
| 59 |
UINT32 Oct6100ApiGetTsstSwSizes( |
| 60 |
OUT tPOCT6100_API_INSTANCE_SIZES f_pInstSizes ); |
| 61 |
|
| 62 |
UINT32 Oct6100ApiTsstSwInit( |
| 63 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance ); |
| 64 |
|
| 65 |
UINT32 Oct6100ApiValidateTsst( |
| 66 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 67 |
IN UINT32 f_ulNumTssts, |
| 68 |
IN UINT32 f_ulTimeslot, |
| 69 |
IN UINT32 f_ulStream, |
| 70 |
IN UINT32 f_ulDirection ); |
| 71 |
|
| 72 |
UINT32 Oct6100ApiReserveTsst( |
| 73 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 74 |
IN UINT32 f_ulTimeslot, |
| 75 |
IN UINT32 f_ulStream, |
| 76 |
IN UINT32 f_ulNumTsst, |
| 77 |
IN UINT32 f_ulDirection, |
| 78 |
OUT PUINT16 f_pusTsstMemIndex, |
| 79 |
OUT PUINT16 f_pusTsstListIndex ); |
| 80 |
|
| 81 |
UINT32 Oct6100ApiReleaseTsst( |
| 82 |
IN OUT tPOCT6100_INSTANCE_API f_pApiInstance, |
| 83 |
IN UINT32 f_ulTimeslot, |
| 84 |
IN UINT32 f_ulStream, |
| 85 |
IN UINT32 f_ulNumTsst, |
| 86 |
IN UINT32 f_ulDirection, |
| 87 |
IN UINT16 f_usTsstListIndex ); |
| 88 |
|
| 89 |
#endif /* __OCT6100_TSST_PRIV_H__ */ |