4 * Copyright (c) 2004 Evgeniy Polyakov <johnpol@2ka.mipt.ru>
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.
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.
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
27 #if defined(__LITTLE_ENDIAN_BITFIELD)
31 #elif defined(__BIG_ENDIAN_BITFIELD)
36 #error "Please fix <asm/byteorder.h>"
42 #include <linux/completion.h>
43 #include <linux/device.h>
47 #include <asm/semaphore.h>
49 #include "w1_family.h"
51 #define W1_MAXNAMELEN 32
52 #define W1_SLAVE_DATA_SIZE 128
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
63 #define W1_SLAVE_ACTIVE (1<<0)
68 unsigned char name[W1_MAXNAMELEN];
69 struct list_head w1_slave_entry;
70 struct w1_reg_num reg_num;
76 struct w1_master *master;
77 struct w1_family *family;
79 struct completion dev_released;
82 typedef void (* w1_slave_found_callback)(unsigned long, u64);
86 * Note: read_bit and write_bit are very low level functions and should only
87 * be used with hardware that doesn't really support 1-wire operations,
88 * like a parallel/serial port.
89 * Either define read_bit and write_bit OR define, at minimum, touch_bit and
94 /** the first parameter in all the functions below */
98 * Sample the line level
99 * @return the level read (0 or 1)
101 u8 (*read_bit)(unsigned long);
103 /** Sets the line level */
104 void (*write_bit)(unsigned long, u8);
107 * touch_bit is the lowest-level function for devices that really
108 * support the 1-wire protocol.
109 * touch_bit(0) = write-0 cycle
110 * touch_bit(1) = write-1 / read cycle
111 * @return the bit read (0 or 1)
113 u8 (*touch_bit)(unsigned long, u8);
116 * Reads a bytes. Same as 8 touch_bit(1) calls.
117 * @return the byte read
119 u8 (*read_byte)(unsigned long);
122 * Writes a byte. Same as 8 touch_bit(x) calls.
124 void (*write_byte)(unsigned long, u8);
127 * Same as a series of read_byte() calls
128 * @return the number of bytes read
130 u8 (*read_block)(unsigned long, u8 *, int);
132 /** Same as a series of write_byte() calls */
133 void (*write_block)(unsigned long, const u8 *, int);
136 * Combines two reads and a smart write for ROM searches
137 * @return bit0=Id bit1=comp_id bit2=dir_taken
139 u8 (*triplet)(unsigned long, u8);
142 * long write-0 with a read for the presence pulse detection
143 * @return -1=Error, 0=Device present, 1=No device present
145 u8 (*reset_bus)(unsigned long);
147 /** Really nice hardware can handles the ROM searches */
148 void (*search)(unsigned long, w1_slave_found_callback);
151 #define W1_MASTER_NEED_EXIT 0
152 #define W1_MASTER_NEED_RECONNECT 1
156 struct list_head w1_master_entry;
157 struct module *owner;
158 unsigned char name[W1_MAXNAMELEN];
159 struct list_head slist;
160 int max_slave_count, slave_count;
161 unsigned long attempts;
175 struct semaphore mutex;
177 struct device_driver *driver;
179 struct completion dev_released;
180 struct completion dev_exited;
182 struct w1_bus_master *bus_master;
188 int w1_create_master_attributes(struct w1_master *);
189 void w1_search(struct w1_master *dev, w1_slave_found_callback cb);
191 static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
193 return container_of(dev, struct w1_slave, dev);
196 static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
198 return dev_to_w1_slave(container_of(kobj, struct device, kobj));
201 static inline struct w1_master* dev_to_w1_master(struct device *dev)
203 return container_of(dev, struct w1_master, dev);
206 #endif /* __KERNEL__ */