source: svn/trunk/newcon3bcm2_21bu/BSEAV/lib/scte65/api/si_api_ea.h

Last change on this file was 2, checked in by jglee, 11 years ago

first commit
  • Property svn:executable set to *
File size: 4.1 KB
Line 
1/***************************************************************
2**
3** Broadcom Corp. Confidential
4** Copyright 2003-2008 Broadcom Corp. All Rights Reserved.
5**
6** THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED
7** SOFTWARE LICENSE AGREEMENT BETWEEN THE USER AND BROADCOM.
8** YOU HAVE NO RIGHT TO USE OR EXPLOIT THIS MATERIAL EXCEPT
9** SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
10**
11** File:                si_api_ea.h
12** Description: Interface functions for processing EA messages
13**
14** Created: 04/18/2001
15**
16** REVISION:
17**
18** $Log: $
19**
20**
21****************************************************************/
22#ifndef POD_API_EA_H
23#define POD_API_EA_H
24
25/*= Module Overview *********************************************************
26<verbatim>
27
28Overview
29This module defines the API functions between POD SW stack Host control entity
30and frontend drivers and applications.
31
32
33Design
34Currently we only provide the API function for tuning OOB receiver.
35
36
37Usage
38When OOB mode is used, the POD will instruct host to tune to the required OOB
39channel with a specific frequency and symbol rate.
40
41
42Interrupt Requirements
43None.
44
45
46Sample Code
47None.
48
49</verbatim>
50***************************************************************************/
51
52#ifdef __cplusplus
53extern "C" {
54#endif
55
56#define EA_TEST_MSG_PRIORITY                    0
57#define EA_LOW_PRIORITY                                 3
58#define EA_MEDIUM_PRIORITY                              7
59#define EA_HIGH_PRIORITY                                11
60#define EA_MAX_PRIORITY                                 15
61
62#define EA_MAX_LOCATION_CODE_COUNT              31
63
64typedef struct ea_location_code_struct
65{
66        unsigned char   state_code;
67        unsigned char   county_subdevision;
68        unsigned short  county_code;
69} EA_LOCATION_CODE;
70
71typedef struct ea_msg_info_struct
72{
73        /* Private information */
74        unsigned char   process:1;
75        unsigned char   in_progress:1;
76       
77        /* Info parsed from EA message */
78        unsigned short  eas_event_id;
79        char                    eas_originator_code[3];
80        char                    eas_event_code[10];                             /* NULL-terminated string */
81        char                    nature_of_act_text[100];                /* NULL-terminated string */
82        unsigned char   ea_alert_message_time_rem;
83        unsigned long   ea_event_start_time;
84        unsigned short  ea_event_duration;
85        unsigned char   ea_alert_priority;
86        unsigned short  ea_details_oob_source_id;
87        unsigned short  ea_details_major_chan_number;
88        unsigned short  ea_details_minor_chan_number;
89        unsigned short  ea_audio_oob_source_id;
90        char                    ea_alert_text[65536];                   /* NULL-terminated string */
91        unsigned char   ea_location_code_count;
92        EA_LOCATION_CODE ea_location_code[EA_MAX_LOCATION_CODE_COUNT];
93        unsigned char   ea_exception_count;
94        unsigned short  ea_exception_major_chan_no[256];
95        unsigned short  ea_exception_minor_chan_no[256];
96        unsigned short  ea_exception_oob_source_id[256];
97} EA_MSG_INFO;
98
99
100#if defined(INTEGRATE_WITH_BCM_SETTOP_API)
101/***************************************************************************
102Summary:
103        This function Initializes the bstream for subsequent settop API
104        calling.
105
106Description:
107        This function is only used if settop API is used.
108
109Returns:
110        void.
111
112See Also:
113       
114
115****************************************************************************/
116void SI_Api_Ea_OOB_Init(void *impl_specific_data);
117#endif
118
119
120/***************************************************************************
121Summary:
122        This function is called by POD stack to tune the OOB receiver.
123
124Description:
125        The POD sends OOB_RX_TUNE_REQ to host to request tuning of OOB receiver
126        channel. The host shall pass the frequency and symbol rate info to front
127        end driver to achieve QPSK lock. Note that FEC is done inside the POD,
128        OOB acquisition shall bypass FEC!!!
129
130Returns:
131        void.
132
133See Also:
134       
135
136****************************************************************************/
137unsigned short SI_Api_Ea_Get_Cur_Src_Id (void);
138void SI_Api_Ea_Acquire_Audio (unsigned short src_id);
139
140void SI_Api_Ea_OOB_Rx_Tune(unsigned long freq, /* [in] OOB channel carrier frequency in Hz */
141                                                        unsigned long data_rate, /* [in] OOB channel symbol rate in symbol/s */
142                                                        unsigned char spec /* [in] spectrum inversion bit */);
143
144void SI_Api_Ea_OOB_Tx_Tune(unsigned long freq, unsigned long power_level, unsigned long rate);
145
146void SI_Api_Ea_IB_Tune(unsigned long freq, unsigned char modulation);
147
148#ifdef __cplusplus
149}
150#endif
151
152#endif
153
Note: See TracBrowser for help on using the repository browser.