drivers/platform/x86/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/slab.h>
  34 #include <linux/types.h>
  35 #include <linux/pci.h>
  36 #include <linux/pm.h>
  37
  38 #include <linux/thermal.h>
  39 #include <acpi/acpi_bus.h>
  40 #include <acpi/acpi_drivers.h>
  41
  42 MODULE_AUTHOR("Thomas Sujith");
  43 MODULE_AUTHOR("Zhang Rui");
  44 MODULE_DESCRIPTION("Intel Menlow platform specific driver");
  45 MODULE_LICENSE("GPL");
  46
  47 /*
  48  * Memory controller device control
  49  */
  50
  51 #define MEMORY_GET_BANDWIDTH "GTHS"
  52 #define MEMORY_SET_BANDWIDTH "STHS"
  53 #define MEMORY_ARG_CUR_BANDWIDTH 1
  54 #define MEMORY_ARG_MAX_BANDWIDTH 0
  55
  56 /*
  57  * GTHS returning 'n' would mean that [0,n-1] states are supported
  58  * In that case max_cstate would be n-1
  59  * GTHS returning '0' would mean that no bandwidth control states are supported
  60  */
  61 static int memory_get_max_bandwidth(struct thermal_cooling_device *cdev,
  62                                     unsigned long *max_state)
  63 {
  64         struct acpi_device *device = cdev->devdata;
  65         acpi_handle handle = device->handle;
  66         unsigned long long value;
  67         struct acpi_object_list arg_list;
  68         union acpi_object arg;
  69         acpi_status status = AE_OK;
  70
  71         arg_list.count = 1;
  72         arg_list.pointer = &arg;
  73         arg.type = ACPI_TYPE_INTEGER;
  74         arg.integer.value = MEMORY_ARG_MAX_BANDWIDTH;
  75         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
  76                                        &arg_list, &value);
  77         if (ACPI_FAILURE(status))
  78                 return -EFAULT;
  79
  80         if (!value)
  81                 return -EINVAL;
  82
  83         *max_state = value - 1;
  84         return 0;
  85 }
  86
  87 static int memory_get_cur_bandwidth(struct thermal_cooling_device *cdev,
  88                                     unsigned long *value)
  89 {
  90         struct acpi_device *device = cdev->devdata;
  91         acpi_handle handle = device->handle;
  92         unsigned long long result;
  93         struct acpi_object_list arg_list;
  94         union acpi_object arg;
  95         acpi_status status = AE_OK;
  96
  97         arg_list.count = 1;
  98         arg_list.pointer = &arg;
  99         arg.type = ACPI_TYPE_INTEGER;
 100         arg.integer.value = MEMORY_ARG_CUR_BANDWIDTH;
 101         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
 102                                        &arg_list, &result);
 103         if (ACPI_FAILURE(status))
 104                 return -EFAULT;
 105
 106         *value = result;
 107         return 0;
 108 }
 109
 110 static int memory_set_cur_bandwidth(struct thermal_cooling_device *cdev,
 111                                     unsigned long 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         unsigned long long temp;
 119         unsigned long max_state;
 120
 121         if (memory_get_max_bandwidth(cdev, &max_state))
 122                 return -EFAULT;
 123
 124         if (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                                   &temp);
 135
 136         printk(KERN_INFO
 137                "Bandwidth value was %ld: 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         device->driver_data = cdev;
 179         result = sysfs_create_link(&device->dev.kobj,
 180                                 &cdev->device.kobj, "thermal_cooling");
 181         if (result)
 182                 goto unregister;
 183
 184         result = sysfs_create_link(&cdev->device.kobj,
 185                                 &device->dev.kobj, "device");
 186         if (result) {
 187                 sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 188                 goto unregister;
 189         }
 190
 191  end:
 192         return result;
 193
 194  unregister:
 195         thermal_cooling_device_unregister(cdev);
 196         return result;
 197
 198 }
 199
 200 static int intel_menlow_memory_remove(struct acpi_device *device, int type)
 201 {
 202         struct thermal_cooling_device *cdev = acpi_driver_data(device);
 203
 204         if (!device || !cdev)
 205                 return -EINVAL;
 206
 207         sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 208         sysfs_remove_link(&cdev->device.kobj, "device");
 209         thermal_cooling_device_unregister(cdev);
 210
 211         return 0;
 212 }
 213
 214 static const struct acpi_device_id intel_menlow_memory_ids[] = {
 215         {"INT0002", 0},
 216         {"", 0},
 217 };
 218
 219 static struct acpi_driver intel_menlow_memory_driver = {
 220         .name = "intel_menlow_thermal_control",
 221         .ids = intel_menlow_memory_ids,
 222         .ops = {
 223                 .add = intel_menlow_memory_add,
 224                 .remove = intel_menlow_memory_remove,
 225                 },
 226 };
 227
 228 /*
 229  * Sensor control on menlow platform
 230  */
 231
 232 #define THERMAL_AUX0 0
 233 #define THERMAL_AUX1 1
 234 #define GET_AUX0 "GAX0"
 235 #define GET_AUX1 "GAX1"
 236 #define SET_AUX0 "SAX0"
 237 #define SET_AUX1 "SAX1"
 238
 239 struct intel_menlow_attribute {
 240         struct device_attribute attr;
 241         struct device *device;
 242         acpi_handle handle;
 243         struct list_head node;
 244 };
 245
 246 static LIST_HEAD(intel_menlow_attr_list);
 247 static DEFINE_MUTEX(intel_menlow_attr_lock);
 248
 249 /*
 250  * sensor_get_auxtrip - get the current auxtrip value from sensor
 251  * @name: Thermalzone name
 252  * @auxtype : AUX0/AUX1
 253  * @buf: syfs buffer
 254  */
 255 static int sensor_get_auxtrip(acpi_handle handle, int index,
 256                                                         unsigned long long *value)
 257 {
 258         acpi_status status;
 259
 260         if ((index != 0 && index != 1) || !value)
 261                 return -EINVAL;
 262
 263         status = acpi_evaluate_integer(handle, index ? GET_AUX1 : GET_AUX0,
 264                                        NULL, value);
 265         if (ACPI_FAILURE(status))
 266                 return -EIO;
 267
 268         return 0;
 269 }
 270
 271 /*
 272  * sensor_set_auxtrip - set the new auxtrip value to sensor
 273  * @name: Thermalzone name
 274  * @auxtype : AUX0/AUX1
 275  * @buf: syfs buffer
 276  */
 277 static int sensor_set_auxtrip(acpi_handle handle, int index, int value)
 278 {
 279         acpi_status status;
 280         union acpi_object arg = {
 281                 ACPI_TYPE_INTEGER
 282         };
 283         struct acpi_object_list args = {
 284                 1, &arg
 285         };
 286         unsigned long long temp;
 287
 288         if (index != 0 && index != 1)
 289                 return -EINVAL;
 290
 291         status = acpi_evaluate_integer(handle, index ? GET_AUX0 : GET_AUX1,
 292                                        NULL, &temp);
 293         if (ACPI_FAILURE(status))
 294                 return -EIO;
 295         if ((index && value < temp) || (!index && value > temp))
 296                 return -EINVAL;
 297
 298         arg.integer.value = value;
 299         status = acpi_evaluate_integer(handle, index ? SET_AUX1 : SET_AUX0,
 300                                        &args, &temp);
 301         if (ACPI_FAILURE(status))
 302                 return -EIO;
 303
 304         /* do we need to check the return value of SAX0/SAX1 ? */
 305
 306         return 0;
 307 }
 308
 309 #define to_intel_menlow_attr(_attr)     \
 310         container_of(_attr, struct intel_menlow_attribute, attr)
 311
 312 static ssize_t aux0_show(struct device *dev,
 313                          struct device_attribute *dev_attr, char *buf)
 314 {
 315         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 316         unsigned long long value;
 317         int result;
 318
 319         result = sensor_get_auxtrip(attr->handle, 0, &value);
 320
 321         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 322 }
 323
 324 static ssize_t aux1_show(struct device *dev,
 325                          struct device_attribute *dev_attr, char *buf)
 326 {
 327         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 328         unsigned long long value;
 329         int result;
 330
 331         result = sensor_get_auxtrip(attr->handle, 1, &value);
 332
 333         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 334 }
 335
 336 static ssize_t aux0_store(struct device *dev,
 337                           struct device_attribute *dev_attr,
 338                           const char *buf, size_t count)
 339 {
 340         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 341         int value;
 342         int result;
 343
 344         /*Sanity check; should be a positive integer */
 345         if (!sscanf(buf, "%d", &value))
 346                 return -EINVAL;
 347
 348         if (value < 0)
 349                 return -EINVAL;
 350
 351         result = sensor_set_auxtrip(attr->handle, 0, CELSIUS_TO_KELVIN(value));
 352         return result ? result : count;
 353 }
 354
 355 static ssize_t aux1_store(struct device *dev,
 356                           struct device_attribute *dev_attr,
 357                           const char *buf, size_t count)
 358 {
 359         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 360         int value;
 361         int result;
 362
 363         /*Sanity check; should be a positive integer */
 364         if (!sscanf(buf, "%d", &value))
 365                 return -EINVAL;
 366
 367         if (value < 0)
 368                 return -EINVAL;
 369
 370         result = sensor_set_auxtrip(attr->handle, 1, CELSIUS_TO_KELVIN(value));
 371         return result ? result : count;
 372 }
 373
 374 /* BIOS can enable/disable the thermal user application in dabney platform */
 375 #define BIOS_ENABLED "\\_TZ.GSTS"
 376 static ssize_t bios_enabled_show(struct device *dev,
 377                                  struct device_attribute *attr, char *buf)
 378 {
 379         acpi_status status;
 380         unsigned long long bios_enabled;
 381
 382         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &bios_enabled);
 383         if (ACPI_FAILURE(status))
 384                 return -ENODEV;
 385
 386         return sprintf(buf, "%s\n", bios_enabled ? "enabled" : "disabled");
 387 }
 388
 389 static int intel_menlow_add_one_attribute(char *name, int mode, void *show,
 390                                           void *store, struct device *dev,
 391                                           acpi_handle handle)
 392 {
 393         struct intel_menlow_attribute *attr;
 394         int result;
 395
 396         attr = kzalloc(sizeof(struct intel_menlow_attribute), GFP_KERNEL);
 397         if (!attr)
 398                 return -ENOMEM;
 399
 400         sysfs_attr_init(&attr->attr.attr); /* That is consistent naming :D */
 401         attr->attr.attr.name = name;
 402         attr->attr.attr.mode = mode;
 403         attr->attr.show = show;
 404         attr->attr.store = store;
 405         attr->device = dev;
 406         attr->handle = handle;
 407
 408         result = device_create_file(dev, &attr->attr);
 409         if (result)
 410                 return result;
 411
 412         mutex_lock(&intel_menlow_attr_lock);
 413         list_add_tail(&attr->node, &intel_menlow_attr_list);
 414         mutex_unlock(&intel_menlow_attr_lock);
 415
 416         return 0;
 417 }
 418
 419 static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl,
 420                                                 void *context, void **rv)
 421 {
 422         acpi_status status;
 423         acpi_handle dummy;
 424         struct thermal_zone_device *thermal;
 425         int result;
 426
 427         result = acpi_bus_get_private_data(handle, (void **)&thermal);
 428         if (result)
 429                 return 0;
 430
 431         /* _TZ must have the AUX0/1 methods */
 432         status = acpi_get_handle(handle, GET_AUX0, &dummy);
 433         if (ACPI_FAILURE(status))
 434                 goto not_found;
 435
 436         status = acpi_get_handle(handle, SET_AUX0, &dummy);
 437         if (ACPI_FAILURE(status))
 438                 goto not_found;
 439
 440         result = intel_menlow_add_one_attribute("aux0", 0644,
 441                                                 aux0_show, aux0_store,
 442                                                 &thermal->device, handle);
 443         if (result)
 444                 return AE_ERROR;
 445
 446         status = acpi_get_handle(handle, GET_AUX1, &dummy);
 447         if (ACPI_FAILURE(status))
 448                 goto not_found;
 449
 450         status = acpi_get_handle(handle, SET_AUX1, &dummy);
 451         if (ACPI_FAILURE(status))
 452                 goto not_found;
 453
 454         result = intel_menlow_add_one_attribute("aux1", 0644,
 455                                                 aux1_show, aux1_store,
 456                                                 &thermal->device, handle);
 457         if (result)
 458                 return AE_ERROR;
 459
 460         /*
 461          * create the "dabney_enabled" attribute which means the user app
 462          * should be loaded or not
 463          */
 464
 465         result = intel_menlow_add_one_attribute("bios_enabled", 0444,
 466                                                 bios_enabled_show, NULL,
 467                                                 &thermal->device, handle);
 468         if (result)
 469                 return AE_ERROR;
 470
 471  not_found:
 472         if (status == AE_NOT_FOUND)
 473                 return AE_OK;
 474         else
 475                 return status;
 476 }
 477
 478 static void intel_menlow_unregister_sensor(void)
 479 {
 480         struct intel_menlow_attribute *pos, *next;
 481
 482         mutex_lock(&intel_menlow_attr_lock);
 483         list_for_each_entry_safe(pos, next, &intel_menlow_attr_list, node) {
 484                 list_del(&pos->node);
 485                 device_remove_file(pos->device, &pos->attr);
 486                 kfree(pos);
 487         }
 488         mutex_unlock(&intel_menlow_attr_lock);
 489
 490         return;
 491 }
 492
 493 static int __init intel_menlow_module_init(void)
 494 {
 495         int result = -ENODEV;
 496         acpi_status status;
 497         unsigned long long enable;
 498
 499         if (acpi_disabled)
 500                 return result;
 501
 502         /* Looking for the \_TZ.GSTS method */
 503         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &enable);
 504         if (ACPI_FAILURE(status) || !enable)
 505                 return -ENODEV;
 506
 507         /* Looking for ACPI device MEM0 with hardware id INT0002 */
 508         result = acpi_bus_register_driver(&intel_menlow_memory_driver);
 509         if (result)
 510                 return result;
 511
 512         /* Looking for sensors in each ACPI thermal zone */
 513         status = acpi_walk_namespace(ACPI_TYPE_THERMAL, ACPI_ROOT_OBJECT,
 514                                      ACPI_UINT32_MAX,
 515                                      intel_menlow_register_sensor, NULL, NULL, NULL);
 516         if (ACPI_FAILURE(status))
 517                 return -ENODEV;
 518
 519         return 0;
 520 }
 521
 522 static void __exit intel_menlow_module_exit(void)
 523 {
 524         acpi_bus_unregister_driver(&intel_menlow_memory_driver);
 525         intel_menlow_unregister_sensor();
 526 }
 527
 528 module_init(intel_menlow_module_init);
 529 module_exit(intel_menlow_module_exit);