[PATCH] w1: fix CRC calculation on bigendian platforms.
[linux-2.6.git] / drivers / w1 / w1.h
1 /*
2  *      w1.h
3  *
4  * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
5  *
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)
28         __u64   family:8,
29                 id:48,
30                 crc:8;
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
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
65 struct 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;
77         struct w1_family        *family;
78         struct device           dev;
79         struct completion       dev_released;
80
81         struct bin_attribute    attr_bin;
82         struct device_attribute attr_name;
83 };
84
85 typedef void (* w1_slave_found_callback)(unsigned long, u64);
86
87
88 /**
89  * Note: read_bit and write_bit are very low level functions and should only
90  * be used with hardware that doesn't really support 1-wire operations,
91  * like a parallel/serial port.
92  * Either define read_bit and write_bit OR define, at minimum, touch_bit and
93  * reset_bus.
94  */
95 struct w1_bus_master
96 {
97         /** the first parameter in all the functions below */
98         unsigned long   data;
99
100         /**
101          * Sample the line level
102          * @return the level read (0 or 1)
103          */
104         u8              (*read_bit)(unsigned long);
105
106         /** Sets the line level */
107         void            (*write_bit)(unsigned long, u8);
108
109         /**
110          * touch_bit is the lowest-level function for devices that really
111          * support the 1-wire protocol.
112          * touch_bit(0) = write-0 cycle
113          * touch_bit(1) = write-1 / read cycle
114          * @return the bit read (0 or 1)
115          */
116         u8              (*touch_bit)(unsigned long, u8);
117
118         /**
119          * Reads a bytes. Same as 8 touch_bit(1) calls.
120          * @return the byte read
121          */
122         u8              (*read_byte)(unsigned long);
123
124         /**
125          * Writes a byte. Same as 8 touch_bit(x) calls.
126          */
127         void            (*write_byte)(unsigned long, u8);
128
129         /**
130          * Same as a series of read_byte() calls
131          * @return the number of bytes read
132          */
133         u8              (*read_block)(unsigned long, u8 *, int);
134
135         /** Same as a series of write_byte() calls */
136         void            (*write_block)(unsigned long, const u8 *, int);
137
138         /**
139          * Combines two reads and a smart write for ROM searches
140          * @return bit0=Id bit1=comp_id bit2=dir_taken
141          */
142         u8              (*triplet)(unsigned long, u8);
143
144         /**
145          * long write-0 with a read for the presence pulse detection
146          * @return -1=Error, 0=Device present, 1=No device present
147          */
148         u8              (*reset_bus)(unsigned long);
149
150         /** Really nice hardware can handles the ROM searches */
151         void            (*search)(unsigned long, w1_slave_found_callback);
152 };
153
154 #define W1_MASTER_NEED_EXIT             0
155 #define W1_MASTER_NEED_RECONNECT        1
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;
168         int                     search_count;
169
170         atomic_t                refcnt;
171
172         void                    *priv;
173         int                     priv_size;
174
175         long                    flags;
176
177         pid_t                   kpid;
178         struct semaphore        mutex;
179
180         struct device_driver    *driver;
181         struct device           dev;
182         struct completion       dev_released;
183         struct completion       dev_exited;
184
185         struct w1_bus_master    *bus_master;
186
187         u32                     seq, groups;
188         struct sock             *nls;
189 };
190
191 int w1_create_master_attributes(struct w1_master *);
192 void w1_search(struct w1_master *dev, w1_slave_found_callback cb);
193
194 #endif /* __KERNEL__ */
195
196 #endif /* __W1_H */