2 * Copyright (c) 2003 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/slab.h>
16 #include <linux/skbuff.h>
17 #include <linux/netlink.h>
18 #include <linux/connector.h>
22 #include "w1_netlink.h"
24 #if defined(CONFIG_W1_CON) && (defined(CONFIG_CONNECTOR) || (defined(CONFIG_CONNECTOR_MODULE) && defined(CONFIG_W1_MODULE)))
26 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
28 /* Bundle together everything required to process a request in one memory
33 u32 portid
; /* Sending process port ID */
34 /* maximum value for first_cn->len */
36 /* pointers to building up the reply message */
37 struct cn_msg
*first_cn
; /* fixed once the structure is populated */
38 struct cn_msg
*cn
; /* advances as cn_msg is appeneded */
39 struct w1_netlink_msg
*msg
; /* advances as w1_netlink_msg is appened */
40 struct w1_netlink_cmd
*cmd
; /* advances as cmds are appened */
41 struct w1_netlink_msg
*cur_msg
; /* currently message being processed */
42 /* copy of the original request follows */
43 struct cn_msg request_cn
;
44 /* followed by variable length:
45 * cn_msg, data (w1_netlink_msg and w1_netlink_cmd)
46 * one or more struct w1_cb_node
47 * reply first_cn, data (w1_netlink_msg and w1_netlink_cmd)
51 struct w1_async_cmd async
;
52 /* pointers within w1_cb_block and cn data */
53 struct w1_cb_block
*block
;
54 struct w1_netlink_msg
*msg
;
56 struct w1_master
*dev
;
60 * w1_reply_len() - calculate current reply length, compare to maxlen
61 * @block: block to calculate
63 * Calculates the current message length including possible multiple
64 * cn_msg and data, excludes the first sizeof(struct cn_msg). Direclty
65 * compariable to maxlen and usable to send the message.
67 static u16
w1_reply_len(struct w1_cb_block
*block
)
71 return (u8
*)block
->cn
- (u8
*)block
->first_cn
+ block
->cn
->len
;
74 static void w1_unref_block(struct w1_cb_block
*block
)
76 if (atomic_sub_return(1, &block
->refcnt
) == 0) {
77 u16 len
= w1_reply_len(block
);
79 cn_netlink_send_mult(block
->first_cn
, len
,
80 block
->portid
, 0, GFP_KERNEL
);
87 * w1_reply_make_space() - send message if needed to make space
88 * @block: block to make space on
89 * @space: how many bytes requested
91 * Verify there is enough room left for the caller to add "space" bytes to the
92 * message, if there isn't send the message and reset.
94 static void w1_reply_make_space(struct w1_cb_block
*block
, u16 space
)
96 u16 len
= w1_reply_len(block
);
97 if (len
+ space
>= block
->maxlen
) {
98 cn_netlink_send_mult(block
->first_cn
, len
, block
->portid
, 0, GFP_KERNEL
);
99 block
->first_cn
->len
= 0;
106 /* Early send when replies aren't bundled. */
107 static void w1_netlink_check_send(struct w1_cb_block
*block
)
109 if (!(block
->request_cn
.flags
& W1_CN_BUNDLE
) && block
->cn
)
110 w1_reply_make_space(block
, block
->maxlen
);
114 * w1_netlink_setup_msg() - prepare to write block->msg
115 * @block: block to operate on
116 * @ack: determines if cn can be reused
118 * block->cn will be setup with the correct ack, advancing if needed
119 * block->cn->len does not include space for block->msg
120 * block->msg advances but remains uninitialized
122 static void w1_netlink_setup_msg(struct w1_cb_block
*block
, u32 ack
)
124 if (block
->cn
&& block
->cn
->ack
== ack
) {
125 block
->msg
= (struct w1_netlink_msg
*)(block
->cn
->data
+ block
->cn
->len
);
127 /* advance or set to data */
129 block
->cn
= (struct cn_msg
*)(block
->cn
->data
+
132 block
->cn
= block
->first_cn
;
134 memcpy(block
->cn
, &block
->request_cn
, sizeof(*block
->cn
));
136 block
->cn
->ack
= ack
;
137 block
->msg
= (struct w1_netlink_msg
*)block
->cn
->data
;
141 /* Append cmd to msg, include cmd->data as well. This is because
142 * any following data goes with the command and in the case of a read is
145 static void w1_netlink_queue_cmd(struct w1_cb_block
*block
,
146 struct w1_netlink_cmd
*cmd
)
149 w1_reply_make_space(block
, sizeof(struct cn_msg
) +
150 sizeof(struct w1_netlink_msg
) + sizeof(*cmd
) + cmd
->len
);
152 /* There's a status message sent after each command, so no point
153 * in trying to bundle this cmd after an existing one, because
154 * there won't be one. Allocate and copy over a new cn_msg.
156 w1_netlink_setup_msg(block
, block
->request_cn
.seq
+ 1);
157 memcpy(block
->msg
, block
->cur_msg
, sizeof(*block
->msg
));
158 block
->cn
->len
+= sizeof(*block
->msg
);
160 block
->cmd
= (struct w1_netlink_cmd
*)(block
->msg
->data
);
162 space
= sizeof(*cmd
) + cmd
->len
;
163 if (block
->cmd
!= cmd
)
164 memcpy(block
->cmd
, cmd
, space
);
165 block
->cn
->len
+= space
;
166 block
->msg
->len
+= space
;
169 /* Append req_msg and req_cmd, no other commands and no data from req_cmd are
172 static void w1_netlink_queue_status(struct w1_cb_block
*block
,
173 struct w1_netlink_msg
*req_msg
, struct w1_netlink_cmd
*req_cmd
,
176 u16 space
= sizeof(struct cn_msg
) + sizeof(*req_msg
) + sizeof(*req_cmd
);
177 w1_reply_make_space(block
, space
);
178 w1_netlink_setup_msg(block
, block
->request_cn
.ack
);
180 memcpy(block
->msg
, req_msg
, sizeof(*req_msg
));
181 block
->cn
->len
+= sizeof(*req_msg
);
183 block
->msg
->status
= (u8
)-error
;
185 struct w1_netlink_cmd
*cmd
= (struct w1_netlink_cmd
*)block
->msg
->data
;
186 memcpy(cmd
, req_cmd
, sizeof(*cmd
));
187 block
->cn
->len
+= sizeof(*cmd
);
188 block
->msg
->len
+= sizeof(*cmd
);
191 w1_netlink_check_send(block
);
195 * w1_netlink_send_error() - sends the error message now
196 * @cn: original cn_msg
197 * @msg: original w1_netlink_msg
198 * @portid: where to send it
199 * @error: error status
201 * Use when a block isn't available to queue the message to and cn, msg
202 * might not be contiguous.
204 static void w1_netlink_send_error(struct cn_msg
*cn
, struct w1_netlink_msg
*msg
,
205 int portid
, int error
)
209 struct w1_netlink_msg msg
;
211 memcpy(&packet
.cn
, cn
, sizeof(packet
.cn
));
212 memcpy(&packet
.msg
, msg
, sizeof(packet
.msg
));
213 packet
.cn
.len
= sizeof(packet
.msg
);
215 packet
.msg
.status
= (u8
)-error
;
216 cn_netlink_send(&packet
.cn
, portid
, 0, GFP_KERNEL
);
220 * w1_netlink_send() - sends w1 netlink notifications
221 * @dev: w1_master the even is associated with or for
222 * @msg: w1_netlink_msg message to be sent
224 * This are notifications generated from the kernel.
226 void w1_netlink_send(struct w1_master
*dev
, struct w1_netlink_msg
*msg
)
230 struct w1_netlink_msg msg
;
232 memset(&packet
, 0, sizeof(packet
));
234 packet
.cn
.id
.idx
= CN_W1_IDX
;
235 packet
.cn
.id
.val
= CN_W1_VAL
;
237 packet
.cn
.seq
= dev
->seq
++;
238 packet
.cn
.len
= sizeof(*msg
);
240 memcpy(&packet
.msg
, msg
, sizeof(*msg
));
243 cn_netlink_send(&packet
.cn
, 0, 0, GFP_KERNEL
);
246 static void w1_send_slave(struct w1_master
*dev
, u64 rn
)
248 struct w1_cb_block
*block
= dev
->priv
;
249 struct w1_netlink_cmd
*cache_cmd
= block
->cmd
;
252 w1_reply_make_space(block
, sizeof(*data
));
254 /* Add cmd back if the packet was sent */
257 w1_netlink_queue_cmd(block
, cache_cmd
);
260 data
= (u64
*)(block
->cmd
->data
+ block
->cmd
->len
);
263 block
->cn
->len
+= sizeof(*data
);
264 block
->msg
->len
+= sizeof(*data
);
265 block
->cmd
->len
+= sizeof(*data
);
268 static void w1_found_send_slave(struct w1_master
*dev
, u64 rn
)
270 /* update kernel slave list */
271 w1_slave_found(dev
, rn
);
273 w1_send_slave(dev
, rn
);
276 /* Get the current slave list, or search (with or without alarm) */
277 static int w1_get_slaves(struct w1_master
*dev
, struct w1_netlink_cmd
*req_cmd
)
282 w1_netlink_queue_cmd(dev
->priv
, req_cmd
);
284 if (req_cmd
->cmd
== W1_CMD_LIST_SLAVES
) {
286 mutex_lock(&dev
->list_mutex
);
287 list_for_each_entry(sl
, &dev
->slist
, w1_slave_entry
) {
288 memcpy(&rn
, &sl
->reg_num
, sizeof(rn
));
289 w1_send_slave(dev
, rn
);
291 mutex_unlock(&dev
->list_mutex
);
293 w1_search_process_cb(dev
, req_cmd
->cmd
== W1_CMD_ALARM_SEARCH
?
294 W1_ALARM_SEARCH
: W1_SEARCH
, w1_found_send_slave
);
300 static int w1_process_command_io(struct w1_master
*dev
,
301 struct w1_netlink_cmd
*cmd
)
307 w1_touch_block(dev
, cmd
->data
, cmd
->len
);
308 w1_netlink_queue_cmd(dev
->priv
, cmd
);
311 w1_read_block(dev
, cmd
->data
, cmd
->len
);
312 w1_netlink_queue_cmd(dev
->priv
, cmd
);
315 w1_write_block(dev
, cmd
->data
, cmd
->len
);
325 static int w1_process_command_addremove(struct w1_master
*dev
,
326 struct w1_netlink_cmd
*cmd
)
330 struct w1_reg_num
*id
;
332 if (cmd
->len
!= sizeof(*id
))
335 id
= (struct w1_reg_num
*)cmd
->data
;
337 sl
= w1_slave_search_device(dev
, id
);
339 case W1_CMD_SLAVE_ADD
:
343 err
= w1_attach_slave_device(dev
, id
);
345 case W1_CMD_SLAVE_REMOVE
:
359 static int w1_process_command_master(struct w1_master
*dev
,
360 struct w1_netlink_cmd
*req_cmd
)
364 /* drop bus_mutex for search (does it's own locking), and add/remove
365 * which doesn't use the bus
367 switch (req_cmd
->cmd
) {
369 case W1_CMD_ALARM_SEARCH
:
370 case W1_CMD_LIST_SLAVES
:
371 mutex_unlock(&dev
->bus_mutex
);
372 err
= w1_get_slaves(dev
, req_cmd
);
373 mutex_lock(&dev
->bus_mutex
);
378 err
= w1_process_command_io(dev
, req_cmd
);
381 err
= w1_reset_bus(dev
);
383 case W1_CMD_SLAVE_ADD
:
384 case W1_CMD_SLAVE_REMOVE
:
385 mutex_unlock(&dev
->bus_mutex
);
386 mutex_lock(&dev
->mutex
);
387 err
= w1_process_command_addremove(dev
, req_cmd
);
388 mutex_unlock(&dev
->mutex
);
389 mutex_lock(&dev
->bus_mutex
);
399 static int w1_process_command_slave(struct w1_slave
*sl
,
400 struct w1_netlink_cmd
*cmd
)
402 dev_dbg(&sl
->master
->dev
, "%s: %02x.%012llx.%02x: cmd=%02x, len=%u.\n",
403 __func__
, sl
->reg_num
.family
, (unsigned long long)sl
->reg_num
.id
,
404 sl
->reg_num
.crc
, cmd
->cmd
, cmd
->len
);
406 return w1_process_command_io(sl
->master
, cmd
);
409 static int w1_process_command_root(struct cn_msg
*req_cn
, u32 portid
)
411 struct w1_master
*dev
;
413 struct w1_netlink_msg
*msg
;
416 cn
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
420 cn
->id
.idx
= CN_W1_IDX
;
421 cn
->id
.val
= CN_W1_VAL
;
423 cn
->seq
= req_cn
->seq
;
424 cn
->ack
= req_cn
->seq
+ 1;
425 cn
->len
= sizeof(struct w1_netlink_msg
);
426 msg
= (struct w1_netlink_msg
*)cn
->data
;
428 msg
->type
= W1_LIST_MASTERS
;
431 id
= (u32
*)msg
->data
;
433 mutex_lock(&w1_mlock
);
434 list_for_each_entry(dev
, &w1_masters
, w1_master_entry
) {
435 if (cn
->len
+ sizeof(*id
) > PAGE_SIZE
- sizeof(struct cn_msg
)) {
436 cn_netlink_send(cn
, portid
, 0, GFP_KERNEL
);
437 cn
->len
= sizeof(struct w1_netlink_msg
);
439 id
= (u32
*)msg
->data
;
443 msg
->len
+= sizeof(*id
);
444 cn
->len
+= sizeof(*id
);
447 cn_netlink_send(cn
, portid
, 0, GFP_KERNEL
);
448 mutex_unlock(&w1_mlock
);
454 static void w1_process_cb(struct w1_master
*dev
, struct w1_async_cmd
*async_cmd
)
456 struct w1_cb_node
*node
= container_of(async_cmd
, struct w1_cb_node
,
458 u16 mlen
= node
->msg
->len
;
461 struct w1_slave
*sl
= node
->sl
;
462 struct w1_netlink_cmd
*cmd
= (struct w1_netlink_cmd
*)node
->msg
->data
;
464 mutex_lock(&dev
->bus_mutex
);
465 dev
->priv
= node
->block
;
466 if (sl
&& w1_reset_select_slave(sl
))
468 node
->block
->cur_msg
= node
->msg
;
470 while (mlen
&& !err
) {
471 if (cmd
->len
+ sizeof(struct w1_netlink_cmd
) > mlen
) {
477 err
= w1_process_command_slave(sl
, cmd
);
479 err
= w1_process_command_master(dev
, cmd
);
480 w1_netlink_check_send(node
->block
);
482 w1_netlink_queue_status(node
->block
, node
->msg
, cmd
, err
);
485 len
= sizeof(*cmd
) + cmd
->len
;
486 cmd
= (struct w1_netlink_cmd
*)((u8
*)cmd
+ len
);
491 w1_netlink_queue_status(node
->block
, node
->msg
, cmd
, err
);
493 /* ref taken in w1_search_slave or w1_search_master_id when building
499 atomic_dec(&dev
->refcnt
);
501 mutex_unlock(&dev
->bus_mutex
);
503 mutex_lock(&dev
->list_mutex
);
504 list_del(&async_cmd
->async_entry
);
505 mutex_unlock(&dev
->list_mutex
);
507 w1_unref_block(node
->block
);
510 static void w1_list_count_cmds(struct w1_netlink_msg
*msg
, int *cmd_count
,
513 struct w1_netlink_cmd
*cmd
= (struct w1_netlink_cmd
*)msg
->data
;
518 if (cmd
->len
+ sizeof(struct w1_netlink_cmd
) > mlen
)
523 case W1_CMD_ALARM_SEARCH
:
524 case W1_CMD_LIST_SLAVES
:
528 len
= sizeof(*cmd
) + cmd
->len
;
529 cmd
= (struct w1_netlink_cmd
*)((u8
*)cmd
+ len
);
534 struct w1_master
*dev
= w1_search_master_id(msg
->id
.mst
.id
);
536 /* Bytes, and likely an overstimate, and if it isn't
537 * the results can still be split between packets.
539 *slave_len
+= sizeof(struct w1_reg_num
) * slave_list
*
540 (dev
->slave_count
+ dev
->max_slave_count
);
541 /* search incremented it */
542 atomic_dec(&dev
->refcnt
);
547 static void w1_cn_callback(struct cn_msg
*cn
, struct netlink_skb_parms
*nsp
)
549 struct w1_netlink_msg
*msg
= (struct w1_netlink_msg
*)(cn
+ 1);
551 struct w1_master
*dev
;
555 struct w1_cb_block
*block
= NULL
;
556 struct w1_cb_node
*node
= NULL
;
560 /* If any unknown flag is set let the application know, that way
561 * applications can detect the absence of features in kernels that
562 * don't know about them. http://lwn.net/Articles/587527/
564 if (cn
->flags
& ~(W1_CN_BUNDLE
)) {
565 w1_netlink_send_error(cn
, msg
, nsp
->portid
, -EINVAL
);
569 /* Count the number of master or slave commands there are to allocate
570 * space for one cb_node each.
573 while (msg_len
&& !err
) {
574 if (msg
->len
+ sizeof(struct w1_netlink_msg
) > msg_len
) {
579 /* count messages for nodes and allocate any additional space
580 * required for slave lists
582 if (msg
->type
== W1_MASTER_CMD
|| msg
->type
== W1_SLAVE_CMD
) {
584 w1_list_count_cmds(msg
, &cmd_count
, &slave_len
);
587 msg_len
-= sizeof(struct w1_netlink_msg
) + msg
->len
;
588 msg
= (struct w1_netlink_msg
*)(((u8
*)msg
) +
589 sizeof(struct w1_netlink_msg
) + msg
->len
);
591 msg
= (struct w1_netlink_msg
*)(cn
+ 1);
594 int reply_size
= sizeof(*cn
) + cn
->len
+ slave_len
;
595 if (cn
->flags
& W1_CN_BUNDLE
) {
596 /* bundling duplicats some of the messages */
597 reply_size
+= 2 * cmd_count
* (sizeof(struct cn_msg
) +
598 sizeof(struct w1_netlink_msg
) +
599 sizeof(struct w1_netlink_cmd
));
601 reply_size
= MIN(CONNECTOR_MAX_MSG_SIZE
, reply_size
);
603 /* allocate space for the block, a copy of the original message,
604 * one node per cmd to point into the original message,
605 * space for replies which is the original message size plus
606 * space for any list slave data and status messages
607 * cn->len doesn't include itself which is part of the block
609 size
= /* block + original message */
610 sizeof(struct w1_cb_block
) + sizeof(*cn
) + cn
->len
+
611 /* space for nodes */
612 node_count
* sizeof(struct w1_cb_node
) +
614 sizeof(struct cn_msg
) + reply_size
;
615 block
= kzalloc(size
, GFP_KERNEL
);
617 /* if the system is already out of memory,
618 * (A) will this work, and (B) would it be better
621 w1_netlink_send_error(cn
, msg
, nsp
->portid
, -ENOMEM
);
624 atomic_set(&block
->refcnt
, 1);
625 block
->portid
= nsp
->portid
;
626 memcpy(&block
->request_cn
, cn
, sizeof(*cn
) + cn
->len
);
627 node
= (struct w1_cb_node
*)(block
->request_cn
.data
+ cn
->len
);
629 /* Sneeky, when not bundling, reply_size is the allocated space
630 * required for the reply, cn_msg isn't part of maxlen so
631 * it should be reply_size - sizeof(struct cn_msg), however
632 * when checking if there is enough space, w1_reply_make_space
633 * is called with the full message size including cn_msg,
634 * because it isn't known at that time if an additional cn_msg
635 * will need to be allocated. So an extra cn_msg is added
638 block
->maxlen
= reply_size
;
639 block
->first_cn
= (struct cn_msg
*)(node
+ node_count
);
640 memset(block
->first_cn
, 0, sizeof(*block
->first_cn
));
644 while (msg_len
&& !err
) {
649 if (msg
->len
+ sizeof(struct w1_netlink_msg
) > msg_len
) {
654 /* execute on this thread, no need to process later */
655 if (msg
->type
== W1_LIST_MASTERS
) {
656 err
= w1_process_command_root(cn
, nsp
->portid
);
660 /* All following message types require additional data,
661 * check here before references are taken.
668 /* both search calls take references */
669 if (msg
->type
== W1_MASTER_CMD
) {
670 dev
= w1_search_master_id(msg
->id
.mst
.id
);
671 } else if (msg
->type
== W1_SLAVE_CMD
) {
672 sl
= w1_search_slave((struct w1_reg_num
*)msg
->id
.id
);
676 pr_notice("%s: cn: %x.%x, wrong type: %u, len: %u.\n",
677 __func__
, cn
->id
.idx
, cn
->id
.val
,
678 msg
->type
, msg
->len
);
690 atomic_inc(&block
->refcnt
);
691 node
->async
.cb
= w1_process_cb
;
693 node
->msg
= (struct w1_netlink_msg
*)((u8
*)&block
->request_cn
+
694 (size_t)((u8
*)msg
- (u8
*)cn
));
698 mutex_lock(&dev
->list_mutex
);
699 list_add_tail(&node
->async
.async_entry
, &dev
->async_list
);
700 wake_up_process(dev
->thread
);
701 mutex_unlock(&dev
->list_mutex
);
705 /* Can't queue because that modifies block and another
706 * thread could be processing the messages by now and
707 * there isn't a lock, send directly.
710 w1_netlink_send_error(cn
, msg
, nsp
->portid
, err
);
711 msg_len
-= sizeof(struct w1_netlink_msg
) + msg
->len
;
712 msg
= (struct w1_netlink_msg
*)(((u8
*)msg
) +
713 sizeof(struct w1_netlink_msg
) + msg
->len
);
716 * Let's allow requests for nonexisting devices.
722 w1_unref_block(block
);
725 int w1_init_netlink(void)
727 struct cb_id w1_id
= {.idx
= CN_W1_IDX
, .val
= CN_W1_VAL
};
729 return cn_add_callback(&w1_id
, "w1", &w1_cn_callback
);
732 void w1_fini_netlink(void)
734 struct cb_id w1_id
= {.idx
= CN_W1_IDX
, .val
= CN_W1_VAL
};
736 cn_del_callback(&w1_id
);
739 void w1_netlink_send(struct w1_master
*dev
, struct w1_netlink_msg
*cn
)
743 int w1_init_netlink(void)
748 void w1_fini_netlink(void)