Debian Codegraph @

xpp/oct612x/include/oct6100api/oct6100_interrupts_pub.h

raw
1 /*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*\
2
3 File: oct6100_interrupts_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_interrupts.c. All elements defined in this file are for public
11 usage of the API. All private elements are defined in the
12 oct6100_interrupts_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: 23 $
31
32 \*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*/
33
34 #ifndef __OCT6100_INTERRUPTS_PUB_H__
35 #define __OCT6100_INTERRUPTS_PUB_H__
36
37 /***************************** INCLUDE FILES *******************************/
38
39
40 /***************************** DEFINES *************************************/
41
42
43 /***************************** TYPES ***************************************/
44
45 typedef struct _OCT6100_INTERRUPT_CONFIGURE_
46 {
47 UINT32 ulFatalGeneralConfig;
48 UINT32 ulFatalMemoryConfig;
49
50 UINT32 ulErrorMemoryConfig;
51 UINT32 ulErrorOverflowToneEventsConfig;
52 UINT32 ulErrorH100Config;
53
54 UINT32 ulFatalMemoryTimeout;
55 UINT32 ulErrorMemoryTimeout;
56 UINT32 ulErrorOverflowToneEventsTimeout;
57 UINT32 ulErrorH100Timeout;
58
59 } tOCT6100_INTERRUPT_CONFIGURE, *tPOCT6100_INTERRUPT_CONFIGURE;
60
61 typedef struct _OCT6100_INTERRUPT_FLAGS_
62 {
63 BOOL fFatalGeneral;
64 UINT32 ulFatalGeneralFlags;
65
66 BOOL fFatalReadTimeout;
67
68 BOOL fErrorRefreshTooLate;
69 BOOL fErrorPllJitter;
70
71 BOOL fErrorOverflowToneEvents;
72
73 BOOL fErrorH100OutOfSync;
74 BOOL fErrorH100ClkA;
75 BOOL fErrorH100ClkB;
76 BOOL fErrorH100FrameA;
77
78 BOOL fToneEventsPending;
79 BOOL fBufferPlayoutEventsPending;
80
81 BOOL fApiSynch;
82
83
84
85 } tOCT6100_INTERRUPT_FLAGS, *tPOCT6100_INTERRUPT_FLAGS;
86
87 /************************** FUNCTION PROTOTYPES *****************************/
88
89 UINT32 Oct6100InterruptConfigureDef(
90 OUT tPOCT6100_INTERRUPT_CONFIGURE f_pConfigInts );
91 UINT32 Oct6100InterruptConfigure(
92 IN tPOCT6100_INSTANCE_API f_pApiInst,
93 IN OUT tPOCT6100_INTERRUPT_CONFIGURE f_pConfigInts );
94
95 UINT32 Oct6100InterruptServiceRoutineDef(
96 OUT tPOCT6100_INTERRUPT_FLAGS f_pIntFlags );
97 UINT32 Oct6100InterruptServiceRoutine(
98 IN tPOCT6100_INSTANCE_API f_pApiInst,
99 IN OUT tPOCT6100_INTERRUPT_FLAGS f_pIntFlags );
100
101 #endif /* __OCT6100_INTERRUPTS_PUB_H__ */
102