Apple IR receiver driver

Heya,

This is an update of the patches sent by Greg [1].

I believe I fixed one of the problems mentioned by Tino (the suspend support, though my testing was blighted by the fact that resuming *without* the driver doesn't work so well with the latest input tree, it works fine with the stock Fedora kernels).

The other problem mentioned by Tino was the fact that some people would want to use LIRC to use different remotes and have access to more keys. This can be achieved by using usbhid.quirks. I could certainly document that for both lirc and in the kernel.

A couple of things:
- Not certain about the suspend code
- Should the Apple TV receiver be handled in the same way? (the LIRC driver works on all 3 revisions of the IR receiver)
- Where should I document the work-around to use lirc in both LIRC and the kernel?

The main features of using a kernel driver are:
- Out-of-the-box support, just like in MacOS X, with the "recommended" remote controller. This is similar to how the ATI remotes are handled.
- On my hacking TODO list are the ability to report flat batteries through kobject_uevent to user space, and binding support (so as to filter out all the remotes apart from the "paired" one)

Let me know of any problems

Cheers

[1]: http://thread.gmane.org/gmane.linux.kernel/680590/

From: Bastien Nocera <[email protected]>
Date: Sun, 17 Jan 2010 00:40:15 +0000
Subject: [PATCH 1/2] [PATCH] Input: add appleir USB driver

From: Bastien Nocera <[email protected]>

This driver was originally written by James McKenzie, updated by Greg Kroah-Hartman, further updated by myself.

More recent versions of the IR receiver are also supported through a patch by Alex Karpenko.

Tested on a MacbookAir1,1

---
 drivers/hid/hid-apple.c      |    2 -
 drivers/hid/hid-core.c       |    2 +
 drivers/hid/hid-ids.h        |    1 +
 drivers/input/misc/Kconfig   |   12 ++
 drivers/input/misc/Makefile  |    1 +
 drivers/input/misc/appleir.c |  378 ++++++++++++++++++++++++++++++++++++++++++
 6 files changed, 394 insertions(+), 2 deletions(-)
 create mode 100644 drivers/input/misc/appleir.c

index 4b96e7a..12fe9c6 100644
@@ -355,8 +355,6 @@ static void apple_remove(struct hid_device *hdev)
 static const struct hid_device_id apple_devices[] = {
 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ATV_IRCONTROL),
 		.driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
-	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4),
-		.driver_data = APPLE_HIDDEV | APPLE_IGNORE_HIDINPUT },
 	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_MIGHTYMOUSE),
 		.driver_data = APPLE_MIGHTYMOUSE | APPLE_INVERT_HWHEEL },
 

index 80792d3..3773f69 100644
@@ -1540,6 +1540,8 @@ static const struct hid_device_id hid_ignore_list[] = {
 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIPTEK, USB_DEVICE_ID_AIPTEK_24) },
 	{ HID_USB_DEVICE(USB_VENDOR_ID_AIRCABLE, USB_DEVICE_ID_AIRCABLE1) },
 	{ HID_USB_DEVICE(USB_VENDOR_ID_ALCOR, USB_DEVICE_ID_ALCOR_USBRS232) },
+	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL) },
+	{ HID_USB_DEVICE(USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_IRCONTROL4) },
 	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM)},
 	{ HID_USB_DEVICE(USB_VENDOR_ID_ASUS, USB_DEVICE_ID_ASUS_LCM2)},
 	{ HID_USB_DEVICE(USB_VENDOR_ID_AVERMEDIA, USB_DEVICE_ID_AVER_FM_MR800) },

index 3839340..8b29a88 100644
@@ -90,6 +90,7 @@
 #define USB_DEVICE_ID_APPLE_WELLSPRING3_JIS	0x0238
 #define USB_DEVICE_ID_APPLE_FOUNTAIN_TP_ONLY	0x030a
 #define USB_DEVICE_ID_APPLE_GEYSER1_TP_ONLY	0x030b
