Debian Codegraph @

xpp/oct612x/octdeviceapi/oct6100api/oct6100_events_priv.h

raw
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: oct6100_events_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_events.c. All elements defined in this
11 file are for private usage of the API. All public elements are defined
12 in the oct6100_events_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: 14 $
31
32 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
33
34 #ifndef __OCT6100_EVENTS_PRIV_H__
35 #define __OCT6100_EVENTS_PRIV_H__
36
37 /***************************** INCLUDE FILES *******************************/
38
39
40 /***************************** DEFINES *************************************/
41
42 #define mOCT6100_GET_TONE_EVENT_BUF_PNT( pSharedInfo, pSoftBuf ) \
43 pSoftBuf = ( PVOID )(( PUINT8 )pSharedInfo + pSharedInfo->SoftBufs.ulToneEventBufferMemOfst );
44
45 #define mOCT6100_GET_BUFFER_PLAYOUT_EVENT_BUF_PNT( pSharedInfo, pSoftBuf ) \
46 pSoftBuf = ( PVOID )(( PUINT8 )pSharedInfo + pSharedInfo->SoftBufs.ulBufPlayoutEventBufferMemOfst );
47
48 /***************************** TYPES ***************************************/
49
50
51 /************************** FUNCTION PROTOTYPES *****************************/
52
53 UINT32 Oct6100ApiGetEventsSwSizes(
54 IN tPOCT6100_CHIP_OPEN f_pOpenChip,
55 OUT tPOCT6100_API_INSTANCE_SIZES f_pInstSizes );
56
57 UINT32 Oct6100EventGetToneSer(
58 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
59 IN OUT tPOCT6100_EVENT_GET_TONE f_pEventGetTone );
60
61 UINT32 Oct6100ApiTransferToneEvents(
62 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
63 IN UINT32 f_ulResetBuf );
64
65
66
67 UINT32 Oct6100BufferPlayoutGetEventSer(
68 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
69 IN OUT tPOCT6100_BUFFER_PLAYOUT_GET_EVENT f_pBufPlayoutGetEvent );
70
71 UINT32 Oct6100BufferPlayoutTransferEvents(
72 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
73 IN UINT32 f_ulResetBuf );
74
75 UINT32 Oct6100BufferPlayoutCheckForSpecificEvent(
76 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
77 IN UINT32 f_ulChannelIndex,
78 IN UINT32 f_ulChannelPort,
79 IN BOOL f_fSaveToSoftBuffer,
80 OUT PBOOL f_pfEventDetected );
81
82 #endif /* __OCT6100_EVENTS_PRIV_H__ */