drivers/hwmon/smsc47b397.c

   1 /*
   2     smsc47b397.c - Part of lm_sensors, Linux kernel modules
   3                         for hardware monitoring
   4
   5     Supports the SMSC LPC47B397-NC Super-I/O chip.
   6
   7     Author/Maintainer: Mark M. Hoffman <mhoffman@lightlink.com>
   8         Copyright (C) 2004 Utilitek Systems, Inc.
   9
  10     derived in part from smsc47m1.c:
  11         Copyright (C) 2002 Mark D. Studebaker <mdsxyz123@yahoo.com>
  12         Copyright (C) 2004 Jean Delvare <khali@linux-fr.org>
  13
  14     This program is free software; you can redistribute it and/or modify
  15     it under the terms of the GNU General Public License as published by
  16     the Free Software Foundation; either version 2 of the License, or
  17     (at your option) any later version.
  18
  19     This program is distributed in the hope that it will be useful,
  20     but WITHOUT ANY WARRANTY; without even the implied warranty of
  21     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22     GNU General Public License for more details.
  23
  24     You should have received a copy of the GNU General Public License
  25     along with this program; if not, write to the Free Software
  26     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  27 */
  28
  29 #include <linux/module.h>
  30 #include <linux/slab.h>
  31 #include <linux/ioport.h>
  32 #include <linux/jiffies.h>
  33 #include <linux/platform_device.h>
  34 #include <linux/hwmon.h>
  35 #include <linux/hwmon-sysfs.h>
  36 #include <linux/err.h>
  37 #include <linux/init.h>
  38 #include <linux/mutex.h>
  39 #include <asm/io.h>
  40
  41 static unsigned short force_id;
  42 module_param(force_id, ushort, 0);
  43 MODULE_PARM_DESC(force_id, "Override the detected device ID");
  44
  45 static struct platform_device *pdev;
  46
  47 #define DRVNAME "smsc47b397"
  48
  49 /* Super-I/0 registers and commands */
  50
  51 #define REG     0x2e    /* The register to read/write */
  52 #define VAL     0x2f    /* The value to read/write */
  53
  54 static inline void superio_outb(int reg, int val)
  55 {
  56         outb(reg, REG);
  57         outb(val, VAL);
  58 }
  59
  60 static inline int superio_inb(int reg)
  61 {
  62         outb(reg, REG);
  63         return inb(VAL);
  64 }
  65
  66 /* select superio logical device */
  67 static inline void superio_select(int ld)
  68 {
  69         superio_outb(0x07, ld);
  70 }
  71
  72 static inline void superio_enter(void)
  73 {
  74         outb(0x55, REG);
  75 }
  76
  77 static inline void superio_exit(void)
  78 {
  79         outb(0xAA, REG);
  80 }
  81
  82 #define SUPERIO_REG_DEVID       0x20
  83 #define SUPERIO_REG_DEVREV      0x21
  84 #define SUPERIO_REG_BASE_MSB    0x60
  85 #define SUPERIO_REG_BASE_LSB    0x61
  86 #define SUPERIO_REG_LD8         0x08
  87
  88 #define SMSC_EXTENT             0x02
  89
  90 /* 0 <= nr <= 3 */
  91 static u8 smsc47b397_reg_temp[] = {0x25, 0x26, 0x27, 0x80};
  92 #define SMSC47B397_REG_TEMP(nr) (smsc47b397_reg_temp[(nr)])
  93
  94 /* 0 <= nr <= 3 */
  95 #define SMSC47B397_REG_FAN_LSB(nr) (0x28 + 2 * (nr))
  96 #define SMSC47B397_REG_FAN_MSB(nr) (0x29 + 2 * (nr))
  97
  98 struct smsc47b397_data {
  99         unsigned short addr;
 100         const char *name;
 101         struct device *hwmon_dev;
 102         struct mutex lock;
 103
 104         struct mutex update_lock;
 105         unsigned long last_updated; /* in jiffies */
 106         int valid;
 107
 108         /* register values */
 109         u16 fan[4];
 110         u8 temp[4];
 111 };
 112
 113 static int smsc47b397_read_value(struct smsc47b397_data* data, u8 reg)
 114 {
 115         int res;
 116
 117         mutex_lock(&data->lock);
 118         outb(reg, data->addr);
 119         res = inb_p(data->addr + 1);
 120         mutex_unlock(&data->lock);
 121         return res;
 122 }
 123
 124 static struct smsc47b397_data *smsc47b397_update_device(struct device *dev)
 125 {
 126         struct smsc47b397_data *data = dev_get_drvdata(dev);
 127         int i;
 128
 129         mutex_lock(&data->update_lock);
 130
 131         if (time_after(jiffies, data->last_updated + HZ) || !data->valid) {
 132                 dev_dbg(dev, "starting device update...\n");
 133
 134                 /* 4 temperature inputs, 4 fan inputs */
 135                 for (i = 0; i < 4; i++) {
 136                         data->temp[i] = smsc47b397_read_value(data,
 137                                         SMSC47B397_REG_TEMP(i));
 138
 139                         /* must read LSB first */
 140                         data->fan[i]  = smsc47b397_read_value(data,
 141                                         SMSC47B397_REG_FAN_LSB(i));
 142                         data->fan[i] |= smsc47b397_read_value(data,
 143                                         SMSC47B397_REG_FAN_MSB(i)) << 8;
 144                 }
 145
 146                 data->last_updated = jiffies;
 147                 data->valid = 1;
 148
 149                 dev_dbg(dev, "... device update complete\n");
 150         }
 151
 152         mutex_unlock(&data->update_lock);
 153
 154         return data;
 155 }
 156
 157 /* TEMP: 0.001C/bit (-128C to +127C)
 158    REG: 1C/bit, two's complement */
 159 static int temp_from_reg(u8 reg)
 160 {
 161         return (s8)reg * 1000;
 162 }
 163
 164 static ssize_t show_temp(struct device *dev, struct device_attribute
 165                          *devattr, char *buf)
 166 {
 167         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 168         struct smsc47b397_data *data = smsc47b397_update_device(dev);
 169         return sprintf(buf, "%d\n", temp_from_reg(data->temp[attr->index]));
 170 }
 171
 172 static SENSOR_DEVICE_ATTR(temp1_input, S_IRUGO, show_temp, NULL, 0);
 173 static SENSOR_DEVICE_ATTR(temp2_input, S_IRUGO, show_temp, NULL, 1);
 174 static SENSOR_DEVICE_ATTR(temp3_input, S_IRUGO, show_temp, NULL, 2);
 175 static SENSOR_DEVICE_ATTR(temp4_input, S_IRUGO, show_temp, NULL, 3);
 176
 177 /* FAN: 1 RPM/bit
 178    REG: count of 90kHz pulses / revolution */
 179 static int fan_from_reg(u16 reg)
 180 {
 181         if (reg == 0 || reg == 0xffff)
 182                 return 0;
 183         return 90000 * 60 / reg;
 184 }
 185
 186 static ssize_t show_fan(struct device *dev, struct device_attribute
 187                         *devattr, char *buf)
 188 {
 189         struct sensor_device_attribute *attr = to_sensor_dev_attr(devattr);
 190         struct smsc47b397_data *data = smsc47b397_update_device(dev);
 191         return sprintf(buf, "%d\n", fan_from_reg(data->fan[attr->index]));
 192 }
 193 static SENSOR_DEVICE_ATTR(fan1_input, S_IRUGO, show_fan, NULL, 0);
 194 static SENSOR_DEVICE_ATTR(fan2_input, S_IRUGO, show_fan, NULL, 1);
 195 static SENSOR_DEVICE_ATTR(fan3_input, S_IRUGO, show_fan, NULL, 2);
 196 static SENSOR_DEVICE_ATTR(fan4_input, S_IRUGO, show_fan, NULL, 3);
 197
 198 static ssize_t show_name(struct device *dev, struct device_attribute
 199                          *devattr, char *buf)
 200 {
 201         struct smsc47b397_data *data = dev_get_drvdata(dev);
 202         return sprintf(buf, "%s\n", data->name);
 203 }
 204 static DEVICE_ATTR(name, S_IRUGO, show_name, NULL);
 205
 206 static struct attribute *smsc47b397_attributes[] = {
 207         &sensor_dev_attr_temp1_input.dev_attr.attr,
 208         &sensor_dev_attr_temp2_input.dev_attr.attr,
 209         &sensor_dev_attr_temp3_input.dev_attr.attr,
 210         &sensor_dev_attr_temp4_input.dev_attr.attr,
 211         &sensor_dev_attr_fan1_input.dev_attr.attr,
 212         &sensor_dev_attr_fan2_input.dev_attr.attr,
 213         &sensor_dev_attr_fan3_input.dev_attr.attr,
 214         &sensor_dev_attr_fan4_input.dev_attr.attr,
 215
 216         &dev_attr_name.attr,
 217         NULL
 218 };
 219
 220 static const struct attribute_group smsc47b397_group = {
 221         .attrs = smsc47b397_attributes,
 222 };
 223
 224 static int __devexit smsc47b397_remove(struct platform_device *pdev)
 225 {
 226         struct smsc47b397_data *data = platform_get_drvdata(pdev);
 227         struct resource *res;
 228
 229         hwmon_device_unregister(data->hwmon_dev);
 230         sysfs_remove_group(&pdev->dev.kobj, &smsc47b397_group);
 231         res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 232         release_region(res->start, SMSC_EXTENT);
 233         kfree(data);
 234
 235         return 0;
 236 }
 237
 238 static int smsc47b397_probe(struct platform_device *pdev);
 239
 240 static struct platform_driver smsc47b397_driver = {
 241         .driver = {
 242                 .owner  = THIS_MODULE,
 243                 .name   = DRVNAME,
 244         },
 245         .probe          = smsc47b397_probe,
 246         .remove         = __devexit_p(smsc47b397_remove),
 247 };
 248
 249 static int __devinit smsc47b397_probe(struct platform_device *pdev)
 250 {
 251         struct device *dev = &pdev->dev;
 252         struct smsc47b397_data *data;
 253         struct resource *res;
 254         int err = 0;
 255
 256         res = platform_get_resource(pdev, IORESOURCE_IO, 0);
 257         if (!request_region(res->start, SMSC_EXTENT,
 258                             smsc47b397_driver.driver.name)) {
 259                 dev_err(dev, "Region 0x%lx-0x%lx already in use!\n",
 260                         (unsigned long)res->start,
 261                         (unsigned long)res->start + SMSC_EXTENT - 1);
 262                 return -EBUSY;
 263         }
 264
 265         if (!(data = kzalloc(sizeof(struct smsc47b397_data), GFP_KERNEL))) {
 266                 err = -ENOMEM;
 267                 goto error_release;
 268         }
 269
 270         data->addr = res->start;
 271         data->name = "smsc47b397";
 272         mutex_init(&data->lock);
 273         mutex_init(&data->update_lock);
 274         platform_set_drvdata(pdev, data);
 275
 276         if ((err = sysfs_create_group(&dev->kobj, &smsc47b397_group)))
 277                 goto error_free;
 278
 279         data->hwmon_dev = hwmon_device_register(dev);
 280         if (IS_ERR(data->hwmon_dev)) {
 281                 err = PTR_ERR(data->hwmon_dev);
 282                 goto error_remove;
 283         }
 284
 285         return 0;
 286
 287 error_remove:
 288         sysfs_remove_group(&dev->kobj, &smsc47b397_group);
 289 error_free:
 290         kfree(data);
 291 error_release:
 292         release_region(res->start, SMSC_EXTENT);
 293         return err;
 294 }
 295
 296 static int __init smsc47b397_device_add(unsigned short address)
 297 {
 298         struct resource res = {
 299                 .start  = address,
 300                 .end    = address + SMSC_EXTENT - 1,
 301                 .name   = DRVNAME,
 302                 .flags  = IORESOURCE_IO,
 303         };
 304         int err;
 305
 306         pdev = platform_device_alloc(DRVNAME, address);
 307         if (!pdev) {
 308                 err = -ENOMEM;
 309                 printk(KERN_ERR DRVNAME ": Device allocation failed\n");
 310                 goto exit;
 311         }
 312
 313         err = platform_device_add_resources(pdev, &res, 1);
 314         if (err) {
 315                 printk(KERN_ERR DRVNAME ": Device resource addition failed "
 316                        "(%d)\n", err);
 317                 goto exit_device_put;
 318         }
 319
 320         err = platform_device_add(pdev);
 321         if (err) {
 322                 printk(KERN_ERR DRVNAME ": Device addition failed (%d)\n",
 323                        err);
 324                 goto exit_device_put;
 325         }
 326
 327         return 0;
 328
 329 exit_device_put:
 330         platform_device_put(pdev);
 331 exit:
 332         return err;
 333 }
 334
 335 static int __init smsc47b397_find(unsigned short *addr)
 336 {
 337         u8 id, rev;
 338
 339         superio_enter();
 340         id = force_id ? force_id : superio_inb(SUPERIO_REG_DEVID);
 341
 342         if ((id != 0x6f) && (id != 0x81) && (id != 0x85)) {
 343                 superio_exit();
 344                 return -ENODEV;
 345         }
 346
 347         rev = superio_inb(SUPERIO_REG_DEVREV);
 348
 349         superio_select(SUPERIO_REG_LD8);
 350         *addr = (superio_inb(SUPERIO_REG_BASE_MSB) << 8)
 351                  |  superio_inb(SUPERIO_REG_BASE_LSB);
 352
 353         printk(KERN_INFO DRVNAME ": found SMSC %s "
 354                 "(base address 0x%04x, revision %u)\n",
 355                 id == 0x81 ? "SCH5307-NS" : id == 0x85 ? "SCH5317" :
 356                "LPC47B397-NC", *addr, rev);
 357
 358         superio_exit();
 359         return 0;
 360 }
 361
 362 static int __init smsc47b397_init(void)
 363 {
 364         unsigned short address;
 365         int ret;
 366
 367         if ((ret = smsc47b397_find(&address)))
 368                 return ret;
 369
 370         ret = platform_driver_register(&smsc47b397_driver);
 371         if (ret)
 372                 goto exit;
 373
 374         /* Sets global pdev as a side effect */
 375         ret = smsc47b397_device_add(address);
 376         if (ret)
 377                 goto exit_driver;
 378
 379         return 0;
 380
 381 exit_driver:
 382         platform_driver_unregister(&smsc47b397_driver);
 383 exit:
 384         return ret;
 385 }
 386
 387 static void __exit smsc47b397_exit(void)
 388 {
 389         platform_device_unregister(pdev);
 390         platform_driver_unregister(&smsc47b397_driver);
 391 }
 392
 393 MODULE_AUTHOR("Mark M. Hoffman <mhoffman@lightlink.com>");
 394 MODULE_DESCRIPTION("SMSC LPC47B397 driver");
 395 MODULE_LICENSE("GPL");
 396
 397 module_init(smsc47b397_init);
 398 module_exit(smsc47b397_exit);