blob: 56980505e6c4451385dc361de39a894b2ffbf3d0 [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>
44
45#include <net/sock.h>
46
47#include <asm/semaphore.h>
48
49#include "w1_family.h"
50
51#define W1_MAXNAMELEN 32
52#define W1_SLAVE_DATA_SIZE 128
53
54#define W1_SEARCH 0xF0
55#define W1_CONDITIONAL_SEARCH 0xEC
56#define W1_CONVERT_TEMP 0x44
57#define W1_SKIP_ROM 0xCC
58#define W1_READ_SCRATCHPAD 0xBE
59#define W1_READ_ROM 0x33
60#define W1_READ_PSUPPLY 0xB4
61#define W1_MATCH_ROM 0x55
62
63#define W1_SLAVE_ACTIVE (1<<0)
64
65struct w1_slave
66{
67 struct module *owner;
68 unsigned char name[W1_MAXNAMELEN];
69 struct list_head w1_slave_entry;
70 struct w1_reg_num reg_num;
71 atomic_t refcnt;
72 u8 rom[9];
73 u32 flags;
74 int ttl;
75
76 struct w1_master *master;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040077 struct w1_family *family;
Evgeniy Polyakova45f1052005-08-17 15:19:08 +040078 void *family_data;
Evgeniy Polyakov77859252005-05-20 22:33:25 +040079 struct device dev;
Evgeniy Polyakov3aca6922005-08-11 17:27:50 +040080 struct completion released;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081};
82
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030083typedef void (* w1_slave_found_callback)(void *, u64);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040085
86/**
87 * Note: read_bit and write_bit are very low level functions and should only
88 * be used with hardware that doesn't really support 1-wire operations,
89 * like a parallel/serial port.
90 * Either define read_bit and write_bit OR define, at minimum, touch_bit and
91 * reset_bus.
92 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070093struct w1_bus_master
94{
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040095 /** the first parameter in all the functions below */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +030096 void *data;
Linus Torvalds1da177e2005-04-16 15:20:36 -070097
Evgeniy Polyakov6b729862005-06-04 01:30:43 +040098 /**
99 * Sample the line level
100 * @return the level read (0 or 1)
101 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300102 u8 (*read_bit)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400103
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400104 /** Sets the line level */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300105 void (*write_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400106
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400107 /**
108 * touch_bit is the lowest-level function for devices that really
109 * support the 1-wire protocol.
110 * touch_bit(0) = write-0 cycle
111 * touch_bit(1) = write-1 / read cycle
112 * @return the bit read (0 or 1)
113 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300114 u8 (*touch_bit)(void *, u8);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400115
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400116 /**
117 * Reads a bytes. Same as 8 touch_bit(1) calls.
118 * @return the byte read
119 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300120 u8 (*read_byte)(void *);
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400121
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400122 /**
123 * Writes a byte. Same as 8 touch_bit(x) calls.
124 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300125 void (*write_byte)(void *, u8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400127 /**
128 * Same as a series of read_byte() calls
129 * @return the number of bytes read
130 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300131 u8 (*read_block)(void *, u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400132
133 /** Same as a series of write_byte() calls */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300134 void (*write_block)(void *, const u8 *, int);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400135
136 /**
137 * Combines two reads and a smart write for ROM searches
138 * @return bit0=Id bit1=comp_id bit2=dir_taken
139 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300140 u8 (*triplet)(void *, u8);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400141
142 /**
143 * long write-0 with a read for the presence pulse detection
144 * @return -1=Error, 0=Device present, 1=No device present
145 */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300146 u8 (*reset_bus)(void *);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400147
148 /** Really nice hardware can handles the ROM searches */
Evgeniy Polyakovccd69942005-12-06 13:38:27 +0300149 void (*search)(void *, w1_slave_found_callback);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150};
151
Evgeniy Polyakov6adf87b2005-06-04 01:29:25 +0400152#define W1_MASTER_NEED_EXIT 0
153#define W1_MASTER_NEED_RECONNECT 1
154
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155struct w1_master
156{
157 struct list_head w1_master_entry;
158 struct module *owner;
159 unsigned char name[W1_MAXNAMELEN];
160 struct list_head slist;
161 int max_slave_count, slave_count;
162 unsigned long attempts;
163 int slave_ttl;
164 int initialized;
165 u32 id;
Evgeniy Polyakov2a9d0c12005-06-04 01:31:02 +0400166 int search_count;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
168 atomic_t refcnt;
169
170 void *priv;
171 int priv_size;
172
Evgeniy Polyakov6adf87b2005-06-04 01:29:25 +0400173 long flags;
174
Evgeniy Polyakov674a396c2006-02-20 11:15:37 +0300175 struct task_struct *thread;
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400176 struct semaphore mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177
178 struct device_driver *driver;
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400179 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
181 struct w1_bus_master *bus_master;
182
183 u32 seq, groups;
Evgeniy Polyakov77859252005-05-20 22:33:25 +0400184 struct sock *nls;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185};
186
187int w1_create_master_attributes(struct w1_master *);
Evgeniy Polyakov6b729862005-06-04 01:30:43 +0400188void w1_search(struct w1_master *dev, w1_slave_found_callback cb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Evgeniy Polyakovdb2d0002005-08-11 17:27:49 +0400190static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
191{
192 return container_of(dev, struct w1_slave, dev);
193}
194
195static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
196{
197 return dev_to_w1_slave(container_of(kobj, struct device, kobj));
198}
199
200static inline struct w1_master* dev_to_w1_master(struct device *dev)
201{
202 return container_of(dev, struct w1_master, dev);
203}
204
Adrian Bunka9fb1c72005-12-13 14:04:33 -0800205extern int w1_max_slave_count;
206extern int w1_max_slave_ttl;
207extern spinlock_t w1_mlock;
208extern struct list_head w1_masters;
209extern struct device_driver w1_master_driver;
210extern struct device w1_master_device;
211
212int w1_process(void *data);
213void w1_reconnect_slaves(struct w1_family *f);
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215#endif /* __KERNEL__ */
216
217#endif /* __W1_H */