blob: 1c776178f598d07724b262b3a43b4f90c1513d9c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Evgeniy Polyakova8018762011-08-25 15:59:06 -07002 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
Evgeniy Polyakov77859252005-05-20 22:33:25 +04003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 */
14
15#include <linux/kernel.h>
16#include <linux/list.h>
17#include <linux/delay.h>
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +030018#include <linux/kthread.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/slab.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010020#include <linux/sched/signal.h>
Paul Gortmaker96239322011-07-10 13:21:52 -040021#include <linux/export.h>
Paul Gortmaker4d184122011-09-15 23:09:52 -040022#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Andrew F. Davisde0d6db2017-06-05 08:52:08 -050024#include "w1_internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include "w1_netlink.h"
26
David Fries9141f572008-10-15 22:04:45 -070027static int w1_search_count = -1; /* Default is continual scan */
28module_param_named(search_count, w1_search_count, int, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
David Fries6a158c02008-10-15 22:04:42 -070030static int w1_enable_pullup = 1;
31module_param_named(enable_pullup, w1_enable_pullup, int, 0);
32
Thomas Wood7242d422014-05-30 16:10:20 -070033static struct w1_master *w1_alloc_dev(u32 id, int slave_count, int slave_ttl,
Evgeniy Polyakov77859252005-05-20 22:33:25 +040034 struct device_driver *driver,
35 struct device *device)
Linus Torvalds1da177e2005-04-16 15:20:36 -070036{
37 struct w1_master *dev;
38 int err;
39
40 /*
41 * We are in process context(kernel thread), so can sleep.
42 */
Yoann Padioleaudd00cc42007-07-19 01:49:03 -070043 dev = kzalloc(sizeof(struct w1_master) + sizeof(struct w1_bus_master), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 if (!dev) {
Fjodor Schelichowfdc91672014-06-19 02:52:00 +020045 pr_err("Failed to allocate %zd bytes for new w1 device.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 sizeof(struct w1_master));
47 return NULL;
48 }
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51 dev->bus_master = (struct w1_bus_master *)(dev + 1);
52
Evgeniy Polyakov77859252005-05-20 22:33:25 +040053 dev->owner = THIS_MODULE;
54 dev->max_slave_count = slave_count;
55 dev->slave_count = 0;
56 dev->attempts = 0;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040057 dev->initialized = 0;
58 dev->id = id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 dev->slave_ttl = slave_ttl;
David Fries9141f572008-10-15 22:04:45 -070060 dev->search_count = w1_search_count;
David Fries6a158c02008-10-15 22:04:42 -070061 dev->enable_pullup = w1_enable_pullup;
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
David Fries01e14d62008-10-15 22:04:40 -070063 /* 1 for w1_process to decrement
64 * 1 for __w1_remove_master_device to decrement
65 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 atomic_set(&dev->refcnt, 2);
67
68 INIT_LIST_HEAD(&dev->slist);
David Fries9fcbbac2014-01-15 22:29:18 -060069 INIT_LIST_HEAD(&dev->async_list);
Evgeniy Polyakovabd52a12006-04-03 12:04:27 +040070 mutex_init(&dev->mutex);
NeilBrownb02f8be2012-05-18 15:59:52 +100071 mutex_init(&dev->bus_mutex);
David Fries9fcbbac2014-01-15 22:29:18 -060072 mutex_init(&dev->list_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 memcpy(&dev->dev, device, sizeof(struct device));
Kay Sievers40f91de2009-01-06 10:44:34 -080075 dev_set_name(&dev->dev, "w1_bus_master%u", dev->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 snprintf(dev->name, sizeof(dev->name), "w1_bus_master%u", dev->id);
Florian Faber68a436a2011-11-02 13:39:59 -070077 dev->dev.init_name = dev->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078
79 dev->driver = driver;
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 dev->seq = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 err = device_register(&dev->dev);
84 if (err) {
Fjodor Schelichowfdc91672014-06-19 02:52:00 +020085 pr_err("Failed to register master device. err=%d\n", err);
Levente Kurusa50524362015-09-14 10:56:12 -070086 put_device(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 dev = NULL;
88 }
89
90 return dev;
91}
92
Evgeniy Polyakov2c5bfda2006-04-04 20:35:22 +040093static void w1_free_dev(struct w1_master *dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094{
95 device_unregister(&dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -070096}
97
David Friesb3be1772014-01-15 22:29:25 -060098/**
99 * w1_add_master_device() - registers a new master device
100 * @master: master bus device to register
101 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102int w1_add_master_device(struct w1_bus_master *master)
103{
David Friesaf00a2d2008-10-15 22:04:53 -0700104 struct w1_master *dev, *entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 int retval = 0;
106 struct w1_netlink_msg msg;
David Friesaf00a2d2008-10-15 22:04:53 -0700107 int id, found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Thomas Wood7242d422014-05-30 16:10:20 -0700109 /* validate minimum functionality */
110 if (!(master->touch_bit && master->reset_bus) &&
111 !(master->write_bit && master->read_bit) &&
Evgeniy Polyakovc1f858b2007-05-08 00:31:20 -0700112 !(master->write_byte && master->read_byte && master->reset_bus)) {
Fjodor Schelichowfdc91672014-06-19 02:52:00 +0200113 pr_err("w1_add_master_device: invalid function set\n");
Evgeniy Polyakov6adf87b2005-06-04 01:29:25 +0400114 return(-EINVAL);
Thomas Wood7242d422014-05-30 16:10:20 -0700115 }
Evgeniy Polyakovbe57ce22005-06-04 01:21:46 +0400116
David Friesaf00a2d2008-10-15 22:04:53 -0700117 /* Lock until the device is added (or not) to w1_masters. */
118 mutex_lock(&w1_mlock);
119 /* Search for the first available id (starting at 1). */
120 id = 0;
121 do {
122 ++id;
123 found = 0;
124 list_for_each_entry(entry, &w1_masters, w1_master_entry) {
125 if (entry->id == id) {
126 found = 1;
127 break;
128 }
129 }
130 } while (found);
131
132 dev = w1_alloc_dev(id, w1_max_slave_count, w1_max_slave_ttl,
133 &w1_master_driver, &w1_master_device);
134 if (!dev) {
135 mutex_unlock(&w1_mlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 return -ENOMEM;
David Friesaf00a2d2008-10-15 22:04:53 -0700137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138
David Fries01e14d62008-10-15 22:04:40 -0700139 retval = w1_create_master_attributes(dev);
David Friesaf00a2d2008-10-15 22:04:53 -0700140 if (retval) {
141 mutex_unlock(&w1_mlock);
David Fries01e14d62008-10-15 22:04:40 -0700142 goto err_out_free_dev;
David Friesaf00a2d2008-10-15 22:04:53 -0700143 }
David Fries01e14d62008-10-15 22:04:40 -0700144
145 memcpy(dev->bus_master, master, sizeof(struct w1_bus_master));
146
147 dev->initialized = 1;
148
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +0300149 dev->thread = kthread_run(&w1_process, dev, "%s", dev->name);
150 if (IS_ERR(dev->thread)) {
151 retval = PTR_ERR(dev->thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 dev_err(&dev->dev,
153 "Failed to create new kernel thread. err=%d\n",
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +0300154 retval);
David Friesaf00a2d2008-10-15 22:04:53 -0700155 mutex_unlock(&w1_mlock);
David Fries01e14d62008-10-15 22:04:40 -0700156 goto err_out_rm_attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
158
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 list_add(&dev->w1_master_entry, &w1_masters);
Evgeniy Polyakovabd52a12006-04-03 12:04:27 +0400160 mutex_unlock(&w1_mlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300162 memset(&msg, 0, sizeof(msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 msg.id.mst.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 msg.type = W1_MASTER_ADD;
165 w1_netlink_send(dev, &msg);
166
167 return 0;
168
David Fries01e14d62008-10-15 22:04:40 -0700169#if 0 /* Thread cleanup code, not required currently. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170err_out_kill_thread:
David Fries42105692014-01-15 22:29:13 -0600171 set_bit(W1_ABORT_SEARCH, &dev->flags);
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +0300172 kthread_stop(dev->thread);
David Fries01e14d62008-10-15 22:04:40 -0700173#endif
174err_out_rm_attr:
175 w1_destroy_master_attributes(dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176err_out_free_dev:
177 w1_free_dev(dev);
178
179 return retval;
180}
Andrew F. Davis50fa2952017-05-16 15:02:12 -0500181EXPORT_SYMBOL(w1_add_master_device);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183void __w1_remove_master_device(struct w1_master *dev)
184{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 struct w1_netlink_msg msg;
David Friesc30c9b12008-10-15 22:04:38 -0700186 struct w1_slave *sl, *sln;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
David Friesc30c9b12008-10-15 22:04:38 -0700188 mutex_lock(&w1_mlock);
189 list_del(&dev->w1_master_entry);
190 mutex_unlock(&w1_mlock);
191
David Fries9fcbbac2014-01-15 22:29:18 -0600192 set_bit(W1_ABORT_SEARCH, &dev->flags);
193 kthread_stop(dev->thread);
194
David Friesc30c9b12008-10-15 22:04:38 -0700195 mutex_lock(&dev->mutex);
David Fries9fcbbac2014-01-15 22:29:18 -0600196 mutex_lock(&dev->list_mutex);
197 list_for_each_entry_safe(sl, sln, &dev->slist, w1_slave_entry) {
198 mutex_unlock(&dev->list_mutex);
David Friesc30c9b12008-10-15 22:04:38 -0700199 w1_slave_detach(sl);
David Fries9fcbbac2014-01-15 22:29:18 -0600200 mutex_lock(&dev->list_mutex);
201 }
David Friesc30c9b12008-10-15 22:04:38 -0700202 w1_destroy_master_attributes(dev);
David Fries9fcbbac2014-01-15 22:29:18 -0600203 mutex_unlock(&dev->list_mutex);
David Friesc30c9b12008-10-15 22:04:38 -0700204 mutex_unlock(&dev->mutex);
205 atomic_dec(&dev->refcnt);
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 while (atomic_read(&dev->refcnt)) {
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +0300208 dev_info(&dev->dev, "Waiting for %s to become free: refcnt=%d.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 dev->name, atomic_read(&dev->refcnt));
210
211 if (msleep_interruptible(1000))
212 flush_signals(current);
Alexey Khoroshilova0f10462014-05-07 01:26:04 +0400213 mutex_lock(&dev->list_mutex);
David Fries9fcbbac2014-01-15 22:29:18 -0600214 w1_process_callbacks(dev);
Alexey Khoroshilova0f10462014-05-07 01:26:04 +0400215 mutex_unlock(&dev->list_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 }
Alexey Khoroshilova0f10462014-05-07 01:26:04 +0400217 mutex_lock(&dev->list_mutex);
David Fries9fcbbac2014-01-15 22:29:18 -0600218 w1_process_callbacks(dev);
Alexey Khoroshilova0f10462014-05-07 01:26:04 +0400219 mutex_unlock(&dev->list_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300221 memset(&msg, 0, sizeof(msg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 msg.id.mst.id = dev->id;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 msg.type = W1_MASTER_REMOVE;
224 w1_netlink_send(dev, &msg);
225
226 w1_free_dev(dev);
227}
228
David Friesb3be1772014-01-15 22:29:25 -0600229/**
230 * w1_remove_master_device() - unregister a master device
231 * @bm: master bus device to remove
232 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233void w1_remove_master_device(struct w1_bus_master *bm)
234{
Evgeniy Polyakov59d94452007-08-22 14:01:51 -0700235 struct w1_master *dev, *found = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400237 list_for_each_entry(dev, &w1_masters, w1_master_entry) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 if (!dev->initialized)
239 continue;
240
Evgeniy Polyakov59d94452007-08-22 14:01:51 -0700241 if (dev->bus_master->data == bm->data) {
242 found = dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 break;
Evgeniy Polyakov59d94452007-08-22 14:01:51 -0700244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 }
246
Evgeniy Polyakov59d94452007-08-22 14:01:51 -0700247 if (!found) {
Fjodor Schelichowfdc91672014-06-19 02:52:00 +0200248 pr_err("Device doesn't exist.\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 return;
250 }
251
Evgeniy Polyakov59d94452007-08-22 14:01:51 -0700252 __w1_remove_master_device(found);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254EXPORT_SYMBOL(w1_remove_master_device);