2 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #include <linux/delay.h>
16 #include <linux/kernel.h>
17 #include <linux/module.h>
18 #include <linux/moduleparam.h>
19 #include <linux/list.h>
20 #include <linux/interrupt.h>
21 #include <linux/spinlock.h>
22 #include <linux/timer.h>
23 #include <linux/device.h>
24 #include <linux/slab.h>
25 #include <linux/sched.h>
26 #include <linux/kthread.h>
27 #include <linux/freezer.h>
28 #include <linux/hwmon.h>
30 #include <linux/atomic.h>
32 #include "w1_internal.h"
33 #include "w1_netlink.h"
35 #define W1_FAMILY_DEFAULT 0
37 static int w1_timeout
= 10;
38 module_param_named(timeout
, w1_timeout
, int, 0);
39 MODULE_PARM_DESC(timeout
, "time in seconds between automatic slave searches");
41 static int w1_timeout_us
= 0;
42 module_param_named(timeout_us
, w1_timeout_us
, int, 0);
43 MODULE_PARM_DESC(timeout_us
,
44 "time in microseconds between automatic slave searches");
46 /* A search stops when w1_max_slave_count devices have been found in that
47 * search. The next search will start over and detect the same set of devices
48 * on a static 1-wire bus. Memory is not allocated based on this number, just
49 * on the number of devices known to the kernel. Having a high number does not
50 * consume additional resources. As a special case, if there is only one
51 * device on the network and w1_max_slave_count is set to 1, the device id can
52 * be read directly skipping the normal slower search process.
54 int w1_max_slave_count
= 64;
55 module_param_named(max_slave_count
, w1_max_slave_count
, int, 0);
56 MODULE_PARM_DESC(max_slave_count
,
57 "maximum number of slaves detected in a search");
59 int w1_max_slave_ttl
= 10;
60 module_param_named(slave_ttl
, w1_max_slave_ttl
, int, 0);
61 MODULE_PARM_DESC(slave_ttl
,
62 "Number of searches not seeing a slave before it will be removed");
64 DEFINE_MUTEX(w1_mlock
);
65 LIST_HEAD(w1_masters
);
67 static int w1_master_match(struct device
*dev
, struct device_driver
*drv
)
72 static int w1_master_probe(struct device
*dev
)
77 static void w1_master_release(struct device
*dev
)
79 struct w1_master
*md
= dev_to_w1_master(dev
);
81 dev_dbg(dev
, "%s: Releasing %s.\n", __func__
, md
->name
);
82 memset(md
, 0, sizeof(struct w1_master
) + sizeof(struct w1_bus_master
));
86 static void w1_slave_release(struct device
*dev
)
88 struct w1_slave
*sl
= dev_to_w1_slave(dev
);
90 dev_dbg(dev
, "%s: Releasing %s [%p]\n", __func__
, sl
->name
, sl
);
92 w1_family_put(sl
->family
);
93 sl
->master
->slave_count
--;
96 static ssize_t
name_show(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
98 struct w1_slave
*sl
= dev_to_w1_slave(dev
);
100 return sprintf(buf
, "%s\n", sl
->name
);
102 static DEVICE_ATTR_RO(name
);
104 static ssize_t
id_show(struct device
*dev
,
105 struct device_attribute
*attr
, char *buf
)
107 struct w1_slave
*sl
= dev_to_w1_slave(dev
);
108 ssize_t count
= sizeof(sl
->reg_num
);
110 memcpy(buf
, (u8
*)&sl
->reg_num
, count
);
113 static DEVICE_ATTR_RO(id
);
115 static struct attribute
*w1_slave_attrs
[] = {
120 ATTRIBUTE_GROUPS(w1_slave
);
124 static ssize_t
rw_write(struct file
*filp
, struct kobject
*kobj
,
125 struct bin_attribute
*bin_attr
, char *buf
, loff_t off
,
128 struct w1_slave
*sl
= kobj_to_w1_slave(kobj
);
130 mutex_lock(&sl
->master
->mutex
);
131 if (w1_reset_select_slave(sl
)) {
136 w1_write_block(sl
->master
, buf
, count
);
139 mutex_unlock(&sl
->master
->mutex
);
143 static ssize_t
rw_read(struct file
*filp
, struct kobject
*kobj
,
144 struct bin_attribute
*bin_attr
, char *buf
, loff_t off
,
147 struct w1_slave
*sl
= kobj_to_w1_slave(kobj
);
149 mutex_lock(&sl
->master
->mutex
);
150 w1_read_block(sl
->master
, buf
, count
);
151 mutex_unlock(&sl
->master
->mutex
);
155 static BIN_ATTR_RW(rw
, PAGE_SIZE
);
157 static struct bin_attribute
*w1_slave_bin_attrs
[] = {
162 static const struct attribute_group w1_slave_default_group
= {
163 .bin_attrs
= w1_slave_bin_attrs
,
166 static const struct attribute_group
*w1_slave_default_groups
[] = {
167 &w1_slave_default_group
,
171 static struct w1_family_ops w1_default_fops
= {
172 .groups
= w1_slave_default_groups
,
175 static struct w1_family w1_default_family
= {
176 .fops
= &w1_default_fops
,
179 static int w1_uevent(struct device
*dev
, struct kobj_uevent_env
*env
);
181 static struct bus_type w1_bus_type
= {
183 .match
= w1_master_match
,
187 struct device_driver w1_master_driver
= {
188 .name
= "w1_master_driver",
190 .probe
= w1_master_probe
,
193 struct device w1_master_device
= {
196 .init_name
= "w1 bus master",
197 .driver
= &w1_master_driver
,
198 .release
= &w1_master_release
201 static struct device_driver w1_slave_driver
= {
202 .name
= "w1_slave_driver",
207 struct device w1_slave_device
= {
210 .init_name
= "w1 bus slave",
211 .driver
= &w1_slave_driver
,
212 .release
= &w1_slave_release
216 static ssize_t
w1_master_attribute_show_name(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
218 struct w1_master
*md
= dev_to_w1_master(dev
);
221 mutex_lock(&md
->mutex
);
222 count
= sprintf(buf
, "%s\n", md
->name
);
223 mutex_unlock(&md
->mutex
);
228 static ssize_t
w1_master_attribute_store_search(struct device
* dev
,
229 struct device_attribute
*attr
,
230 const char * buf
, size_t count
)
233 struct w1_master
*md
= dev_to_w1_master(dev
);
236 ret
= kstrtol(buf
, 0, &tmp
);
240 mutex_lock(&md
->mutex
);
241 md
->search_count
= tmp
;
242 mutex_unlock(&md
->mutex
);
243 /* Only wake if it is going to be searching. */
245 wake_up_process(md
->thread
);
250 static ssize_t
w1_master_attribute_show_search(struct device
*dev
,
251 struct device_attribute
*attr
,
254 struct w1_master
*md
= dev_to_w1_master(dev
);
257 mutex_lock(&md
->mutex
);
258 count
= sprintf(buf
, "%d\n", md
->search_count
);
259 mutex_unlock(&md
->mutex
);
264 static ssize_t
w1_master_attribute_store_pullup(struct device
*dev
,
265 struct device_attribute
*attr
,
266 const char *buf
, size_t count
)
269 struct w1_master
*md
= dev_to_w1_master(dev
);
272 ret
= kstrtol(buf
, 0, &tmp
);
276 mutex_lock(&md
->mutex
);
277 md
->enable_pullup
= tmp
;
278 mutex_unlock(&md
->mutex
);
283 static ssize_t
w1_master_attribute_show_pullup(struct device
*dev
,
284 struct device_attribute
*attr
,
287 struct w1_master
*md
= dev_to_w1_master(dev
);
290 mutex_lock(&md
->mutex
);
291 count
= sprintf(buf
, "%d\n", md
->enable_pullup
);
292 mutex_unlock(&md
->mutex
);
297 static ssize_t
w1_master_attribute_show_pointer(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
299 struct w1_master
*md
= dev_to_w1_master(dev
);
302 mutex_lock(&md
->mutex
);
303 count
= sprintf(buf
, "0x%p\n", md
->bus_master
);
304 mutex_unlock(&md
->mutex
);
308 static ssize_t
w1_master_attribute_show_timeout(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
311 count
= sprintf(buf
, "%d\n", w1_timeout
);
315 static ssize_t
w1_master_attribute_show_timeout_us(struct device
*dev
,
316 struct device_attribute
*attr
, char *buf
)
319 count
= sprintf(buf
, "%d\n", w1_timeout_us
);
323 static ssize_t
w1_master_attribute_store_max_slave_count(struct device
*dev
,
324 struct device_attribute
*attr
, const char *buf
, size_t count
)
327 struct w1_master
*md
= dev_to_w1_master(dev
);
329 if (kstrtoint(buf
, 0, &tmp
) || tmp
< 1)
332 mutex_lock(&md
->mutex
);
333 md
->max_slave_count
= tmp
;
334 /* allow each time the max_slave_count is updated */
335 clear_bit(W1_WARN_MAX_COUNT
, &md
->flags
);
336 mutex_unlock(&md
->mutex
);
341 static ssize_t
w1_master_attribute_show_max_slave_count(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
343 struct w1_master
*md
= dev_to_w1_master(dev
);
346 mutex_lock(&md
->mutex
);
347 count
= sprintf(buf
, "%d\n", md
->max_slave_count
);
348 mutex_unlock(&md
->mutex
);
352 static ssize_t
w1_master_attribute_show_attempts(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
354 struct w1_master
*md
= dev_to_w1_master(dev
);
357 mutex_lock(&md
->mutex
);
358 count
= sprintf(buf
, "%lu\n", md
->attempts
);
359 mutex_unlock(&md
->mutex
);
363 static ssize_t
w1_master_attribute_show_slave_count(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
365 struct w1_master
*md
= dev_to_w1_master(dev
);
368 mutex_lock(&md
->mutex
);
369 count
= sprintf(buf
, "%d\n", md
->slave_count
);
370 mutex_unlock(&md
->mutex
);
374 static ssize_t
w1_master_attribute_show_slaves(struct device
*dev
,
375 struct device_attribute
*attr
, char *buf
)
377 struct w1_master
*md
= dev_to_w1_master(dev
);
379 struct list_head
*ent
, *n
;
380 struct w1_slave
*sl
= NULL
;
382 mutex_lock(&md
->list_mutex
);
384 list_for_each_safe(ent
, n
, &md
->slist
) {
385 sl
= list_entry(ent
, struct w1_slave
, w1_slave_entry
);
387 c
-= snprintf(buf
+ PAGE_SIZE
- c
, c
, "%s\n", sl
->name
);
390 c
-= snprintf(buf
+ PAGE_SIZE
- c
, c
, "not found.\n");
392 mutex_unlock(&md
->list_mutex
);
394 return PAGE_SIZE
- c
;
397 static ssize_t
w1_master_attribute_show_add(struct device
*dev
,
398 struct device_attribute
*attr
, char *buf
)
401 c
-= snprintf(buf
+PAGE_SIZE
- c
, c
,
402 "write device id xx-xxxxxxxxxxxx to add slave\n");
403 return PAGE_SIZE
- c
;
406 static int w1_atoreg_num(struct device
*dev
, const char *buf
, size_t count
,
407 struct w1_reg_num
*rn
)
410 unsigned long long id
;
414 /* The CRC value isn't read from the user because the sysfs directory
415 * doesn't include it and most messages from the bus search don't
416 * print it either. It would be unreasonable for the user to then
419 const char *error_msg
= "bad slave string format, expecting "
423 dev_err(dev
, "%s", error_msg
);
426 i
= sscanf(buf
, "%02x-%012llx", &family
, &id
);
428 dev_err(dev
, "%s", error_msg
);
434 rn64_le
= cpu_to_le64(*(u64
*)rn
);
435 rn
->crc
= w1_calc_crc8((u8
*)&rn64_le
, 7);
438 dev_info(dev
, "With CRC device is %02x.%012llx.%02x.\n",
439 rn
->family
, (unsigned long long)rn
->id
, rn
->crc
);
445 /* Searches the slaves in the w1_master and returns a pointer or NULL.
446 * Note: must not hold list_mutex
448 struct w1_slave
*w1_slave_search_device(struct w1_master
*dev
,
449 struct w1_reg_num
*rn
)
452 mutex_lock(&dev
->list_mutex
);
453 list_for_each_entry(sl
, &dev
->slist
, w1_slave_entry
) {
454 if (sl
->reg_num
.family
== rn
->family
&&
455 sl
->reg_num
.id
== rn
->id
&&
456 sl
->reg_num
.crc
== rn
->crc
) {
457 mutex_unlock(&dev
->list_mutex
);
461 mutex_unlock(&dev
->list_mutex
);
465 static ssize_t
w1_master_attribute_store_add(struct device
*dev
,
466 struct device_attribute
*attr
,
467 const char *buf
, size_t count
)
469 struct w1_master
*md
= dev_to_w1_master(dev
);
470 struct w1_reg_num rn
;
472 ssize_t result
= count
;
474 if (w1_atoreg_num(dev
, buf
, count
, &rn
))
477 mutex_lock(&md
->mutex
);
478 sl
= w1_slave_search_device(md
, &rn
);
479 /* It would be nice to do a targeted search one the one-wire bus
480 * for the new device to see if it is out there or not. But the
481 * current search doesn't support that.
484 dev_info(dev
, "Device %s already exists\n", sl
->name
);
487 w1_attach_slave_device(md
, &rn
);
489 mutex_unlock(&md
->mutex
);
494 static ssize_t
w1_master_attribute_show_remove(struct device
*dev
,
495 struct device_attribute
*attr
, char *buf
)
498 c
-= snprintf(buf
+PAGE_SIZE
- c
, c
,
499 "write device id xx-xxxxxxxxxxxx to remove slave\n");
500 return PAGE_SIZE
- c
;
503 static ssize_t
w1_master_attribute_store_remove(struct device
*dev
,
504 struct device_attribute
*attr
,
505 const char *buf
, size_t count
)
507 struct w1_master
*md
= dev_to_w1_master(dev
);
508 struct w1_reg_num rn
;
510 ssize_t result
= count
;
512 if (w1_atoreg_num(dev
, buf
, count
, &rn
))
515 mutex_lock(&md
->mutex
);
516 sl
= w1_slave_search_device(md
, &rn
);
518 result
= w1_slave_detach(sl
);
519 /* refcnt 0 means it was detached in the call */
523 dev_info(dev
, "Device %02x-%012llx doesn't exists\n", rn
.family
,
524 (unsigned long long)rn
.id
);
527 mutex_unlock(&md
->mutex
);
532 #define W1_MASTER_ATTR_RO(_name, _mode) \
533 struct device_attribute w1_master_attribute_##_name = \
534 __ATTR(w1_master_##_name, _mode, \
535 w1_master_attribute_show_##_name, NULL)
537 #define W1_MASTER_ATTR_RW(_name, _mode) \
538 struct device_attribute w1_master_attribute_##_name = \
539 __ATTR(w1_master_##_name, _mode, \
540 w1_master_attribute_show_##_name, \
541 w1_master_attribute_store_##_name)
543 static W1_MASTER_ATTR_RO(name
, S_IRUGO
);
544 static W1_MASTER_ATTR_RO(slaves
, S_IRUGO
);
545 static W1_MASTER_ATTR_RO(slave_count
, S_IRUGO
);
546 static W1_MASTER_ATTR_RW(max_slave_count
, S_IRUGO
| S_IWUSR
| S_IWGRP
);
547 static W1_MASTER_ATTR_RO(attempts
, S_IRUGO
);
548 static W1_MASTER_ATTR_RO(timeout
, S_IRUGO
);
549 static W1_MASTER_ATTR_RO(timeout_us
, S_IRUGO
);
550 static W1_MASTER_ATTR_RO(pointer
, S_IRUGO
);
551 static W1_MASTER_ATTR_RW(search
, S_IRUGO
| S_IWUSR
| S_IWGRP
);
552 static W1_MASTER_ATTR_RW(pullup
, S_IRUGO
| S_IWUSR
| S_IWGRP
);
553 static W1_MASTER_ATTR_RW(add
, S_IRUGO
| S_IWUSR
| S_IWGRP
);
554 static W1_MASTER_ATTR_RW(remove
, S_IRUGO
| S_IWUSR
| S_IWGRP
);
556 static struct attribute
*w1_master_default_attrs
[] = {
557 &w1_master_attribute_name
.attr
,
558 &w1_master_attribute_slaves
.attr
,
559 &w1_master_attribute_slave_count
.attr
,
560 &w1_master_attribute_max_slave_count
.attr
,
561 &w1_master_attribute_attempts
.attr
,
562 &w1_master_attribute_timeout
.attr
,
563 &w1_master_attribute_timeout_us
.attr
,
564 &w1_master_attribute_pointer
.attr
,
565 &w1_master_attribute_search
.attr
,
566 &w1_master_attribute_pullup
.attr
,
567 &w1_master_attribute_add
.attr
,
568 &w1_master_attribute_remove
.attr
,
572 static const struct attribute_group w1_master_defattr_group
= {
573 .attrs
= w1_master_default_attrs
,
576 int w1_create_master_attributes(struct w1_master
*master
)
578 return sysfs_create_group(&master
->dev
.kobj
, &w1_master_defattr_group
);
581 void w1_destroy_master_attributes(struct w1_master
*master
)
583 sysfs_remove_group(&master
->dev
.kobj
, &w1_master_defattr_group
);
586 static int w1_uevent(struct device
*dev
, struct kobj_uevent_env
*env
)
588 struct w1_master
*md
= NULL
;
589 struct w1_slave
*sl
= NULL
;
590 char *event_owner
, *name
;
593 if (dev
->driver
== &w1_master_driver
) {
594 md
= container_of(dev
, struct w1_master
, dev
);
595 event_owner
= "master";
597 } else if (dev
->driver
== &w1_slave_driver
) {
598 sl
= container_of(dev
, struct w1_slave
, dev
);
599 event_owner
= "slave";
602 dev_dbg(dev
, "Unknown event.\n");
606 dev_dbg(dev
, "Hotplug event for %s %s, bus_id=%s.\n",
607 event_owner
, name
, dev_name(dev
));
609 if (dev
->driver
!= &w1_slave_driver
|| !sl
)
612 err
= add_uevent_var(env
, "W1_FID=%02X", sl
->reg_num
.family
);
616 err
= add_uevent_var(env
, "W1_SLAVE_ID=%024LX",
617 (unsigned long long)sl
->reg_num
.id
);
622 static int w1_family_notify(unsigned long action
, struct w1_slave
*sl
)
624 struct w1_family_ops
*fops
;
627 fops
= sl
->family
->fops
;
633 case BUS_NOTIFY_ADD_DEVICE
:
634 /* if the family driver needs to initialize something... */
635 if (fops
->add_slave
) {
636 err
= fops
->add_slave(sl
);
639 "add_slave() call failed. err=%d\n",
645 err
= sysfs_create_groups(&sl
->dev
.kobj
, fops
->groups
);
648 "sysfs group creation failed. err=%d\n",
653 if (IS_REACHABLE(CONFIG_HWMON
) && fops
->chip_info
) {
655 = hwmon_device_register_with_info(&sl
->dev
,
661 "could not create hwmon device\n");
667 case BUS_NOTIFY_DEL_DEVICE
:
668 if (IS_REACHABLE(CONFIG_HWMON
) && fops
->chip_info
&&
670 hwmon_device_unregister(sl
->hwmon
);
671 if (fops
->remove_slave
)
672 sl
->family
->fops
->remove_slave(sl
);
674 sysfs_remove_groups(&sl
->dev
.kobj
, fops
->groups
);
680 static int __w1_attach_slave_device(struct w1_slave
*sl
)
684 sl
->dev
.parent
= &sl
->master
->dev
;
685 sl
->dev
.driver
= &w1_slave_driver
;
686 sl
->dev
.bus
= &w1_bus_type
;
687 sl
->dev
.release
= &w1_slave_release
;
688 sl
->dev
.groups
= w1_slave_groups
;
690 dev_set_name(&sl
->dev
, "%02x-%012llx",
691 (unsigned int) sl
->reg_num
.family
,
692 (unsigned long long) sl
->reg_num
.id
);
693 snprintf(&sl
->name
[0], sizeof(sl
->name
),
695 (unsigned int) sl
->reg_num
.family
,
696 (unsigned long long) sl
->reg_num
.id
);
698 dev_dbg(&sl
->dev
, "%s: registering %s as %p.\n", __func__
,
699 dev_name(&sl
->dev
), sl
);
701 /* suppress for w1_family_notify before sending KOBJ_ADD */
702 dev_set_uevent_suppress(&sl
->dev
, true);
704 err
= device_register(&sl
->dev
);
707 "Device registration [%s] failed. err=%d\n",
708 dev_name(&sl
->dev
), err
);
709 put_device(&sl
->dev
);
712 w1_family_notify(BUS_NOTIFY_ADD_DEVICE
, sl
);
714 dev_set_uevent_suppress(&sl
->dev
, false);
715 kobject_uevent(&sl
->dev
.kobj
, KOBJ_ADD
);
717 mutex_lock(&sl
->master
->list_mutex
);
718 list_add_tail(&sl
->w1_slave_entry
, &sl
->master
->slist
);
719 mutex_unlock(&sl
->master
->list_mutex
);
724 int w1_attach_slave_device(struct w1_master
*dev
, struct w1_reg_num
*rn
)
729 struct w1_netlink_msg msg
;
731 sl
= kzalloc(sizeof(struct w1_slave
), GFP_KERNEL
);
734 "%s: failed to allocate new slave device.\n",
740 sl
->owner
= THIS_MODULE
;
742 set_bit(W1_SLAVE_ACTIVE
, &sl
->flags
);
744 memset(&msg
, 0, sizeof(msg
));
745 memcpy(&sl
->reg_num
, rn
, sizeof(sl
->reg_num
));
746 atomic_set(&sl
->refcnt
, 1);
747 atomic_inc(&sl
->master
->refcnt
);
749 dev_info(&dev
->dev
, "Attaching one wire slave %02x.%012llx crc %02x\n",
750 rn
->family
, (unsigned long long)rn
->id
, rn
->crc
);
752 /* slave modules need to be loaded in a context with unlocked mutex */
753 mutex_unlock(&dev
->mutex
);
754 request_module("w1-family-0x%02x", rn
->family
);
755 mutex_lock(&dev
->mutex
);
757 spin_lock(&w1_flock
);
758 f
= w1_family_registered(rn
->family
);
760 f
= &w1_default_family
;
761 dev_info(&dev
->dev
, "Family %x for %02x.%012llx.%02x is not registered.\n",
762 rn
->family
, rn
->family
,
763 (unsigned long long)rn
->id
, rn
->crc
);
766 spin_unlock(&w1_flock
);
770 err
= __w1_attach_slave_device(sl
);
772 dev_err(&dev
->dev
, "%s: Attaching %s failed.\n", __func__
,
775 w1_family_put(sl
->family
);
776 atomic_dec(&sl
->master
->refcnt
);
781 sl
->ttl
= dev
->slave_ttl
;
783 memcpy(msg
.id
.id
, rn
, sizeof(msg
.id
));
784 msg
.type
= W1_SLAVE_ADD
;
785 w1_netlink_send(dev
, &msg
);
790 int w1_unref_slave(struct w1_slave
*sl
)
792 struct w1_master
*dev
= sl
->master
;
794 mutex_lock(&dev
->list_mutex
);
795 refcnt
= atomic_sub_return(1, &sl
->refcnt
);
797 struct w1_netlink_msg msg
;
799 dev_dbg(&sl
->dev
, "%s: detaching %s [%p].\n", __func__
,
802 list_del(&sl
->w1_slave_entry
);
804 memset(&msg
, 0, sizeof(msg
));
805 memcpy(msg
.id
.id
, &sl
->reg_num
, sizeof(msg
.id
));
806 msg
.type
= W1_SLAVE_REMOVE
;
807 w1_netlink_send(sl
->master
, &msg
);
809 w1_family_notify(BUS_NOTIFY_DEL_DEVICE
, sl
);
810 device_unregister(&sl
->dev
);
812 memset(sl
, 0, sizeof(*sl
));
816 atomic_dec(&dev
->refcnt
);
817 mutex_unlock(&dev
->list_mutex
);
821 int w1_slave_detach(struct w1_slave
*sl
)
823 /* Only detach a slave once as it decreases the refcnt each time. */
825 mutex_lock(&sl
->master
->list_mutex
);
826 destroy_now
= !test_bit(W1_SLAVE_DETACH
, &sl
->flags
);
827 set_bit(W1_SLAVE_DETACH
, &sl
->flags
);
828 mutex_unlock(&sl
->master
->list_mutex
);
831 destroy_now
= !w1_unref_slave(sl
);
832 return destroy_now
? 0 : -EBUSY
;
835 struct w1_master
*w1_search_master_id(u32 id
)
837 struct w1_master
*dev
;
840 mutex_lock(&w1_mlock
);
841 list_for_each_entry(dev
, &w1_masters
, w1_master_entry
) {
844 atomic_inc(&dev
->refcnt
);
848 mutex_unlock(&w1_mlock
);
850 return (found
)?dev
:NULL
;
853 struct w1_slave
*w1_search_slave(struct w1_reg_num
*id
)
855 struct w1_master
*dev
;
856 struct w1_slave
*sl
= NULL
;
859 mutex_lock(&w1_mlock
);
860 list_for_each_entry(dev
, &w1_masters
, w1_master_entry
) {
861 mutex_lock(&dev
->list_mutex
);
862 list_for_each_entry(sl
, &dev
->slist
, w1_slave_entry
) {
863 if (sl
->reg_num
.family
== id
->family
&&
864 sl
->reg_num
.id
== id
->id
&&
865 sl
->reg_num
.crc
== id
->crc
) {
867 atomic_inc(&dev
->refcnt
);
868 atomic_inc(&sl
->refcnt
);
872 mutex_unlock(&dev
->list_mutex
);
877 mutex_unlock(&w1_mlock
);
879 return (found
)?sl
:NULL
;
882 void w1_reconnect_slaves(struct w1_family
*f
, int attach
)
884 struct w1_slave
*sl
, *sln
;
885 struct w1_master
*dev
;
887 mutex_lock(&w1_mlock
);
888 list_for_each_entry(dev
, &w1_masters
, w1_master_entry
) {
889 dev_dbg(&dev
->dev
, "Reconnecting slaves in device %s "
890 "for family %02x.\n", dev
->name
, f
->fid
);
891 mutex_lock(&dev
->mutex
);
892 mutex_lock(&dev
->list_mutex
);
893 list_for_each_entry_safe(sl
, sln
, &dev
->slist
, w1_slave_entry
) {
894 /* If it is a new family, slaves with the default
895 * family driver and are that family will be
896 * connected. If the family is going away, devices
897 * matching that family are reconneced.
899 if ((attach
&& sl
->family
->fid
== W1_FAMILY_DEFAULT
900 && sl
->reg_num
.family
== f
->fid
) ||
901 (!attach
&& sl
->family
->fid
== f
->fid
)) {
902 struct w1_reg_num rn
;
904 mutex_unlock(&dev
->list_mutex
);
905 memcpy(&rn
, &sl
->reg_num
, sizeof(rn
));
906 /* If it was already in use let the automatic
907 * scan pick it up again later.
909 if (!w1_slave_detach(sl
))
910 w1_attach_slave_device(dev
, &rn
);
911 mutex_lock(&dev
->list_mutex
);
914 dev_dbg(&dev
->dev
, "Reconnecting slaves in device %s "
915 "has been finished.\n", dev
->name
);
916 mutex_unlock(&dev
->list_mutex
);
917 mutex_unlock(&dev
->mutex
);
919 mutex_unlock(&w1_mlock
);
922 void w1_slave_found(struct w1_master
*dev
, u64 rn
)
925 struct w1_reg_num
*tmp
;
926 u64 rn_le
= cpu_to_le64(rn
);
928 atomic_inc(&dev
->refcnt
);
930 tmp
= (struct w1_reg_num
*) &rn
;
932 sl
= w1_slave_search_device(dev
, tmp
);
934 set_bit(W1_SLAVE_ACTIVE
, &sl
->flags
);
936 if (rn
&& tmp
->crc
== w1_calc_crc8((u8
*)&rn_le
, 7))
937 w1_attach_slave_device(dev
, tmp
);
940 atomic_dec(&dev
->refcnt
);
944 * w1_search() - Performs a ROM Search & registers any devices found.
945 * @dev: The master device to search
946 * @search_type: W1_SEARCH to search all devices, or W1_ALARM_SEARCH
947 * to return only devices in the alarmed state
948 * @cb: Function to call when a device is found
950 * The 1-wire search is a simple binary tree search.
951 * For each bit of the address, we read two bits and write one bit.
952 * The bit written will put to sleep all devies that don't match that bit.
953 * When the two reads differ, the direction choice is obvious.
954 * When both bits are 0, we must choose a path to take.
955 * When we can scan all 64 bits without having to choose a path, we are done.
957 * See "Application note 187 1-wire search algorithm" at www.maxim-ic.com
960 void w1_search(struct w1_master
*dev
, u8 search_type
, w1_slave_found_callback cb
)
962 u64 last_rn
, rn
, tmp64
;
963 int i
, slave_count
= 0;
964 int last_zero
, last_device
;
965 int search_bit
, desc_bit
;
976 while ( !last_device
&& (slave_count
++ < dev
->max_slave_count
) ) {
981 * Reset bus and all 1-wire device state machines
982 * so they can respond to our requests.
984 * Return 0 - device(s) present, 1 - no devices present.
986 mutex_lock(&dev
->bus_mutex
);
987 if (w1_reset_bus(dev
)) {
988 mutex_unlock(&dev
->bus_mutex
);
989 dev_dbg(&dev
->dev
, "No devices present on the wire.\n");
993 /* Do fast search on single slave bus */
994 if (dev
->max_slave_count
== 1) {
996 w1_write_8(dev
, W1_READ_ROM
);
997 rv
= w1_read_block(dev
, (u8
*)&rn
, 8);
998 mutex_unlock(&dev
->bus_mutex
);
1006 /* Start the search */
1007 w1_write_8(dev
, search_type
);
1008 for (i
= 0; i
< 64; ++i
) {
1009 /* Determine the direction/search bit */
1011 search_bit
= 1; /* took the 0 path last time, so take the 1 path */
1012 else if (i
> desc_bit
)
1013 search_bit
= 0; /* take the 0 path on the next branch */
1015 search_bit
= ((last_rn
>> i
) & 0x1);
1017 /* Read two bits and write one bit */
1018 triplet_ret
= w1_triplet(dev
, search_bit
);
1020 /* quit if no device responded */
1021 if ( (triplet_ret
& 0x03) == 0x03 )
1024 /* If both directions were valid, and we took the 0 path... */
1025 if (triplet_ret
== 0)
1028 /* extract the direction taken & update the device number */
1029 tmp64
= (triplet_ret
>> 2);
1032 if (test_bit(W1_ABORT_SEARCH
, &dev
->flags
)) {
1033 mutex_unlock(&dev
->bus_mutex
);
1034 dev_dbg(&dev
->dev
, "Abort w1_search\n");
1038 mutex_unlock(&dev
->bus_mutex
);
1040 if ( (triplet_ret
& 0x03) != 0x03 ) {
1041 if ((desc_bit
== last_zero
) || (last_zero
< 0)) {
1045 dev
->search_id
= rn
;
1047 desc_bit
= last_zero
;
1051 if (!last_device
&& slave_count
== dev
->max_slave_count
&&
1052 !test_bit(W1_WARN_MAX_COUNT
, &dev
->flags
)) {
1053 /* Only max_slave_count will be scanned in a search,
1054 * but it will start where it left off next search
1055 * until all ids are identified and then it will start
1056 * over. A continued search will report the previous
1057 * last id as the first id (provided it is still on the
1060 dev_info(&dev
->dev
, "%s: max_slave_count %d reached, "
1061 "will continue next search.\n", __func__
,
1062 dev
->max_slave_count
);
1063 set_bit(W1_WARN_MAX_COUNT
, &dev
->flags
);
1068 void w1_search_process_cb(struct w1_master
*dev
, u8 search_type
,
1069 w1_slave_found_callback cb
)
1071 struct w1_slave
*sl
, *sln
;
1073 mutex_lock(&dev
->list_mutex
);
1074 list_for_each_entry(sl
, &dev
->slist
, w1_slave_entry
)
1075 clear_bit(W1_SLAVE_ACTIVE
, &sl
->flags
);
1076 mutex_unlock(&dev
->list_mutex
);
1078 w1_search_devices(dev
, search_type
, cb
);
1080 mutex_lock(&dev
->list_mutex
);
1081 list_for_each_entry_safe(sl
, sln
, &dev
->slist
, w1_slave_entry
) {
1082 if (!test_bit(W1_SLAVE_ACTIVE
, &sl
->flags
) && !--sl
->ttl
) {
1083 mutex_unlock(&dev
->list_mutex
);
1084 w1_slave_detach(sl
);
1085 mutex_lock(&dev
->list_mutex
);
1087 else if (test_bit(W1_SLAVE_ACTIVE
, &sl
->flags
))
1088 sl
->ttl
= dev
->slave_ttl
;
1090 mutex_unlock(&dev
->list_mutex
);
1092 if (dev
->search_count
> 0)
1093 dev
->search_count
--;
1096 static void w1_search_process(struct w1_master
*dev
, u8 search_type
)
1098 w1_search_process_cb(dev
, search_type
, w1_slave_found
);
1102 * w1_process_callbacks() - execute each dev->async_list callback entry
1103 * @dev: w1_master device
1105 * The w1 master list_mutex must be held.
1107 * Return: 1 if there were commands to executed 0 otherwise
1109 int w1_process_callbacks(struct w1_master
*dev
)
1112 struct w1_async_cmd
*async_cmd
, *async_n
;
1114 /* The list can be added to in another thread, loop until it is empty */
1115 while (!list_empty(&dev
->async_list
)) {
1116 list_for_each_entry_safe(async_cmd
, async_n
, &dev
->async_list
,
1118 /* drop the lock, if it is a search it can take a long
1120 mutex_unlock(&dev
->list_mutex
);
1121 async_cmd
->cb(dev
, async_cmd
);
1123 mutex_lock(&dev
->list_mutex
);
1129 int w1_process(void *data
)
1131 struct w1_master
*dev
= (struct w1_master
*) data
;
1132 /* As long as w1_timeout is only set by a module parameter the sleep
1133 * time can be calculated in jiffies once.
1135 const unsigned long jtime
=
1136 usecs_to_jiffies(w1_timeout
* 1000000 + w1_timeout_us
);
1137 /* remainder if it woke up early */
1138 unsigned long jremain
= 0;
1142 if (!jremain
&& dev
->search_count
) {
1143 mutex_lock(&dev
->mutex
);
1144 w1_search_process(dev
, W1_SEARCH
);
1145 mutex_unlock(&dev
->mutex
);
1148 mutex_lock(&dev
->list_mutex
);
1149 /* Note, w1_process_callback drops the lock while processing,
1150 * but locks it again before returning.
1152 if (!w1_process_callbacks(dev
) && jremain
) {
1153 /* a wake up is either to stop the thread, process
1154 * callbacks, or search, it isn't process callbacks, so
1155 * schedule a search.
1160 __set_current_state(TASK_INTERRUPTIBLE
);
1162 /* hold list_mutex until after interruptible to prevent loosing
1163 * the wakeup signal when async_cmd is added.
1165 mutex_unlock(&dev
->list_mutex
);
1167 if (kthread_should_stop())
1170 /* Only sleep when the search is active. */
1171 if (dev
->search_count
) {
1174 jremain
= schedule_timeout(jremain
);
1180 atomic_dec(&dev
->refcnt
);
1185 static int __init
w1_init(void)
1189 pr_info("Driver for 1-wire Dallas network protocol.\n");
1193 retval
= bus_register(&w1_bus_type
);
1195 pr_err("Failed to register bus. err=%d.\n", retval
);
1196 goto err_out_exit_init
;
1199 retval
= driver_register(&w1_master_driver
);
1201 pr_err("Failed to register master driver. err=%d.\n",
1203 goto err_out_bus_unregister
;
1206 retval
= driver_register(&w1_slave_driver
);
1208 pr_err("Failed to register slave driver. err=%d.\n",
1210 goto err_out_master_unregister
;
1216 /* For undoing the slave register if there was a step after it. */
1217 err_out_slave_unregister
:
1218 driver_unregister(&w1_slave_driver
);
1221 err_out_master_unregister
:
1222 driver_unregister(&w1_master_driver
);
1224 err_out_bus_unregister
:
1225 bus_unregister(&w1_bus_type
);
1231 static void __exit
w1_fini(void)
1233 struct w1_master
*dev
;
1235 /* Set netlink removal messages and some cleanup */
1236 list_for_each_entry(dev
, &w1_masters
, w1_master_entry
)
1237 __w1_remove_master_device(dev
);
1241 driver_unregister(&w1_slave_driver
);
1242 driver_unregister(&w1_master_driver
);
1243 bus_unregister(&w1_bus_type
);
1246 module_init(w1_init
);
1247 module_exit(w1_fini
);
1249 MODULE_AUTHOR("Evgeniy Polyakov <zbr@ioremap.net>");
1250 MODULE_DESCRIPTION("Driver for 1-wire Dallas network protocol.");
1251 MODULE_LICENSE("GPL");