+#define USB_DEVICE_ID_APPLE_IRCONTROL	0x8240
 #define USB_DEVICE_ID_APPLE_ATV_IRCONTROL	0x8241
 #define USB_DEVICE_ID_APPLE_IRCONTROL4	0x8242
 

index 16ec523..b46e3f1 100644
@@ -149,6 +149,18 @@ config INPUT_KEYSPAN_REMOTE
 	  To compile this driver as a module, choose M here: the module will
 	  be called keyspan_remote.
 
+config INPUT_APPLEIR
+	tristate "Apple infrared receiver (built in)"
+	depends on USB_ARCH_HAS_HCD
+	select USB
+	help
+	  Say Y here if you want to use a Apple infrared remote control. All
+	  the Apple computers from 2005 onwards include such a port, except
+	  the unibody Macbook (2009), and Mac Pros.
+
+	  To compile this driver as a module, choose M here: the module will
+	  be called appleir.
+
 config INPUT_POWERMATE
 	tristate "Griffin PowerMate and Contour Jog support"
 	depends on USB_ARCH_HAS_HCD

index a8b8485..041e6f5 100644
@@ -5,6 +5,7 @@
 # Each configuration option enables a list of files.
 
 obj-$(CONFIG_INPUT_APANEL)		+= apanel.o
+obj-$(CONFIG_INPUT_APPLEIR)		+= appleir.o
 obj-$(CONFIG_INPUT_ATI_REMOTE)		+= ati_remote.o
 obj-$(CONFIG_INPUT_ATI_REMOTE2)		+= ati_remote2.o
 obj-$(CONFIG_INPUT_ATLAS_BTNS)		+= atlas_btns.o

1.6.5.2

From: Bastien Nocera <[email protected]>
Date: Mon, 18 Jan 2010 13:57:03 +0000
Subject: [PATCH 2/2] [appleir] Add suspend support

Close the connection to the device and kill the timer when suspending, and undo those changes on resume.

---
 drivers/input/misc/appleir.c |  120 +++++++++++++++++++++++++++++++++++++++---
 1 files changed, 112 insertions(+), 8 deletions(-)

1.6.5.2

On Mon, Jan 18, 2010 at 14:14:25 +0000, Bastien Nocera wrote:

[...]

Yes, which I mentioned could be worked around using usbhid.quirks on boot (if you need the extra key definitions), or using lirc's uinput driver (if you're using the stock hardware).

What exactly do you mean with "using usbhid.quirks on boot"?

Regards,
Tino

Pass something along those lines:
usbhid.quirks=0xVID:0xPID:0xQUIRK
on the kernel command-line, and the appleir won't pick up the device, and the current quirks would be restored.

Given that I seriously doubt there's very many people interested in using "non-standard" remotes with those receivers, it would make most users' life easier (and I doubt that the people that have the hardware bothered setting up lirc on their systems...).

Cheers

So I guess this would be usbhid.quirks=0x05ac:0x8240:0xsomething.

The remaining question is what "something" should be.

IMHO "non-standard" remotes are interesting especially with this remote, because the vendor supplied remote has only six keys.

Is there really no way to make the quirk only effective if the appleir driver is active?

Regards,
Tino

The mask for HIDDEV and HIDINPUT_IGNORE (which I don't know on top of my head, and will only lookup if Dmitry thinks documentation is required).

Yes, and I don't know of anyone using the non-standard remotes with this receiver, and they could still do it with a bit of tweaking (which would be necessary to setup the other keys anyway).

Not easily, no, though the quirks should soon be changeable at run-time, so you could potentially not even have to reboot.

Cheers

HID_QUIRK_IGNORE, iirc, is 0x4.

The most common non-standard remote I've heard of people using is a Logitech Harmony remote, which they program 6 buttons at a time, then cycle to the next code set, program 6 more, rinse, repeat, etc.

Jarod Wilson
[email protected]

On Mon, Jan 18, 2010 at 11:39:54 -0500, Jarod Wilson wrote:

[...]

That's how I did it, with some random learning remote made by Sony. It should work with most learning remotes.

Regards,
Tino