drivers/platform/x86/compal-laptop.c

   1 /*-*-linux-c-*-*/
   2
   3 /*
   4   Copyright (C) 2008 Cezary Jackiewicz <cezary.jackiewicz (at) gmail.com>
   5
   6   based on MSI driver
   7
   8   Copyright (C) 2006 Lennart Poettering <mzxreary (at) 0pointer (dot) de>
   9
  10   This program is free software; you can redistribute it and/or modify
  11   it under the terms 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, but
  16   WITHOUT ANY WARRANTY; without even the implied warranty of
  17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18   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., 51 Franklin Street, Fifth Floor, Boston, MA
  23   02110-1301, USA.
  24  */
  25
  26 /*
  27  * compal-laptop.c - Compal laptop support.
  28  *
  29  * This driver exports a few files in /sys/devices/platform/compal-laptop/:
  30  *   wake_up_XXX   Whether or not we listen to such wake up events (rw)
  31  *
  32  * In addition to these platform device attributes the driver
  33  * registers itself in the Linux backlight control, power_supply, rfkill
  34  * and hwmon subsystem and is available to userspace under:
  35  *
  36  *   /sys/class/backlight/compal-laptop/
  37  *   /sys/class/power_supply/compal-laptop/
  38  *   /sys/class/rfkill/rfkillX/
  39  *   /sys/class/hwmon/hwmonX/
  40  *
  41  * Notes on the power_supply battery interface:
  42  *   - the "minimum" design voltage is *the* design voltage
  43  *   - the ambient temperature is the average battery temperature
  44  *     and the value is an educated guess (see commented code below)
  45  *
  46  *
  47  * This driver might work on other laptops produced by Compal. If you
  48  * want to try it you can pass force=1 as argument to the module which
  49  * will force it to load even when the DMI data doesn't identify the
  50  * laptop as compatible.
  51  *
  52  * Lots of data available at:
  53  * http://service1.marasst.com/Compal/JHL90_91/Service%20Manual/
  54  * JHL90%20service%20manual-Final-0725.pdf
  55  *
  56  *
  57  *
  58  * Support for the Compal JHL90 added by Roald Frederickx
  59  * (roald.frederickx@gmail.com):
  60  * Driver got large revision. Added functionalities: backlight
  61  * power, wake_on_XXX, a hwmon and power_supply interface.
  62  *
  63  * In case this gets merged into the kernel source: I want to dedicate this
  64  * to Kasper Meerts, the awesome guy who showed me Linux and C!
  65  */
  66
  67 /* NOTE: currently the wake_on_XXX, hwmon and power_supply interfaces are
  68  * only enabled on a JHL90 board until it is verified that they work on the
  69  * other boards too.  See the extra_features variable. */
  70
  71 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  72
  73 #include <linux/module.h>
  74 #include <linux/kernel.h>
  75 #include <linux/init.h>
  76 #include <linux/acpi.h>
  77 #include <linux/dmi.h>
  78 #include <linux/backlight.h>
  79 #include <linux/platform_device.h>
  80 #include <linux/rfkill.h>
  81 #include <linux/hwmon.h>
  82 #include <linux/hwmon-sysfs.h>
  83 #include <linux/power_supply.h>
  84 #include <linux/fb.h>
  85 #include <acpi/video.h>
  86
  87 /* ======= */
  88 /* Defines */
  89 /* ======= */
  90 #define DRIVER_NAME "compal-laptop"
  91 #define DRIVER_VERSION  "0.2.7"
  92
  93 #define BACKLIGHT_LEVEL_ADDR            0xB9
  94 #define BACKLIGHT_LEVEL_MAX             7
  95 #define BACKLIGHT_STATE_ADDR            0x59
  96 #define BACKLIGHT_STATE_ON_DATA         0xE1
  97 #define BACKLIGHT_STATE_OFF_DATA        0xE2
  98
  99 #define WAKE_UP_ADDR                    0xA4
 100 #define WAKE_UP_PME                     (1 << 0)
 101 #define WAKE_UP_MODEM                   (1 << 1)
 102 #define WAKE_UP_LAN                     (1 << 2)
 103 #define WAKE_UP_WLAN                    (1 << 4)
 104 #define WAKE_UP_KEY                     (1 << 6)
 105 #define WAKE_UP_MOUSE                   (1 << 7)
 106
 107 #define WIRELESS_ADDR                   0xBB
 108 #define WIRELESS_WLAN                   (1 << 0)
 109 #define WIRELESS_BT                     (1 << 1)
 110 #define WIRELESS_WLAN_EXISTS            (1 << 2)
 111 #define WIRELESS_BT_EXISTS              (1 << 3)
 112 #define WIRELESS_KILLSWITCH             (1 << 4)
 113
 114 #define PWM_ADDRESS                     0x46
 115 #define PWM_DISABLE_ADDR                0x59
 116 #define PWM_DISABLE_DATA                0xA5
 117 #define PWM_ENABLE_ADDR                 0x59
 118 #define PWM_ENABLE_DATA                 0xA8
 119
 120 #define FAN_ADDRESS                     0x46
 121 #define FAN_DATA                        0x81
 122 #define FAN_FULL_ON_CMD                 0x59 /* Doesn't seem to work. Just */
 123 #define FAN_FULL_ON_ENABLE              0x76 /* force the pwm signal to its */
 124 #define FAN_FULL_ON_DISABLE             0x77 /* maximum value instead */
 125
 126 #define TEMP_CPU                        0xB0
 127 #define TEMP_CPU_LOCAL                  0xB1
 128 #define TEMP_CPU_DTS                    0xB5
 129 #define TEMP_NORTHBRIDGE                0xB6
 130 #define TEMP_VGA                        0xB4
 131 #define TEMP_SKIN                       0xB2
 132
 133 #define BAT_MANUFACTURER_NAME_ADDR      0x10
 134 #define BAT_MANUFACTURER_NAME_LEN       9
 135 #define BAT_MODEL_NAME_ADDR             0x19
 136 #define BAT_MODEL_NAME_LEN              6
 137 #define BAT_SERIAL_NUMBER_ADDR          0xC4
 138 #define BAT_SERIAL_NUMBER_LEN           5
 139 #define BAT_CHARGE_NOW                  0xC2
 140 #define BAT_CHARGE_DESIGN               0xCA
 141 #define BAT_VOLTAGE_NOW                 0xC6
 142 #define BAT_VOLTAGE_DESIGN              0xC8
 143 #define BAT_CURRENT_NOW                 0xD0
 144 #define BAT_CURRENT_AVG                 0xD2
 145 #define BAT_POWER                       0xD4
 146 #define BAT_CAPACITY                    0xCE
 147 #define BAT_TEMP                        0xD6
 148 #define BAT_TEMP_AVG                    0xD7
 149 #define BAT_STATUS0                     0xC1
 150 #define BAT_STATUS1                     0xF0
 151 #define BAT_STATUS2                     0xF1
 152 #define BAT_STOP_CHARGE1                0xF2
 153 #define BAT_STOP_CHARGE2                0xF3
 154 #define BAT_CHARGE_LIMIT                0x03
 155 #define BAT_CHARGE_LIMIT_MAX            100
 156
 157 #define BAT_S0_DISCHARGE                (1 << 0)
 158 #define BAT_S0_DISCHRG_CRITICAL         (1 << 2)
 159 #define BAT_S0_LOW                      (1 << 3)
 160 #define BAT_S0_CHARGING                 (1 << 1)
 161 #define BAT_S0_AC                       (1 << 7)
 162 #define BAT_S1_EXISTS                   (1 << 0)
 163 #define BAT_S1_FULL                     (1 << 1)
 164 #define BAT_S1_EMPTY                    (1 << 2)
 165 #define BAT_S1_LiION_OR_NiMH            (1 << 7)
 166 #define BAT_S2_LOW_LOW                  (1 << 0)
 167 #define BAT_STOP_CHRG1_BAD_CELL         (1 << 1)
 168 #define BAT_STOP_CHRG1_COMM_FAIL        (1 << 2)
 169 #define BAT_STOP_CHRG1_OVERVOLTAGE      (1 << 6)
 170 #define BAT_STOP_CHRG1_OVERTEMPERATURE  (1 << 7)
 171
 172
 173 /* ======= */
 174 /* Structs */
 175 /* ======= */
 176 struct compal_data{
 177         /* Fan control */
 178         int pwm_enable; /* 0:full on, 1:set by pwm1, 2:control by motherboard */
 179         unsigned char curr_pwm;
 180
 181         /* Power supply */
 182         struct power_supply *psy;
 183         struct power_supply_info psy_info;
 184         char bat_model_name[BAT_MODEL_NAME_LEN + 1];
 185         char bat_manufacturer_name[BAT_MANUFACTURER_NAME_LEN + 1];
 186         char bat_serial_number[BAT_SERIAL_NUMBER_LEN + 1];
 187 };
 188
 189
 190 /* =============== */
 191 /* General globals */
 192 /* =============== */
 193 static bool force;
 194 module_param(force, bool, 0);
 195 MODULE_PARM_DESC(force, "Force driver load, ignore DMI data");
 196
 197 /* Support for the wake_on_XXX, hwmon and power_supply interface. Currently
 198  * only gets enabled on a JHL90 board. Might work with the others too */
 199 static bool extra_features;
 200
 201 /* Nasty stuff. For some reason the fan control is very un-linear.  I've
 202  * come up with these values by looping through the possible inputs and
 203  * watching the output of address 0x4F (do an ec_transaction writing 0x33
 204  * into 0x4F and read a few bytes from the output, like so:
 205  *      u8 writeData = 0x33;
 206  *      ec_transaction(0x4F, &writeData, 1, buffer, 32);
 207  * That address is labeled "fan1 table information" in the service manual.
 208  * It should be clear which value in 'buffer' changes). This seems to be
 209  * related to fan speed. It isn't a proper 'realtime' fan speed value
 210  * though, because physically stopping or speeding up the fan doesn't
 211  * change it. It might be the average voltage or current of the pwm output.
 212  * Nevertheless, it is more fine-grained than the actual RPM reading */
 213 static const unsigned char pwm_lookup_table[256] = {
 214         0, 0, 0, 1, 1, 1, 2, 253, 254, 3, 3, 3, 4, 4, 4, 5, 5, 5, 6, 6, 6,
 215         7, 7, 7, 8, 86, 86, 9, 9, 9, 10, 10, 10, 11, 92, 92, 12, 12, 95,
 216         13, 66, 66, 14, 14, 98, 15, 15, 15, 16, 16, 67, 17, 17, 72, 18, 70,
 217         75, 19, 90, 90, 73, 73, 73, 21, 21, 91, 91, 91, 96, 23, 94, 94, 94,
 218         94, 94, 94, 94, 94, 94, 94, 141, 141, 238, 223, 192, 139, 139, 139,
 219         139, 139, 142, 142, 142, 142, 142, 78, 78, 78, 78, 78, 76, 76, 76,
 220         76, 76, 79, 79, 79, 79, 79, 79, 79, 20, 20, 20, 20, 20, 22, 22, 22,
 221         22, 22, 24, 24, 24, 24, 24, 24, 219, 219, 219, 219, 219, 219, 219,
 222         219, 27, 27, 188, 188, 28, 28, 28, 29, 186, 186, 186, 186, 186,
 223         186, 186, 186, 186, 186, 31, 31, 31, 31, 31, 32, 32, 32, 41, 33,
 224         33, 33, 33, 33, 252, 252, 34, 34, 34, 43, 35, 35, 35, 36, 36, 38,
 225         206, 206, 206, 206, 206, 206, 206, 206, 206, 37, 37, 37, 46, 46,
 226         47, 47, 232, 232, 232, 232, 232, 232, 232, 232, 232, 232, 48, 48,
 227         48, 48, 48, 40, 40, 40, 49, 42, 42, 42, 42, 42, 42, 42, 42, 44,
 228         189, 189, 189, 189, 54, 54, 45, 45, 45, 45, 45, 45, 45, 45, 251,
 229         191, 199, 199, 199, 199, 199, 215, 215, 215, 215, 187, 187, 187,
 230         187, 187, 193, 50
 231 };
 232
 233
 234
 235
 236 /* ========================= */
 237 /* Hardware access functions */
 238 /* ========================= */
 239 /* General access */
 240 static u8 ec_read_u8(u8 addr)
 241 {
 242         u8 value;
 243         ec_read(addr, &value);
 244         return value;
 245 }
 246
 247 static s8 ec_read_s8(u8 addr)
 248 {
 249         return (s8)ec_read_u8(addr);
 250 }
 251
 252 static u16 ec_read_u16(u8 addr)
 253 {
 254         int hi, lo;
 255         lo = ec_read_u8(addr);
 256         hi = ec_read_u8(addr + 1);
 257         return (hi << 8) + lo;
 258 }
 259
 260 static s16 ec_read_s16(u8 addr)
 261 {
 262         return (s16) ec_read_u16(addr);
 263 }
 264
 265 static void ec_read_sequence(u8 addr, u8 *buf, int len)
 266 {
 267         int i;
 268         for (i = 0; i < len; i++)
 269                 ec_read(addr + i, buf + i);
 270 }
 271
 272
 273 /* Backlight access */
 274 static int set_backlight_level(int level)
 275 {
 276         if (level < 0 || level > BACKLIGHT_LEVEL_MAX)
 277                 return -EINVAL;
 278
 279         ec_write(BACKLIGHT_LEVEL_ADDR, level);
 280
 281         return 0;
 282 }
 283
 284 static int get_backlight_level(void)
 285 {
 286         return (int) ec_read_u8(BACKLIGHT_LEVEL_ADDR);
 287 }
 288
 289 static void set_backlight_state(bool on)
 290 {
 291         u8 data = on ? BACKLIGHT_STATE_ON_DATA : BACKLIGHT_STATE_OFF_DATA;
 292         ec_transaction(BACKLIGHT_STATE_ADDR, &data, 1, NULL, 0);
 293 }
 294
 295
 296 /* Fan control access */
 297 static void pwm_enable_control(void)
 298 {
 299         unsigned char writeData = PWM_ENABLE_DATA;
 300         ec_transaction(PWM_ENABLE_ADDR, &writeData, 1, NULL, 0);
 301 }
 302
 303 static void pwm_disable_control(void)
 304 {
 305         unsigned char writeData = PWM_DISABLE_DATA;
 306         ec_transaction(PWM_DISABLE_ADDR, &writeData, 1, NULL, 0);
 307 }
 308
 309 static void set_pwm(int pwm)
 310 {
 311         ec_transaction(PWM_ADDRESS, &pwm_lookup_table[pwm], 1, NULL, 0);
 312 }
 313
 314 static int get_fan_rpm(void)
 315 {
 316         u8 value, data = FAN_DATA;
 317         ec_transaction(FAN_ADDRESS, &data, 1, &value, 1);
 318         return 100 * (int)value;
 319 }
 320
 321
 322
 323
 324 /* =================== */
 325 /* Interface functions */
 326 /* =================== */
 327
 328 /* Backlight interface */
 329 static int bl_get_brightness(struct backlight_device *b)
 330 {
 331         return get_backlight_level();
 332 }
 333
 334 static int bl_update_status(struct backlight_device *b)
 335 {
 336         int ret = set_backlight_level(b->props.brightness);
 337         if (ret)
 338                 return ret;
 339
 340         set_backlight_state((b->props.power == FB_BLANK_UNBLANK)
 341                 &&    !(b->props.state & BL_CORE_SUSPENDED)
 342                 &&    !(b->props.state & BL_CORE_FBBLANK));
 343         return 0;
 344 }
 345
 346 static const struct backlight_ops compalbl_ops = {
 347         .get_brightness = bl_get_brightness,
 348         .update_status  = bl_update_status,
 349 };
 350
 351
 352 /* Wireless interface */
 353 static int compal_rfkill_set(void *data, bool blocked)
 354 {
 355         unsigned long radio = (unsigned long) data;
 356         u8 result = ec_read_u8(WIRELESS_ADDR);
 357         u8 value;
 358
 359         if (!blocked)
 360                 value = (u8) (result | radio);
 361         else
 362                 value = (u8) (result & ~radio);
 363         ec_write(WIRELESS_ADDR, value);
 364
 365         return 0;
 366 }
 367
 368 static void compal_rfkill_poll(struct rfkill *rfkill, void *data)
 369 {
 370         u8 result = ec_read_u8(WIRELESS_ADDR);
 371         bool hw_blocked = !(result & WIRELESS_KILLSWITCH);
 372         rfkill_set_hw_state(rfkill, hw_blocked);
 373 }
 374
 375 static const struct rfkill_ops compal_rfkill_ops = {
 376         .poll = compal_rfkill_poll,
 377         .set_block = compal_rfkill_set,
 378 };
 379
 380
 381 /* Wake_up interface */
 382 #define SIMPLE_MASKED_STORE_SHOW(NAME, ADDR, MASK)                      \
 383 static ssize_t NAME##_show(struct device *dev,                          \
 384         struct device_attribute *attr, char *buf)                       \
 385 {                                                                       \
 386         return sprintf(buf, "%d\n", ((ec_read_u8(ADDR) & MASK) != 0));  \
 387 }                                                                       \
 388 static ssize_t NAME##_store(struct device *dev,                         \
 389         struct device_attribute *attr, const char *buf, size_t count)   \
 390 {                                                                       \
 391         int state;                                                      \
 392         u8 old_val = ec_read_u8(ADDR);                                  \
 393         if (sscanf(buf, "%d", &state) != 1 || (state < 0 || state > 1)) \
 394                 return -EINVAL;                                         \
 395         ec_write(ADDR, state ? (old_val | MASK) : (old_val & ~MASK));   \
 396         return count;                                                   \
 397 }
 398
 399 SIMPLE_MASKED_STORE_SHOW(wake_up_pme,   WAKE_UP_ADDR, WAKE_UP_PME)
 400 SIMPLE_MASKED_STORE_SHOW(wake_up_modem, WAKE_UP_ADDR, WAKE_UP_MODEM)
 401 SIMPLE_MASKED_STORE_SHOW(wake_up_lan,   WAKE_UP_ADDR, WAKE_UP_LAN)
 402 SIMPLE_MASKED_STORE_SHOW(wake_up_wlan,  WAKE_UP_ADDR, WAKE_UP_WLAN)
 403 SIMPLE_MASKED_STORE_SHOW(wake_up_key,   WAKE_UP_ADDR, WAKE_UP_KEY)
 404 SIMPLE_MASKED_STORE_SHOW(wake_up_mouse, WAKE_UP_ADDR, WAKE_UP_MOUSE)
 405
 406 /* Fan control interface */
 407 static ssize_t pwm_enable_show(struct device *dev,
 408                 struct device_attribute *attr, char *buf)
 409 {
 410         struct compal_data *data = dev_get_drvdata(dev);
 411         return sprintf(buf, "%d\n", data->pwm_enable);
 412 }
 413
 414 static ssize_t pwm_enable_store(struct device *dev,
 415                 struct device_attribute *attr, const char *buf, size_t count)
 416 {
 417         struct compal_data *data = dev_get_drvdata(dev);
 418         long val;
 419         int err;
 420
 421         err = kstrtol(buf, 10, &val);
 422         if (err)
 423                 return err;
 424         if (val < 0)
 425                 return -EINVAL;
 426
 427         data->pwm_enable = val;
 428
 429         switch (val) {
 430         case 0:  /* Full speed */
 431                 pwm_enable_control();
 432                 set_pwm(255);
 433                 break;
 434         case 1:  /* As set by pwm1 */
 435                 pwm_enable_control();
 436                 set_pwm(data->curr_pwm);
 437                 break;
 438         default: /* Control by motherboard */
 439                 pwm_disable_control();
 440                 break;
 441         }
 442
 443         return count;
 444 }
 445
 446 static ssize_t pwm_show(struct device *dev, struct device_attribute *attr,
 447                 char *buf)
 448 {
 449         struct compal_data *data = dev_get_drvdata(dev);
 450         return sprintf(buf, "%hhu\n", data->curr_pwm);
 451 }
 452
 453 static ssize_t pwm_store(struct device *dev, struct device_attribute *attr,
 454                 const char *buf, size_t count)
 455 {
 456         struct compal_data *data = dev_get_drvdata(dev);
 457         long val;
 458         int err;
 459
 460         err = kstrtol(buf, 10, &val);
 461         if (err)
 462                 return err;
 463         if (val < 0 || val > 255)
 464                 return -EINVAL;
 465
 466         data->curr_pwm = val;
 467
 468         if (data->pwm_enable != 1)
 469                 return count;
 470         set_pwm(val);
 471
 472         return count;
 473 }
 474
 475 static ssize_t fan_show(struct device *dev, struct device_attribute *attr,
 476                 char *buf)
 477 {
 478         return sprintf(buf, "%d\n", get_fan_rpm());
 479 }
 480
 481
 482 /* Temperature interface */
 483 #define TEMPERATURE_SHOW_TEMP_AND_LABEL(POSTFIX, ADDRESS, LABEL)        \
 484 static ssize_t temp_##POSTFIX(struct device *dev,                       \
 485                 struct device_attribute *attr, char *buf)               \
 486 {                                                                       \
 487         return sprintf(buf, "%d\n", 1000 * (int)ec_read_s8(ADDRESS));   \
 488 }                                                                       \
 489 static ssize_t label_##POSTFIX(struct device *dev,                      \
 490                 struct device_attribute *attr, char *buf)               \
 491 {                                                                       \
 492         return sprintf(buf, "%s\n", LABEL);                             \
 493 }
 494
 495 /* Labels as in service guide */
 496 TEMPERATURE_SHOW_TEMP_AND_LABEL(cpu,        TEMP_CPU,        "CPU_TEMP");
 497 TEMPERATURE_SHOW_TEMP_AND_LABEL(cpu_local,  TEMP_CPU_LOCAL,  "CPU_TEMP_LOCAL");
 498 TEMPERATURE_SHOW_TEMP_AND_LABEL(cpu_DTS,    TEMP_CPU_DTS,    "CPU_DTS");
 499 TEMPERATURE_SHOW_TEMP_AND_LABEL(northbridge,TEMP_NORTHBRIDGE,"NorthBridge");
 500 TEMPERATURE_SHOW_TEMP_AND_LABEL(vga,        TEMP_VGA,        "VGA_TEMP");
 501 TEMPERATURE_SHOW_TEMP_AND_LABEL(SKIN,       TEMP_SKIN,       "SKIN_TEMP90");
 502
 503
 504 /* Power supply interface */
 505 static int bat_status(void)
 506 {
 507         u8 status0 = ec_read_u8(BAT_STATUS0);
 508         u8 status1 = ec_read_u8(BAT_STATUS1);
 509
 510         if (status0 & BAT_S0_CHARGING)
 511                 return POWER_SUPPLY_STATUS_CHARGING;
 512         if (status0 & BAT_S0_DISCHARGE)
 513                 return POWER_SUPPLY_STATUS_DISCHARGING;
 514         if (status1 & BAT_S1_FULL)
 515                 return POWER_SUPPLY_STATUS_FULL;
 516         return POWER_SUPPLY_STATUS_NOT_CHARGING;
 517 }
 518
 519 static int bat_health(void)
 520 {
 521         u8 status = ec_read_u8(BAT_STOP_CHARGE1);
 522
 523         if (status & BAT_STOP_CHRG1_OVERTEMPERATURE)
 524                 return POWER_SUPPLY_HEALTH_OVERHEAT;
 525         if (status & BAT_STOP_CHRG1_OVERVOLTAGE)
 526                 return POWER_SUPPLY_HEALTH_OVERVOLTAGE;
 527         if (status & BAT_STOP_CHRG1_BAD_CELL)
 528                 return POWER_SUPPLY_HEALTH_DEAD;
 529         if (status & BAT_STOP_CHRG1_COMM_FAIL)
 530                 return POWER_SUPPLY_HEALTH_UNKNOWN;
 531         return POWER_SUPPLY_HEALTH_GOOD;
 532 }
 533
 534 static int bat_is_present(void)
 535 {
 536         u8 status = ec_read_u8(BAT_STATUS2);
 537         return ((status & BAT_S1_EXISTS) != 0);
 538 }
 539
 540 static int bat_technology(void)
 541 {
 542         u8 status = ec_read_u8(BAT_STATUS1);
 543
 544         if (status & BAT_S1_LiION_OR_NiMH)
 545                 return POWER_SUPPLY_TECHNOLOGY_LION;
 546         return POWER_SUPPLY_TECHNOLOGY_NiMH;
 547 }
 548
 549 static int bat_capacity_level(void)
 550 {
 551         u8 status0 = ec_read_u8(BAT_STATUS0);
 552         u8 status1 = ec_read_u8(BAT_STATUS1);
 553         u8 status2 = ec_read_u8(BAT_STATUS2);
 554
 555         if (status0 & BAT_S0_DISCHRG_CRITICAL
 556                         || status1 & BAT_S1_EMPTY
 557                         || status2 & BAT_S2_LOW_LOW)
 558                 return POWER_SUPPLY_CAPACITY_LEVEL_CRITICAL;
 559         if (status0 & BAT_S0_LOW)
 560                 return POWER_SUPPLY_CAPACITY_LEVEL_LOW;
 561         if (status1 & BAT_S1_FULL)
 562                 return POWER_SUPPLY_CAPACITY_LEVEL_FULL;
 563         return POWER_SUPPLY_CAPACITY_LEVEL_NORMAL;
 564 }
 565
 566 static int bat_get_property(struct power_supply *psy,
 567                                 enum power_supply_property psp,
 568                                 union power_supply_propval *val)
 569 {
 570         struct compal_data *data = power_supply_get_drvdata(psy);
 571
 572         switch (psp) {
 573         case POWER_SUPPLY_PROP_STATUS:
 574                 val->intval = bat_status();
 575                 break;
 576         case POWER_SUPPLY_PROP_HEALTH:
 577                 val->intval = bat_health();
 578                 break;
 579         case POWER_SUPPLY_PROP_PRESENT:
 580                 val->intval = bat_is_present();
 581                 break;
 582         case POWER_SUPPLY_PROP_TECHNOLOGY:
 583                 val->intval = bat_technology();
 584                 break;
 585         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN: /* THE design voltage... */
 586                 val->intval = ec_read_u16(BAT_VOLTAGE_DESIGN) * 1000;
 587                 break;
 588         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 589                 val->intval = ec_read_u16(BAT_VOLTAGE_NOW) * 1000;
 590                 break;
 591         case POWER_SUPPLY_PROP_CURRENT_NOW:
 592                 val->intval = ec_read_s16(BAT_CURRENT_NOW) * 1000;
 593                 break;
 594         case POWER_SUPPLY_PROP_CURRENT_AVG:
 595                 val->intval = ec_read_s16(BAT_CURRENT_AVG) * 1000;
 596                 break;
 597         case POWER_SUPPLY_PROP_POWER_NOW:
 598                 val->intval = ec_read_u8(BAT_POWER) * 1000000;
 599                 break;
 600         case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
 601                 val->intval = ec_read_u16(BAT_CHARGE_DESIGN) * 1000;
 602                 break;
 603         case POWER_SUPPLY_PROP_CHARGE_NOW:
 604                 val->intval = ec_read_u16(BAT_CHARGE_NOW) * 1000;
 605                 break;
 606         case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
 607                 val->intval = ec_read_u8(BAT_CHARGE_LIMIT);
 608                 break;
 609         case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX:
 610                 val->intval = BAT_CHARGE_LIMIT_MAX;
 611                 break;
 612         case POWER_SUPPLY_PROP_CAPACITY:
 613                 val->intval = ec_read_u8(BAT_CAPACITY);
 614                 break;
 615         case POWER_SUPPLY_PROP_CAPACITY_LEVEL:
 616                 val->intval = bat_capacity_level();
 617                 break;
 618         /* It smees that BAT_TEMP_AVG is a (2's complement?) value showing
 619          * the number of degrees, whereas BAT_TEMP is somewhat more
 620          * complicated. It looks like this is a negative nember with a
 621          * 100/256 divider and an offset of 222. Both were determined
 622          * experimentally by comparing BAT_TEMP and BAT_TEMP_AVG. */
 623         case POWER_SUPPLY_PROP_TEMP:
 624                 val->intval = ((222 - (int)ec_read_u8(BAT_TEMP)) * 1000) >> 8;
 625                 break;
 626         case POWER_SUPPLY_PROP_TEMP_AMBIENT: /* Ambient, Avg, ... same thing */
 627                 val->intval = ec_read_s8(BAT_TEMP_AVG) * 10;
 628                 break;
 629         /* Neither the model name nor manufacturer name work for me. */
 630         case POWER_SUPPLY_PROP_MODEL_NAME:
 631                 val->strval = data->bat_model_name;
 632                 break;
 633         case POWER_SUPPLY_PROP_MANUFACTURER:
 634                 val->strval = data->bat_manufacturer_name;
 635                 break;
 636         case POWER_SUPPLY_PROP_SERIAL_NUMBER:
 637                 val->strval = data->bat_serial_number;
 638                 break;
 639         default:
 640                 break;
 641         }
 642         return 0;
 643 }
 644
 645 static int bat_set_property(struct power_supply *psy,
 646                                 enum power_supply_property psp,
 647                                 const union power_supply_propval *val)
 648 {
 649         int level;
 650
 651         switch (psp) {
 652         case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
 653                 level = val->intval;
 654                 if (level < 0 || level > BAT_CHARGE_LIMIT_MAX)
 655                         return -EINVAL;
 656                 if (ec_write(BAT_CHARGE_LIMIT, level) < 0)
 657                         return -EIO;
 658                 break;
 659         default:
 660                 break;
 661         }
 662         return 0;
 663 }
 664
 665 static int bat_writeable_property(struct power_supply *psy,
 666                                 enum power_supply_property psp)
 667 {
 668         switch (psp) {
 669         case POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT:
 670                 return 1;
 671         default:
 672                 return 0;
 673         }
 674 }
 675
 676
 677
 678
 679 /* ============== */
 680 /* Driver Globals */
 681 /* ============== */
 682 static DEVICE_ATTR_RW(wake_up_pme);
 683 static DEVICE_ATTR_RW(wake_up_modem);
 684 static DEVICE_ATTR_RW(wake_up_lan);
 685 static DEVICE_ATTR_RW(wake_up_wlan);
 686 static DEVICE_ATTR_RW(wake_up_key);
 687 static DEVICE_ATTR_RW(wake_up_mouse);
 688
 689 static DEVICE_ATTR(fan1_input,  S_IRUGO, fan_show,          NULL);
 690 static DEVICE_ATTR(temp1_input, S_IRUGO, temp_cpu,          NULL);
 691 static DEVICE_ATTR(temp2_input, S_IRUGO, temp_cpu_local,    NULL);
 692 static DEVICE_ATTR(temp3_input, S_IRUGO, temp_cpu_DTS,      NULL);
 693 static DEVICE_ATTR(temp4_input, S_IRUGO, temp_northbridge,  NULL);
 694 static DEVICE_ATTR(temp5_input, S_IRUGO, temp_vga,          NULL);
 695 static DEVICE_ATTR(temp6_input, S_IRUGO, temp_SKIN,         NULL);
 696 static DEVICE_ATTR(temp1_label, S_IRUGO, label_cpu,         NULL);
 697 static DEVICE_ATTR(temp2_label, S_IRUGO, label_cpu_local,   NULL);
 698 static DEVICE_ATTR(temp3_label, S_IRUGO, label_cpu_DTS,     NULL);
 699 static DEVICE_ATTR(temp4_label, S_IRUGO, label_northbridge, NULL);
 700 static DEVICE_ATTR(temp5_label, S_IRUGO, label_vga,         NULL);
 701 static DEVICE_ATTR(temp6_label, S_IRUGO, label_SKIN,        NULL);
 702 static DEVICE_ATTR(pwm1, S_IRUGO | S_IWUSR, pwm_show, pwm_store);
 703 static DEVICE_ATTR(pwm1_enable,
 704                    S_IRUGO | S_IWUSR, pwm_enable_show, pwm_enable_store);
 705
 706 static struct attribute *compal_platform_attrs[] = {
 707         &dev_attr_wake_up_pme.attr,
 708         &dev_attr_wake_up_modem.attr,
 709         &dev_attr_wake_up_lan.attr,
 710         &dev_attr_wake_up_wlan.attr,
 711         &dev_attr_wake_up_key.attr,
 712         &dev_attr_wake_up_mouse.attr,
 713         NULL
 714 };
 715 static const struct attribute_group compal_platform_attr_group = {
 716         .attrs = compal_platform_attrs
 717 };
 718
 719 static struct attribute *compal_hwmon_attrs[] = {
 720         &dev_attr_pwm1_enable.attr,
 721         &dev_attr_pwm1.attr,
 722         &dev_attr_fan1_input.attr,
 723         &dev_attr_temp1_input.attr,
 724         &dev_attr_temp2_input.attr,
 725         &dev_attr_temp3_input.attr,
 726         &dev_attr_temp4_input.attr,
 727         &dev_attr_temp5_input.attr,
 728         &dev_attr_temp6_input.attr,
 729         &dev_attr_temp1_label.attr,
 730         &dev_attr_temp2_label.attr,
 731         &dev_attr_temp3_label.attr,
 732         &dev_attr_temp4_label.attr,
 733         &dev_attr_temp5_label.attr,
 734         &dev_attr_temp6_label.attr,
 735         NULL
 736 };
 737 ATTRIBUTE_GROUPS(compal_hwmon);
 738
 739 static int compal_probe(struct platform_device *);
 740 static int compal_remove(struct platform_device *);
 741 static struct platform_driver compal_driver = {
 742         .driver = {
 743                 .name = DRIVER_NAME,
 744         },
 745         .probe  = compal_probe,
 746         .remove = compal_remove,
 747 };
 748
 749 static enum power_supply_property compal_bat_properties[] = {
 750         POWER_SUPPLY_PROP_STATUS,
 751         POWER_SUPPLY_PROP_HEALTH,
 752         POWER_SUPPLY_PROP_PRESENT,
 753         POWER_SUPPLY_PROP_TECHNOLOGY,
 754         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
 755         POWER_SUPPLY_PROP_VOLTAGE_NOW,
 756         POWER_SUPPLY_PROP_CURRENT_NOW,
 757         POWER_SUPPLY_PROP_CURRENT_AVG,
 758         POWER_SUPPLY_PROP_POWER_NOW,
 759         POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
 760         POWER_SUPPLY_PROP_CHARGE_NOW,
 761         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT,
 762         POWER_SUPPLY_PROP_CHARGE_CONTROL_LIMIT_MAX,
 763         POWER_SUPPLY_PROP_CAPACITY,
 764         POWER_SUPPLY_PROP_CAPACITY_LEVEL,
 765         POWER_SUPPLY_PROP_TEMP,
 766         POWER_SUPPLY_PROP_TEMP_AMBIENT,
 767         POWER_SUPPLY_PROP_MODEL_NAME,
 768         POWER_SUPPLY_PROP_MANUFACTURER,
 769         POWER_SUPPLY_PROP_SERIAL_NUMBER,
 770 };
 771
 772 static struct backlight_device *compalbl_device;
 773
 774 static struct platform_device *compal_device;
 775
 776 static struct rfkill *wifi_rfkill;
 777 static struct rfkill *bt_rfkill;
 778
 779
 780
 781
 782
 783 /* =================================== */
 784 /* Initialization & clean-up functions */
 785 /* =================================== */
 786
 787 static int dmi_check_cb(const struct dmi_system_id *id)
 788 {
 789         pr_info("Identified laptop model '%s'\n", id->ident);
 790         extra_features = false;
 791         return 1;
 792 }
 793
 794 static int dmi_check_cb_extra(const struct dmi_system_id *id)
 795 {
 796         pr_info("Identified laptop model '%s', enabling extra features\n",
 797                 id->ident);
 798         extra_features = true;
 799         return 1;
 800 }
 801
 802 static const struct dmi_system_id compal_dmi_table[] __initconst = {
 803         {
 804                 .ident = "FL90/IFL90",
 805                 .matches = {
 806                         DMI_MATCH(DMI_BOARD_NAME, "IFL90"),
 807                         DMI_MATCH(DMI_BOARD_VERSION, "IFT00"),
 808                 },
 809                 .callback = dmi_check_cb
 810         },
 811         {
 812                 .ident = "FL90/IFL90",
 813                 .matches = {
 814                         DMI_MATCH(DMI_BOARD_NAME, "IFL90"),
 815                         DMI_MATCH(DMI_BOARD_VERSION, "REFERENCE"),
 816                 },
 817                 .callback = dmi_check_cb
 818         },
 819         {
 820                 .ident = "FL91/IFL91",
 821                 .matches = {
 822                         DMI_MATCH(DMI_BOARD_NAME, "IFL91"),
 823                         DMI_MATCH(DMI_BOARD_VERSION, "IFT00"),
 824                 },
 825                 .callback = dmi_check_cb
 826         },
 827         {
 828                 .ident = "FL92/JFL92",
 829                 .matches = {
 830                         DMI_MATCH(DMI_BOARD_NAME, "JFL92"),
 831                         DMI_MATCH(DMI_BOARD_VERSION, "IFT00"),
 832                 },
 833                 .callback = dmi_check_cb
 834         },
 835         {
 836                 .ident = "FT00/IFT00",
 837                 .matches = {
 838                         DMI_MATCH(DMI_BOARD_NAME, "IFT00"),
 839                         DMI_MATCH(DMI_BOARD_VERSION, "IFT00"),
 840                 },
 841                 .callback = dmi_check_cb
 842         },
 843         {
 844                 .ident = "Dell Mini 9",
 845                 .matches = {
 846                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 847                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 910"),
 848                 },
 849                 .callback = dmi_check_cb
 850         },
 851         {
 852                 .ident = "Dell Mini 10",
 853                 .matches = {
 854                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 855                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 1010"),
 856                 },
 857                 .callback = dmi_check_cb
 858         },
 859         {
 860                 .ident = "Dell Mini 10v",
 861                 .matches = {
 862                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 863                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 1011"),
 864                 },
 865                 .callback = dmi_check_cb
 866         },
 867         {
 868                 .ident = "Dell Mini 1012",
 869                 .matches = {
 870                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 871                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 1012"),
 872                 },
 873                 .callback = dmi_check_cb
 874         },
 875         {
 876                 .ident = "Dell Inspiron 11z",
 877                 .matches = {
 878                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 879                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 1110"),
 880                 },
 881                 .callback = dmi_check_cb
 882         },
 883         {
 884                 .ident = "Dell Mini 12",
 885                 .matches = {
 886                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
 887                         DMI_MATCH(DMI_PRODUCT_NAME, "Inspiron 1210"),
 888                 },
 889                 .callback = dmi_check_cb
 890         },
 891         {
 892                 .ident = "JHL90",
 893                 .matches = {
 894                         DMI_MATCH(DMI_BOARD_NAME, "JHL90"),
 895                         DMI_MATCH(DMI_BOARD_VERSION, "REFERENCE"),
 896                 },
 897                 .callback = dmi_check_cb_extra
 898         },
 899         {
 900                 .ident = "KHLB2",
 901                 .matches = {
 902                         DMI_MATCH(DMI_BOARD_NAME, "KHLB2"),
 903                         DMI_MATCH(DMI_BOARD_VERSION, "REFERENCE"),
 904                 },
 905                 .callback = dmi_check_cb_extra
 906         },
 907         { }
 908 };
 909 MODULE_DEVICE_TABLE(dmi, compal_dmi_table);
 910
 911 static const struct power_supply_desc psy_bat_desc = {
 912         .name           = DRIVER_NAME,
 913         .type           = POWER_SUPPLY_TYPE_BATTERY,
 914         .properties     = compal_bat_properties,
 915         .num_properties = ARRAY_SIZE(compal_bat_properties),
 916         .get_property   = bat_get_property,
 917         .set_property   = bat_set_property,
 918         .property_is_writeable = bat_writeable_property,
 919 };
 920
 921 static void initialize_power_supply_data(struct compal_data *data)
 922 {
 923         ec_read_sequence(BAT_MANUFACTURER_NAME_ADDR,
 924                                         data->bat_manufacturer_name,
 925                                         BAT_MANUFACTURER_NAME_LEN);
 926         data->bat_manufacturer_name[BAT_MANUFACTURER_NAME_LEN] = 0;
 927
 928         ec_read_sequence(BAT_MODEL_NAME_ADDR,
 929                                         data->bat_model_name,
 930                                         BAT_MODEL_NAME_LEN);
 931         data->bat_model_name[BAT_MODEL_NAME_LEN] = 0;
 932
 933         scnprintf(data->bat_serial_number, BAT_SERIAL_NUMBER_LEN + 1, "%d",
 934                                 ec_read_u16(BAT_SERIAL_NUMBER_ADDR));
 935 }
 936
 937 static void initialize_fan_control_data(struct compal_data *data)
 938 {
 939         data->pwm_enable = 2; /* Keep motherboard in control for now */
 940         data->curr_pwm = 255; /* Try not to cause a CPU_on_fire exception
 941                                  if we take over... */
 942 }
 943
 944 static int setup_rfkill(void)
 945 {
 946         int ret;
 947
 948         wifi_rfkill = rfkill_alloc("compal-wifi", &compal_device->dev,
 949                                 RFKILL_TYPE_WLAN, &compal_rfkill_ops,
 950                                 (void *) WIRELESS_WLAN);
 951         if (!wifi_rfkill)
 952                 return -ENOMEM;
 953
 954         ret = rfkill_register(wifi_rfkill);
 955         if (ret)
 956                 goto err_wifi;
 957
 958         bt_rfkill = rfkill_alloc("compal-bluetooth", &compal_device->dev,
 959                                 RFKILL_TYPE_BLUETOOTH, &compal_rfkill_ops,
 960                                 (void *) WIRELESS_BT);
 961         if (!bt_rfkill) {
 962                 ret = -ENOMEM;
 963                 goto err_allocate_bt;
 964         }
 965         ret = rfkill_register(bt_rfkill);
 966         if (ret)
 967                 goto err_register_bt;
 968
 969         return 0;
 970
 971 err_register_bt:
 972         rfkill_destroy(bt_rfkill);
 973
 974 err_allocate_bt:
 975         rfkill_unregister(wifi_rfkill);
 976
 977 err_wifi:
 978         rfkill_destroy(wifi_rfkill);
 979
 980         return ret;
 981 }
 982
 983 static int __init compal_init(void)
 984 {
 985         int ret;
 986
 987         if (acpi_disabled) {
 988                 pr_err("ACPI needs to be enabled for this driver to work!\n");
 989                 return -ENODEV;
 990         }
 991
 992         if (!force && !dmi_check_system(compal_dmi_table)) {
 993                 pr_err("Motherboard not recognized (You could try the module's force-parameter)\n");
 994                 return -ENODEV;
 995         }
 996
 997         if (acpi_video_get_backlight_type() == acpi_backlight_vendor) {
 998                 struct backlight_properties props;
 999                 memset(&props, 0, sizeof(struct backlight_properties));
1000                 props.type = BACKLIGHT_PLATFORM;
1001                 props.max_brightness = BACKLIGHT_LEVEL_MAX;
1002                 compalbl_device = backlight_device_register(DRIVER_NAME,
1003                                                             NULL, NULL,
1004                                                             &compalbl_ops,
1005                                                             &props);
1006                 if (IS_ERR(compalbl_device))
1007                         return PTR_ERR(compalbl_device);
1008         }
1009
1010         ret = platform_driver_register(&compal_driver);
1011         if (ret)
1012                 goto err_backlight;
1013
1014         compal_device = platform_device_alloc(DRIVER_NAME, -1);
1015         if (!compal_device) {
1016                 ret = -ENOMEM;
1017                 goto err_platform_driver;
1018         }
1019
1020         ret = platform_device_add(compal_device); /* This calls compal_probe */
1021         if (ret)
1022                 goto err_platform_device;
1023
1024         ret = setup_rfkill();
1025         if (ret)
1026                 goto err_rfkill;
1027
1028         pr_info("Driver " DRIVER_VERSION " successfully loaded\n");
1029         return 0;
1030
1031 err_rfkill:
1032         platform_device_del(compal_device);
1033
1034 err_platform_device:
1035         platform_device_put(compal_device);
1036
1037 err_platform_driver:
1038         platform_driver_unregister(&compal_driver);
1039
1040 err_backlight:
1041         backlight_device_unregister(compalbl_device);
1042
1043         return ret;
1044 }
1045
1046 static int compal_probe(struct platform_device *pdev)
1047 {
1048         int err;
1049         struct compal_data *data;
1050         struct device *hwmon_dev;
1051         struct power_supply_config psy_cfg = {};
1052
1053         if (!extra_features)
1054                 return 0;
1055
1056         /* Fan control */
1057         data = devm_kzalloc(&pdev->dev, sizeof(struct compal_data), GFP_KERNEL);
1058         if (!data)
1059                 return -ENOMEM;
1060
1061         initialize_fan_control_data(data);
1062
1063         err = sysfs_create_group(&pdev->dev.kobj, &compal_platform_attr_group);
1064         if (err)
1065                 return err;
1066
1067         hwmon_dev = devm_hwmon_device_register_with_groups(&pdev->dev,
1068                                                            "compal", data,
1069                                                            compal_hwmon_groups);
1070         if (IS_ERR(hwmon_dev)) {
1071                 err = PTR_ERR(hwmon_dev);
1072                 goto remove;
1073         }
1074
1075         /* Power supply */
1076         initialize_power_supply_data(data);
1077         psy_cfg.drv_data = data;
1078         data->psy = power_supply_register(&compal_device->dev, &psy_bat_desc,
1079                                           &psy_cfg);
1080         if (IS_ERR(data->psy)) {
1081                 err = PTR_ERR(data->psy);
1082                 goto remove;
1083         }
1084
1085         platform_set_drvdata(pdev, data);
1086
1087         return 0;
1088
1089 remove:
1090         sysfs_remove_group(&pdev->dev.kobj, &compal_platform_attr_group);
1091         return err;
1092 }
1093
1094 static void __exit compal_cleanup(void)
1095 {
1096         platform_device_unregister(compal_device);
1097         platform_driver_unregister(&compal_driver);
1098         backlight_device_unregister(compalbl_device);
1099         rfkill_unregister(wifi_rfkill);
1100         rfkill_unregister(bt_rfkill);
1101         rfkill_destroy(wifi_rfkill);
1102         rfkill_destroy(bt_rfkill);
1103
1104         pr_info("Driver unloaded\n");
1105 }
1106
1107 static int compal_remove(struct platform_device *pdev)
1108 {
1109         struct compal_data *data;
1110
1111         if (!extra_features)
1112                 return 0;
1113
1114         pr_info("Unloading: resetting fan control to motherboard\n");
1115         pwm_disable_control();
1116
1117         data = platform_get_drvdata(pdev);
1118         power_supply_unregister(data->psy);
1119
1120         sysfs_remove_group(&pdev->dev.kobj, &compal_platform_attr_group);
1121
1122         return 0;
1123 }
1124
1125
1126 module_init(compal_init);
1127 module_exit(compal_cleanup);
1128
1129 MODULE_AUTHOR("Cezary Jackiewicz");
1130 MODULE_AUTHOR("Roald Frederickx (roald.frederickx@gmail.com)");
1131 MODULE_DESCRIPTION("Compal Laptop Support");
1132 MODULE_VERSION(DRIVER_VERSION);
1133 MODULE_LICENSE("GPL");