1 /*
2  * Guillemot Maxi Radio FM 2000 PCI radio card driver for Linux
3  * (C) 2001 Dimitromanolakis Apostolos <apdim@grecian.net>
4  *
5  * Based in the radio Maestro PCI driver. Actually it uses the same chip
6  * for radio but different pci controller.
7  *
8  * I didn't have any specs I reversed engineered the protocol from
9  * the windows driver (radio.dll).
10  *
11  * The card uses the TEA5757 chip that includes a search function but it
12  * is useless as I haven't found any way to read back the frequency. If
13  * anybody does please mail me.
14  *
15  * For the pdf file see:
16  * http://www.semiconductors.philips.com/pip/TEA5757H/V1
17  *
18  *
19  * CHANGES:
20  *   0.75b
21  *     - better pci interface thanks to Francois Romieu <romieu@cogenit.fr>
22  *
23  *   0.75
24  *     - tiding up
25  *     - removed support for multiple devices as it didn't work anyway
26  *
27  * BUGS:
28  *   - card unmutes if you change frequency
29  *
30  */
31 
32 
33 #include <linux/module.h>
34 #include <linux/init.h>
35 #include <linux/ioport.h>
36 #include <linux/delay.h>
37 #include <linux/sched.h>
38 #include <asm/io.h>
39 #include <asm/uaccess.h>
40 #include <asm/semaphore.h>
41 #include <linux/pci.h>
42 #include <linux/videodev.h>
43 
44 /* version 0.75      Sun Feb  4 22:51:27 EET 2001 */
45 #define DRIVER_VERSION	"0.75"
46 
47 #ifndef PCI_VENDOR_ID_GUILLEMOT
48 #define PCI_VENDOR_ID_GUILLEMOT 0x5046
49 #endif
50 
51 #ifndef PCI_DEVICE_ID_GUILLEMOT
52 #define PCI_DEVICE_ID_GUILLEMOT_MAXIRADIO 0x1001
53 #endif
54 
55 
56 /* TEA5757 pin mappings */
57 static const int clk = 1, data = 2, wren = 4, mo_st = 8, power = 16 ;
58 
59 static int radio_nr = -1;
60 module_param(radio_nr, int, 0);
61 
62 
63 #define FREQ_LO		 50*16000
64 #define FREQ_HI		150*16000
65 
66 #define FREQ_IF         171200 /* 10.7*16000   */
67 #define FREQ_STEP       200    /* 12.5*16      */
68 
69 #define FREQ2BITS(x)	((( (unsigned int)(x)+FREQ_IF+(FREQ_STEP<<1))\
70 			/(FREQ_STEP<<2))<<2) /* (x==fmhz*16*1000) -> bits */
71 
72 #define BITS2FREQ(x)	((x) * FREQ_STEP - FREQ_IF)
73 
74 
75 static int radio_ioctl(struct inode *inode, struct file *file,
76 		       unsigned int cmd, unsigned long arg);
77 
78 static struct file_operations maxiradio_fops = {
79 	.owner		= THIS_MODULE,
80 	.open           = video_exclusive_open,
81 	.release        = video_exclusive_release,
82 	.ioctl	        = radio_ioctl,
83 	.compat_ioctl	= v4l_compat_ioctl32,
84 	.llseek         = no_llseek,
85 };
86 static struct video_device maxiradio_radio =
87 {
88 	.owner		= THIS_MODULE,
89 	.name		= "Maxi Radio FM2000 radio",
90 	.type		= VID_TYPE_TUNER,
91 	.hardware	= VID_HARDWARE_SF16MI,
92 	.fops           = &maxiradio_fops,
93 };
94 
95 static struct radio_device
96 {
97 	__u16	io,	/* base of radio io */
98 		muted,	/* VIDEO_AUDIO_MUTE */
99 		stereo,	/* VIDEO_TUNER_STEREO_ON */
100 		tuned;	/* signal strength (0 or 0xffff) */
101 
102 	unsigned long freq;
103 
104 	struct  semaphore lock;
105 } radio_unit = {0, 0, 0, 0, };
106 
107 
108 static void outbit(unsigned long bit, __u16 io)
109 {
110 	if(bit != 0)
111 		{
112 			outb(  power|wren|data     ,io); udelay(4);
113 			outb(  power|wren|data|clk ,io); udelay(4);
114 			outb(  power|wren|data     ,io); udelay(4);
115 		}
116 	else
117 		{
118 			outb(  power|wren          ,io); udelay(4);
119 			outb(  power|wren|clk      ,io); udelay(4);
120 			outb(  power|wren          ,io); udelay(4);
121 		}
122 }
123 
124 static void turn_power(__u16 io, int p)
125 {
126 	if(p != 0) outb(power, io); else outb(0,io);
127 }
128 
129 
130 static void set_freq(__u16 io, __u32 data)
131 {
132 	unsigned long int si;
133 	int bl;
134 
135 	/* TEA5757 shift register bits (see pdf) */
136 
137 	outbit(0,io); // 24  search
138 	outbit(1,io); // 23  search up/down
139 
140 	outbit(0,io); // 22  stereo/mono
141 
142 	outbit(0,io); // 21  band
143 	outbit(0,io); // 20  band (only 00=FM works I think)
144 
145 	outbit(0,io); // 19  port ?
146 	outbit(0,io); // 18  port ?
147 
148 	outbit(0,io); // 17  search level
149 	outbit(0,io); // 16  search level
150 
151 	si = 0x8000;
152 	for(bl = 1; bl <= 16 ; bl++) { outbit(data & si,io); si >>=1; }
153 
154 	outb(power,io);
155 }
156 
157 static int get_stereo(__u16 io)
158 {
159 	outb(power,io); udelay(4);
160 	return !(inb(io) & mo_st);
161 }
162 
163 static int get_tune(__u16 io)
164 {
165 	outb(power+clk,io); udelay(4);
166 	return !(inb(io) & mo_st);
167 }
168 
169 
170 static inline int radio_function(struct inode *inode, struct file *file,
171 				 unsigned int cmd, void *arg)
172 {
173 	struct video_device *dev = video_devdata(file);
174 	struct radio_device *card=dev->priv;
175 
176 	switch(cmd) {
177 		case VIDIOCGCAP: {
178 			struct video_capability *v = arg;
179 
180 			memset(v,0,sizeof(*v));
181 			strcpy(v->name, "Maxi Radio FM2000 radio");
182 			v->type=VID_TYPE_TUNER;
183 			v->channels=v->audios=1;
184 			return 0;
185 		}
186 		case VIDIOCGTUNER: {
187 			struct video_tuner *v = arg;
188 
189 			if(v->tuner)
190 				return -EINVAL;
191 
192 			card->stereo = 0xffff * get_stereo(card->io);
193 			card->tuned = 0xffff * get_tune(card->io);
194 
195 			v->flags = VIDEO_TUNER_LOW | card->stereo;
196 			v->signal = card->tuned;
197 
198 			strcpy(v->name, "FM");
199 
200 			v->rangelow = FREQ_LO;
201 			v->rangehigh = FREQ_HI;
202 			v->mode = VIDEO_MODE_AUTO;
203 
204 			return 0;
205 		}
206 		case VIDIOCSTUNER: {
207 			struct video_tuner *v = arg;
208 			if(v->tuner!=0)
209 				return -EINVAL;
210 			return 0;
211 		}
212 		case VIDIOCGFREQ: {
213 			unsigned long *freq = arg;
214 
215 			*freq = card->freq;
216 			return 0;
217 		}
218 		case VIDIOCSFREQ: {
219 			unsigned long *freq = arg;
220 
221 			if (*freq < FREQ_LO || *freq > FREQ_HI)
222 				return -EINVAL;
223 			card->freq = *freq;
224 			set_freq(card->io, FREQ2BITS(card->freq));
225 			msleep(125);
226 			return 0;
227 		}
228 		case VIDIOCGAUDIO: {
229 			struct video_audio *v = arg;
230 			memset(v,0,sizeof(*v));
231 			strcpy(v->name, "Radio");
232 			v->flags=VIDEO_AUDIO_MUTABLE | card->muted;
233 			v->mode=VIDEO_SOUND_STEREO;
234 			return 0;
235 		}
236 
237 		case VIDIOCSAUDIO: {
238 			struct video_audio *v = arg;
239 
240 			if(v->audio)
241 				return -EINVAL;
242 			card->muted = v->flags & VIDEO_AUDIO_MUTE;
243 			if(card->muted)
244 				turn_power(card->io, 0);
245 			else
246 				set_freq(card->io, FREQ2BITS(card->freq));
247 			return 0;
248 		}
249 		case VIDIOCGUNIT: {
250 			struct video_unit *v = arg;
251 
252 			v->video=VIDEO_NO_UNIT;
253 			v->vbi=VIDEO_NO_UNIT;
254 			v->radio=dev->minor;
255 			v->audio=0;
256 			v->teletext=VIDEO_NO_UNIT;
257 			return 0;
258 		}
259 		default: return -ENOIOCTLCMD;
260 	}
261 }
262 
263 static int radio_ioctl(struct inode *inode, struct file *file,
264 		       unsigned int cmd, unsigned long arg)
265 {
266 	struct video_device *dev = video_devdata(file);
267 	struct radio_device *card=dev->priv;
268 	int ret;
269 
270 	down(&card->lock);
271 	ret = video_usercopy(inode, file, cmd, arg, radio_function);
272 	up(&card->lock);
273 	return ret;
274 }
275 
276 MODULE_AUTHOR("Dimitromanolakis Apostolos, apdim@grecian.net");
277 MODULE_DESCRIPTION("Radio driver for the Guillemot Maxi Radio FM2000 radio.");
278 MODULE_LICENSE("GPL");
279 
280 
281 static int __devinit maxiradio_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
282 {
283 	if(!request_region(pci_resource_start(pdev, 0),
284 	                   pci_resource_len(pdev, 0), "Maxi Radio FM 2000")) {
285 	        printk(KERN_ERR "radio-maxiradio: can't reserve I/O ports\n");
286 	        goto err_out;
287 	}
288 
289 	if (pci_enable_device(pdev))
290 	        goto err_out_free_region;
291 
292 	radio_unit.io = pci_resource_start(pdev, 0);
293 	init_MUTEX(&radio_unit.lock);
294 	maxiradio_radio.priv = &radio_unit;
295 
296 	if(video_register_device(&maxiradio_radio, VFL_TYPE_RADIO, radio_nr)==-1) {
297 	        printk("radio-maxiradio: can't register device!");
298 	        goto err_out_free_region;
299 	}
300 
301 	printk(KERN_INFO "radio-maxiradio: version "
302 	       DRIVER_VERSION
303 	       " time "
304 	       __TIME__ "  "
305 	       __DATE__
306 	       "\n");
307 
308 	printk(KERN_INFO "radio-maxiradio: found Guillemot MAXI Radio device (io = 0x%x)\n",
309 	       radio_unit.io);
310 	return 0;
311 
312 err_out_free_region:
313 	release_region(pci_resource_start(pdev, 0), pci_resource_len(pdev, 0));
314 err_out:
315 	return -ENODEV;
316 }
317 
318 static void __devexit maxiradio_remove_one(struct pci_dev *pdev)
319 {
320 	video_unregister_device(&maxiradio_radio);
321 	release_region(pci_resource_start(pdev, 0), pci_resource_len(pdev, 0));
322 }
323 
324 static struct pci_device_id maxiradio_pci_tbl[] = {
325 	{ PCI_VENDOR_ID_GUILLEMOT, PCI_DEVICE_ID_GUILLEMOT_MAXIRADIO,
326 		PCI_ANY_ID, PCI_ANY_ID, },
327 	{ 0,}
328 };
329 
330 MODULE_DEVICE_TABLE(pci, maxiradio_pci_tbl);
331 
332 static struct pci_driver maxiradio_driver = {
333 	.name		= "radio-maxiradio",
334 	.id_table	= maxiradio_pci_tbl,
335 	.probe		= maxiradio_init_one,
336 	.remove		= __devexit_p(maxiradio_remove_one),
337 };
338 
339 static int __init maxiradio_radio_init(void)
340 {
341 	return pci_register_driver(&maxiradio_driver);
342 }
343 
344 static void __exit maxiradio_radio_exit(void)
345 {
346 	pci_unregister_driver(&maxiradio_driver);
347 }
348 
349 module_init(maxiradio_radio_init);
350 module_exit(maxiradio_radio_exit);
351