blob: 97304bd83ec9674105bc837a4e9ecea6ba373cfd [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 *
4 * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
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
58
Evgeniy Polyakovf522d232006-03-23 19:11:58 +030059#define W1_SLAVE_ACTIVE 0
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61struct 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 Polyakov77859252005-05-20 22:33:25 +040073 struct w1_family *family;
Evgeniy Polyakova45f1052005-08-17 15:19:08 +040074 void *family_data;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040075 struct device dev;
Evgeniy Polyakov3aca6922005-08-11 17:27:50 +040076 struct completion released;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
78
David Friesc30c9b12008-10-15 22:04:38 -070079typedef void (*w1_slave_found_callback)(struct w1_master *, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040081
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 Torvalds1da177e2005-04-16 15:20:36 -070089struct w1_bus_master
90{
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040091 /** the first parameter in all the functions below */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030092 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040094 /**
95 * Sample the line level
96 * @return the level read (0 or 1)
97 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030098 u8 (*read_bit)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +040099
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400100 /** Sets the line level */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300101 void (*write_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400102
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400103 /**
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 Polyakovccd69942005-12-06 13:38:27 +0300110 u8 (*touch_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400111
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400112 /**
113 * Reads a bytes. Same as 8 touch_bit(1) calls.
114 * @return the byte read
115 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300116 u8 (*read_byte)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400117
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400118 /**
119 * Writes a byte. Same as 8 touch_bit(x) calls.
120 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300121 void (*write_byte)(void *, u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400123 /**
124 * Same as a series of read_byte() calls
125 * @return the number of bytes read
126 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300127 u8 (*read_block)(void *, u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400128
129 /** Same as a series of write_byte() calls */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300130 void (*write_block)(void *, const u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400131
132 /**
133 * Combines two reads and a smart write for ROM searches
134 * @return bit0=Id bit1=comp_id bit2=dir_taken
135 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300136 u8 (*triplet)(void *, u8);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400137
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 Polyakovccd69942005-12-06 13:38:27 +0300142 u8 (*reset_bus)(void *);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400143
David Fries6a158c02008-10-15 22:04:42 -0700144 /**
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 Friesc30c9b12008-10-15 22:04:38 -0700150 /** 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 Torvalds1da177e2005-04-16 15:20:36 -0700155};
156
157struct 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 Polyakov2a9d0c12005-06-04 01:31:02 +0400168 int search_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 atomic_t refcnt;
171
172 void *priv;
173 int priv_size;
174
David Fries6a158c02008-10-15 22:04:42 -0700175 /** 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 Polyakov674a3962006-02-20 11:15:37 +0300180 struct task_struct *thread;
Evgeniy Polyakovabd52a12006-04-03 12:04:27 +0400181 struct mutex mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
183 struct device_driver *driver;
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400184 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 struct w1_bus_master *bus_master;
187
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300188 u32 seq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189};
190
191int w1_create_master_attributes(struct w1_master *);
David Friesc30c9b12008-10-15 22:04:38 -0700192void w1_destroy_master_attributes(struct w1_master *master);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300193void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
194void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
195struct w1_slave *w1_search_slave(struct w1_reg_num *id);
196void w1_search_process(struct w1_master *dev, u8 search_type);
197struct w1_master *w1_search_master_id(u32 id);
198
David Friesc30c9b12008-10-15 22:04:38 -0700199/* 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 */
204void w1_reconnect_slaves(struct w1_family *f, int attach);
205void w1_slave_detach(struct w1_slave *sl);
206
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300207u8 w1_triplet(struct w1_master *dev, int bdir);
208void w1_write_8(struct w1_master *, u8);
Madhusudhan Chikkature34e453d2008-11-12 13:27:08 -0800209u8 w1_read_8(struct w1_master *);
Evgeniy Polyakov12003372006-03-23 19:11:58 +0300210int w1_reset_bus(struct w1_master *);
211u8 w1_calc_crc8(u8 *, int);
212void w1_write_block(struct w1_master *, const u8 *, int);
213u8 w1_read_block(struct w1_master *, u8 *, int);
214int w1_reset_select_slave(struct w1_slave *sl);
David Fries6a158c02008-10-15 22:04:42 -0700215void w1_next_pullup(struct w1_master *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Evgeniy Polyakovdb2d0002005-08-11 17:27:49 +0400217static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
218{
219 return container_of(dev, struct w1_slave, dev);
220}
221
222static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
223{
224 return dev_to_w1_slave(container_of(kobj, struct device, kobj));
225}
226
227static inline struct w1_master* dev_to_w1_master(struct device *dev)
228{
229 return container_of(dev, struct w1_master, dev);
230}
231
Evgeniy Polyakov2c5bfda2006-04-04 20:35:22 +0400232extern struct device_driver w1_master_driver;
Evgeniy Polyakov2c5bfda2006-04-04 20:35:22 +0400233extern struct device w1_master_device;
234extern int w1_max_slave_count;
235extern int w1_max_slave_ttl;
236extern struct list_head w1_masters;
237extern struct mutex w1_mlock;
238
239extern int w1_process(void *);
240
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241#endif /* __KERNEL__ */
242
243#endif /* __W1_H */