Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
4 */
5
6#include <linux/delay.h>
7#include <linux/kernel.h>
8#include <linux/module.h>
9#include <linux/moduleparam.h>
10#include <linux/list.h>
11#include <linux/interrupt.h>
12#include <linux/spinlock.h>
13#include <linux/timer.h>
14#include <linux/device.h>
15#include <linux/slab.h>
16#include <linux/sched.h>
17#include <linux/kthread.h>
18#include <linux/freezer.h>
19#include <linux/hwmon.h>
20#include <linux/of.h>
21
22#include <linux/atomic.h>
23
24#include "w1_internal.h"
25#include "w1_netlink.h"
26
27#define W1_FAMILY_DEFAULT 0
28#define W1_FAMILY_DS28E04 0x1C /* for crc quirk */
29
30
31static int w1_timeout = 10;
32module_param_named(timeout, w1_timeout, int, 0);
33MODULE_PARM_DESC(timeout, "time in seconds between automatic slave searches");
34
35static int w1_timeout_us;
36module_param_named(timeout_us, w1_timeout_us, int, 0);
37MODULE_PARM_DESC(timeout_us,
38 "time in microseconds between automatic slave searches");
39
40/* A search stops when w1_max_slave_count devices have been found in that
41 * search. The next search will start over and detect the same set of devices
42 * on a static 1-wire bus. Memory is not allocated based on this number, just
43 * on the number of devices known to the kernel. Having a high number does not
44 * consume additional resources. As a special case, if there is only one
45 * device on the network and w1_max_slave_count is set to 1, the device id can
46 * be read directly skipping the normal slower search process.
47 */
48int w1_max_slave_count = 64;
49module_param_named(max_slave_count, w1_max_slave_count, int, 0);
50MODULE_PARM_DESC(max_slave_count,
51 "maximum number of slaves detected in a search");
52
53int w1_max_slave_ttl = 10;
54module_param_named(slave_ttl, w1_max_slave_ttl, int, 0);
55MODULE_PARM_DESC(slave_ttl,
56 "Number of searches not seeing a slave before it will be removed");
57
58DEFINE_MUTEX(w1_mlock);
59LIST_HEAD(w1_masters);
60
61static int w1_master_probe(struct device *dev)
62{
63 return -ENODEV;
64}
65
66static void w1_master_release(struct device *dev)
67{
68 struct w1_master *md = dev_to_w1_master(dev);
69
70 dev_dbg(dev, "%s: Releasing %s.\n", __func__, md->name);
71 memset(md, 0, sizeof(struct w1_master) + sizeof(struct w1_bus_master));
72 kfree(md);
73}
74
75static void w1_slave_release(struct device *dev)
76{
77 struct w1_slave *sl = dev_to_w1_slave(dev);
78
79 dev_dbg(dev, "%s: Releasing %s [%p]\n", __func__, sl->name, sl);
80
81 w1_family_put(sl->family);
82 sl->master->slave_count--;
83}
84
85static ssize_t name_show(struct device *dev, struct device_attribute *attr, char *buf)
86{
87 struct w1_slave *sl = dev_to_w1_slave(dev);
88
89 return sprintf(buf, "%s\n", sl->name);
90}
91static DEVICE_ATTR_RO(name);
92
93static ssize_t id_show(struct device *dev,
94 struct device_attribute *attr, char *buf)
95{
96 struct w1_slave *sl = dev_to_w1_slave(dev);
97 ssize_t count = sizeof(sl->reg_num);
98
99 memcpy(buf, (u8 *)&sl->reg_num, count);
100 return count;
101}
102static DEVICE_ATTR_RO(id);
103
104static struct attribute *w1_slave_attrs[] = {
105 &dev_attr_name.attr,
106 &dev_attr_id.attr,
107 NULL,
108};
109ATTRIBUTE_GROUPS(w1_slave);
110
111/* Default family */
112
113static ssize_t rw_write(struct file *filp, struct kobject *kobj,
114 struct bin_attribute *bin_attr, char *buf, loff_t off,
115 size_t count)
116{
117 struct w1_slave *sl = kobj_to_w1_slave(kobj);
118
119 mutex_lock(&sl->master->mutex);
120 if (w1_reset_select_slave(sl)) {
121 count = 0;
122 goto out_up;
123 }
124
125 w1_write_block(sl->master, buf, count);
126
127out_up:
128 mutex_unlock(&sl->master->mutex);
129 return count;
130}
131
132static ssize_t rw_read(struct file *filp, struct kobject *kobj,
133 struct bin_attribute *bin_attr, char *buf, loff_t off,
134 size_t count)
135{
136 struct w1_slave *sl = kobj_to_w1_slave(kobj);
137
138 mutex_lock(&sl->master->mutex);
139 w1_read_block(sl->master, buf, count);
140 mutex_unlock(&sl->master->mutex);
141 return count;
142}
143
144static BIN_ATTR_RW(rw, PAGE_SIZE);
145
146static struct bin_attribute *w1_slave_bin_attrs[] = {
147 &bin_attr_rw,
148 NULL,
149};
150
151static const struct attribute_group w1_slave_default_group = {
152 .bin_attrs = w1_slave_bin_attrs,
153};
154
155static const struct attribute_group *w1_slave_default_groups[] = {
156 &w1_slave_default_group,
157 NULL,
158};
159
160static const struct w1_family_ops w1_default_fops = {
161 .groups = w1_slave_default_groups,
162};
163
164static struct w1_family w1_default_family = {
165 .fops = &w1_default_fops,
166};
167
168static int w1_uevent(const struct device *dev, struct kobj_uevent_env *env);
169
170static struct bus_type w1_bus_type = {
171 .name = "w1",
172 .uevent = w1_uevent,
173};
174
175struct device_driver w1_master_driver = {
176 .name = "w1_master_driver",
177 .bus = &w1_bus_type,
178 .probe = w1_master_probe,
179};
180
181struct device w1_master_device = {
182 .parent = NULL,
183 .bus = &w1_bus_type,
184 .init_name = "w1 bus master",
185 .driver = &w1_master_driver,
186 .release = &w1_master_release
187};
188
189static struct device_driver w1_slave_driver = {
190 .name = "w1_slave_driver",
191 .bus = &w1_bus_type,
192};
193
194#if 0
195struct device w1_slave_device = {
196 .parent = NULL,
197 .bus = &w1_bus_type,
198 .init_name = "w1 bus slave",
199 .driver = &w1_slave_driver,
200 .release = &w1_slave_release
201};
202#endif /* 0 */
203
204static ssize_t w1_master_attribute_show_name(struct device *dev, struct device_attribute *attr, char *buf)
205{
206 struct w1_master *md = dev_to_w1_master(dev);
207 ssize_t count;
208
209 mutex_lock(&md->mutex);
210 count = sprintf(buf, "%s\n", md->name);
211 mutex_unlock(&md->mutex);
212
213 return count;
214}
215
216static ssize_t w1_master_attribute_store_search(struct device * dev,
217 struct device_attribute *attr,
218 const char * buf, size_t count)
219{
220 long tmp;
221 struct w1_master *md = dev_to_w1_master(dev);
222 int ret;
223
224 ret = kstrtol(buf, 0, &tmp);
225 if (ret)
226 return ret;
227
228 mutex_lock(&md->mutex);
229 md->search_count = tmp;
230 mutex_unlock(&md->mutex);
231 /* Only wake if it is going to be searching. */
232 if (tmp)
233 wake_up_process(md->thread);
234
235 return count;
236}
237
238static ssize_t w1_master_attribute_show_search(struct device *dev,
239 struct device_attribute *attr,
240 char *buf)
241{
242 struct w1_master *md = dev_to_w1_master(dev);
243 ssize_t count;
244
245 mutex_lock(&md->mutex);
246 count = sprintf(buf, "%d\n", md->search_count);
247 mutex_unlock(&md->mutex);
248
249 return count;
250}
251
252static ssize_t w1_master_attribute_store_pullup(struct device *dev,
253 struct device_attribute *attr,
254 const char *buf, size_t count)
255{
256 long tmp;
257 struct w1_master *md = dev_to_w1_master(dev);
258 int ret;
259
260 ret = kstrtol(buf, 0, &tmp);
261 if (ret)
262 return ret;
263
264 mutex_lock(&md->mutex);
265 md->enable_pullup = tmp;
266 mutex_unlock(&md->mutex);
267
268 return count;
269}
270
271static ssize_t w1_master_attribute_show_pullup(struct device *dev,
272 struct device_attribute *attr,
273 char *buf)
274{
275 struct w1_master *md = dev_to_w1_master(dev);
276 ssize_t count;
277
278 mutex_lock(&md->mutex);
279 count = sprintf(buf, "%d\n", md->enable_pullup);
280 mutex_unlock(&md->mutex);
281
282 return count;
283}
284
285static ssize_t w1_master_attribute_show_pointer(struct device *dev, struct device_attribute *attr, char *buf)
286{
287 struct w1_master *md = dev_to_w1_master(dev);
288 ssize_t count;
289
290 mutex_lock(&md->mutex);
291 count = sprintf(buf, "0x%p\n", md->bus_master);
292 mutex_unlock(&md->mutex);
293 return count;
294}
295
296static ssize_t w1_master_attribute_show_timeout(struct device *dev, struct device_attribute *attr, char *buf)
297{
298 return sprintf(buf, "%d\n", w1_timeout);
299}
300
301static ssize_t w1_master_attribute_show_timeout_us(struct device *dev,
302 struct device_attribute *attr, char *buf)
303{
304 return sprintf(buf, "%d\n", w1_timeout_us);
305}
306
307static ssize_t w1_master_attribute_store_max_slave_count(struct device *dev,
308 struct device_attribute *attr, const char *buf, size_t count)
309{
310 int tmp;
311 struct w1_master *md = dev_to_w1_master(dev);
312
313 if (kstrtoint(buf, 0, &tmp) || tmp < 1)
314 return -EINVAL;
315
316 mutex_lock(&md->mutex);
317 md->max_slave_count = tmp;
318 /* allow each time the max_slave_count is updated */
319 clear_bit(W1_WARN_MAX_COUNT, &md->flags);
320 mutex_unlock(&md->mutex);
321
322 return count;
323}
324
325static ssize_t w1_master_attribute_show_max_slave_count(struct device *dev, struct device_attribute *attr, char *buf)
326{
327 struct w1_master *md = dev_to_w1_master(dev);
328 ssize_t count;
329
330 mutex_lock(&md->mutex);
331 count = sprintf(buf, "%d\n", md->max_slave_count);
332 mutex_unlock(&md->mutex);
333 return count;
334}
335
336static ssize_t w1_master_attribute_show_attempts(struct device *dev, struct device_attribute *attr, char *buf)
337{
338 struct w1_master *md = dev_to_w1_master(dev);
339 ssize_t count;
340
341 mutex_lock(&md->mutex);
342 count = sprintf(buf, "%lu\n", md->attempts);
343 mutex_unlock(&md->mutex);
344 return count;
345}
346
347static ssize_t w1_master_attribute_show_slave_count(struct device *dev, struct device_attribute *attr, char *buf)
348{
349 struct w1_master *md = dev_to_w1_master(dev);
350 ssize_t count;
351
352 mutex_lock(&md->mutex);
353 count = sprintf(buf, "%d\n", md->slave_count);
354 mutex_unlock(&md->mutex);
355 return count;
356}
357
358static ssize_t w1_master_attribute_show_slaves(struct device *dev,
359 struct device_attribute *attr, char *buf)
360{
361 struct w1_master *md = dev_to_w1_master(dev);
362 int c = PAGE_SIZE;
363 struct list_head *ent, *n;
364 struct w1_slave *sl = NULL;
365
366 mutex_lock(&md->list_mutex);
367
368 list_for_each_safe(ent, n, &md->slist) {
369 sl = list_entry(ent, struct w1_slave, w1_slave_entry);
370
371 c -= snprintf(buf + PAGE_SIZE - c, c, "%s\n", sl->name);
372 }
373 if (!sl)
374 c -= snprintf(buf + PAGE_SIZE - c, c, "not found.\n");
375
376 mutex_unlock(&md->list_mutex);
377
378 return PAGE_SIZE - c;
379}
380
381static ssize_t w1_master_attribute_show_add(struct device *dev,
382 struct device_attribute *attr, char *buf)
383{
384 int c = PAGE_SIZE;
385 c -= snprintf(buf+PAGE_SIZE - c, c,
386 "write device id xx-xxxxxxxxxxxx to add slave\n");
387 return PAGE_SIZE - c;
388}
389
390static int w1_atoreg_num(struct device *dev, const char *buf, size_t count,
391 struct w1_reg_num *rn)
392{
393 unsigned int family;
394 unsigned long long id;
395 int i;
396 u64 rn64_le;
397
398 /* The CRC value isn't read from the user because the sysfs directory
399 * doesn't include it and most messages from the bus search don't
400 * print it either. It would be unreasonable for the user to then
401 * provide it.
402 */
403 const char *error_msg = "bad slave string format, expecting "
404 "ff-dddddddddddd\n";
405
406 if (buf[2] != '-') {
407 dev_err(dev, "%s", error_msg);
408 return -EINVAL;
409 }
410 i = sscanf(buf, "%02x-%012llx", &family, &id);
411 if (i != 2) {
412 dev_err(dev, "%s", error_msg);
413 return -EINVAL;
414 }
415 rn->family = family;
416 rn->id = id;
417
418 rn64_le = cpu_to_le64(*(u64 *)rn);
419 rn->crc = w1_calc_crc8((u8 *)&rn64_le, 7);
420
421#if 0
422 dev_info(dev, "With CRC device is %02x.%012llx.%02x.\n",
423 rn->family, (unsigned long long)rn->id, rn->crc);
424#endif
425
426 return 0;
427}
428
429/* Searches the slaves in the w1_master and returns a pointer or NULL.
430 * Note: must not hold list_mutex
431 */
432struct w1_slave *w1_slave_search_device(struct w1_master *dev,
433 struct w1_reg_num *rn)
434{
435 struct w1_slave *sl;
436 mutex_lock(&dev->list_mutex);
437 list_for_each_entry(sl, &dev->slist, w1_slave_entry) {
438 if (sl->reg_num.family == rn->family &&
439 sl->reg_num.id == rn->id &&
440 sl->reg_num.crc == rn->crc) {
441 mutex_unlock(&dev->list_mutex);
442 return sl;
443 }
444 }
445 mutex_unlock(&dev->list_mutex);
446 return NULL;
447}
448
449static ssize_t w1_master_attribute_store_add(struct device *dev,
450 struct device_attribute *attr,
451 const char *buf, size_t count)
452{
453 struct w1_master *md = dev_to_w1_master(dev);
454 struct w1_reg_num rn;
455 struct w1_slave *sl;
456 ssize_t result = count;
457
458 if (w1_atoreg_num(dev, buf, count, &rn))
459 return -EINVAL;
460
461 mutex_lock(&md->mutex);
462 sl = w1_slave_search_device(md, &rn);
463 /* It would be nice to do a targeted search one the one-wire bus
464 * for the new device to see if it is out there or not. But the
465 * current search doesn't support that.
466 */
467 if (sl) {
468 dev_info(dev, "Device %s already exists\n", sl->name);
469 result = -EINVAL;
470 } else {
471 w1_attach_slave_device(md, &rn);
472 }
473 mutex_unlock(&md->mutex);
474
475 return result;
476}
477
478static ssize_t w1_master_attribute_show_remove(struct device *dev,
479 struct device_attribute *attr, char *buf)
480{
481 int c = PAGE_SIZE;
482 c -= snprintf(buf+PAGE_SIZE - c, c,
483 "write device id xx-xxxxxxxxxxxx to remove slave\n");
484 return PAGE_SIZE - c;
485}
486
487static ssize_t w1_master_attribute_store_remove(struct device *dev,
488 struct device_attribute *attr,
489 const char *buf, size_t count)
490{
491 struct w1_master *md = dev_to_w1_master(dev);
492 struct w1_reg_num rn;
493 struct w1_slave *sl;
494 ssize_t result;
495
496 if (w1_atoreg_num(dev, buf, count, &rn))
497 return -EINVAL;
498
499 mutex_lock(&md->mutex);
500 sl = w1_slave_search_device(md, &rn);
501 if (sl) {
502 result = w1_slave_detach(sl);
503 /* refcnt 0 means it was detached in the call */
504 if (result == 0)
505 result = count;
506 } else {
507 dev_info(dev, "Device %02x-%012llx doesn't exists\n", rn.family,
508 (unsigned long long)rn.id);
509 result = -EINVAL;
510 }
511 mutex_unlock(&md->mutex);
512
513 return result;
514}
515
516#define W1_MASTER_ATTR_RO(_name, _mode) \
517 struct device_attribute w1_master_attribute_##_name = \
518 __ATTR(w1_master_##_name, _mode, \
519 w1_master_attribute_show_##_name, NULL)
520
521#define W1_MASTER_ATTR_RW(_name, _mode) \
522 struct device_attribute w1_master_attribute_##_name = \
523 __ATTR(w1_master_##_name, _mode, \
524 w1_master_attribute_show_##_name, \
525 w1_master_attribute_store_##_name)
526
527static W1_MASTER_ATTR_RO(name, S_IRUGO);
528static W1_MASTER_ATTR_RO(slaves, S_IRUGO);
529static W1_MASTER_ATTR_RO(slave_count, S_IRUGO);
530static W1_MASTER_ATTR_RW(max_slave_count, S_IRUGO | S_IWUSR | S_IWGRP);
531static W1_MASTER_ATTR_RO(attempts, S_IRUGO);
532static W1_MASTER_ATTR_RO(timeout, S_IRUGO);
533static W1_MASTER_ATTR_RO(timeout_us, S_IRUGO);
534static W1_MASTER_ATTR_RO(pointer, S_IRUGO);
535static W1_MASTER_ATTR_RW(search, S_IRUGO | S_IWUSR | S_IWGRP);
536static W1_MASTER_ATTR_RW(pullup, S_IRUGO | S_IWUSR | S_IWGRP);
537static W1_MASTER_ATTR_RW(add, S_IRUGO | S_IWUSR | S_IWGRP);
538static W1_MASTER_ATTR_RW(remove, S_IRUGO | S_IWUSR | S_IWGRP);
539
540static struct attribute *w1_master_default_attrs[] = {
541 &w1_master_attribute_name.attr,
542 &w1_master_attribute_slaves.attr,
543 &w1_master_attribute_slave_count.attr,
544 &w1_master_attribute_max_slave_count.attr,
545 &w1_master_attribute_attempts.attr,
546 &w1_master_attribute_timeout.attr,
547 &w1_master_attribute_timeout_us.attr,
548 &w1_master_attribute_pointer.attr,
549 &w1_master_attribute_search.attr,
550 &w1_master_attribute_pullup.attr,
551 &w1_master_attribute_add.attr,
552 &w1_master_attribute_remove.attr,
553 NULL
554};
555
556static const struct attribute_group w1_master_defattr_group = {
557 .attrs = w1_master_default_attrs,
558};
559
560int w1_create_master_attributes(struct w1_master *master)
561{
562 return sysfs_create_group(&master->dev.kobj, &w1_master_defattr_group);
563}
564
565void w1_destroy_master_attributes(struct w1_master *master)
566{
567 sysfs_remove_group(&master->dev.kobj, &w1_master_defattr_group);
568}
569
570static int w1_uevent(const struct device *dev, struct kobj_uevent_env *env)
571{
572 const struct w1_master *md = NULL;
573 const struct w1_slave *sl = NULL;
574 const char *event_owner, *name;
575 int err = 0;
576
577 if (dev->driver == &w1_master_driver) {
578 md = container_of(dev, struct w1_master, dev);
579 event_owner = "master";
580 name = md->name;
581 } else if (dev->driver == &w1_slave_driver) {
582 sl = container_of(dev, struct w1_slave, dev);
583 event_owner = "slave";
584 name = sl->name;
585 } else {
586 dev_dbg(dev, "Unknown event.\n");
587 return -EINVAL;
588 }
589
590 dev_dbg(dev, "Hotplug event for %s %s, bus_id=%s.\n",
591 event_owner, name, dev_name(dev));
592
593 if (dev->driver != &w1_slave_driver || !sl)
594 goto end;
595
596 err = add_uevent_var(env, "W1_FID=%02X", sl->reg_num.family);
597 if (err)
598 goto end;
599
600 err = add_uevent_var(env, "W1_SLAVE_ID=%024LX",
601 (unsigned long long)sl->reg_num.id);
602end:
603 return err;
604}
605
606static int w1_family_notify(unsigned long action, struct w1_slave *sl)
607{
608 const struct w1_family_ops *fops;
609 int err;
610
611 fops = sl->family->fops;
612
613 if (!fops)
614 return 0;
615
616 switch (action) {
617 case BUS_NOTIFY_ADD_DEVICE:
618 /* if the family driver needs to initialize something... */
619 if (fops->add_slave) {
620 err = fops->add_slave(sl);
621 if (err < 0) {
622 dev_err(&sl->dev,
623 "add_slave() call failed. err=%d\n",
624 err);
625 return err;
626 }
627 }
628 if (fops->groups) {
629 err = sysfs_create_groups(&sl->dev.kobj, fops->groups);
630 if (err) {
631 dev_err(&sl->dev,
632 "sysfs group creation failed. err=%d\n",
633 err);
634 return err;
635 }
636 }
637 if (IS_REACHABLE(CONFIG_HWMON) && fops->chip_info) {
638 struct device *hwmon
639 = hwmon_device_register_with_info(&sl->dev,
640 "w1_slave_temp", sl,
641 fops->chip_info,
642 NULL);
643 if (IS_ERR(hwmon)) {
644 dev_warn(&sl->dev,
645 "could not create hwmon device\n");
646 } else {
647 sl->hwmon = hwmon;
648 }
649 }
650 break;
651 case BUS_NOTIFY_DEL_DEVICE:
652 if (IS_REACHABLE(CONFIG_HWMON) && fops->chip_info &&
653 sl->hwmon)
654 hwmon_device_unregister(sl->hwmon);
655 if (fops->remove_slave)
656 sl->family->fops->remove_slave(sl);
657 if (fops->groups)
658 sysfs_remove_groups(&sl->dev.kobj, fops->groups);
659 break;
660 }
661 return 0;
662}
663
664static int __w1_attach_slave_device(struct w1_slave *sl)
665{
666 int err;
667
668 sl->dev.parent = &sl->master->dev;
669 sl->dev.driver = &w1_slave_driver;
670 sl->dev.bus = &w1_bus_type;
671 sl->dev.release = &w1_slave_release;
672 sl->dev.groups = w1_slave_groups;
673 sl->dev.of_node = of_find_matching_node(sl->master->dev.of_node,
674 sl->family->of_match_table);
675
676 dev_set_name(&sl->dev, "%02x-%012llx",
677 (unsigned int) sl->reg_num.family,
678 (unsigned long long) sl->reg_num.id);
679 snprintf(&sl->name[0], sizeof(sl->name),
680 "%02x-%012llx",
681 (unsigned int) sl->reg_num.family,
682 (unsigned long long) sl->reg_num.id);
683
684 dev_dbg(&sl->dev, "%s: registering %s as %p.\n", __func__,
685 dev_name(&sl->dev), sl);
686
687 /* suppress for w1_family_notify before sending KOBJ_ADD */
688 dev_set_uevent_suppress(&sl->dev, true);
689
690 err = device_register(&sl->dev);
691 if (err < 0) {
692 dev_err(&sl->dev,
693 "Device registration [%s] failed. err=%d\n",
694 dev_name(&sl->dev), err);
695 of_node_put(sl->dev.of_node);
696 put_device(&sl->dev);
697 return err;
698 }
699 w1_family_notify(BUS_NOTIFY_ADD_DEVICE, sl);
700
701 dev_set_uevent_suppress(&sl->dev, false);
702 kobject_uevent(&sl->dev.kobj, KOBJ_ADD);
703
704 mutex_lock(&sl->master->list_mutex);
705 list_add_tail(&sl->w1_slave_entry, &sl->master->slist);
706 mutex_unlock(&sl->master->list_mutex);
707
708 return 0;
709}
710
711int w1_attach_slave_device(struct w1_master *dev, struct w1_reg_num *rn)
712{
713 struct w1_slave *sl;
714 struct w1_family *f;
715 int err;
716 struct w1_netlink_msg msg;
717
718 sl = kzalloc(sizeof(struct w1_slave), GFP_KERNEL);
719 if (!sl) {
720 dev_err(&dev->dev,
721 "%s: failed to allocate new slave device.\n",
722 __func__);
723 return -ENOMEM;
724 }
725
726
727 sl->owner = THIS_MODULE;
728 sl->master = dev;
729 set_bit(W1_SLAVE_ACTIVE, &sl->flags);
730
731 memset(&msg, 0, sizeof(msg));
732 memcpy(&sl->reg_num, rn, sizeof(sl->reg_num));
733 atomic_set(&sl->refcnt, 1);
734 atomic_inc(&sl->master->refcnt);
735 dev->slave_count++;
736 dev_info(&dev->dev, "Attaching one wire slave %02x.%012llx crc %02x\n",
737 rn->family, (unsigned long long)rn->id, rn->crc);
738
739 /* slave modules need to be loaded in a context with unlocked mutex */
740 mutex_unlock(&dev->mutex);
741 request_module("w1-family-0x%02X", rn->family);
742 mutex_lock(&dev->mutex);
743
744 spin_lock(&w1_flock);
745 f = w1_family_registered(rn->family);
746 if (!f) {
747 f= &w1_default_family;
748 dev_info(&dev->dev, "Family %x for %02x.%012llx.%02x is not registered.\n",
749 rn->family, rn->family,
750 (unsigned long long)rn->id, rn->crc);
751 }
752 __w1_family_get(f);
753 spin_unlock(&w1_flock);
754
755 sl->family = f;
756
757 err = __w1_attach_slave_device(sl);
758 if (err < 0) {
759 dev_err(&dev->dev, "%s: Attaching %s failed.\n", __func__,
760 sl->name);
761 dev->slave_count--;
762 w1_family_put(sl->family);
763 atomic_dec(&sl->master->refcnt);
764 kfree(sl);
765 return err;
766 }
767
768 sl->ttl = dev->slave_ttl;
769
770 memcpy(msg.id.id, rn, sizeof(msg.id));
771 msg.type = W1_SLAVE_ADD;
772 w1_netlink_send(dev, &msg);
773
774 return 0;
775}
776
777int w1_unref_slave(struct w1_slave *sl)
778{
779 struct w1_master *dev = sl->master;
780 int refcnt;
781 mutex_lock(&dev->list_mutex);
782 refcnt = atomic_sub_return(1, &sl->refcnt);
783 if (refcnt == 0) {
784 struct w1_netlink_msg msg;
785
786 dev_dbg(&sl->dev, "%s: detaching %s [%p].\n", __func__,
787 sl->name, sl);
788
789 list_del(&sl->w1_slave_entry);
790
791 memset(&msg, 0, sizeof(msg));
792 memcpy(msg.id.id, &sl->reg_num, sizeof(msg.id));
793 msg.type = W1_SLAVE_REMOVE;
794 w1_netlink_send(sl->master, &msg);
795
796 w1_family_notify(BUS_NOTIFY_DEL_DEVICE, sl);
797 device_unregister(&sl->dev);
798 #ifdef DEBUG
799 memset(sl, 0, sizeof(*sl));
800 #endif
801 kfree(sl);
802 }
803 atomic_dec(&dev->refcnt);
804 mutex_unlock(&dev->list_mutex);
805 return refcnt;
806}
807
808int w1_slave_detach(struct w1_slave *sl)
809{
810 /* Only detach a slave once as it decreases the refcnt each time. */
811 int destroy_now;
812 mutex_lock(&sl->master->list_mutex);
813 destroy_now = !test_bit(W1_SLAVE_DETACH, &sl->flags);
814 set_bit(W1_SLAVE_DETACH, &sl->flags);
815 mutex_unlock(&sl->master->list_mutex);
816
817 if (destroy_now)
818 destroy_now = !w1_unref_slave(sl);
819 return destroy_now ? 0 : -EBUSY;
820}
821
822struct w1_master *w1_search_master_id(u32 id)
823{
824 struct w1_master *dev = NULL, *iter;
825
826 mutex_lock(&w1_mlock);
827 list_for_each_entry(iter, &w1_masters, w1_master_entry) {
828 if (iter->id == id) {
829 dev = iter;
830 atomic_inc(&iter->refcnt);
831 break;
832 }
833 }
834 mutex_unlock(&w1_mlock);
835
836 return dev;
837}
838
839struct w1_slave *w1_search_slave(struct w1_reg_num *id)
840{
841 struct w1_master *dev;
842 struct w1_slave *sl = NULL, *iter;
843
844 mutex_lock(&w1_mlock);
845 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
846 mutex_lock(&dev->list_mutex);
847 list_for_each_entry(iter, &dev->slist, w1_slave_entry) {
848 if (iter->reg_num.family == id->family &&
849 iter->reg_num.id == id->id &&
850 iter->reg_num.crc == id->crc) {
851 sl = iter;
852 atomic_inc(&dev->refcnt);
853 atomic_inc(&iter->refcnt);
854 break;
855 }
856 }
857 mutex_unlock(&dev->list_mutex);
858
859 if (sl)
860 break;
861 }
862 mutex_unlock(&w1_mlock);
863
864 return sl;
865}
866
867void w1_reconnect_slaves(struct w1_family *f, int attach)
868{
869 struct w1_slave *sl, *sln;
870 struct w1_master *dev;
871
872 mutex_lock(&w1_mlock);
873 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
874 dev_dbg(&dev->dev, "Reconnecting slaves in device %s "
875 "for family %02x.\n", dev->name, f->fid);
876 mutex_lock(&dev->mutex);
877 mutex_lock(&dev->list_mutex);
878 list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
879 /* If it is a new family, slaves with the default
880 * family driver and are that family will be
881 * connected. If the family is going away, devices
882 * matching that family are reconneced.
883 */
884 if ((attach && sl->family->fid == W1_FAMILY_DEFAULT
885 && sl->reg_num.family == f->fid) ||
886 (!attach && sl->family->fid == f->fid)) {
887 struct w1_reg_num rn;
888
889 mutex_unlock(&dev->list_mutex);
890 memcpy(&rn, &sl->reg_num, sizeof(rn));
891 /* If it was already in use let the automatic
892 * scan pick it up again later.
893 */
894 if (!w1_slave_detach(sl))
895 w1_attach_slave_device(dev, &rn);
896 mutex_lock(&dev->list_mutex);
897 }
898 }
899 dev_dbg(&dev->dev, "Reconnecting slaves in device %s "
900 "has been finished.\n", dev->name);
901 mutex_unlock(&dev->list_mutex);
902 mutex_unlock(&dev->mutex);
903 }
904 mutex_unlock(&w1_mlock);
905}
906
907static int w1_addr_crc_is_valid(struct w1_master *dev, u64 rn)
908{
909 u64 rn_le = cpu_to_le64(rn);
910 struct w1_reg_num *tmp = (struct w1_reg_num *)&rn;
911 u8 crc;
912
913 crc = w1_calc_crc8((u8 *)&rn_le, 7);
914
915 /* quirk:
916 * DS28E04 (1w eeprom) has strapping pins to change
917 * address, but will not update the crc. So normal rules
918 * for consistent w1 addresses are violated. We test
919 * with the 7 LSBs of the address forced high.
920 *
921 * (char*)&rn_le = { family, addr_lsb, ..., addr_msb, crc }.
922 */
923 if (crc != tmp->crc && tmp->family == W1_FAMILY_DS28E04) {
924 u64 corr_le = rn_le;
925
926 ((u8 *)&corr_le)[1] |= 0x7f;
927 crc = w1_calc_crc8((u8 *)&corr_le, 7);
928
929 dev_info(&dev->dev, "DS28E04 crc workaround on %02x.%012llx.%02x\n",
930 tmp->family, (unsigned long long)tmp->id, tmp->crc);
931 }
932
933 if (crc != tmp->crc) {
934 dev_dbg(&dev->dev, "w1 addr crc mismatch: %02x.%012llx.%02x != 0x%02x.\n",
935 tmp->family, (unsigned long long)tmp->id, tmp->crc, crc);
936 return 0;
937 }
938 return 1;
939}
940
941void w1_slave_found(struct w1_master *dev, u64 rn)
942{
943 struct w1_slave *sl;
944 struct w1_reg_num *tmp;
945
946 atomic_inc(&dev->refcnt);
947
948 tmp = (struct w1_reg_num *) &rn;
949
950 sl = w1_slave_search_device(dev, tmp);
951 if (sl) {
952 set_bit(W1_SLAVE_ACTIVE, &sl->flags);
953 } else {
954 if (rn && w1_addr_crc_is_valid(dev, rn))
955 w1_attach_slave_device(dev, tmp);
956 }
957
958 atomic_dec(&dev->refcnt);
959}
960
961/**
962 * w1_search() - Performs a ROM Search & registers any devices found.
963 * @dev: The master device to search
964 * @search_type: W1_SEARCH to search all devices, or W1_ALARM_SEARCH
965 * to return only devices in the alarmed state
966 * @cb: Function to call when a device is found
967 *
968 * The 1-wire search is a simple binary tree search.
969 * For each bit of the address, we read two bits and write one bit.
970 * The bit written will put to sleep all devies that don't match that bit.
971 * When the two reads differ, the direction choice is obvious.
972 * When both bits are 0, we must choose a path to take.
973 * When we can scan all 64 bits without having to choose a path, we are done.
974 *
975 * See "Application note 187 1-wire search algorithm" at www.maxim-ic.com
976 *
977 */
978void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb)
979{
980 u64 last_rn, rn, tmp64;
981 int i, slave_count = 0;
982 int last_zero, last_device;
983 int search_bit, desc_bit;
984 u8 triplet_ret = 0;
985
986 search_bit = 0;
987 rn = dev->search_id;
988 last_rn = 0;
989 last_device = 0;
990 last_zero = -1;
991
992 desc_bit = 64;
993
994 while ( !last_device && (slave_count++ < dev->max_slave_count) ) {
995 last_rn = rn;
996 rn = 0;
997
998 /*
999 * Reset bus and all 1-wire device state machines
1000 * so they can respond to our requests.
1001 *
1002 * Return 0 - device(s) present, 1 - no devices present.
1003 */
1004 mutex_lock(&dev->bus_mutex);
1005 if (w1_reset_bus(dev)) {
1006 mutex_unlock(&dev->bus_mutex);
1007 dev_dbg(&dev->dev, "No devices present on the wire.\n");
1008 break;
1009 }
1010
1011 /* Do fast search on single slave bus */
1012 if (dev->max_slave_count == 1) {
1013 int rv;
1014 w1_write_8(dev, W1_READ_ROM);
1015 rv = w1_read_block(dev, (u8 *)&rn, 8);
1016 mutex_unlock(&dev->bus_mutex);
1017
1018 if (rv == 8 && rn)
1019 cb(dev, rn);
1020
1021 break;
1022 }
1023
1024 /* Start the search */
1025 w1_write_8(dev, search_type);
1026 for (i = 0; i < 64; ++i) {
1027 /* Determine the direction/search bit */
1028 if (i == desc_bit)
1029 search_bit = 1; /* took the 0 path last time, so take the 1 path */
1030 else if (i > desc_bit)
1031 search_bit = 0; /* take the 0 path on the next branch */
1032 else
1033 search_bit = ((last_rn >> i) & 0x1);
1034
1035 /* Read two bits and write one bit */
1036 triplet_ret = w1_triplet(dev, search_bit);
1037
1038 /* quit if no device responded */
1039 if ( (triplet_ret & 0x03) == 0x03 )
1040 break;
1041
1042 /* If both directions were valid, and we took the 0 path... */
1043 if (triplet_ret == 0)
1044 last_zero = i;
1045
1046 /* extract the direction taken & update the device number */
1047 tmp64 = (triplet_ret >> 2);
1048 rn |= (tmp64 << i);
1049
1050 if (test_bit(W1_ABORT_SEARCH, &dev->flags)) {
1051 mutex_unlock(&dev->bus_mutex);
1052 dev_dbg(&dev->dev, "Abort w1_search\n");
1053 return;
1054 }
1055 }
1056 mutex_unlock(&dev->bus_mutex);
1057
1058 if ( (triplet_ret & 0x03) != 0x03 ) {
1059 if ((desc_bit == last_zero) || (last_zero < 0)) {
1060 last_device = 1;
1061 dev->search_id = 0;
1062 } else {
1063 dev->search_id = rn;
1064 }
1065 desc_bit = last_zero;
1066 cb(dev, rn);
1067 }
1068
1069 if (!last_device && slave_count == dev->max_slave_count &&
1070 !test_bit(W1_WARN_MAX_COUNT, &dev->flags)) {
1071 /* Only max_slave_count will be scanned in a search,
1072 * but it will start where it left off next search
1073 * until all ids are identified and then it will start
1074 * over. A continued search will report the previous
1075 * last id as the first id (provided it is still on the
1076 * bus).
1077 */
1078 dev_info(&dev->dev, "%s: max_slave_count %d reached, "
1079 "will continue next search.\n", __func__,
1080 dev->max_slave_count);
1081 set_bit(W1_WARN_MAX_COUNT, &dev->flags);
1082 }
1083 }
1084}
1085
1086void w1_search_process_cb(struct w1_master *dev, u8 search_type,
1087 w1_slave_found_callback cb)
1088{
1089 struct w1_slave *sl, *sln;
1090
1091 mutex_lock(&dev->list_mutex);
1092 list_for_each_entry(sl, &dev->slist, w1_slave_entry)
1093 clear_bit(W1_SLAVE_ACTIVE, &sl->flags);
1094 mutex_unlock(&dev->list_mutex);
1095
1096 w1_search_devices(dev, search_type, cb);
1097
1098 mutex_lock(&dev->list_mutex);
1099 list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
1100 if (!test_bit(W1_SLAVE_ACTIVE, &sl->flags) && !--sl->ttl) {
1101 mutex_unlock(&dev->list_mutex);
1102 w1_slave_detach(sl);
1103 mutex_lock(&dev->list_mutex);
1104 }
1105 else if (test_bit(W1_SLAVE_ACTIVE, &sl->flags))
1106 sl->ttl = dev->slave_ttl;
1107 }
1108 mutex_unlock(&dev->list_mutex);
1109
1110 if (dev->search_count > 0)
1111 dev->search_count--;
1112}
1113
1114static void w1_search_process(struct w1_master *dev, u8 search_type)
1115{
1116 w1_search_process_cb(dev, search_type, w1_slave_found);
1117}
1118
1119/**
1120 * w1_process_callbacks() - execute each dev->async_list callback entry
1121 * @dev: w1_master device
1122 *
1123 * The w1 master list_mutex must be held.
1124 *
1125 * Return: 1 if there were commands to executed 0 otherwise
1126 */
1127int w1_process_callbacks(struct w1_master *dev)
1128{
1129 int ret = 0;
1130 struct w1_async_cmd *async_cmd, *async_n;
1131
1132 /* The list can be added to in another thread, loop until it is empty */
1133 while (!list_empty(&dev->async_list)) {
1134 list_for_each_entry_safe(async_cmd, async_n, &dev->async_list,
1135 async_entry) {
1136 /* drop the lock, if it is a search it can take a long
1137 * time */
1138 mutex_unlock(&dev->list_mutex);
1139 async_cmd->cb(dev, async_cmd);
1140 ret = 1;
1141 mutex_lock(&dev->list_mutex);
1142 }
1143 }
1144 return ret;
1145}
1146
1147int w1_process(void *data)
1148{
1149 struct w1_master *dev = (struct w1_master *) data;
1150 /* As long as w1_timeout is only set by a module parameter the sleep
1151 * time can be calculated in jiffies once.
1152 */
1153 const unsigned long jtime =
1154 usecs_to_jiffies(w1_timeout * 1000000 + w1_timeout_us);
1155 /* remainder if it woke up early */
1156 unsigned long jremain = 0;
1157
1158 atomic_inc(&dev->refcnt);
1159
1160 for (;;) {
1161
1162 if (!jremain && dev->search_count) {
1163 mutex_lock(&dev->mutex);
1164 w1_search_process(dev, W1_SEARCH);
1165 mutex_unlock(&dev->mutex);
1166 }
1167
1168 mutex_lock(&dev->list_mutex);
1169 /* Note, w1_process_callback drops the lock while processing,
1170 * but locks it again before returning.
1171 */
1172 if (!w1_process_callbacks(dev) && jremain) {
1173 /* a wake up is either to stop the thread, process
1174 * callbacks, or search, it isn't process callbacks, so
1175 * schedule a search.
1176 */
1177 jremain = 1;
1178 }
1179
1180 __set_current_state(TASK_INTERRUPTIBLE);
1181
1182 /* hold list_mutex until after interruptible to prevent loosing
1183 * the wakeup signal when async_cmd is added.
1184 */
1185 mutex_unlock(&dev->list_mutex);
1186
1187 if (kthread_should_stop()) {
1188 __set_current_state(TASK_RUNNING);
1189 break;
1190 }
1191
1192 /* Only sleep when the search is active. */
1193 if (dev->search_count) {
1194 if (!jremain)
1195 jremain = jtime;
1196 jremain = schedule_timeout(jremain);
1197 }
1198 else
1199 schedule();
1200 }
1201
1202 atomic_dec(&dev->refcnt);
1203
1204 return 0;
1205}
1206
1207static int __init w1_init(void)
1208{
1209 int retval;
1210
1211 pr_info("Driver for 1-wire Dallas network protocol.\n");
1212
1213 w1_init_netlink();
1214
1215 retval = bus_register(&w1_bus_type);
1216 if (retval) {
1217 pr_err("Failed to register bus. err=%d.\n", retval);
1218 goto err_out_exit_init;
1219 }
1220
1221 retval = driver_register(&w1_master_driver);
1222 if (retval) {
1223 pr_err("Failed to register master driver. err=%d.\n",
1224 retval);
1225 goto err_out_bus_unregister;
1226 }
1227
1228 retval = driver_register(&w1_slave_driver);
1229 if (retval) {
1230 pr_err("Failed to register slave driver. err=%d.\n",
1231 retval);
1232 goto err_out_master_unregister;
1233 }
1234
1235 return 0;
1236
1237#if 0
1238/* For undoing the slave register if there was a step after it. */
1239err_out_slave_unregister:
1240 driver_unregister(&w1_slave_driver);
1241#endif
1242
1243err_out_master_unregister:
1244 driver_unregister(&w1_master_driver);
1245
1246err_out_bus_unregister:
1247 bus_unregister(&w1_bus_type);
1248
1249err_out_exit_init:
1250 return retval;
1251}
1252
1253static void __exit w1_fini(void)
1254{
1255 struct w1_master *dev, *n;
1256
1257 /* Set netlink removal messages and some cleanup */
1258 list_for_each_entry_safe(dev, n, &w1_masters, w1_master_entry)
1259 __w1_remove_master_device(dev);
1260
1261 w1_fini_netlink();
1262
1263 driver_unregister(&w1_slave_driver);
1264 driver_unregister(&w1_master_driver);
1265 bus_unregister(&w1_bus_type);
1266}
1267
1268module_init(w1_init);
1269module_exit(w1_fini);
1270
1271MODULE_AUTHOR("Evgeniy Polyakov <zbr@ioremap.net>");
1272MODULE_DESCRIPTION("Driver for 1-wire Dallas network protocol.");
1273MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
4 */
5
6#include <linux/delay.h>
7#include <linux/kernel.h>
8#include <linux/module.h>
9#include <linux/moduleparam.h>
10#include <linux/list.h>
11#include <linux/interrupt.h>
12#include <linux/spinlock.h>
13#include <linux/timer.h>
14#include <linux/device.h>
15#include <linux/slab.h>
16#include <linux/sched.h>
17#include <linux/kthread.h>
18#include <linux/freezer.h>
19#include <linux/hwmon.h>
20#include <linux/of.h>
21
22#include <linux/atomic.h>
23
24#include "w1_internal.h"
25#include "w1_netlink.h"
26
27#define W1_FAMILY_DEFAULT 0
28#define W1_FAMILY_DS28E04 0x1C /* for crc quirk */
29
30
31static int w1_timeout = 10;
32module_param_named(timeout, w1_timeout, int, 0);
33MODULE_PARM_DESC(timeout, "time in seconds between automatic slave searches");
34
35static int w1_timeout_us = 0;
36module_param_named(timeout_us, w1_timeout_us, int, 0);
37MODULE_PARM_DESC(timeout_us,
38 "time in microseconds between automatic slave searches");
39
40/* A search stops when w1_max_slave_count devices have been found in that
41 * search. The next search will start over and detect the same set of devices
42 * on a static 1-wire bus. Memory is not allocated based on this number, just
43 * on the number of devices known to the kernel. Having a high number does not
44 * consume additional resources. As a special case, if there is only one
45 * device on the network and w1_max_slave_count is set to 1, the device id can
46 * be read directly skipping the normal slower search process.
47 */
48int w1_max_slave_count = 64;
49module_param_named(max_slave_count, w1_max_slave_count, int, 0);
50MODULE_PARM_DESC(max_slave_count,
51 "maximum number of slaves detected in a search");
52
53int w1_max_slave_ttl = 10;
54module_param_named(slave_ttl, w1_max_slave_ttl, int, 0);
55MODULE_PARM_DESC(slave_ttl,
56 "Number of searches not seeing a slave before it will be removed");
57
58DEFINE_MUTEX(w1_mlock);
59LIST_HEAD(w1_masters);
60
61static int w1_master_match(struct device *dev, struct device_driver *drv)
62{
63 return 1;
64}
65
66static int w1_master_probe(struct device *dev)
67{
68 return -ENODEV;
69}
70
71static void w1_master_release(struct device *dev)
72{
73 struct w1_master *md = dev_to_w1_master(dev);
74
75 dev_dbg(dev, "%s: Releasing %s.\n", __func__, md->name);
76 memset(md, 0, sizeof(struct w1_master) + sizeof(struct w1_bus_master));
77 kfree(md);
78}
79
80static void w1_slave_release(struct device *dev)
81{
82 struct w1_slave *sl = dev_to_w1_slave(dev);
83
84 dev_dbg(dev, "%s: Releasing %s [%p]\n", __func__, sl->name, sl);
85
86 w1_family_put(sl->family);
87 sl->master->slave_count--;
88}
89
90static ssize_t name_show(struct device *dev, struct device_attribute *attr, char *buf)
91{
92 struct w1_slave *sl = dev_to_w1_slave(dev);
93
94 return sprintf(buf, "%s\n", sl->name);
95}
96static DEVICE_ATTR_RO(name);
97
98static ssize_t id_show(struct device *dev,
99 struct device_attribute *attr, char *buf)
100{
101 struct w1_slave *sl = dev_to_w1_slave(dev);
102 ssize_t count = sizeof(sl->reg_num);
103
104 memcpy(buf, (u8 *)&sl->reg_num, count);
105 return count;
106}
107static DEVICE_ATTR_RO(id);
108
109static struct attribute *w1_slave_attrs[] = {
110 &dev_attr_name.attr,
111 &dev_attr_id.attr,
112 NULL,
113};
114ATTRIBUTE_GROUPS(w1_slave);
115
116/* Default family */
117
118static ssize_t rw_write(struct file *filp, struct kobject *kobj,
119 struct bin_attribute *bin_attr, char *buf, loff_t off,
120 size_t count)
121{
122 struct w1_slave *sl = kobj_to_w1_slave(kobj);
123
124 mutex_lock(&sl->master->mutex);
125 if (w1_reset_select_slave(sl)) {
126 count = 0;
127 goto out_up;
128 }
129
130 w1_write_block(sl->master, buf, count);
131
132out_up:
133 mutex_unlock(&sl->master->mutex);
134 return count;
135}
136
137static ssize_t rw_read(struct file *filp, struct kobject *kobj,
138 struct bin_attribute *bin_attr, char *buf, loff_t off,
139 size_t count)
140{
141 struct w1_slave *sl = kobj_to_w1_slave(kobj);
142
143 mutex_lock(&sl->master->mutex);
144 w1_read_block(sl->master, buf, count);
145 mutex_unlock(&sl->master->mutex);
146 return count;
147}
148
149static BIN_ATTR_RW(rw, PAGE_SIZE);
150
151static struct bin_attribute *w1_slave_bin_attrs[] = {
152 &bin_attr_rw,
153 NULL,
154};
155
156static const struct attribute_group w1_slave_default_group = {
157 .bin_attrs = w1_slave_bin_attrs,
158};
159
160static const struct attribute_group *w1_slave_default_groups[] = {
161 &w1_slave_default_group,
162 NULL,
163};
164
165static const struct w1_family_ops w1_default_fops = {
166 .groups = w1_slave_default_groups,
167};
168
169static struct w1_family w1_default_family = {
170 .fops = &w1_default_fops,
171};
172
173static int w1_uevent(struct device *dev, struct kobj_uevent_env *env);
174
175static struct bus_type w1_bus_type = {
176 .name = "w1",
177 .match = w1_master_match,
178 .uevent = w1_uevent,
179};
180
181struct device_driver w1_master_driver = {
182 .name = "w1_master_driver",
183 .bus = &w1_bus_type,
184 .probe = w1_master_probe,
185};
186
187struct device w1_master_device = {
188 .parent = NULL,
189 .bus = &w1_bus_type,
190 .init_name = "w1 bus master",
191 .driver = &w1_master_driver,
192 .release = &w1_master_release
193};
194
195static struct device_driver w1_slave_driver = {
196 .name = "w1_slave_driver",
197 .bus = &w1_bus_type,
198};
199
200#if 0
201struct device w1_slave_device = {
202 .parent = NULL,
203 .bus = &w1_bus_type,
204 .init_name = "w1 bus slave",
205 .driver = &w1_slave_driver,
206 .release = &w1_slave_release
207};
208#endif /* 0 */
209
210static ssize_t w1_master_attribute_show_name(struct device *dev, struct device_attribute *attr, char *buf)
211{
212 struct w1_master *md = dev_to_w1_master(dev);
213 ssize_t count;
214
215 mutex_lock(&md->mutex);
216 count = sprintf(buf, "%s\n", md->name);
217 mutex_unlock(&md->mutex);
218
219 return count;
220}
221
222static ssize_t w1_master_attribute_store_search(struct device * dev,
223 struct device_attribute *attr,
224 const char * buf, size_t count)
225{
226 long tmp;
227 struct w1_master *md = dev_to_w1_master(dev);
228 int ret;
229
230 ret = kstrtol(buf, 0, &tmp);
231 if (ret)
232 return ret;
233
234 mutex_lock(&md->mutex);
235 md->search_count = tmp;
236 mutex_unlock(&md->mutex);
237 /* Only wake if it is going to be searching. */
238 if (tmp)
239 wake_up_process(md->thread);
240
241 return count;
242}
243
244static ssize_t w1_master_attribute_show_search(struct device *dev,
245 struct device_attribute *attr,
246 char *buf)
247{
248 struct w1_master *md = dev_to_w1_master(dev);
249 ssize_t count;
250
251 mutex_lock(&md->mutex);
252 count = sprintf(buf, "%d\n", md->search_count);
253 mutex_unlock(&md->mutex);
254
255 return count;
256}
257
258static ssize_t w1_master_attribute_store_pullup(struct device *dev,
259 struct device_attribute *attr,
260 const char *buf, size_t count)
261{
262 long tmp;
263 struct w1_master *md = dev_to_w1_master(dev);
264 int ret;
265
266 ret = kstrtol(buf, 0, &tmp);
267 if (ret)
268 return ret;
269
270 mutex_lock(&md->mutex);
271 md->enable_pullup = tmp;
272 mutex_unlock(&md->mutex);
273
274 return count;
275}
276
277static ssize_t w1_master_attribute_show_pullup(struct device *dev,
278 struct device_attribute *attr,
279 char *buf)
280{
281 struct w1_master *md = dev_to_w1_master(dev);
282 ssize_t count;
283
284 mutex_lock(&md->mutex);
285 count = sprintf(buf, "%d\n", md->enable_pullup);
286 mutex_unlock(&md->mutex);
287
288 return count;
289}
290
291static ssize_t w1_master_attribute_show_pointer(struct device *dev, struct device_attribute *attr, char *buf)
292{
293 struct w1_master *md = dev_to_w1_master(dev);
294 ssize_t count;
295
296 mutex_lock(&md->mutex);
297 count = sprintf(buf, "0x%p\n", md->bus_master);
298 mutex_unlock(&md->mutex);
299 return count;
300}
301
302static ssize_t w1_master_attribute_show_timeout(struct device *dev, struct device_attribute *attr, char *buf)
303{
304 ssize_t count;
305 count = sprintf(buf, "%d\n", w1_timeout);
306 return count;
307}
308
309static ssize_t w1_master_attribute_show_timeout_us(struct device *dev,
310 struct device_attribute *attr, char *buf)
311{
312 ssize_t count;
313 count = sprintf(buf, "%d\n", w1_timeout_us);
314 return count;
315}
316
317static ssize_t w1_master_attribute_store_max_slave_count(struct device *dev,
318 struct device_attribute *attr, const char *buf, size_t count)
319{
320 int tmp;
321 struct w1_master *md = dev_to_w1_master(dev);
322
323 if (kstrtoint(buf, 0, &tmp) || tmp < 1)
324 return -EINVAL;
325
326 mutex_lock(&md->mutex);
327 md->max_slave_count = tmp;
328 /* allow each time the max_slave_count is updated */
329 clear_bit(W1_WARN_MAX_COUNT, &md->flags);
330 mutex_unlock(&md->mutex);
331
332 return count;
333}
334
335static ssize_t w1_master_attribute_show_max_slave_count(struct device *dev, struct device_attribute *attr, char *buf)
336{
337 struct w1_master *md = dev_to_w1_master(dev);
338 ssize_t count;
339
340 mutex_lock(&md->mutex);
341 count = sprintf(buf, "%d\n", md->max_slave_count);
342 mutex_unlock(&md->mutex);
343 return count;
344}
345
346static ssize_t w1_master_attribute_show_attempts(struct device *dev, struct device_attribute *attr, char *buf)
347{
348 struct w1_master *md = dev_to_w1_master(dev);
349 ssize_t count;
350
351 mutex_lock(&md->mutex);
352 count = sprintf(buf, "%lu\n", md->attempts);
353 mutex_unlock(&md->mutex);
354 return count;
355}
356
357static ssize_t w1_master_attribute_show_slave_count(struct device *dev, struct device_attribute *attr, char *buf)
358{
359 struct w1_master *md = dev_to_w1_master(dev);
360 ssize_t count;
361
362 mutex_lock(&md->mutex);
363 count = sprintf(buf, "%d\n", md->slave_count);
364 mutex_unlock(&md->mutex);
365 return count;
366}
367
368static ssize_t w1_master_attribute_show_slaves(struct device *dev,
369 struct device_attribute *attr, char *buf)
370{
371 struct w1_master *md = dev_to_w1_master(dev);
372 int c = PAGE_SIZE;
373 struct list_head *ent, *n;
374 struct w1_slave *sl = NULL;
375
376 mutex_lock(&md->list_mutex);
377
378 list_for_each_safe(ent, n, &md->slist) {
379 sl = list_entry(ent, struct w1_slave, w1_slave_entry);
380
381 c -= snprintf(buf + PAGE_SIZE - c, c, "%s\n", sl->name);
382 }
383 if (!sl)
384 c -= snprintf(buf + PAGE_SIZE - c, c, "not found.\n");
385
386 mutex_unlock(&md->list_mutex);
387
388 return PAGE_SIZE - c;
389}
390
391static ssize_t w1_master_attribute_show_add(struct device *dev,
392 struct device_attribute *attr, char *buf)
393{
394 int c = PAGE_SIZE;
395 c -= snprintf(buf+PAGE_SIZE - c, c,
396 "write device id xx-xxxxxxxxxxxx to add slave\n");
397 return PAGE_SIZE - c;
398}
399
400static int w1_atoreg_num(struct device *dev, const char *buf, size_t count,
401 struct w1_reg_num *rn)
402{
403 unsigned int family;
404 unsigned long long id;
405 int i;
406 u64 rn64_le;
407
408 /* The CRC value isn't read from the user because the sysfs directory
409 * doesn't include it and most messages from the bus search don't
410 * print it either. It would be unreasonable for the user to then
411 * provide it.
412 */
413 const char *error_msg = "bad slave string format, expecting "
414 "ff-dddddddddddd\n";
415
416 if (buf[2] != '-') {
417 dev_err(dev, "%s", error_msg);
418 return -EINVAL;
419 }
420 i = sscanf(buf, "%02x-%012llx", &family, &id);
421 if (i != 2) {
422 dev_err(dev, "%s", error_msg);
423 return -EINVAL;
424 }
425 rn->family = family;
426 rn->id = id;
427
428 rn64_le = cpu_to_le64(*(u64 *)rn);
429 rn->crc = w1_calc_crc8((u8 *)&rn64_le, 7);
430
431#if 0
432 dev_info(dev, "With CRC device is %02x.%012llx.%02x.\n",
433 rn->family, (unsigned long long)rn->id, rn->crc);
434#endif
435
436 return 0;
437}
438
439/* Searches the slaves in the w1_master and returns a pointer or NULL.
440 * Note: must not hold list_mutex
441 */
442struct w1_slave *w1_slave_search_device(struct w1_master *dev,
443 struct w1_reg_num *rn)
444{
445 struct w1_slave *sl;
446 mutex_lock(&dev->list_mutex);
447 list_for_each_entry(sl, &dev->slist, w1_slave_entry) {
448 if (sl->reg_num.family == rn->family &&
449 sl->reg_num.id == rn->id &&
450 sl->reg_num.crc == rn->crc) {
451 mutex_unlock(&dev->list_mutex);
452 return sl;
453 }
454 }
455 mutex_unlock(&dev->list_mutex);
456 return NULL;
457}
458
459static ssize_t w1_master_attribute_store_add(struct device *dev,
460 struct device_attribute *attr,
461 const char *buf, size_t count)
462{
463 struct w1_master *md = dev_to_w1_master(dev);
464 struct w1_reg_num rn;
465 struct w1_slave *sl;
466 ssize_t result = count;
467
468 if (w1_atoreg_num(dev, buf, count, &rn))
469 return -EINVAL;
470
471 mutex_lock(&md->mutex);
472 sl = w1_slave_search_device(md, &rn);
473 /* It would be nice to do a targeted search one the one-wire bus
474 * for the new device to see if it is out there or not. But the
475 * current search doesn't support that.
476 */
477 if (sl) {
478 dev_info(dev, "Device %s already exists\n", sl->name);
479 result = -EINVAL;
480 } else {
481 w1_attach_slave_device(md, &rn);
482 }
483 mutex_unlock(&md->mutex);
484
485 return result;
486}
487
488static ssize_t w1_master_attribute_show_remove(struct device *dev,
489 struct device_attribute *attr, char *buf)
490{
491 int c = PAGE_SIZE;
492 c -= snprintf(buf+PAGE_SIZE - c, c,
493 "write device id xx-xxxxxxxxxxxx to remove slave\n");
494 return PAGE_SIZE - c;
495}
496
497static ssize_t w1_master_attribute_store_remove(struct device *dev,
498 struct device_attribute *attr,
499 const char *buf, size_t count)
500{
501 struct w1_master *md = dev_to_w1_master(dev);
502 struct w1_reg_num rn;
503 struct w1_slave *sl;
504 ssize_t result = count;
505
506 if (w1_atoreg_num(dev, buf, count, &rn))
507 return -EINVAL;
508
509 mutex_lock(&md->mutex);
510 sl = w1_slave_search_device(md, &rn);
511 if (sl) {
512 result = w1_slave_detach(sl);
513 /* refcnt 0 means it was detached in the call */
514 if (result == 0)
515 result = count;
516 } else {
517 dev_info(dev, "Device %02x-%012llx doesn't exists\n", rn.family,
518 (unsigned long long)rn.id);
519 result = -EINVAL;
520 }
521 mutex_unlock(&md->mutex);
522
523 return result;
524}
525
526#define W1_MASTER_ATTR_RO(_name, _mode) \
527 struct device_attribute w1_master_attribute_##_name = \
528 __ATTR(w1_master_##_name, _mode, \
529 w1_master_attribute_show_##_name, NULL)
530
531#define W1_MASTER_ATTR_RW(_name, _mode) \
532 struct device_attribute w1_master_attribute_##_name = \
533 __ATTR(w1_master_##_name, _mode, \
534 w1_master_attribute_show_##_name, \
535 w1_master_attribute_store_##_name)
536
537static W1_MASTER_ATTR_RO(name, S_IRUGO);
538static W1_MASTER_ATTR_RO(slaves, S_IRUGO);
539static W1_MASTER_ATTR_RO(slave_count, S_IRUGO);
540static W1_MASTER_ATTR_RW(max_slave_count, S_IRUGO | S_IWUSR | S_IWGRP);
541static W1_MASTER_ATTR_RO(attempts, S_IRUGO);
542static W1_MASTER_ATTR_RO(timeout, S_IRUGO);
543static W1_MASTER_ATTR_RO(timeout_us, S_IRUGO);
544static W1_MASTER_ATTR_RO(pointer, S_IRUGO);
545static W1_MASTER_ATTR_RW(search, S_IRUGO | S_IWUSR | S_IWGRP);
546static W1_MASTER_ATTR_RW(pullup, S_IRUGO | S_IWUSR | S_IWGRP);
547static W1_MASTER_ATTR_RW(add, S_IRUGO | S_IWUSR | S_IWGRP);
548static W1_MASTER_ATTR_RW(remove, S_IRUGO | S_IWUSR | S_IWGRP);
549
550static struct attribute *w1_master_default_attrs[] = {
551 &w1_master_attribute_name.attr,
552 &w1_master_attribute_slaves.attr,
553 &w1_master_attribute_slave_count.attr,
554 &w1_master_attribute_max_slave_count.attr,
555 &w1_master_attribute_attempts.attr,
556 &w1_master_attribute_timeout.attr,
557 &w1_master_attribute_timeout_us.attr,
558 &w1_master_attribute_pointer.attr,
559 &w1_master_attribute_search.attr,
560 &w1_master_attribute_pullup.attr,
561 &w1_master_attribute_add.attr,
562 &w1_master_attribute_remove.attr,
563 NULL
564};
565
566static const struct attribute_group w1_master_defattr_group = {
567 .attrs = w1_master_default_attrs,
568};
569
570int w1_create_master_attributes(struct w1_master *master)
571{
572 return sysfs_create_group(&master->dev.kobj, &w1_master_defattr_group);
573}
574
575void w1_destroy_master_attributes(struct w1_master *master)
576{
577 sysfs_remove_group(&master->dev.kobj, &w1_master_defattr_group);
578}
579
580static int w1_uevent(struct device *dev, struct kobj_uevent_env *env)
581{
582 struct w1_master *md = NULL;
583 struct w1_slave *sl = NULL;
584 char *event_owner, *name;
585 int err = 0;
586
587 if (dev->driver == &w1_master_driver) {
588 md = container_of(dev, struct w1_master, dev);
589 event_owner = "master";
590 name = md->name;
591 } else if (dev->driver == &w1_slave_driver) {
592 sl = container_of(dev, struct w1_slave, dev);
593 event_owner = "slave";
594 name = sl->name;
595 } else {
596 dev_dbg(dev, "Unknown event.\n");
597 return -EINVAL;
598 }
599
600 dev_dbg(dev, "Hotplug event for %s %s, bus_id=%s.\n",
601 event_owner, name, dev_name(dev));
602
603 if (dev->driver != &w1_slave_driver || !sl)
604 goto end;
605
606 err = add_uevent_var(env, "W1_FID=%02X", sl->reg_num.family);
607 if (err)
608 goto end;
609
610 err = add_uevent_var(env, "W1_SLAVE_ID=%024LX",
611 (unsigned long long)sl->reg_num.id);
612end:
613 return err;
614}
615
616static int w1_family_notify(unsigned long action, struct w1_slave *sl)
617{
618 const struct w1_family_ops *fops;
619 int err;
620
621 fops = sl->family->fops;
622
623 if (!fops)
624 return 0;
625
626 switch (action) {
627 case BUS_NOTIFY_ADD_DEVICE:
628 /* if the family driver needs to initialize something... */
629 if (fops->add_slave) {
630 err = fops->add_slave(sl);
631 if (err < 0) {
632 dev_err(&sl->dev,
633 "add_slave() call failed. err=%d\n",
634 err);
635 return err;
636 }
637 }
638 if (fops->groups) {
639 err = sysfs_create_groups(&sl->dev.kobj, fops->groups);
640 if (err) {
641 dev_err(&sl->dev,
642 "sysfs group creation failed. err=%d\n",
643 err);
644 return err;
645 }
646 }
647 if (IS_REACHABLE(CONFIG_HWMON) && fops->chip_info) {
648 struct device *hwmon
649 = hwmon_device_register_with_info(&sl->dev,
650 "w1_slave_temp", sl,
651 fops->chip_info,
652 NULL);
653 if (IS_ERR(hwmon)) {
654 dev_warn(&sl->dev,
655 "could not create hwmon device\n");
656 } else {
657 sl->hwmon = hwmon;
658 }
659 }
660 break;
661 case BUS_NOTIFY_DEL_DEVICE:
662 if (IS_REACHABLE(CONFIG_HWMON) && fops->chip_info &&
663 sl->hwmon)
664 hwmon_device_unregister(sl->hwmon);
665 if (fops->remove_slave)
666 sl->family->fops->remove_slave(sl);
667 if (fops->groups)
668 sysfs_remove_groups(&sl->dev.kobj, fops->groups);
669 break;
670 }
671 return 0;
672}
673
674static int __w1_attach_slave_device(struct w1_slave *sl)
675{
676 int err;
677
678 sl->dev.parent = &sl->master->dev;
679 sl->dev.driver = &w1_slave_driver;
680 sl->dev.bus = &w1_bus_type;
681 sl->dev.release = &w1_slave_release;
682 sl->dev.groups = w1_slave_groups;
683 sl->dev.of_node = of_find_matching_node(sl->master->dev.of_node,
684 sl->family->of_match_table);
685
686 dev_set_name(&sl->dev, "%02x-%012llx",
687 (unsigned int) sl->reg_num.family,
688 (unsigned long long) sl->reg_num.id);
689 snprintf(&sl->name[0], sizeof(sl->name),
690 "%02x-%012llx",
691 (unsigned int) sl->reg_num.family,
692 (unsigned long long) sl->reg_num.id);
693
694 dev_dbg(&sl->dev, "%s: registering %s as %p.\n", __func__,
695 dev_name(&sl->dev), sl);
696
697 /* suppress for w1_family_notify before sending KOBJ_ADD */
698 dev_set_uevent_suppress(&sl->dev, true);
699
700 err = device_register(&sl->dev);
701 if (err < 0) {
702 dev_err(&sl->dev,
703 "Device registration [%s] failed. err=%d\n",
704 dev_name(&sl->dev), err);
705 put_device(&sl->dev);
706 return err;
707 }
708 w1_family_notify(BUS_NOTIFY_ADD_DEVICE, sl);
709
710 dev_set_uevent_suppress(&sl->dev, false);
711 kobject_uevent(&sl->dev.kobj, KOBJ_ADD);
712
713 mutex_lock(&sl->master->list_mutex);
714 list_add_tail(&sl->w1_slave_entry, &sl->master->slist);
715 mutex_unlock(&sl->master->list_mutex);
716
717 return 0;
718}
719
720int w1_attach_slave_device(struct w1_master *dev, struct w1_reg_num *rn)
721{
722 struct w1_slave *sl;
723 struct w1_family *f;
724 int err;
725 struct w1_netlink_msg msg;
726
727 sl = kzalloc(sizeof(struct w1_slave), GFP_KERNEL);
728 if (!sl) {
729 dev_err(&dev->dev,
730 "%s: failed to allocate new slave device.\n",
731 __func__);
732 return -ENOMEM;
733 }
734
735
736 sl->owner = THIS_MODULE;
737 sl->master = dev;
738 set_bit(W1_SLAVE_ACTIVE, &sl->flags);
739
740 memset(&msg, 0, sizeof(msg));
741 memcpy(&sl->reg_num, rn, sizeof(sl->reg_num));
742 atomic_set(&sl->refcnt, 1);
743 atomic_inc(&sl->master->refcnt);
744 dev->slave_count++;
745 dev_info(&dev->dev, "Attaching one wire slave %02x.%012llx crc %02x\n",
746 rn->family, (unsigned long long)rn->id, rn->crc);
747
748 /* slave modules need to be loaded in a context with unlocked mutex */
749 mutex_unlock(&dev->mutex);
750 request_module("w1-family-0x%02X", rn->family);
751 mutex_lock(&dev->mutex);
752
753 spin_lock(&w1_flock);
754 f = w1_family_registered(rn->family);
755 if (!f) {
756 f= &w1_default_family;
757 dev_info(&dev->dev, "Family %x for %02x.%012llx.%02x is not registered.\n",
758 rn->family, rn->family,
759 (unsigned long long)rn->id, rn->crc);
760 }
761 __w1_family_get(f);
762 spin_unlock(&w1_flock);
763
764 sl->family = f;
765
766 err = __w1_attach_slave_device(sl);
767 if (err < 0) {
768 dev_err(&dev->dev, "%s: Attaching %s failed.\n", __func__,
769 sl->name);
770 dev->slave_count--;
771 w1_family_put(sl->family);
772 atomic_dec(&sl->master->refcnt);
773 kfree(sl);
774 return err;
775 }
776
777 sl->ttl = dev->slave_ttl;
778
779 memcpy(msg.id.id, rn, sizeof(msg.id));
780 msg.type = W1_SLAVE_ADD;
781 w1_netlink_send(dev, &msg);
782
783 return 0;
784}
785
786int w1_unref_slave(struct w1_slave *sl)
787{
788 struct w1_master *dev = sl->master;
789 int refcnt;
790 mutex_lock(&dev->list_mutex);
791 refcnt = atomic_sub_return(1, &sl->refcnt);
792 if (refcnt == 0) {
793 struct w1_netlink_msg msg;
794
795 dev_dbg(&sl->dev, "%s: detaching %s [%p].\n", __func__,
796 sl->name, sl);
797
798 list_del(&sl->w1_slave_entry);
799
800 memset(&msg, 0, sizeof(msg));
801 memcpy(msg.id.id, &sl->reg_num, sizeof(msg.id));
802 msg.type = W1_SLAVE_REMOVE;
803 w1_netlink_send(sl->master, &msg);
804
805 w1_family_notify(BUS_NOTIFY_DEL_DEVICE, sl);
806 device_unregister(&sl->dev);
807 #ifdef DEBUG
808 memset(sl, 0, sizeof(*sl));
809 #endif
810 kfree(sl);
811 }
812 atomic_dec(&dev->refcnt);
813 mutex_unlock(&dev->list_mutex);
814 return refcnt;
815}
816
817int w1_slave_detach(struct w1_slave *sl)
818{
819 /* Only detach a slave once as it decreases the refcnt each time. */
820 int destroy_now;
821 mutex_lock(&sl->master->list_mutex);
822 destroy_now = !test_bit(W1_SLAVE_DETACH, &sl->flags);
823 set_bit(W1_SLAVE_DETACH, &sl->flags);
824 mutex_unlock(&sl->master->list_mutex);
825
826 if (destroy_now)
827 destroy_now = !w1_unref_slave(sl);
828 return destroy_now ? 0 : -EBUSY;
829}
830
831struct w1_master *w1_search_master_id(u32 id)
832{
833 struct w1_master *dev;
834 int found = 0;
835
836 mutex_lock(&w1_mlock);
837 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
838 if (dev->id == id) {
839 found = 1;
840 atomic_inc(&dev->refcnt);
841 break;
842 }
843 }
844 mutex_unlock(&w1_mlock);
845
846 return (found)?dev:NULL;
847}
848
849struct w1_slave *w1_search_slave(struct w1_reg_num *id)
850{
851 struct w1_master *dev;
852 struct w1_slave *sl = NULL;
853 int found = 0;
854
855 mutex_lock(&w1_mlock);
856 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
857 mutex_lock(&dev->list_mutex);
858 list_for_each_entry(sl, &dev->slist, w1_slave_entry) {
859 if (sl->reg_num.family == id->family &&
860 sl->reg_num.id == id->id &&
861 sl->reg_num.crc == id->crc) {
862 found = 1;
863 atomic_inc(&dev->refcnt);
864 atomic_inc(&sl->refcnt);
865 break;
866 }
867 }
868 mutex_unlock(&dev->list_mutex);
869
870 if (found)
871 break;
872 }
873 mutex_unlock(&w1_mlock);
874
875 return (found)?sl:NULL;
876}
877
878void w1_reconnect_slaves(struct w1_family *f, int attach)
879{
880 struct w1_slave *sl, *sln;
881 struct w1_master *dev;
882
883 mutex_lock(&w1_mlock);
884 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
885 dev_dbg(&dev->dev, "Reconnecting slaves in device %s "
886 "for family %02x.\n", dev->name, f->fid);
887 mutex_lock(&dev->mutex);
888 mutex_lock(&dev->list_mutex);
889 list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
890 /* If it is a new family, slaves with the default
891 * family driver and are that family will be
892 * connected. If the family is going away, devices
893 * matching that family are reconneced.
894 */
895 if ((attach && sl->family->fid == W1_FAMILY_DEFAULT
896 && sl->reg_num.family == f->fid) ||
897 (!attach && sl->family->fid == f->fid)) {
898 struct w1_reg_num rn;
899
900 mutex_unlock(&dev->list_mutex);
901 memcpy(&rn, &sl->reg_num, sizeof(rn));
902 /* If it was already in use let the automatic
903 * scan pick it up again later.
904 */
905 if (!w1_slave_detach(sl))
906 w1_attach_slave_device(dev, &rn);
907 mutex_lock(&dev->list_mutex);
908 }
909 }
910 dev_dbg(&dev->dev, "Reconnecting slaves in device %s "
911 "has been finished.\n", dev->name);
912 mutex_unlock(&dev->list_mutex);
913 mutex_unlock(&dev->mutex);
914 }
915 mutex_unlock(&w1_mlock);
916}
917
918static int w1_addr_crc_is_valid(struct w1_master *dev, u64 rn)
919{
920 u64 rn_le = cpu_to_le64(rn);
921 struct w1_reg_num *tmp = (struct w1_reg_num *)&rn;
922 u8 crc;
923
924 crc = w1_calc_crc8((u8 *)&rn_le, 7);
925
926 /* quirk:
927 * DS28E04 (1w eeprom) has strapping pins to change
928 * address, but will not update the crc. So normal rules
929 * for consistent w1 addresses are violated. We test
930 * with the 7 LSBs of the address forced high.
931 *
932 * (char*)&rn_le = { family, addr_lsb, ..., addr_msb, crc }.
933 */
934 if (crc != tmp->crc && tmp->family == W1_FAMILY_DS28E04) {
935 u64 corr_le = rn_le;
936
937 ((u8 *)&corr_le)[1] |= 0x7f;
938 crc = w1_calc_crc8((u8 *)&corr_le, 7);
939
940 dev_info(&dev->dev, "DS28E04 crc workaround on %02x.%012llx.%02x\n",
941 tmp->family, (unsigned long long)tmp->id, tmp->crc);
942 }
943
944 if (crc != tmp->crc) {
945 dev_dbg(&dev->dev, "w1 addr crc mismatch: %02x.%012llx.%02x != 0x%02x.\n",
946 tmp->family, (unsigned long long)tmp->id, tmp->crc, crc);
947 return 0;
948 }
949 return 1;
950}
951
952void w1_slave_found(struct w1_master *dev, u64 rn)
953{
954 struct w1_slave *sl;
955 struct w1_reg_num *tmp;
956
957 atomic_inc(&dev->refcnt);
958
959 tmp = (struct w1_reg_num *) &rn;
960
961 sl = w1_slave_search_device(dev, tmp);
962 if (sl) {
963 set_bit(W1_SLAVE_ACTIVE, &sl->flags);
964 } else {
965 if (rn && w1_addr_crc_is_valid(dev, rn))
966 w1_attach_slave_device(dev, tmp);
967 }
968
969 atomic_dec(&dev->refcnt);
970}
971
972/**
973 * w1_search() - Performs a ROM Search & registers any devices found.
974 * @dev: The master device to search
975 * @search_type: W1_SEARCH to search all devices, or W1_ALARM_SEARCH
976 * to return only devices in the alarmed state
977 * @cb: Function to call when a device is found
978 *
979 * The 1-wire search is a simple binary tree search.
980 * For each bit of the address, we read two bits and write one bit.
981 * The bit written will put to sleep all devies that don't match that bit.
982 * When the two reads differ, the direction choice is obvious.
983 * When both bits are 0, we must choose a path to take.
984 * When we can scan all 64 bits without having to choose a path, we are done.
985 *
986 * See "Application note 187 1-wire search algorithm" at www.maxim-ic.com
987 *
988 */
989void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb)
990{
991 u64 last_rn, rn, tmp64;
992 int i, slave_count = 0;
993 int last_zero, last_device;
994 int search_bit, desc_bit;
995 u8 triplet_ret = 0;
996
997 search_bit = 0;
998 rn = dev->search_id;
999 last_rn = 0;
1000 last_device = 0;
1001 last_zero = -1;
1002
1003 desc_bit = 64;
1004
1005 while ( !last_device && (slave_count++ < dev->max_slave_count) ) {
1006 last_rn = rn;
1007 rn = 0;
1008
1009 /*
1010 * Reset bus and all 1-wire device state machines
1011 * so they can respond to our requests.
1012 *
1013 * Return 0 - device(s) present, 1 - no devices present.
1014 */
1015 mutex_lock(&dev->bus_mutex);
1016 if (w1_reset_bus(dev)) {
1017 mutex_unlock(&dev->bus_mutex);
1018 dev_dbg(&dev->dev, "No devices present on the wire.\n");
1019 break;
1020 }
1021
1022 /* Do fast search on single slave bus */
1023 if (dev->max_slave_count == 1) {
1024 int rv;
1025 w1_write_8(dev, W1_READ_ROM);
1026 rv = w1_read_block(dev, (u8 *)&rn, 8);
1027 mutex_unlock(&dev->bus_mutex);
1028
1029 if (rv == 8 && rn)
1030 cb(dev, rn);
1031
1032 break;
1033 }
1034
1035 /* Start the search */
1036 w1_write_8(dev, search_type);
1037 for (i = 0; i < 64; ++i) {
1038 /* Determine the direction/search bit */
1039 if (i == desc_bit)
1040 search_bit = 1; /* took the 0 path last time, so take the 1 path */
1041 else if (i > desc_bit)
1042 search_bit = 0; /* take the 0 path on the next branch */
1043 else
1044 search_bit = ((last_rn >> i) & 0x1);
1045
1046 /* Read two bits and write one bit */
1047 triplet_ret = w1_triplet(dev, search_bit);
1048
1049 /* quit if no device responded */
1050 if ( (triplet_ret & 0x03) == 0x03 )
1051 break;
1052
1053 /* If both directions were valid, and we took the 0 path... */
1054 if (triplet_ret == 0)
1055 last_zero = i;
1056
1057 /* extract the direction taken & update the device number */
1058 tmp64 = (triplet_ret >> 2);
1059 rn |= (tmp64 << i);
1060
1061 if (test_bit(W1_ABORT_SEARCH, &dev->flags)) {
1062 mutex_unlock(&dev->bus_mutex);
1063 dev_dbg(&dev->dev, "Abort w1_search\n");
1064 return;
1065 }
1066 }
1067 mutex_unlock(&dev->bus_mutex);
1068
1069 if ( (triplet_ret & 0x03) != 0x03 ) {
1070 if ((desc_bit == last_zero) || (last_zero < 0)) {
1071 last_device = 1;
1072 dev->search_id = 0;
1073 } else {
1074 dev->search_id = rn;
1075 }
1076 desc_bit = last_zero;
1077 cb(dev, rn);
1078 }
1079
1080 if (!last_device && slave_count == dev->max_slave_count &&
1081 !test_bit(W1_WARN_MAX_COUNT, &dev->flags)) {
1082 /* Only max_slave_count will be scanned in a search,
1083 * but it will start where it left off next search
1084 * until all ids are identified and then it will start
1085 * over. A continued search will report the previous
1086 * last id as the first id (provided it is still on the
1087 * bus).
1088 */
1089 dev_info(&dev->dev, "%s: max_slave_count %d reached, "
1090 "will continue next search.\n", __func__,
1091 dev->max_slave_count);
1092 set_bit(W1_WARN_MAX_COUNT, &dev->flags);
1093 }
1094 }
1095}
1096
1097void w1_search_process_cb(struct w1_master *dev, u8 search_type,
1098 w1_slave_found_callback cb)
1099{
1100 struct w1_slave *sl, *sln;
1101
1102 mutex_lock(&dev->list_mutex);
1103 list_for_each_entry(sl, &dev->slist, w1_slave_entry)
1104 clear_bit(W1_SLAVE_ACTIVE, &sl->flags);
1105 mutex_unlock(&dev->list_mutex);
1106
1107 w1_search_devices(dev, search_type, cb);
1108
1109 mutex_lock(&dev->list_mutex);
1110 list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
1111 if (!test_bit(W1_SLAVE_ACTIVE, &sl->flags) && !--sl->ttl) {
1112 mutex_unlock(&dev->list_mutex);
1113 w1_slave_detach(sl);
1114 mutex_lock(&dev->list_mutex);
1115 }
1116 else if (test_bit(W1_SLAVE_ACTIVE, &sl->flags))
1117 sl->ttl = dev->slave_ttl;
1118 }
1119 mutex_unlock(&dev->list_mutex);
1120
1121 if (dev->search_count > 0)
1122 dev->search_count--;
1123}
1124
1125static void w1_search_process(struct w1_master *dev, u8 search_type)
1126{
1127 w1_search_process_cb(dev, search_type, w1_slave_found);
1128}
1129
1130/**
1131 * w1_process_callbacks() - execute each dev->async_list callback entry
1132 * @dev: w1_master device
1133 *
1134 * The w1 master list_mutex must be held.
1135 *
1136 * Return: 1 if there were commands to executed 0 otherwise
1137 */
1138int w1_process_callbacks(struct w1_master *dev)
1139{
1140 int ret = 0;
1141 struct w1_async_cmd *async_cmd, *async_n;
1142
1143 /* The list can be added to in another thread, loop until it is empty */
1144 while (!list_empty(&dev->async_list)) {
1145 list_for_each_entry_safe(async_cmd, async_n, &dev->async_list,
1146 async_entry) {
1147 /* drop the lock, if it is a search it can take a long
1148 * time */
1149 mutex_unlock(&dev->list_mutex);
1150 async_cmd->cb(dev, async_cmd);
1151 ret = 1;
1152 mutex_lock(&dev->list_mutex);
1153 }
1154 }
1155 return ret;
1156}
1157
1158int w1_process(void *data)
1159{
1160 struct w1_master *dev = (struct w1_master *) data;
1161 /* As long as w1_timeout is only set by a module parameter the sleep
1162 * time can be calculated in jiffies once.
1163 */
1164 const unsigned long jtime =
1165 usecs_to_jiffies(w1_timeout * 1000000 + w1_timeout_us);
1166 /* remainder if it woke up early */
1167 unsigned long jremain = 0;
1168
1169 atomic_inc(&dev->refcnt);
1170
1171 for (;;) {
1172
1173 if (!jremain && dev->search_count) {
1174 mutex_lock(&dev->mutex);
1175 w1_search_process(dev, W1_SEARCH);
1176 mutex_unlock(&dev->mutex);
1177 }
1178
1179 mutex_lock(&dev->list_mutex);
1180 /* Note, w1_process_callback drops the lock while processing,
1181 * but locks it again before returning.
1182 */
1183 if (!w1_process_callbacks(dev) && jremain) {
1184 /* a wake up is either to stop the thread, process
1185 * callbacks, or search, it isn't process callbacks, so
1186 * schedule a search.
1187 */
1188 jremain = 1;
1189 }
1190
1191 __set_current_state(TASK_INTERRUPTIBLE);
1192
1193 /* hold list_mutex until after interruptible to prevent loosing
1194 * the wakeup signal when async_cmd is added.
1195 */
1196 mutex_unlock(&dev->list_mutex);
1197
1198 if (kthread_should_stop()) {
1199 __set_current_state(TASK_RUNNING);
1200 break;
1201 }
1202
1203 /* Only sleep when the search is active. */
1204 if (dev->search_count) {
1205 if (!jremain)
1206 jremain = jtime;
1207 jremain = schedule_timeout(jremain);
1208 }
1209 else
1210 schedule();
1211 }
1212
1213 atomic_dec(&dev->refcnt);
1214
1215 return 0;
1216}
1217
1218static int __init w1_init(void)
1219{
1220 int retval;
1221
1222 pr_info("Driver for 1-wire Dallas network protocol.\n");
1223
1224 w1_init_netlink();
1225
1226 retval = bus_register(&w1_bus_type);
1227 if (retval) {
1228 pr_err("Failed to register bus. err=%d.\n", retval);
1229 goto err_out_exit_init;
1230 }
1231
1232 retval = driver_register(&w1_master_driver);
1233 if (retval) {
1234 pr_err("Failed to register master driver. err=%d.\n",
1235 retval);
1236 goto err_out_bus_unregister;
1237 }
1238
1239 retval = driver_register(&w1_slave_driver);
1240 if (retval) {
1241 pr_err("Failed to register slave driver. err=%d.\n",
1242 retval);
1243 goto err_out_master_unregister;
1244 }
1245
1246 return 0;
1247
1248#if 0
1249/* For undoing the slave register if there was a step after it. */
1250err_out_slave_unregister:
1251 driver_unregister(&w1_slave_driver);
1252#endif
1253
1254err_out_master_unregister:
1255 driver_unregister(&w1_master_driver);
1256
1257err_out_bus_unregister:
1258 bus_unregister(&w1_bus_type);
1259
1260err_out_exit_init:
1261 return retval;
1262}
1263
1264static void __exit w1_fini(void)
1265{
1266 struct w1_master *dev;
1267
1268 /* Set netlink removal messages and some cleanup */
1269 list_for_each_entry(dev, &w1_masters, w1_master_entry)
1270 __w1_remove_master_device(dev);
1271
1272 w1_fini_netlink();
1273
1274 driver_unregister(&w1_slave_driver);
1275 driver_unregister(&w1_master_driver);
1276 bus_unregister(&w1_bus_type);
1277}
1278
1279module_init(w1_init);
1280module_exit(w1_fini);
1281
1282MODULE_AUTHOR("Evgeniy Polyakov <zbr@ioremap.net>");
1283MODULE_DESCRIPTION("Driver for 1-wire Dallas network protocol.");
1284MODULE_LICENSE("GPL");