Documentation cleanup: trivial misspelling, punctuation, and grammar corrections.
[linux-2.6] / drivers / w1 / w1_netlink.h
1 /*
2  * w1_netlink.h
3  *
4  * Copyright (c) 2003 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
5  *
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20  */
21
22 #ifndef __W1_NETLINK_H
23 #define __W1_NETLINK_H
24
25 #include <asm/types.h>
26 #include <linux/connector.h>
27
28 #include "w1.h"
29
30 enum w1_netlink_message_types {
31         W1_SLAVE_ADD = 0,
32         W1_SLAVE_REMOVE,
33         W1_MASTER_ADD,
34         W1_MASTER_REMOVE,
35         W1_MASTER_CMD,
36         W1_SLAVE_CMD,
37 };
38
39 struct w1_netlink_msg
40 {
41         __u8                            type;
42         __u8                            reserved;
43         __u16                           len;
44         union {
45                 __u8                    id[8];
46                 struct w1_mst {
47                         __u32           id;
48                         __u32           res;
49                 } mst;
50         } id;
51         __u8                            data[0];
52 };
53
54 #define W1_CMD_READ             0x0
55 #define W1_CMD_WRITE            0x1
56 #define W1_CMD_SEARCH           0x2
57 #define W1_CMD_ALARM_SEARCH     0x3
58
59 struct w1_netlink_cmd
60 {
61         __u8                            cmd;
62         __u8                            res;
63         __u16                           len;
64         __u8                            data[0];
65 };
66
67 #ifdef __KERNEL__
68
69 void w1_netlink_send(struct w1_master *, struct w1_netlink_msg *);
70 int w1_init_netlink(void);
71 void w1_fini_netlink(void);
72
73 #endif /* __KERNEL__ */
74 #endif /* __W1_NETLINK_H */