xref: /linux/drivers/hwmon/ultra45_env.c (revision 0d456bad36d42d16022be045c8a53ddbb59ee478)
1 /*
2  * ultra45_env.c: Driver for Ultra45 PIC16F747 environmental monitor.
3  *
4  * Copyright (C) 2008 David S. Miller <davem@davemloft.net>
5  */
6 
7 #include <linux/kernel.h>
8 #include <linux/types.h>
9 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/of_device.h>
12 #include <linux/io.h>
13 #include <linux/hwmon.h>
14 #include <linux/hwmon-sysfs.h>
15 #include <linux/err.h>
16 
17 #define DRV_MODULE_VERSION	"0.1"
18 
19 MODULE_AUTHOR("David S. Miller (davem@davemloft.net)");
20 MODULE_DESCRIPTION("Ultra45 environmental monitor driver");
21 MODULE_LICENSE("GPL");
22 MODULE_VERSION(DRV_MODULE_VERSION);
23 
24 /* PIC device registers */
25 #define REG_CMD		0x00UL
26 #define  REG_CMD_RESET	0x80
27 #define  REG_CMD_ESTAR	0x01
28 #define REG_STAT	0x01UL
29 #define  REG_STAT_FWVER	0xf0
30 #define  REG_STAT_TGOOD	0x08
31 #define  REG_STAT_STALE	0x04
32 #define  REG_STAT_BUSY	0x02
33 #define  REG_STAT_FAULT	0x01
34 #define REG_DATA	0x40UL
35 #define REG_ADDR	0x41UL
36 #define REG_SIZE	0x42UL
37 
38 /* Registers accessed indirectly via REG_DATA/REG_ADDR */
39 #define IREG_FAN0		0x00
40 #define IREG_FAN1		0x01
41 #define IREG_FAN2		0x02
42 #define IREG_FAN3		0x03
43 #define IREG_FAN4		0x04
44 #define IREG_FAN5		0x05
45 #define IREG_LCL_TEMP		0x06
46 #define IREG_RMT1_TEMP		0x07
47 #define IREG_RMT2_TEMP		0x08
48 #define IREG_RMT3_TEMP		0x09
49 #define IREG_LM95221_TEMP	0x0a
50 #define IREG_FIRE_TEMP		0x0b
51 #define IREG_LSI1064_TEMP	0x0c
52 #define IREG_FRONT_TEMP		0x0d
53 #define IREG_FAN_STAT		0x0e
54 #define IREG_VCORE0		0x0f
55 #define IREG_VCORE1		0x10
56 #define IREG_VMEM0		0x11
57 #define IREG_VMEM1		0x12
58 #define IREG_PSU_TEMP		0x13
59 
60 struct env {
61 	void __iomem	*regs;
62 	spinlock_t	lock;
63 
64 	struct device	*hwmon_dev;
65 };
66 
67 static u8 env_read(struct env *p, u8 ireg)
68 {
69 	u8 ret;
70 
71 	spin_lock(&p->lock);
72 	writeb(ireg, p->regs + REG_ADDR);
73 	ret = readb(p->regs + REG_DATA);
74 	spin_unlock(&p->lock);
75 
76 	return ret;
77 }
78 
79 static void env_write(struct env *p, u8 ireg, u8 val)
80 {
81 	spin_lock(&p->lock);
82 	writeb(ireg, p->regs + REG_ADDR);
83 	writeb(val, p->regs + REG_DATA);
84 	spin_unlock(&p->lock);
85 }
86 
87 /*
88  * There seems to be a adr7462 providing these values, thus a lot
89  * of these calculations are borrowed from the adt7470 driver.
90  */
91 #define FAN_PERIOD_TO_RPM(x)	((90000 * 60) / (x))
92 #define FAN_RPM_TO_PERIOD	FAN_PERIOD_TO_RPM
93 #define FAN_PERIOD_INVALID	(0xff << 8)
94 #define FAN_DATA_VALID(x)	((x) && (x) != FAN_PERIOD_INVALID)
95 
96 static ssize_t show_fan_speed(struct device *dev, struct device_attribute *attr,
97 			      char *buf)
98 {
99 	int fan_nr = to_sensor_dev_attr(attr)->index;
100 	struct env *p = dev_get_drvdata(dev);
101 	int rpm, period;
102 	u8 val;
103 
104 	val = env_read(p, IREG_FAN0 + fan_nr);
105 	period = (int) val << 8;
106 	if (FAN_DATA_VALID(period))
107 		rpm = FAN_PERIOD_TO_RPM(period);
108 	else
109 		rpm = 0;
110 
111 	return sprintf(buf, "%d\n", rpm);
112 }
113 
114 static ssize_t set_fan_speed(struct device *dev, struct device_attribute *attr,
115 			     const char *buf, size_t count)
116 {
117 	int fan_nr = to_sensor_dev_attr(attr)->index;
118 	unsigned long rpm;
119 	struct env *p = dev_get_drvdata(dev);
120 	int period;
121 	u8 val;
122 	int err;
123 
124 	err = kstrtoul(buf, 10, &rpm);
125 	if (err)
126 		return err;
127 
128 	if (!rpm)
129 		return -EINVAL;
130 
131 	period = FAN_RPM_TO_PERIOD(rpm);
132 	val = period >> 8;
133 	env_write(p, IREG_FAN0 + fan_nr, val);
134 
135 	return count;
136 }
137 
138 static ssize_t show_fan_fault(struct device *dev, struct device_attribute *attr,
139 			      char *buf)
140 {
141 	int fan_nr = to_sensor_dev_attr(attr)->index;
142 	struct env *p = dev_get_drvdata(dev);
143 	u8 val = env_read(p, IREG_FAN_STAT);
144 	return sprintf(buf, "%d\n", (val & (1 << fan_nr)) ? 1 : 0);
145 }
146 
147 #define fan(index)							\
148 static SENSOR_DEVICE_ATTR(fan##index##_speed, S_IRUGO | S_IWUSR,	\
149 		show_fan_speed, set_fan_speed, index);			\
150 static SENSOR_DEVICE_ATTR(fan##index##_fault, S_IRUGO,			\
151 		show_fan_fault, NULL, index)
152 
153 fan(0);
154 fan(1);
155 fan(2);
156 fan(3);
157 fan(4);
158 
159 static SENSOR_DEVICE_ATTR(psu_fan_fault, S_IRUGO, show_fan_fault, NULL, 6);
160 
161 static ssize_t show_temp(struct device *dev, struct device_attribute *attr,
162 			 char *buf)
163 {
164 	int temp_nr = to_sensor_dev_attr(attr)->index;
165 	struct env *p = dev_get_drvdata(dev);
166 	s8 val;
167 
168 	val = env_read(p, IREG_LCL_TEMP + temp_nr);
169 	return sprintf(buf, "%d\n", ((int) val) - 64);
170 }
171 
172 static SENSOR_DEVICE_ATTR(adt7462_local_temp, S_IRUGO, show_temp, NULL, 0);
173 static SENSOR_DEVICE_ATTR(cpu0_temp, S_IRUGO, show_temp, NULL, 1);
174 static SENSOR_DEVICE_ATTR(cpu1_temp, S_IRUGO, show_temp, NULL, 2);
175 static SENSOR_DEVICE_ATTR(motherboard_temp, S_IRUGO, show_temp, NULL, 3);
176 static SENSOR_DEVICE_ATTR(lm95221_local_temp, S_IRUGO, show_temp, NULL, 4);
177 static SENSOR_DEVICE_ATTR(fire_temp, S_IRUGO, show_temp, NULL, 5);
178 static SENSOR_DEVICE_ATTR(lsi1064_local_temp, S_IRUGO, show_temp, NULL, 6);
179 static SENSOR_DEVICE_ATTR(front_panel_temp, S_IRUGO, show_temp, NULL, 7);
180 static SENSOR_DEVICE_ATTR(psu_temp, S_IRUGO, show_temp, NULL, 13);
181 
182 static ssize_t show_stat_bit(struct device *dev, struct device_attribute *attr,
183 			     char *buf)
184 {
185 	int index = to_sensor_dev_attr(attr)->index;
186 	struct env *p = dev_get_drvdata(dev);
187 	u8 val;
188 
189 	val = readb(p->regs + REG_STAT);
190 	return sprintf(buf, "%d\n", (val & (1 << index)) ? 1 : 0);
191 }
192 
193 static SENSOR_DEVICE_ATTR(fan_failure, S_IRUGO, show_stat_bit, NULL, 0);
194 static SENSOR_DEVICE_ATTR(env_bus_busy, S_IRUGO, show_stat_bit, NULL, 1);
195 static SENSOR_DEVICE_ATTR(env_data_stale, S_IRUGO, show_stat_bit, NULL, 2);
196 static SENSOR_DEVICE_ATTR(tpm_self_test_passed, S_IRUGO, show_stat_bit, NULL,
197 			  3);
198 
199 static ssize_t show_fwver(struct device *dev, struct device_attribute *attr,
200 			  char *buf)
201 {
202 	struct env *p = dev_get_drvdata(dev);
203 	u8 val;
204 
205 	val = readb(p->regs + REG_STAT);
206 	return sprintf(buf, "%d\n", val >> 4);
207 }
208 
209 static SENSOR_DEVICE_ATTR(firmware_version, S_IRUGO, show_fwver, NULL, 0);
210 
211 static ssize_t show_name(struct device *dev, struct device_attribute *attr,
212 			 char *buf)
213 {
214 	return sprintf(buf, "ultra45\n");
215 }
216 
217 static SENSOR_DEVICE_ATTR(name, S_IRUGO, show_name, NULL, 0);
218 
219 static struct attribute *env_attributes[] = {
220 	&sensor_dev_attr_fan0_speed.dev_attr.attr,
221 	&sensor_dev_attr_fan0_fault.dev_attr.attr,
222 	&sensor_dev_attr_fan1_speed.dev_attr.attr,
223 	&sensor_dev_attr_fan1_fault.dev_attr.attr,
224 	&sensor_dev_attr_fan2_speed.dev_attr.attr,
225 	&sensor_dev_attr_fan2_fault.dev_attr.attr,
226 	&sensor_dev_attr_fan3_speed.dev_attr.attr,
227 	&sensor_dev_attr_fan3_fault.dev_attr.attr,
228 	&sensor_dev_attr_fan4_speed.dev_attr.attr,
229 	&sensor_dev_attr_fan4_fault.dev_attr.attr,
230 	&sensor_dev_attr_psu_fan_fault.dev_attr.attr,
231 	&sensor_dev_attr_adt7462_local_temp.dev_attr.attr,
232 	&sensor_dev_attr_cpu0_temp.dev_attr.attr,
233 	&sensor_dev_attr_cpu1_temp.dev_attr.attr,
234 	&sensor_dev_attr_motherboard_temp.dev_attr.attr,
235 	&sensor_dev_attr_lm95221_local_temp.dev_attr.attr,
236 	&sensor_dev_attr_fire_temp.dev_attr.attr,
237 	&sensor_dev_attr_lsi1064_local_temp.dev_attr.attr,
238 	&sensor_dev_attr_front_panel_temp.dev_attr.attr,
239 	&sensor_dev_attr_psu_temp.dev_attr.attr,
240 	&sensor_dev_attr_fan_failure.dev_attr.attr,
241 	&sensor_dev_attr_env_bus_busy.dev_attr.attr,
242 	&sensor_dev_attr_env_data_stale.dev_attr.attr,
243 	&sensor_dev_attr_tpm_self_test_passed.dev_attr.attr,
244 	&sensor_dev_attr_firmware_version.dev_attr.attr,
245 	&sensor_dev_attr_name.dev_attr.attr,
246 	NULL,
247 };
248 
249 static const struct attribute_group env_group = {
250 	.attrs = env_attributes,
251 };
252 
253 static int env_probe(struct platform_device *op)
254 {
255 	struct env *p = kzalloc(sizeof(*p), GFP_KERNEL);
256 	int err = -ENOMEM;
257 
258 	if (!p)
259 		goto out;
260 
261 	spin_lock_init(&p->lock);
262 
263 	p->regs = of_ioremap(&op->resource[0], 0, REG_SIZE, "pic16f747");
264 	if (!p->regs)
265 		goto out_free;
266 
267 	err = sysfs_create_group(&op->dev.kobj, &env_group);
268 	if (err)
269 		goto out_iounmap;
270 
271 	p->hwmon_dev = hwmon_device_register(&op->dev);
272 	if (IS_ERR(p->hwmon_dev)) {
273 		err = PTR_ERR(p->hwmon_dev);
274 		goto out_sysfs_remove_group;
275 	}
276 
277 	platform_set_drvdata(op, p);
278 	err = 0;
279 
280 out:
281 	return err;
282 
283 out_sysfs_remove_group:
284 	sysfs_remove_group(&op->dev.kobj, &env_group);
285 
286 out_iounmap:
287 	of_iounmap(&op->resource[0], p->regs, REG_SIZE);
288 
289 out_free:
290 	kfree(p);
291 	goto out;
292 }
293 
294 static int env_remove(struct platform_device *op)
295 {
296 	struct env *p = platform_get_drvdata(op);
297 
298 	if (p) {
299 		sysfs_remove_group(&op->dev.kobj, &env_group);
300 		hwmon_device_unregister(p->hwmon_dev);
301 		of_iounmap(&op->resource[0], p->regs, REG_SIZE);
302 		kfree(p);
303 	}
304 
305 	return 0;
306 }
307 
308 static const struct of_device_id env_match[] = {
309 	{
310 		.name = "env-monitor",
311 		.compatible = "SUNW,ebus-pic16f747-env",
312 	},
313 	{},
314 };
315 MODULE_DEVICE_TABLE(of, env_match);
316 
317 static struct platform_driver env_driver = {
318 	.driver = {
319 		.name = "ultra45_env",
320 		.owner = THIS_MODULE,
321 		.of_match_table = env_match,
322 	},
323 	.probe		= env_probe,
324 	.remove		= env_remove,
325 };
326 
327 module_platform_driver(env_driver);
328