Debian Codegraph @

xpp/oct612x/octdeviceapi/oct6100api/oct6100_tone_detection_priv.h

raw
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: oct6100_tone_detection_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_tone_detection.c. All elements defined in
11 this file are for private usage of the API. All public elements are
12 defined in the oct6100_tone_detection_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_TONE_DETECTION_PRIV_H__
35 #define __OCT6100_TONE_DETECTION_PRIV_H__
36
37 /***************************** INCLUDE FILES *******************************/
38
39
40 /***************************** DEFINES *************************************/
41
42
43 /***************************** TYPES ***************************************/
44
45
46 /************************** FUNCTION PROTOTYPES *****************************/
47
48 UINT32 Oct6100ToneDetectionEnableSer(
49 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
50 IN tPOCT6100_TONE_DETECTION_ENABLE f_pToneDetectEnable );
51
52 UINT32 Oct6100ApiCheckToneEnableParams(
53 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
54 IN tPOCT6100_TONE_DETECTION_ENABLE f_pToneDetectEnable,
55 OUT PUINT32 f_pulChannelIndex,
56 OUT PUINT32 f_pulToneEventNumber,
57
58 OUT PUINT32 f_pulExtToneChanIndex );
59
60 UINT32 Oct6100ApiWriteToneDetectEvent(
61 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
62 IN UINT32 f_ulChannelIndex,
63 IN UINT32 f_ulToneEventNumber,
64
65 IN UINT32 f_ulExtToneChanIndex );
66
67 UINT32 Oct6100ApiUpdateChanToneDetectEntry (
68 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
69 IN UINT32 f_ulChannelIndex,
70 IN UINT32 f_ulToneEventNumber,
71 IN UINT32 f_ulExtToneChanIndex );
72
73 UINT32 Oct6100ToneDetectionDisableSer(
74 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
75 IN OUT tPOCT6100_TONE_DETECTION_DISABLE f_pToneDetectDisable );
76
77 UINT32 Oct6100ApiAssertToneDetectionParams(
78 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
79 IN tPOCT6100_TONE_DETECTION_DISABLE f_pToneDetectDisable,
80 OUT PUINT32 f_pulChannelIndex,
81 OUT PUINT32 f_pulToneEventNumber,
82 OUT PUINT32 f_pulExtToneChanIndex,
83
84 OUT PBOOL f_pfDisableAll );
85
86 UINT32 Oct6100ApiClearToneDetectionEvent(
87 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
88 IN UINT32 f_ulChannelIndex,
89 IN UINT32 f_ulToneEventNumber,
90 IN UINT32 f_ulExtToneChanIndex,
91
92 IN BOOL f_fDisableAll );
93
94 UINT32 Oct6100ApiReleaseToneDetectionEvent(
95 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
96 IN UINT32 f_ulChannelIndex,
97 IN UINT32 f_ulToneEventNumber,
98 IN UINT32 f_ulExtToneChanIndex,
99 IN BOOL f_fDisableAll );
100
101 UINT32 Oct6100ApiIsSSTone(
102 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
103 IN UINT32 f_ulToneEventNumber,
104 OUT PBOOL f_fSSTone );
105
106 UINT32 Oct6100ApiIs2100Tone(
107 IN OUT tPOCT6100_INSTANCE_API f_pApiInstance,
108 IN UINT32 f_ulToneEventNumber,
109 OUT PBOOL f_fIs2100Tone );
110
111 #endif /* __OCT6100_TONE_DETECTION_PRIV_H__ */