1 /*
2  * STK1160 driver
3  *
4  * Copyright (C) 2012 Ezequiel Garcia
5  * <elezegarcia--a.t--gmail.com>
6  *
7  * Based on Easycap driver by R.M. Thomas
8  *	Copyright (C) 2010 R.M. Thomas
9  *	<rmthomas--a.t--sciolus.org>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  */
22 
23 #include <linux/i2c.h>
24 #include <sound/core.h>
25 #include <sound/ac97_codec.h>
26 #include <media/videobuf2-v4l2.h>
27 #include <media/v4l2-device.h>
28 #include <media/v4l2-ctrls.h>
29 
30 #define STK1160_VERSION		"0.9.5"
31 #define STK1160_VERSION_NUM	0x000905
32 
33 /* Decide on number of packets for each buffer */
34 #define STK1160_NUM_PACKETS 64
35 
36 /* Number of buffers for isoc transfers */
37 #define STK1160_NUM_BUFS 16
38 #define STK1160_MIN_BUFS 1
39 
40 /* TODO: This endpoint address should be retrieved */
41 #define STK1160_EP_VIDEO 0x82
42 #define STK1160_EP_AUDIO 0x81
43 
44 /* Max and min video buffers */
45 #define STK1160_MIN_VIDEO_BUFFERS 8
46 #define STK1160_MAX_VIDEO_BUFFERS 32
47 
48 #define STK1160_MIN_PKT_SIZE 3072
49 
50 #define STK1160_MAX_INPUT 4
51 #define STK1160_SVIDEO_INPUT 4
52 
53 #define STK1160_AC97_TIMEOUT 50
54 
55 #define STK1160_I2C_TIMEOUT 100
56 
57 /* TODO: Print helpers
58  * I could use dev_xxx, pr_xxx, v4l2_xxx or printk.
59  * However, there isn't a solid consensus on which
60  * new drivers should use.
61  *
62  */
63 #ifdef DEBUG
64 #define stk1160_dbg(fmt, args...) \
65 	printk(KERN_DEBUG "stk1160: " fmt,  ## args)
66 #else
67 #define stk1160_dbg(fmt, args...)
68 #endif
69 
70 #define stk1160_info(fmt, args...) \
71 	pr_info("stk1160: " fmt, ## args)
72 
73 #define stk1160_warn(fmt, args...) \
74 	pr_warn("stk1160: " fmt, ## args)
75 
76 #define stk1160_err(fmt, args...) \
77 	pr_err("stk1160: " fmt, ## args)
78 
79 /* Buffer for one video frame */
80 struct stk1160_buffer {
81 	/* common v4l buffer stuff -- must be first */
82 	struct vb2_v4l2_buffer vb;
83 	struct list_head list;
84 
85 	void *mem;
86 	unsigned int length;		/* buffer length */
87 	unsigned int bytesused;		/* bytes written */
88 	int odd;			/* current oddity */
89 
90 	/*
91 	 * Since we interlace two fields per frame,
92 	 * this is different from bytesused.
93 	 */
94 	unsigned int pos;		/* current pos inside buffer */
95 };
96 
97 struct stk1160_isoc_ctl {
98 	/* max packet size of isoc transaction */
99 	int max_pkt_size;
100 
101 	/* number of allocated urbs */
102 	int num_bufs;
103 
104 	/* urb for isoc transfers */
105 	struct urb **urb;
106 
107 	/* transfer buffers for isoc transfer */
108 	char **transfer_buffer;
109 
110 	/* current buffer */
111 	struct stk1160_buffer *buf;
112 };
113 
114 struct stk1160_fmt {
115 	char  *name;
116 	u32   fourcc;          /* v4l2 format id */
117 	int   depth;
118 };
119 
120 struct stk1160 {
121 	struct v4l2_device v4l2_dev;
122 	struct video_device vdev;
123 	struct v4l2_ctrl_handler ctrl_handler;
124 
125 	struct device *dev;
126 	struct usb_device *udev;
127 
128 	/* saa7115 subdev */
129 	struct v4l2_subdev *sd_saa7115;
130 
131 	/* isoc control struct */
132 	struct list_head avail_bufs;
133 
134 	/* video capture */
135 	struct vb2_queue vb_vidq;
136 
137 	/* max packet size of isoc transaction */
138 	int max_pkt_size;
139 	/* array of wMaxPacketSize */
140 	unsigned int *alt_max_pkt_size;
141 	/* alternate */
142 	int alt;
143 	/* Number of alternative settings */
144 	int num_alt;
145 
146 	struct stk1160_isoc_ctl isoc_ctl;
147 
148 	/* frame properties */
149 	int width;		  /* current frame width */
150 	int height;		  /* current frame height */
151 	unsigned int ctl_input;	  /* selected input */
152 	v4l2_std_id norm;	  /* current norm */
153 	struct stk1160_fmt *fmt;  /* selected format */
154 
155 	unsigned int sequence;
156 
157 	/* i2c i/o */
158 	struct i2c_adapter i2c_adap;
159 	struct i2c_client i2c_client;
160 
161 	struct mutex v4l_lock;
162 	struct mutex vb_queue_lock;
163 	spinlock_t buf_lock;
164 
165 	struct file *fh_owner;	/* filehandle ownership */
166 
167 	/* EXPERIMENTAL */
168 	struct snd_card *snd_card;
169 };
170 
171 struct regval {
172 	u16 reg;
173 	u16 val;
174 };
175 
176 /* Provided by stk1160-v4l.c */
177 int stk1160_vb2_setup(struct stk1160 *dev);
178 int stk1160_video_register(struct stk1160 *dev);
179 void stk1160_video_unregister(struct stk1160 *dev);
180 void stk1160_clear_queue(struct stk1160 *dev);
181 
182 /* Provided by stk1160-video.c */
183 int stk1160_alloc_isoc(struct stk1160 *dev);
184 void stk1160_free_isoc(struct stk1160 *dev);
185 void stk1160_cancel_isoc(struct stk1160 *dev);
186 void stk1160_uninit_isoc(struct stk1160 *dev);
187 
188 /* Provided by stk1160-i2c.c */
189 int stk1160_i2c_register(struct stk1160 *dev);
190 int stk1160_i2c_unregister(struct stk1160 *dev);
191 
192 /* Provided by stk1160-core.c */
193 int stk1160_read_reg(struct stk1160 *dev, u16 reg, u8 *value);
194 int stk1160_write_reg(struct stk1160 *dev, u16 reg, u16 value);
195 int stk1160_write_regs_req(struct stk1160 *dev, u8 req, u16 reg,
196 		char *buf, int len);
197 int stk1160_read_reg_req_len(struct stk1160 *dev, u8 req, u16 reg,
198 		char *buf, int len);
199 void stk1160_select_input(struct stk1160 *dev);
200 
201 /* Provided by stk1160-ac97.c */
202 void stk1160_ac97_setup(struct stk1160 *dev);
203