drivers/w1/w1.h

   1 /*
   2  *      w1.h
   3  *
   4  * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
   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 #include <linux/mutex.h>
  45
  46 #include "w1_family.h"
  47
  48 #define W1_MAXNAMELEN           32
  49
  50 #define W1_SEARCH               0xF0
  51 #define W1_ALARM_SEARCH         0xEC
  52 #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 #define W1_RESUME_CMD           0xA5
  59
  60 #define W1_SLAVE_ACTIVE         0
  61 #define W1_SLAVE_DETACH         1
  62
  63 struct w1_slave
  64 {
  65         struct module           *owner;
  66         unsigned char           name[W1_MAXNAMELEN];
  67         struct list_head        w1_slave_entry;
  68         struct w1_reg_num       reg_num;
  69         atomic_t                refcnt;
  70         int                     ttl;
  71         unsigned long           flags;
  72
  73         struct w1_master        *master;
  74         struct w1_family        *family;
  75         void                    *family_data;
  76         struct device           dev;
  77 };
  78
  79 typedef void (*w1_slave_found_callback)(struct w1_master *, u64);
  80
  81
  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  */
  89 struct w1_bus_master
  90 {
  91         /** the first parameter in all the functions below */
  92         void            *data;
  93
  94         /**
  95          * Sample the line level
  96          * @return the level read (0 or 1)
  97          */
  98         u8              (*read_bit)(void *);
  99
 100         /** Sets the line level */
 101         void            (*write_bit)(void *, u8);
 102
 103         /**
 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          */
 110         u8              (*touch_bit)(void *, u8);
 111
 112         /**
 113          * Reads a bytes. Same as 8 touch_bit(1) calls.
 114          * @return the byte read
 115          */
 116         u8              (*read_byte)(void *);
 117
 118         /**
 119          * Writes a byte. Same as 8 touch_bit(x) calls.
 120          */
 121         void            (*write_byte)(void *, u8);
 122
 123         /**
 124          * Same as a series of read_byte() calls
 125          * @return the number of bytes read
 126          */
 127         u8              (*read_block)(void *, u8 *, int);
 128
 129         /** Same as a series of write_byte() calls */
 130         void            (*write_block)(void *, const u8 *, int);
 131
 132         /**
 133          * Combines two reads and a smart write for ROM searches
 134          * @return bit0=Id bit1=comp_id bit2=dir_taken
 135          */
 136         u8              (*triplet)(void *, u8);
 137
 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          */
 142         u8              (*reset_bus)(void *);
 143
 144         /**
 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
 150         /** Really nice hardware can handles the different types of ROM search
 151          *  w1_master* is passed to the slave found callback.
 152          *  u8 is search_type, W1_SEARCH or W1_ALARM_SEARCH
 153          */
 154         void            (*search)(void *, struct w1_master *,
 155                 u8, w1_slave_found_callback);
 156 };
 157
 158 /**
 159  * enum w1_master_flags - bitfields used in w1_master.flags
 160  * @W1_ABORT_SEARCH: abort searching early on shutdown
 161  * @W1_WARN_MAX_COUNT: limit warning when the maximum count is reached
 162  */
 163 enum w1_master_flags {
 164         W1_ABORT_SEARCH = 0,
 165         W1_WARN_MAX_COUNT = 1,
 166 };
 167
 168 struct w1_master
 169 {
 170         struct list_head        w1_master_entry;
 171         struct module           *owner;
 172         unsigned char           name[W1_MAXNAMELEN];
 173         /* list_mutex protects just slist and async_list so slaves can be
 174          * searched for and async commands added while the master has
 175          * w1_master.mutex locked and is operating on the bus.
 176          * lock order w1_mlock, w1_master.mutex, w1_master_list_mutex
 177          */
 178         struct mutex            list_mutex;
 179         struct list_head        slist;
 180         struct list_head        async_list;
 181         int                     max_slave_count, slave_count;
 182         unsigned long           attempts;
 183         int                     slave_ttl;
 184         int                     initialized;
 185         u32                     id;
 186         int                     search_count;
 187         /* id to start searching on, to continue a search or 0 to restart */
 188         u64                     search_id;
 189
 190         atomic_t                refcnt;
 191
 192         void                    *priv;
 193         int                     priv_size;
 194
 195         /** 5V strong pullup enabled flag, 1 enabled, zero disabled. */
 196         int                     enable_pullup;
 197         /** 5V strong pullup duration in milliseconds, zero disabled. */
 198         int                     pullup_duration;
 199
 200         long                    flags;
 201
 202         struct task_struct      *thread;
 203         struct mutex            mutex;
 204         struct mutex            bus_mutex;
 205
 206         struct device_driver    *driver;
 207         struct device           dev;
 208
 209         struct w1_bus_master    *bus_master;
 210
 211         u32                     seq;
 212         /* port id to send netlink responses to.  The value is temporarily
 213          * stored here while processing a message, set after locking the
 214          * mutex, zero before unlocking the mutex.
 215          */
 216         u32                     portid;
 217 };
 218
 219 /**
 220  * struct w1_async_cmd - execute callback from the w1_process kthread
 221  * @async_entry: link entry
 222  * @cb: callback function, must list_del and destroy this list before
 223  * returning
 224  *
 225  * When inserted into the w1_master async_list, w1_process will execute
 226  * the callback.  Embed this into the structure with the command details.
 227  */
 228 struct w1_async_cmd {
 229         struct list_head        async_entry;
 230         void (*cb)(struct w1_master *dev, struct w1_async_cmd *async_cmd);
 231 };
 232
 233 int w1_create_master_attributes(struct w1_master *);
 234 void w1_destroy_master_attributes(struct w1_master *master);
 235 void w1_search(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
 236 void w1_search_devices(struct w1_master *dev, u8 search_type, w1_slave_found_callback cb);
 237 /* call w1_unref_slave to release the reference counts w1_search_slave added */
 238 struct w1_slave *w1_search_slave(struct w1_reg_num *id);
 239 /* decrements the reference on sl->master and sl, and cleans up if zero
 240  * returns the reference count after it has been decremented */
 241 int w1_unref_slave(struct w1_slave *sl);
 242 void w1_slave_found(struct w1_master *dev, u64 rn);
 243 void w1_search_process_cb(struct w1_master *dev, u8 search_type,
 244         w1_slave_found_callback cb);
 245 struct w1_slave *w1_slave_search_device(struct w1_master *dev,
 246         struct w1_reg_num *rn);
 247 struct w1_master *w1_search_master_id(u32 id);
 248
 249 /* Disconnect and reconnect devices in the given family.  Used for finding
 250  * unclaimed devices after a family has been registered or releasing devices
 251  * after a family has been unregistered.  Set attach to 1 when a new family
 252  * has just been registered, to 0 when it has been unregistered.
 253  */
 254 void w1_reconnect_slaves(struct w1_family *f, int attach);
 255 int w1_attach_slave_device(struct w1_master *dev, struct w1_reg_num *rn);
 256 /* 0 success, otherwise EBUSY */
 257 int w1_slave_detach(struct w1_slave *sl);
 258
 259 u8 w1_triplet(struct w1_master *dev, int bdir);
 260 void w1_write_8(struct w1_master *, u8);
 261 u8 w1_read_8(struct w1_master *);
 262 int w1_reset_bus(struct w1_master *);
 263 u8 w1_calc_crc8(u8 *, int);
 264 void w1_write_block(struct w1_master *, const u8 *, int);
 265 void w1_touch_block(struct w1_master *, u8 *, int);
 266 u8 w1_read_block(struct w1_master *, u8 *, int);
 267 int w1_reset_select_slave(struct w1_slave *sl);
 268 int w1_reset_resume_command(struct w1_master *);
 269 void w1_next_pullup(struct w1_master *, int);
 270
 271 static inline struct w1_slave* dev_to_w1_slave(struct device *dev)
 272 {
 273         return container_of(dev, struct w1_slave, dev);
 274 }
 275
 276 static inline struct w1_slave* kobj_to_w1_slave(struct kobject *kobj)
 277 {
 278         return dev_to_w1_slave(container_of(kobj, struct device, kobj));
 279 }
 280
 281 static inline struct w1_master* dev_to_w1_master(struct device *dev)
 282 {
 283         return container_of(dev, struct w1_master, dev);
 284 }
 285
 286 extern struct device_driver w1_master_driver;
 287 extern struct device w1_master_device;
 288 extern int w1_max_slave_count;
 289 extern int w1_max_slave_ttl;
 290 extern struct list_head w1_masters;
 291 extern struct mutex w1_mlock;
 292
 293 /* returns 1 if there were commands to executed 0 otherwise */
 294 extern int w1_process_callbacks(struct w1_master *dev);
 295 extern int w1_process(void *);
 296
 297 #endif /* __KERNEL__ */
 298
 299 #endif /* __W1_H */