1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * tm6000.h - driver for TM5600/TM6000/TM6010 USB video capture devices
4 *
5 * Copyright (c) 2006-2007 Mauro Carvalho Chehab <mchehab@kernel.org>
6 *
7 * Copyright (c) 2007 Michel Ludwig <michel.ludwig@gmail.com>
8 *	- DVB-T support
9 */
10
11#include <linux/videodev2.h>
12#include <media/v4l2-common.h>
13#include <media/videobuf-vmalloc.h>
14#include "tm6000-usb-isoc.h"
15#include <linux/i2c.h>
16#include <linux/mutex.h>
17#include <media/v4l2-device.h>
18#include <media/v4l2-ctrls.h>
19#include <media/v4l2-fh.h>
20
21#include <linux/dvb/frontend.h>
22#include <media/dvb_demux.h>
23#include <media/dvb_frontend.h>
24#include <media/dmxdev.h>
25
26/* Inputs */
27enum tm6000_itype {
28	TM6000_INPUT_TV	= 1,
29	TM6000_INPUT_COMPOSITE1,
30	TM6000_INPUT_COMPOSITE2,
31	TM6000_INPUT_SVIDEO,
32	TM6000_INPUT_DVB,
33	TM6000_INPUT_RADIO,
34};
35
36enum tm6000_mux {
37	TM6000_VMUX_VIDEO_A = 1,
38	TM6000_VMUX_VIDEO_B,
39	TM6000_VMUX_VIDEO_AB,
40	TM6000_AMUX_ADC1,
41	TM6000_AMUX_ADC2,
42	TM6000_AMUX_SIF1,
43	TM6000_AMUX_SIF2,
44	TM6000_AMUX_I2S,
45};
46
47enum tm6000_devtype {
48	TM6000 = 0,
49	TM5600,
50	TM6010,
51};
52
53struct tm6000_input {
54	enum tm6000_itype	type;
55	enum tm6000_mux		vmux;
56	enum tm6000_mux		amux;
57	unsigned int		v_gpio;
58	unsigned int		a_gpio;
59};
60
61/* ------------------------------------------------------------------
62 *	Basic structures
63 * ------------------------------------------------------------------
64 */
65
66struct tm6000_fmt {
67	u32   fourcc;          /* v4l2 format id */
68	int   depth;
69};
70
71/* buffer for one video frame */
72struct tm6000_buffer {
73	/* common v4l buffer stuff -- must be first */
74	struct videobuf_buffer vb;
75
76	struct tm6000_fmt      *fmt;
77};
78
79struct tm6000_dmaqueue {
80	struct list_head       active;
81	struct list_head       queued;
82
83	/* thread for generating video stream*/
84	struct task_struct         *kthread;
85	wait_queue_head_t          wq;
86	/* Counters to control fps rate */
87	int                        frame;
88	int                        ini_jiffies;
89};
90
91/* device states */
92enum tm6000_core_state {
93	DEV_INITIALIZED   = 0x01,
94	DEV_DISCONNECTED  = 0x02,
95	DEV_MISCONFIGURED = 0x04,
96};
97
98/* io methods */
99enum tm6000_io_method {
100	IO_NONE,
101	IO_READ,
102	IO_MMAP,
103};
104
105enum tm6000_mode {
106	TM6000_MODE_UNKNOWN = 0,
107	TM6000_MODE_ANALOG,
108	TM6000_MODE_DIGITAL,
109};
110
111struct tm6000_gpio {
112	int		tuner_reset;
113	int		tuner_on;
114	int		demod_reset;
115	int		demod_on;
116	int		power_led;
117	int		dvb_led;
118	int		ir;
119};
120
121struct tm6000_capabilities {
122	unsigned int    has_tuner:1;
123	unsigned int    has_tda9874:1;
124	unsigned int    has_dvb:1;
125	unsigned int    has_zl10353:1;
126	unsigned int    has_eeprom:1;
127	unsigned int    has_remote:1;
128	unsigned int    has_radio:1;
129};
130
131struct tm6000_dvb {
132	struct dvb_adapter	adapter;
133	struct dvb_demux	demux;
134	struct dvb_frontend	*frontend;
135	struct dmxdev		dmxdev;
136	unsigned int		streams;
137	struct urb		*bulk_urb;
138	struct mutex		mutex;
139};
140
141struct snd_tm6000_card {
142	struct snd_card			*card;
143	spinlock_t			reg_lock;
144	struct tm6000_core		*core;
145	struct snd_pcm_substream	*substream;
146
147	/* temporary data for buffer fill processing */
148	unsigned			buf_pos;
149	unsigned			period_pos;
150};
151
152struct tm6000_endpoint {
153	struct usb_host_endpoint	*endp;
154	__u8				bInterfaceNumber;
155	__u8				bAlternateSetting;
156	unsigned			maxsize;
157};
158
159#define TM6000_QUIRK_NO_USB_DELAY (1 << 0)
160
161struct tm6000_core {
162	/* generic device properties */
163	char				name[30];	/* name (including minor) of the device */
164	int				model;		/* index in the device_data struct */
165	int				devno;		/* marks the number of this device */
166	enum tm6000_devtype		dev_type;	/* type of device */
167	unsigned char			eedata[256];	/* Eeprom data */
168	unsigned			eedata_size;	/* Size of the eeprom info */
169
170	v4l2_std_id                     norm;           /* Current norm */
171	int				width, height;	/* Selected resolution */
172
173	enum tm6000_core_state		state;
174
175	/* Device Capabilities*/
176	struct tm6000_capabilities	caps;
177
178	/* Used to load alsa/dvb */
179	struct work_struct		request_module_wk;
180
181	/* Tuner configuration */
182	int				tuner_type;		/* type of the tuner */
183	int				tuner_addr;		/* tuner address */
184
185	struct tm6000_gpio		gpio;
186
187	char				*ir_codes;
188
189	__u8				radio;
190
191	/* Demodulator configuration */
192	int				demod_addr;	/* demodulator address */
193
194	int				audio_bitrate;
195	/* i2c i/o */
196	struct i2c_adapter		i2c_adap;
197	struct i2c_client		i2c_client;
198
199
200	/* extension */
201	struct list_head		devlist;
202
203	/* video for linux */
204	int				users;
205
206	/* various device info */
207	struct tm6000_fh		*resources;	/* Points to fh that is streaming */
208	bool				is_res_read;
209
210	struct video_device		vfd;
211	struct video_device		radio_dev;
212	struct tm6000_dmaqueue		vidq;
213	struct v4l2_device		v4l2_dev;
214	struct v4l2_ctrl_handler	ctrl_handler;
215	struct v4l2_ctrl_handler	radio_ctrl_handler;
216
217	int				input;
218	struct tm6000_input		vinput[3];	/* video input */
219	struct tm6000_input		rinput;		/* radio input */
220
221	int				freq;
222	unsigned int			fourcc;
223
224	enum tm6000_mode		mode;
225
226	int				ctl_mute;             /* audio */
227	int				ctl_volume;
228	int				amode;
229
230	/* DVB-T support */
231	struct tm6000_dvb		*dvb;
232
233	/* audio support */
234	struct snd_tm6000_card		*adev;
235	struct work_struct		wq_trigger;   /* Trigger to start/stop audio for alsa module */
236	atomic_t			stream_started;  /* stream should be running if true */
237
238	struct tm6000_IR		*ir;
239
240	/* locks */
241	struct mutex			lock;
242	struct mutex			usb_lock;
243
244	/* usb transfer */
245	struct usb_device		*udev;		/* the usb device */
246
247	struct tm6000_endpoint		bulk_in, bulk_out, isoc_in, isoc_out;
248	struct tm6000_endpoint		int_in, int_out;
249
250	/* scaler!=0 if scaler is active*/
251	int				scaler;
252
253		/* Isoc control struct */
254	struct usb_isoc_ctl          isoc_ctl;
255
256	spinlock_t                   slock;
257
258	/* urb dma buffers */
259	char				**urb_buffer;
260	dma_addr_t			*urb_dma;
261	unsigned int			urb_size;
262
263	unsigned long quirks;
264};
265
266enum tm6000_ops_type {
267	TM6000_AUDIO = 0x10,
268	TM6000_DVB = 0x20,
269};
270
271struct tm6000_ops {
272	struct list_head	next;
273	char			*name;
274	enum tm6000_ops_type	type;
275	int (*init)(struct tm6000_core *);
276	int (*fini)(struct tm6000_core *);
277	int (*fillbuf)(struct tm6000_core *, char *buf, int size);
278};
279
280struct tm6000_fh {
281	struct v4l2_fh		     fh;
282	struct tm6000_core           *dev;
283	unsigned int                 radio;
284
285	/* video capture */
286	struct tm6000_fmt            *fmt;
287	unsigned int                 width, height;
288	struct videobuf_queue        vb_vidq;
289
290	enum v4l2_buf_type           type;
291};
292
293#define TM6000_STD	(V4L2_STD_PAL|V4L2_STD_PAL_N|V4L2_STD_PAL_Nc|    \
294			V4L2_STD_PAL_M|V4L2_STD_PAL_60|V4L2_STD_NTSC_M| \
295			V4L2_STD_NTSC_M_JP|V4L2_STD_SECAM)
296
297/* In tm6000-cards.c */
298
299int tm6000_tuner_callback(void *ptr, int component, int command, int arg);
300int tm6000_xc5000_callback(void *ptr, int component, int command, int arg);
301int tm6000_cards_setup(struct tm6000_core *dev);
302void tm6000_flash_led(struct tm6000_core *dev, u8 state);
303
304/* In tm6000-core.c */
305
306int tm6000_read_write_usb(struct tm6000_core *dev, u8 reqtype, u8 req,
307			   u16 value, u16 index, u8 *buf, u16 len);
308int tm6000_get_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
309int tm6000_get_reg16(struct tm6000_core *dev, u8 req, u16 value, u16 index);
310int tm6000_get_reg32(struct tm6000_core *dev, u8 req, u16 value, u16 index);
311int tm6000_set_reg(struct tm6000_core *dev, u8 req, u16 value, u16 index);
312int tm6000_set_reg_mask(struct tm6000_core *dev, u8 req, u16 value,
313						u16 index, u16 mask);
314int tm6000_i2c_reset(struct tm6000_core *dev, u16 tsleep);
315int tm6000_init(struct tm6000_core *dev);
316int tm6000_reset(struct tm6000_core *dev);
317
318int tm6000_init_analog_mode(struct tm6000_core *dev);
319int tm6000_init_digital_mode(struct tm6000_core *dev);
320int tm6000_set_audio_bitrate(struct tm6000_core *dev, int bitrate);
321int tm6000_set_audio_rinput(struct tm6000_core *dev);
322int tm6000_tvaudio_set_mute(struct tm6000_core *dev, u8 mute);
323void tm6000_set_volume(struct tm6000_core *dev, int vol);
324
325int tm6000_v4l2_register(struct tm6000_core *dev);
326int tm6000_v4l2_unregister(struct tm6000_core *dev);
327int tm6000_v4l2_exit(void);
328void tm6000_set_fourcc_format(struct tm6000_core *dev);
329
330void tm6000_remove_from_devlist(struct tm6000_core *dev);
331void tm6000_add_into_devlist(struct tm6000_core *dev);
332int tm6000_register_extension(struct tm6000_ops *ops);
333void tm6000_unregister_extension(struct tm6000_ops *ops);
334void tm6000_init_extension(struct tm6000_core *dev);
335void tm6000_close_extension(struct tm6000_core *dev);
336int tm6000_call_fillbuf(struct tm6000_core *dev, enum tm6000_ops_type type,
337			char *buf, int size);
338
339
340/* In tm6000-stds.c */
341void tm6000_get_std_res(struct tm6000_core *dev);
342int tm6000_set_standard(struct tm6000_core *dev);
343
344/* In tm6000-i2c.c */
345int tm6000_i2c_register(struct tm6000_core *dev);
346int tm6000_i2c_unregister(struct tm6000_core *dev);
347
348/* In tm6000-queue.c */
349
350int tm6000_v4l2_mmap(struct file *filp, struct vm_area_struct *vma);
351
352int tm6000_vidioc_streamon(struct file *file, void *priv,
353			   enum v4l2_buf_type i);
354int tm6000_vidioc_streamoff(struct file *file, void *priv,
355			    enum v4l2_buf_type i);
356int tm6000_vidioc_reqbufs(struct file *file, void *priv,
357			  struct v4l2_requestbuffers *rb);
358int tm6000_vidioc_querybuf(struct file *file, void *priv,
359			   struct v4l2_buffer *b);
360int tm6000_vidioc_qbuf(struct file *file, void *priv, struct v4l2_buffer *b);
361int tm6000_vidioc_dqbuf(struct file *file, void *priv, struct v4l2_buffer *b);
362ssize_t tm6000_v4l2_read(struct file *filp, char __user * buf, size_t count,
363			 loff_t *f_pos);
364unsigned int tm6000_v4l2_poll(struct file *file,
365			      struct poll_table_struct *wait);
366int tm6000_queue_init(struct tm6000_core *dev);
367
368/* In tm6000-alsa.c */
369/*int tm6000_audio_init(struct tm6000_core *dev, int idx);*/
370
371/* In tm6000-input.c */
372int tm6000_ir_init(struct tm6000_core *dev);
373int tm6000_ir_fini(struct tm6000_core *dev);
374void tm6000_ir_wait(struct tm6000_core *dev, u8 state);
375int tm6000_ir_int_start(struct tm6000_core *dev);
376void tm6000_ir_int_stop(struct tm6000_core *dev);
377
378/* Debug stuff */
379
380extern int tm6000_debug;
381
382#define dprintk(dev, level, fmt, arg...) do {\
383	if (tm6000_debug & level) \
384		printk(KERN_INFO "(%lu) %s %s :"fmt, jiffies, \
385			 dev->name, __func__ , ##arg); } while (0)
386
387#define V4L2_DEBUG_REG		0x0004
388#define V4L2_DEBUG_I2C		0x0008
389#define V4L2_DEBUG_QUEUE	0x0010
390#define V4L2_DEBUG_ISOC		0x0020
391#define V4L2_DEBUG_RES_LOCK	0x0040	/* Resource locking */
392#define V4L2_DEBUG_OPEN		0x0080	/* video open/close debug */
393
394#define tm6000_err(fmt, arg...) do {\
395	printk(KERN_ERR "tm6000 %s :"fmt, \
396		__func__ , ##arg); } while (0)
397