blob: 4d012ca3f32c42a27c2ccd54b9b506907abd597e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Evgeniy Polyakov77859252005-05-20 22:33:25 +04002 * w1.h
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Evgeniy Polyakova8018762011-08-25 15:59:06 -07004 * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
Evgeniy Polyakov77859252005-05-20 22:33:25 +04005 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 *
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
25struct w1_reg_num
26{
27#if defined(__LITTLE_ENDIAN_BITFIELD)
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040028 __u64 family:8,
29 id:48,
30 crc:8;
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#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 Polyakovabd52a12006-04-03 12:04:27 +040044#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
46#include "w1_family.h"
47
48#define W1_MAXNAMELEN 32
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50#define W1_SEARCH 0xF0
Evgeniy Polyakov12003372006-03-23 19:11:58 +030051#define W1_ALARM_SEARCH 0xEC
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#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
Jean-François Dagenais67dfd542011-05-26 16:26:01 -070058#define W1_RESUME_CMD 0xA5
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Evgeniy Polyakovf522d232006-03-23 19:11:58 +030060#define W1_SLAVE_ACTIVE 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62struct w1_slave
63{
64 struct module *owner;
65 unsigned char name[W1_MAXNAMELEN];
66 struct list_head w1_slave_entry;
67 struct w1_reg_num reg_num;
68 atomic_t refcnt;
69 u8 rom[9];
70 u32 flags;
71 int ttl;
72
73 struct w1_master *master;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040074 struct w1_family *family;
Evgeniy Polyakova45f1052005-08-17 15:19:08 +040075 void *family_data;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040076 struct device dev;
Evgeniy Polyakov3aca6922005-08-11 17:27:50 +040077 struct completion released;
Linus Torvalds1da177e2005-04-16 15:20:36 -070078};
79
David Friesc30c9b12008-10-15 22:04:38 -070080typedef void (*w1_slave_found_callback)(struct w1_master *, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040082
83/**
84 * Note: read_bit and write_bit are very low level functions and should only
85 * be used with hardware that doesn't really support 1-wire operations,
86 * like a parallel/serial port.
87 * Either define read_bit and write_bit OR define, at minimum, touch_bit and
88 * reset_bus.
89 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070090struct w1_bus_master
91{
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040092 /** the first parameter in all the functions below */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030093 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040095 /**
96 * Sample the line level
97 * @return the level read (0 or 1)
98 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030099 u8 (*read_bit)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400100
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400101 /** Sets the line level */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300102 void (*write_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400103
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400104 /**
105 * touch_bit is the lowest-level function for devices that really
106 * support the 1-wire protocol.
107 * touch_bit(0) = write-0 cycle
108 * touch_bit(1) = write-1 / read cycle
109 * @return the bit read (0 or 1)
110 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300111 u8 (*touch_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400112
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400113 /**
114 * Reads a bytes. Same as 8 touch_bit(1) calls.
115 * @return the byte read
116 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300117 u8 (*read_byte)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400118
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400119 /**
120 * Writes a byte. Same as 8 touch_bit(x) calls.
121 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300122 void (*write_byte)(void *, u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400124 /**
125 * Same as a series of read_byte() calls
126 * @return the number of bytes read
127 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300128 u8 (*read_block)(void *, u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400129
130 /** Same as a series of write_byte() calls */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300131 void (*write_block)(void *, const u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400132
133 /**
134 * Combines two reads and a smart write for ROM searches
135 * @return bit0=Id bit1=comp_id bit2=dir_taken
136 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300137 u8 (*triplet)(void *, u8);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400138
139 /**
140 * long write-0 with a read for the presence pulse detection
141 * @return -1=Error, 0=Device present, 1=No device present
142 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300143 u8 (*reset_bus)(void *);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400144
David Fries6a158c02008-10-15 22:04:42 -0700145 /**
146 * Put out a strong pull-up pulse of the specified duration.
147 * @return -1=Error, 0=completed
148 */
149 u8 (*set_pullup)(void *, int);
150
David Friesc30c9b12008-10-15 22:04:38 -0700151 /** Really nice hardware can handles the different types of ROM search
152 * w1_master* is passed to the slave found callback.
153 */
154 void (*search)(void *, struct w1_master *,
155 u8, w1_slave_found_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156};
157
158struct w1_master
159{
160 struct list_head w1_master_entry;
161 struct module *owner;
162 unsigned char name[W1_MAXNAMELEN];
163 struct list_head slist;
164 int max_slave_count, slave_count;
165 unsigned long attempts;
166 int slave_ttl;
167 int initialized;
168 u32 id;
Evgeniy Polyakov2a9d0c12005-06-04 01:31:02 +0400169 int search_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
171 atomic_t refcnt;
172
173 void *priv;
174 int priv_size;
175
David Fries6a158c02008-10-15 22:04:42 -0700176 /** 5V strong pullup enabled flag, 1 enabled, zero disabled. */
177 int enable_pullup;
178 /** 5V strong pullup duration in milliseconds, zero disabled. */
179 int pullup_duration;
180
Evgeniy Polyakov674a3962006-02-20 11:15:37 +0300181 struct task_struct *thread;
Evgeniy Polyakovabd52a12006-04-03 12:04:27 +0400182 struct mutex mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184 struct device_driver *driver;
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400185 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
187 struct w1_bus_master *bus_master;
188
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300189 u32 seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190};
191
192int w1_create_master_attributes(struct w1_master *);
David Friesc30c9b12008-10-15 22:04:38 -0700193void w1_destroy_master_attributes(struct w1_master *master);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300194void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
195void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
196struct w1_slave *w1_search_slave(struct w1_reg_num *id);
David Fries963bb102011-05-26 16:26:03 -0700197void w1_slave_found(struct w1_master *dev, u64 rn);
198void w1_search_process_cb(struct w1_master *dev, u8 search_type,
199 w1_slave_found_callback cb);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300200struct w1_master *w1_search_master_id(u32 id);
201
David Friesc30c9b12008-10-15 22:04:38 -0700202/* Disconnect and reconnect devices in the given family. Used for finding
203 * unclaimed devices after a family has been registered or releasing devices
204 * after a family has been unregistered. Set attach to 1 when a new family
205 * has just been registered, to 0 when it has been unregistered.
206 */
207void w1_reconnect_slaves(struct w1_family *f, int attach);
208void w1_slave_detach(struct w1_slave *sl);
209
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300210u8 w1_triplet(struct w1_master *dev, int bdir);
211void w1_write_8(struct w1_master *, u8);
Madhusudhan Chikkature34e453d2008-11-12 13:27:08 -0800212u8 w1_read_8(struct w1_master *);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300213int w1_reset_bus(struct w1_master *);
214u8 w1_calc_crc8(u8 *, int);
215void w1_write_block(struct w1_master *, const u8 *, int);
Evgeniy Polyakov9be62e02009-01-07 18:09:01 -0800216void w1_touch_block(struct w1_master *, u8 *, int);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300217u8 w1_read_block(struct w1_master *, u8 *, int);
218int w1_reset_select_slave(struct w1_slave *sl);
Jean-François Dagenais67dfd542011-05-26 16:26:01 -0700219int w1_reset_resume_command(struct w1_master *);
David Fries6a158c02008-10-15 22:04:42 -0700220void w1_next_pullup(struct w1_master *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Evgeniy Polyakovdb2d0002005-08-11 17:27:49 +0400222static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
223{
224 return container_of(dev, struct w1_slave, dev);
225}
226
227static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
228{
229 return dev_to_w1_slave(container_of(kobj, struct device, kobj));
230}
231
232static inline struct w1_master* dev_to_w1_master(struct device *dev)
233{
234 return container_of(dev, struct w1_master, dev);
235}
236
Evgeniy Polyakov2c5bfda2006-04-04 20:35:22 +0400237extern struct device_driver w1_master_driver;
Evgeniy Polyakov2c5bfda2006-04-04 20:35:22 +0400238extern struct device w1_master_device;
239extern int w1_max_slave_count;
240extern int w1_max_slave_ttl;
241extern struct list_head w1_masters;
242extern struct mutex w1_mlock;
243
244extern int w1_process(void *);
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246#endif /* __KERNEL__ */
247
248#endif /* __W1_H */