Orange Pi5 kernel

Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards

3 Commits   0 Branches   0 Tags
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) // SPDX-License-Identifier: GPL-2.0-only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3)  * AimsLab RadioTrack (aka RadioVeveal) driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5)  * Copyright 1997 M. Kirkwood
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7)  * Converted to the radio-isa framework by Hans Verkuil <hans.verkuil@cisco.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8)  * Converted to V4L2 API by Mauro Carvalho Chehab <mchehab@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9)  * Converted to new API by Alan Cox <alan@lxorguk.ukuu.org.uk>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10)  * Various bugfixes and enhancements by Russell Kroll <rkroll@exploits.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12)  * Notes on the hardware (reverse engineered from other peoples'
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13)  * reverse engineering of AIMS' code :-)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15)  *  Frequency control is done digitally -- ie out(port,encodefreq(95.8));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17)  *  The signal strength query is unsurprisingly inaccurate.  And it seems
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18)  *  to indicate that (on my card, at least) the frequency setting isn't
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19)  *  too great.  (I have to tune up .025MHz from what the freq should be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20)  *  to get a report that the thing is tuned.)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22)  *  Volume control is (ugh) analogue:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23)  *   out(port, start_increasing_volume);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24)  *   wait(a_wee_while);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25)  *   out(port, stop_changing_the_volume);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26)  *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27)  * Fully tested with the Keene USB FM Transmitter and the v4l2-compliance tool.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28)  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) #include <linux/module.h>	/* Modules			*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) #include <linux/init.h>		/* Initdata			*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) #include <linux/ioport.h>	/* request_region		*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) #include <linux/delay.h>	/* msleep			*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) #include <linux/videodev2.h>	/* kernel radio structs		*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35) #include <linux/io.h>		/* outb, outb_p			*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) #include <linux/slab.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) #include <media/v4l2-device.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) #include <media/v4l2-ioctl.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) #include <media/v4l2-ctrls.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) #include "radio-isa.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) #include "lm7000.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) MODULE_AUTHOR("M. Kirkwood");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44) MODULE_DESCRIPTION("A driver for the RadioTrack/RadioReveal radio card.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) MODULE_LICENSE("GPL");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46) MODULE_VERSION("1.0.0");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48) #ifndef CONFIG_RADIO_RTRACK_PORT
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) #define CONFIG_RADIO_RTRACK_PORT -1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52) #define RTRACK_MAX 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54) static int io[RTRACK_MAX] = { [0] = CONFIG_RADIO_RTRACK_PORT,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) 			      [1 ... (RTRACK_MAX - 1)] = -1 };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56) static int radio_nr[RTRACK_MAX]	= { [0 ... (RTRACK_MAX - 1)] = -1 };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) module_param_array(io, int, NULL, 0444);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59) MODULE_PARM_DESC(io, "I/O addresses of the RadioTrack card (0x20f or 0x30f)");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60) module_param_array(radio_nr, int, NULL, 0444);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) MODULE_PARM_DESC(radio_nr, "Radio device numbers");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63) struct rtrack {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64) 	struct radio_isa_card isa;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) 	int curvol;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68) static struct radio_isa_card *rtrack_alloc(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) 	struct rtrack *rt = kzalloc(sizeof(struct rtrack), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) 	if (rt)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 		rt->curvol = 0xff;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) 	return rt ? &rt->isa : NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) #define AIMS_BIT_TUN_CE		(1 << 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) #define AIMS_BIT_TUN_CLK	(1 << 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79) #define AIMS_BIT_TUN_DATA	(1 << 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80) #define AIMS_BIT_VOL_CE		(1 << 3)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81) #define AIMS_BIT_TUN_STRQ	(1 << 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82) /* bit 5 is not connected */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83) #define AIMS_BIT_VOL_UP		(1 << 6)	/* active low */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) #define AIMS_BIT_VOL_DN		(1 << 7)	/* active low */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86) static void rtrack_set_pins(void *handle, u8 pins)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88) 	struct radio_isa_card *isa = handle;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89) 	struct rtrack *rt = container_of(isa, struct rtrack, isa);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90) 	u8 bits = AIMS_BIT_VOL_DN | AIMS_BIT_VOL_UP | AIMS_BIT_TUN_STRQ;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92) 	if (!v4l2_ctrl_g_ctrl(rt->isa.mute))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 		bits |= AIMS_BIT_VOL_CE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) 	if (pins & LM7000_DATA)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 		bits |= AIMS_BIT_TUN_DATA;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 	if (pins & LM7000_CLK)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 		bits |= AIMS_BIT_TUN_CLK;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) 	if (pins & LM7000_CE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) 		bits |= AIMS_BIT_TUN_CE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) 	outb_p(bits, rt->isa.io);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) static int rtrack_s_frequency(struct radio_isa_card *isa, u32 freq)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) 	lm7000_set_freq(freq, isa, rtrack_set_pins);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) static u32 rtrack_g_signal(struct radio_isa_card *isa)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) 	/* bit set = no signal present */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) 	return 0xffff * !(inb(isa->io) & 2);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) static int rtrack_s_mute_volume(struct radio_isa_card *isa, bool mute, int vol)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) 	struct rtrack *rt = container_of(isa, struct rtrack, isa);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) 	int curvol = rt->curvol;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 	if (mute) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) 		outb(0xd0, isa->io);	/* volume steady + sigstr + off	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) 		return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 	if (vol == 0) {			/* volume = 0 means mute the card */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) 		outb(0x48, isa->io);	/* volume down but still "on"	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) 		msleep(curvol * 3);	/* make sure it's totally down	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) 	} else if (curvol < vol) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) 		outb(0x98, isa->io);	/* volume up + sigstr + on	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) 		for (; curvol < vol; curvol++)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) 			mdelay(3);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) 	} else if (curvol > vol) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) 		outb(0x58, isa->io);	/* volume down + sigstr + on	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) 		for (; curvol > vol; curvol--)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) 			mdelay(3);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) 	}
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) 	outb(0xd8, isa->io);		/* volume steady + sigstr + on	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) 	rt->curvol = vol;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) /* Mute card - prevents noisy bootups */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) static int rtrack_initialize(struct radio_isa_card *isa)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) 	/* this ensures that the volume is all the way up  */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) 	outb(0x90, isa->io);	/* volume up but still "on"	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) 	msleep(3000);		/* make sure it's totally up	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) 	outb(0xc0, isa->io);	/* steady volume, mute card	*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 	return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) static const struct radio_isa_ops rtrack_ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) 	.alloc = rtrack_alloc,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) 	.init = rtrack_initialize,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) 	.s_mute_volume = rtrack_s_mute_volume,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) 	.s_frequency = rtrack_s_frequency,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 	.g_signal = rtrack_g_signal,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) static const int rtrack_ioports[] = { 0x20f, 0x30f };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) static struct radio_isa_driver rtrack_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) 	.driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) 		.match		= radio_isa_match,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) 		.probe		= radio_isa_probe,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 		.remove		= radio_isa_remove,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) 		.driver		= {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 			.name	= "radio-aimslab",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) 		},
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) 	},
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) 	.io_params = io,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) 	.radio_nr_params = radio_nr,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) 	.io_ports = rtrack_ioports,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) 	.num_of_io_ports = ARRAY_SIZE(rtrack_ioports),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) 	.region_size = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) 	.card = "AIMSlab RadioTrack/RadioReveal",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) 	.ops = &rtrack_ops,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) 	.has_stereo = true,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) 	.max_volume = 0xff,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) static int __init rtrack_init(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) 	return isa_register_driver(&rtrack_driver.driver, RTRACK_MAX);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) static void __exit rtrack_exit(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) 	isa_unregister_driver(&rtrack_driver.driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) module_init(rtrack_init);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) module_exit(rtrack_exit);