xref: /openbmc/linux/drivers/i2c/i2c-core-acpi.c (revision 360823a09426347ea8f232b0b0b5156d0aed0302)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Linux I2C core ACPI support code
4  *
5  * Copyright (C) 2014 Intel Corp, Author: Lan Tianyu <tianyu.lan@intel.com>
6  */
7 
8 #include <linux/acpi.h>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/i2c.h>
12 #include <linux/list.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 
16 #include "i2c-core.h"
17 
18 struct i2c_acpi_handler_data {
19 	struct acpi_connection_info info;
20 	struct i2c_adapter *adapter;
21 };
22 
23 struct gsb_buffer {
24 	u8	status;
25 	u8	len;
26 	union {
27 		u16	wdata;
28 		u8	bdata;
29 		DECLARE_FLEX_ARRAY(u8, data);
30 	};
31 } __packed;
32 
33 struct i2c_acpi_lookup {
34 	struct i2c_board_info *info;
35 	acpi_handle adapter_handle;
36 	acpi_handle device_handle;
37 	acpi_handle search_handle;
38 	int n;
39 	int index;
40 	u32 speed;
41 	u32 min_speed;
42 	u32 force_speed;
43 };
44 
45 /**
46  * i2c_acpi_get_i2c_resource - Gets I2cSerialBus resource if type matches
47  * @ares:	ACPI resource
48  * @i2c:	Pointer to I2cSerialBus resource will be returned here
49  *
50  * Checks if the given ACPI resource is of type I2cSerialBus.
51  * In this case, returns a pointer to it to the caller.
52  *
53  * Returns true if resource type is of I2cSerialBus, otherwise false.
54  */
i2c_acpi_get_i2c_resource(struct acpi_resource * ares,struct acpi_resource_i2c_serialbus ** i2c)55 bool i2c_acpi_get_i2c_resource(struct acpi_resource *ares,
56 			       struct acpi_resource_i2c_serialbus **i2c)
57 {
58 	struct acpi_resource_i2c_serialbus *sb;
59 
60 	if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
61 		return false;
62 
63 	sb = &ares->data.i2c_serial_bus;
64 	if (sb->type != ACPI_RESOURCE_SERIAL_TYPE_I2C)
65 		return false;
66 
67 	*i2c = sb;
68 	return true;
69 }
70 EXPORT_SYMBOL_GPL(i2c_acpi_get_i2c_resource);
71 
i2c_acpi_resource_count(struct acpi_resource * ares,void * data)72 static int i2c_acpi_resource_count(struct acpi_resource *ares, void *data)
73 {
74 	struct acpi_resource_i2c_serialbus *sb;
75 	int *count = data;
76 
77 	if (i2c_acpi_get_i2c_resource(ares, &sb))
78 		*count = *count + 1;
79 
80 	return 1;
81 }
82 
83 /**
84  * i2c_acpi_client_count - Count the number of I2cSerialBus resources
85  * @adev:	ACPI device
86  *
87  * Returns the number of I2cSerialBus resources in the ACPI-device's
88  * resource-list; or a negative error code.
89  */
i2c_acpi_client_count(struct acpi_device * adev)90 int i2c_acpi_client_count(struct acpi_device *adev)
91 {
92 	int ret, count = 0;
93 	LIST_HEAD(r);
94 
95 	ret = acpi_dev_get_resources(adev, &r, i2c_acpi_resource_count, &count);
96 	if (ret < 0)
97 		return ret;
98 
99 	acpi_dev_free_resource_list(&r);
100 	return count;
101 }
102 EXPORT_SYMBOL_GPL(i2c_acpi_client_count);
103 
i2c_acpi_fill_info(struct acpi_resource * ares,void * data)104 static int i2c_acpi_fill_info(struct acpi_resource *ares, void *data)
105 {
106 	struct i2c_acpi_lookup *lookup = data;
107 	struct i2c_board_info *info = lookup->info;
108 	struct acpi_resource_i2c_serialbus *sb;
109 	acpi_status status;
110 
111 	if (info->addr || !i2c_acpi_get_i2c_resource(ares, &sb))
112 		return 1;
113 
114 	if (lookup->index != -1 && lookup->n++ != lookup->index)
115 		return 1;
116 
117 	status = acpi_get_handle(lookup->device_handle,
118 				 sb->resource_source.string_ptr,
119 				 &lookup->adapter_handle);
120 	if (ACPI_FAILURE(status))
121 		return 1;
122 
123 	info->addr = sb->slave_address;
124 	lookup->speed = sb->connection_speed;
125 	if (sb->access_mode == ACPI_I2C_10BIT_MODE)
126 		info->flags |= I2C_CLIENT_TEN;
127 
128 	return 1;
129 }
130 
131 static const struct acpi_device_id i2c_acpi_ignored_device_ids[] = {
132 	/*
133 	 * ACPI video acpi_devices, which are handled by the acpi-video driver
134 	 * sometimes contain a SERIAL_TYPE_I2C ACPI resource, ignore these.
135 	 */
136 	{ ACPI_VIDEO_HID, 0 },
137 	{}
138 };
139 
140 struct i2c_acpi_irq_context {
141 	int irq;
142 	bool wake_capable;
143 };
144 
i2c_acpi_do_lookup(struct acpi_device * adev,struct i2c_acpi_lookup * lookup)145 static int i2c_acpi_do_lookup(struct acpi_device *adev,
146 			      struct i2c_acpi_lookup *lookup)
147 {
148 	struct i2c_board_info *info = lookup->info;
149 	struct list_head resource_list;
150 	int ret;
151 
152 	if (acpi_bus_get_status(adev))
153 		return -EINVAL;
154 
155 	if (!acpi_dev_ready_for_enumeration(adev))
156 		return -ENODEV;
157 
158 	if (acpi_match_device_ids(adev, i2c_acpi_ignored_device_ids) == 0)
159 		return -ENODEV;
160 
161 	memset(info, 0, sizeof(*info));
162 	lookup->device_handle = acpi_device_handle(adev);
163 
164 	/* Look up for I2cSerialBus resource */
165 	INIT_LIST_HEAD(&resource_list);
166 	ret = acpi_dev_get_resources(adev, &resource_list,
167 				     i2c_acpi_fill_info, lookup);
168 	acpi_dev_free_resource_list(&resource_list);
169 
170 	if (ret < 0 || !info->addr)
171 		return -EINVAL;
172 
173 	return 0;
174 }
175 
i2c_acpi_add_irq_resource(struct acpi_resource * ares,void * data)176 static int i2c_acpi_add_irq_resource(struct acpi_resource *ares, void *data)
177 {
178 	struct i2c_acpi_irq_context *irq_ctx = data;
179 	struct resource r;
180 
181 	if (irq_ctx->irq > 0)
182 		return 1;
183 
184 	if (!acpi_dev_resource_interrupt(ares, 0, &r))
185 		return 1;
186 
187 	irq_ctx->irq = i2c_dev_irq_from_resources(&r, 1);
188 	irq_ctx->wake_capable = r.flags & IORESOURCE_IRQ_WAKECAPABLE;
189 
190 	return 1; /* No need to add resource to the list */
191 }
192 
193 /**
194  * i2c_acpi_get_irq - get device IRQ number from ACPI
195  * @client: Pointer to the I2C client device
196  * @wake_capable: Set to true if the IRQ is wake capable
197  *
198  * Find the IRQ number used by a specific client device.
199  *
200  * Return: The IRQ number or an error code.
201  */
i2c_acpi_get_irq(struct i2c_client * client,bool * wake_capable)202 int i2c_acpi_get_irq(struct i2c_client *client, bool *wake_capable)
203 {
204 	struct acpi_device *adev = ACPI_COMPANION(&client->dev);
205 	struct list_head resource_list;
206 	struct i2c_acpi_irq_context irq_ctx = {
207 		.irq = -ENOENT,
208 	};
209 	int ret;
210 
211 	INIT_LIST_HEAD(&resource_list);
212 
213 	ret = acpi_dev_get_resources(adev, &resource_list,
214 				     i2c_acpi_add_irq_resource, &irq_ctx);
215 	if (ret < 0)
216 		return ret;
217 
218 	acpi_dev_free_resource_list(&resource_list);
219 
220 	if (irq_ctx.irq == -ENOENT)
221 		irq_ctx.irq = acpi_dev_gpio_irq_wake_get(adev, 0, &irq_ctx.wake_capable);
222 
223 	if (irq_ctx.irq < 0)
224 		return irq_ctx.irq;
225 
226 	if (wake_capable)
227 		*wake_capable = irq_ctx.wake_capable;
228 
229 	return irq_ctx.irq;
230 }
231 
i2c_acpi_get_info(struct acpi_device * adev,struct i2c_board_info * info,struct i2c_adapter * adapter,acpi_handle * adapter_handle)232 static int i2c_acpi_get_info(struct acpi_device *adev,
233 			     struct i2c_board_info *info,
234 			     struct i2c_adapter *adapter,
235 			     acpi_handle *adapter_handle)
236 {
237 	struct i2c_acpi_lookup lookup;
238 	int ret;
239 
240 	memset(&lookup, 0, sizeof(lookup));
241 	lookup.info = info;
242 	lookup.index = -1;
243 
244 	if (acpi_device_enumerated(adev))
245 		return -EINVAL;
246 
247 	ret = i2c_acpi_do_lookup(adev, &lookup);
248 	if (ret)
249 		return ret;
250 
251 	if (adapter) {
252 		/* The adapter must match the one in I2cSerialBus() connector */
253 		if (ACPI_HANDLE(&adapter->dev) != lookup.adapter_handle)
254 			return -ENODEV;
255 	} else {
256 		struct acpi_device *adapter_adev;
257 
258 		/* The adapter must be present */
259 		adapter_adev = acpi_fetch_acpi_dev(lookup.adapter_handle);
260 		if (!adapter_adev)
261 			return -ENODEV;
262 		if (acpi_bus_get_status(adapter_adev) ||
263 		    !adapter_adev->status.present)
264 			return -ENODEV;
265 	}
266 
267 	info->fwnode = acpi_fwnode_handle(adev);
268 	if (adapter_handle)
269 		*adapter_handle = lookup.adapter_handle;
270 
271 	acpi_set_modalias(adev, dev_name(&adev->dev), info->type,
272 			  sizeof(info->type));
273 
274 	return 0;
275 }
276 
i2c_acpi_register_device(struct i2c_adapter * adapter,struct acpi_device * adev,struct i2c_board_info * info)277 static void i2c_acpi_register_device(struct i2c_adapter *adapter,
278 				     struct acpi_device *adev,
279 				     struct i2c_board_info *info)
280 {
281 	/*
282 	 * Skip registration on boards where the ACPI tables are
283 	 * known to contain bogus I2C devices.
284 	 */
285 	if (acpi_quirk_skip_i2c_client_enumeration(adev))
286 		return;
287 
288 	adev->power.flags.ignore_parent = true;
289 	acpi_device_set_enumerated(adev);
290 
291 	if (IS_ERR(i2c_new_client_device(adapter, info)))
292 		adev->power.flags.ignore_parent = false;
293 }
294 
i2c_acpi_add_device(acpi_handle handle,u32 level,void * data,void ** return_value)295 static acpi_status i2c_acpi_add_device(acpi_handle handle, u32 level,
296 				       void *data, void **return_value)
297 {
298 	struct i2c_adapter *adapter = data;
299 	struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
300 	struct i2c_board_info info;
301 
302 	if (!adev || i2c_acpi_get_info(adev, &info, adapter, NULL))
303 		return AE_OK;
304 
305 	i2c_acpi_register_device(adapter, adev, &info);
306 
307 	return AE_OK;
308 }
309 
310 #define I2C_ACPI_MAX_SCAN_DEPTH 32
311 
312 /**
313  * i2c_acpi_register_devices - enumerate I2C slave devices behind adapter
314  * @adap: pointer to adapter
315  *
316  * Enumerate all I2C slave devices behind this adapter by walking the ACPI
317  * namespace. When a device is found it will be added to the Linux device
318  * model and bound to the corresponding ACPI handle.
319  */
i2c_acpi_register_devices(struct i2c_adapter * adap)320 void i2c_acpi_register_devices(struct i2c_adapter *adap)
321 {
322 	struct acpi_device *adev;
323 	acpi_status status;
324 
325 	if (!has_acpi_companion(&adap->dev))
326 		return;
327 
328 	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
329 				     I2C_ACPI_MAX_SCAN_DEPTH,
330 				     i2c_acpi_add_device, NULL,
331 				     adap, NULL);
332 	if (ACPI_FAILURE(status))
333 		dev_warn(&adap->dev, "failed to enumerate I2C slaves\n");
334 
335 	if (!adap->dev.parent)
336 		return;
337 
338 	adev = ACPI_COMPANION(adap->dev.parent);
339 	if (!adev)
340 		return;
341 
342 	acpi_dev_clear_dependencies(adev);
343 }
344 
345 static const struct acpi_device_id i2c_acpi_force_400khz_device_ids[] = {
346 	/*
347 	 * These Silead touchscreen controllers only work at 400KHz, for
348 	 * some reason they do not work at 100KHz. On some devices the ACPI
349 	 * tables list another device at their bus as only being capable
350 	 * of 100KHz, testing has shown that these other devices work fine
351 	 * at 400KHz (as can be expected of any recent i2c hw) so we force
352 	 * the speed of the bus to 400 KHz if a Silead device is present.
353 	 */
354 	{ "MSSL1680", 0 },
355 	{}
356 };
357 
358 static const struct acpi_device_id i2c_acpi_force_100khz_device_ids[] = {
359 	/*
360 	 * When a 400KHz freq is used on this model of ELAN touchpad in Linux,
361 	 * excessive smoothing (similar to when the touchpad's firmware detects
362 	 * a noisy signal) is sometimes applied. As some devices' (e.g, Lenovo
363 	 * V15 G4) ACPI tables specify a 400KHz frequency for this device and
364 	 * some I2C busses (e.g, Designware I2C) default to a 400KHz freq,
365 	 * force the speed to 100KHz as a workaround.
366 	 *
367 	 * For future investigation: This problem may be related to the default
368 	 * HCNT/LCNT values given by some busses' drivers, because they are not
369 	 * specified in the aforementioned devices' ACPI tables, and because
370 	 * the device works without issues on Windows at what is expected to be
371 	 * a 400KHz frequency. The root cause of the issue is not known.
372 	 */
373 	{ "ELAN06FA", 0 },
374 	{}
375 };
376 
i2c_acpi_lookup_speed(acpi_handle handle,u32 level,void * data,void ** return_value)377 static acpi_status i2c_acpi_lookup_speed(acpi_handle handle, u32 level,
378 					   void *data, void **return_value)
379 {
380 	struct i2c_acpi_lookup *lookup = data;
381 	struct acpi_device *adev = acpi_fetch_acpi_dev(handle);
382 
383 	if (!adev || i2c_acpi_do_lookup(adev, lookup))
384 		return AE_OK;
385 
386 	if (lookup->search_handle != lookup->adapter_handle)
387 		return AE_OK;
388 
389 	if (lookup->speed <= lookup->min_speed)
390 		lookup->min_speed = lookup->speed;
391 
392 	if (acpi_match_device_ids(adev, i2c_acpi_force_400khz_device_ids) == 0)
393 		lookup->force_speed = I2C_MAX_FAST_MODE_FREQ;
394 
395 	if (acpi_match_device_ids(adev, i2c_acpi_force_100khz_device_ids) == 0)
396 		lookup->force_speed = I2C_MAX_STANDARD_MODE_FREQ;
397 
398 	return AE_OK;
399 }
400 
401 /**
402  * i2c_acpi_find_bus_speed - find I2C bus speed from ACPI
403  * @dev: The device owning the bus
404  *
405  * Find the I2C bus speed by walking the ACPI namespace for all I2C slaves
406  * devices connected to this bus and use the speed of slowest device.
407  *
408  * Returns the speed in Hz or zero
409  */
i2c_acpi_find_bus_speed(struct device * dev)410 u32 i2c_acpi_find_bus_speed(struct device *dev)
411 {
412 	struct i2c_acpi_lookup lookup;
413 	struct i2c_board_info dummy;
414 	acpi_status status;
415 
416 	if (!has_acpi_companion(dev))
417 		return 0;
418 
419 	memset(&lookup, 0, sizeof(lookup));
420 	lookup.search_handle = ACPI_HANDLE(dev);
421 	lookup.min_speed = UINT_MAX;
422 	lookup.info = &dummy;
423 	lookup.index = -1;
424 
425 	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
426 				     I2C_ACPI_MAX_SCAN_DEPTH,
427 				     i2c_acpi_lookup_speed, NULL,
428 				     &lookup, NULL);
429 
430 	if (ACPI_FAILURE(status)) {
431 		dev_warn(dev, "unable to find I2C bus speed from ACPI\n");
432 		return 0;
433 	}
434 
435 	if (lookup.force_speed) {
436 		if (lookup.force_speed != lookup.min_speed)
437 			dev_warn(dev, FW_BUG "DSDT uses known not-working I2C bus speed %d, forcing it to %d\n",
438 				 lookup.min_speed, lookup.force_speed);
439 		return lookup.force_speed;
440 	} else if (lookup.min_speed != UINT_MAX) {
441 		return lookup.min_speed;
442 	} else {
443 		return 0;
444 	}
445 }
446 EXPORT_SYMBOL_GPL(i2c_acpi_find_bus_speed);
447 
i2c_acpi_find_adapter_by_handle(acpi_handle handle)448 struct i2c_adapter *i2c_acpi_find_adapter_by_handle(acpi_handle handle)
449 {
450 	struct i2c_adapter *adapter;
451 	struct device *dev;
452 
453 	dev = bus_find_device(&i2c_bus_type, NULL, handle, device_match_acpi_handle);
454 	if (!dev)
455 		return NULL;
456 
457 	adapter = i2c_verify_adapter(dev);
458 	if (!adapter)
459 		put_device(dev);
460 
461 	return adapter;
462 }
463 EXPORT_SYMBOL_GPL(i2c_acpi_find_adapter_by_handle);
464 
i2c_acpi_find_client_by_adev(struct acpi_device * adev)465 static struct i2c_client *i2c_acpi_find_client_by_adev(struct acpi_device *adev)
466 {
467 	return i2c_find_device_by_fwnode(acpi_fwnode_handle(adev));
468 }
469 
i2c_acpi_find_adapter_by_adev(struct acpi_device * adev)470 static struct i2c_adapter *i2c_acpi_find_adapter_by_adev(struct acpi_device *adev)
471 {
472 	return i2c_find_adapter_by_fwnode(acpi_fwnode_handle(adev));
473 }
474 
i2c_acpi_notify(struct notifier_block * nb,unsigned long value,void * arg)475 static int i2c_acpi_notify(struct notifier_block *nb, unsigned long value,
476 			   void *arg)
477 {
478 	struct acpi_device *adev = arg;
479 	struct i2c_board_info info;
480 	acpi_handle adapter_handle;
481 	struct i2c_adapter *adapter;
482 	struct i2c_client *client;
483 
484 	switch (value) {
485 	case ACPI_RECONFIG_DEVICE_ADD:
486 		if (i2c_acpi_get_info(adev, &info, NULL, &adapter_handle))
487 			break;
488 
489 		adapter = i2c_acpi_find_adapter_by_handle(adapter_handle);
490 		if (!adapter)
491 			break;
492 
493 		i2c_acpi_register_device(adapter, adev, &info);
494 		put_device(&adapter->dev);
495 		break;
496 	case ACPI_RECONFIG_DEVICE_REMOVE:
497 		if (!acpi_device_enumerated(adev))
498 			break;
499 
500 		client = i2c_acpi_find_client_by_adev(adev);
501 		if (client) {
502 			i2c_unregister_device(client);
503 			put_device(&client->dev);
504 		}
505 
506 		adapter = i2c_acpi_find_adapter_by_adev(adev);
507 		if (adapter) {
508 			acpi_unbind_one(&adapter->dev);
509 			put_device(&adapter->dev);
510 		}
511 
512 		break;
513 	}
514 
515 	return NOTIFY_OK;
516 }
517 
518 struct notifier_block i2c_acpi_notifier = {
519 	.notifier_call = i2c_acpi_notify,
520 };
521 
522 /**
523  * i2c_acpi_new_device_by_fwnode - Create i2c-client for the Nth I2cSerialBus resource
524  * @fwnode:  fwnode with the ACPI resources to get the client from
525  * @index:   Index of ACPI resource to get
526  * @info:    describes the I2C device; note this is modified (addr gets set)
527  * Context: can sleep
528  *
529  * By default the i2c subsys creates an i2c-client for the first I2cSerialBus
530  * resource of an acpi_device, but some acpi_devices have multiple I2cSerialBus
531  * resources, in that case this function can be used to create an i2c-client
532  * for other I2cSerialBus resources in the Current Resource Settings table.
533  *
534  * Also see i2c_new_client_device, which this function calls to create the
535  * i2c-client.
536  *
537  * Returns a pointer to the new i2c-client, or error pointer in case of failure.
538  * Specifically, -EPROBE_DEFER is returned if the adapter is not found.
539  */
i2c_acpi_new_device_by_fwnode(struct fwnode_handle * fwnode,int index,struct i2c_board_info * info)540 struct i2c_client *i2c_acpi_new_device_by_fwnode(struct fwnode_handle *fwnode,
541 						 int index,
542 						 struct i2c_board_info *info)
543 {
544 	struct i2c_acpi_lookup lookup;
545 	struct i2c_adapter *adapter;
546 	struct acpi_device *adev;
547 	LIST_HEAD(resource_list);
548 	int ret;
549 
550 	adev = to_acpi_device_node(fwnode);
551 	if (!adev)
552 		return ERR_PTR(-ENODEV);
553 
554 	memset(&lookup, 0, sizeof(lookup));
555 	lookup.info = info;
556 	lookup.device_handle = acpi_device_handle(adev);
557 	lookup.index = index;
558 
559 	ret = acpi_dev_get_resources(adev, &resource_list,
560 				     i2c_acpi_fill_info, &lookup);
561 	if (ret < 0)
562 		return ERR_PTR(ret);
563 
564 	acpi_dev_free_resource_list(&resource_list);
565 
566 	if (!info->addr)
567 		return ERR_PTR(-EADDRNOTAVAIL);
568 
569 	adapter = i2c_acpi_find_adapter_by_handle(lookup.adapter_handle);
570 	if (!adapter)
571 		return ERR_PTR(-EPROBE_DEFER);
572 
573 	return i2c_new_client_device(adapter, info);
574 }
575 EXPORT_SYMBOL_GPL(i2c_acpi_new_device_by_fwnode);
576 
i2c_acpi_waive_d0_probe(struct device * dev)577 bool i2c_acpi_waive_d0_probe(struct device *dev)
578 {
579 	struct i2c_driver *driver = to_i2c_driver(dev->driver);
580 	struct acpi_device *adev = ACPI_COMPANION(dev);
581 
582 	return driver->flags & I2C_DRV_ACPI_WAIVE_D0_PROBE &&
583 		adev && adev->power.state_for_enumeration >= adev->power.state;
584 }
585 EXPORT_SYMBOL_GPL(i2c_acpi_waive_d0_probe);
586 
587 #ifdef CONFIG_ACPI_I2C_OPREGION
acpi_gsb_i2c_read_bytes(struct i2c_client * client,u8 cmd,u8 * data,u8 data_len)588 static int acpi_gsb_i2c_read_bytes(struct i2c_client *client,
589 		u8 cmd, u8 *data, u8 data_len)
590 {
591 
592 	struct i2c_msg msgs[2];
593 	int ret;
594 	u8 *buffer;
595 
596 	buffer = kzalloc(data_len, GFP_KERNEL);
597 	if (!buffer)
598 		return AE_NO_MEMORY;
599 
600 	msgs[0].addr = client->addr;
601 	msgs[0].flags = client->flags;
602 	msgs[0].len = 1;
603 	msgs[0].buf = &cmd;
604 
605 	msgs[1].addr = client->addr;
606 	msgs[1].flags = client->flags | I2C_M_RD;
607 	msgs[1].len = data_len;
608 	msgs[1].buf = buffer;
609 
610 	ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
611 	if (ret < 0) {
612 		/* Getting a NACK is unfortunately normal with some DSTDs */
613 		if (ret == -EREMOTEIO)
614 			dev_dbg(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
615 				data_len, client->addr, cmd, ret);
616 		else
617 			dev_err(&client->adapter->dev, "i2c read %d bytes from client@%#x starting at reg %#x failed, error: %d\n",
618 				data_len, client->addr, cmd, ret);
619 	/* 2 transfers must have completed successfully */
620 	} else if (ret == 2) {
621 		memcpy(data, buffer, data_len);
622 		ret = 0;
623 	} else {
624 		ret = -EIO;
625 	}
626 
627 	kfree(buffer);
628 	return ret;
629 }
630 
acpi_gsb_i2c_write_bytes(struct i2c_client * client,u8 cmd,u8 * data,u8 data_len)631 static int acpi_gsb_i2c_write_bytes(struct i2c_client *client,
632 		u8 cmd, u8 *data, u8 data_len)
633 {
634 
635 	struct i2c_msg msgs[1];
636 	u8 *buffer;
637 	int ret = AE_OK;
638 
639 	buffer = kzalloc(data_len + 1, GFP_KERNEL);
640 	if (!buffer)
641 		return AE_NO_MEMORY;
642 
643 	buffer[0] = cmd;
644 	memcpy(buffer + 1, data, data_len);
645 
646 	msgs[0].addr = client->addr;
647 	msgs[0].flags = client->flags;
648 	msgs[0].len = data_len + 1;
649 	msgs[0].buf = buffer;
650 
651 	ret = i2c_transfer(client->adapter, msgs, ARRAY_SIZE(msgs));
652 
653 	kfree(buffer);
654 
655 	if (ret < 0) {
656 		dev_err(&client->adapter->dev, "i2c write failed: %d\n", ret);
657 		return ret;
658 	}
659 
660 	/* 1 transfer must have completed successfully */
661 	return (ret == 1) ? 0 : -EIO;
662 }
663 
664 static acpi_status
i2c_acpi_space_handler(u32 function,acpi_physical_address command,u32 bits,u64 * value64,void * handler_context,void * region_context)665 i2c_acpi_space_handler(u32 function, acpi_physical_address command,
666 			u32 bits, u64 *value64,
667 			void *handler_context, void *region_context)
668 {
669 	struct gsb_buffer *gsb = (struct gsb_buffer *)value64;
670 	struct i2c_acpi_handler_data *data = handler_context;
671 	struct acpi_connection_info *info = &data->info;
672 	struct acpi_resource_i2c_serialbus *sb;
673 	struct i2c_adapter *adapter = data->adapter;
674 	struct i2c_client *client;
675 	struct acpi_resource *ares;
676 	u32 accessor_type = function >> 16;
677 	u8 action = function & ACPI_IO_MASK;
678 	acpi_status ret;
679 	int status;
680 
681 	ret = acpi_buffer_to_resource(info->connection, info->length, &ares);
682 	if (ACPI_FAILURE(ret))
683 		return ret;
684 
685 	client = kzalloc(sizeof(*client), GFP_KERNEL);
686 	if (!client) {
687 		ret = AE_NO_MEMORY;
688 		goto err;
689 	}
690 
691 	if (!value64 || !i2c_acpi_get_i2c_resource(ares, &sb)) {
692 		ret = AE_BAD_PARAMETER;
693 		goto err;
694 	}
695 
696 	client->adapter = adapter;
697 	client->addr = sb->slave_address;
698 
699 	if (sb->access_mode == ACPI_I2C_10BIT_MODE)
700 		client->flags |= I2C_CLIENT_TEN;
701 
702 	switch (accessor_type) {
703 	case ACPI_GSB_ACCESS_ATTRIB_SEND_RCV:
704 		if (action == ACPI_READ) {
705 			status = i2c_smbus_read_byte(client);
706 			if (status >= 0) {
707 				gsb->bdata = status;
708 				status = 0;
709 			}
710 		} else {
711 			status = i2c_smbus_write_byte(client, gsb->bdata);
712 		}
713 		break;
714 
715 	case ACPI_GSB_ACCESS_ATTRIB_BYTE:
716 		if (action == ACPI_READ) {
717 			status = i2c_smbus_read_byte_data(client, command);
718 			if (status >= 0) {
719 				gsb->bdata = status;
720 				status = 0;
721 			}
722 		} else {
723 			status = i2c_smbus_write_byte_data(client, command,
724 					gsb->bdata);
725 		}
726 		break;
727 
728 	case ACPI_GSB_ACCESS_ATTRIB_WORD:
729 		if (action == ACPI_READ) {
730 			status = i2c_smbus_read_word_data(client, command);
731 			if (status >= 0) {
732 				gsb->wdata = status;
733 				status = 0;
734 			}
735 		} else {
736 			status = i2c_smbus_write_word_data(client, command,
737 					gsb->wdata);
738 		}
739 		break;
740 
741 	case ACPI_GSB_ACCESS_ATTRIB_BLOCK:
742 		if (action == ACPI_READ) {
743 			status = i2c_smbus_read_block_data(client, command,
744 					gsb->data);
745 			if (status >= 0) {
746 				gsb->len = status;
747 				status = 0;
748 			}
749 		} else {
750 			status = i2c_smbus_write_block_data(client, command,
751 					gsb->len, gsb->data);
752 		}
753 		break;
754 
755 	case ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE:
756 		if (action == ACPI_READ) {
757 			status = acpi_gsb_i2c_read_bytes(client, command,
758 					gsb->data, info->access_length);
759 		} else {
760 			status = acpi_gsb_i2c_write_bytes(client, command,
761 					gsb->data, info->access_length);
762 		}
763 		break;
764 
765 	default:
766 		dev_warn(&adapter->dev, "protocol 0x%02x not supported for client 0x%02x\n",
767 			 accessor_type, client->addr);
768 		ret = AE_BAD_PARAMETER;
769 		goto err;
770 	}
771 
772 	gsb->status = status;
773 
774  err:
775 	kfree(client);
776 	ACPI_FREE(ares);
777 	return ret;
778 }
779 
780 
i2c_acpi_install_space_handler(struct i2c_adapter * adapter)781 int i2c_acpi_install_space_handler(struct i2c_adapter *adapter)
782 {
783 	acpi_handle handle;
784 	struct i2c_acpi_handler_data *data;
785 	acpi_status status;
786 
787 	if (!adapter->dev.parent)
788 		return -ENODEV;
789 
790 	handle = ACPI_HANDLE(adapter->dev.parent);
791 
792 	if (!handle)
793 		return -ENODEV;
794 
795 	data = kzalloc(sizeof(struct i2c_acpi_handler_data),
796 			    GFP_KERNEL);
797 	if (!data)
798 		return -ENOMEM;
799 
800 	data->adapter = adapter;
801 	status = acpi_bus_attach_private_data(handle, (void *)data);
802 	if (ACPI_FAILURE(status)) {
803 		kfree(data);
804 		return -ENOMEM;
805 	}
806 
807 	status = acpi_install_address_space_handler(handle,
808 				ACPI_ADR_SPACE_GSBUS,
809 				&i2c_acpi_space_handler,
810 				NULL,
811 				data);
812 	if (ACPI_FAILURE(status)) {
813 		dev_err(&adapter->dev, "Error installing i2c space handler\n");
814 		acpi_bus_detach_private_data(handle);
815 		kfree(data);
816 		return -ENOMEM;
817 	}
818 
819 	return 0;
820 }
821 
i2c_acpi_remove_space_handler(struct i2c_adapter * adapter)822 void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter)
823 {
824 	acpi_handle handle;
825 	struct i2c_acpi_handler_data *data;
826 	acpi_status status;
827 
828 	if (!adapter->dev.parent)
829 		return;
830 
831 	handle = ACPI_HANDLE(adapter->dev.parent);
832 
833 	if (!handle)
834 		return;
835 
836 	acpi_remove_address_space_handler(handle,
837 				ACPI_ADR_SPACE_GSBUS,
838 				&i2c_acpi_space_handler);
839 
840 	status = acpi_bus_get_private_data(handle, (void **)&data);
841 	if (ACPI_SUCCESS(status))
842 		kfree(data);
843 
844 	acpi_bus_detach_private_data(handle);
845 }
846 #endif /* CONFIG_ACPI_I2C_OPREGION */
847