2 * A hwmon driver for the Intel 5000 series chipset FB-DIMM AMB
4 * Copyright (C) 2007 IBM
6 * Author: Darrick J. Wong <djwong@us.ibm.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/jiffies.h>
25 #include <linux/hwmon.h>
26 #include <linux/hwmon-sysfs.h>
27 #include <linux/err.h>
28 #include <linux/mutex.h>
29 #include <linux/delay.h>
30 #include <linux/log2.h>
31 #include <linux/pci.h>
32 #include <linux/platform_device.h>
33 #include <linux/slab.h>
35 #define DRVNAME "i5k_amb"
37 #define I5K_REG_AMB_BASE_ADDR 0x48
38 #define I5K_REG_AMB_LEN_ADDR 0x50
39 #define I5K_REG_CHAN0_PRESENCE_ADDR 0x64
40 #define I5K_REG_CHAN1_PRESENCE_ADDR 0x66
42 #define AMB_REG_TEMP_MIN_ADDR 0x80
43 #define AMB_REG_TEMP_MID_ADDR 0x81
44 #define AMB_REG_TEMP_MAX_ADDR 0x82
45 #define AMB_REG_TEMP_STATUS_ADDR 0x84
46 #define AMB_REG_TEMP_ADDR 0x85
48 #define AMB_CONFIG_SIZE 2048
49 #define AMB_FUNC_3_OFFSET 768
51 static unsigned long amb_reg_temp_status(unsigned int amb)
53 return AMB_FUNC_3_OFFSET + AMB_REG_TEMP_STATUS_ADDR +
54 AMB_CONFIG_SIZE * amb;
57 static unsigned long amb_reg_temp_min(unsigned int amb)
59 return AMB_FUNC_3_OFFSET + AMB_REG_TEMP_MIN_ADDR +
60 AMB_CONFIG_SIZE * amb;
63 static unsigned long amb_reg_temp_mid(unsigned int amb)
65 return AMB_FUNC_3_OFFSET + AMB_REG_TEMP_MID_ADDR +
66 AMB_CONFIG_SIZE * amb;
69 static unsigned long amb_reg_temp_max(unsigned int amb)
71 return AMB_FUNC_3_OFFSET + AMB_REG_TEMP_MAX_ADDR +
72 AMB_CONFIG_SIZE * amb;
75 static unsigned long amb_reg_temp(unsigned int amb)
77 return AMB_FUNC_3_OFFSET + AMB_REG_TEMP_ADDR +
78 AMB_CONFIG_SIZE * amb;
81 #define MAX_MEM_CHANNELS 4
82 #define MAX_AMBS_PER_CHANNEL 16
83 #define MAX_AMBS (MAX_MEM_CHANNELS * \
85 #define CHANNEL_SHIFT 4
88 * Ugly hack: For some reason the highest bit is set if there
89 * are _any_ DIMMs in the channel. Attempting to read from
90 * this "high-order" AMB results in a memory bus error, so
91 * for now we'll just ignore that top bit, even though that
92 * might prevent us from seeing the 16th DIMM in the channel.
94 #define REAL_MAX_AMBS_PER_CHANNEL 15
95 #define KNOBS_PER_AMB 6
97 static unsigned long amb_num_from_reg(unsigned int byte_num, unsigned int bit)
99 return byte_num * MAX_AMBS_PER_CHANNEL + bit;
102 #define AMB_SYSFS_NAME_LEN 16
103 struct i5k_device_attribute {
104 struct sensor_device_attribute s_attr;
105 char name[AMB_SYSFS_NAME_LEN];
108 struct i5k_amb_data {
109 struct device *hwmon_dev;
111 unsigned long amb_base;
112 unsigned long amb_len;
113 u16 amb_present[MAX_MEM_CHANNELS];
114 void __iomem *amb_mmio;
115 struct i5k_device_attribute *attrs;
116 unsigned int num_attrs;
117 unsigned long chipset_id;
120 static ssize_t show_name(struct device *dev, struct device_attribute *devattr,
123 return sprintf(buf, "%s\n", DRVNAME);
127 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
129 static struct platform_device *amb_pdev;
131 static u8 amb_read_byte(struct i5k_amb_data *data, unsigned long offset)
133 return ioread8(data->amb_mmio + offset);
136 static void amb_write_byte(struct i5k_amb_data *data, unsigned long offset,
139 iowrite8(val, data->amb_mmio + offset);
142 static ssize_t show_amb_alarm(struct device *dev,
143 struct device_attribute *devattr,
146 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
147 struct i5k_amb_data *data = dev_get_drvdata(dev);
149 if (!(amb_read_byte(data, amb_reg_temp_status(attr->index)) & 0x20) &&
150 (amb_read_byte(data, amb_reg_temp_status(attr->index)) & 0x8))
151 return sprintf(buf, "1\n");
153 return sprintf(buf, "0\n");
156 static ssize_t store_amb_min(struct device *dev,
157 struct device_attribute *devattr,
161 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
162 struct i5k_amb_data *data = dev_get_drvdata(dev);
163 unsigned long temp = simple_strtoul(buf, NULL, 10) / 500;
168 amb_write_byte(data, amb_reg_temp_min(attr->index), temp);
172 static ssize_t store_amb_mid(struct device *dev,
173 struct device_attribute *devattr,
177 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
178 struct i5k_amb_data *data = dev_get_drvdata(dev);
179 unsigned long temp = simple_strtoul(buf, NULL, 10) / 500;
184 amb_write_byte(data, amb_reg_temp_mid(attr->index), temp);
188 static ssize_t store_amb_max(struct device *dev,
189 struct device_attribute *devattr,
193 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
194 struct i5k_amb_data *data = dev_get_drvdata(dev);
195 unsigned long temp = simple_strtoul(buf, NULL, 10) / 500;
200 amb_write_byte(data, amb_reg_temp_max(attr->index), temp);
204 static ssize_t show_amb_min(struct device *dev,
205 struct device_attribute *devattr,
208 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
209 struct i5k_amb_data *data = dev_get_drvdata(dev);
210 return sprintf(buf, "%d\n",
211 500 * amb_read_byte(data, amb_reg_temp_min(attr->index)));
214 static ssize_t show_amb_mid(struct device *dev,
215 struct device_attribute *devattr,
218 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
219 struct i5k_amb_data *data = dev_get_drvdata(dev);
220 return sprintf(buf, "%d\n",
221 500 * amb_read_byte(data, amb_reg_temp_mid(attr->index)));
224 static ssize_t show_amb_max(struct device *dev,
225 struct device_attribute *devattr,
228 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
229 struct i5k_amb_data *data = dev_get_drvdata(dev);
230 return sprintf(buf, "%d\n",
231 500 * amb_read_byte(data, amb_reg_temp_max(attr->index)));
234 static ssize_t show_amb_temp(struct device *dev,
235 struct device_attribute *devattr,
238 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
239 struct i5k_amb_data *data = dev_get_drvdata(dev);
240 return sprintf(buf, "%d\n",
241 500 * amb_read_byte(data, amb_reg_temp(attr->index)));
244 static ssize_t show_label(struct device *dev,
245 struct device_attribute *devattr,
248 struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
250 return sprintf(buf, "Ch. %d DIMM %d\n", attr->index >> CHANNEL_SHIFT,
251 attr->index & DIMM_MASK);
254 static int __devinit i5k_amb_hwmon_init(struct platform_device *pdev)
260 struct i5k_amb_data *data = platform_get_drvdata(pdev);
262 /* Count the number of AMBs found */
263 /* ignore the high-order bit, see "Ugly hack" comment above */
264 for (i = 0; i < MAX_MEM_CHANNELS; i++)
265 num_ambs += hweight16(data->amb_present[i] & 0x7fff);
267 /* Set up sysfs stuff */
268 data->attrs = kzalloc(sizeof(*data->attrs) * num_ambs * KNOBS_PER_AMB,
274 for (i = 0; i < MAX_MEM_CHANNELS; i++) {
275 c = data->amb_present[i];
276 for (j = 0; j < REAL_MAX_AMBS_PER_CHANNEL; j++, c >>= 1) {
277 struct i5k_device_attribute *iattr;
279 k = amb_num_from_reg(i, j);
285 iattr = data->attrs + data->num_attrs;
286 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
288 iattr->s_attr.dev_attr.attr.name = iattr->name;
289 iattr->s_attr.dev_attr.attr.mode = S_IRUGO;
290 iattr->s_attr.dev_attr.show = show_label;
291 iattr->s_attr.index = k;
292 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
293 res = device_create_file(&pdev->dev,
294 &iattr->s_attr.dev_attr);
299 /* Temperature sysfs knob */
300 iattr = data->attrs + data->num_attrs;
301 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
303 iattr->s_attr.dev_attr.attr.name = iattr->name;
304 iattr->s_attr.dev_attr.attr.mode = S_IRUGO;
305 iattr->s_attr.dev_attr.show = show_amb_temp;
306 iattr->s_attr.index = k;
307 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
308 res = device_create_file(&pdev->dev,
309 &iattr->s_attr.dev_attr);
314 /* Temperature min sysfs knob */
315 iattr = data->attrs + data->num_attrs;
316 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
318 iattr->s_attr.dev_attr.attr.name = iattr->name;
319 iattr->s_attr.dev_attr.attr.mode = S_IWUSR | S_IRUGO;
320 iattr->s_attr.dev_attr.show = show_amb_min;
321 iattr->s_attr.dev_attr.store = store_amb_min;
322 iattr->s_attr.index = k;
323 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
324 res = device_create_file(&pdev->dev,
325 &iattr->s_attr.dev_attr);
330 /* Temperature mid sysfs knob */
331 iattr = data->attrs + data->num_attrs;
332 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
334 iattr->s_attr.dev_attr.attr.name = iattr->name;
335 iattr->s_attr.dev_attr.attr.mode = S_IWUSR | S_IRUGO;
336 iattr->s_attr.dev_attr.show = show_amb_mid;
337 iattr->s_attr.dev_attr.store = store_amb_mid;
338 iattr->s_attr.index = k;
339 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
340 res = device_create_file(&pdev->dev,
341 &iattr->s_attr.dev_attr);
346 /* Temperature max sysfs knob */
347 iattr = data->attrs + data->num_attrs;
348 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
350 iattr->s_attr.dev_attr.attr.name = iattr->name;
351 iattr->s_attr.dev_attr.attr.mode = S_IWUSR | S_IRUGO;
352 iattr->s_attr.dev_attr.show = show_amb_max;
353 iattr->s_attr.dev_attr.store = store_amb_max;
354 iattr->s_attr.index = k;
355 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
356 res = device_create_file(&pdev->dev,
357 &iattr->s_attr.dev_attr);
362 /* Temperature alarm sysfs knob */
363 iattr = data->attrs + data->num_attrs;
364 snprintf(iattr->name, AMB_SYSFS_NAME_LEN,
366 iattr->s_attr.dev_attr.attr.name = iattr->name;
367 iattr->s_attr.dev_attr.attr.mode = S_IRUGO;
368 iattr->s_attr.dev_attr.show = show_amb_alarm;
369 iattr->s_attr.index = k;
370 sysfs_attr_init(&iattr->s_attr.dev_attr.attr);
371 res = device_create_file(&pdev->dev,
372 &iattr->s_attr.dev_attr);
379 res = device_create_file(&pdev->dev, &dev_attr_name);
383 data->hwmon_dev = hwmon_device_register(&pdev->dev);
384 if (IS_ERR(data->hwmon_dev)) {
385 res = PTR_ERR(data->hwmon_dev);
392 device_remove_file(&pdev->dev, &dev_attr_name);
393 for (i = 0; i < data->num_attrs; i++)
394 device_remove_file(&pdev->dev, &data->attrs[i].s_attr.dev_attr);
400 static int __devinit i5k_amb_add(void)
404 /* only ever going to be one of these */
405 amb_pdev = platform_device_alloc(DRVNAME, 0);
409 res = platform_device_add(amb_pdev);
415 platform_device_put(amb_pdev);
419 static int __devinit i5k_find_amb_registers(struct i5k_amb_data *data,
422 struct pci_dev *pcidev;
426 /* Find AMB register memory space */
427 pcidev = pci_get_device(PCI_VENDOR_ID_INTEL,
433 if (pci_read_config_dword(pcidev, I5K_REG_AMB_BASE_ADDR, &val32))
435 data->amb_base = val32;
437 if (pci_read_config_dword(pcidev, I5K_REG_AMB_LEN_ADDR, &val32))
439 data->amb_len = val32;
441 /* Is it big enough? */
442 if (data->amb_len < AMB_CONFIG_SIZE * MAX_AMBS) {
443 dev_err(&pcidev->dev, "AMB region too small!\n");
447 data->chipset_id = devid;
455 static int __devinit i5k_channel_probe(u16 *amb_present, unsigned long dev_id)
457 struct pci_dev *pcidev;
461 /* Copy the DIMM presence map for these two channels */
462 pcidev = pci_get_device(PCI_VENDOR_ID_INTEL, dev_id, NULL);
466 if (pci_read_config_word(pcidev, I5K_REG_CHAN0_PRESENCE_ADDR, &val16))
468 amb_present[0] = val16;
470 if (pci_read_config_word(pcidev, I5K_REG_CHAN1_PRESENCE_ADDR, &val16))
472 amb_present[1] = val16;
481 static unsigned long i5k_channel_pci_id(struct i5k_amb_data *data,
482 unsigned long channel)
484 switch (data->chipset_id) {
485 case PCI_DEVICE_ID_INTEL_5000_ERR:
486 return PCI_DEVICE_ID_INTEL_5000_FBD0 + channel;
487 case PCI_DEVICE_ID_INTEL_5400_ERR:
488 return PCI_DEVICE_ID_INTEL_5400_FBD0 + channel;
494 static unsigned long chipset_ids[] = {
495 PCI_DEVICE_ID_INTEL_5000_ERR,
496 PCI_DEVICE_ID_INTEL_5400_ERR,
500 static struct pci_device_id i5k_amb_ids[] __devinitdata = {
501 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5000_ERR) },
502 { PCI_DEVICE(PCI_VENDOR_ID_INTEL, PCI_DEVICE_ID_INTEL_5400_ERR) },
505 MODULE_DEVICE_TABLE(pci, i5k_amb_ids);
507 static int __devinit i5k_amb_probe(struct platform_device *pdev)
509 struct i5k_amb_data *data;
510 struct resource *reso;
514 data = kzalloc(sizeof(*data), GFP_KERNEL);
518 /* Figure out where the AMB registers live */
521 res = i5k_find_amb_registers(data, chipset_ids[i]);
523 } while (res && chipset_ids[i]);
528 /* Copy the DIMM presence map for the first two channels */
529 res = i5k_channel_probe(&data->amb_present[0],
530 i5k_channel_pci_id(data, 0));
534 /* Copy the DIMM presence map for the optional second two channels */
535 i5k_channel_probe(&data->amb_present[2],
536 i5k_channel_pci_id(data, 1));
538 /* Set up resource regions */
539 reso = request_mem_region(data->amb_base, data->amb_len, DRVNAME);
545 data->amb_mmio = ioremap_nocache(data->amb_base, data->amb_len);
546 if (!data->amb_mmio) {
551 platform_set_drvdata(pdev, data);
553 res = i5k_amb_hwmon_init(pdev);
555 goto err_init_failed;
560 iounmap(data->amb_mmio);
561 platform_set_drvdata(pdev, NULL);
563 release_mem_region(data->amb_base, data->amb_len);
569 static int __devexit i5k_amb_remove(struct platform_device *pdev)
572 struct i5k_amb_data *data = platform_get_drvdata(pdev);
574 hwmon_device_unregister(data->hwmon_dev);
575 device_remove_file(&pdev->dev, &dev_attr_name);
576 for (i = 0; i < data->num_attrs; i++)
577 device_remove_file(&pdev->dev, &data->attrs[i].s_attr.dev_attr);
579 iounmap(data->amb_mmio);
580 release_mem_region(data->amb_base, data->amb_len);
581 platform_set_drvdata(pdev, NULL);
586 static struct platform_driver i5k_amb_driver = {
588 .owner = THIS_MODULE,
591 .probe = i5k_amb_probe,
592 .remove = __devexit_p(i5k_amb_remove),
595 static int __init i5k_amb_init(void)
599 res = platform_driver_register(&i5k_amb_driver);
605 platform_driver_unregister(&i5k_amb_driver);
610 static void __exit i5k_amb_exit(void)
612 platform_device_unregister(amb_pdev);
613 platform_driver_unregister(&i5k_amb_driver);
616 MODULE_AUTHOR("Darrick J. Wong <djwong@us.ibm.com>");
617 MODULE_DESCRIPTION("Intel 5000 chipset FB-DIMM AMB temperature sensor");
618 MODULE_LICENSE("GPL");
620 module_init(i5k_amb_init);
621 module_exit(i5k_amb_exit);