1/* cx25840 internal API header
2 *
3 * Copyright (C) 2003-2004 Chris Kennedy
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; either version 2
8 * of the License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
18 */
19
20#ifndef _CX25840_CORE_H_
21#define _CX25840_CORE_H_
22
23
24#include <linux/videodev2.h>
25#include <media/v4l2-device.h>
26#include <media/v4l2-ctrls.h>
27#include <linux/i2c.h>
28
29struct cx25840_ir_state;
30
31enum cx25840_model {
32	CX23885_AV,
33	CX23887_AV,
34	CX23888_AV,
35	CX2310X_AV,
36	CX25840,
37	CX25841,
38	CX25842,
39	CX25843,
40	CX25836,
41	CX25837,
42};
43
44enum cx25840_media_pads {
45	CX25840_PAD_INPUT,
46	CX25840_PAD_VID_OUT,
47	CX25840_PAD_VBI_OUT,
48
49	CX25840_NUM_PADS
50};
51
52struct cx25840_state {
53	struct i2c_client *c;
54	struct v4l2_subdev sd;
55	struct v4l2_ctrl_handler hdl;
56	struct {
57		/* volume cluster */
58		struct v4l2_ctrl *volume;
59		struct v4l2_ctrl *mute;
60	};
61	int pvr150_workaround;
62	int radio;
63	v4l2_std_id std;
64	enum cx25840_video_input vid_input;
65	enum cx25840_audio_input aud_input;
66	u32 audclk_freq;
67	int audmode;
68	int vbi_line_offset;
69	enum cx25840_model id;
70	u32 rev;
71	int is_initialized;
72	wait_queue_head_t fw_wait;    /* wake up when the fw load is finished */
73	struct work_struct fw_work;   /* work entry for fw load */
74	struct cx25840_ir_state *ir_state;
75#if defined(CONFIG_MEDIA_CONTROLLER)
76	struct media_pad	pads[CX25840_NUM_PADS];
77#endif
78};
79
80static inline struct cx25840_state *to_state(struct v4l2_subdev *sd)
81{
82	return container_of(sd, struct cx25840_state, sd);
83}
84
85static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
86{
87	return &container_of(ctrl->handler, struct cx25840_state, hdl)->sd;
88}
89
90static inline bool is_cx2583x(struct cx25840_state *state)
91{
92	return state->id == CX25836 ||
93	       state->id == CX25837;
94}
95
96static inline bool is_cx231xx(struct cx25840_state *state)
97{
98	return state->id == CX2310X_AV;
99}
100
101static inline bool is_cx2388x(struct cx25840_state *state)
102{
103	return state->id == CX23885_AV ||
104	       state->id == CX23887_AV ||
105	       state->id == CX23888_AV;
106}
107
108static inline bool is_cx23885(struct cx25840_state *state)
109{
110	return state->id == CX23885_AV;
111}
112
113static inline bool is_cx23887(struct cx25840_state *state)
114{
115	return state->id == CX23887_AV;
116}
117
118static inline bool is_cx23888(struct cx25840_state *state)
119{
120	return state->id == CX23888_AV;
121}
122
123/* ----------------------------------------------------------------------- */
124/* cx25850-core.c 							   */
125int cx25840_write(struct i2c_client *client, u16 addr, u8 value);
126int cx25840_write4(struct i2c_client *client, u16 addr, u32 value);
127u8 cx25840_read(struct i2c_client *client, u16 addr);
128u32 cx25840_read4(struct i2c_client *client, u16 addr);
129int cx25840_and_or(struct i2c_client *client, u16 addr, unsigned mask, u8 value);
130int cx25840_and_or4(struct i2c_client *client, u16 addr, u32 and_mask,
131		    u32 or_value);
132void cx25840_std_setup(struct i2c_client *client);
133
134/* ----------------------------------------------------------------------- */
135/* cx25850-firmware.c                                                      */
136int cx25840_loadfw(struct i2c_client *client);
137
138/* ----------------------------------------------------------------------- */
139/* cx25850-audio.c                                                         */
140void cx25840_audio_set_path(struct i2c_client *client);
141int cx25840_s_clock_freq(struct v4l2_subdev *sd, u32 freq);
142
143extern const struct v4l2_ctrl_ops cx25840_audio_ctrl_ops;
144
145/* ----------------------------------------------------------------------- */
146/* cx25850-vbi.c                                                           */
147int cx25840_s_raw_fmt(struct v4l2_subdev *sd, struct v4l2_vbi_format *fmt);
148int cx25840_s_sliced_fmt(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
149int cx25840_g_sliced_fmt(struct v4l2_subdev *sd, struct v4l2_sliced_vbi_format *fmt);
150int cx25840_decode_vbi_line(struct v4l2_subdev *sd, struct v4l2_decode_vbi_line *vbi);
151
152/* ----------------------------------------------------------------------- */
153/* cx25850-ir.c                                                            */
154extern const struct v4l2_subdev_ir_ops cx25840_ir_ops;
155int cx25840_ir_log_status(struct v4l2_subdev *sd);
156int cx25840_ir_irq_handler(struct v4l2_subdev *sd, u32 status, bool *handled);
157int cx25840_ir_probe(struct v4l2_subdev *sd);
158int cx25840_ir_remove(struct v4l2_subdev *sd);
159
160#endif
161