Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7785925d | 2 | * w1.h |
1da177e4 | 3 | * |
a8018766 | 4 | * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net> |
7785925d | 5 | * |
1da177e4 LT |
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 | ||
b3be177a DF |
25 | /** |
26 | * struct w1_reg_num - broken out slave device id | |
27 | * | |
28 | * @family: identifies the type of device | |
29 | * @id: along with family is the unique device id | |
30 | * @crc: checksum of the other bytes | |
31 | */ | |
1da177e4 LT |
32 | struct w1_reg_num |
33 | { | |
34 | #if defined(__LITTLE_ENDIAN_BITFIELD) | |
6b729861 EP |
35 | __u64 family:8, |
36 | id:48, | |
37 | crc:8; | |
1da177e4 LT |
38 | #elif defined(__BIG_ENDIAN_BITFIELD) |
39 | __u64 crc:8, | |
40 | id:48, | |
41 | family:8; | |
42 | #else | |
43 | #error "Please fix <asm/byteorder.h>" | |
44 | #endif | |
45 | }; | |
46 | ||
47 | #ifdef __KERNEL__ | |
48 | ||
49 | #include <linux/completion.h> | |
50 | #include <linux/device.h> | |
abd52a13 | 51 | #include <linux/mutex.h> |
1da177e4 LT |
52 | |
53 | #include "w1_family.h" | |
54 | ||
55 | #define W1_MAXNAMELEN 32 | |
1da177e4 LT |
56 | |
57 | #define W1_SEARCH 0xF0 | |
12003375 | 58 | #define W1_ALARM_SEARCH 0xEC |
1da177e4 LT |
59 | #define W1_CONVERT_TEMP 0x44 |
60 | #define W1_SKIP_ROM 0xCC | |
0a19f129 BS |
61 | #define W1_COPY_SCRATCHPAD 0x48 |
62 | #define W1_WRITE_SCRATCHPAD 0x4E | |
1da177e4 LT |
63 | #define W1_READ_SCRATCHPAD 0xBE |
64 | #define W1_READ_ROM 0x33 | |
65 | #define W1_READ_PSUPPLY 0xB4 | |
66 | #define W1_MATCH_ROM 0x55 | |
67dfd54c | 67 | #define W1_RESUME_CMD 0xA5 |
1da177e4 | 68 | |
f522d239 | 69 | #define W1_SLAVE_ACTIVE 0 |
9fcbbac5 | 70 | #define W1_SLAVE_DETACH 1 |
1da177e4 | 71 | |
b3be177a DF |
72 | /** |
73 | * struct w1_slave - holds a single slave device on the bus | |
74 | * | |
75 | * @owner: Points to the one wire "wire" kernel module. | |
76 | * @name: Device id is ascii. | |
77 | * @w1_slave_entry: data for the linked list | |
78 | * @reg_num: the slave id in binary | |
79 | * @refcnt: reference count, delete when 0 | |
80 | * @flags: bit flags for W1_SLAVE_ACTIVE W1_SLAVE_DETACH | |
81 | * @ttl: decrement per search this slave isn't found, deatch at 0 | |
82 | * @master: bus which this slave is on | |
83 | * @family: module for device family type | |
84 | * @family_data: pointer for use by the family module | |
85 | * @dev: kernel device identifier | |
86 | * | |
87 | */ | |
1da177e4 LT |
88 | struct w1_slave |
89 | { | |
90 | struct module *owner; | |
91 | unsigned char name[W1_MAXNAMELEN]; | |
92 | struct list_head w1_slave_entry; | |
93 | struct w1_reg_num reg_num; | |
94 | atomic_t refcnt; | |
1da177e4 | 95 | int ttl; |
bb670937 | 96 | unsigned long flags; |
1da177e4 LT |
97 | |
98 | struct w1_master *master; | |
7785925d | 99 | struct w1_family *family; |
a45f105a | 100 | void *family_data; |
7785925d | 101 | struct device dev; |
1da177e4 LT |
102 | }; |
103 | ||
c30c9b15 | 104 | typedef void (*w1_slave_found_callback)(struct w1_master *, u64); |
1da177e4 | 105 | |
6b729861 EP |
106 | |
107 | /** | |
b3be177a DF |
108 | * struct w1_bus_master - operations available on a bus master |
109 | * | |
110 | * @data: the first parameter in all the functions below | |
111 | * | |
112 | * @read_bit: Sample the line level @return the level read (0 or 1) | |
113 | * | |
114 | * @write_bit: Sets the line level | |
115 | * | |
116 | * @touch_bit: the lowest-level function for devices that really support the | |
117 | * 1-wire protocol. | |
118 | * touch_bit(0) = write-0 cycle | |
119 | * touch_bit(1) = write-1 / read cycle | |
120 | * @return the bit read (0 or 1) | |
121 | * | |
122 | * @read_byte: Reads a bytes. Same as 8 touch_bit(1) calls. | |
123 | * @return the byte read | |
124 | * | |
125 | * @write_byte: Writes a byte. Same as 8 touch_bit(x) calls. | |
126 | * | |
127 | * @read_block: Same as a series of read_byte() calls | |
128 | * @return the number of bytes read | |
129 | * | |
130 | * @write_block: Same as a series of write_byte() calls | |
131 | * | |
132 | * @triplet: Combines two reads and a smart write for ROM searches | |
133 | * @return bit0=Id bit1=comp_id bit2=dir_taken | |
134 | * | |
135 | * @reset_bus: long write-0 with a read for the presence pulse detection | |
136 | * @return -1=Error, 0=Device present, 1=No device present | |
137 | * | |
138 | * @set_pullup: Put out a strong pull-up pulse of the specified duration. | |
139 | * @return -1=Error, 0=completed | |
140 | * | |
141 | * @search: Really nice hardware can handles the different types of ROM search | |
142 | * w1_master* is passed to the slave found callback. | |
143 | * u8 is search_type, W1_SEARCH or W1_ALARM_SEARCH | |
144 | * | |
6b729861 EP |
145 | * Note: read_bit and write_bit are very low level functions and should only |
146 | * be used with hardware that doesn't really support 1-wire operations, | |
147 | * like a parallel/serial port. | |
148 | * Either define read_bit and write_bit OR define, at minimum, touch_bit and | |
149 | * reset_bus. | |
b3be177a | 150 | * |
6b729861 | 151 | */ |
1da177e4 LT |
152 | struct w1_bus_master |
153 | { | |
ccd69940 | 154 | void *data; |
6b729861 | 155 | |
ccd69940 | 156 | u8 (*read_bit)(void *); |
6b729861 | 157 | |
ccd69940 | 158 | void (*write_bit)(void *, u8); |
6b729861 | 159 | |
ccd69940 | 160 | u8 (*touch_bit)(void *, u8); |
6b729861 | 161 | |
ccd69940 | 162 | u8 (*read_byte)(void *); |
6b729861 | 163 | |
ccd69940 | 164 | void (*write_byte)(void *, u8); |
6b729861 | 165 | |
ccd69940 | 166 | u8 (*read_block)(void *, u8 *, int); |
6b729861 | 167 | |
ccd69940 | 168 | void (*write_block)(void *, const u8 *, int); |
6b729861 | 169 | |
ccd69940 | 170 | u8 (*triplet)(void *, u8); |
6b729861 | 171 | |
ccd69940 | 172 | u8 (*reset_bus)(void *); |
6b729861 | 173 | |
6a158c0d DF |
174 | u8 (*set_pullup)(void *, int); |
175 | ||
c30c9b15 DF |
176 | void (*search)(void *, struct w1_master *, |
177 | u8, w1_slave_found_callback); | |
1da177e4 LT |
178 | }; |
179 | ||
42105698 DF |
180 | /** |
181 | * enum w1_master_flags - bitfields used in w1_master.flags | |
182 | * @W1_ABORT_SEARCH: abort searching early on shutdown | |
a1613056 | 183 | * @W1_WARN_MAX_COUNT: limit warning when the maximum count is reached |
42105698 DF |
184 | */ |
185 | enum w1_master_flags { | |
186 | W1_ABORT_SEARCH = 0, | |
a1613056 | 187 | W1_WARN_MAX_COUNT = 1, |
42105698 DF |
188 | }; |
189 | ||
b3be177a DF |
190 | /** |
191 | * struct w1_master - one per bus master | |
192 | * @w1_master_entry: master linked list | |
193 | * @owner: module owner | |
194 | * @name: dynamically allocate bus name | |
195 | * @list_mutex: protect slist and async_list | |
196 | * @slist: linked list of slaves | |
197 | * @async_list: linked list of netlink commands to execute | |
198 | * @max_slave_count: maximum number of slaves to search for at a time | |
199 | * @slave_count: current number of slaves known | |
200 | * @attempts: number of searches ran | |
201 | * @slave_ttl: number of searches before a slave is timed out | |
202 | * @initialized: prevent init/removal race conditions | |
203 | * @id: w1 bus number | |
204 | * @search_count: number of automatic searches to run, -1 unlimited | |
205 | * @search_id: allows continuing a search | |
206 | * @refcnt: reference count | |
207 | * @priv: private data storage | |
b3be177a DF |
208 | * @enable_pullup: allows a strong pullup |
209 | * @pullup_duration: time for the next strong pullup | |
210 | * @flags: one of w1_master_flags | |
211 | * @thread: thread for bus search and netlink commands | |
212 | * @mutex: protect most of w1_master | |
213 | * @bus_mutex: pretect concurrent bus access | |
214 | * @driver: sysfs driver | |
215 | * @dev: sysfs device | |
216 | * @bus_master: io operations available | |
217 | * @seq: sequence number used for netlink broadcasts | |
b3be177a | 218 | */ |
1da177e4 LT |
219 | struct w1_master |
220 | { | |
221 | struct list_head w1_master_entry; | |
222 | struct module *owner; | |
223 | unsigned char name[W1_MAXNAMELEN]; | |
9fcbbac5 DF |
224 | /* list_mutex protects just slist and async_list so slaves can be |
225 | * searched for and async commands added while the master has | |
226 | * w1_master.mutex locked and is operating on the bus. | |
b3be177a | 227 | * lock order w1_mlock, w1_master.mutex, w1_master.list_mutex |
9fcbbac5 DF |
228 | */ |
229 | struct mutex list_mutex; | |
1da177e4 | 230 | struct list_head slist; |
9fcbbac5 | 231 | struct list_head async_list; |
1da177e4 LT |
232 | int max_slave_count, slave_count; |
233 | unsigned long attempts; | |
234 | int slave_ttl; | |
235 | int initialized; | |
236 | u32 id; | |
2a9d0c17 | 237 | int search_count; |
3c6955e5 DF |
238 | /* id to start searching on, to continue a search or 0 to restart */ |
239 | u64 search_id; | |
1da177e4 LT |
240 | |
241 | atomic_t refcnt; | |
242 | ||
243 | void *priv; | |
1da177e4 | 244 | |
6a158c0d DF |
245 | /** 5V strong pullup enabled flag, 1 enabled, zero disabled. */ |
246 | int enable_pullup; | |
247 | /** 5V strong pullup duration in milliseconds, zero disabled. */ | |
248 | int pullup_duration; | |
249 | ||
42105698 DF |
250 | long flags; |
251 | ||
674a396c | 252 | struct task_struct *thread; |
abd52a13 | 253 | struct mutex mutex; |
b02f8bed | 254 | struct mutex bus_mutex; |
1da177e4 LT |
255 | |
256 | struct device_driver *driver; | |
7785925d | 257 | struct device dev; |
1da177e4 LT |
258 | |
259 | struct w1_bus_master *bus_master; | |
260 | ||
12003375 | 261 | u32 seq; |
1da177e4 LT |
262 | }; |
263 | ||
9fcbbac5 DF |
264 | /** |
265 | * struct w1_async_cmd - execute callback from the w1_process kthread | |
266 | * @async_entry: link entry | |
267 | * @cb: callback function, must list_del and destroy this list before | |
268 | * returning | |
269 | * | |
270 | * When inserted into the w1_master async_list, w1_process will execute | |
271 | * the callback. Embed this into the structure with the command details. | |
272 | */ | |
273 | struct w1_async_cmd { | |
274 | struct list_head async_entry; | |
275 | void (*cb)(struct w1_master *dev, struct w1_async_cmd *async_cmd); | |
276 | }; | |
277 | ||
1da177e4 | 278 | int w1_create_master_attributes(struct w1_master *); |
c30c9b15 | 279 | void w1_destroy_master_attributes(struct w1_master *master); |
12003375 EP |
280 | void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); |
281 | void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); | |
9fcbbac5 | 282 | /* call w1_unref_slave to release the reference counts w1_search_slave added */ |
12003375 | 283 | struct w1_slave *w1_search_slave(struct w1_reg_num *id); |
9fcbbac5 DF |
284 | /* decrements the reference on sl->master and sl, and cleans up if zero |
285 | * returns the reference count after it has been decremented */ | |
286 | int w1_unref_slave(struct w1_slave *sl); | |
963bb101 DF |
287 | void w1_slave_found(struct w1_master *dev, u64 rn); |
288 | void w1_search_process_cb(struct w1_master *dev, u8 search_type, | |
289 | w1_slave_found_callback cb); | |
70b34d2e DF |
290 | struct w1_slave *w1_slave_search_device(struct w1_master *dev, |
291 | struct w1_reg_num *rn); | |
12003375 EP |
292 | struct w1_master *w1_search_master_id(u32 id); |
293 | ||
c30c9b15 DF |
294 | /* Disconnect and reconnect devices in the given family. Used for finding |
295 | * unclaimed devices after a family has been registered or releasing devices | |
296 | * after a family has been unregistered. Set attach to 1 when a new family | |
297 | * has just been registered, to 0 when it has been unregistered. | |
298 | */ | |
299 | void w1_reconnect_slaves(struct w1_family *f, int attach); | |
70b34d2e | 300 | int w1_attach_slave_device(struct w1_master *dev, struct w1_reg_num *rn); |
9fcbbac5 DF |
301 | /* 0 success, otherwise EBUSY */ |
302 | int w1_slave_detach(struct w1_slave *sl); | |
c30c9b15 | 303 | |
12003375 EP |
304 | u8 w1_triplet(struct w1_master *dev, int bdir); |
305 | void w1_write_8(struct w1_master *, u8); | |
34e453d4 | 306 | u8 w1_read_8(struct w1_master *); |
12003375 EP |
307 | int w1_reset_bus(struct w1_master *); |
308 | u8 w1_calc_crc8(u8 *, int); | |
309 | void w1_write_block(struct w1_master *, const u8 *, int); | |
9be62e0b | 310 | void w1_touch_block(struct w1_master *, u8 *, int); |
12003375 EP |
311 | u8 w1_read_block(struct w1_master *, u8 *, int); |
312 | int w1_reset_select_slave(struct w1_slave *sl); | |
67dfd54c | 313 | int w1_reset_resume_command(struct w1_master *); |
6a158c0d | 314 | void w1_next_pullup(struct w1_master *, int); |
1da177e4 | 315 | |
db2d0008 EP |
316 | static inline struct w1_slave* dev_to_w1_slave(struct device *dev) |
317 | { | |
318 | return container_of(dev, struct w1_slave, dev); | |
319 | } | |
320 | ||
321 | static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj) | |
322 | { | |
323 | return dev_to_w1_slave(container_of(kobj, struct device, kobj)); | |
324 | } | |
325 | ||
326 | static inline struct w1_master* dev_to_w1_master(struct device *dev) | |
327 | { | |
328 | return container_of(dev, struct w1_master, dev); | |
329 | } | |
330 | ||
2c5bfdac | 331 | extern struct device_driver w1_master_driver; |
2c5bfdac EP |
332 | extern struct device w1_master_device; |
333 | extern int w1_max_slave_count; | |
334 | extern int w1_max_slave_ttl; | |
335 | extern struct list_head w1_masters; | |
336 | extern struct mutex w1_mlock; | |
337 | ||
9fcbbac5 | 338 | extern int w1_process_callbacks(struct w1_master *dev); |
2c5bfdac EP |
339 | extern int w1_process(void *); |
340 | ||
1da177e4 LT |
341 | #endif /* __KERNEL__ */ |
342 | ||
343 | #endif /* __W1_H */ |