xref: /OK3568_Linux_fs/kernel/drivers/tty/serdev/core.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2016-2017 Linaro Ltd., Rob Herring <robh@kernel.org>
4  *
5  * Based on drivers/spmi/spmi.c:
6  * Copyright (c) 2012-2015, The Linux Foundation. All rights reserved.
7  */
8 
9 #include <linux/acpi.h>
10 #include <linux/errno.h>
11 #include <linux/idr.h>
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/of.h>
15 #include <linux/of_device.h>
16 #include <linux/pm_domain.h>
17 #include <linux/pm_runtime.h>
18 #include <linux/sched.h>
19 #include <linux/serdev.h>
20 #include <linux/slab.h>
21 #include <linux/platform_data/x86/apple.h>
22 
23 static bool is_registered;
24 static DEFINE_IDA(ctrl_ida);
25 
modalias_show(struct device * dev,struct device_attribute * attr,char * buf)26 static ssize_t modalias_show(struct device *dev,
27 			     struct device_attribute *attr, char *buf)
28 {
29 	int len;
30 
31 	len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
32 	if (len != -ENODEV)
33 		return len;
34 
35 	len = of_device_modalias(dev, buf, PAGE_SIZE);
36 	if (len != -ENODEV)
37 		return len;
38 
39 	if (dev->parent->parent->bus == &platform_bus_type) {
40 		struct platform_device *pdev =
41 			to_platform_device(dev->parent->parent);
42 
43 		len = snprintf(buf, PAGE_SIZE, "platform:%s\n", pdev->name);
44 	}
45 
46 	return len;
47 }
48 static DEVICE_ATTR_RO(modalias);
49 
50 static struct attribute *serdev_device_attrs[] = {
51 	&dev_attr_modalias.attr,
52 	NULL,
53 };
54 ATTRIBUTE_GROUPS(serdev_device);
55 
serdev_device_uevent(struct device * dev,struct kobj_uevent_env * env)56 static int serdev_device_uevent(struct device *dev, struct kobj_uevent_env *env)
57 {
58 	int rc;
59 
60 	rc = acpi_device_uevent_modalias(dev, env);
61 	if (rc != -ENODEV)
62 		return rc;
63 
64 	rc = of_device_uevent_modalias(dev, env);
65 	if (rc != -ENODEV)
66 		return rc;
67 
68 	if (dev->parent->parent->bus == &platform_bus_type)
69 		rc = dev->parent->parent->bus->uevent(dev->parent->parent, env);
70 
71 	return rc;
72 }
73 
serdev_device_release(struct device * dev)74 static void serdev_device_release(struct device *dev)
75 {
76 	struct serdev_device *serdev = to_serdev_device(dev);
77 	kfree(serdev);
78 }
79 
80 static const struct device_type serdev_device_type = {
81 	.groups		= serdev_device_groups,
82 	.uevent		= serdev_device_uevent,
83 	.release	= serdev_device_release,
84 };
85 
is_serdev_device(const struct device * dev)86 static bool is_serdev_device(const struct device *dev)
87 {
88 	return dev->type == &serdev_device_type;
89 }
90 
serdev_ctrl_release(struct device * dev)91 static void serdev_ctrl_release(struct device *dev)
92 {
93 	struct serdev_controller *ctrl = to_serdev_controller(dev);
94 	ida_simple_remove(&ctrl_ida, ctrl->nr);
95 	kfree(ctrl);
96 }
97 
98 static const struct device_type serdev_ctrl_type = {
99 	.release	= serdev_ctrl_release,
100 };
101 
serdev_device_match(struct device * dev,struct device_driver * drv)102 static int serdev_device_match(struct device *dev, struct device_driver *drv)
103 {
104 	if (!is_serdev_device(dev))
105 		return 0;
106 
107 	if (acpi_driver_match_device(dev, drv))
108 		return 1;
109 
110 	if (of_driver_match_device(dev, drv))
111 		return 1;
112 
113 	if (dev->parent->parent->bus == &platform_bus_type &&
114 	    dev->parent->parent->bus->match(dev->parent->parent, drv))
115 		return 1;
116 
117 	return 0;
118 }
119 
120 /**
121  * serdev_device_add() - add a device previously constructed via serdev_device_alloc()
122  * @serdev:	serdev_device to be added
123  */
serdev_device_add(struct serdev_device * serdev)124 int serdev_device_add(struct serdev_device *serdev)
125 {
126 	struct serdev_controller *ctrl = serdev->ctrl;
127 	struct device *parent = serdev->dev.parent;
128 	int err;
129 
130 	dev_set_name(&serdev->dev, "%s-%d", dev_name(parent), serdev->nr);
131 
132 	/* Only a single slave device is currently supported. */
133 	if (ctrl->serdev) {
134 		dev_err(&serdev->dev, "controller busy\n");
135 		return -EBUSY;
136 	}
137 	ctrl->serdev = serdev;
138 
139 	err = device_add(&serdev->dev);
140 	if (err < 0) {
141 		dev_err(&serdev->dev, "Can't add %s, status %pe\n",
142 			dev_name(&serdev->dev), ERR_PTR(err));
143 		goto err_clear_serdev;
144 	}
145 
146 	dev_dbg(&serdev->dev, "device %s registered\n", dev_name(&serdev->dev));
147 
148 	return 0;
149 
150 err_clear_serdev:
151 	ctrl->serdev = NULL;
152 	return err;
153 }
154 EXPORT_SYMBOL_GPL(serdev_device_add);
155 
156 /**
157  * serdev_device_remove(): remove an serdev device
158  * @serdev:	serdev_device to be removed
159  */
serdev_device_remove(struct serdev_device * serdev)160 void serdev_device_remove(struct serdev_device *serdev)
161 {
162 	struct serdev_controller *ctrl = serdev->ctrl;
163 
164 	device_unregister(&serdev->dev);
165 	ctrl->serdev = NULL;
166 }
167 EXPORT_SYMBOL_GPL(serdev_device_remove);
168 
serdev_device_open(struct serdev_device * serdev)169 int serdev_device_open(struct serdev_device *serdev)
170 {
171 	struct serdev_controller *ctrl = serdev->ctrl;
172 	int ret;
173 
174 	if (!ctrl || !ctrl->ops->open)
175 		return -EINVAL;
176 
177 	ret = ctrl->ops->open(ctrl);
178 	if (ret)
179 		return ret;
180 
181 	ret = pm_runtime_get_sync(&ctrl->dev);
182 	if (ret < 0) {
183 		pm_runtime_put_noidle(&ctrl->dev);
184 		goto err_close;
185 	}
186 
187 	return 0;
188 
189 err_close:
190 	if (ctrl->ops->close)
191 		ctrl->ops->close(ctrl);
192 
193 	return ret;
194 }
195 EXPORT_SYMBOL_GPL(serdev_device_open);
196 
serdev_device_close(struct serdev_device * serdev)197 void serdev_device_close(struct serdev_device *serdev)
198 {
199 	struct serdev_controller *ctrl = serdev->ctrl;
200 
201 	if (!ctrl || !ctrl->ops->close)
202 		return;
203 
204 	pm_runtime_put(&ctrl->dev);
205 
206 	ctrl->ops->close(ctrl);
207 }
208 EXPORT_SYMBOL_GPL(serdev_device_close);
209 
devm_serdev_device_release(struct device * dev,void * dr)210 static void devm_serdev_device_release(struct device *dev, void *dr)
211 {
212 	serdev_device_close(*(struct serdev_device **)dr);
213 }
214 
devm_serdev_device_open(struct device * dev,struct serdev_device * serdev)215 int devm_serdev_device_open(struct device *dev, struct serdev_device *serdev)
216 {
217 	struct serdev_device **dr;
218 	int ret;
219 
220 	dr = devres_alloc(devm_serdev_device_release, sizeof(*dr), GFP_KERNEL);
221 	if (!dr)
222 		return -ENOMEM;
223 
224 	ret = serdev_device_open(serdev);
225 	if (ret) {
226 		devres_free(dr);
227 		return ret;
228 	}
229 
230 	*dr = serdev;
231 	devres_add(dev, dr);
232 
233 	return 0;
234 }
235 EXPORT_SYMBOL_GPL(devm_serdev_device_open);
236 
serdev_device_write_wakeup(struct serdev_device * serdev)237 void serdev_device_write_wakeup(struct serdev_device *serdev)
238 {
239 	complete(&serdev->write_comp);
240 }
241 EXPORT_SYMBOL_GPL(serdev_device_write_wakeup);
242 
243 /**
244  * serdev_device_write_buf() - write data asynchronously
245  * @serdev:	serdev device
246  * @buf:	data to be written
247  * @count:	number of bytes to write
248  *
249  * Write data to the device asynchronously.
250  *
251  * Note that any accepted data has only been buffered by the controller; use
252  * serdev_device_wait_until_sent() to make sure the controller write buffer
253  * has actually been emptied.
254  *
255  * Return: The number of bytes written (less than count if not enough room in
256  * the write buffer), or a negative errno on errors.
257  */
serdev_device_write_buf(struct serdev_device * serdev,const unsigned char * buf,size_t count)258 int serdev_device_write_buf(struct serdev_device *serdev,
259 			    const unsigned char *buf, size_t count)
260 {
261 	struct serdev_controller *ctrl = serdev->ctrl;
262 
263 	if (!ctrl || !ctrl->ops->write_buf)
264 		return -EINVAL;
265 
266 	return ctrl->ops->write_buf(ctrl, buf, count);
267 }
268 EXPORT_SYMBOL_GPL(serdev_device_write_buf);
269 
270 /**
271  * serdev_device_write() - write data synchronously
272  * @serdev:	serdev device
273  * @buf:	data to be written
274  * @count:	number of bytes to write
275  * @timeout:	timeout in jiffies, or 0 to wait indefinitely
276  *
277  * Write data to the device synchronously by repeatedly calling
278  * serdev_device_write() until the controller has accepted all data (unless
279  * interrupted by a timeout or a signal).
280  *
281  * Note that any accepted data has only been buffered by the controller; use
282  * serdev_device_wait_until_sent() to make sure the controller write buffer
283  * has actually been emptied.
284  *
285  * Note that this function depends on serdev_device_write_wakeup() being
286  * called in the serdev driver write_wakeup() callback.
287  *
288  * Return: The number of bytes written (less than count if interrupted),
289  * -ETIMEDOUT or -ERESTARTSYS if interrupted before any bytes were written, or
290  * a negative errno on errors.
291  */
serdev_device_write(struct serdev_device * serdev,const unsigned char * buf,size_t count,long timeout)292 int serdev_device_write(struct serdev_device *serdev,
293 			const unsigned char *buf, size_t count,
294 			long timeout)
295 {
296 	struct serdev_controller *ctrl = serdev->ctrl;
297 	int written = 0;
298 	int ret;
299 
300 	if (!ctrl || !ctrl->ops->write_buf || !serdev->ops->write_wakeup)
301 		return -EINVAL;
302 
303 	if (timeout == 0)
304 		timeout = MAX_SCHEDULE_TIMEOUT;
305 
306 	mutex_lock(&serdev->write_lock);
307 	do {
308 		reinit_completion(&serdev->write_comp);
309 
310 		ret = ctrl->ops->write_buf(ctrl, buf, count);
311 		if (ret < 0)
312 			break;
313 
314 		written += ret;
315 		buf += ret;
316 		count -= ret;
317 
318 		if (count == 0)
319 			break;
320 
321 		timeout = wait_for_completion_interruptible_timeout(&serdev->write_comp,
322 								    timeout);
323 	} while (timeout > 0);
324 	mutex_unlock(&serdev->write_lock);
325 
326 	if (ret < 0)
327 		return ret;
328 
329 	if (timeout <= 0 && written == 0) {
330 		if (timeout == -ERESTARTSYS)
331 			return -ERESTARTSYS;
332 		else
333 			return -ETIMEDOUT;
334 	}
335 
336 	return written;
337 }
338 EXPORT_SYMBOL_GPL(serdev_device_write);
339 
serdev_device_write_flush(struct serdev_device * serdev)340 void serdev_device_write_flush(struct serdev_device *serdev)
341 {
342 	struct serdev_controller *ctrl = serdev->ctrl;
343 
344 	if (!ctrl || !ctrl->ops->write_flush)
345 		return;
346 
347 	ctrl->ops->write_flush(ctrl);
348 }
349 EXPORT_SYMBOL_GPL(serdev_device_write_flush);
350 
serdev_device_write_room(struct serdev_device * serdev)351 int serdev_device_write_room(struct serdev_device *serdev)
352 {
353 	struct serdev_controller *ctrl = serdev->ctrl;
354 
355 	if (!ctrl || !ctrl->ops->write_room)
356 		return 0;
357 
358 	return serdev->ctrl->ops->write_room(ctrl);
359 }
360 EXPORT_SYMBOL_GPL(serdev_device_write_room);
361 
serdev_device_set_baudrate(struct serdev_device * serdev,unsigned int speed)362 unsigned int serdev_device_set_baudrate(struct serdev_device *serdev, unsigned int speed)
363 {
364 	struct serdev_controller *ctrl = serdev->ctrl;
365 
366 	if (!ctrl || !ctrl->ops->set_baudrate)
367 		return 0;
368 
369 	return ctrl->ops->set_baudrate(ctrl, speed);
370 
371 }
372 EXPORT_SYMBOL_GPL(serdev_device_set_baudrate);
373 
serdev_device_set_flow_control(struct serdev_device * serdev,bool enable)374 void serdev_device_set_flow_control(struct serdev_device *serdev, bool enable)
375 {
376 	struct serdev_controller *ctrl = serdev->ctrl;
377 
378 	if (!ctrl || !ctrl->ops->set_flow_control)
379 		return;
380 
381 	ctrl->ops->set_flow_control(ctrl, enable);
382 }
383 EXPORT_SYMBOL_GPL(serdev_device_set_flow_control);
384 
serdev_device_set_parity(struct serdev_device * serdev,enum serdev_parity parity)385 int serdev_device_set_parity(struct serdev_device *serdev,
386 			     enum serdev_parity parity)
387 {
388 	struct serdev_controller *ctrl = serdev->ctrl;
389 
390 	if (!ctrl || !ctrl->ops->set_parity)
391 		return -ENOTSUPP;
392 
393 	return ctrl->ops->set_parity(ctrl, parity);
394 }
395 EXPORT_SYMBOL_GPL(serdev_device_set_parity);
396 
serdev_device_wait_until_sent(struct serdev_device * serdev,long timeout)397 void serdev_device_wait_until_sent(struct serdev_device *serdev, long timeout)
398 {
399 	struct serdev_controller *ctrl = serdev->ctrl;
400 
401 	if (!ctrl || !ctrl->ops->wait_until_sent)
402 		return;
403 
404 	ctrl->ops->wait_until_sent(ctrl, timeout);
405 }
406 EXPORT_SYMBOL_GPL(serdev_device_wait_until_sent);
407 
serdev_device_get_tiocm(struct serdev_device * serdev)408 int serdev_device_get_tiocm(struct serdev_device *serdev)
409 {
410 	struct serdev_controller *ctrl = serdev->ctrl;
411 
412 	if (!ctrl || !ctrl->ops->get_tiocm)
413 		return -ENOTSUPP;
414 
415 	return ctrl->ops->get_tiocm(ctrl);
416 }
417 EXPORT_SYMBOL_GPL(serdev_device_get_tiocm);
418 
serdev_device_set_tiocm(struct serdev_device * serdev,int set,int clear)419 int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
420 {
421 	struct serdev_controller *ctrl = serdev->ctrl;
422 
423 	if (!ctrl || !ctrl->ops->set_tiocm)
424 		return -ENOTSUPP;
425 
426 	return ctrl->ops->set_tiocm(ctrl, set, clear);
427 }
428 EXPORT_SYMBOL_GPL(serdev_device_set_tiocm);
429 
serdev_drv_probe(struct device * dev)430 static int serdev_drv_probe(struct device *dev)
431 {
432 	const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
433 	int ret;
434 
435 	ret = dev_pm_domain_attach(dev, true);
436 	if (ret)
437 		return ret;
438 
439 	ret = sdrv->probe(to_serdev_device(dev));
440 	if (ret)
441 		dev_pm_domain_detach(dev, true);
442 
443 	return ret;
444 }
445 
serdev_drv_remove(struct device * dev)446 static int serdev_drv_remove(struct device *dev)
447 {
448 	const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
449 	if (sdrv->remove)
450 		sdrv->remove(to_serdev_device(dev));
451 
452 	dev_pm_domain_detach(dev, true);
453 
454 	return 0;
455 }
456 
457 static struct bus_type serdev_bus_type = {
458 	.name		= "serial",
459 	.match		= serdev_device_match,
460 	.probe		= serdev_drv_probe,
461 	.remove		= serdev_drv_remove,
462 };
463 
464 /**
465  * serdev_device_alloc() - Allocate a new serdev device
466  * @ctrl:	associated controller
467  *
468  * Caller is responsible for either calling serdev_device_add() to add the
469  * newly allocated controller, or calling serdev_device_put() to discard it.
470  */
serdev_device_alloc(struct serdev_controller * ctrl)471 struct serdev_device *serdev_device_alloc(struct serdev_controller *ctrl)
472 {
473 	struct serdev_device *serdev;
474 
475 	serdev = kzalloc(sizeof(*serdev), GFP_KERNEL);
476 	if (!serdev)
477 		return NULL;
478 
479 	serdev->ctrl = ctrl;
480 	device_initialize(&serdev->dev);
481 	serdev->dev.parent = &ctrl->dev;
482 	serdev->dev.bus = &serdev_bus_type;
483 	serdev->dev.type = &serdev_device_type;
484 	init_completion(&serdev->write_comp);
485 	mutex_init(&serdev->write_lock);
486 	return serdev;
487 }
488 EXPORT_SYMBOL_GPL(serdev_device_alloc);
489 
490 /**
491  * serdev_controller_alloc() - Allocate a new serdev controller
492  * @parent:	parent device
493  * @size:	size of private data
494  *
495  * Caller is responsible for either calling serdev_controller_add() to add the
496  * newly allocated controller, or calling serdev_controller_put() to discard it.
497  * The allocated private data region may be accessed via
498  * serdev_controller_get_drvdata()
499  */
serdev_controller_alloc(struct device * parent,size_t size)500 struct serdev_controller *serdev_controller_alloc(struct device *parent,
501 					      size_t size)
502 {
503 	struct serdev_controller *ctrl;
504 	int id;
505 
506 	if (WARN_ON(!parent))
507 		return NULL;
508 
509 	ctrl = kzalloc(sizeof(*ctrl) + size, GFP_KERNEL);
510 	if (!ctrl)
511 		return NULL;
512 
513 	id = ida_simple_get(&ctrl_ida, 0, 0, GFP_KERNEL);
514 	if (id < 0) {
515 		dev_err(parent,
516 			"unable to allocate serdev controller identifier.\n");
517 		goto err_free;
518 	}
519 
520 	ctrl->nr = id;
521 
522 	device_initialize(&ctrl->dev);
523 	ctrl->dev.type = &serdev_ctrl_type;
524 	ctrl->dev.bus = &serdev_bus_type;
525 	ctrl->dev.parent = parent;
526 	ctrl->dev.of_node = parent->of_node;
527 	serdev_controller_set_drvdata(ctrl, &ctrl[1]);
528 
529 	dev_set_name(&ctrl->dev, "serial%d", id);
530 
531 	pm_runtime_no_callbacks(&ctrl->dev);
532 	pm_suspend_ignore_children(&ctrl->dev, true);
533 
534 	dev_dbg(&ctrl->dev, "allocated controller 0x%p id %d\n", ctrl, id);
535 	return ctrl;
536 
537 err_free:
538 	kfree(ctrl);
539 
540 	return NULL;
541 }
542 EXPORT_SYMBOL_GPL(serdev_controller_alloc);
543 
of_serdev_register_devices(struct serdev_controller * ctrl)544 static int of_serdev_register_devices(struct serdev_controller *ctrl)
545 {
546 	struct device_node *node;
547 	struct serdev_device *serdev = NULL;
548 	int err;
549 	bool found = false;
550 
551 	for_each_available_child_of_node(ctrl->dev.of_node, node) {
552 		if (!of_get_property(node, "compatible", NULL))
553 			continue;
554 
555 		dev_dbg(&ctrl->dev, "adding child %pOF\n", node);
556 
557 		serdev = serdev_device_alloc(ctrl);
558 		if (!serdev)
559 			continue;
560 
561 		serdev->dev.of_node = node;
562 
563 		err = serdev_device_add(serdev);
564 		if (err) {
565 			dev_err(&serdev->dev,
566 				"failure adding device. status %pe\n",
567 				ERR_PTR(err));
568 			serdev_device_put(serdev);
569 		} else
570 			found = true;
571 	}
572 	if (!found)
573 		return -ENODEV;
574 
575 	return 0;
576 }
577 
578 #ifdef CONFIG_ACPI
579 
580 #define SERDEV_ACPI_MAX_SCAN_DEPTH 32
581 
582 struct acpi_serdev_lookup {
583 	acpi_handle device_handle;
584 	acpi_handle controller_handle;
585 	int n;
586 	int index;
587 };
588 
acpi_serdev_parse_resource(struct acpi_resource * ares,void * data)589 static int acpi_serdev_parse_resource(struct acpi_resource *ares, void *data)
590 {
591 	struct acpi_serdev_lookup *lookup = data;
592 	struct acpi_resource_uart_serialbus *sb;
593 	acpi_status status;
594 
595 	if (ares->type != ACPI_RESOURCE_TYPE_SERIAL_BUS)
596 		return 1;
597 
598 	if (ares->data.common_serial_bus.type != ACPI_RESOURCE_SERIAL_TYPE_UART)
599 		return 1;
600 
601 	if (lookup->index != -1 && lookup->n++ != lookup->index)
602 		return 1;
603 
604 	sb = &ares->data.uart_serial_bus;
605 
606 	status = acpi_get_handle(lookup->device_handle,
607 				 sb->resource_source.string_ptr,
608 				 &lookup->controller_handle);
609 	if (ACPI_FAILURE(status))
610 		return 1;
611 
612 	/*
613 	 * NOTE: Ideally, we would also want to retreive other properties here,
614 	 * once setting them before opening the device is supported by serdev.
615 	 */
616 
617 	return 1;
618 }
619 
acpi_serdev_do_lookup(struct acpi_device * adev,struct acpi_serdev_lookup * lookup)620 static int acpi_serdev_do_lookup(struct acpi_device *adev,
621                                  struct acpi_serdev_lookup *lookup)
622 {
623 	struct list_head resource_list;
624 	int ret;
625 
626 	lookup->device_handle = acpi_device_handle(adev);
627 	lookup->controller_handle = NULL;
628 	lookup->n = 0;
629 
630 	INIT_LIST_HEAD(&resource_list);
631 	ret = acpi_dev_get_resources(adev, &resource_list,
632 				     acpi_serdev_parse_resource, lookup);
633 	acpi_dev_free_resource_list(&resource_list);
634 
635 	if (ret < 0)
636 		return -EINVAL;
637 
638 	return 0;
639 }
640 
acpi_serdev_check_resources(struct serdev_controller * ctrl,struct acpi_device * adev)641 static int acpi_serdev_check_resources(struct serdev_controller *ctrl,
642 				       struct acpi_device *adev)
643 {
644 	struct acpi_serdev_lookup lookup;
645 	int ret;
646 
647 	if (acpi_bus_get_status(adev) || !adev->status.present)
648 		return -EINVAL;
649 
650 	/* Look for UARTSerialBusV2 resource */
651 	lookup.index = -1;	// we only care for the last device
652 
653 	ret = acpi_serdev_do_lookup(adev, &lookup);
654 	if (ret)
655 		return ret;
656 
657 	/*
658 	 * Apple machines provide an empty resource template, so on those
659 	 * machines just look for immediate children with a "baud" property
660 	 * (from the _DSM method) instead.
661 	 */
662 	if (!lookup.controller_handle && x86_apple_machine &&
663 	    !acpi_dev_get_property(adev, "baud", ACPI_TYPE_BUFFER, NULL))
664 		acpi_get_parent(adev->handle, &lookup.controller_handle);
665 
666 	/* Make sure controller and ResourceSource handle match */
667 	if (ACPI_HANDLE(ctrl->dev.parent) != lookup.controller_handle)
668 		return -ENODEV;
669 
670 	return 0;
671 }
672 
acpi_serdev_register_device(struct serdev_controller * ctrl,struct acpi_device * adev)673 static acpi_status acpi_serdev_register_device(struct serdev_controller *ctrl,
674 					       struct acpi_device *adev)
675 {
676 	struct serdev_device *serdev;
677 	int err;
678 
679 	serdev = serdev_device_alloc(ctrl);
680 	if (!serdev) {
681 		dev_err(&ctrl->dev, "failed to allocate serdev device for %s\n",
682 			dev_name(&adev->dev));
683 		return AE_NO_MEMORY;
684 	}
685 
686 	ACPI_COMPANION_SET(&serdev->dev, adev);
687 	acpi_device_set_enumerated(adev);
688 
689 	err = serdev_device_add(serdev);
690 	if (err) {
691 		dev_err(&serdev->dev,
692 			"failure adding ACPI serdev device. status %pe\n",
693 			ERR_PTR(err));
694 		serdev_device_put(serdev);
695 	}
696 
697 	return AE_OK;
698 }
699 
700 static const struct acpi_device_id serdev_acpi_devices_blacklist[] = {
701 	{ "INT3511", 0 },
702 	{ "INT3512", 0 },
703 	{ },
704 };
705 
acpi_serdev_add_device(acpi_handle handle,u32 level,void * data,void ** return_value)706 static acpi_status acpi_serdev_add_device(acpi_handle handle, u32 level,
707 					  void *data, void **return_value)
708 {
709 	struct serdev_controller *ctrl = data;
710 	struct acpi_device *adev;
711 
712 	if (acpi_bus_get_device(handle, &adev))
713 		return AE_OK;
714 
715 	if (acpi_device_enumerated(adev))
716 		return AE_OK;
717 
718 	/* Skip if black listed */
719 	if (!acpi_match_device_ids(adev, serdev_acpi_devices_blacklist))
720 		return AE_OK;
721 
722 	if (acpi_serdev_check_resources(ctrl, adev))
723 		return AE_OK;
724 
725 	return acpi_serdev_register_device(ctrl, adev);
726 }
727 
728 
acpi_serdev_register_devices(struct serdev_controller * ctrl)729 static int acpi_serdev_register_devices(struct serdev_controller *ctrl)
730 {
731 	acpi_status status;
732 
733 	if (!has_acpi_companion(ctrl->dev.parent))
734 		return -ENODEV;
735 
736 	status = acpi_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
737 				     SERDEV_ACPI_MAX_SCAN_DEPTH,
738 				     acpi_serdev_add_device, NULL, ctrl, NULL);
739 	if (ACPI_FAILURE(status))
740 		dev_warn(&ctrl->dev, "failed to enumerate serdev slaves\n");
741 
742 	if (!ctrl->serdev)
743 		return -ENODEV;
744 
745 	return 0;
746 }
747 #else
acpi_serdev_register_devices(struct serdev_controller * ctrl)748 static inline int acpi_serdev_register_devices(struct serdev_controller *ctrl)
749 {
750 	return -ENODEV;
751 }
752 #endif /* CONFIG_ACPI */
753 
platform_serdev_register_devices(struct serdev_controller * ctrl)754 static int platform_serdev_register_devices(struct serdev_controller *ctrl)
755 {
756 	struct serdev_device *serdev;
757 	int err;
758 
759 	if (ctrl->dev.parent->bus != &platform_bus_type)
760 		return -ENODEV;
761 
762 	serdev = serdev_device_alloc(ctrl);
763 	if (!serdev) {
764 		dev_err(&ctrl->dev, "failed to allocate serdev device for %s\n",
765 				    dev_name(ctrl->dev.parent));
766 		return -ENOMEM;
767 	}
768 
769 	pm_runtime_no_callbacks(&serdev->dev);
770 
771 	err = serdev_device_add(serdev);
772 	if (err) {
773 		dev_err(&serdev->dev,
774 			"failure adding device. status %d\n", err);
775 		serdev_device_put(serdev);
776 	}
777 
778 	return err;
779 }
780 
781 
782 /**
783  * serdev_controller_add_platform() - Add an serdev controller
784  * @ctrl:	controller to be registered.
785  * @platform:	whether to permit fallthrough to platform device probe
786  *
787  * Register a controller previously allocated via serdev_controller_alloc() with
788  * the serdev core. Optionally permit probing via a platform device fallback.
789  */
serdev_controller_add_platform(struct serdev_controller * ctrl,bool platform)790 int serdev_controller_add_platform(struct serdev_controller *ctrl, bool platform)
791 {
792 	int ret, ret_of, ret_acpi, ret_platform = -ENODEV;
793 
794 	/* Can't register until after driver model init */
795 	if (WARN_ON(!is_registered))
796 		return -EAGAIN;
797 
798 	ret = device_add(&ctrl->dev);
799 	if (ret)
800 		return ret;
801 
802 	pm_runtime_enable(&ctrl->dev);
803 
804 	ret_of = of_serdev_register_devices(ctrl);
805 	ret_acpi = acpi_serdev_register_devices(ctrl);
806 	if (platform)
807 		ret_platform = platform_serdev_register_devices(ctrl);
808 	if (ret_of && ret_acpi && ret_platform) {
809 		dev_dbg(&ctrl->dev,
810 			"no devices registered: of:%pe acpi:%pe platform:%pe\n",
811 			ERR_PTR(ret_of), ERR_PTR(ret_acpi),
812 			ERR_PTR(ret_platform));
813 		ret = -ENODEV;
814 		goto err_rpm_disable;
815 	}
816 
817 	dev_dbg(&ctrl->dev, "serdev%d registered: dev:%p\n",
818 		ctrl->nr, &ctrl->dev);
819 	return 0;
820 
821 err_rpm_disable:
822 	pm_runtime_disable(&ctrl->dev);
823 	device_del(&ctrl->dev);
824 	return ret;
825 };
826 EXPORT_SYMBOL_GPL(serdev_controller_add_platform);
827 
828 /* Remove a device associated with a controller */
serdev_remove_device(struct device * dev,void * data)829 static int serdev_remove_device(struct device *dev, void *data)
830 {
831 	struct serdev_device *serdev = to_serdev_device(dev);
832 	if (dev->type == &serdev_device_type)
833 		serdev_device_remove(serdev);
834 	return 0;
835 }
836 
837 /**
838  * serdev_controller_remove(): remove an serdev controller
839  * @ctrl:	controller to remove
840  *
841  * Remove a serdev controller.  Caller is responsible for calling
842  * serdev_controller_put() to discard the allocated controller.
843  */
serdev_controller_remove(struct serdev_controller * ctrl)844 void serdev_controller_remove(struct serdev_controller *ctrl)
845 {
846 	int dummy;
847 
848 	if (!ctrl)
849 		return;
850 
851 	dummy = device_for_each_child(&ctrl->dev, NULL,
852 				      serdev_remove_device);
853 	pm_runtime_disable(&ctrl->dev);
854 	device_del(&ctrl->dev);
855 }
856 EXPORT_SYMBOL_GPL(serdev_controller_remove);
857 
858 /**
859  * serdev_driver_register() - Register client driver with serdev core
860  * @sdrv:	client driver to be associated with client-device.
861  *
862  * This API will register the client driver with the serdev framework.
863  * It is typically called from the driver's module-init function.
864  */
__serdev_device_driver_register(struct serdev_device_driver * sdrv,struct module * owner)865 int __serdev_device_driver_register(struct serdev_device_driver *sdrv, struct module *owner)
866 {
867 	sdrv->driver.bus = &serdev_bus_type;
868 	sdrv->driver.owner = owner;
869 
870 	/* force drivers to async probe so I/O is possible in probe */
871         sdrv->driver.probe_type = PROBE_PREFER_ASYNCHRONOUS;
872 
873 	return driver_register(&sdrv->driver);
874 }
875 EXPORT_SYMBOL_GPL(__serdev_device_driver_register);
876 
serdev_exit(void)877 static void __exit serdev_exit(void)
878 {
879 	bus_unregister(&serdev_bus_type);
880 	ida_destroy(&ctrl_ida);
881 }
882 module_exit(serdev_exit);
883 
serdev_init(void)884 static int __init serdev_init(void)
885 {
886 	int ret;
887 
888 	ret = bus_register(&serdev_bus_type);
889 	if (ret)
890 		return ret;
891 
892 	is_registered = true;
893 	return 0;
894 }
895 /* Must be before serial drivers register */
896 postcore_initcall(serdev_init);
897 
898 MODULE_AUTHOR("Rob Herring <robh@kernel.org>");
899 MODULE_LICENSE("GPL v2");
900 MODULE_DESCRIPTION("Serial attached device bus");
901