drivers/w1/w1.c

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