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/i2c/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 ISL_ALS_I2C_ADDR 0x44
38 #define TAOS_ALS_I2C_ADDR 0x29
40 #define MAX_I2C_DEVICE_DEFERRALS 5
42 static struct i2c_client
*als
;
43 static struct i2c_client
*tp
;
44 static struct i2c_client
*ts
;
46 static const char *i2c_adapter_names
[] = {
54 /* Keep this enum consistent with i2c_adapter_names */
55 enum i2c_adapter_type
{
56 I2C_ADAPTER_SMBUS
= 0,
59 I2C_ADAPTER_DESIGNWARE_0
,
60 I2C_ADAPTER_DESIGNWARE_1
,
63 enum i2c_peripheral_state
{
69 struct i2c_peripheral
{
70 int (*add
)(enum i2c_adapter_type type
);
71 enum i2c_adapter_type type
;
72 enum i2c_peripheral_state state
;
76 #define MAX_I2C_PERIPHERALS 3
78 struct chromeos_laptop
{
79 struct i2c_peripheral i2c_peripherals
[MAX_I2C_PERIPHERALS
];
82 static struct chromeos_laptop
*cros_laptop
;
84 static struct i2c_board_info cyapa_device
= {
85 I2C_BOARD_INFO("cyapa", CYAPA_TP_I2C_ADDR
),
86 .flags
= I2C_CLIENT_WAKE
,
89 static struct i2c_board_info isl_als_device
= {
90 I2C_BOARD_INFO("isl29018", ISL_ALS_I2C_ADDR
),
93 static struct i2c_board_info tsl2583_als_device
= {
94 I2C_BOARD_INFO("tsl2583", TAOS_ALS_I2C_ADDR
),
97 static struct i2c_board_info tsl2563_als_device
= {
98 I2C_BOARD_INFO("tsl2563", TAOS_ALS_I2C_ADDR
),
101 static int mxt_t19_keys
[] = {
110 static struct mxt_platform_data atmel_224s_tp_platform_data
= {
111 .irqflags
= IRQF_TRIGGER_FALLING
,
112 .t19_num_keys
= ARRAY_SIZE(mxt_t19_keys
),
113 .t19_keymap
= mxt_t19_keys
,
116 static struct i2c_board_info atmel_224s_tp_device
= {
117 I2C_BOARD_INFO("atmel_mxt_tp", ATMEL_TP_I2C_ADDR
),
118 .platform_data
= &atmel_224s_tp_platform_data
,
119 .flags
= I2C_CLIENT_WAKE
,
122 static struct mxt_platform_data atmel_1664s_platform_data
= {
123 .irqflags
= IRQF_TRIGGER_FALLING
,
126 static struct i2c_board_info atmel_1664s_device
= {
127 I2C_BOARD_INFO("atmel_mxt_ts", ATMEL_TS_I2C_ADDR
),
128 .platform_data
= &atmel_1664s_platform_data
,
129 .flags
= I2C_CLIENT_WAKE
,
132 static struct i2c_client
*__add_probed_i2c_device(
135 struct i2c_board_info
*info
,
136 const unsigned short *alt_addr_list
)
138 const struct dmi_device
*dmi_dev
;
139 const struct dmi_dev_onboard
*dev_data
;
140 struct i2c_adapter
*adapter
;
141 struct i2c_client
*client
= NULL
;
142 const unsigned short addr_list
[] = { info
->addr
, I2C_CLIENT_END
};
147 * If a name is specified, look for irq platform information stashed
148 * in DMI_DEV_TYPE_DEV_ONBOARD by the Chrome OS custom system firmware.
151 dmi_dev
= dmi_find_device(DMI_DEV_TYPE_DEV_ONBOARD
, name
, NULL
);
153 pr_err("%s failed to dmi find device %s.\n",
158 dev_data
= (struct dmi_dev_onboard
*)dmi_dev
->device_data
;
160 pr_err("%s failed to get data from dmi for %s.\n",
164 info
->irq
= dev_data
->instance
;
167 adapter
= i2c_get_adapter(bus
);
169 pr_err("%s failed to get i2c adapter %d.\n", __func__
, bus
);
174 * Add the i2c device. If we can't detect it at the primary
175 * address we scan secondary addresses. In any case the client
176 * structure gets assigned primary address.
178 client
= i2c_new_probed_device(adapter
, info
, addr_list
, NULL
);
179 if (!client
&& alt_addr_list
) {
180 struct i2c_board_info dummy_info
= {
181 I2C_BOARD_INFO("dummy", info
->addr
),
183 struct i2c_client
*dummy
;
185 dummy
= i2c_new_probed_device(adapter
, &dummy_info
,
186 alt_addr_list
, NULL
);
188 pr_debug("%s %d-%02x is probed at %02x\n",
189 __func__
, bus
, info
->addr
, dummy
->addr
);
190 i2c_unregister_device(dummy
);
191 client
= i2c_new_device(adapter
, info
);
196 pr_notice("%s failed to register device %d-%02x\n",
197 __func__
, bus
, info
->addr
);
199 pr_debug("%s added i2c device %d-%02x\n",
200 __func__
, bus
, info
->addr
);
202 i2c_put_adapter(adapter
);
212 static int __find_i2c_adap(struct device
*dev
, void *data
)
214 struct i2c_lookup
*lookup
= data
;
215 static const char *prefix
= "i2c-";
216 struct i2c_adapter
*adapter
;
218 if (strncmp(dev_name(dev
), prefix
, strlen(prefix
)) != 0)
220 adapter
= to_i2c_adapter(dev
);
221 if (strncmp(adapter
->name
, lookup
->name
, strlen(lookup
->name
)) == 0 &&
222 lookup
->n
++ == lookup
->instance
)
227 static int find_i2c_adapter_num(enum i2c_adapter_type type
)
229 struct device
*dev
= NULL
;
230 struct i2c_adapter
*adapter
;
231 struct i2c_lookup lookup
;
233 memset(&lookup
, 0, sizeof(lookup
));
234 lookup
.name
= i2c_adapter_names
[type
];
235 lookup
.instance
= (type
== I2C_ADAPTER_DESIGNWARE_1
) ? 1 : 0;
237 /* find the adapter by name */
238 dev
= bus_find_device(&i2c_bus_type
, NULL
, &lookup
, __find_i2c_adap
);
240 /* Adapters may appear later. Deferred probing will retry */
241 pr_notice("%s: i2c adapter %s not found on system.\n", __func__
,
245 adapter
= to_i2c_adapter(dev
);
250 * Takes a list of addresses in addrs as such :
251 * { addr1, ... , addrn, I2C_CLIENT_END };
252 * add_probed_i2c_device will use i2c_new_probed_device
253 * and probe for devices at all of the addresses listed.
254 * Returns NULL if no devices found.
255 * See Documentation/i2c/instantiating-devices for more information.
257 static struct i2c_client
*add_probed_i2c_device(
259 enum i2c_adapter_type type
,
260 struct i2c_board_info
*info
,
261 const unsigned short *addrs
)
263 return __add_probed_i2c_device(name
,
264 find_i2c_adapter_num(type
),
270 * Probes for a device at a single address, the one provided by
272 * Returns NULL if no device found.
274 static struct i2c_client
*add_i2c_device(const char *name
,
275 enum i2c_adapter_type type
,
276 struct i2c_board_info
*info
)
278 return __add_probed_i2c_device(name
,
279 find_i2c_adapter_num(type
),
284 static int setup_cyapa_tp(enum i2c_adapter_type type
)
289 /* add cyapa touchpad */
290 tp
= add_i2c_device("trackpad", type
, &cyapa_device
);
291 return (!tp
) ? -EAGAIN
: 0;
294 static int setup_atmel_224s_tp(enum i2c_adapter_type type
)
296 const unsigned short addr_list
[] = { ATMEL_TP_I2C_BL_ADDR
,
301 /* add atmel mxt touchpad */
302 tp
= add_probed_i2c_device("trackpad", type
,
303 &atmel_224s_tp_device
, addr_list
);
304 return (!tp
) ? -EAGAIN
: 0;
307 static int setup_atmel_1664s_ts(enum i2c_adapter_type type
)
309 const unsigned short addr_list
[] = { ATMEL_TS_I2C_BL_ADDR
,
314 /* add atmel mxt touch device */
315 ts
= add_probed_i2c_device("touchscreen", type
,
316 &atmel_1664s_device
, addr_list
);
317 return (!ts
) ? -EAGAIN
: 0;
320 static int setup_isl29018_als(enum i2c_adapter_type type
)
325 /* add isl29018 light sensor */
326 als
= add_i2c_device("lightsensor", type
, &isl_als_device
);
327 return (!als
) ? -EAGAIN
: 0;
330 static int setup_tsl2583_als(enum i2c_adapter_type type
)
335 /* add tsl2583 light sensor */
336 als
= add_i2c_device(NULL
, type
, &tsl2583_als_device
);
337 return (!als
) ? -EAGAIN
: 0;
340 static int setup_tsl2563_als(enum i2c_adapter_type type
)
345 /* add tsl2563 light sensor */
346 als
= add_i2c_device(NULL
, type
, &tsl2563_als_device
);
347 return (!als
) ? -EAGAIN
: 0;
350 static int __init
chromeos_laptop_dmi_matched(const struct dmi_system_id
*id
)
352 cros_laptop
= (void *)id
->driver_data
;
353 pr_debug("DMI Matched %s.\n", id
->ident
);
355 /* Indicate to dmi_scan that processing is done. */
359 static int chromeos_laptop_probe(struct platform_device
*pdev
)
364 for (i
= 0; i
< MAX_I2C_PERIPHERALS
; i
++) {
365 struct i2c_peripheral
*i2c_dev
;
367 i2c_dev
= &cros_laptop
->i2c_peripherals
[i
];
369 /* No more peripherals. */
370 if (i2c_dev
->add
== NULL
)
373 if (i2c_dev
->state
== TIMEDOUT
|| i2c_dev
->state
== PROBED
)
377 * Check that the i2c adapter is present.
378 * -EPROBE_DEFER if missing as the adapter may appear much
381 if (find_i2c_adapter_num(i2c_dev
->type
) == -ENODEV
) {
386 /* Add the device. */
387 if (i2c_dev
->add(i2c_dev
->type
) == -EAGAIN
) {
389 * Set -EPROBE_DEFER a limited num of times
390 * if device is not successfully added.
392 if (++i2c_dev
->tries
< MAX_I2C_DEVICE_DEFERRALS
) {
395 /* Ran out of tries. */
396 pr_notice("%s: Ran out of tries for device.\n",
398 i2c_dev
->state
= TIMEDOUT
;
401 i2c_dev
->state
= PROBED
;
408 static struct chromeos_laptop samsung_series_5_550
= {
411 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
413 { .add
= setup_isl29018_als
, I2C_ADAPTER_SMBUS
},
417 static struct chromeos_laptop samsung_series_5
= {
420 { .add
= setup_tsl2583_als
, I2C_ADAPTER_SMBUS
},
424 static struct chromeos_laptop chromebook_pixel
= {
427 { .add
= setup_atmel_1664s_ts
, I2C_ADAPTER_PANEL
},
429 { .add
= setup_atmel_224s_tp
, I2C_ADAPTER_VGADDC
},
431 { .add
= setup_isl29018_als
, I2C_ADAPTER_PANEL
},
435 static struct chromeos_laptop hp_chromebook_14
= {
438 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
442 static struct chromeos_laptop dell_chromebook_11
= {
445 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
449 static struct chromeos_laptop toshiba_cb35
= {
452 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
456 static struct chromeos_laptop acer_c7_chromebook
= {
459 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
463 static struct chromeos_laptop acer_ac700
= {
466 { .add
= setup_tsl2563_als
, I2C_ADAPTER_SMBUS
},
470 static struct chromeos_laptop acer_c720
= {
473 { .add
= setup_atmel_1664s_ts
, I2C_ADAPTER_DESIGNWARE_1
},
475 { .add
= setup_cyapa_tp
, I2C_ADAPTER_DESIGNWARE_0
},
477 { .add
= setup_isl29018_als
, I2C_ADAPTER_DESIGNWARE_1
},
481 static struct chromeos_laptop hp_pavilion_14_chromebook
= {
484 { .add
= setup_cyapa_tp
, I2C_ADAPTER_SMBUS
},
488 static struct chromeos_laptop cr48
= {
491 { .add
= setup_tsl2563_als
, I2C_ADAPTER_SMBUS
},
495 #define _CBDD(board_) \
496 .callback = chromeos_laptop_dmi_matched, \
497 .driver_data = (void *)&board_
499 static struct dmi_system_id chromeos_laptop_dmi_table
[] __initdata
= {
501 .ident
= "Samsung Series 5 550",
503 DMI_MATCH(DMI_SYS_VENDOR
, "SAMSUNG"),
504 DMI_MATCH(DMI_PRODUCT_NAME
, "Lumpy"),
506 _CBDD(samsung_series_5_550
),
509 .ident
= "Samsung Series 5",
511 DMI_MATCH(DMI_PRODUCT_NAME
, "Alex"),
513 _CBDD(samsung_series_5
),
516 .ident
= "Chromebook Pixel",
518 DMI_MATCH(DMI_SYS_VENDOR
, "GOOGLE"),
519 DMI_MATCH(DMI_PRODUCT_NAME
, "Link"),
521 _CBDD(chromebook_pixel
),
526 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
527 DMI_MATCH(DMI_PRODUCT_NAME
, "Wolf"),
529 _CBDD(dell_chromebook_11
),
532 .ident
= "HP Chromebook 14",
534 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
535 DMI_MATCH(DMI_PRODUCT_NAME
, "Falco"),
537 _CBDD(hp_chromebook_14
),
540 .ident
= "Toshiba CB35",
542 DMI_MATCH(DMI_BIOS_VENDOR
, "coreboot"),
543 DMI_MATCH(DMI_PRODUCT_NAME
, "Leon"),
548 .ident
= "Acer C7 Chromebook",
550 DMI_MATCH(DMI_PRODUCT_NAME
, "Parrot"),
552 _CBDD(acer_c7_chromebook
),
555 .ident
= "Acer AC700",
557 DMI_MATCH(DMI_PRODUCT_NAME
, "ZGB"),
562 .ident
= "Acer C720",
564 DMI_MATCH(DMI_PRODUCT_NAME
, "Peppy"),
569 .ident
= "HP Pavilion 14 Chromebook",
571 DMI_MATCH(DMI_PRODUCT_NAME
, "Butterfly"),
573 _CBDD(hp_pavilion_14_chromebook
),
578 DMI_MATCH(DMI_PRODUCT_NAME
, "Mario"),
584 MODULE_DEVICE_TABLE(dmi
, chromeos_laptop_dmi_table
);
586 static struct platform_device
*cros_platform_device
;
588 static struct platform_driver cros_platform_driver
= {
590 .name
= "chromeos_laptop",
592 .probe
= chromeos_laptop_probe
,
595 static int __init
chromeos_laptop_init(void)
599 if (!dmi_check_system(chromeos_laptop_dmi_table
)) {
600 pr_debug("%s unsupported system.\n", __func__
);
604 ret
= platform_driver_register(&cros_platform_driver
);
608 cros_platform_device
= platform_device_alloc("chromeos_laptop", -1);
609 if (!cros_platform_device
) {
611 goto fail_platform_device1
;
614 ret
= platform_device_add(cros_platform_device
);
616 goto fail_platform_device2
;
620 fail_platform_device2
:
621 platform_device_put(cros_platform_device
);
622 fail_platform_device1
:
623 platform_driver_unregister(&cros_platform_driver
);
627 static void __exit
chromeos_laptop_exit(void)
630 i2c_unregister_device(als
);
632 i2c_unregister_device(tp
);
634 i2c_unregister_device(ts
);
636 platform_device_unregister(cros_platform_device
);
637 platform_driver_unregister(&cros_platform_driver
);
640 module_init(chromeos_laptop_init
);
641 module_exit(chromeos_laptop_exit
);
643 MODULE_DESCRIPTION("Chrome OS Laptop driver");
644 MODULE_AUTHOR("Benson Leung <bleung@chromium.org>");
645 MODULE_LICENSE("GPL");