xref: /linux/drivers/media/dvb-frontends/stv0367_priv.h (revision 9095bf25ea08135a5b74875dd0e3eeaddc4218a0)
1 /*
2  * stv0367_priv.h
3  *
4  * Driver for ST STV0367 DVB-T & DVB-C demodulator IC.
5  *
6  * Copyright (C) ST Microelectronics.
7  * Copyright (C) 2010,2011 NetUP Inc.
8  * Copyright (C) 2010,2011 Igor M. Liplianin <liplianin@netup.ru>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *
19  * GNU General Public License for more details.
20  */
21 /* Common driver error constants */
22 
23 #ifndef STV0367_PRIV_H
24 #define STV0367_PRIV_H
25 
26 #ifndef TRUE
27     #define TRUE (1 == 1)
28 #endif
29 #ifndef FALSE
30     #define FALSE (!TRUE)
31 #endif
32 
33 #ifndef NULL
34 #define NULL 0
35 #endif
36 
37 /* MACRO definitions */
38 #define ABS(X) ((X) < 0 ? (-1 * (X)) : (X))
39 #define MAX(X, Y) ((X) >= (Y) ? (X) : (Y))
40 #define MIN(X, Y) ((X) <= (Y) ? (X) : (Y))
41 #define INRANGE(X, Y, Z) \
42 	((((X) <= (Y)) && ((Y) <= (Z))) || \
43 	(((Z) <= (Y)) && ((Y) <= (X))) ? 1 : 0)
44 
45 #ifndef MAKEWORD
46 #define MAKEWORD(X, Y) (((X) << 8) + (Y))
47 #endif
48 
49 #define LSB(X) (((X) & 0xff))
50 #define MSB(Y) (((Y) >> 8) & 0xff)
51 #define MMSB(Y)(((Y) >> 16) & 0xff)
52 
53 enum stv0367_ter_signal_type {
54 	FE_TER_NOAGC = 0,
55 	FE_TER_AGCOK = 5,
56 	FE_TER_NOTPS = 6,
57 	FE_TER_TPSOK = 7,
58 	FE_TER_NOSYMBOL = 8,
59 	FE_TER_BAD_CPQ = 9,
60 	FE_TER_PRFOUNDOK = 10,
61 	FE_TER_NOPRFOUND = 11,
62 	FE_TER_LOCKOK = 12,
63 	FE_TER_NOLOCK = 13,
64 	FE_TER_SYMBOLOK = 15,
65 	FE_TER_CPAMPOK = 16,
66 	FE_TER_NOCPAMP = 17,
67 	FE_TER_SWNOK = 18
68 };
69 
70 enum stv0367_ts_mode {
71 	STV0367_OUTPUTMODE_DEFAULT,
72 	STV0367_SERIAL_PUNCT_CLOCK,
73 	STV0367_SERIAL_CONT_CLOCK,
74 	STV0367_PARALLEL_PUNCT_CLOCK,
75 	STV0367_DVBCI_CLOCK
76 };
77 
78 enum stv0367_clk_pol {
79 	STV0367_CLOCKPOLARITY_DEFAULT,
80 	STV0367_RISINGEDGE_CLOCK,
81 	STV0367_FALLINGEDGE_CLOCK
82 };
83 
84 enum stv0367_ter_bw {
85 	FE_TER_CHAN_BW_6M = 6,
86 	FE_TER_CHAN_BW_7M = 7,
87 	FE_TER_CHAN_BW_8M = 8
88 };
89 
90 #if 0
91 enum FE_TER_Rate_TPS {
92 	FE_TER_TPS_1_2 = 0,
93 	FE_TER_TPS_2_3 = 1,
94 	FE_TER_TPS_3_4 = 2,
95 	FE_TER_TPS_5_6 = 3,
96 	FE_TER_TPS_7_8 = 4
97 };
98 #endif
99 
100 enum stv0367_ter_mode {
101 	FE_TER_MODE_2K,
102 	FE_TER_MODE_8K,
103 	FE_TER_MODE_4K
104 };
105 #if 0
106 enum FE_TER_Hierarchy_Alpha {
107 	FE_TER_HIER_ALPHA_NONE,	/* Regular modulation */
108 	FE_TER_HIER_ALPHA_1,	/* Hierarchical modulation a = 1*/
109 	FE_TER_HIER_ALPHA_2,	/* Hierarchical modulation a = 2*/
110 	FE_TER_HIER_ALPHA_4	/* Hierarchical modulation a = 4*/
111 };
112 #endif
113 enum stv0367_ter_hierarchy {
114 	FE_TER_HIER_NONE,	/*Hierarchy None*/
115 	FE_TER_HIER_LOW_PRIO,	/*Hierarchy : Low Priority*/
116 	FE_TER_HIER_HIGH_PRIO,	/*Hierarchy : High Priority*/
117 	FE_TER_HIER_PRIO_ANY	/*Hierarchy  :Any*/
118 };
119 
120 #if 0
121 enum fe_stv0367_ter_spec {
122 	FE_TER_INVERSION_NONE = 0,
123 	FE_TER_INVERSION = 1,
124 	FE_TER_INVERSION_AUTO = 2,
125 	FE_TER_INVERSION_UNK  = 4
126 };
127 #endif
128 
129 enum stv0367_ter_if_iq_mode {
130 	FE_TER_NORMAL_IF_TUNER = 0,
131 	FE_TER_LONGPATH_IF_TUNER = 1,
132 	FE_TER_IQ_TUNER = 2
133 
134 };
135 
136 #if 0
137 enum FE_TER_FECRate {
138 	FE_TER_FEC_NONE = 0x00,	/* no FEC rate specified */
139 	FE_TER_FEC_ALL = 0xFF,	 /* Logical OR of all FECs */
140 	FE_TER_FEC_1_2 = 1,
141 	FE_TER_FEC_2_3 = (1 << 1),
142 	FE_TER_FEC_3_4 = (1 << 2),
143 	FE_TER_FEC_4_5 = (1 << 3),
144 	FE_TER_FEC_5_6 = (1 << 4),
145 	FE_TER_FEC_6_7 = (1 << 5),
146 	FE_TER_FEC_7_8 = (1 << 6),
147 	FE_TER_FEC_8_9 = (1 << 7)
148 };
149 
150 enum FE_TER_Rate {
151 	FE_TER_FE_1_2 = 0,
152 	FE_TER_FE_2_3 = 1,
153 	FE_TER_FE_3_4 = 2,
154 	FE_TER_FE_5_6 = 3,
155 	FE_TER_FE_6_7 = 4,
156 	FE_TER_FE_7_8 = 5
157 };
158 #endif
159 
160 enum stv0367_ter_force {
161 	FE_TER_FORCENONE = 0,
162 	FE_TER_FORCE_M_G = 1
163 };
164 
165 enum  stv0367cab_mod {
166 	FE_CAB_MOD_QAM4,
167 	FE_CAB_MOD_QAM16,
168 	FE_CAB_MOD_QAM32,
169 	FE_CAB_MOD_QAM64,
170 	FE_CAB_MOD_QAM128,
171 	FE_CAB_MOD_QAM256,
172 	FE_CAB_MOD_QAM512,
173 	FE_CAB_MOD_QAM1024
174 };
175 #if 0
176 enum {
177 	FE_CAB_FEC_A = 1,	/* J83 Annex A */
178 	FE_CAB_FEC_B = (1 << 1),/* J83 Annex B */
179 	FE_CAB_FEC_C = (1 << 2)	/* J83 Annex C */
180 } FE_CAB_FECType_t;
181 #endif
182 struct stv0367_cab_signal_info {
183 	int locked;
184 	u32 frequency; /* kHz */
185 	u32 symbol_rate; /* Mbds */
186 	enum stv0367cab_mod modulation;
187 	enum fe_spectral_inversion spect_inv;
188 	s32 Power_dBmx10;	/* Power of the RF signal (dBm x 10) */
189 	u32	CN_dBx10;	/* Carrier to noise ratio (dB x 10) */
190 	u32	BER;		/* Bit error rate (x 10000000)	*/
191 };
192 
193 enum stv0367_cab_signal_type {
194 	FE_CAB_NOTUNER,
195 	FE_CAB_NOAGC,
196 	FE_CAB_NOSIGNAL,
197 	FE_CAB_NOTIMING,
198 	FE_CAB_TIMINGOK,
199 	FE_CAB_NOCARRIER,
200 	FE_CAB_CARRIEROK,
201 	FE_CAB_NOBLIND,
202 	FE_CAB_BLINDOK,
203 	FE_CAB_NODEMOD,
204 	FE_CAB_DEMODOK,
205 	FE_CAB_DATAOK
206 };
207 
208 #endif
209