Loading...
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Fujitsu Lifebook Application Panel button drive
4 *
5 * Copyright (C) 2007 Stephen Hemminger <shemminger@linux-foundation.org>
6 * Copyright (C) 2001-2003 Jochen Eisinger <jochen@penguin-breeder.org>
7 *
8 * Many Fujitsu Lifebook laptops have a small panel of buttons that are
9 * accessible via the i2c/smbus interface. This driver polls those
10 * buttons and generates input events.
11 *
12 * For more details see:
13 * http://apanel.sourceforge.net/tech.php
14 */
15
16#include <linux/kernel.h>
17#include <linux/module.h>
18#include <linux/ioport.h>
19#include <linux/io.h>
20#include <linux/input.h>
21#include <linux/i2c.h>
22#include <linux/leds.h>
23
24#define APANEL_NAME "Fujitsu Application Panel"
25#define APANEL "apanel"
26
27/* How often we poll keys - msecs */
28#define POLL_INTERVAL_DEFAULT 1000
29
30/* Magic constants in BIOS that tell about buttons */
31enum apanel_devid {
32 APANEL_DEV_NONE = 0,
33 APANEL_DEV_APPBTN = 1,
34 APANEL_DEV_CDBTN = 2,
35 APANEL_DEV_LCD = 3,
36 APANEL_DEV_LED = 4,
37
38 APANEL_DEV_MAX,
39};
40
41enum apanel_chip {
42 CHIP_NONE = 0,
43 CHIP_OZ992C = 1,
44 CHIP_OZ163T = 2,
45 CHIP_OZ711M3 = 4,
46};
47
48/* Result of BIOS snooping/probing -- what features are supported */
49static enum apanel_chip device_chip[APANEL_DEV_MAX];
50
51#define MAX_PANEL_KEYS 12
52
53struct apanel {
54 struct input_dev *idev;
55 struct i2c_client *client;
56 unsigned short keymap[MAX_PANEL_KEYS];
57 u16 nkeys;
58 struct led_classdev mail_led;
59};
60
61static const unsigned short apanel_keymap[MAX_PANEL_KEYS] = {
62 [0] = KEY_MAIL,
63 [1] = KEY_WWW,
64 [2] = KEY_PROG2,
65 [3] = KEY_PROG1,
66
67 [8] = KEY_FORWARD,
68 [9] = KEY_REWIND,
69 [10] = KEY_STOPCD,
70 [11] = KEY_PLAYPAUSE,
71};
72
73static void report_key(struct input_dev *input, unsigned keycode)
74{
75 dev_dbg(input->dev.parent, "report key %#x\n", keycode);
76 input_report_key(input, keycode, 1);
77 input_sync(input);
78
79 input_report_key(input, keycode, 0);
80 input_sync(input);
81}
82
83/* Poll for key changes
84 *
85 * Read Application keys via SMI
86 * A (0x4), B (0x8), Internet (0x2), Email (0x1).
87 *
88 * CD keys:
89 * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800)
90 */
91static void apanel_poll(struct input_dev *idev)
92{
93 struct apanel *ap = input_get_drvdata(idev);
94 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
95 s32 data;
96 int i;
97
98 data = i2c_smbus_read_word_data(ap->client, cmd);
99 if (data < 0)
100 return; /* ignore errors (due to ACPI??) */
101
102 /* write back to clear latch */
103 i2c_smbus_write_word_data(ap->client, cmd, 0);
104
105 if (!data)
106 return;
107
108 dev_dbg(&idev->dev, APANEL ": data %#x\n", data);
109 for (i = 0; i < idev->keycodemax; i++)
110 if ((1u << i) & data)
111 report_key(idev, ap->keymap[i]);
112}
113
114static int mail_led_set(struct led_classdev *led,
115 enum led_brightness value)
116{
117 struct apanel *ap = container_of(led, struct apanel, mail_led);
118 u16 led_bits = value != LED_OFF ? 0x8000 : 0x0000;
119
120 return i2c_smbus_write_word_data(ap->client, 0x10, led_bits);
121}
122
123static int apanel_probe(struct i2c_client *client)
124{
125 struct apanel *ap;
126 struct input_dev *idev;
127 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
128 int i, err;
129
130 ap = devm_kzalloc(&client->dev, sizeof(*ap), GFP_KERNEL);
131 if (!ap)
132 return -ENOMEM;
133
134 idev = devm_input_allocate_device(&client->dev);
135 if (!idev)
136 return -ENOMEM;
137
138 ap->idev = idev;
139 ap->client = client;
140
141 i2c_set_clientdata(client, ap);
142
143 err = i2c_smbus_write_word_data(client, cmd, 0);
144 if (err) {
145 dev_warn(&client->dev, "smbus write error %d\n", err);
146 return err;
147 }
148
149 input_set_drvdata(idev, ap);
150
151 idev->name = APANEL_NAME " buttons";
152 idev->phys = "apanel/input0";
153 idev->id.bustype = BUS_HOST;
154
155 memcpy(ap->keymap, apanel_keymap, sizeof(apanel_keymap));
156 idev->keycode = ap->keymap;
157 idev->keycodesize = sizeof(ap->keymap[0]);
158 idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4;
159
160 set_bit(EV_KEY, idev->evbit);
161 for (i = 0; i < idev->keycodemax; i++)
162 if (ap->keymap[i])
163 set_bit(ap->keymap[i], idev->keybit);
164
165 err = input_setup_polling(idev, apanel_poll);
166 if (err)
167 return err;
168
169 input_set_poll_interval(idev, POLL_INTERVAL_DEFAULT);
170
171 err = input_register_device(idev);
172 if (err)
173 return err;
174
175 if (device_chip[APANEL_DEV_LED] != CHIP_NONE) {
176 ap->mail_led.name = "mail:blue";
177 ap->mail_led.brightness_set_blocking = mail_led_set;
178 err = devm_led_classdev_register(&client->dev, &ap->mail_led);
179 if (err)
180 return err;
181 }
182
183 return 0;
184}
185
186static void apanel_shutdown(struct i2c_client *client)
187{
188 struct apanel *ap = i2c_get_clientdata(client);
189
190 if (device_chip[APANEL_DEV_LED] != CHIP_NONE)
191 led_set_brightness(&ap->mail_led, LED_OFF);
192}
193
194static const struct i2c_device_id apanel_id[] = {
195 { "fujitsu_apanel", 0 },
196 { }
197};
198MODULE_DEVICE_TABLE(i2c, apanel_id);
199
200static struct i2c_driver apanel_driver = {
201 .driver = {
202 .name = APANEL,
203 },
204 .probe_new = apanel_probe,
205 .shutdown = apanel_shutdown,
206 .id_table = apanel_id,
207};
208
209/* Scan the system ROM for the signature "FJKEYINF" */
210static __init const void __iomem *bios_signature(const void __iomem *bios)
211{
212 ssize_t offset;
213 const unsigned char signature[] = "FJKEYINF";
214
215 for (offset = 0; offset < 0x10000; offset += 0x10) {
216 if (check_signature(bios + offset, signature,
217 sizeof(signature)-1))
218 return bios + offset;
219 }
220 pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n",
221 signature);
222 return NULL;
223}
224
225static int __init apanel_init(void)
226{
227 void __iomem *bios;
228 const void __iomem *p;
229 u8 devno;
230 unsigned char i2c_addr;
231 int found = 0;
232
233 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
234
235 p = bios_signature(bios);
236 if (!p) {
237 iounmap(bios);
238 return -ENODEV;
239 }
240
241 /* just use the first address */
242 p += 8;
243 i2c_addr = readb(p + 3) >> 1;
244
245 for ( ; (devno = readb(p)) & 0x7f; p += 4) {
246 unsigned char method, slave, chip;
247
248 method = readb(p + 1);
249 chip = readb(p + 2);
250 slave = readb(p + 3) >> 1;
251
252 if (slave != i2c_addr) {
253 pr_notice(APANEL ": only one SMBus slave "
254 "address supported, skipping device...\n");
255 continue;
256 }
257
258 /* translate alternative device numbers */
259 switch (devno) {
260 case 6:
261 devno = APANEL_DEV_APPBTN;
262 break;
263 case 7:
264 devno = APANEL_DEV_LED;
265 break;
266 }
267
268 if (devno >= APANEL_DEV_MAX)
269 pr_notice(APANEL ": unknown device %u found\n", devno);
270 else if (device_chip[devno] != CHIP_NONE)
271 pr_warn(APANEL ": duplicate entry for devno %u\n",
272 devno);
273
274 else if (method != 1 && method != 2 && method != 4) {
275 pr_notice(APANEL ": unknown method %u for devno %u\n",
276 method, devno);
277 } else {
278 device_chip[devno] = (enum apanel_chip) chip;
279 ++found;
280 }
281 }
282 iounmap(bios);
283
284 if (found == 0) {
285 pr_info(APANEL ": no input devices reported by BIOS\n");
286 return -EIO;
287 }
288
289 return i2c_add_driver(&apanel_driver);
290}
291module_init(apanel_init);
292
293static void __exit apanel_cleanup(void)
294{
295 i2c_del_driver(&apanel_driver);
296}
297module_exit(apanel_cleanup);
298
299MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>");
300MODULE_DESCRIPTION(APANEL_NAME " driver");
301MODULE_LICENSE("GPL");
302
303MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*");
304MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Fujitsu Lifebook Application Panel button drive
4 *
5 * Copyright (C) 2007 Stephen Hemminger <shemminger@linux-foundation.org>
6 * Copyright (C) 2001-2003 Jochen Eisinger <jochen@penguin-breeder.org>
7 *
8 * Many Fujitsu Lifebook laptops have a small panel of buttons that are
9 * accessible via the i2c/smbus interface. This driver polls those
10 * buttons and generates input events.
11 *
12 * For more details see:
13 * http://apanel.sourceforge.net/tech.php
14 */
15
16#include <linux/kernel.h>
17#include <linux/module.h>
18#include <linux/ioport.h>
19#include <linux/io.h>
20#include <linux/input-polldev.h>
21#include <linux/i2c.h>
22#include <linux/leds.h>
23
24#define APANEL_NAME "Fujitsu Application Panel"
25#define APANEL "apanel"
26
27/* How often we poll keys - msecs */
28#define POLL_INTERVAL_DEFAULT 1000
29
30/* Magic constants in BIOS that tell about buttons */
31enum apanel_devid {
32 APANEL_DEV_NONE = 0,
33 APANEL_DEV_APPBTN = 1,
34 APANEL_DEV_CDBTN = 2,
35 APANEL_DEV_LCD = 3,
36 APANEL_DEV_LED = 4,
37
38 APANEL_DEV_MAX,
39};
40
41enum apanel_chip {
42 CHIP_NONE = 0,
43 CHIP_OZ992C = 1,
44 CHIP_OZ163T = 2,
45 CHIP_OZ711M3 = 4,
46};
47
48/* Result of BIOS snooping/probing -- what features are supported */
49static enum apanel_chip device_chip[APANEL_DEV_MAX];
50
51#define MAX_PANEL_KEYS 12
52
53struct apanel {
54 struct input_polled_dev *ipdev;
55 struct i2c_client *client;
56 unsigned short keymap[MAX_PANEL_KEYS];
57 u16 nkeys;
58 struct led_classdev mail_led;
59};
60
61
62static int apanel_probe(struct i2c_client *, const struct i2c_device_id *);
63
64static void report_key(struct input_dev *input, unsigned keycode)
65{
66 pr_debug(APANEL ": report key %#x\n", keycode);
67 input_report_key(input, keycode, 1);
68 input_sync(input);
69
70 input_report_key(input, keycode, 0);
71 input_sync(input);
72}
73
74/* Poll for key changes
75 *
76 * Read Application keys via SMI
77 * A (0x4), B (0x8), Internet (0x2), Email (0x1).
78 *
79 * CD keys:
80 * Forward (0x100), Rewind (0x200), Stop (0x400), Pause (0x800)
81 */
82static void apanel_poll(struct input_polled_dev *ipdev)
83{
84 struct apanel *ap = ipdev->private;
85 struct input_dev *idev = ipdev->input;
86 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
87 s32 data;
88 int i;
89
90 data = i2c_smbus_read_word_data(ap->client, cmd);
91 if (data < 0)
92 return; /* ignore errors (due to ACPI??) */
93
94 /* write back to clear latch */
95 i2c_smbus_write_word_data(ap->client, cmd, 0);
96
97 if (!data)
98 return;
99
100 dev_dbg(&idev->dev, APANEL ": data %#x\n", data);
101 for (i = 0; i < idev->keycodemax; i++)
102 if ((1u << i) & data)
103 report_key(idev, ap->keymap[i]);
104}
105
106static int mail_led_set(struct led_classdev *led,
107 enum led_brightness value)
108{
109 struct apanel *ap = container_of(led, struct apanel, mail_led);
110 u16 led_bits = value != LED_OFF ? 0x8000 : 0x0000;
111
112 return i2c_smbus_write_word_data(ap->client, 0x10, led_bits);
113}
114
115static int apanel_remove(struct i2c_client *client)
116{
117 struct apanel *ap = i2c_get_clientdata(client);
118
119 if (device_chip[APANEL_DEV_LED] != CHIP_NONE)
120 led_classdev_unregister(&ap->mail_led);
121
122 input_unregister_polled_device(ap->ipdev);
123 input_free_polled_device(ap->ipdev);
124
125 return 0;
126}
127
128static void apanel_shutdown(struct i2c_client *client)
129{
130 apanel_remove(client);
131}
132
133static const struct i2c_device_id apanel_id[] = {
134 { "fujitsu_apanel", 0 },
135 { }
136};
137MODULE_DEVICE_TABLE(i2c, apanel_id);
138
139static struct i2c_driver apanel_driver = {
140 .driver = {
141 .name = APANEL,
142 },
143 .probe = &apanel_probe,
144 .remove = &apanel_remove,
145 .shutdown = &apanel_shutdown,
146 .id_table = apanel_id,
147};
148
149static struct apanel apanel = {
150 .keymap = {
151 [0] = KEY_MAIL,
152 [1] = KEY_WWW,
153 [2] = KEY_PROG2,
154 [3] = KEY_PROG1,
155
156 [8] = KEY_FORWARD,
157 [9] = KEY_REWIND,
158 [10] = KEY_STOPCD,
159 [11] = KEY_PLAYPAUSE,
160
161 },
162 .mail_led = {
163 .name = "mail:blue",
164 .brightness_set_blocking = mail_led_set,
165 },
166};
167
168/* NB: Only one panel on the i2c. */
169static int apanel_probe(struct i2c_client *client,
170 const struct i2c_device_id *id)
171{
172 struct apanel *ap;
173 struct input_polled_dev *ipdev;
174 struct input_dev *idev;
175 u8 cmd = device_chip[APANEL_DEV_APPBTN] == CHIP_OZ992C ? 0 : 8;
176 int i, err = -ENOMEM;
177
178 ap = &apanel;
179
180 ipdev = input_allocate_polled_device();
181 if (!ipdev)
182 goto out1;
183
184 ap->ipdev = ipdev;
185 ap->client = client;
186
187 i2c_set_clientdata(client, ap);
188
189 err = i2c_smbus_write_word_data(client, cmd, 0);
190 if (err) {
191 dev_warn(&client->dev, APANEL ": smbus write error %d\n",
192 err);
193 goto out3;
194 }
195
196 ipdev->poll = apanel_poll;
197 ipdev->poll_interval = POLL_INTERVAL_DEFAULT;
198 ipdev->private = ap;
199
200 idev = ipdev->input;
201 idev->name = APANEL_NAME " buttons";
202 idev->phys = "apanel/input0";
203 idev->id.bustype = BUS_HOST;
204 idev->dev.parent = &client->dev;
205
206 set_bit(EV_KEY, idev->evbit);
207
208 idev->keycode = ap->keymap;
209 idev->keycodesize = sizeof(ap->keymap[0]);
210 idev->keycodemax = (device_chip[APANEL_DEV_CDBTN] != CHIP_NONE) ? 12 : 4;
211
212 for (i = 0; i < idev->keycodemax; i++)
213 if (ap->keymap[i])
214 set_bit(ap->keymap[i], idev->keybit);
215
216 err = input_register_polled_device(ipdev);
217 if (err)
218 goto out3;
219
220 if (device_chip[APANEL_DEV_LED] != CHIP_NONE) {
221 err = led_classdev_register(&client->dev, &ap->mail_led);
222 if (err)
223 goto out4;
224 }
225
226 return 0;
227out4:
228 input_unregister_polled_device(ipdev);
229out3:
230 input_free_polled_device(ipdev);
231out1:
232 return err;
233}
234
235/* Scan the system ROM for the signature "FJKEYINF" */
236static __init const void __iomem *bios_signature(const void __iomem *bios)
237{
238 ssize_t offset;
239 const unsigned char signature[] = "FJKEYINF";
240
241 for (offset = 0; offset < 0x10000; offset += 0x10) {
242 if (check_signature(bios + offset, signature,
243 sizeof(signature)-1))
244 return bios + offset;
245 }
246 pr_notice(APANEL ": Fujitsu BIOS signature '%s' not found...\n",
247 signature);
248 return NULL;
249}
250
251static int __init apanel_init(void)
252{
253 void __iomem *bios;
254 const void __iomem *p;
255 u8 devno;
256 unsigned char i2c_addr;
257 int found = 0;
258
259 bios = ioremap(0xF0000, 0x10000); /* Can't fail */
260
261 p = bios_signature(bios);
262 if (!p) {
263 iounmap(bios);
264 return -ENODEV;
265 }
266
267 /* just use the first address */
268 p += 8;
269 i2c_addr = readb(p + 3) >> 1;
270
271 for ( ; (devno = readb(p)) & 0x7f; p += 4) {
272 unsigned char method, slave, chip;
273
274 method = readb(p + 1);
275 chip = readb(p + 2);
276 slave = readb(p + 3) >> 1;
277
278 if (slave != i2c_addr) {
279 pr_notice(APANEL ": only one SMBus slave "
280 "address supported, skipping device...\n");
281 continue;
282 }
283
284 /* translate alternative device numbers */
285 switch (devno) {
286 case 6:
287 devno = APANEL_DEV_APPBTN;
288 break;
289 case 7:
290 devno = APANEL_DEV_LED;
291 break;
292 }
293
294 if (devno >= APANEL_DEV_MAX)
295 pr_notice(APANEL ": unknown device %u found\n", devno);
296 else if (device_chip[devno] != CHIP_NONE)
297 pr_warn(APANEL ": duplicate entry for devno %u\n",
298 devno);
299
300 else if (method != 1 && method != 2 && method != 4) {
301 pr_notice(APANEL ": unknown method %u for devno %u\n",
302 method, devno);
303 } else {
304 device_chip[devno] = (enum apanel_chip) chip;
305 ++found;
306 }
307 }
308 iounmap(bios);
309
310 if (found == 0) {
311 pr_info(APANEL ": no input devices reported by BIOS\n");
312 return -EIO;
313 }
314
315 return i2c_add_driver(&apanel_driver);
316}
317module_init(apanel_init);
318
319static void __exit apanel_cleanup(void)
320{
321 i2c_del_driver(&apanel_driver);
322}
323module_exit(apanel_cleanup);
324
325MODULE_AUTHOR("Stephen Hemminger <shemminger@linux-foundation.org>");
326MODULE_DESCRIPTION(APANEL_NAME " driver");
327MODULE_LICENSE("GPL");
328
329MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifeBook*:pvr*:rvnFUJITSU:*");
330MODULE_ALIAS("dmi:*:svnFUJITSU:pnLifebook*:pvr*:rvnFUJITSU:*");