xref: /openbmc/linux/drivers/w1/slaves/w1_ds2423.c (revision 63dc02bd)
1 /*
2  *	w1_ds2423.c
3  *
4  * Copyright (c) 2010 Mika Laitio <lamikr@pilppa.org>
5  *
6  * This driver will read and write the value of 4 counters to w1_slave file in
7  * sys filesystem.
8  * Inspired by the w1_therm and w1_ds2431 drivers.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the therms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23  */
24 
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/device.h>
29 #include <linux/types.h>
30 #include <linux/delay.h>
31 #include <linux/crc16.h>
32 
33 #include "../w1.h"
34 #include "../w1_int.h"
35 #include "../w1_family.h"
36 
37 #define CRC16_VALID	0xb001
38 #define CRC16_INIT	0
39 
40 #define COUNTER_COUNT 4
41 #define READ_BYTE_COUNT 42
42 
43 static ssize_t w1_counter_read(struct device *device,
44 	struct device_attribute *attr, char *buf);
45 
46 static struct device_attribute w1_counter_attr =
47 	__ATTR(w1_slave, S_IRUGO, w1_counter_read, NULL);
48 
49 static ssize_t w1_counter_read(struct device *device,
50 	struct device_attribute *attr, char *out_buf)
51 {
52 	struct w1_slave *sl = dev_to_w1_slave(device);
53 	struct w1_master *dev = sl->master;
54 	u8 rbuf[COUNTER_COUNT * READ_BYTE_COUNT];
55 	u8 wrbuf[3];
56 	int rom_addr;
57 	int read_byte_count;
58 	int result;
59 	ssize_t c;
60 	int ii;
61 	int p;
62 	int crc;
63 
64 	c		= PAGE_SIZE;
65 	rom_addr	= (12 << 5) + 31;
66 	wrbuf[0]	= 0xA5;
67 	wrbuf[1]	= rom_addr & 0xFF;
68 	wrbuf[2]	= rom_addr >> 8;
69 	mutex_lock(&dev->mutex);
70 	if (!w1_reset_select_slave(sl)) {
71 		w1_write_block(dev, wrbuf, 3);
72 		read_byte_count = 0;
73 		for (p = 0; p < 4; p++) {
74 			/*
75 			 * 1 byte for first bytes in ram page read
76 			 * 4 bytes for counter
77 			 * 4 bytes for zero bits
78 			 * 2 bytes for crc
79 			 * 31 remaining bytes from the ram page
80 			 */
81 			read_byte_count += w1_read_block(dev,
82 				rbuf + (p * READ_BYTE_COUNT), READ_BYTE_COUNT);
83 			for (ii = 0; ii < READ_BYTE_COUNT; ++ii)
84 				c -= snprintf(out_buf + PAGE_SIZE - c,
85 					c, "%02x ",
86 					rbuf[(p * READ_BYTE_COUNT) + ii]);
87 			if (read_byte_count != (p + 1) * READ_BYTE_COUNT) {
88 				dev_warn(device,
89 					"w1_counter_read() returned %u bytes "
90 					"instead of %d bytes wanted.\n",
91 					read_byte_count,
92 					READ_BYTE_COUNT);
93 				c -= snprintf(out_buf + PAGE_SIZE - c,
94 					c, "crc=NO\n");
95 			} else {
96 				if (p == 0) {
97 					crc = crc16(CRC16_INIT, wrbuf, 3);
98 					crc = crc16(crc, rbuf, 11);
99 				} else {
100 					/*
101 					 * DS2423 calculates crc from all bytes
102 					 * read after the previous crc bytes.
103 					 */
104 					crc = crc16(CRC16_INIT,
105 						(rbuf + 11) +
106 						((p - 1) * READ_BYTE_COUNT),
107 						READ_BYTE_COUNT);
108 				}
109 				if (crc == CRC16_VALID) {
110 					result = 0;
111 					for (ii = 4; ii > 0; ii--) {
112 						result <<= 8;
113 						result |= rbuf[(p *
114 							READ_BYTE_COUNT) + ii];
115 					}
116 					c -= snprintf(out_buf + PAGE_SIZE - c,
117 						c, "crc=YES c=%d\n", result);
118 				} else {
119 					c -= snprintf(out_buf + PAGE_SIZE - c,
120 						c, "crc=NO\n");
121 				}
122 			}
123 		}
124 	} else {
125 		c -= snprintf(out_buf + PAGE_SIZE - c, c, "Connection error");
126 	}
127 	mutex_unlock(&dev->mutex);
128 	return PAGE_SIZE - c;
129 }
130 
131 static int w1_f1d_add_slave(struct w1_slave *sl)
132 {
133 	return device_create_file(&sl->dev, &w1_counter_attr);
134 }
135 
136 static void w1_f1d_remove_slave(struct w1_slave *sl)
137 {
138 	device_remove_file(&sl->dev, &w1_counter_attr);
139 }
140 
141 static struct w1_family_ops w1_f1d_fops = {
142 	.add_slave      = w1_f1d_add_slave,
143 	.remove_slave   = w1_f1d_remove_slave,
144 };
145 
146 static struct w1_family w1_family_1d = {
147 	.fid = W1_COUNTER_DS2423,
148 	.fops = &w1_f1d_fops,
149 };
150 
151 static int __init w1_f1d_init(void)
152 {
153 	return w1_register_family(&w1_family_1d);
154 }
155 
156 static void __exit w1_f1d_exit(void)
157 {
158 	w1_unregister_family(&w1_family_1d);
159 }
160 
161 module_init(w1_f1d_init);
162 module_exit(w1_f1d_exit);
163 
164 MODULE_LICENSE("GPL");
165 MODULE_AUTHOR("Mika Laitio <lamikr@pilppa.org>");
166 MODULE_DESCRIPTION("w1 family 1d driver for DS2423, 4 counters and 4kb ram");
167