drivers/misc/intel_menlow.c

   1 /*
   2  *  intel_menlow.c - Intel menlow Driver for thermal management extension
   3  *
   4  *  Copyright (C) 2008 Intel Corp
   5  *  Copyright (C) 2008 Sujith Thomas <sujith.thomas@intel.com>
   6  *  Copyright (C) 2008 Zhang Rui <rui.zhang@intel.com>
   7  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; version 2 of the License.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  *
  24  *  This driver creates the sys I/F for programming the sensors.
  25  *  It also implements the driver for intel menlow memory controller (hardware
  26  *  id is INT0002) which makes use of the platform specific ACPI methods
  27  *  to get/set bandwidth.
  28  */
  29
  30 #include <linux/kernel.h>
  31 #include <linux/module.h>
  32 #include <linux/init.h>
  33 #include <linux/types.h>
  34 #include <linux/pci.h>
  35 #include <linux/pm.h>
  36
  37 #include <linux/thermal.h>
  38 #include <acpi/acpi_bus.h>
  39 #include <acpi/acpi_drivers.h>
  40
  41 MODULE_AUTHOR("Thomas Sujith");
  42 MODULE_AUTHOR("Zhang Rui");
  43 MODULE_DESCRIPTION("Intel Menlow platform specific driver");
  44 MODULE_LICENSE("GPL");
  45
  46 /*
  47  * Memory controller device control
  48  */
  49
  50 #define MEMORY_GET_BANDWIDTH "GTHS"
  51 #define MEMORY_SET_BANDWIDTH "STHS"
  52 #define MEMORY_ARG_CUR_BANDWIDTH 1
  53 #define MEMORY_ARG_MAX_BANDWIDTH 0
  54
  55 static int memory_get_int_max_bandwidth(struct thermal_cooling_device *cdev,
  56                                         unsigned long *max_state)
  57 {
  58         struct acpi_device *device = cdev->devdata;
  59         acpi_handle handle = device->handle;
  60         unsigned long value;
  61         struct acpi_object_list arg_list;
  62         union acpi_object arg;
  63         acpi_status status = AE_OK;
  64
  65         arg_list.count = 1;
  66         arg_list.pointer = &arg;
  67         arg.type = ACPI_TYPE_INTEGER;
  68         arg.integer.value = MEMORY_ARG_MAX_BANDWIDTH;
  69         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
  70                                        &arg_list, &value);
  71         if (ACPI_FAILURE(status))
  72                 return -EFAULT;
  73
  74         *max_state = value - 1;
  75         return 0;
  76 }
  77
  78 static int memory_get_max_bandwidth(struct thermal_cooling_device *cdev,
  79                                     char *buf)
  80 {
  81         unsigned long value;
  82         if (memory_get_int_max_bandwidth(cdev, &value))
  83                 return -EINVAL;
  84
  85         return sprintf(buf, "%ld\n", value);
  86 }
  87
  88 static int memory_get_cur_bandwidth(struct thermal_cooling_device *cdev,
  89                                     char *buf)
  90 {
  91         struct acpi_device *device = cdev->devdata;
  92         acpi_handle handle = device->handle;
  93         unsigned long value;
  94         struct acpi_object_list arg_list;
  95         union acpi_object arg;
  96         acpi_status status = AE_OK;
  97
  98         arg_list.count = 1;
  99         arg_list.pointer = &arg;
 100         arg.type = ACPI_TYPE_INTEGER;
 101         arg.integer.value = MEMORY_ARG_CUR_BANDWIDTH;
 102         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
 103                                        &arg_list, &value);
 104         if (ACPI_FAILURE(status))
 105                 return -EFAULT;
 106
 107         return sprintf(buf, "%ld\n", value);
 108 }
 109
 110 static int memory_set_cur_bandwidth(struct thermal_cooling_device *cdev,
 111                                     unsigned int state)
 112 {
 113         struct acpi_device *device = cdev->devdata;
 114         acpi_handle handle = device->handle;
 115         struct acpi_object_list arg_list;
 116         union acpi_object arg;
 117         acpi_status status;
 118         int temp;
 119         unsigned long max_state;
 120
 121         if (memory_get_int_max_bandwidth(cdev, &max_state))
 122                 return -EFAULT;
 123
 124         if (max_state < 0 || state > max_state)
 125                 return -EINVAL;
 126
 127         arg_list.count = 1;
 128         arg_list.pointer = &arg;
 129         arg.type = ACPI_TYPE_INTEGER;
 130         arg.integer.value = state;
 131
 132         status =
 133             acpi_evaluate_integer(handle, MEMORY_SET_BANDWIDTH, &arg_list,
 134                                   (unsigned long *)&temp);
 135
 136         printk(KERN_INFO
 137                "Bandwidth value was %d: status is %d\n", state, status);
 138         if (ACPI_FAILURE(status))
 139                 return -EFAULT;
 140
 141         return 0;
 142 }
 143
 144 static struct thermal_cooling_device_ops memory_cooling_ops = {
 145         .get_max_state = memory_get_max_bandwidth,
 146         .get_cur_state = memory_get_cur_bandwidth,
 147         .set_cur_state = memory_set_cur_bandwidth,
 148 };
 149
 150 /*
 151  * Memory Device Management
 152  */
 153 static int intel_menlow_memory_add(struct acpi_device *device)
 154 {
 155         int result = -ENODEV;
 156         acpi_status status = AE_OK;
 157         acpi_handle dummy;
 158         struct thermal_cooling_device *cdev;
 159
 160         if (!device)
 161                 return -EINVAL;
 162
 163         status = acpi_get_handle(device->handle, MEMORY_GET_BANDWIDTH, &dummy);
 164         if (ACPI_FAILURE(status))
 165                 goto end;
 166
 167         status = acpi_get_handle(device->handle, MEMORY_SET_BANDWIDTH, &dummy);
 168         if (ACPI_FAILURE(status))
 169                 goto end;
 170
 171         cdev = thermal_cooling_device_register("Memory controller", device,
 172                                                &memory_cooling_ops);
 173         if (IS_ERR(cdev)) {
 174                 result = PTR_ERR(cdev);
 175                 goto end;
 176         }
 177
 178         acpi_driver_data(device) = cdev;
 179         result = sysfs_create_link(&device->dev.kobj,
 180                                 &cdev->device.kobj, "thermal_cooling");
 181         if (result)
 182                 printk(KERN_ERR PREFIX "Create sysfs link\n");
 183         result = sysfs_create_link(&cdev->device.kobj,
 184                                 &device->dev.kobj, "device");
 185         if (result)
 186                 printk(KERN_ERR PREFIX "Create sysfs link\n");
 187
 188  end:
 189         return result;
 190 }
 191
 192 static int intel_menlow_memory_remove(struct acpi_device *device, int type)
 193 {
 194         struct thermal_cooling_device *cdev = acpi_driver_data(device);
 195
 196         if (!device || !cdev)
 197                 return -EINVAL;
 198
 199         sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 200         sysfs_remove_link(&cdev->device.kobj, "device");
 201         thermal_cooling_device_unregister(cdev);
 202
 203         return 0;
 204 }
 205
 206 static const struct acpi_device_id intel_menlow_memory_ids[] = {
 207         {"INT0002", 0},
 208         {"", 0},
 209 };
 210
 211 static struct acpi_driver intel_menlow_memory_driver = {
 212         .name = "intel_menlow_thermal_control",
 213         .ids = intel_menlow_memory_ids,
 214         .ops = {
 215                 .add = intel_menlow_memory_add,
 216                 .remove = intel_menlow_memory_remove,
 217                 },
 218 };
 219
 220 /*
 221  * Sensor control on menlow platform
 222  */
 223
 224 #define THERMAL_AUX0 0
 225 #define THERMAL_AUX1 1
 226 #define GET_AUX0 "GAX0"
 227 #define GET_AUX1 "GAX1"
 228 #define SET_AUX0 "SAX0"
 229 #define SET_AUX1 "SAX1"
 230
 231 struct intel_menlow_attribute {
 232         struct device_attribute attr;
 233         struct device *device;
 234         acpi_handle handle;
 235         struct list_head node;
 236 };
 237
 238 static LIST_HEAD(intel_menlow_attr_list);
 239 static DEFINE_MUTEX(intel_menlow_attr_lock);
 240
 241 /*
 242  * sensor_get_auxtrip - get the current auxtrip value from sensor
 243  * @name: Thermalzone name
 244  * @auxtype : AUX0/AUX1
 245  * @buf: syfs buffer
 246  */
 247 static int sensor_get_auxtrip(acpi_handle handle, int index, int *value)
 248 {
 249         acpi_status status;
 250
 251         if ((index != 0 && index != 1) || !value)
 252                 return -EINVAL;
 253
 254         status = acpi_evaluate_integer(handle, index ? GET_AUX1 : GET_AUX0,
 255                                        NULL, (unsigned long *)value);
 256         if (ACPI_FAILURE(status))
 257                 return -EIO;
 258
 259         return 0;
 260 }
 261
 262 /*
 263  * sensor_set_auxtrip - set the new auxtrip value to sensor
 264  * @name: Thermalzone name
 265  * @auxtype : AUX0/AUX1
 266  * @buf: syfs buffer
 267  */
 268 static int sensor_set_auxtrip(acpi_handle handle, int index, int value)
 269 {
 270         acpi_status status;
 271         union acpi_object arg = {
 272                 ACPI_TYPE_INTEGER
 273         };
 274         struct acpi_object_list args = {
 275                 1, &arg
 276         };
 277         int temp;
 278
 279         if (index != 0 && index != 1)
 280                 return -EINVAL;
 281
 282         status = acpi_evaluate_integer(handle, index ? GET_AUX0 : GET_AUX1,
 283                                        NULL, (unsigned long *)&temp);
 284         if (ACPI_FAILURE(status))
 285                 return -EIO;
 286         if ((index && value < temp) || (!index && value > temp))
 287                 return -EINVAL;
 288
 289         arg.integer.value = value;
 290         status = acpi_evaluate_integer(handle, index ? SET_AUX1 : SET_AUX0,
 291                                        &args, (unsigned long *)&temp);
 292         if (ACPI_FAILURE(status))
 293                 return -EIO;
 294
 295         /* do we need to check the return value of SAX0/SAX1 ? */
 296
 297         return 0;
 298 }
 299
 300 #define to_intel_menlow_attr(_attr)     \
 301         container_of(_attr, struct intel_menlow_attribute, attr)
 302
 303 static ssize_t aux0_show(struct device *dev,
 304                          struct device_attribute *dev_attr, char *buf)
 305 {
 306         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 307         int value;
 308         int result;
 309
 310         result = sensor_get_auxtrip(attr->handle, 0, &value);
 311
 312         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 313 }
 314
 315 static ssize_t aux1_show(struct device *dev,
 316                          struct device_attribute *dev_attr, char *buf)
 317 {
 318         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 319         int value;
 320         int result;
 321
 322         result = sensor_get_auxtrip(attr->handle, 1, &value);
 323
 324         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 325 }
 326
 327 static ssize_t aux0_store(struct device *dev,
 328                           struct device_attribute *dev_attr,
 329                           const char *buf, size_t count)
 330 {
 331         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 332         int value;
 333         int result;
 334
 335         /*Sanity check; should be a positive integer */
 336         if (!sscanf(buf, "%d", &value))
 337                 return -EINVAL;
 338
 339         if (value < 0)
 340                 return -EINVAL;
 341
 342         result = sensor_set_auxtrip(attr->handle, 0, CELSIUS_TO_KELVIN(value));
 343         return result ? result : count;
 344 }
 345
 346 static ssize_t aux1_store(struct device *dev,
 347                           struct device_attribute *dev_attr,
 348                           const char *buf, size_t count)
 349 {
 350         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 351         int value;
 352         int result;
 353
 354         /*Sanity check; should be a positive integer */
 355         if (!sscanf(buf, "%d", &value))
 356                 return -EINVAL;
 357
 358         if (value < 0)
 359                 return -EINVAL;
 360
 361         result = sensor_set_auxtrip(attr->handle, 1, CELSIUS_TO_KELVIN(value));
 362         return result ? result : count;
 363 }
 364
 365 /* BIOS can enable/disable the thermal user application in dabney platform */
 366 #define BIOS_ENABLED "\\_TZ.GSTS"
 367 static ssize_t bios_enabled_show(struct device *dev,
 368                                  struct device_attribute *attr, char *buf)
 369 {
 370         acpi_status status;
 371         unsigned long bios_enabled;
 372
 373         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &bios_enabled);
 374         if (ACPI_FAILURE(status))
 375                 return -ENODEV;
 376
 377         return sprintf(buf, "%s\n", bios_enabled ? "enabled" : "disabled");
 378 }
 379
 380 static int intel_menlow_add_one_attribute(char *name, int mode, void *show,
 381                                           void *store, struct device *dev,
 382                                           acpi_handle handle)
 383 {
 384         struct intel_menlow_attribute *attr;
 385         int result;
 386
 387         attr = kzalloc(sizeof(struct intel_menlow_attribute), GFP_KERNEL);
 388         if (!attr)
 389                 return -ENOMEM;
 390
 391         attr->attr.attr.name = name;
 392         attr->attr.attr.mode = mode;
 393         attr->attr.show = show;
 394         attr->attr.store = store;
 395         attr->device = dev;
 396         attr->handle = handle;
 397
 398         result = device_create_file(dev, &attr->attr);
 399         if (result)
 400                 return result;
 401
 402         mutex_lock(&intel_menlow_attr_lock);
 403         list_add_tail(&attr->node, &intel_menlow_attr_list);
 404         mutex_unlock(&intel_menlow_attr_lock);
 405
 406         return 0;
 407 }
 408
 409 static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl,
 410                                                 void *context, void **rv)
 411 {
 412         acpi_status status;
 413         acpi_handle dummy;
 414         struct thermal_zone_device *thermal;
 415         int result;
 416
 417         result = acpi_bus_get_private_data(handle, (void **)&thermal);
 418         if (result)
 419                 return 0;
 420
 421         /* _TZ must have the AUX0/1 methods */
 422         status = acpi_get_handle(handle, GET_AUX0, &dummy);
 423         if (ACPI_FAILURE(status))
 424                 goto not_found;
 425
 426         status = acpi_get_handle(handle, SET_AUX0, &dummy);
 427         if (ACPI_FAILURE(status))
 428                 goto not_found;
 429
 430         result = intel_menlow_add_one_attribute("aux0", 0644,
 431                                                 aux0_show, aux0_store,
 432                                                 &thermal->device, handle);
 433         if (result)
 434                 return AE_ERROR;
 435
 436         status = acpi_get_handle(handle, GET_AUX1, &dummy);
 437         if (ACPI_FAILURE(status))
 438                 goto not_found;
 439
 440         status = acpi_get_handle(handle, SET_AUX1, &dummy);
 441         if (ACPI_FAILURE(status))
 442                 goto not_found;
 443
 444         result = intel_menlow_add_one_attribute("aux1", 0644,
 445                                                 aux1_show, aux1_store,
 446                                                 &thermal->device, handle);
 447         if (result)
 448                 return AE_ERROR;
 449
 450         /*
 451          * create the "dabney_enabled" attribute which means the user app
 452          * should be loaded or not
 453          */
 454
 455         result = intel_menlow_add_one_attribute("bios_enabled", 0444,
 456                                                 bios_enabled_show, NULL,
 457                                                 &thermal->device, handle);
 458         if (result)
 459                 return AE_ERROR;
 460
 461  not_found:
 462         if (status == AE_NOT_FOUND)
 463                 return AE_OK;
 464         else
 465                 return status;
 466 }
 467
 468 static void intel_menlow_unregister_sensor(void)
 469 {
 470         struct intel_menlow_attribute *pos, *next;
 471
 472         mutex_lock(&intel_menlow_attr_lock);
 473         list_for_each_entry_safe(pos, next, &intel_menlow_attr_list, node) {
 474                 list_del(&pos->node);
 475                 device_remove_file(pos->device, &pos->attr);
 476                 kfree(pos);
 477         }
 478         mutex_unlock(&intel_menlow_attr_lock);
 479
 480         return;
 481 }
 482
 483 static int __init intel_menlow_module_init(void)
 484 {
 485         int result = -ENODEV;
 486         acpi_status status;
 487         unsigned long enable;
 488
 489         if (acpi_disabled)
 490                 return result;
 491
 492         /* Looking for the \_TZ.GSTS method */
 493         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &enable);
 494         if (ACPI_FAILURE(status) || !enable)
 495                 return -ENODEV;
 496
 497         /* Looking for ACPI device MEM0 with hardware id INT0002 */
 498         result = acpi_bus_register_driver(&intel_menlow_memory_driver);
 499         if (result)
 500                 return result;
 501
 502         /* Looking for sensors in each ACPI thermal zone */
 503         status = acpi_walk_namespace(ACPI_TYPE_THERMAL, ACPI_ROOT_OBJECT,
 504                                      ACPI_UINT32_MAX,
 505                                      intel_menlow_register_sensor, NULL, NULL);
 506         if (ACPI_FAILURE(status))
 507                 return -ENODEV;
 508
 509         return 0;
 510 }
 511
 512 static void __exit intel_menlow_module_exit(void)
 513 {
 514         acpi_bus_unregister_driver(&intel_menlow_memory_driver);
 515         intel_menlow_unregister_sensor();
 516 }
 517
 518 module_init(intel_menlow_module_init);
 519 module_exit(intel_menlow_module_exit);