]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/media/dvb/frontends/stv0900_priv.h
V4L/DVB (10843): saa7146: Clean-up i2c error handling
[mirror_ubuntu-artful-kernel.git] / drivers / media / dvb / frontends / stv0900_priv.h
CommitLineData
db7a4843
IL
1/*
2 * stv0900_priv.h
3 *
4 * Driver for ST STV0900 satellite demodulator IC.
5 *
6 * Copyright (C) ST Microelectronics.
7 * Copyright (C) 2009 NetUP Inc.
8 * Copyright (C) 2009 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 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 */
25
26#ifndef STV0900_PRIV_H
27#define STV0900_PRIV_H
28
29#include <linux/i2c.h>
30
31#define ABS(X) ((X) < 0 ? (-1 * (X)) : (X))
32#define INRANGE(X, Y, Z) ((((X) <= (Y)) && ((Y) <= (Z))) \
33 || (((Z) <= (Y)) && ((Y) <= (X))) ? 1 : 0)
34
35#ifndef MAKEWORD
36#define MAKEWORD(X, Y) (((X) << 8) + (Y))
37#endif
38
39#define LSB(X) (((X) & 0xFF))
40#define MSB(Y) (((Y) >> 8) & 0xFF)
41
42#ifndef TRUE
43#define TRUE (1 == 1)
44#endif
45#ifndef FALSE
46#define FALSE (!TRUE)
47#endif
48
49#define dmd_reg(a, b, c) \
50 do { \
51 a = 0; \
52 switch (demod) { \
53 case STV0900_DEMOD_1: \
54 default: \
55 a = b; \
56 break; \
57 case STV0900_DEMOD_2: \
58 a = c; \
59 break; \
60 } \
61 } while (0)
62
63#define dmd_choose(a, b) (demod = STV0900_DEMOD_2 ? b : a))
64
65extern int debug;
66
67#define dprintk(args...) \
68 do { \
69 if (debug) \
70 printk(KERN_DEBUG args); \
71 } while (0)
72
73#define STV0900_MAXLOOKUPSIZE 500
74#define STV0900_BLIND_SEARCH_AGC2_TH 700
75
76/* One point of the lookup table */
77struct stv000_lookpoint {
78 s32 realval;/* real value */
79 s32 regval;/* binary value */
80};
81
82/* Lookup table definition */
83struct stv0900_table{
84 s32 size;/* Size of the lookup table */
85 struct stv000_lookpoint table[STV0900_MAXLOOKUPSIZE];/* Lookup table */
86};
87
88enum fe_stv0900_error {
89 STV0900_NO_ERROR = 0,
90 STV0900_INVALID_HANDLE,
91 STV0900_BAD_PARAMETER,
92 STV0900_I2C_ERROR,
93 STV0900_SEARCH_FAILED,
94};
95
96enum fe_stv0900_clock_type {
97 STV0900_USE_REGISTERS_DEFAULT,
98 STV0900_SERIAL_PUNCT_CLOCK,/*Serial punctured clock */
99 STV0900_SERIAL_CONT_CLOCK,/*Serial continues clock */
100 STV0900_PARALLEL_PUNCT_CLOCK,/*Parallel punctured clock */
101 STV0900_DVBCI_CLOCK/*Parallel continues clock : DVBCI */
102};
103
104enum fe_stv0900_search_state {
105 STV0900_SEARCH = 0,
106 STV0900_PLH_DETECTED,
107 STV0900_DVBS2_FOUND,
108 STV0900_DVBS_FOUND
109
110};
111
112enum fe_stv0900_ldpc_state {
113 STV0900_PATH1_OFF_PATH2_OFF = 0,
114 STV0900_PATH1_ON_PATH2_OFF = 1,
115 STV0900_PATH1_OFF_PATH2_ON = 2,
116 STV0900_PATH1_ON_PATH2_ON = 3
117};
118
119enum fe_stv0900_signal_type {
120 STV0900_NOAGC1 = 0,
121 STV0900_AGC1OK,
122 STV0900_NOTIMING,
123 STV0900_ANALOGCARRIER,
124 STV0900_TIMINGOK,
125 STV0900_NOAGC2,
126 STV0900_AGC2OK,
127 STV0900_NOCARRIER,
128 STV0900_CARRIEROK,
129 STV0900_NODATA,
130 STV0900_DATAOK,
131 STV0900_OUTOFRANGE,
132 STV0900_RANGEOK
133};
134
135enum fe_stv0900_demod_num {
136 STV0900_DEMOD_1,
137 STV0900_DEMOD_2
138};
139
140enum fe_stv0900_tracking_standard {
141 STV0900_DVBS1_STANDARD,/* Found Standard*/
142 STV0900_DVBS2_STANDARD,
143 STV0900_DSS_STANDARD,
144 STV0900_TURBOCODE_STANDARD,
145 STV0900_UNKNOWN_STANDARD
146};
147
148enum fe_stv0900_search_standard {
149 STV0900_AUTO_SEARCH,
150 STV0900_SEARCH_DVBS1,/* Search Standard*/
151 STV0900_SEARCH_DVBS2,
152 STV0900_SEARCH_DSS,
153 STV0900_SEARCH_TURBOCODE
154};
155
156enum fe_stv0900_search_algo {
157 STV0900_BLIND_SEARCH,/* offset freq and SR are Unknown */
158 STV0900_COLD_START,/* only the SR is known */
159 STV0900_WARM_START/* offset freq and SR are known */
160};
161
162enum fe_stv0900_modulation {
163 STV0900_QPSK,
164 STV0900_8PSK,
165 STV0900_16APSK,
166 STV0900_32APSK,
167 STV0900_UNKNOWN
168};
169
170enum fe_stv0900_modcode {
171 STV0900_DUMMY_PLF,
172 STV0900_QPSK_14,
173 STV0900_QPSK_13,
174 STV0900_QPSK_25,
175 STV0900_QPSK_12,
176 STV0900_QPSK_35,
177 STV0900_QPSK_23,
178 STV0900_QPSK_34,
179 STV0900_QPSK_45,
180 STV0900_QPSK_56,
181 STV0900_QPSK_89,
182 STV0900_QPSK_910,
183 STV0900_8PSK_35,
184 STV0900_8PSK_23,
185 STV0900_8PSK_34,
186 STV0900_8PSK_56,
187 STV0900_8PSK_89,
188 STV0900_8PSK_910,
189 STV0900_16APSK_23,
190 STV0900_16APSK_34,
191 STV0900_16APSK_45,
192 STV0900_16APSK_56,
193 STV0900_16APSK_89,
194 STV0900_16APSK_910,
195 STV0900_32APSK_34,
196 STV0900_32APSK_45,
197 STV0900_32APSK_56,
198 STV0900_32APSK_89,
199 STV0900_32APSK_910,
200 STV0900_MODCODE_UNKNOWN
201};
202
203enum fe_stv0900_fec {/*DVBS1, DSS and turbo code puncture rate*/
204 STV0900_FEC_1_2 = 0,
205 STV0900_FEC_2_3,
206 STV0900_FEC_3_4,
207 STV0900_FEC_4_5,/*for turbo code only*/
208 STV0900_FEC_5_6,
209 STV0900_FEC_6_7,/*for DSS only */
210 STV0900_FEC_7_8,
211 STV0900_FEC_8_9,/*for turbo code only*/
212 STV0900_FEC_UNKNOWN
213};
214
215enum fe_stv0900_frame_length {
216 STV0900_LONG_FRAME,
217 STV0900_SHORT_FRAME
218};
219
220enum fe_stv0900_pilot {
221 STV0900_PILOTS_OFF,
222 STV0900_PILOTS_ON
223};
224
225enum fe_stv0900_rolloff {
226 STV0900_35,
227 STV0900_25,
228 STV0900_20
229};
230
231enum fe_stv0900_search_iq {
232 STV0900_IQ_AUTO,
233 STV0900_IQ_AUTO_NORMAL_FIRST,
234 STV0900_IQ_FORCE_NORMAL,
235 STV0900_IQ_FORCE_SWAPPED
236};
237
238enum stv0900_iq_inversion {
239 STV0900_IQ_NORMAL,
240 STV0900_IQ_SWAPPED
241};
242
243enum fe_stv0900_diseqc_mode {
244 STV0900_22KHZ_Continues = 0,
245 STV0900_DISEQC_2_3_PWM = 2,
246 STV0900_DISEQC_3_3_PWM = 3,
247 STV0900_DISEQC_2_3_ENVELOP = 4,
248 STV0900_DISEQC_3_3_ENVELOP = 5
249};
250
251enum fe_stv0900_demod_mode {
252 STV0900_SINGLE = 0,
253 STV0900_DUAL
254};
255
256struct stv0900_init_params{
257 u32 dmd_ref_clk;/* Refrence,Input clock for the demod in Hz */
258
259 /* Demodulator Type (single demod or dual demod) */
260 enum fe_stv0900_demod_mode demod_mode;
261 enum fe_stv0900_rolloff rolloff;
262 enum fe_stv0900_clock_type path1_ts_clock;
263
264 u8 tun1_maddress;
265 int tuner1_adc;
266
267 /* IQ from the tuner1 to the demod */
268 enum stv0900_iq_inversion tun1_iq_inversion;
269 enum fe_stv0900_clock_type path2_ts_clock;
270
271 u8 tun2_maddress;
272 int tuner2_adc;
273
274 /* IQ from the tuner2 to the demod */
275 enum stv0900_iq_inversion tun2_iq_inversion;
276};
277
278struct stv0900_search_params {
279 enum fe_stv0900_demod_num path;/* Path Used demod1 or 2 */
280
281 u32 frequency;/* Transponder frequency (in KHz) */
282 u32 symbol_rate;/* Transponder symbol rate (in bds)*/
283 u32 search_range;/* Range of the search (in Hz) */
284
285 enum fe_stv0900_search_standard standard;
286 enum fe_stv0900_modulation modulation;
287 enum fe_stv0900_fec fec;
288 enum fe_stv0900_modcode modcode;
289 enum fe_stv0900_search_iq iq_inversion;
290 enum fe_stv0900_search_algo search_algo;
291
292};
293
294struct stv0900_signal_info {
295 int locked;/* Transponder locked */
296 u32 frequency;/* Transponder frequency (in KHz) */
297 u32 symbol_rate;/* Transponder symbol rate (in Mbds) */
298
299 enum fe_stv0900_tracking_standard standard;
300 enum fe_stv0900_fec fec;
301 enum fe_stv0900_modcode modcode;
302 enum fe_stv0900_modulation modulation;
303 enum fe_stv0900_pilot pilot;
304 enum fe_stv0900_frame_length frame_length;
305 enum stv0900_iq_inversion spectrum;
306 enum fe_stv0900_rolloff rolloff;
307
308 s32 Power;/* Power of the RF signal (dBm) */
309 s32 C_N;/* Carrier to noise ratio (dB x10)*/
310 u32 BER;/* Bit error rate (x10^7) */
311
312};
313
314struct stv0900_internal{
315 s32 quartz;
316 s32 mclk;
317 /* manual RollOff for DVBS1/DSS only */
318 enum fe_stv0900_rolloff rolloff;
319 /* Demodulator use for single demod or for dual demod) */
320 enum fe_stv0900_demod_mode demod_mode;
321
322 /*Demod 1*/
323 s32 tuner1_freq;
324 s32 tuner1_bw;
325 s32 dmd1_symbol_rate;
326 s32 dmd1_srch_range;
327
328 /* algorithm for search Blind, Cold or Warm*/
329 enum fe_stv0900_search_algo dmd1_srch_algo;
330 /* search standard: Auto, DVBS1/DSS only or DVBS2 only*/
331 enum fe_stv0900_search_standard dmd1_srch_standard;
332 /* inversion search : auto, auto norma first, normal or inverted */
333 enum fe_stv0900_search_iq dmd1_srch_iq_inv;
334 enum fe_stv0900_modcode dmd1_modcode;
335 enum fe_stv0900_modulation dmd1_modulation;
336 enum fe_stv0900_fec dmd1_fec;
337
338 struct stv0900_signal_info dmd1_rslts;
339 enum fe_stv0900_signal_type dmd1_state;
340
341 enum fe_stv0900_error dmd1_err;
342
343 /*Demod 2*/
344 s32 tuner2_freq;
345 s32 tuner2_bw;
346 s32 dmd2_symbol_rate;
347 s32 dmd2_srch_range;
348
349 enum fe_stv0900_search_algo dmd2_srch_algo;
350 enum fe_stv0900_search_standard dmd2_srch_stndrd;
351 /* inversion search : auto, auto normal first, normal or inverted */
352 enum fe_stv0900_search_iq dmd2_srch_iq_inv;
353 enum fe_stv0900_modcode dmd2_modcode;
354 enum fe_stv0900_modulation dmd2_modulation;
355 enum fe_stv0900_fec dmd2_fec;
356
357 /* results of the search*/
358 struct stv0900_signal_info dmd2_rslts;
359 /* current state of the search algorithm */
360 enum fe_stv0900_signal_type dmd2_state;
361
362 enum fe_stv0900_error dmd2_err;
363
364 struct i2c_adapter *i2c_adap;
365 u8 i2c_addr;
366 u8 clkmode;/* 0 for CLKI, 2 for XTALI */
367 u8 chip_id;
368 enum fe_stv0900_error errs;
369 int dmds_used;
370};
371
372/* state for each demod */
373struct stv0900_state {
374 /* pointer for internal params, one for each pair of demods */
375 struct stv0900_internal *internal;
376 struct i2c_adapter *i2c_adap;
377 const struct stv0900_config *config;
378 struct dvb_frontend frontend;
379 int demod;
380};
381
382extern s32 ge2comp(s32 a, s32 width);
383
384extern void stv0900_write_reg(struct stv0900_internal *i_params,
385 u16 reg_addr, u8 reg_data);
386
387extern u8 stv0900_read_reg(struct stv0900_internal *i_params,
388 u16 reg_addr);
389
390extern void stv0900_write_bits(struct stv0900_internal *i_params,
391 u32 label, u8 val);
392
393extern u8 stv0900_get_bits(struct stv0900_internal *i_params,
394 u32 label);
395
396extern int stv0900_get_demod_lock(struct stv0900_internal *i_params,
397 enum fe_stv0900_demod_num demod, s32 time_out);
398extern int stv0900_check_signal_presence(struct stv0900_internal *i_params,
399 enum fe_stv0900_demod_num demod);
400
401extern enum fe_stv0900_signal_type stv0900_algo(struct dvb_frontend *fe);
402
403extern void stv0900_set_tuner(struct dvb_frontend *fe, u32 frequency,
404 u32 bandwidth);
405extern void stv0900_set_bandwidth(struct dvb_frontend *fe, u32 bandwidth);
406
407extern void stv0900_start_search(struct stv0900_internal *i_params,
408 enum fe_stv0900_demod_num demod);
409
410extern u8 stv0900_get_optim_carr_loop(s32 srate,
411 enum fe_stv0900_modcode modcode,
412 s32 pilot, u8 chip_id);
413
414extern u8 stv0900_get_optim_short_carr_loop(s32 srate,
415 enum fe_stv0900_modulation modulation,
416 u8 chip_id);
417
418extern void stv0900_stop_all_s2_modcod(struct stv0900_internal *i_params,
419 enum fe_stv0900_demod_num demod);
420
421extern void stv0900_activate_s2_modcode(struct stv0900_internal *i_params,
422 enum fe_stv0900_demod_num demod);
423
424extern void stv0900_activate_s2_modcode_single(struct stv0900_internal *i_params,
425 enum fe_stv0900_demod_num demod);
426
427extern enum fe_stv0900_tracking_standard stv0900_get_standard(struct dvb_frontend *fe,
428 enum fe_stv0900_demod_num demod);
429
430#endif