git.oblomov.eu Git - linux-2.6/blob - drivers/w1/slaves/w1_ds2433.c

   1 /*
   2  *      w1_ds2433.c - w1 family 23 (DS2433) driver
   3  *
   4  * Copyright (c) 2005 Ben Gardner <bgardner@wabtec.com>
   5  *
   6  * This source code is licensed under the GNU General Public License,
   7  * Version 2. See the file COPYING for more details.
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/module.h>
  12 #include <linux/moduleparam.h>
  13 #include <linux/device.h>
  14 #include <linux/types.h>
  15 #include <linux/delay.h>
  16 #ifdef CONFIG_W1_F23_CRC
  17 #include <linux/crc16.h>
  18
  19 #define CRC16_INIT              0
  20 #define CRC16_VALID             0xb001
  21
  22 #endif
  23
  24 #include "../w1.h"
  25 #include "../w1_int.h"
  26 #include "../w1_family.h"
  27
  28 MODULE_LICENSE("GPL");
  29 MODULE_AUTHOR("Ben Gardner <bgardner@wabtec.com>");
  30 MODULE_DESCRIPTION("w1 family 23 driver for DS2433, 4kb EEPROM");
  31
  32 #define W1_EEPROM_SIZE          512
  33 #define W1_PAGE_COUNT           16
  34 #define W1_PAGE_SIZE            32
  35 #define W1_PAGE_BITS            5
  36 #define W1_PAGE_MASK            0x1F
  37
  38 #define W1_F23_TIME             300
  39
  40 #define W1_F23_READ_EEPROM      0xF0
  41 #define W1_F23_WRITE_SCRATCH    0x0F
  42 #define W1_F23_READ_SCRATCH     0xAA
  43 #define W1_F23_COPY_SCRATCH     0x55
  44
  45 struct w1_f23_data {
  46         u8      memory[W1_EEPROM_SIZE];
  47         u32     validcrc;
  48 };
  49
  50 /**
  51  * Check the file size bounds and adjusts count as needed.
  52  * This would not be needed if the file size didn't reset to 0 after a write.
  53  */
  54 static inline size_t w1_f23_fix_count(loff_t off, size_t count, size_t size)
  55 {
  56         if (off > size)
  57                 return 0;
  58
  59         if ((off + count) > size)
  60                 return (size - off);
  61
  62         return count;
  63 }
  64
  65 #ifdef CONFIG_W1_F23_CRC
  66 static int w1_f23_refresh_block(struct w1_slave *sl, struct w1_f23_data *data,
  67                                 int block)
  68 {
  69         u8      wrbuf[3];
  70         int     off = block * W1_PAGE_SIZE;
  71
  72         if (data->validcrc & (1 << block))
  73                 return 0;
  74
  75         if (w1_reset_select_slave(sl)) {
  76                 data->validcrc = 0;
  77                 return -EIO;
  78         }
  79
  80         wrbuf[0] = W1_F23_READ_EEPROM;
  81         wrbuf[1] = off & 0xff;
  82         wrbuf[2] = off >> 8;
  83         w1_write_block(sl->master, wrbuf, 3);
  84         w1_read_block(sl->master, &data->memory[off], W1_PAGE_SIZE);
  85
  86         /* cache the block if the CRC is valid */
  87         if (crc16(CRC16_INIT, &data->memory[off], W1_PAGE_SIZE) == CRC16_VALID)
  88                 data->validcrc |= (1 << block);
  89
  90         return 0;
  91 }
  92 #endif  /* CONFIG_W1_F23_CRC */
  93
  94 static ssize_t w1_f23_read_bin(struct kobject *kobj, char *buf, loff_t off,
  95                                size_t count)
  96 {
  97         struct w1_slave *sl = kobj_to_w1_slave(kobj);
  98 #ifdef CONFIG_W1_F23_CRC
  99         struct w1_f23_data *data = sl->family_data;
 100         int i, min_page, max_page;
 101 #else
 102         u8 wrbuf[3];
 103 #endif
 104
 105         if ((count = w1_f23_fix_count(off, count, W1_EEPROM_SIZE)) == 0)
 106                 return 0;
 107
 108         atomic_inc(&sl->refcnt);
 109         if (down_interruptible(&sl->master->mutex)) {
 110                 count = 0;
 111                 goto out_dec;
 112         }
 113
 114 #ifdef CONFIG_W1_F23_CRC
 115
 116         min_page = (off >> W1_PAGE_BITS);
 117         max_page = (off + count - 1) >> W1_PAGE_BITS;
 118         for (i = min_page; i <= max_page; i++) {
 119                 if (w1_f23_refresh_block(sl, data, i)) {
 120                         count = -EIO;
 121                         goto out_up;
 122                 }
 123         }
 124         memcpy(buf, &data->memory[off], count);
 125
 126 #else   /* CONFIG_W1_F23_CRC */
 127
 128         /* read directly from the EEPROM */
 129         if (w1_reset_select_slave(sl)) {
 130                 count = -EIO;
 131                 goto out_up;
 132         }
 133
 134         wrbuf[0] = W1_F23_READ_EEPROM;
 135         wrbuf[1] = off & 0xff;
 136         wrbuf[2] = off >> 8;
 137         w1_write_block(sl->master, wrbuf, 3);
 138         w1_read_block(sl->master, buf, count);
 139
 140 #endif  /* CONFIG_W1_F23_CRC */
 141
 142 out_up:
 143         up(&sl->master->mutex);
 144 out_dec:
 145         atomic_dec(&sl->refcnt);
 146
 147         return count;
 148 }
 149
 150 /**
 151  * Writes to the scratchpad and reads it back for verification.
 152  * Then copies the scratchpad to EEPROM.
 153  * The data must be on one page.
 154  * The master must be locked.
 155  *
 156  * @param sl    The slave structure
 157  * @param addr  Address for the write
 158  * @param len   length must be <= (W1_PAGE_SIZE - (addr & W1_PAGE_MASK))
 159  * @param data  The data to write
 160  * @return      0=Success -1=failure
 161  */
 162 static int w1_f23_write(struct w1_slave *sl, int addr, int len, const u8 *data)
 163 {
 164         u8 wrbuf[4];
 165         u8 rdbuf[W1_PAGE_SIZE + 3];
 166         u8 es = (addr + len - 1) & 0x1f;
 167
 168         /* Write the data to the scratchpad */
 169         if (w1_reset_select_slave(sl))
 170                 return -1;
 171
 172         wrbuf[0] = W1_F23_WRITE_SCRATCH;
 173         wrbuf[1] = addr & 0xff;
 174         wrbuf[2] = addr >> 8;
 175
 176         w1_write_block(sl->master, wrbuf, 3);
 177         w1_write_block(sl->master, data, len);
 178
 179         /* Read the scratchpad and verify */
 180         if (w1_reset_select_slave(sl))
 181                 return -1;
 182
 183         w1_write_8(sl->master, W1_F23_READ_SCRATCH);
 184         w1_read_block(sl->master, rdbuf, len + 3);
 185
 186         /* Compare what was read against the data written */
 187         if ((rdbuf[0] != wrbuf[1]) || (rdbuf[1] != wrbuf[2]) ||
 188             (rdbuf[2] != es) || (memcmp(data, &rdbuf[3], len) != 0))
 189                 return -1;
 190
 191         /* Copy the scratchpad to EEPROM */
 192         if (w1_reset_select_slave(sl))
 193                 return -1;
 194
 195         wrbuf[0] = W1_F23_COPY_SCRATCH;
 196         wrbuf[3] = es;
 197         w1_write_block(sl->master, wrbuf, 4);
 198
 199         /* Sleep for 5 ms to wait for the write to complete */
 200         msleep(5);
 201
 202         /* Reset the bus to wake up the EEPROM (this may not be needed) */
 203         w1_reset_bus(sl->master);
 204
 205         return 0;
 206 }
 207
 208 static ssize_t w1_f23_write_bin(struct kobject *kobj, char *buf, loff_t off,
 209                                 size_t count)
 210 {
 211         struct w1_slave *sl = kobj_to_w1_slave(kobj);
 212         int addr, len, idx;
 213
 214         if ((count = w1_f23_fix_count(off, count, W1_EEPROM_SIZE)) == 0)
 215                 return 0;
 216
 217 #ifdef CONFIG_W1_F23_CRC
 218         /* can only write full blocks in cached mode */
 219         if ((off & W1_PAGE_MASK) || (count & W1_PAGE_MASK)) {
 220                 dev_err(&sl->dev, "invalid offset/count off=%d cnt=%zd\n",
 221                         (int)off, count);
 222                 return -EINVAL;
 223         }
 224
 225         /* make sure the block CRCs are valid */
 226         for (idx = 0; idx < count; idx += W1_PAGE_SIZE) {
 227                 if (crc16(CRC16_INIT, &buf[idx], W1_PAGE_SIZE) != CRC16_VALID) {
 228                         dev_err(&sl->dev, "bad CRC at offset %d\n", (int)off);
 229                         return -EINVAL;
 230                 }
 231         }
 232 #endif  /* CONFIG_W1_F23_CRC */
 233
 234         atomic_inc(&sl->refcnt);
 235         if (down_interruptible(&sl->master->mutex)) {
 236                 count = 0;
 237                 goto out_dec;
 238         }
 239
 240         /* Can only write data to one page at a time */
 241         idx = 0;
 242         while (idx < count) {
 243                 addr = off + idx;
 244                 len = W1_PAGE_SIZE - (addr & W1_PAGE_MASK);
 245                 if (len > (count - idx))
 246                         len = count - idx;
 247
 248                 if (w1_f23_write(sl, addr, len, &buf[idx]) < 0) {
 249                         count = -EIO;
 250                         goto out_up;
 251                 }
 252                 idx += len;
 253         }
 254
 255 out_up:
 256         up(&sl->master->mutex);
 257 out_dec:
 258         atomic_dec(&sl->refcnt);
 259
 260         return count;
 261 }
 262
 263 static struct bin_attribute w1_f23_bin_attr = {
 264         .attr = {
 265                 .name = "eeprom",
 266                 .mode = S_IRUGO | S_IWUSR,
 267                 .owner = THIS_MODULE,
 268         },
 269         .size = W1_EEPROM_SIZE,
 270         .read = w1_f23_read_bin,
 271         .write = w1_f23_write_bin,
 272 };
 273
 274 static int w1_f23_add_slave(struct w1_slave *sl)
 275 {
 276         int err;
 277 #ifdef CONFIG_W1_F23_CRC
 278         struct w1_f23_data *data;
 279
 280         data = kmalloc(sizeof(struct w1_f23_data), GFP_KERNEL);
 281         if (!data)
 282                 return -ENOMEM;
 283         memset(data, 0, sizeof(struct w1_f23_data));
 284         sl->family_data = data;
 285
 286 #endif  /* CONFIG_W1_F23_CRC */
 287
 288         err = sysfs_create_bin_file(&sl->dev.kobj, &w1_f23_bin_attr);
 289
 290 #ifdef CONFIG_W1_F23_CRC
 291         if (err)
 292                 kfree(data);
 293 #endif  /* CONFIG_W1_F23_CRC */
 294
 295         return err;
 296 }
 297
 298 static void w1_f23_remove_slave(struct w1_slave *sl)
 299 {
 300 #ifdef CONFIG_W1_F23_CRC
 301         kfree(sl->family_data);
 302         sl->family_data = NULL;
 303 #endif  /* CONFIG_W1_F23_CRC */
 304         sysfs_remove_bin_file(&sl->dev.kobj, &w1_f23_bin_attr);
 305 }
 306
 307 static struct w1_family_ops w1_f23_fops = {
 308         .add_slave      = w1_f23_add_slave,
 309         .remove_slave   = w1_f23_remove_slave,
 310 };
 311
 312 static struct w1_family w1_family_23 = {
 313         .fid = W1_EEPROM_DS2433,
 314         .fops = &w1_f23_fops,
 315 };
 316
 317 static int __init w1_f23_init(void)
 318 {
 319         return w1_register_family(&w1_family_23);
 320 }
 321
 322 static void __exit w1_f23_fini(void)
 323 {
 324         w1_unregister_family(&w1_family_23);
 325 }
 326
 327 module_init(w1_f23_init);
 328 module_exit(w1_f23_fini);