Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7785925d | 2 | * w1.h |
1da177e4 LT |
3 | * |
4 | * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru> | |
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 | ||
25 | struct w1_reg_num | |
26 | { | |
27 | #if defined(__LITTLE_ENDIAN_BITFIELD) | |
6b729861 EP |
28 | __u64 family:8, |
29 | id:48, | |
30 | crc:8; | |
1da177e4 LT |
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 | ||
1da177e4 LT |
45 | #include <asm/semaphore.h> |
46 | ||
47 | #include "w1_family.h" | |
48 | ||
49 | #define W1_MAXNAMELEN 32 | |
50 | #define W1_SLAVE_DATA_SIZE 128 | |
51 | ||
52 | #define W1_SEARCH 0xF0 | |
12003375 | 53 | #define W1_ALARM_SEARCH 0xEC |
1da177e4 LT |
54 | #define W1_CONVERT_TEMP 0x44 |
55 | #define W1_SKIP_ROM 0xCC | |
56 | #define W1_READ_SCRATCHPAD 0xBE | |
57 | #define W1_READ_ROM 0x33 | |
58 | #define W1_READ_PSUPPLY 0xB4 | |
59 | #define W1_MATCH_ROM 0x55 | |
60 | ||
f522d239 | 61 | #define W1_SLAVE_ACTIVE 0 |
1da177e4 LT |
62 | |
63 | struct w1_slave | |
64 | { | |
65 | struct module *owner; | |
66 | unsigned char name[W1_MAXNAMELEN]; | |
67 | struct list_head w1_slave_entry; | |
68 | struct w1_reg_num reg_num; | |
69 | atomic_t refcnt; | |
70 | u8 rom[9]; | |
71 | u32 flags; | |
72 | int ttl; | |
73 | ||
74 | struct w1_master *master; | |
7785925d | 75 | struct w1_family *family; |
a45f105a | 76 | void *family_data; |
7785925d | 77 | struct device dev; |
3aca692d | 78 | struct completion released; |
1da177e4 LT |
79 | }; |
80 | ||
ccd69940 | 81 | typedef void (* w1_slave_found_callback)(void *, u64); |
1da177e4 | 82 | |
6b729861 EP |
83 | |
84 | /** | |
85 | * Note: read_bit and write_bit are very low level functions and should only | |
86 | * be used with hardware that doesn't really support 1-wire operations, | |
87 | * like a parallel/serial port. | |
88 | * Either define read_bit and write_bit OR define, at minimum, touch_bit and | |
89 | * reset_bus. | |
90 | */ | |
1da177e4 LT |
91 | struct w1_bus_master |
92 | { | |
6b729861 | 93 | /** the first parameter in all the functions below */ |
ccd69940 | 94 | void *data; |
6b729861 EP |
95 | |
96 | /** | |
97 | * Sample the line level | |
98 | * @return the level read (0 or 1) | |
99 | */ | |
ccd69940 | 100 | u8 (*read_bit)(void *); |
6b729861 EP |
101 | |
102 | /** Sets the line level */ | |
ccd69940 | 103 | void (*write_bit)(void *, u8); |
6b729861 EP |
104 | |
105 | /** | |
106 | * touch_bit is the lowest-level function for devices that really | |
107 | * support the 1-wire protocol. | |
108 | * touch_bit(0) = write-0 cycle | |
109 | * touch_bit(1) = write-1 / read cycle | |
110 | * @return the bit read (0 or 1) | |
111 | */ | |
ccd69940 | 112 | u8 (*touch_bit)(void *, u8); |
6b729861 EP |
113 | |
114 | /** | |
115 | * Reads a bytes. Same as 8 touch_bit(1) calls. | |
116 | * @return the byte read | |
117 | */ | |
ccd69940 | 118 | u8 (*read_byte)(void *); |
6b729861 EP |
119 | |
120 | /** | |
121 | * Writes a byte. Same as 8 touch_bit(x) calls. | |
122 | */ | |
ccd69940 | 123 | void (*write_byte)(void *, u8); |
6b729861 EP |
124 | |
125 | /** | |
126 | * Same as a series of read_byte() calls | |
127 | * @return the number of bytes read | |
128 | */ | |
ccd69940 | 129 | u8 (*read_block)(void *, u8 *, int); |
6b729861 EP |
130 | |
131 | /** Same as a series of write_byte() calls */ | |
ccd69940 | 132 | void (*write_block)(void *, const u8 *, int); |
6b729861 EP |
133 | |
134 | /** | |
135 | * Combines two reads and a smart write for ROM searches | |
136 | * @return bit0=Id bit1=comp_id bit2=dir_taken | |
137 | */ | |
ccd69940 | 138 | u8 (*triplet)(void *, u8); |
6b729861 EP |
139 | |
140 | /** | |
141 | * long write-0 with a read for the presence pulse detection | |
142 | * @return -1=Error, 0=Device present, 1=No device present | |
143 | */ | |
ccd69940 | 144 | u8 (*reset_bus)(void *); |
6b729861 | 145 | |
12003375 EP |
146 | /** Really nice hardware can handles the different types of ROM search */ |
147 | void (*search)(void *, u8, w1_slave_found_callback); | |
1da177e4 LT |
148 | }; |
149 | ||
6adf87bd EP |
150 | #define W1_MASTER_NEED_EXIT 0 |
151 | #define W1_MASTER_NEED_RECONNECT 1 | |
152 | ||
1da177e4 LT |
153 | struct w1_master |
154 | { | |
155 | struct list_head w1_master_entry; | |
156 | struct module *owner; | |
157 | unsigned char name[W1_MAXNAMELEN]; | |
158 | struct list_head slist; | |
159 | int max_slave_count, slave_count; | |
160 | unsigned long attempts; | |
161 | int slave_ttl; | |
162 | int initialized; | |
163 | u32 id; | |
2a9d0c17 | 164 | int search_count; |
1da177e4 LT |
165 | |
166 | atomic_t refcnt; | |
167 | ||
168 | void *priv; | |
169 | int priv_size; | |
170 | ||
6adf87bd EP |
171 | long flags; |
172 | ||
674a396c | 173 | struct task_struct *thread; |
7785925d | 174 | struct semaphore mutex; |
1da177e4 LT |
175 | |
176 | struct device_driver *driver; | |
7785925d | 177 | struct device dev; |
1da177e4 LT |
178 | |
179 | struct w1_bus_master *bus_master; | |
180 | ||
12003375 | 181 | u32 seq; |
1da177e4 LT |
182 | }; |
183 | ||
184 | int w1_create_master_attributes(struct w1_master *); | |
12003375 EP |
185 | void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); |
186 | void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); | |
187 | struct w1_slave *w1_search_slave(struct w1_reg_num *id); | |
188 | void w1_search_process(struct w1_master *dev, u8 search_type); | |
189 | struct w1_master *w1_search_master_id(u32 id); | |
190 | ||
191 | void w1_delay(unsigned long); | |
192 | u8 w1_touch_bit(struct w1_master *, int); | |
193 | u8 w1_triplet(struct w1_master *dev, int bdir); | |
194 | void w1_write_8(struct w1_master *, u8); | |
195 | u8 w1_read_8(struct w1_master *); | |
196 | int w1_reset_bus(struct w1_master *); | |
197 | u8 w1_calc_crc8(u8 *, int); | |
198 | void w1_write_block(struct w1_master *, const u8 *, int); | |
199 | u8 w1_read_block(struct w1_master *, u8 *, int); | |
200 | int w1_reset_select_slave(struct w1_slave *sl); | |
1da177e4 | 201 | |
db2d0008 EP |
202 | static inline struct w1_slave* dev_to_w1_slave(struct device *dev) |
203 | { | |
204 | return container_of(dev, struct w1_slave, dev); | |
205 | } | |
206 | ||
207 | static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj) | |
208 | { | |
209 | return dev_to_w1_slave(container_of(kobj, struct device, kobj)); | |
210 | } | |
211 | ||
212 | static inline struct w1_master* dev_to_w1_master(struct device *dev) | |
213 | { | |
214 | return container_of(dev, struct w1_master, dev); | |
215 | } | |
216 | ||
1da177e4 LT |
217 | #endif /* __KERNEL__ */ |
218 | ||
219 | #endif /* __W1_H */ |