2 * chromeos_laptop.c - Driver to instantiate Chromebook i2c/smbus devices.
4 * Author : Benson Leung <bleung@chromium.org>
6 * Copyright (C) 2012 Google, Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include <linux/dmi.h>
25 #include <linux/i2c.h>
26 #include <linux/platform_data/atmel_mxt_ts.h>
27 #include <linux/input.h>
28 #include <linux/interrupt.h>
29 #include <linux/module.h>
30 #include <linux/platform_device.h>
32 #define ATMEL_TP_I2C_ADDR 0x4b
33 #define ATMEL_TP_I2C_BL_ADDR 0x25
34 #define ATMEL_TS_I2C_ADDR 0x4a
35 #define ATMEL_TS_I2C_BL_ADDR 0x26
36 #define CYAPA_TP_I2C_ADDR 0x67
37 #define ELAN_TP_I2C_ADDR 0x15
38 #define ISL_ALS_I2C_ADDR 0x44
39 #define TAOS_ALS_I2C_ADDR 0x29
41 #define MAX_I2C_DEVICE_DEFERRALS 5
43 static struct i2c_client
*als
;
44 static struct i2c_client
*tp
;
45 static struct i2c_client
*ts
;
47 static const char *i2c_adapter_names
[] = {
51 "Synopsys DesignWare I2C adapter",
52 "Synopsys DesignWare I2C adapter",
55 /* Keep this enum consistent with i2c_adapter_names */
56 enum i2c_adapter_type
{
57 I2C_ADAPTER_SMBUS
= 0,
60 I2C_ADAPTER_DESIGNWARE_0
,
61 I2C_ADAPTER_DESIGNWARE_1
,
64 enum i2c_peripheral_state
{
70 struct i2c_peripheral
{
71 int (*add
)(enum i2c_adapter_type type
);
72 enum i2c_adapter_type type
;
73 enum i2c_peripheral_state state
;
77 #define MAX_I2C_PERIPHERALS 4
79 struct chromeos_laptop
{
80 struct i2c_peripheral i2c_peripherals
[MAX_I2C_PERIPHERALS
];
83 static struct chromeos_laptop
*cros_laptop
;
85 static struct i2c_board_info cyapa_device
= {
86 I2C_BOARD_INFO("cyapa", CYAPA_TP_I2C_ADDR
),
87 .flags
= I2C_CLIENT_WAKE
,
90 static struct i2c_board_info elantech_device
= {
91 I2C_BOARD_INFO("elan_i2c", ELAN_TP_I2C_ADDR
),
92 .flags
= I2C_CLIENT_WAKE
,
95 static struct i2c_board_info isl_als_device
= {
96 I2C_BOARD_INFO("isl29018", ISL_ALS_I2C_ADDR
),
99 static struct i2c_board_info tsl2583_als_device
= {
100 I2C_BOARD_INFO("tsl2583", TAOS_ALS_I2C_ADDR
),
103 static struct i2c_board_info tsl2563_als_device
= {
104 I2C_BOARD_INFO("tsl2563", TAOS_ALS_I2C_ADDR
),
107 static int mxt_t19_keys
[] = {
116 static struct mxt_platform_data atmel_224s_tp_platform_data
= {
117 .irqflags
= IRQF_TRIGGER_FALLING
,
118 .t19_num_keys
= ARRAY_SIZE(mxt_t19_keys
),
119 .t19_keymap
= mxt_t19_keys
,
120 .suspend_mode
= MXT_SUSPEND_T9_CTRL
,
123 static struct i2c_board_info atmel_224s_tp_device
= {
124 I2C_BOARD_INFO("atmel_mxt_tp", ATMEL_TP_I2C_ADDR
),
125 .platform_data
= &atmel_224s_tp_platform_data
,
126 .flags
= I2C_CLIENT_WAKE
,
129 static struct mxt_platform_data atmel_1664s_platform_data
= {
130 .irqflags
= IRQF_TRIGGER_FALLING
,
131 .suspend_mode
= MXT_SUSPEND_T9_CTRL
,
134 static struct i2c_board_info atmel_1664s_device
= {
135 I2C_BOARD_INFO("atmel_mxt_ts", ATMEL_TS_I2C_ADDR
),
136 .platform_data
= &atmel_1664s_platform_data
,
137 .flags
= I2C_CLIENT_WAKE
,
140 static struct i2c_client
*__add_probed_i2c_device(
143 struct i2c_board_info
*info
,
144 const unsigned short *alt_addr_list
)
146 const struct dmi_device
*dmi_dev
;
147 const struct dmi_dev_onboard
*dev_data
;
148 struct i2c_adapter
*adapter
;
149 struct i2c_client
*client
= NULL
;
150 const unsigned short addr_list
[] = { info
->addr
, I2C_CLIENT_END
};
155 * If a name is specified, look for irq platform information stashed
156 * in DMI_DEV_TYPE_DEV_ONBOARD by the Chrome OS custom system firmware.
159 dmi_dev
= dmi_find_device(DMI_DEV_TYPE_DEV_ONBOARD
, name
, NULL
);
161 pr_err("%s failed to dmi find device %s.\n",
166 dev_data
= (struct dmi_dev_onboard
*)dmi_dev
->device_data
;
168 pr_err("%s failed to get data from dmi for %s.\n",
172 info
->irq
= dev_data
->instance
;
175 adapter
= i2c_get_adapter(bus
);
177 pr_err("%s failed to get i2c adapter %d.\n", __func__
, bus
);
182 * Add the i2c device. If we can't detect it at the primary
183 * address we scan secondary addresses. In any case the client
184 * structure gets assigned primary address.
186 client
= i2c_new_probed_device(adapter
, info
, addr_list
, NULL
);
187 if (!client
&& alt_addr_list
) {
188 struct i2c_board_info dummy_info
= {
189 I2C_BOARD_INFO("dummy", info
->addr
),
191 struct i2c_client
*dummy
;
193 dummy
= i2c_new_probed_device(adapter
, &dummy_info
,
194 alt_addr_list
, NULL
);
196 pr_debug("%s %d-%02x is probed at %02x\n",
197 __func__
, bus
, info
->addr
, dummy
->addr
);
198 i2c_unregister_device(dummy
);
199 client
= i2c_new_device(adapter
, info
);
204 pr_notice("%s failed to register device %d-%02x\n",
205 __func__
, bus
, info
->addr
);
207 pr_debug("%s added i2c device %d-%02x\n",
208 __func__
, bus
, info
->addr
);
210 i2c_put_adapter(adapter
);
220 static int __find_i2c_adap(struct device
*dev
, void *data
)
222 struct i2c_lookup
*lookup
= data
;
223 static const char *prefix
= "i2c-";
224 struct i2c_adapter
*adapter
;
226 if (strncmp(dev_name(dev
), prefix
, strlen(prefix
)) != 0)
228 adapter
= to_i2c_adapter(dev
);
229 if (strncmp(adapter
->name
, lookup
->name
, strlen(lookup
->name
)) == 0 &&
230 lookup
->n
++ == lookup
->instance
)
235 static int find_i2c_adapter_num(enum i2c_adapter_type type
)
237 struct device
*dev
= NULL
;
238 struct i2c_adapter
*adapter
;
239 struct i2c_lookup lookup
;
241 memset(&lookup
, 0, sizeof(lookup
));
242 lookup
.name
= i2c_adapter_names
[type
];
243 lookup
.instance
= (type
== I2C_ADAPTER_DESIGNWARE_1
) ? 1 : 0;
245 /* find the adapter by name */
246 dev
= bus_find_device(&i2c_bus_type
, NULL
, &lookup
, __find_i2c_adap
);
248 /* Adapters may appear later. Deferred probing will retry */
249 pr_notice("%s: i2c adapter %s not found on system.\n", __func__
,
253 adapter
= to_i2c_adapter(dev
);
258 * Takes a list of addresses in addrs as such :
259 * { addr1, ... , addrn, I2C_CLIENT_END };
260 * add_probed_i2c_device will use i2c_new_probed_device
261 * and probe for devices at all of the addresses listed.
262 * Returns NULL if no devices found.
263 * See Documentation/i2c/instantiating-devices for more information.
265 static struct i2c_client
*add_probed_i2c_device(
267 enum i2c_adapter_type type
,
268 struct i2c_board_info
*info
,
269 const unsigned short *addrs
)
271 return __add_probed_i2c_device(name
,
272 find_i2c_adapter_num(type
),
278 * Probes for a device at a single address, the one provided by
280 * Returns NULL if no device found.
282 static struct i2c_client
*add_i2c_device(const char *name
,
283 enum i2c_adapter_type type
,
284 struct i2c_board_info
*info
)
286 return __add_probed_i2c_device(name
,
287 find_i2c_adapter_num(type
),
292 static int setup_cyapa_tp(enum i2c_adapter_type type
)
297 /* add cyapa touchpad */
298 tp
= add_i2c_device("trackpad", type
, &cyapa_device
);
299 return (!tp
) ? -EAGAIN
: 0;
302 static int setup_atmel_224s_tp(enum i2c_adapter_type type
)
304 const unsigned short addr_list
[] = { ATMEL_TP_I2C_BL_ADDR
,
309 /* add atmel mxt touchpad */
310 tp
= add_probed_i2c_device("trackpad", type
,
311 &atmel_224s_tp_device
, addr_list
);
312 return (!tp
) ? -EAGAIN
: 0;
315 static int setup_elantech_tp(enum i2c_adapter_type type
)
320 /* add elantech touchpad */
321 tp
= add_i2c_device("trackpad", type
, &elantech_device
);
322 return (!tp
) ? -EAGAIN
: 0;
325 static int setup_atmel_1664s_ts(enum i2c_adapter_type type
)
327 const unsigned short addr_list
[] = { ATMEL_TS_I2C_BL_ADDR
,
332 /* add atmel mxt touch device */
333 ts
= add_probed_i2c_device("touchscreen", type
,
334 &atmel_1664s_device
, addr_list
);
335 return (!ts
) ? -EAGAIN
: 0;
338 static int setup_isl29018_als(enum i2c_adapter_type type
)
343 /* add isl29018 light sensor */
344 als
= add_i2c_device("lightsensor", type
, &isl_als_device
);
345 return (!als
) ? -EAGAIN
: 0;
348 static int setup_tsl2583_als(enum i2c_adapter_type type
)
353 /* add tsl2583 light sensor */
354 als
= add_i2c_device(NULL
, type
, &tsl2583_als_device
);
355 return (!als
) ? -EAGAIN
: 0;
358 static int setup_tsl2563_als(enum i2c_adapter_type type
)
363 /* add tsl2563 light sensor */
364 als
= add_i2c_device(NULL
, type
, &tsl2563_als_device
);
365 return (!als
) ? -EAGAIN
: 0;
368 static int __init
chromeos_laptop_dmi_matched(const struct dmi_system_id
*id
)
370 cros_laptop
= (void *)id
->driver_data
;
371 pr_debug("DMI Matched %s.\n", id
->ident
);
373 /* Indicate to dmi_scan that processing is done. */
377 static int chromeos_laptop_probe(struct platform_device
*pdev
)
382 for (i
= 0; i
< MAX_I2C_PERIPHERALS
; i
++) {
383 struct i2c_peripheral
*i2c_dev
;
385 i2c_dev
= &cros_laptop
->i2c_peripherals
[i
];
387 /* No more peripherals. */
388 if (i2c_dev
->add
== NULL
)
391 if (i2c_dev
->state
== TIMEDOUT
|| i2c_dev
->state
== PROBED
)
395 * Check that the i2c adapter is present.
396 * -EPROBE_DEFER if missing as the adapter may appear much
399 if (find_i2c_adapter_num(i2c_dev
->type
) == -ENODEV
) {
404 /* Add the device. */
405 if (i2c_dev
->add(i2c_dev
->type
) == -EAGAIN
) {
407 * Set -EPROBE_DEFER a limited num of times
408 * if device is not successfully added.
410 if (++i2c_dev
->tries
< MAX_I2C_DEVICE_DEFERRALS
) {
413 /* Ran out of tries. */
414 pr_notice("%s: Ran out of tries for device.\n",
416 i2c_dev
->state
= TIMEDOUT
;
419 i2c_dev
->state
= PROBED
;
426 static struct chromeos_laptop samsung_series_5_550
= {
429 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
431 { .add
= setup_isl29018_als
, I2C_ADAPTER_SMBUS
},
435 static struct chromeos_laptop samsung_series_5
= {
438 { .add
= setup_tsl2583_als
, I2C_ADAPTER_SMBUS
},
442 static struct chromeos_laptop chromebook_pixel
= {
445 { .add
= setup_atmel_1664s_ts
, I2C_ADAPTER_PANEL
},
447 { .add
= setup_atmel_224s_tp
, I2C_ADAPTER_VGADDC
},
449 { .add
= setup_isl29018_als
, I2C_ADAPTER_PANEL
},
453 static struct chromeos_laptop hp_chromebook_14
= {
456 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
460 static struct chromeos_laptop dell_chromebook_11
= {
463 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
464 /* Elan Touchpad option. */
465 { .add
= setup_elantech_tp
, I2C_ADAPTER_DESIGNWARE_0
},
469 static struct chromeos_laptop toshiba_cb35
= {
472 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
476 static struct chromeos_laptop acer_c7_chromebook
= {
479 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
483 static struct chromeos_laptop acer_ac700
= {
486 { .add
= setup_tsl2563_als
, I2C_ADAPTER_SMBUS
},
490 static struct chromeos_laptop acer_c720
= {
493 { .add
= setup_atmel_1664s_ts
, I2C_ADAPTER_DESIGNWARE_1
},
495 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
496 /* Elan Touchpad option. */
497 { .add
= setup_elantech_tp
, I2C_ADAPTER_DESIGNWARE_0
},
499 { .add
= setup_isl29018_als
, I2C_ADAPTER_DESIGNWARE_1
},
503 static struct chromeos_laptop hp_pavilion_14_chromebook
= {
506 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
510 static struct chromeos_laptop cr48
= {
513 { .add
= setup_tsl2563_als
, I2C_ADAPTER_SMBUS
},
517 #define _CBDD(board_) \
518 .callback = chromeos_laptop_dmi_matched, \
519 .driver_data = (void *)&board_
521 static struct dmi_system_id chromeos_laptop_dmi_table
[] __initdata
= {
523 .ident
= "Samsung Series 5 550",
525 DMI_MATCH(DMI_SYS_VENDOR
, "SAMSUNG"),
526 DMI_MATCH(DMI_PRODUCT_NAME
, "Lumpy"),
528 _CBDD(samsung_series_5_550
),
531 .ident
= "Samsung Series 5",
533 DMI_MATCH(DMI_PRODUCT_NAME
, "Alex"),
535 _CBDD(samsung_series_5
),
538 .ident
= "Chromebook Pixel",
540 DMI_MATCH(DMI_SYS_VENDOR
, "GOOGLE"),
541 DMI_MATCH(DMI_PRODUCT_NAME
, "Link"),
543 _CBDD(chromebook_pixel
),
548 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
549 DMI_MATCH(DMI_PRODUCT_NAME
, "Wolf"),
551 _CBDD(dell_chromebook_11
),
554 .ident
= "HP Chromebook 14",
556 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
557 DMI_MATCH(DMI_PRODUCT_NAME
, "Falco"),
559 _CBDD(hp_chromebook_14
),
562 .ident
= "Toshiba CB35",
564 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
565 DMI_MATCH(DMI_PRODUCT_NAME
, "Leon"),
570 .ident
= "Acer C7 Chromebook",
572 DMI_MATCH(DMI_PRODUCT_NAME
, "Parrot"),
574 _CBDD(acer_c7_chromebook
),
577 .ident
= "Acer AC700",
579 DMI_MATCH(DMI_PRODUCT_NAME
, "ZGB"),
584 .ident
= "Acer C720",
586 DMI_MATCH(DMI_PRODUCT_NAME
, "Peppy"),
591 .ident
= "HP Pavilion 14 Chromebook",
593 DMI_MATCH(DMI_PRODUCT_NAME
, "Butterfly"),
595 _CBDD(hp_pavilion_14_chromebook
),
600 DMI_MATCH(DMI_PRODUCT_NAME
, "Mario"),
606 MODULE_DEVICE_TABLE(dmi
, chromeos_laptop_dmi_table
);
608 static struct platform_device
*cros_platform_device
;
610 static struct platform_driver cros_platform_driver
= {
612 .name
= "chromeos_laptop",
614 .probe
= chromeos_laptop_probe
,
617 static int __init
chromeos_laptop_init(void)
621 if (!dmi_check_system(chromeos_laptop_dmi_table
)) {
622 pr_debug("%s unsupported system.\n", __func__
);
626 ret
= platform_driver_register(&cros_platform_driver
);
630 cros_platform_device
= platform_device_alloc("chromeos_laptop", -1);
631 if (!cros_platform_device
) {
633 goto fail_platform_device1
;
636 ret
= platform_device_add(cros_platform_device
);
638 goto fail_platform_device2
;
642 fail_platform_device2
:
643 platform_device_put(cros_platform_device
);
644 fail_platform_device1
:
645 platform_driver_unregister(&cros_platform_driver
);
649 static void __exit
chromeos_laptop_exit(void)
652 i2c_unregister_device(als
);
654 i2c_unregister_device(tp
);
656 i2c_unregister_device(ts
);
658 platform_device_unregister(cros_platform_device
);
659 platform_driver_unregister(&cros_platform_driver
);
662 module_init(chromeos_laptop_init
);
663 module_exit(chromeos_laptop_exit
);
665 MODULE_DESCRIPTION("Chrome OS Laptop driver");
666 MODULE_AUTHOR("Benson Leung <bleung@chromium.org>");
667 MODULE_LICENSE("GPL");