109c434b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
2cc3c6df1SHans Verkuil /*
3cc3c6df1SHans Verkuil * AimsLab RadioTrack (aka RadioVeveal) driver
4cc3c6df1SHans Verkuil *
5cc3c6df1SHans Verkuil * Copyright 1997 M. Kirkwood
6cc3c6df1SHans Verkuil *
7cc3c6df1SHans Verkuil * Converted to the radio-isa framework by Hans Verkuil <hans.verkuil@cisco.com>
832590819SMauro Carvalho Chehab * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@kernel.org>
9d9b01449SAlan Cox * Converted to new API by Alan Cox <alan@lxorguk.ukuu.org.uk>
101da177e4SLinus Torvalds * Various bugfixes and enhancements by Russell Kroll <rkroll@exploits.org>
111da177e4SLinus Torvalds *
121da177e4SLinus Torvalds * Notes on the hardware (reverse engineered from other peoples'
131da177e4SLinus Torvalds * reverse engineering of AIMS' code :-)
141da177e4SLinus Torvalds *
151da177e4SLinus Torvalds * Frequency control is done digitally -- ie out(port,encodefreq(95.8));
161da177e4SLinus Torvalds *
171da177e4SLinus Torvalds * The signal strength query is unsurprisingly inaccurate. And it seems
181da177e4SLinus Torvalds * to indicate that (on my card, at least) the frequency setting isn't
191da177e4SLinus Torvalds * too great. (I have to tune up .025MHz from what the freq should be
201da177e4SLinus Torvalds * to get a report that the thing is tuned.)
211da177e4SLinus Torvalds *
221da177e4SLinus Torvalds * Volume control is (ugh) analogue:
231da177e4SLinus Torvalds * out(port, start_increasing_volume);
241da177e4SLinus Torvalds * wait(a_wee_while);
251da177e4SLinus Torvalds * out(port, stop_changing_the_volume);
261da177e4SLinus Torvalds *
27cc3c6df1SHans Verkuil * Fully tested with the Keene USB FM Transmitter and the v4l2-compliance tool.
281da177e4SLinus Torvalds */
291da177e4SLinus Torvalds
301da177e4SLinus Torvalds #include <linux/module.h> /* Modules */
311da177e4SLinus Torvalds #include <linux/init.h> /* Initdata */
32fb911ee8SPeter Osterlund #include <linux/ioport.h> /* request_region */
332400982aSGeert Uytterhoeven #include <linux/delay.h> /* msleep */
3446ff2c72SMauro Carvalho Chehab #include <linux/videodev2.h> /* kernel radio structs */
35151c3f82SHans Verkuil #include <linux/io.h> /* outb, outb_p */
369f1dfccfSHans Verkuil #include <linux/slab.h>
37151c3f82SHans Verkuil #include <media/v4l2-device.h>
3835ea11ffSHans Verkuil #include <media/v4l2-ioctl.h>
39cc3c6df1SHans Verkuil #include <media/v4l2-ctrls.h>
40cc3c6df1SHans Verkuil #include "radio-isa.h"
4139cca6b8SOndrej Zary #include "lm7000.h"
421da177e4SLinus Torvalds
43151c3f82SHans Verkuil MODULE_AUTHOR("M. Kirkwood");
44151c3f82SHans Verkuil MODULE_DESCRIPTION("A driver for the RadioTrack/RadioReveal radio card.");
45151c3f82SHans Verkuil MODULE_LICENSE("GPL");
46cc3c6df1SHans Verkuil MODULE_VERSION("1.0.0");
4746ff2c72SMauro Carvalho Chehab
481da177e4SLinus Torvalds #ifndef CONFIG_RADIO_RTRACK_PORT
491da177e4SLinus Torvalds #define CONFIG_RADIO_RTRACK_PORT -1
501da177e4SLinus Torvalds #endif
511da177e4SLinus Torvalds
52cc3c6df1SHans Verkuil #define RTRACK_MAX 2
531da177e4SLinus Torvalds
54cc3c6df1SHans Verkuil static int io[RTRACK_MAX] = { [0] = CONFIG_RADIO_RTRACK_PORT,
55cc3c6df1SHans Verkuil [1 ... (RTRACK_MAX - 1)] = -1 };
56cc3c6df1SHans Verkuil static int radio_nr[RTRACK_MAX] = { [0 ... (RTRACK_MAX - 1)] = -1 };
57151c3f82SHans Verkuil
58cc3c6df1SHans Verkuil module_param_array(io, int, NULL, 0444);
59cc3c6df1SHans Verkuil MODULE_PARM_DESC(io, "I/O addresses of the RadioTrack card (0x20f or 0x30f)");
60cc3c6df1SHans Verkuil module_param_array(radio_nr, int, NULL, 0444);
61cc3c6df1SHans Verkuil MODULE_PARM_DESC(radio_nr, "Radio device numbers");
62cc3c6df1SHans Verkuil
63cc3c6df1SHans Verkuil struct rtrack {
64cc3c6df1SHans Verkuil struct radio_isa_card isa;
651da177e4SLinus Torvalds int curvol;
661da177e4SLinus Torvalds };
671da177e4SLinus Torvalds
rtrack_alloc(void)68cc3c6df1SHans Verkuil static struct radio_isa_card *rtrack_alloc(void)
691da177e4SLinus Torvalds {
70cc3c6df1SHans Verkuil struct rtrack *rt = kzalloc(sizeof(struct rtrack), GFP_KERNEL);
71cc3c6df1SHans Verkuil
728f7fa3c8SMauro Carvalho Chehab if (rt)
73cc3c6df1SHans Verkuil rt->curvol = 0xff;
74cc3c6df1SHans Verkuil return rt ? &rt->isa : NULL;
751da177e4SLinus Torvalds }
761da177e4SLinus Torvalds
7739cca6b8SOndrej Zary #define AIMS_BIT_TUN_CE (1 << 0)
7839cca6b8SOndrej Zary #define AIMS_BIT_TUN_CLK (1 << 1)
7939cca6b8SOndrej Zary #define AIMS_BIT_TUN_DATA (1 << 2)
8039cca6b8SOndrej Zary #define AIMS_BIT_VOL_CE (1 << 3)
8139cca6b8SOndrej Zary #define AIMS_BIT_TUN_STRQ (1 << 4)
8239cca6b8SOndrej Zary /* bit 5 is not connected */
8339cca6b8SOndrej Zary #define AIMS_BIT_VOL_UP (1 << 6) /* active low */
8439cca6b8SOndrej Zary #define AIMS_BIT_VOL_DN (1 << 7) /* active low */
858f7fa3c8SMauro Carvalho Chehab
rtrack_set_pins(void * handle,u8 pins)86f6d15e09SMauro Carvalho Chehab static void rtrack_set_pins(void *handle, u8 pins)
878f7fa3c8SMauro Carvalho Chehab {
8839cca6b8SOndrej Zary struct radio_isa_card *isa = handle;
8939cca6b8SOndrej Zary struct rtrack *rt = container_of(isa, struct rtrack, isa);
9039cca6b8SOndrej Zary u8 bits = AIMS_BIT_VOL_DN | AIMS_BIT_VOL_UP | AIMS_BIT_TUN_STRQ;
918f7fa3c8SMauro Carvalho Chehab
9239cca6b8SOndrej Zary if (!v4l2_ctrl_g_ctrl(rt->isa.mute))
9339cca6b8SOndrej Zary bits |= AIMS_BIT_VOL_CE;
9439cca6b8SOndrej Zary
9539cca6b8SOndrej Zary if (pins & LM7000_DATA)
9639cca6b8SOndrej Zary bits |= AIMS_BIT_TUN_DATA;
9739cca6b8SOndrej Zary if (pins & LM7000_CLK)
9839cca6b8SOndrej Zary bits |= AIMS_BIT_TUN_CLK;
9939cca6b8SOndrej Zary if (pins & LM7000_CE)
10039cca6b8SOndrej Zary bits |= AIMS_BIT_TUN_CE;
10139cca6b8SOndrej Zary
10239cca6b8SOndrej Zary outb_p(bits, rt->isa.io);
1038f7fa3c8SMauro Carvalho Chehab }
1048f7fa3c8SMauro Carvalho Chehab
rtrack_s_frequency(struct radio_isa_card * isa,u32 freq)105cc3c6df1SHans Verkuil static int rtrack_s_frequency(struct radio_isa_card *isa, u32 freq)
1061da177e4SLinus Torvalds {
10739cca6b8SOndrej Zary lm7000_set_freq(freq, isa, rtrack_set_pins);
1081da177e4SLinus Torvalds
1091da177e4SLinus Torvalds return 0;
1101da177e4SLinus Torvalds }
1111da177e4SLinus Torvalds
rtrack_g_signal(struct radio_isa_card * isa)112cc3c6df1SHans Verkuil static u32 rtrack_g_signal(struct radio_isa_card *isa)
1131da177e4SLinus Torvalds {
114cc3c6df1SHans Verkuil /* bit set = no signal present */
115cc3c6df1SHans Verkuil return 0xffff * !(inb(isa->io) & 2);
11646ff2c72SMauro Carvalho Chehab }
11746ff2c72SMauro Carvalho Chehab
rtrack_s_mute_volume(struct radio_isa_card * isa,bool mute,int vol)118cc3c6df1SHans Verkuil static int rtrack_s_mute_volume(struct radio_isa_card *isa, bool mute, int vol)
1191da177e4SLinus Torvalds {
120cc3c6df1SHans Verkuil struct rtrack *rt = container_of(isa, struct rtrack, isa);
121cc3c6df1SHans Verkuil int curvol = rt->curvol;
122cc3c6df1SHans Verkuil
123cc3c6df1SHans Verkuil if (mute) {
124cc3c6df1SHans Verkuil outb(0xd0, isa->io); /* volume steady + sigstr + off */
125cc3c6df1SHans Verkuil return 0;
126cc3c6df1SHans Verkuil }
127cc3c6df1SHans Verkuil if (vol == 0) { /* volume = 0 means mute the card */
128cc3c6df1SHans Verkuil outb(0x48, isa->io); /* volume down but still "on" */
129cc3c6df1SHans Verkuil msleep(curvol * 3); /* make sure it's totally down */
130cc3c6df1SHans Verkuil } else if (curvol < vol) {
131cc3c6df1SHans Verkuil outb(0x98, isa->io); /* volume up + sigstr + on */
132cc3c6df1SHans Verkuil for (; curvol < vol; curvol++)
133cc287f7cSArnd Bergmann mdelay(3);
134cc3c6df1SHans Verkuil } else if (curvol > vol) {
135cc3c6df1SHans Verkuil outb(0x58, isa->io); /* volume down + sigstr + on */
136cc3c6df1SHans Verkuil for (; curvol > vol; curvol--)
137cc287f7cSArnd Bergmann mdelay(3);
138cc3c6df1SHans Verkuil }
139cc3c6df1SHans Verkuil outb(0xd8, isa->io); /* volume steady + sigstr + on */
140cc3c6df1SHans Verkuil rt->curvol = vol;
1411da177e4SLinus Torvalds return 0;
1421da177e4SLinus Torvalds }
143385e8d8fSDouglas Landgraf
144cc3c6df1SHans Verkuil /* Mute card - prevents noisy bootups */
rtrack_initialize(struct radio_isa_card * isa)145cc3c6df1SHans Verkuil static int rtrack_initialize(struct radio_isa_card *isa)
1461da177e4SLinus Torvalds {
147cc3c6df1SHans Verkuil /* this ensures that the volume is all the way up */
148cc3c6df1SHans Verkuil outb(0x90, isa->io); /* volume up but still "on" */
149cc3c6df1SHans Verkuil msleep(3000); /* make sure it's totally up */
150cc3c6df1SHans Verkuil outb(0xc0, isa->io); /* steady volume, mute card */
1511da177e4SLinus Torvalds return 0;
1521da177e4SLinus Torvalds }
15346ff2c72SMauro Carvalho Chehab
154cc3c6df1SHans Verkuil static const struct radio_isa_ops rtrack_ops = {
155cc3c6df1SHans Verkuil .alloc = rtrack_alloc,
156cc3c6df1SHans Verkuil .init = rtrack_initialize,
157cc3c6df1SHans Verkuil .s_mute_volume = rtrack_s_mute_volume,
158cc3c6df1SHans Verkuil .s_frequency = rtrack_s_frequency,
159cc3c6df1SHans Verkuil .g_signal = rtrack_g_signal,
1601da177e4SLinus Torvalds };
1611da177e4SLinus Torvalds
162cc3c6df1SHans Verkuil static const int rtrack_ioports[] = { 0x20f, 0x30f };
163cc3c6df1SHans Verkuil
164cc3c6df1SHans Verkuil static struct radio_isa_driver rtrack_driver = {
165cc3c6df1SHans Verkuil .driver = {
166cc3c6df1SHans Verkuil .match = radio_isa_match,
167cc3c6df1SHans Verkuil .probe = radio_isa_probe,
168cc3c6df1SHans Verkuil .remove = radio_isa_remove,
169cc3c6df1SHans Verkuil .driver = {
170cc3c6df1SHans Verkuil .name = "radio-aimslab",
171cc3c6df1SHans Verkuil },
172cc3c6df1SHans Verkuil },
173cc3c6df1SHans Verkuil .io_params = io,
174cc3c6df1SHans Verkuil .radio_nr_params = radio_nr,
175cc3c6df1SHans Verkuil .io_ports = rtrack_ioports,
176cc3c6df1SHans Verkuil .num_of_io_ports = ARRAY_SIZE(rtrack_ioports),
177cc3c6df1SHans Verkuil .region_size = 2,
178cc3c6df1SHans Verkuil .card = "AIMSlab RadioTrack/RadioReveal",
179cc3c6df1SHans Verkuil .ops = &rtrack_ops,
180cc3c6df1SHans Verkuil .has_stereo = true,
181cc3c6df1SHans Verkuil .max_volume = 0xff,
1821da177e4SLinus Torvalds };
1831da177e4SLinus Torvalds
rtrack_init(void)1841da177e4SLinus Torvalds static int __init rtrack_init(void)
1851da177e4SLinus Torvalds {
186cc3c6df1SHans Verkuil return isa_register_driver(&rtrack_driver.driver, RTRACK_MAX);
1871da177e4SLinus Torvalds }
1881da177e4SLinus Torvalds
rtrack_exit(void)189151c3f82SHans Verkuil static void __exit rtrack_exit(void)
1901da177e4SLinus Torvalds {
191cc3c6df1SHans Verkuil isa_unregister_driver(&rtrack_driver.driver);
1921da177e4SLinus Torvalds }
1931da177e4SLinus Torvalds
1941da177e4SLinus Torvalds module_init(rtrack_init);
195151c3f82SHans Verkuil module_exit(rtrack_exit);
196