drivers/hwmon/via686a.c

   1 /*
   2     via686a.c - Part of lm_sensors, Linux kernel modules
   3                 for hardware monitoring
   4
   5     Copyright (c) 1998 - 2002  Frodo Looijaard <frodol@dds.nl>,
   6                         Kyösti Mälkki <kmalkki@cc.hut.fi>,
   7                         Mark Studebaker <mdsxyz123@yahoo.com>,
   8                         and Bob Dougherty <bobd@stanford.edu>
   9     (Some conversion-factor data were contributed by Jonathan Teh Soon Yew
  10     <j.teh@iname.com> and Alex van Kaam <darkside@chello.nl>.)
  11
  12     This program is free software; you can redistribute it and/or modify
  13     it under the terms of the GNU General Public License as published by
  14     the Free Software Foundation; either version 2 of the License, or
  15     (at your option) any later version.
  16
  17     This program is distributed in the hope that it will be useful,
  18     but WITHOUT ANY WARRANTY; without even the implied warranty of
  19     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20     GNU General Public License for more details.
  21
  22     You should have received a copy of the GNU General Public License
  23     along with this program; if not, write to the Free Software
  24     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  25 */
  26
  27 /*
  28     Supports the Via VT82C686A, VT82C686B south bridges.
  29     Reports all as a 686A.
  30     Warning - only supports a single device.
  31 */
  32
  33 #include <linux/module.h>
  34 #include <linux/slab.h>
  35 #include <linux/pci.h>
  36 #include <linux/jiffies.h>
  37 #include <linux/i2c.h>
  38 #include <linux/i2c-isa.h>
  39 #include <linux/hwmon.h>
  40 #include <linux/err.h>
  41 #include <linux/init.h>
  42 #include <linux/mutex.h>
  43 #include <linux/sysfs.h>
  44 #include <asm/io.h>
  45
  46
  47 /* If force_addr is set to anything different from 0, we forcibly enable
  48    the device at the given address. */
  49 static unsigned short force_addr;
  50 module_param(force_addr, ushort, 0);
  51 MODULE_PARM_DESC(force_addr,
  52                  "Initialize the base address of the sensors");
  53
  54 /* Device address
  55    Note that we can't determine the ISA address until we have initialized
  56    our module */
  57 static unsigned short address;
  58
  59 /*
  60    The Via 686a southbridge has a LM78-like chip integrated on the same IC.
  61    This driver is a customized copy of lm78.c
  62 */
  63
  64 /* Many VIA686A constants specified below */
  65
  66 /* Length of ISA address segment */
  67 #define VIA686A_EXTENT          0x80
  68 #define VIA686A_BASE_REG        0x70
  69 #define VIA686A_ENABLE_REG      0x74
  70
  71 /* The VIA686A registers */
  72 /* ins numbered 0-4 */
  73 #define VIA686A_REG_IN_MAX(nr)  (0x2b + ((nr) * 2))
  74 #define VIA686A_REG_IN_MIN(nr)  (0x2c + ((nr) * 2))
  75 #define VIA686A_REG_IN(nr)      (0x22 + (nr))
  76
  77 /* fans numbered 1-2 */
  78 #define VIA686A_REG_FAN_MIN(nr) (0x3a + (nr))
  79 #define VIA686A_REG_FAN(nr)     (0x28 + (nr))
  80
  81 /* temps numbered 1-3 */
  82 static const u8 VIA686A_REG_TEMP[]      = { 0x20, 0x21, 0x1f };
  83 static const u8 VIA686A_REG_TEMP_OVER[] = { 0x39, 0x3d, 0x1d };
  84 static const u8 VIA686A_REG_TEMP_HYST[] = { 0x3a, 0x3e, 0x1e };
  85 /* bits 7-6 */
  86 #define VIA686A_REG_TEMP_LOW1   0x4b
  87 /* 2 = bits 5-4, 3 = bits 7-6 */
  88 #define VIA686A_REG_TEMP_LOW23  0x49
  89
  90 #define VIA686A_REG_ALARM1      0x41
  91 #define VIA686A_REG_ALARM2      0x42
  92 #define VIA686A_REG_FANDIV      0x47
  93 #define VIA686A_REG_CONFIG      0x40
  94 /* The following register sets temp interrupt mode (bits 1-0 for temp1,
  95  3-2 for temp2, 5-4 for temp3).  Modes are:
  96     00 interrupt stays as long as value is out-of-range
  97     01 interrupt is cleared once register is read (default)
  98     10 comparator mode- like 00, but ignores hysteresis
  99     11 same as 00 */
 100 #define VIA686A_REG_TEMP_MODE           0x4b
 101 /* We'll just assume that you want to set all 3 simultaneously: */
 102 #define VIA686A_TEMP_MODE_MASK          0x3F
 103 #define VIA686A_TEMP_MODE_CONTINUOUS    0x00
 104
 105 /* Conversions. Limit checking is only done on the TO_REG
 106    variants.
 107
 108 ********* VOLTAGE CONVERSIONS (Bob Dougherty) ********
 109  From HWMon.cpp (Copyright 1998-2000 Jonathan Teh Soon Yew):
 110  voltagefactor[0]=1.25/2628; (2628/1.25=2102.4)   // Vccp
 111  voltagefactor[1]=1.25/2628; (2628/1.25=2102.4)   // +2.5V
 112  voltagefactor[2]=1.67/2628; (2628/1.67=1573.7)   // +3.3V
 113  voltagefactor[3]=2.6/2628;  (2628/2.60=1010.8)   // +5V
 114  voltagefactor[4]=6.3/2628;  (2628/6.30=417.14)   // +12V
 115  in[i]=(data[i+2]*25.0+133)*voltagefactor[i];
 116  That is:
 117  volts = (25*regVal+133)*factor
 118  regVal = (volts/factor-133)/25
 119  (These conversions were contributed by Jonathan Teh Soon Yew
 120  <j.teh@iname.com>) */
 121 static inline u8 IN_TO_REG(long val, int inNum)
 122 {
 123         /* To avoid floating point, we multiply constants by 10 (100 for +12V).
 124            Rounding is done (120500 is actually 133000 - 12500).
 125            Remember that val is expressed in 0.001V/bit, which is why we divide
 126            by an additional 10000 (100000 for +12V): 1000 for val and 10 (100)
 127            for the constants. */
 128         if (inNum <= 1)
 129                 return (u8)
 130                     SENSORS_LIMIT((val * 21024 - 1205000) / 250000, 0, 255);
 131         else if (inNum == 2)
 132                 return (u8)
 133                     SENSORS_LIMIT((val * 15737 - 1205000) / 250000, 0, 255);
 134         else if (inNum == 3)
 135                 return (u8)
 136                     SENSORS_LIMIT((val * 10108 - 1205000) / 250000, 0, 255);
 137         else
 138                 return (u8)
 139                     SENSORS_LIMIT((val * 41714 - 12050000) / 2500000, 0, 255);
 140 }
 141
 142 static inline long IN_FROM_REG(u8 val, int inNum)
 143 {
 144         /* To avoid floating point, we multiply constants by 10 (100 for +12V).
 145            We also multiply them by 1000 because we want 0.001V/bit for the
 146            output value. Rounding is done. */
 147         if (inNum <= 1)
 148                 return (long) ((250000 * val + 1330000 + 21024 / 2) / 21024);
 149         else if (inNum == 2)
 150                 return (long) ((250000 * val + 1330000 + 15737 / 2) / 15737);
 151         else if (inNum == 3)
 152                 return (long) ((250000 * val + 1330000 + 10108 / 2) / 10108);
 153         else
 154                 return (long) ((2500000 * val + 13300000 + 41714 / 2) / 41714);
 155 }
 156
 157 /********* FAN RPM CONVERSIONS ********/
 158 /* Higher register values = slower fans (the fan's strobe gates a counter).
 159  But this chip saturates back at 0, not at 255 like all the other chips.
 160  So, 0 means 0 RPM */
 161 static inline u8 FAN_TO_REG(long rpm, int div)
 162 {
 163         if (rpm == 0)
 164                 return 0;
 165         rpm = SENSORS_LIMIT(rpm, 1, 1000000);
 166         return SENSORS_LIMIT((1350000 + rpm * div / 2) / (rpm * div), 1, 255);
 167 }
 168
 169 #define FAN_FROM_REG(val,div) ((val)==0?0:(val)==255?0:1350000/((val)*(div)))
 170
 171 /******** TEMP CONVERSIONS (Bob Dougherty) *********/
 172 /* linear fits from HWMon.cpp (Copyright 1998-2000 Jonathan Teh Soon Yew)
 173       if(temp<169)
 174               return double(temp)*0.427-32.08;
 175       else if(temp>=169 && temp<=202)
 176               return double(temp)*0.582-58.16;
 177       else
 178               return double(temp)*0.924-127.33;
 179
 180  A fifth-order polynomial fits the unofficial data (provided by Alex van
 181  Kaam <darkside@chello.nl>) a bit better.  It also give more reasonable
 182  numbers on my machine (ie. they agree with what my BIOS tells me).
 183  Here's the fifth-order fit to the 8-bit data:
 184  temp = 1.625093e-10*val^5 - 1.001632e-07*val^4 + 2.457653e-05*val^3 -
 185         2.967619e-03*val^2 + 2.175144e-01*val - 7.090067e+0.
 186
 187  (2000-10-25- RFD: thanks to Uwe Andersen <uandersen@mayah.com> for
 188  finding my typos in this formula!)
 189
 190  Alas, none of the elegant function-fit solutions will work because we
 191  aren't allowed to use floating point in the kernel and doing it with
 192  integers doesn't provide enough precision.  So we'll do boring old
 193  look-up table stuff.  The unofficial data (see below) have effectively
 194  7-bit resolution (they are rounded to the nearest degree).  I'm assuming
 195  that the transfer function of the device is monotonic and smooth, so a
 196  smooth function fit to the data will allow us to get better precision.
 197  I used the 5th-order poly fit described above and solved for
 198  VIA register values 0-255.  I *10 before rounding, so we get tenth-degree
 199  precision.  (I could have done all 1024 values for our 10-bit readings,
 200  but the function is very linear in the useful range (0-80 deg C), so
 201  we'll just use linear interpolation for 10-bit readings.)  So, tempLUT
 202  is the temp at via register values 0-255: */
 203 static const s16 tempLUT[] =
 204 { -709, -688, -667, -646, -627, -607, -589, -570, -553, -536, -519,
 205         -503, -487, -471, -456, -442, -428, -414, -400, -387, -375,
 206         -362, -350, -339, -327, -316, -305, -295, -285, -275, -265,
 207         -255, -246, -237, -229, -220, -212, -204, -196, -188, -180,
 208         -173, -166, -159, -152, -145, -139, -132, -126, -120, -114,
 209         -108, -102, -96, -91, -85, -80, -74, -69, -64, -59, -54, -49,
 210         -44, -39, -34, -29, -25, -20, -15, -11, -6, -2, 3, 7, 12, 16,
 211         20, 25, 29, 33, 37, 42, 46, 50, 54, 59, 63, 67, 71, 75, 79, 84,
 212         88, 92, 96, 100, 104, 109, 113, 117, 121, 125, 130, 134, 138,
 213         142, 146, 151, 155, 159, 163, 168, 172, 176, 181, 185, 189,
 214         193, 198, 202, 206, 211, 215, 219, 224, 228, 232, 237, 241,
 215         245, 250, 254, 259, 263, 267, 272, 276, 281, 285, 290, 294,
 216         299, 303, 307, 312, 316, 321, 325, 330, 334, 339, 344, 348,
 217         353, 357, 362, 366, 371, 376, 380, 385, 390, 395, 399, 404,
 218         409, 414, 419, 423, 428, 433, 438, 443, 449, 454, 459, 464,
 219         469, 475, 480, 486, 491, 497, 502, 508, 514, 520, 526, 532,
 220         538, 544, 551, 557, 564, 571, 578, 584, 592, 599, 606, 614,
 221         621, 629, 637, 645, 654, 662, 671, 680, 689, 698, 708, 718,
 222         728, 738, 749, 759, 770, 782, 793, 805, 818, 830, 843, 856,
 223         870, 883, 898, 912, 927, 943, 958, 975, 991, 1008, 1026, 1044,
 224         1062, 1081, 1101, 1121, 1141, 1162, 1184, 1206, 1229, 1252,
 225         1276, 1301, 1326, 1352, 1378, 1406, 1434, 1462
 226 };
 227
 228 /* the original LUT values from Alex van Kaam <darkside@chello.nl>
 229    (for via register values 12-240):
 230 {-50,-49,-47,-45,-43,-41,-39,-38,-37,-35,-34,-33,-32,-31,
 231 -30,-29,-28,-27,-26,-25,-24,-24,-23,-22,-21,-20,-20,-19,-18,-17,-17,-16,-15,
 232 -15,-14,-14,-13,-12,-12,-11,-11,-10,-9,-9,-8,-8,-7,-7,-6,-6,-5,-5,-4,-4,-3,
 233 -3,-2,-2,-1,-1,0,0,1,1,1,3,3,3,4,4,4,5,5,5,6,6,7,7,8,8,9,9,9,10,10,11,11,12,
 234 12,12,13,13,13,14,14,15,15,16,16,16,17,17,18,18,19,19,20,20,21,21,21,22,22,
 235 22,23,23,24,24,25,25,26,26,26,27,27,27,28,28,29,29,30,30,30,31,31,32,32,33,
 236 33,34,34,35,35,35,36,36,37,37,38,38,39,39,40,40,41,41,42,42,43,43,44,44,45,
 237 45,46,46,47,48,48,49,49,50,51,51,52,52,53,53,54,55,55,56,57,57,58,59,59,60,
 238 61,62,62,63,64,65,66,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,83,84,
 239 85,86,88,89,91,92,94,96,97,99,101,103,105,107,109,110};
 240
 241
 242  Here's the reverse LUT.  I got it by doing a 6-th order poly fit (needed
 243  an extra term for a good fit to these inverse data!) and then
 244  solving for each temp value from -50 to 110 (the useable range for
 245  this chip).  Here's the fit:
 246  viaRegVal = -1.160370e-10*val^6 +3.193693e-08*val^5 - 1.464447e-06*val^4
 247  - 2.525453e-04*val^3 + 1.424593e-02*val^2 + 2.148941e+00*val +7.275808e+01)
 248  Note that n=161: */
 249 static const u8 viaLUT[] =
 250 { 12, 12, 13, 14, 14, 15, 16, 16, 17, 18, 18, 19, 20, 20, 21, 22, 23,
 251         23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 35, 36, 37, 39, 40,
 252         41, 43, 45, 46, 48, 49, 51, 53, 55, 57, 59, 60, 62, 64, 66,
 253         69, 71, 73, 75, 77, 79, 82, 84, 86, 88, 91, 93, 95, 98, 100,
 254         103, 105, 107, 110, 112, 115, 117, 119, 122, 124, 126, 129,
 255         131, 134, 136, 138, 140, 143, 145, 147, 150, 152, 154, 156,
 256         158, 160, 162, 164, 166, 168, 170, 172, 174, 176, 178, 180,
 257         182, 183, 185, 187, 188, 190, 192, 193, 195, 196, 198, 199,
 258         200, 202, 203, 205, 206, 207, 208, 209, 210, 211, 212, 213,
 259         214, 215, 216, 217, 218, 219, 220, 221, 222, 222, 223, 224,
 260         225, 226, 226, 227, 228, 228, 229, 230, 230, 231, 232, 232,
 261         233, 233, 234, 235, 235, 236, 236, 237, 237, 238, 238, 239,
 262         239, 240
 263 };
 264
 265 /* Converting temps to (8-bit) hyst and over registers
 266    No interpolation here.
 267    The +50 is because the temps start at -50 */
 268 static inline u8 TEMP_TO_REG(long val)
 269 {
 270         return viaLUT[val <= -50000 ? 0 : val >= 110000 ? 160 :
 271                       (val < 0 ? val - 500 : val + 500) / 1000 + 50];
 272 }
 273
 274 /* for 8-bit temperature hyst and over registers */
 275 #define TEMP_FROM_REG(val)      ((long)tempLUT[val] * 100)
 276
 277 /* for 10-bit temperature readings */
 278 static inline long TEMP_FROM_REG10(u16 val)
 279 {
 280         u16 eightBits = val >> 2;
 281         u16 twoBits = val & 3;
 282
 283         /* no interpolation for these */
 284         if (twoBits == 0 || eightBits == 255)
 285                 return TEMP_FROM_REG(eightBits);
 286
 287         /* do some linear interpolation */
 288         return (tempLUT[eightBits] * (4 - twoBits) +
 289                 tempLUT[eightBits + 1] * twoBits) * 25;
 290 }
 291
 292 #define DIV_FROM_REG(val) (1 << (val))
 293 #define DIV_TO_REG(val) ((val)==8?3:(val)==4?2:(val)==1?0:1)
 294
 295 /* For the VIA686A, we need to keep some data in memory.
 296    The structure is dynamically allocated, at the same time when a new
 297    via686a client is allocated. */
 298 struct via686a_data {
 299         struct i2c_client client;
 300         struct class_device *class_dev;
 301         struct mutex update_lock;
 302         char valid;             /* !=0 if following fields are valid */
 303         unsigned long last_updated;     /* In jiffies */
 304
 305         u8 in[5];               /* Register value */
 306         u8 in_max[5];           /* Register value */
 307         u8 in_min[5];           /* Register value */
 308         u8 fan[2];              /* Register value */
 309         u8 fan_min[2];          /* Register value */
 310         u16 temp[3];            /* Register value 10 bit */
 311         u8 temp_over[3];        /* Register value */
 312         u8 temp_hyst[3];        /* Register value */
 313         u8 fan_div[2];          /* Register encoding, shifted right */
 314         u16 alarms;             /* Register encoding, combined */
 315 };
 316
 317 static struct pci_dev *s_bridge;        /* pointer to the (only) via686a */
 318
 319 static int via686a_detect(struct i2c_adapter *adapter);
 320 static int via686a_detach_client(struct i2c_client *client);
 321
 322 static inline int via686a_read_value(struct i2c_client *client, u8 reg)
 323 {
 324         return (inb_p(client->addr + reg));
 325 }
 326
 327 static inline void via686a_write_value(struct i2c_client *client, u8 reg,
 328                                        u8 value)
 329 {
 330         outb_p(value, client->addr + reg);
 331 }
 332
 333 static struct via686a_data *via686a_update_device(struct device *dev);
 334 static void via686a_init_client(struct i2c_client *client);
 335
 336 /* following are the sysfs callback functions */
 337
 338 /* 7 voltage sensors */
 339 static ssize_t show_in(struct device *dev, char *buf, int nr) {
 340         struct via686a_data *data = via686a_update_device(dev);
 341         return sprintf(buf, "%ld\n", IN_FROM_REG(data->in[nr], nr));
 342 }
 343
 344 static ssize_t show_in_min(struct device *dev, char *buf, int nr) {
 345         struct via686a_data *data = via686a_update_device(dev);
 346         return sprintf(buf, "%ld\n", IN_FROM_REG(data->in_min[nr], nr));
 347 }
 348
 349 static ssize_t show_in_max(struct device *dev, char *buf, int nr) {
 350         struct via686a_data *data = via686a_update_device(dev);
 351         return sprintf(buf, "%ld\n", IN_FROM_REG(data->in_max[nr], nr));
 352 }
 353
 354 static ssize_t set_in_min(struct device *dev, const char *buf,
 355                 size_t count, int nr) {
 356         struct i2c_client *client = to_i2c_client(dev);
 357         struct via686a_data *data = i2c_get_clientdata(client);
 358         unsigned long val = simple_strtoul(buf, NULL, 10);
 359
 360         mutex_lock(&data->update_lock);
 361         data->in_min[nr] = IN_TO_REG(val, nr);
 362         via686a_write_value(client, VIA686A_REG_IN_MIN(nr),
 363                         data->in_min[nr]);
 364         mutex_unlock(&data->update_lock);
 365         return count;
 366 }
 367 static ssize_t set_in_max(struct device *dev, const char *buf,
 368                 size_t count, int nr) {
 369         struct i2c_client *client = to_i2c_client(dev);
 370         struct via686a_data *data = i2c_get_clientdata(client);
 371         unsigned long val = simple_strtoul(buf, NULL, 10);
 372
 373         mutex_lock(&data->update_lock);
 374         data->in_max[nr] = IN_TO_REG(val, nr);
 375         via686a_write_value(client, VIA686A_REG_IN_MAX(nr),
 376                         data->in_max[nr]);
 377         mutex_unlock(&data->update_lock);
 378         return count;
 379 }
 380 #define show_in_offset(offset)                                  \
 381 static ssize_t                                                  \
 382         show_in##offset (struct device *dev, struct device_attribute *attr, char *buf)          \
 383 {                                                               \
 384         return show_in(dev, buf, offset);                       \
 385 }                                                               \
 386 static ssize_t                                                  \
 387         show_in##offset##_min (struct device *dev, struct device_attribute *attr, char *buf)    \
 388 {                                                               \
 389         return show_in_min(dev, buf, offset);           \
 390 }                                                               \
 391 static ssize_t                                                  \
 392         show_in##offset##_max (struct device *dev, struct device_attribute *attr, char *buf)    \
 393 {                                                               \
 394         return show_in_max(dev, buf, offset);           \
 395 }                                                               \
 396 static ssize_t set_in##offset##_min (struct device *dev, struct device_attribute *attr,         \
 397                 const char *buf, size_t count)                  \
 398 {                                                               \
 399         return set_in_min(dev, buf, count, offset);             \
 400 }                                                               \
 401 static ssize_t set_in##offset##_max (struct device *dev, struct device_attribute *attr, \
 402                         const char *buf, size_t count)          \
 403 {                                                               \
 404         return set_in_max(dev, buf, count, offset);             \
 405 }                                                               \
 406 static DEVICE_ATTR(in##offset##_input, S_IRUGO, show_in##offset, NULL);\
 407 static DEVICE_ATTR(in##offset##_min, S_IRUGO | S_IWUSR,         \
 408                 show_in##offset##_min, set_in##offset##_min);   \
 409 static DEVICE_ATTR(in##offset##_max, S_IRUGO | S_IWUSR,         \
 410                 show_in##offset##_max, set_in##offset##_max);
 411
 412 show_in_offset(0);
 413 show_in_offset(1);
 414 show_in_offset(2);
 415 show_in_offset(3);
 416 show_in_offset(4);
 417
 418 /* 3 temperatures */
 419 static ssize_t show_temp(struct device *dev, char *buf, int nr) {
 420         struct via686a_data *data = via686a_update_device(dev);
 421         return sprintf(buf, "%ld\n", TEMP_FROM_REG10(data->temp[nr]));
 422 }
 423 static ssize_t show_temp_over(struct device *dev, char *buf, int nr) {
 424         struct via686a_data *data = via686a_update_device(dev);
 425         return sprintf(buf, "%ld\n", TEMP_FROM_REG(data->temp_over[nr]));
 426 }
 427 static ssize_t show_temp_hyst(struct device *dev, char *buf, int nr) {
 428         struct via686a_data *data = via686a_update_device(dev);
 429         return sprintf(buf, "%ld\n", TEMP_FROM_REG(data->temp_hyst[nr]));
 430 }
 431 static ssize_t set_temp_over(struct device *dev, const char *buf,
 432                 size_t count, int nr) {
 433         struct i2c_client *client = to_i2c_client(dev);
 434         struct via686a_data *data = i2c_get_clientdata(client);
 435         int val = simple_strtol(buf, NULL, 10);
 436
 437         mutex_lock(&data->update_lock);
 438         data->temp_over[nr] = TEMP_TO_REG(val);
 439         via686a_write_value(client, VIA686A_REG_TEMP_OVER[nr],
 440                             data->temp_over[nr]);
 441         mutex_unlock(&data->update_lock);
 442         return count;
 443 }
 444 static ssize_t set_temp_hyst(struct device *dev, const char *buf,
 445                 size_t count, int nr) {
 446         struct i2c_client *client = to_i2c_client(dev);
 447         struct via686a_data *data = i2c_get_clientdata(client);
 448         int val = simple_strtol(buf, NULL, 10);
 449
 450         mutex_lock(&data->update_lock);
 451         data->temp_hyst[nr] = TEMP_TO_REG(val);
 452         via686a_write_value(client, VIA686A_REG_TEMP_HYST[nr],
 453                             data->temp_hyst[nr]);
 454         mutex_unlock(&data->update_lock);
 455         return count;
 456 }
 457 #define show_temp_offset(offset)                                        \
 458 static ssize_t show_temp_##offset (struct device *dev, struct device_attribute *attr, char *buf)        \
 459 {                                                                       \
 460         return show_temp(dev, buf, offset - 1);                         \
 461 }                                                                       \
 462 static ssize_t                                                          \
 463 show_temp_##offset##_over (struct device *dev, struct device_attribute *attr, char *buf)                \
 464 {                                                                       \
 465         return show_temp_over(dev, buf, offset - 1);                    \
 466 }                                                                       \
 467 static ssize_t                                                          \
 468 show_temp_##offset##_hyst (struct device *dev, struct device_attribute *attr, char *buf)                \
 469 {                                                                       \
 470         return show_temp_hyst(dev, buf, offset - 1);                    \
 471 }                                                                       \
 472 static ssize_t set_temp_##offset##_over (struct device *dev, struct device_attribute *attr,             \
 473                 const char *buf, size_t count)                          \
 474 {                                                                       \
 475         return set_temp_over(dev, buf, count, offset - 1);              \
 476 }                                                                       \
 477 static ssize_t set_temp_##offset##_hyst (struct device *dev, struct device_attribute *attr,             \
 478                 const char *buf, size_t count)                          \
 479 {                                                                       \
 480         return set_temp_hyst(dev, buf, count, offset - 1);              \
 481 }                                                                       \
 482 static DEVICE_ATTR(temp##offset##_input, S_IRUGO, show_temp_##offset, NULL);\
 483 static DEVICE_ATTR(temp##offset##_max, S_IRUGO | S_IWUSR,               \
 484                 show_temp_##offset##_over, set_temp_##offset##_over);   \
 485 static DEVICE_ATTR(temp##offset##_max_hyst, S_IRUGO | S_IWUSR,          \
 486                 show_temp_##offset##_hyst, set_temp_##offset##_hyst);
 487
 488 show_temp_offset(1);
 489 show_temp_offset(2);
 490 show_temp_offset(3);
 491
 492 /* 2 Fans */
 493 static ssize_t show_fan(struct device *dev, char *buf, int nr) {
 494         struct via686a_data *data = via686a_update_device(dev);
 495         return sprintf(buf, "%d\n", FAN_FROM_REG(data->fan[nr],
 496                                 DIV_FROM_REG(data->fan_div[nr])) );
 497 }
 498 static ssize_t show_fan_min(struct device *dev, char *buf, int nr) {
 499         struct via686a_data *data = via686a_update_device(dev);
 500         return sprintf(buf, "%d\n",
 501                 FAN_FROM_REG(data->fan_min[nr], DIV_FROM_REG(data->fan_div[nr])) );
 502 }
 503 static ssize_t show_fan_div(struct device *dev, char *buf, int nr) {
 504         struct via686a_data *data = via686a_update_device(dev);
 505         return sprintf(buf, "%d\n", DIV_FROM_REG(data->fan_div[nr]) );
 506 }
 507 static ssize_t set_fan_min(struct device *dev, const char *buf,
 508                 size_t count, int nr) {
 509         struct i2c_client *client = to_i2c_client(dev);
 510         struct via686a_data *data = i2c_get_clientdata(client);
 511         int val = simple_strtol(buf, NULL, 10);
 512
 513         mutex_lock(&data->update_lock);
 514         data->fan_min[nr] = FAN_TO_REG(val, DIV_FROM_REG(data->fan_div[nr]));
 515         via686a_write_value(client, VIA686A_REG_FAN_MIN(nr+1), data->fan_min[nr]);
 516         mutex_unlock(&data->update_lock);
 517         return count;
 518 }
 519 static ssize_t set_fan_div(struct device *dev, const char *buf,
 520                 size_t count, int nr) {
 521         struct i2c_client *client = to_i2c_client(dev);
 522         struct via686a_data *data = i2c_get_clientdata(client);
 523         int val = simple_strtol(buf, NULL, 10);
 524         int old;
 525
 526         mutex_lock(&data->update_lock);
 527         old = via686a_read_value(client, VIA686A_REG_FANDIV);
 528         data->fan_div[nr] = DIV_TO_REG(val);
 529         old = (old & 0x0f) | (data->fan_div[1] << 6) | (data->fan_div[0] << 4);
 530         via686a_write_value(client, VIA686A_REG_FANDIV, old);
 531         mutex_unlock(&data->update_lock);
 532         return count;
 533 }
 534
 535 #define show_fan_offset(offset)                                         \
 536 static ssize_t show_fan_##offset (struct device *dev, struct device_attribute *attr, char *buf) \
 537 {                                                                       \
 538         return show_fan(dev, buf, offset - 1);                          \
 539 }                                                                       \
 540 static ssize_t show_fan_##offset##_min (struct device *dev, struct device_attribute *attr, char *buf)   \
 541 {                                                                       \
 542         return show_fan_min(dev, buf, offset - 1);                      \
 543 }                                                                       \
 544 static ssize_t show_fan_##offset##_div (struct device *dev, struct device_attribute *attr, char *buf)   \
 545 {                                                                       \
 546         return show_fan_div(dev, buf, offset - 1);                      \
 547 }                                                                       \
 548 static ssize_t set_fan_##offset##_min (struct device *dev, struct device_attribute *attr,               \
 549         const char *buf, size_t count)                                  \
 550 {                                                                       \
 551         return set_fan_min(dev, buf, count, offset - 1);                \
 552 }                                                                       \
 553 static ssize_t set_fan_##offset##_div (struct device *dev, struct device_attribute *attr,               \
 554                 const char *buf, size_t count)                          \
 555 {                                                                       \
 556         return set_fan_div(dev, buf, count, offset - 1);                \
 557 }                                                                       \
 558 static DEVICE_ATTR(fan##offset##_input, S_IRUGO, show_fan_##offset, NULL);\
 559 static DEVICE_ATTR(fan##offset##_min, S_IRUGO | S_IWUSR,                \
 560                 show_fan_##offset##_min, set_fan_##offset##_min);       \
 561 static DEVICE_ATTR(fan##offset##_div, S_IRUGO | S_IWUSR,                \
 562                 show_fan_##offset##_div, set_fan_##offset##_div);
 563
 564 show_fan_offset(1);
 565 show_fan_offset(2);
 566
 567 /* Alarms */
 568 static ssize_t show_alarms(struct device *dev, struct device_attribute *attr, char *buf) {
 569         struct via686a_data *data = via686a_update_device(dev);
 570         return sprintf(buf, "%u\n", data->alarms);
 571 }
 572 static DEVICE_ATTR(alarms, S_IRUGO, show_alarms, NULL);
 573
 574 static struct attribute *via686a_attributes[] = {
 575         &dev_attr_in0_input.attr,
 576         &dev_attr_in1_input.attr,
 577         &dev_attr_in2_input.attr,
 578         &dev_attr_in3_input.attr,
 579         &dev_attr_in4_input.attr,
 580         &dev_attr_in0_min.attr,
 581         &dev_attr_in1_min.attr,
 582         &dev_attr_in2_min.attr,
 583         &dev_attr_in3_min.attr,
 584         &dev_attr_in4_min.attr,
 585         &dev_attr_in0_max.attr,
 586         &dev_attr_in1_max.attr,
 587         &dev_attr_in2_max.attr,
 588         &dev_attr_in3_max.attr,
 589         &dev_attr_in4_max.attr,
 590
 591         &dev_attr_temp1_input.attr,
 592         &dev_attr_temp2_input.attr,
 593         &dev_attr_temp3_input.attr,
 594         &dev_attr_temp1_max.attr,
 595         &dev_attr_temp2_max.attr,
 596         &dev_attr_temp3_max.attr,
 597         &dev_attr_temp1_max_hyst.attr,
 598         &dev_attr_temp2_max_hyst.attr,
 599         &dev_attr_temp3_max_hyst.attr,
 600
 601         &dev_attr_fan1_input.attr,
 602         &dev_attr_fan2_input.attr,
 603         &dev_attr_fan1_min.attr,
 604         &dev_attr_fan2_min.attr,
 605         &dev_attr_fan1_div.attr,
 606         &dev_attr_fan2_div.attr,
 607
 608         &dev_attr_alarms.attr,
 609         NULL
 610 };
 611
 612 static const struct attribute_group via686a_group = {
 613         .attrs = via686a_attributes,
 614 };
 615
 616 /* The driver. I choose to use type i2c_driver, as at is identical to both
 617    smbus_driver and isa_driver, and clients could be of either kind */
 618 static struct i2c_driver via686a_driver = {
 619         .driver = {
 620                 .owner  = THIS_MODULE,
 621                 .name   = "via686a",
 622         },
 623         .attach_adapter = via686a_detect,
 624         .detach_client  = via686a_detach_client,
 625 };
 626
 627
 628 /* This is called when the module is loaded */
 629 static int via686a_detect(struct i2c_adapter *adapter)
 630 {
 631         struct i2c_client *new_client;
 632         struct via686a_data *data;
 633         int err = 0;
 634         const char client_name[] = "via686a";
 635         u16 val;
 636
 637         /* 8231 requires multiple of 256, we enforce that on 686 as well */
 638         if (force_addr) {
 639                 address = force_addr & 0xFF00;
 640                 dev_warn(&adapter->dev, "forcing ISA address 0x%04X\n",
 641                          address);
 642                 if (PCIBIOS_SUCCESSFUL !=
 643                     pci_write_config_word(s_bridge, VIA686A_BASE_REG, address))
 644                         return -ENODEV;
 645         }
 646         if (PCIBIOS_SUCCESSFUL !=
 647             pci_read_config_word(s_bridge, VIA686A_ENABLE_REG, &val))
 648                 return -ENODEV;
 649         if (!(val & 0x0001)) {
 650                 if (force_addr) {
 651                         dev_info(&adapter->dev, "enabling sensors\n");
 652                         if (PCIBIOS_SUCCESSFUL !=
 653                             pci_write_config_word(s_bridge, VIA686A_ENABLE_REG,
 654                                                   val | 0x0001))
 655                                 return -ENODEV;
 656                 } else {
 657                         dev_warn(&adapter->dev, "sensors disabled - enable "
 658                                  "with force_addr=0x%x\n", address);
 659                         return -ENODEV;
 660                 }
 661         }
 662
 663         /* Reserve the ISA region */
 664         if (!request_region(address, VIA686A_EXTENT,
 665                             via686a_driver.driver.name)) {
 666                 dev_err(&adapter->dev, "region 0x%x already in use!\n",
 667                         address);
 668                 return -ENODEV;
 669         }
 670
 671         if (!(data = kzalloc(sizeof(struct via686a_data), GFP_KERNEL))) {
 672                 err = -ENOMEM;
 673                 goto exit_release;
 674         }
 675
 676         new_client = &data->client;
 677         i2c_set_clientdata(new_client, data);
 678         new_client->addr = address;
 679         new_client->adapter = adapter;
 680         new_client->driver = &via686a_driver;
 681         new_client->flags = 0;
 682
 683         /* Fill in the remaining client fields and put into the global list */
 684         strlcpy(new_client->name, client_name, I2C_NAME_SIZE);
 685
 686         data->valid = 0;
 687         mutex_init(&data->update_lock);
 688         /* Tell the I2C layer a new client has arrived */
 689         if ((err = i2c_attach_client(new_client)))
 690                 goto exit_free;
 691
 692         /* Initialize the VIA686A chip */
 693         via686a_init_client(new_client);
 694
 695         /* Register sysfs hooks */
 696         if ((err = sysfs_create_group(&new_client->dev.kobj, &via686a_group)))
 697                 goto exit_detach;
 698
 699         data->class_dev = hwmon_device_register(&new_client->dev);
 700         if (IS_ERR(data->class_dev)) {
 701                 err = PTR_ERR(data->class_dev);
 702                 goto exit_remove_files;
 703         }
 704
 705         return 0;
 706
 707 exit_remove_files:
 708         sysfs_remove_group(&new_client->dev.kobj, &via686a_group);
 709 exit_detach:
 710         i2c_detach_client(new_client);
 711 exit_free:
 712         kfree(data);
 713 exit_release:
 714         release_region(address, VIA686A_EXTENT);
 715         return err;
 716 }
 717
 718 static int via686a_detach_client(struct i2c_client *client)
 719 {
 720         struct via686a_data *data = i2c_get_clientdata(client);
 721         int err;
 722
 723         hwmon_device_unregister(data->class_dev);
 724         sysfs_remove_group(&client->dev.kobj, &via686a_group);
 725
 726         if ((err = i2c_detach_client(client)))
 727                 return err;
 728
 729         release_region(client->addr, VIA686A_EXTENT);
 730         kfree(data);
 731
 732         return 0;
 733 }
 734
 735 static void via686a_init_client(struct i2c_client *client)
 736 {
 737         u8 reg;
 738
 739         /* Start monitoring */
 740         reg = via686a_read_value(client, VIA686A_REG_CONFIG);
 741         via686a_write_value(client, VIA686A_REG_CONFIG, (reg|0x01)&0x7F);
 742
 743         /* Configure temp interrupt mode for continuous-interrupt operation */
 744         via686a_write_value(client, VIA686A_REG_TEMP_MODE,
 745                             via686a_read_value(client, VIA686A_REG_TEMP_MODE) &
 746                             !(VIA686A_TEMP_MODE_MASK | VIA686A_TEMP_MODE_CONTINUOUS));
 747 }
 748
 749 static struct via686a_data *via686a_update_device(struct device *dev)
 750 {
 751         struct i2c_client *client = to_i2c_client(dev);
 752         struct via686a_data *data = i2c_get_clientdata(client);
 753         int i;
 754
 755         mutex_lock(&data->update_lock);
 756
 757         if (time_after(jiffies, data->last_updated + HZ + HZ / 2)
 758             || !data->valid) {
 759                 for (i = 0; i <= 4; i++) {
 760                         data->in[i] =
 761                             via686a_read_value(client, VIA686A_REG_IN(i));
 762                         data->in_min[i] = via686a_read_value(client,
 763                                                              VIA686A_REG_IN_MIN
 764                                                              (i));
 765                         data->in_max[i] =
 766                             via686a_read_value(client, VIA686A_REG_IN_MAX(i));
 767                 }
 768                 for (i = 1; i <= 2; i++) {
 769                         data->fan[i - 1] =
 770                             via686a_read_value(client, VIA686A_REG_FAN(i));
 771                         data->fan_min[i - 1] = via686a_read_value(client,
 772                                                      VIA686A_REG_FAN_MIN(i));
 773                 }
 774                 for (i = 0; i <= 2; i++) {
 775                         data->temp[i] = via686a_read_value(client,
 776                                                  VIA686A_REG_TEMP[i]) << 2;
 777                         data->temp_over[i] =
 778                             via686a_read_value(client,
 779                                                VIA686A_REG_TEMP_OVER[i]);
 780                         data->temp_hyst[i] =
 781                             via686a_read_value(client,
 782                                                VIA686A_REG_TEMP_HYST[i]);
 783                 }
 784                 /* add in lower 2 bits
 785                    temp1 uses bits 7-6 of VIA686A_REG_TEMP_LOW1
 786                    temp2 uses bits 5-4 of VIA686A_REG_TEMP_LOW23
 787                    temp3 uses bits 7-6 of VIA686A_REG_TEMP_LOW23
 788                  */
 789                 data->temp[0] |= (via686a_read_value(client,
 790                                                      VIA686A_REG_TEMP_LOW1)
 791                                   & 0xc0) >> 6;
 792                 data->temp[1] |=
 793                     (via686a_read_value(client, VIA686A_REG_TEMP_LOW23) &
 794                      0x30) >> 4;
 795                 data->temp[2] |=
 796                     (via686a_read_value(client, VIA686A_REG_TEMP_LOW23) &
 797                      0xc0) >> 6;
 798
 799                 i = via686a_read_value(client, VIA686A_REG_FANDIV);
 800                 data->fan_div[0] = (i >> 4) & 0x03;
 801                 data->fan_div[1] = i >> 6;
 802                 data->alarms =
 803                     via686a_read_value(client,
 804                                        VIA686A_REG_ALARM1) |
 805                     (via686a_read_value(client, VIA686A_REG_ALARM2) << 8);
 806                 data->last_updated = jiffies;
 807                 data->valid = 1;
 808         }
 809
 810         mutex_unlock(&data->update_lock);
 811
 812         return data;
 813 }
 814
 815 static struct pci_device_id via686a_pci_ids[] = {
 816         { PCI_DEVICE(PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C686_4) },
 817         { 0, }
 818 };
 819
 820 MODULE_DEVICE_TABLE(pci, via686a_pci_ids);
 821
 822 static int __devinit via686a_pci_probe(struct pci_dev *dev,
 823                                        const struct pci_device_id *id)
 824 {
 825         u16 val;
 826
 827         if (PCIBIOS_SUCCESSFUL !=
 828             pci_read_config_word(dev, VIA686A_BASE_REG, &val))
 829                 return -ENODEV;
 830
 831         address = val & ~(VIA686A_EXTENT - 1);
 832         if (address == 0 && force_addr == 0) {
 833                 dev_err(&dev->dev, "base address not set - upgrade BIOS "
 834                         "or use force_addr=0xaddr\n");
 835                 return -ENODEV;
 836         }
 837
 838         s_bridge = pci_dev_get(dev);
 839         if (i2c_isa_add_driver(&via686a_driver)) {
 840                 pci_dev_put(s_bridge);
 841                 s_bridge = NULL;
 842         }
 843
 844         /* Always return failure here.  This is to allow other drivers to bind
 845          * to this pci device.  We don't really want to have control over the
 846          * pci device, we only wanted to read as few register values from it.
 847          */
 848         return -ENODEV;
 849 }
 850
 851 static struct pci_driver via686a_pci_driver = {
 852         .name           = "via686a",
 853         .id_table       = via686a_pci_ids,
 854         .probe          = via686a_pci_probe,
 855 };
 856
 857 static int __init sm_via686a_init(void)
 858 {
 859         return pci_register_driver(&via686a_pci_driver);
 860 }
 861
 862 static void __exit sm_via686a_exit(void)
 863 {
 864         pci_unregister_driver(&via686a_pci_driver);
 865         if (s_bridge != NULL) {
 866                 i2c_isa_del_driver(&via686a_driver);
 867                 pci_dev_put(s_bridge);
 868                 s_bridge = NULL;
 869         }
 870 }
 871
 872 MODULE_AUTHOR("Kyösti Mälkki <kmalkki@cc.hut.fi>, "
 873               "Mark Studebaker <mdsxyz123@yahoo.com> "
 874               "and Bob Dougherty <bobd@stanford.edu>");
 875 MODULE_DESCRIPTION("VIA 686A Sensor device");
 876 MODULE_LICENSE("GPL");
 877
 878 module_init(sm_via686a_init);
 879 module_exit(sm_via686a_exit);