drivers/w1/w1_int.c

   1 /*
   2  * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
   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/kernel.h>
  16 #include <linux/list.h>
  17 #include <linux/delay.h>
  18 #include <linux/kthread.h>
  19 #include <linux/slab.h>
  20 #include <linux/sched/signal.h>
  21 #include <linux/export.h>
  22 #include <linux/moduleparam.h>
  23
  24 #include "w1_internal.h"
  25 #include "w1_netlink.h"
  26
  27 static int w1_search_count = -1; /* Default is continual scan */
  28 module_param_named(search_count, w1_search_count, int, 0);
  29
  30 static int w1_enable_pullup = 1;
  31 module_param_named(enable_pullup, w1_enable_pullup, int, 0);
  32
  33 static struct w1_master *w1_alloc_dev(u32 id, int slave_count, int slave_ttl,
  34                                        struct device_driver *driver,
  35                                        struct device *device)
  36 {
  37         struct w1_master *dev;
  38         int err;
  39
  40         /*
  41          * We are in process context(kernel thread), so can sleep.
  42          */
  43         dev = kzalloc(sizeof(struct w1_master) + sizeof(struct w1_bus_master), GFP_KERNEL);
  44         if (!dev) {
  45                 pr_err("Failed to allocate %zd bytes for new w1 device.\n",
  46                         sizeof(struct w1_master));
  47                 return NULL;
  48         }
  49
  50
  51         dev->bus_master = (struct w1_bus_master *)(dev + 1);
  52
  53         dev->owner              = THIS_MODULE;
  54         dev->max_slave_count    = slave_count;
  55         dev->slave_count        = 0;
  56         dev->attempts           = 0;
  57         dev->initialized        = 0;
  58         dev->id                 = id;
  59         dev->slave_ttl          = slave_ttl;
  60         dev->search_count       = w1_search_count;
  61         dev->enable_pullup      = w1_enable_pullup;
  62
  63         /* 1 for w1_process to decrement
  64          * 1 for __w1_remove_master_device to decrement
  65          */
  66         atomic_set(&dev->refcnt, 2);
  67
  68         INIT_LIST_HEAD(&dev->slist);
  69         INIT_LIST_HEAD(&dev->async_list);
  70         mutex_init(&dev->mutex);
  71         mutex_init(&dev->bus_mutex);
  72         mutex_init(&dev->list_mutex);
  73
  74         memcpy(&dev->dev, device, sizeof(struct device));
  75         dev_set_name(&dev->dev, "w1_bus_master%u", dev->id);
  76         snprintf(dev->name, sizeof(dev->name), "w1_bus_master%u", dev->id);
  77         dev->dev.init_name = dev->name;
  78
  79         dev->driver = driver;
  80
  81         dev->seq = 1;
  82
  83         err = device_register(&dev->dev);
  84         if (err) {
  85                 pr_err("Failed to register master device. err=%d\n", err);
  86                 put_device(&dev->dev);
  87                 dev = NULL;
  88         }
  89
  90         return dev;
  91 }
  92
  93 static void w1_free_dev(struct w1_master *dev)
  94 {
  95         device_unregister(&dev->dev);
  96 }
  97
  98 /**
  99  * w1_add_master_device() - registers a new master device
 100  * @master:     master bus device to register
 101  */
 102 int w1_add_master_device(struct w1_bus_master *master)
 103 {
 104         struct w1_master *dev, *entry;
 105         int retval = 0;
 106         struct w1_netlink_msg msg;
 107         int id, found;
 108
 109         /* validate minimum functionality */
 110         if (!(master->touch_bit && master->reset_bus) &&
 111             !(master->write_bit && master->read_bit) &&
 112             !(master->write_byte && master->read_byte && master->reset_bus)) {
 113                 pr_err("w1_add_master_device: invalid function set\n");
 114                 return(-EINVAL);
 115         }
 116
 117         /* bitbanging hardware uses bitbang_pullup, other hardware uses set_pullup
 118          * and takes care of timing itself */
 119         if (!master->write_byte && !master->touch_bit && master->set_pullup) {
 120                 printk(KERN_ERR "w1_add_master_device: set_pullup requires "
 121                         "write_byte or touch_bit, disabling\n");
 122                 master->set_pullup = NULL;
 123         }
 124
 125         if (master->set_pullup && master->bitbang_pullup) {
 126                 printk(KERN_ERR "w1_add_master_device: set_pullup should not "
 127                        "be set when bitbang_pullup is used, disabling\n");
 128                 master->set_pullup = NULL;
 129         }
 130
 131         /* Lock until the device is added (or not) to w1_masters. */
 132         mutex_lock(&w1_mlock);
 133         /* Search for the first available id (starting at 1). */
 134         id = 0;
 135         do {
 136                 ++id;
 137                 found = 0;
 138                 list_for_each_entry(entry, &w1_masters, w1_master_entry) {
 139                         if (entry->id == id) {
 140                                 found = 1;
 141                                 break;
 142                         }
 143                 }
 144         } while (found);
 145
 146         dev = w1_alloc_dev(id, w1_max_slave_count, w1_max_slave_ttl,
 147                 &w1_master_driver, &w1_master_device);
 148         if (!dev) {
 149                 mutex_unlock(&w1_mlock);
 150                 return -ENOMEM;
 151         }
 152
 153         retval =  w1_create_master_attributes(dev);
 154         if (retval) {
 155                 mutex_unlock(&w1_mlock);
 156                 goto err_out_free_dev;
 157         }
 158
 159         memcpy(dev->bus_master, master, sizeof(struct w1_bus_master));
 160
 161         dev->initialized = 1;
 162
 163         dev->thread = kthread_run(&w1_process, dev, "%s", dev->name);
 164         if (IS_ERR(dev->thread)) {
 165                 retval = PTR_ERR(dev->thread);
 166                 dev_err(&dev->dev,
 167                          "Failed to create new kernel thread. err=%d\n",
 168                          retval);
 169                 mutex_unlock(&w1_mlock);
 170                 goto err_out_rm_attr;
 171         }
 172
 173         list_add(&dev->w1_master_entry, &w1_masters);
 174         mutex_unlock(&w1_mlock);
 175
 176         memset(&msg, 0, sizeof(msg));
 177         msg.id.mst.id = dev->id;
 178         msg.type = W1_MASTER_ADD;
 179         w1_netlink_send(dev, &msg);
 180
 181         return 0;
 182
 183 #if 0 /* Thread cleanup code, not required currently. */
 184 err_out_kill_thread:
 185         set_bit(W1_ABORT_SEARCH, &dev->flags);
 186         kthread_stop(dev->thread);
 187 #endif
 188 err_out_rm_attr:
 189         w1_destroy_master_attributes(dev);
 190 err_out_free_dev:
 191         w1_free_dev(dev);
 192
 193         return retval;
 194 }
 195 EXPORT_SYMBOL(w1_add_master_device);
 196
 197 void __w1_remove_master_device(struct w1_master *dev)
 198 {
 199         struct w1_netlink_msg msg;
 200         struct w1_slave *sl, *sln;
 201
 202         mutex_lock(&w1_mlock);
 203         list_del(&dev->w1_master_entry);
 204         mutex_unlock(&w1_mlock);
 205
 206         set_bit(W1_ABORT_SEARCH, &dev->flags);
 207         kthread_stop(dev->thread);
 208
 209         mutex_lock(&dev->mutex);
 210         mutex_lock(&dev->list_mutex);
 211         list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
 212                 mutex_unlock(&dev->list_mutex);
 213                 w1_slave_detach(sl);
 214                 mutex_lock(&dev->list_mutex);
 215         }
 216         w1_destroy_master_attributes(dev);
 217         mutex_unlock(&dev->list_mutex);
 218         mutex_unlock(&dev->mutex);
 219         atomic_dec(&dev->refcnt);
 220
 221         while (atomic_read(&dev->refcnt)) {
 222                 dev_info(&dev->dev, "Waiting for %s to become free: refcnt=%d.\n",
 223                                 dev->name, atomic_read(&dev->refcnt));
 224
 225                 if (msleep_interruptible(1000))
 226                         flush_signals(current);
 227                 mutex_lock(&dev->list_mutex);
 228                 w1_process_callbacks(dev);
 229                 mutex_unlock(&dev->list_mutex);
 230         }
 231         mutex_lock(&dev->list_mutex);
 232         w1_process_callbacks(dev);
 233         mutex_unlock(&dev->list_mutex);
 234
 235         memset(&msg, 0, sizeof(msg));
 236         msg.id.mst.id = dev->id;
 237         msg.type = W1_MASTER_REMOVE;
 238         w1_netlink_send(dev, &msg);
 239
 240         w1_free_dev(dev);
 241 }
 242
 243 /**
 244  * w1_remove_master_device() - unregister a master device
 245  * @bm: master bus device to remove
 246  */
 247 void w1_remove_master_device(struct w1_bus_master *bm)
 248 {
 249         struct w1_master *dev, *found = NULL;
 250
 251         list_for_each_entry(dev, &w1_masters, w1_master_entry) {
 252                 if (!dev->initialized)
 253                         continue;
 254
 255                 if (dev->bus_master->data == bm->data) {
 256                         found = dev;
 257                         break;
 258                 }
 259         }
 260
 261         if (!found) {
 262                 pr_err("Device doesn't exist.\n");
 263                 return;
 264         }
 265
 266         __w1_remove_master_device(found);
 267 }
 268 EXPORT_SYMBOL(w1_remove_master_device);