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         acpi_driver_data(device) = cdev;
 174         if (!cdev)
 175                 result = -ENODEV;
 176         else {
 177                 result = sysfs_create_link(&device->dev.kobj,
 178                                         &cdev->device.kobj, "thermal_cooling");
 179                 if (result)
 180                         goto unregister;
 181
 182                 result = sysfs_create_link(&cdev->device.kobj,
 183                                         &device->dev.kobj, "device");
 184                 if (result) {
 185                         sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 186                         goto unregister;
 187                 }
 188         }
 189
 190  end:
 191         return result;
 192
 193  unregister:
 194         thermal_cooling_device_unregister(cdev);
 195         return result;
 196
 197 }
 198
 199 static int intel_menlow_memory_remove(struct acpi_device *device, int type)
 200 {
 201         struct thermal_cooling_device *cdev = acpi_driver_data(device);
 202
 203         if (!device || !cdev)
 204                 return -EINVAL;
 205
 206         sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 207         sysfs_remove_link(&cdev->device.kobj, "device");
 208         thermal_cooling_device_unregister(cdev);
 209
 210         return 0;
 211 }
 212
 213 const static struct acpi_device_id intel_menlow_memory_ids[] = {
 214         {"INT0002", 0},
 215         {"", 0},
 216 };
 217
 218 static struct acpi_driver intel_menlow_memory_driver = {
 219         .name = "intel_menlow_thermal_control",
 220         .ids = intel_menlow_memory_ids,
 221         .ops = {
 222                 .add = intel_menlow_memory_add,
 223                 .remove = intel_menlow_memory_remove,
 224                 },
 225 };
 226
 227 /*
 228  * Sensor control on menlow platform
 229  */
 230
 231 #define THERMAL_AUX0 0
 232 #define THERMAL_AUX1 1
 233 #define GET_AUX0 "GAX0"
 234 #define GET_AUX1 "GAX1"
 235 #define SET_AUX0 "SAX0"
 236 #define SET_AUX1 "SAX1"
 237
 238 struct intel_menlow_attribute {
 239         struct device_attribute attr;
 240         struct device *device;
 241         acpi_handle handle;
 242         struct list_head node;
 243 };
 244
 245 static LIST_HEAD(intel_menlow_attr_list);
 246 static DEFINE_MUTEX(intel_menlow_attr_lock);
 247
 248 /*
 249  * sensor_get_auxtrip - get the current auxtrip value from sensor
 250  * @name: Thermalzone name
 251  * @auxtype : AUX0/AUX1
 252  * @buf: syfs buffer
 253  */
 254 static int sensor_get_auxtrip(acpi_handle handle, int index, int *value)
 255 {
 256         acpi_status status;
 257
 258         if ((index != 0 && index != 1) || !value)
 259                 return -EINVAL;
 260
 261         status = acpi_evaluate_integer(handle, index ? GET_AUX1 : GET_AUX0,
 262                                        NULL, (unsigned long *)value);
 263         if (ACPI_FAILURE(status))
 264                 return -EIO;
 265
 266         return 0;
 267 }
 268
 269 /*
 270  * sensor_set_auxtrip - set the new auxtrip value to sensor
 271  * @name: Thermalzone name
 272  * @auxtype : AUX0/AUX1
 273  * @buf: syfs buffer
 274  */
 275 static int sensor_set_auxtrip(acpi_handle handle, int index, int value)
 276 {
 277         acpi_status status;
 278         union acpi_object arg = {
 279                 ACPI_TYPE_INTEGER
 280         };
 281         struct acpi_object_list args = {
 282                 1, &arg
 283         };
 284         int temp;
 285
 286         if (index != 0 && index != 1)
 287                 return -EINVAL;
 288
 289         status = acpi_evaluate_integer(handle, index ? GET_AUX0 : GET_AUX1,
 290                                        NULL, (unsigned long *)&temp);
 291         if (ACPI_FAILURE(status))
 292                 return -EIO;
 293         if ((index && value < temp) || (!index && value > temp))
 294                 return -EINVAL;
 295
 296         arg.integer.value = value;
 297         status = acpi_evaluate_integer(handle, index ? SET_AUX1 : SET_AUX0,
 298                                        &args, (unsigned long *)&temp);
 299         if (ACPI_FAILURE(status))
 300                 return -EIO;
 301
 302         /* do we need to check the return value of SAX0/SAX1 ? */
 303
 304         return 0;
 305 }
 306
 307 #define to_intel_menlow_attr(_attr)     \
 308         container_of(_attr, struct intel_menlow_attribute, attr)
 309
 310 static ssize_t aux0_show(struct device *dev,
 311                          struct device_attribute *dev_attr, char *buf)
 312 {
 313         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 314         int value;
 315         int result;
 316
 317         result = sensor_get_auxtrip(attr->handle, 0, &value);
 318
 319         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 320 }
 321
 322 static ssize_t aux1_show(struct device *dev,
 323                          struct device_attribute *dev_attr, char *buf)
 324 {
 325         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 326         int value;
 327         int result;
 328
 329         result = sensor_get_auxtrip(attr->handle, 1, &value);
 330
 331         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 332 }
 333
 334 static ssize_t aux0_store(struct device *dev,
 335                           struct device_attribute *dev_attr,
 336                           const char *buf, size_t count)
 337 {
 338         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 339         int value;
 340         int result;
 341
 342         /*Sanity check; should be a positive integer */
 343         if (!sscanf(buf, "%d", &value))
 344                 return -EINVAL;
 345
 346         if (value < 0)
 347                 return -EINVAL;
 348
 349         result = sensor_set_auxtrip(attr->handle, 0, CELSIUS_TO_KELVIN(value));
 350         return result ? result : count;
 351 }
 352
 353 static ssize_t aux1_store(struct device *dev,
 354                           struct device_attribute *dev_attr,
 355                           const char *buf, size_t count)
 356 {
 357         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 358         int value;
 359         int result;
 360
 361         /*Sanity check; should be a positive integer */
 362         if (!sscanf(buf, "%d", &value))
 363                 return -EINVAL;
 364
 365         if (value < 0)
 366                 return -EINVAL;
 367
 368         result = sensor_set_auxtrip(attr->handle, 1, CELSIUS_TO_KELVIN(value));
 369         return result ? result : count;
 370 }
 371
 372 /* BIOS can enable/disable the thermal user application in dabney platform */
 373 #define BIOS_ENABLED "\\_TZ.GSTS"
 374 static ssize_t bios_enabled_show(struct device *dev,
 375                                  struct device_attribute *attr, char *buf)
 376 {
 377         acpi_status status;
 378         unsigned long bios_enabled;
 379
 380         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &bios_enabled);
 381         if (ACPI_FAILURE(status))
 382                 return -ENODEV;
 383
 384         return sprintf(buf, "%s\n", bios_enabled ? "enabled" : "disabled");
 385 }
 386
 387 static int intel_menlow_add_one_attribute(char *name, int mode, void *show,
 388                                           void *store, struct device *dev,
 389                                           acpi_handle handle)
 390 {
 391         struct intel_menlow_attribute *attr;
 392         int result;
 393
 394         attr = kzalloc(sizeof(struct intel_menlow_attribute), GFP_KERNEL);
 395         if (!attr)
 396                 return -ENOMEM;
 397
 398         attr->attr.attr.name = name;
 399         attr->attr.attr.mode = mode;
 400         attr->attr.show = show;
 401         attr->attr.store = store;
 402         attr->device = dev;
 403         attr->handle = handle;
 404
 405         result = device_create_file(dev, &attr->attr);
 406         if (result)
 407                 return result;
 408
 409         mutex_lock(&intel_menlow_attr_lock);
 410         list_add_tail(&attr->node, &intel_menlow_attr_list);
 411         mutex_unlock(&intel_menlow_attr_lock);
 412
 413         return 0;
 414 }
 415
 416 static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl,
 417                                                 void *context, void **rv)
 418 {
 419         acpi_status status;
 420         acpi_handle dummy;
 421         struct thermal_zone_device *thermal;
 422         int result;
 423
 424         result = acpi_bus_get_private_data(handle, (void **)&thermal);
 425         if (result)
 426                 return 0;
 427
 428         /* _TZ must have the AUX0/1 methods */
 429         status = acpi_get_handle(handle, GET_AUX0, &dummy);
 430         if (ACPI_FAILURE(status))
 431                 goto not_found;
 432
 433         status = acpi_get_handle(handle, SET_AUX0, &dummy);
 434         if (ACPI_FAILURE(status))
 435                 goto not_found;
 436
 437         result = intel_menlow_add_one_attribute("aux0", 0644,
 438                                                 aux0_show, aux0_store,
 439                                                 &thermal->device, handle);
 440         if (result)
 441                 return AE_ERROR;
 442
 443         status = acpi_get_handle(handle, GET_AUX1, &dummy);
 444         if (ACPI_FAILURE(status))
 445                 goto not_found;
 446
 447         status = acpi_get_handle(handle, SET_AUX1, &dummy);
 448         if (ACPI_FAILURE(status))
 449                 goto not_found;
 450
 451         result = intel_menlow_add_one_attribute("aux1", 0644,
 452                                                 aux1_show, aux1_store,
 453                                                 &thermal->device, handle);
 454         if (result)
 455                 return AE_ERROR;
 456
 457         /*
 458          * create the "dabney_enabled" attribute which means the user app
 459          * should be loaded or not
 460          */
 461
 462         result = intel_menlow_add_one_attribute("bios_enabled", 0444,
 463                                                 bios_enabled_show, NULL,
 464                                                 &thermal->device, handle);
 465         if (result)
 466                 return AE_ERROR;
 467
 468  not_found:
 469         if (status == AE_NOT_FOUND)
 470                 return AE_OK;
 471         else
 472                 return status;
 473 }
 474
 475 static void intel_menlow_unregister_sensor(void)
 476 {
 477         struct intel_menlow_attribute *pos, *next;
 478
 479         mutex_lock(&intel_menlow_attr_lock);
 480         list_for_each_entry_safe(pos, next, &intel_menlow_attr_list, node) {
 481                 list_del(&pos->node);
 482                 device_remove_file(pos->device, &pos->attr);
 483                 kfree(pos);
 484         }
 485         mutex_unlock(&intel_menlow_attr_lock);
 486
 487         return;
 488 }
 489
 490 static int __init intel_menlow_module_init(void)
 491 {
 492         int result = -ENODEV;
 493         acpi_status status;
 494         unsigned long enable;
 495
 496         if (acpi_disabled)
 497                 return result;
 498
 499         /* Looking for the \_TZ.GSTS method */
 500         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &enable);
 501         if (ACPI_FAILURE(status) || !enable)
 502                 return -ENODEV;
 503
 504         /* Looking for ACPI device MEM0 with hardware id INT0002 */
 505         result = acpi_bus_register_driver(&intel_menlow_memory_driver);
 506         if (result)
 507                 return result;
 508
 509         /* Looking for sensors in each ACPI thermal zone */
 510         status = acpi_walk_namespace(ACPI_TYPE_THERMAL, ACPI_ROOT_OBJECT,
 511                                      ACPI_UINT32_MAX,
 512                                      intel_menlow_register_sensor, NULL, NULL);
 513         if (ACPI_FAILURE(status))
 514                 return -ENODEV;
 515
 516         return 0;
 517 }
 518
 519 static void __exit intel_menlow_module_exit(void)
 520 {
 521         acpi_bus_unregister_driver(&intel_menlow_memory_driver);
 522         intel_menlow_unregister_sensor();
 523 }
 524
 525 module_init(intel_menlow_module_init);
 526 module_exit(intel_menlow_module_exit);