Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 2 | * w1.h |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | * |
| 4 | * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru> |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 5 | * |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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) |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 28 | __u64 family:8, |
| 29 | id:48, |
| 30 | crc:8; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
Evgeniy Polyakov | abd52a1 | 2006-04-03 12:04:27 +0400 | [diff] [blame] | 44 | #include <linux/mutex.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | |
| 46 | #include "w1_family.h" |
| 47 | |
| 48 | #define W1_MAXNAMELEN 32 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | |
| 50 | #define W1_SEARCH 0xF0 |
Evgeniy Polyakov | 1200337 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 51 | #define W1_ALARM_SEARCH 0xEC |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | #define W1_CONVERT_TEMP 0x44 |
| 53 | #define W1_SKIP_ROM 0xCC |
| 54 | #define W1_READ_SCRATCHPAD 0xBE |
| 55 | #define W1_READ_ROM 0x33 |
| 56 | #define W1_READ_PSUPPLY 0xB4 |
| 57 | #define W1_MATCH_ROM 0x55 |
| 58 | |
Evgeniy Polyakov | f522d23 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 59 | #define W1_SLAVE_ACTIVE 0 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 60 | |
| 61 | struct w1_slave |
| 62 | { |
| 63 | struct module *owner; |
| 64 | unsigned char name[W1_MAXNAMELEN]; |
| 65 | struct list_head w1_slave_entry; |
| 66 | struct w1_reg_num reg_num; |
| 67 | atomic_t refcnt; |
| 68 | u8 rom[9]; |
| 69 | u32 flags; |
| 70 | int ttl; |
| 71 | |
| 72 | struct w1_master *master; |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 73 | struct w1_family *family; |
Evgeniy Polyakov | a45f105 | 2005-08-17 15:19:08 +0400 | [diff] [blame] | 74 | void *family_data; |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 75 | struct device dev; |
Evgeniy Polyakov | 3aca692 | 2005-08-11 17:27:50 +0400 | [diff] [blame] | 76 | struct completion released; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 77 | }; |
| 78 | |
David Fries | c30c9b1 | 2008-10-15 22:04:38 -0700 | [diff] [blame] | 79 | typedef void (*w1_slave_found_callback)(struct w1_master *, u64); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 80 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 81 | |
| 82 | /** |
| 83 | * Note: read_bit and write_bit are very low level functions and should only |
| 84 | * be used with hardware that doesn't really support 1-wire operations, |
| 85 | * like a parallel/serial port. |
| 86 | * Either define read_bit and write_bit OR define, at minimum, touch_bit and |
| 87 | * reset_bus. |
| 88 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | struct w1_bus_master |
| 90 | { |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 91 | /** the first parameter in all the functions below */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 92 | void *data; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 94 | /** |
| 95 | * Sample the line level |
| 96 | * @return the level read (0 or 1) |
| 97 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 98 | u8 (*read_bit)(void *); |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 99 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 100 | /** Sets the line level */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 101 | void (*write_bit)(void *, u8); |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 102 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 103 | /** |
| 104 | * touch_bit is the lowest-level function for devices that really |
| 105 | * support the 1-wire protocol. |
| 106 | * touch_bit(0) = write-0 cycle |
| 107 | * touch_bit(1) = write-1 / read cycle |
| 108 | * @return the bit read (0 or 1) |
| 109 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 110 | u8 (*touch_bit)(void *, u8); |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 111 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 112 | /** |
| 113 | * Reads a bytes. Same as 8 touch_bit(1) calls. |
| 114 | * @return the byte read |
| 115 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 116 | u8 (*read_byte)(void *); |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 117 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 118 | /** |
| 119 | * Writes a byte. Same as 8 touch_bit(x) calls. |
| 120 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 121 | void (*write_byte)(void *, u8); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 122 | |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 123 | /** |
| 124 | * Same as a series of read_byte() calls |
| 125 | * @return the number of bytes read |
| 126 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 127 | u8 (*read_block)(void *, u8 *, int); |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 128 | |
| 129 | /** Same as a series of write_byte() calls */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 130 | void (*write_block)(void *, const u8 *, int); |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 131 | |
| 132 | /** |
| 133 | * Combines two reads and a smart write for ROM searches |
| 134 | * @return bit0=Id bit1=comp_id bit2=dir_taken |
| 135 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 136 | u8 (*triplet)(void *, u8); |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 137 | |
| 138 | /** |
| 139 | * long write-0 with a read for the presence pulse detection |
| 140 | * @return -1=Error, 0=Device present, 1=No device present |
| 141 | */ |
Evgeniy Polyakov | ccd6994 | 2005-12-06 13:38:27 +0300 | [diff] [blame] | 142 | u8 (*reset_bus)(void *); |
Evgeniy Polyakov | 6b72986 | 2005-06-04 01:30:43 +0400 | [diff] [blame] | 143 | |
David Fries | 6a158c0 | 2008-10-15 22:04:42 -0700 | [diff] [blame] | 144 | /** |
| 145 | * Put out a strong pull-up pulse of the specified duration. |
| 146 | * @return -1=Error, 0=completed |
| 147 | */ |
| 148 | u8 (*set_pullup)(void *, int); |
| 149 | |
David Fries | c30c9b1 | 2008-10-15 22:04:38 -0700 | [diff] [blame] | 150 | /** Really nice hardware can handles the different types of ROM search |
| 151 | * w1_master* is passed to the slave found callback. |
| 152 | */ |
| 153 | void (*search)(void *, struct w1_master *, |
| 154 | u8, w1_slave_found_callback); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 155 | }; |
| 156 | |
| 157 | struct w1_master |
| 158 | { |
| 159 | struct list_head w1_master_entry; |
| 160 | struct module *owner; |
| 161 | unsigned char name[W1_MAXNAMELEN]; |
| 162 | struct list_head slist; |
| 163 | int max_slave_count, slave_count; |
| 164 | unsigned long attempts; |
| 165 | int slave_ttl; |
| 166 | int initialized; |
| 167 | u32 id; |
Evgeniy Polyakov | 2a9d0c1 | 2005-06-04 01:31:02 +0400 | [diff] [blame] | 168 | int search_count; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 169 | |
| 170 | atomic_t refcnt; |
| 171 | |
| 172 | void *priv; |
| 173 | int priv_size; |
| 174 | |
David Fries | 6a158c0 | 2008-10-15 22:04:42 -0700 | [diff] [blame] | 175 | /** 5V strong pullup enabled flag, 1 enabled, zero disabled. */ |
| 176 | int enable_pullup; |
| 177 | /** 5V strong pullup duration in milliseconds, zero disabled. */ |
| 178 | int pullup_duration; |
| 179 | |
Evgeniy Polyakov | 674a396 | 2006-02-20 11:15:37 +0300 | [diff] [blame] | 180 | struct task_struct *thread; |
Evgeniy Polyakov | abd52a1 | 2006-04-03 12:04:27 +0400 | [diff] [blame] | 181 | struct mutex mutex; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | |
| 183 | struct device_driver *driver; |
Evgeniy Polyakov | 7785925 | 2005-05-20 22:33:25 +0400 | [diff] [blame] | 184 | struct device dev; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | |
| 186 | struct w1_bus_master *bus_master; |
| 187 | |
Evgeniy Polyakov | 1200337 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 188 | u32 seq; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 189 | }; |
| 190 | |
| 191 | int w1_create_master_attributes(struct w1_master *); |
David Fries | c30c9b1 | 2008-10-15 22:04:38 -0700 | [diff] [blame] | 192 | void w1_destroy_master_attributes(struct w1_master *master); |
Evgeniy Polyakov | 1200337 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 193 | void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); |
| 194 | void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb); |
| 195 | struct w1_slave *w1_search_slave(struct w1_reg_num *id); |
| 196 | void w1_search_process(struct w1_master *dev, u8 search_type); |
| 197 | struct w1_master *w1_search_master_id(u32 id); |
| 198 | |
David Fries | c30c9b1 | 2008-10-15 22:04:38 -0700 | [diff] [blame] | 199 | /* Disconnect and reconnect devices in the given family. Used for finding |
| 200 | * unclaimed devices after a family has been registered or releasing devices |
| 201 | * after a family has been unregistered. Set attach to 1 when a new family |
| 202 | * has just been registered, to 0 when it has been unregistered. |
| 203 | */ |
| 204 | void w1_reconnect_slaves(struct w1_family *f, int attach); |
| 205 | void w1_slave_detach(struct w1_slave *sl); |
| 206 | |
Evgeniy Polyakov | 1200337 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 207 | u8 w1_triplet(struct w1_master *dev, int bdir); |
| 208 | void w1_write_8(struct w1_master *, u8); |
Evgeniy Polyakov | 1200337 | 2006-03-23 19:11:58 +0300 | [diff] [blame] | 209 | int w1_reset_bus(struct w1_master *); |
| 210 | u8 w1_calc_crc8(u8 *, int); |
| 211 | void w1_write_block(struct w1_master *, const u8 *, int); |
| 212 | u8 w1_read_block(struct w1_master *, u8 *, int); |
| 213 | int w1_reset_select_slave(struct w1_slave *sl); |
David Fries | 6a158c0 | 2008-10-15 22:04:42 -0700 | [diff] [blame] | 214 | void w1_next_pullup(struct w1_master *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 215 | |
Evgeniy Polyakov | db2d000 | 2005-08-11 17:27:49 +0400 | [diff] [blame] | 216 | static inline struct w1_slave* dev_to_w1_slave(struct device *dev) |
| 217 | { |
| 218 | return container_of(dev, struct w1_slave, dev); |
| 219 | } |
| 220 | |
| 221 | static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj) |
| 222 | { |
| 223 | return dev_to_w1_slave(container_of(kobj, struct device, kobj)); |
| 224 | } |
| 225 | |
| 226 | static inline struct w1_master* dev_to_w1_master(struct device *dev) |
| 227 | { |
| 228 | return container_of(dev, struct w1_master, dev); |
| 229 | } |
| 230 | |
Evgeniy Polyakov | 2c5bfda | 2006-04-04 20:35:22 +0400 | [diff] [blame] | 231 | extern struct device_driver w1_master_driver; |
Evgeniy Polyakov | 2c5bfda | 2006-04-04 20:35:22 +0400 | [diff] [blame] | 232 | extern struct device w1_master_device; |
| 233 | extern int w1_max_slave_count; |
| 234 | extern int w1_max_slave_ttl; |
| 235 | extern struct list_head w1_masters; |
| 236 | extern struct mutex w1_mlock; |
| 237 | |
| 238 | extern int w1_process(void *); |
| 239 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | #endif /* __KERNEL__ */ |
| 241 | |
| 242 | #endif /* __W1_H */ |