This source file includes following definitions.
- modalias_show
- serdev_device_uevent
- serdev_device_release
- is_serdev_device
- serdev_ctrl_release
- serdev_device_match
- serdev_device_add
- serdev_device_remove
- serdev_device_open
- serdev_device_close
- devm_serdev_device_release
- devm_serdev_device_open
- serdev_device_write_wakeup
- serdev_device_write_buf
- serdev_device_write
- serdev_device_write_flush
- serdev_device_write_room
- serdev_device_set_baudrate
- serdev_device_set_flow_control
- serdev_device_set_parity
- serdev_device_wait_until_sent
- serdev_device_get_tiocm
- serdev_device_set_tiocm
- serdev_drv_probe
- serdev_drv_remove
- serdev_device_alloc
- serdev_controller_alloc
- of_serdev_register_devices
- acpi_serdev_register_device
- acpi_serdev_add_device
- acpi_serdev_register_devices
- acpi_serdev_register_devices
- serdev_controller_add
- serdev_remove_device
- serdev_controller_remove
- __serdev_device_driver_register
- serdev_exit
- serdev_init
1
2
3
4
5
6
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
22 static bool is_registered;
23 static DEFINE_IDA(ctrl_ida);
24
25 static ssize_t modalias_show(struct device *dev,
26 struct device_attribute *attr, char *buf)
27 {
28 int len;
29
30 len = acpi_device_modalias(dev, buf, PAGE_SIZE - 1);
31 if (len != -ENODEV)
32 return len;
33
34 return of_device_modalias(dev, buf, PAGE_SIZE);
35 }
36 static DEVICE_ATTR_RO(modalias);
37
38 static struct attribute *serdev_device_attrs[] = {
39 &dev_attr_modalias.attr,
40 NULL,
41 };
42 ATTRIBUTE_GROUPS(serdev_device);
43
44 static int serdev_device_uevent(struct device *dev, struct kobj_uevent_env *env)
45 {
46 int rc;
47
48
49
50 rc = acpi_device_uevent_modalias(dev, env);
51 if (rc != -ENODEV)
52 return rc;
53
54 return of_device_uevent_modalias(dev, env);
55 }
56
57 static void serdev_device_release(struct device *dev)
58 {
59 struct serdev_device *serdev = to_serdev_device(dev);
60 kfree(serdev);
61 }
62
63 static const struct device_type serdev_device_type = {
64 .groups = serdev_device_groups,
65 .uevent = serdev_device_uevent,
66 .release = serdev_device_release,
67 };
68
69 static bool is_serdev_device(const struct device *dev)
70 {
71 return dev->type == &serdev_device_type;
72 }
73
74 static void serdev_ctrl_release(struct device *dev)
75 {
76 struct serdev_controller *ctrl = to_serdev_controller(dev);
77 ida_simple_remove(&ctrl_ida, ctrl->nr);
78 kfree(ctrl);
79 }
80
81 static const struct device_type serdev_ctrl_type = {
82 .release = serdev_ctrl_release,
83 };
84
85 static int serdev_device_match(struct device *dev, struct device_driver *drv)
86 {
87 if (!is_serdev_device(dev))
88 return 0;
89
90
91 if (acpi_driver_match_device(dev, drv))
92 return 1;
93
94 return of_driver_match_device(dev, drv);
95 }
96
97
98
99
100
101 int serdev_device_add(struct serdev_device *serdev)
102 {
103 struct serdev_controller *ctrl = serdev->ctrl;
104 struct device *parent = serdev->dev.parent;
105 int err;
106
107 dev_set_name(&serdev->dev, "%s-%d", dev_name(parent), serdev->nr);
108
109
110 if (ctrl->serdev) {
111 dev_err(&serdev->dev, "controller busy\n");
112 return -EBUSY;
113 }
114 ctrl->serdev = serdev;
115
116 err = device_add(&serdev->dev);
117 if (err < 0) {
118 dev_err(&serdev->dev, "Can't add %s, status %d\n",
119 dev_name(&serdev->dev), err);
120 goto err_clear_serdev;
121 }
122
123 dev_dbg(&serdev->dev, "device %s registered\n", dev_name(&serdev->dev));
124
125 return 0;
126
127 err_clear_serdev:
128 ctrl->serdev = NULL;
129 return err;
130 }
131 EXPORT_SYMBOL_GPL(serdev_device_add);
132
133
134
135
136
137 void serdev_device_remove(struct serdev_device *serdev)
138 {
139 struct serdev_controller *ctrl = serdev->ctrl;
140
141 device_unregister(&serdev->dev);
142 ctrl->serdev = NULL;
143 }
144 EXPORT_SYMBOL_GPL(serdev_device_remove);
145
146 int serdev_device_open(struct serdev_device *serdev)
147 {
148 struct serdev_controller *ctrl = serdev->ctrl;
149 int ret;
150
151 if (!ctrl || !ctrl->ops->open)
152 return -EINVAL;
153
154 ret = ctrl->ops->open(ctrl);
155 if (ret)
156 return ret;
157
158 ret = pm_runtime_get_sync(&ctrl->dev);
159 if (ret < 0) {
160 pm_runtime_put_noidle(&ctrl->dev);
161 goto err_close;
162 }
163
164 return 0;
165
166 err_close:
167 if (ctrl->ops->close)
168 ctrl->ops->close(ctrl);
169
170 return ret;
171 }
172 EXPORT_SYMBOL_GPL(serdev_device_open);
173
174 void serdev_device_close(struct serdev_device *serdev)
175 {
176 struct serdev_controller *ctrl = serdev->ctrl;
177
178 if (!ctrl || !ctrl->ops->close)
179 return;
180
181 pm_runtime_put(&ctrl->dev);
182
183 ctrl->ops->close(ctrl);
184 }
185 EXPORT_SYMBOL_GPL(serdev_device_close);
186
187 static void devm_serdev_device_release(struct device *dev, void *dr)
188 {
189 serdev_device_close(*(struct serdev_device **)dr);
190 }
191
192 int devm_serdev_device_open(struct device *dev, struct serdev_device *serdev)
193 {
194 struct serdev_device **dr;
195 int ret;
196
197 dr = devres_alloc(devm_serdev_device_release, sizeof(*dr), GFP_KERNEL);
198 if (!dr)
199 return -ENOMEM;
200
201 ret = serdev_device_open(serdev);
202 if (ret) {
203 devres_free(dr);
204 return ret;
205 }
206
207 *dr = serdev;
208 devres_add(dev, dr);
209
210 return 0;
211 }
212 EXPORT_SYMBOL_GPL(devm_serdev_device_open);
213
214 void serdev_device_write_wakeup(struct serdev_device *serdev)
215 {
216 complete(&serdev->write_comp);
217 }
218 EXPORT_SYMBOL_GPL(serdev_device_write_wakeup);
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235 int serdev_device_write_buf(struct serdev_device *serdev,
236 const unsigned char *buf, size_t count)
237 {
238 struct serdev_controller *ctrl = serdev->ctrl;
239
240 if (!ctrl || !ctrl->ops->write_buf)
241 return -EINVAL;
242
243 return ctrl->ops->write_buf(ctrl, buf, count);
244 }
245 EXPORT_SYMBOL_GPL(serdev_device_write_buf);
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269 int serdev_device_write(struct serdev_device *serdev,
270 const unsigned char *buf, size_t count,
271 long timeout)
272 {
273 struct serdev_controller *ctrl = serdev->ctrl;
274 int written = 0;
275 int ret;
276
277 if (!ctrl || !ctrl->ops->write_buf || !serdev->ops->write_wakeup)
278 return -EINVAL;
279
280 if (timeout == 0)
281 timeout = MAX_SCHEDULE_TIMEOUT;
282
283 mutex_lock(&serdev->write_lock);
284 do {
285 reinit_completion(&serdev->write_comp);
286
287 ret = ctrl->ops->write_buf(ctrl, buf, count);
288 if (ret < 0)
289 break;
290
291 written += ret;
292 buf += ret;
293 count -= ret;
294
295 if (count == 0)
296 break;
297
298 timeout = wait_for_completion_interruptible_timeout(&serdev->write_comp,
299 timeout);
300 } while (timeout > 0);
301 mutex_unlock(&serdev->write_lock);
302
303 if (ret < 0)
304 return ret;
305
306 if (timeout <= 0 && written == 0) {
307 if (timeout == -ERESTARTSYS)
308 return -ERESTARTSYS;
309 else
310 return -ETIMEDOUT;
311 }
312
313 return written;
314 }
315 EXPORT_SYMBOL_GPL(serdev_device_write);
316
317 void serdev_device_write_flush(struct serdev_device *serdev)
318 {
319 struct serdev_controller *ctrl = serdev->ctrl;
320
321 if (!ctrl || !ctrl->ops->write_flush)
322 return;
323
324 ctrl->ops->write_flush(ctrl);
325 }
326 EXPORT_SYMBOL_GPL(serdev_device_write_flush);
327
328 int serdev_device_write_room(struct serdev_device *serdev)
329 {
330 struct serdev_controller *ctrl = serdev->ctrl;
331
332 if (!ctrl || !ctrl->ops->write_room)
333 return 0;
334
335 return serdev->ctrl->ops->write_room(ctrl);
336 }
337 EXPORT_SYMBOL_GPL(serdev_device_write_room);
338
339 unsigned int serdev_device_set_baudrate(struct serdev_device *serdev, unsigned int speed)
340 {
341 struct serdev_controller *ctrl = serdev->ctrl;
342
343 if (!ctrl || !ctrl->ops->set_baudrate)
344 return 0;
345
346 return ctrl->ops->set_baudrate(ctrl, speed);
347
348 }
349 EXPORT_SYMBOL_GPL(serdev_device_set_baudrate);
350
351 void serdev_device_set_flow_control(struct serdev_device *serdev, bool enable)
352 {
353 struct serdev_controller *ctrl = serdev->ctrl;
354
355 if (!ctrl || !ctrl->ops->set_flow_control)
356 return;
357
358 ctrl->ops->set_flow_control(ctrl, enable);
359 }
360 EXPORT_SYMBOL_GPL(serdev_device_set_flow_control);
361
362 int serdev_device_set_parity(struct serdev_device *serdev,
363 enum serdev_parity parity)
364 {
365 struct serdev_controller *ctrl = serdev->ctrl;
366
367 if (!ctrl || !ctrl->ops->set_parity)
368 return -ENOTSUPP;
369
370 return ctrl->ops->set_parity(ctrl, parity);
371 }
372 EXPORT_SYMBOL_GPL(serdev_device_set_parity);
373
374 void serdev_device_wait_until_sent(struct serdev_device *serdev, long timeout)
375 {
376 struct serdev_controller *ctrl = serdev->ctrl;
377
378 if (!ctrl || !ctrl->ops->wait_until_sent)
379 return;
380
381 ctrl->ops->wait_until_sent(ctrl, timeout);
382 }
383 EXPORT_SYMBOL_GPL(serdev_device_wait_until_sent);
384
385 int serdev_device_get_tiocm(struct serdev_device *serdev)
386 {
387 struct serdev_controller *ctrl = serdev->ctrl;
388
389 if (!ctrl || !ctrl->ops->get_tiocm)
390 return -ENOTSUPP;
391
392 return ctrl->ops->get_tiocm(ctrl);
393 }
394 EXPORT_SYMBOL_GPL(serdev_device_get_tiocm);
395
396 int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
397 {
398 struct serdev_controller *ctrl = serdev->ctrl;
399
400 if (!ctrl || !ctrl->ops->set_tiocm)
401 return -ENOTSUPP;
402
403 return ctrl->ops->set_tiocm(ctrl, set, clear);
404 }
405 EXPORT_SYMBOL_GPL(serdev_device_set_tiocm);
406
407 static int serdev_drv_probe(struct device *dev)
408 {
409 const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
410 int ret;
411
412 ret = dev_pm_domain_attach(dev, true);
413 if (ret)
414 return ret;
415
416 ret = sdrv->probe(to_serdev_device(dev));
417 if (ret)
418 dev_pm_domain_detach(dev, true);
419
420 return ret;
421 }
422
423 static int serdev_drv_remove(struct device *dev)
424 {
425 const struct serdev_device_driver *sdrv = to_serdev_device_driver(dev->driver);
426 if (sdrv->remove)
427 sdrv->remove(to_serdev_device(dev));
428
429 dev_pm_domain_detach(dev, true);
430
431 return 0;
432 }
433
434 static struct bus_type serdev_bus_type = {
435 .name = "serial",
436 .match = serdev_device_match,
437 .probe = serdev_drv_probe,
438 .remove = serdev_drv_remove,
439 };
440
441
442
443
444
445
446
447
448 struct serdev_device *serdev_device_alloc(struct serdev_controller *ctrl)
449 {
450 struct serdev_device *serdev;
451
452 serdev = kzalloc(sizeof(*serdev), GFP_KERNEL);
453 if (!serdev)
454 return NULL;
455
456 serdev->ctrl = ctrl;
457 device_initialize(&serdev->dev);
458 serdev->dev.parent = &ctrl->dev;
459 serdev->dev.bus = &serdev_bus_type;
460 serdev->dev.type = &serdev_device_type;
461 init_completion(&serdev->write_comp);
462 mutex_init(&serdev->write_lock);
463 return serdev;
464 }
465 EXPORT_SYMBOL_GPL(serdev_device_alloc);
466
467
468
469
470
471
472
473
474
475
476
477 struct serdev_controller *serdev_controller_alloc(struct device *parent,
478 size_t size)
479 {
480 struct serdev_controller *ctrl;
481 int id;
482
483 if (WARN_ON(!parent))
484 return NULL;
485
486 ctrl = kzalloc(sizeof(*ctrl) + size, GFP_KERNEL);
487 if (!ctrl)
488 return NULL;
489
490 id = ida_simple_get(&ctrl_ida, 0, 0, GFP_KERNEL);
491 if (id < 0) {
492 dev_err(parent,
493 "unable to allocate serdev controller identifier.\n");
494 goto err_free;
495 }
496
497 ctrl->nr = id;
498
499 device_initialize(&ctrl->dev);
500 ctrl->dev.type = &serdev_ctrl_type;
501 ctrl->dev.bus = &serdev_bus_type;
502 ctrl->dev.parent = parent;
503 ctrl->dev.of_node = parent->of_node;
504 serdev_controller_set_drvdata(ctrl, &ctrl[1]);
505
506 dev_set_name(&ctrl->dev, "serial%d", id);
507
508 pm_runtime_no_callbacks(&ctrl->dev);
509 pm_suspend_ignore_children(&ctrl->dev, true);
510
511 dev_dbg(&ctrl->dev, "allocated controller 0x%p id %d\n", ctrl, id);
512 return ctrl;
513
514 err_free:
515 kfree(ctrl);
516
517 return NULL;
518 }
519 EXPORT_SYMBOL_GPL(serdev_controller_alloc);
520
521 static int of_serdev_register_devices(struct serdev_controller *ctrl)
522 {
523 struct device_node *node;
524 struct serdev_device *serdev = NULL;
525 int err;
526 bool found = false;
527
528 for_each_available_child_of_node(ctrl->dev.of_node, node) {
529 if (!of_get_property(node, "compatible", NULL))
530 continue;
531
532 dev_dbg(&ctrl->dev, "adding child %pOF\n", node);
533
534 serdev = serdev_device_alloc(ctrl);
535 if (!serdev)
536 continue;
537
538 serdev->dev.of_node = node;
539
540 err = serdev_device_add(serdev);
541 if (err) {
542 dev_err(&serdev->dev,
543 "failure adding device. status %d\n", err);
544 serdev_device_put(serdev);
545 } else
546 found = true;
547 }
548 if (!found)
549 return -ENODEV;
550
551 return 0;
552 }
553
554 #ifdef CONFIG_ACPI
555 static acpi_status acpi_serdev_register_device(struct serdev_controller *ctrl,
556 struct acpi_device *adev)
557 {
558 struct serdev_device *serdev = NULL;
559 int err;
560
561 if (acpi_bus_get_status(adev) || !adev->status.present ||
562 acpi_device_enumerated(adev))
563 return AE_OK;
564
565 serdev = serdev_device_alloc(ctrl);
566 if (!serdev) {
567 dev_err(&ctrl->dev, "failed to allocate serdev device for %s\n",
568 dev_name(&adev->dev));
569 return AE_NO_MEMORY;
570 }
571
572 ACPI_COMPANION_SET(&serdev->dev, adev);
573 acpi_device_set_enumerated(adev);
574
575 err = serdev_device_add(serdev);
576 if (err) {
577 dev_err(&serdev->dev,
578 "failure adding ACPI serdev device. status %d\n", err);
579 serdev_device_put(serdev);
580 }
581
582 return AE_OK;
583 }
584
585 static const struct acpi_device_id serdev_acpi_devices_blacklist[] = {
586 { "INT3511", 0 },
587 { "INT3512", 0 },
588 { },
589 };
590
591 static acpi_status acpi_serdev_add_device(acpi_handle handle, u32 level,
592 void *data, void **return_value)
593 {
594 struct serdev_controller *ctrl = data;
595 struct acpi_device *adev;
596
597 if (acpi_bus_get_device(handle, &adev))
598 return AE_OK;
599
600
601 if (!acpi_match_device_ids(adev, serdev_acpi_devices_blacklist))
602 return AE_OK;
603
604 return acpi_serdev_register_device(ctrl, adev);
605 }
606
607 static int acpi_serdev_register_devices(struct serdev_controller *ctrl)
608 {
609 acpi_status status;
610 acpi_handle handle;
611
612 handle = ACPI_HANDLE(ctrl->dev.parent);
613 if (!handle)
614 return -ENODEV;
615
616 status = acpi_walk_namespace(ACPI_TYPE_DEVICE, handle, 1,
617 acpi_serdev_add_device, NULL, ctrl, NULL);
618 if (ACPI_FAILURE(status))
619 dev_dbg(&ctrl->dev, "failed to enumerate serdev slaves\n");
620
621 if (!ctrl->serdev)
622 return -ENODEV;
623
624 return 0;
625 }
626 #else
627 static inline int acpi_serdev_register_devices(struct serdev_controller *ctrl)
628 {
629 return -ENODEV;
630 }
631 #endif
632
633
634
635
636
637
638
639
640 int serdev_controller_add(struct serdev_controller *ctrl)
641 {
642 int ret_of, ret_acpi, ret;
643
644
645 if (WARN_ON(!is_registered))
646 return -EAGAIN;
647
648 ret = device_add(&ctrl->dev);
649 if (ret)
650 return ret;
651
652 pm_runtime_enable(&ctrl->dev);
653
654 ret_of = of_serdev_register_devices(ctrl);
655 ret_acpi = acpi_serdev_register_devices(ctrl);
656 if (ret_of && ret_acpi) {
657 dev_dbg(&ctrl->dev, "no devices registered: of:%d acpi:%d\n",
658 ret_of, ret_acpi);
659 ret = -ENODEV;
660 goto err_rpm_disable;
661 }
662
663 dev_dbg(&ctrl->dev, "serdev%d registered: dev:%p\n",
664 ctrl->nr, &ctrl->dev);
665 return 0;
666
667 err_rpm_disable:
668 pm_runtime_disable(&ctrl->dev);
669 device_del(&ctrl->dev);
670 return ret;
671 };
672 EXPORT_SYMBOL_GPL(serdev_controller_add);
673
674
675 static int serdev_remove_device(struct device *dev, void *data)
676 {
677 struct serdev_device *serdev = to_serdev_device(dev);
678 if (dev->type == &serdev_device_type)
679 serdev_device_remove(serdev);
680 return 0;
681 }
682
683
684
685
686
687
688
689
690 void serdev_controller_remove(struct serdev_controller *ctrl)
691 {
692 int dummy;
693
694 if (!ctrl)
695 return;
696
697 dummy = device_for_each_child(&ctrl->dev, NULL,
698 serdev_remove_device);
699 pm_runtime_disable(&ctrl->dev);
700 device_del(&ctrl->dev);
701 }
702 EXPORT_SYMBOL_GPL(serdev_controller_remove);
703
704
705
706
707
708
709
710
711 int __serdev_device_driver_register(struct serdev_device_driver *sdrv, struct module *owner)
712 {
713 sdrv->driver.bus = &serdev_bus_type;
714 sdrv->driver.owner = owner;
715
716
717 sdrv->driver.probe_type = PROBE_PREFER_ASYNCHRONOUS;
718
719 return driver_register(&sdrv->driver);
720 }
721 EXPORT_SYMBOL_GPL(__serdev_device_driver_register);
722
723 static void __exit serdev_exit(void)
724 {
725 bus_unregister(&serdev_bus_type);
726 ida_destroy(&ctrl_ida);
727 }
728 module_exit(serdev_exit);
729
730 static int __init serdev_init(void)
731 {
732 int ret;
733
734 ret = bus_register(&serdev_bus_type);
735 if (ret)
736 return ret;
737
738 is_registered = true;
739 return 0;
740 }
741
742 postcore_initcall(serdev_init);
743
744 MODULE_AUTHOR("Rob Herring <robh@kernel.org>");
745 MODULE_LICENSE("GPL v2");
746 MODULE_DESCRIPTION("Serial attached device bus");