[PATCH] w1: new family structure.
[linux-2.6.git] / drivers / w1 / w1.h
1 /*
2  *      w1.h
3  *
4  * Copyright (c) 2004 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_H
23 #define __W1_H
24
25 struct w1_reg_num
26 {
27 #if defined(__LITTLE_ENDIAN_BITFIELD)
28         __u64   family:8,
29                 id:48,
30                 crc:8;
31 #elif defined(__BIG_ENDIAN_BITFIELD)
32         __u64   crc:8,
33                 id:48,
34                 family:8;
35 #else
36 #error "Please fix <asm/byteorder.h>"
37 #endif
38 };
39
40 #ifdef __KERNEL__
41
42 #include <linux/completion.h>
43 #include <linux/device.h>
44
45 #include <net/sock.h>
46
47 #include <asm/semaphore.h>
48
49 #include "w1_family.h"
50
51 #define W1_MAXNAMELEN           32
52 #define W1_SLAVE_DATA_SIZE      128
53
54 #define W1_SEARCH               0xF0
55 #define W1_CONDITIONAL_SEARCH   0xEC
56 #define W1_CONVERT_TEMP         0x44
57 #define W1_SKIP_ROM             0xCC
58 #define W1_READ_SCRATCHPAD      0xBE
59 #define W1_READ_ROM             0x33
60 #define W1_READ_PSUPPLY         0xB4
61 #define W1_MATCH_ROM            0x55
62
63 #define W1_SLAVE_ACTIVE         (1<<0)
64
65 struct w1_slave
66 {
67         struct module           *owner;
68         unsigned char           name[W1_MAXNAMELEN];
69         struct list_head        w1_slave_entry;
70         struct w1_reg_num       reg_num;
71         atomic_t                refcnt;
72         u8                      rom[9];
73         u32                     flags;
74         int                     ttl;
75
76         struct w1_master        *master;
77         struct w1_family        *family;
78         struct device           dev;
79         struct completion       dev_released;
80
81         struct bin_attribute    attr_bin;
82         struct device_attribute attr_name;
83 };
84
85 typedef void (* w1_slave_found_callback)(unsigned long, u64);
86
87 struct w1_bus_master
88 {
89         unsigned long           data;
90
91         u8                      (*read_bit)(unsigned long);
92         void                    (*write_bit)(unsigned long, u8);
93
94         u8                      (*read_byte)(unsigned long);
95         void                    (*write_byte)(unsigned long, u8);
96
97         u8                      (*read_block)(unsigned long, u8 *, int);
98         void                    (*write_block)(unsigned long, u8 *, int);
99
100         u8                      (*touch_bit)(unsigned long, u8);
101
102         u8                      (*reset_bus)(unsigned long);
103
104         void                    (*search)(unsigned long, w1_slave_found_callback);
105 };
106
107 struct w1_master
108 {
109         struct list_head        w1_master_entry;
110         struct module           *owner;
111         unsigned char           name[W1_MAXNAMELEN];
112         struct list_head        slist;
113         int                     max_slave_count, slave_count;
114         unsigned long           attempts;
115         int                     slave_ttl;
116         int                     initialized;
117         u32                     id;
118
119         atomic_t                refcnt;
120
121         void                    *priv;
122         int                     priv_size;
123
124         int                     need_exit;
125         pid_t                   kpid;
126         struct semaphore        mutex;
127
128         struct device_driver    *driver;
129         struct device           dev;
130         struct completion       dev_released;
131         struct completion       dev_exited;
132
133         struct w1_bus_master    *bus_master;
134
135         u32                     seq, groups;
136         struct sock             *nls;
137 };
138
139 int w1_create_master_attributes(struct w1_master *);
140 void w1_search(struct w1_master *dev);
141
142 #endif /* __KERNEL__ */
143
144 #endif /* __W1_H */