Merge branch 'next' of git://git.kernel.org/pub/scm/linux/kernel/git/benh/powerpc
[linux-2.6] / drivers / media / common / tuners / tda18271-priv.h
1 /*
2     tda18271-priv.h - private header for the NXP TDA18271 silicon tuner
3
4     Copyright (C) 2007, 2008 Michael Krufky <mkrufky@linuxtv.org>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21 #ifndef __TDA18271_PRIV_H__
22 #define __TDA18271_PRIV_H__
23
24 #include <linux/kernel.h>
25 #include <linux/types.h>
26 #include <linux/mutex.h>
27 #include "tuner-i2c.h"
28 #include "tda18271.h"
29
30 #define R_ID     0x00   /* ID byte                */
31 #define R_TM     0x01   /* Thermo byte            */
32 #define R_PL     0x02   /* Power level byte       */
33 #define R_EP1    0x03   /* Easy Prog byte 1       */
34 #define R_EP2    0x04   /* Easy Prog byte 2       */
35 #define R_EP3    0x05   /* Easy Prog byte 3       */
36 #define R_EP4    0x06   /* Easy Prog byte 4       */
37 #define R_EP5    0x07   /* Easy Prog byte 5       */
38 #define R_CPD    0x08   /* Cal Post-Divider byte  */
39 #define R_CD1    0x09   /* Cal Divider byte 1     */
40 #define R_CD2    0x0a   /* Cal Divider byte 2     */
41 #define R_CD3    0x0b   /* Cal Divider byte 3     */
42 #define R_MPD    0x0c   /* Main Post-Divider byte */
43 #define R_MD1    0x0d   /* Main Divider byte 1    */
44 #define R_MD2    0x0e   /* Main Divider byte 2    */
45 #define R_MD3    0x0f   /* Main Divider byte 3    */
46 #define R_EB1    0x10   /* Extended byte 1        */
47 #define R_EB2    0x11   /* Extended byte 2        */
48 #define R_EB3    0x12   /* Extended byte 3        */
49 #define R_EB4    0x13   /* Extended byte 4        */
50 #define R_EB5    0x14   /* Extended byte 5        */
51 #define R_EB6    0x15   /* Extended byte 6        */
52 #define R_EB7    0x16   /* Extended byte 7        */
53 #define R_EB8    0x17   /* Extended byte 8        */
54 #define R_EB9    0x18   /* Extended byte 9        */
55 #define R_EB10   0x19   /* Extended byte 10       */
56 #define R_EB11   0x1a   /* Extended byte 11       */
57 #define R_EB12   0x1b   /* Extended byte 12       */
58 #define R_EB13   0x1c   /* Extended byte 13       */
59 #define R_EB14   0x1d   /* Extended byte 14       */
60 #define R_EB15   0x1e   /* Extended byte 15       */
61 #define R_EB16   0x1f   /* Extended byte 16       */
62 #define R_EB17   0x20   /* Extended byte 17       */
63 #define R_EB18   0x21   /* Extended byte 18       */
64 #define R_EB19   0x22   /* Extended byte 19       */
65 #define R_EB20   0x23   /* Extended byte 20       */
66 #define R_EB21   0x24   /* Extended byte 21       */
67 #define R_EB22   0x25   /* Extended byte 22       */
68 #define R_EB23   0x26   /* Extended byte 23       */
69
70 #define TDA18271_NUM_REGS 39
71
72 /*---------------------------------------------------------------------*/
73
74 struct tda18271_rf_tracking_filter_cal {
75         u32 rfmax;
76         u8  rfband;
77         u32 rf1_def;
78         u32 rf2_def;
79         u32 rf3_def;
80         u32 rf1;
81         u32 rf2;
82         u32 rf3;
83         int rf_a1;
84         int rf_b1;
85         int rf_a2;
86         int rf_b2;
87 };
88
89 enum tda18271_pll {
90         TDA18271_MAIN_PLL,
91         TDA18271_CAL_PLL,
92 };
93
94 struct tda18271_map_layout;
95
96 enum tda18271_ver {
97         TDA18271HDC1,
98         TDA18271HDC2,
99 };
100
101 struct tda18271_priv {
102         unsigned char tda18271_regs[TDA18271_NUM_REGS];
103
104         struct list_head        hybrid_tuner_instance_list;
105         struct tuner_i2c_props  i2c_props;
106
107         enum tda18271_mode mode;
108         enum tda18271_role role;
109         enum tda18271_i2c_gate gate;
110         enum tda18271_ver id;
111
112         unsigned int config; /* interface to saa713x / tda829x */
113         unsigned int tm_rfcal;
114         unsigned int cal_initialized:1;
115         unsigned int small_i2c:1;
116
117         struct tda18271_map_layout *maps;
118         struct tda18271_std_map std;
119         struct tda18271_rf_tracking_filter_cal rf_cal_state[8];
120
121         struct mutex lock;
122
123         u32 frequency;
124         u32 bandwidth;
125 };
126
127 /*---------------------------------------------------------------------*/
128
129 extern int tda18271_debug;
130
131 #define DBG_INFO 1
132 #define DBG_MAP  2
133 #define DBG_REG  4
134 #define DBG_ADV  8
135 #define DBG_CAL  16
136
137 #define tda_printk(kern, fmt, arg...) \
138         printk(kern "%s: " fmt, __func__, ##arg)
139
140 #define dprintk(kern, lvl, fmt, arg...) do {\
141         if (tda18271_debug & lvl) \
142                 tda_printk(kern, fmt, ##arg); } while (0)
143
144 #define tda_info(fmt, arg...) printk(KERN_INFO              fmt, ##arg)
145 #define tda_warn(fmt, arg...) tda_printk(KERN_WARNING,      fmt, ##arg)
146 #define tda_err(fmt, arg...)  tda_printk(KERN_ERR,          fmt, ##arg)
147 #define tda_dbg(fmt, arg...)  dprintk(KERN_DEBUG, DBG_INFO, fmt, ##arg)
148 #define tda_map(fmt, arg...)  dprintk(KERN_DEBUG, DBG_MAP,  fmt, ##arg)
149 #define tda_reg(fmt, arg...)  dprintk(KERN_DEBUG, DBG_REG,  fmt, ##arg)
150 #define tda_cal(fmt, arg...)  dprintk(KERN_DEBUG, DBG_CAL,  fmt, ##arg)
151
152 #define tda_fail(ret)                                                        \
153 ({                                                                           \
154         int __ret;                                                           \
155         __ret = (ret < 0);                                                   \
156         if (__ret)                                                           \
157                 tda_printk(KERN_ERR, "error %d on line %d\n", ret, __LINE__);\
158         __ret;                                                               \
159 })
160
161 /*---------------------------------------------------------------------*/
162
163 enum tda18271_map_type {
164         /* tda18271_pll_map */
165         MAIN_PLL,
166         CAL_PLL,
167         /* tda18271_map */
168         RF_CAL,
169         RF_CAL_KMCO,
170         RF_CAL_DC_OVER_DT,
171         BP_FILTER,
172         RF_BAND,
173         GAIN_TAPER,
174         IR_MEASURE,
175 };
176
177 extern int tda18271_lookup_pll_map(struct dvb_frontend *fe,
178                                    enum tda18271_map_type map_type,
179                                    u32 *freq, u8 *post_div, u8 *div);
180 extern int tda18271_lookup_map(struct dvb_frontend *fe,
181                                enum tda18271_map_type map_type,
182                                u32 *freq, u8 *val);
183
184 extern int tda18271_lookup_thermometer(struct dvb_frontend *fe);
185
186 extern int tda18271_lookup_rf_band(struct dvb_frontend *fe,
187                                    u32 *freq, u8 *rf_band);
188
189 extern int tda18271_lookup_cid_target(struct dvb_frontend *fe,
190                                       u32 *freq, u8 *cid_target,
191                                       u16 *count_limit);
192
193 extern int tda18271_assign_map_layout(struct dvb_frontend *fe);
194
195 /*---------------------------------------------------------------------*/
196
197 extern int tda18271_read_regs(struct dvb_frontend *fe);
198 extern int tda18271_read_extended(struct dvb_frontend *fe);
199 extern int tda18271_write_regs(struct dvb_frontend *fe, int idx, int len);
200 extern int tda18271_init_regs(struct dvb_frontend *fe);
201
202 extern int tda18271_charge_pump_source(struct dvb_frontend *fe,
203                                        enum tda18271_pll pll, int force);
204 extern int tda18271_set_standby_mode(struct dvb_frontend *fe,
205                                      int sm, int sm_lt, int sm_xt);
206
207 extern int tda18271_calc_main_pll(struct dvb_frontend *fe, u32 freq);
208 extern int tda18271_calc_cal_pll(struct dvb_frontend *fe, u32 freq);
209
210 extern int tda18271_calc_bp_filter(struct dvb_frontend *fe, u32 *freq);
211 extern int tda18271_calc_km(struct dvb_frontend *fe, u32 *freq);
212 extern int tda18271_calc_rf_band(struct dvb_frontend *fe, u32 *freq);
213 extern int tda18271_calc_gain_taper(struct dvb_frontend *fe, u32 *freq);
214 extern int tda18271_calc_ir_measure(struct dvb_frontend *fe, u32 *freq);
215 extern int tda18271_calc_rf_cal(struct dvb_frontend *fe, u32 *freq);
216
217 #endif /* __TDA18271_PRIV_H__ */
218
219 /*
220  * Overrides for Emacs so that we follow Linus's tabbing style.
221  * ---------------------------------------------------------------------------
222  * Local variables:
223  * c-basic-offset: 8
224  * End:
225  */