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 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  31
  32 #include <linux/kernel.h>
  33 #include <linux/module.h>
  34 #include <linux/init.h>
  35 #include <linux/slab.h>
  36 #include <linux/types.h>
  37 #include <linux/pci.h>
  38 #include <linux/pm.h>
  39
  40 #include <linux/thermal.h>
  41 #include <acpi/acpi_bus.h>
  42 #include <acpi/acpi_drivers.h>
  43
  44 MODULE_AUTHOR("Thomas Sujith");
  45 MODULE_AUTHOR("Zhang Rui");
  46 MODULE_DESCRIPTION("Intel Menlow platform specific driver");
  47 MODULE_LICENSE("GPL");
  48
  49 /*
  50  * Memory controller device control
  51  */
  52
  53 #define MEMORY_GET_BANDWIDTH "GTHS"
  54 #define MEMORY_SET_BANDWIDTH "STHS"
  55 #define MEMORY_ARG_CUR_BANDWIDTH 1
  56 #define MEMORY_ARG_MAX_BANDWIDTH 0
  57
  58 static void intel_menlow_unregister_sensor(void);
  59
  60 /*
  61  * GTHS returning 'n' would mean that [0,n-1] states are supported
  62  * In that case max_cstate would be n-1
  63  * GTHS returning '0' would mean that no bandwidth control states are supported
  64  */
  65 static int memory_get_max_bandwidth(struct thermal_cooling_device *cdev,
  66                                     unsigned long *max_state)
  67 {
  68         struct acpi_device *device = cdev->devdata;
  69         acpi_handle handle = device->handle;
  70         unsigned long long value;
  71         struct acpi_object_list arg_list;
  72         union acpi_object arg;
  73         acpi_status status = AE_OK;
  74
  75         arg_list.count = 1;
  76         arg_list.pointer = &arg;
  77         arg.type = ACPI_TYPE_INTEGER;
  78         arg.integer.value = MEMORY_ARG_MAX_BANDWIDTH;
  79         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
  80                                        &arg_list, &value);
  81         if (ACPI_FAILURE(status))
  82                 return -EFAULT;
  83
  84         if (!value)
  85                 return -EINVAL;
  86
  87         *max_state = value - 1;
  88         return 0;
  89 }
  90
  91 static int memory_get_cur_bandwidth(struct thermal_cooling_device *cdev,
  92                                     unsigned long *value)
  93 {
  94         struct acpi_device *device = cdev->devdata;
  95         acpi_handle handle = device->handle;
  96         unsigned long long result;
  97         struct acpi_object_list arg_list;
  98         union acpi_object arg;
  99         acpi_status status = AE_OK;
 100
 101         arg_list.count = 1;
 102         arg_list.pointer = &arg;
 103         arg.type = ACPI_TYPE_INTEGER;
 104         arg.integer.value = MEMORY_ARG_CUR_BANDWIDTH;
 105         status = acpi_evaluate_integer(handle, MEMORY_GET_BANDWIDTH,
 106                                        &arg_list, &result);
 107         if (ACPI_FAILURE(status))
 108                 return -EFAULT;
 109
 110         *value = result;
 111         return 0;
 112 }
 113
 114 static int memory_set_cur_bandwidth(struct thermal_cooling_device *cdev,
 115                                     unsigned long state)
 116 {
 117         struct acpi_device *device = cdev->devdata;
 118         acpi_handle handle = device->handle;
 119         struct acpi_object_list arg_list;
 120         union acpi_object arg;
 121         acpi_status status;
 122         unsigned long long temp;
 123         unsigned long max_state;
 124
 125         if (memory_get_max_bandwidth(cdev, &max_state))
 126                 return -EFAULT;
 127
 128         if (state > max_state)
 129                 return -EINVAL;
 130
 131         arg_list.count = 1;
 132         arg_list.pointer = &arg;
 133         arg.type = ACPI_TYPE_INTEGER;
 134         arg.integer.value = state;
 135
 136         status =
 137             acpi_evaluate_integer(handle, MEMORY_SET_BANDWIDTH, &arg_list,
 138                                   &temp);
 139
 140         pr_info("Bandwidth value was %ld: status is %d\n", state, status);
 141         if (ACPI_FAILURE(status))
 142                 return -EFAULT;
 143
 144         return 0;
 145 }
 146
 147 static struct thermal_cooling_device_ops memory_cooling_ops = {
 148         .get_max_state = memory_get_max_bandwidth,
 149         .get_cur_state = memory_get_cur_bandwidth,
 150         .set_cur_state = memory_set_cur_bandwidth,
 151 };
 152
 153 /*
 154  * Memory Device Management
 155  */
 156 static int intel_menlow_memory_add(struct acpi_device *device)
 157 {
 158         int result = -ENODEV;
 159         struct thermal_cooling_device *cdev;
 160
 161         if (!device)
 162                 return -EINVAL;
 163
 164         if (!acpi_has_method(device->handle, MEMORY_GET_BANDWIDTH))
 165                 goto end;
 166
 167         if (!acpi_has_method(device->handle, MEMORY_SET_BANDWIDTH))
 168                 goto end;
 169
 170         cdev = thermal_cooling_device_register("Memory controller", device,
 171                                                &memory_cooling_ops);
 172         if (IS_ERR(cdev)) {
 173                 result = PTR_ERR(cdev);
 174                 goto end;
 175         }
 176
 177         device->driver_data = cdev;
 178         result = sysfs_create_link(&device->dev.kobj,
 179                                 &cdev->device.kobj, "thermal_cooling");
 180         if (result)
 181                 goto unregister;
 182
 183         result = sysfs_create_link(&cdev->device.kobj,
 184                                 &device->dev.kobj, "device");
 185         if (result) {
 186                 sysfs_remove_link(&device->dev.kobj, "thermal_cooling");
 187                 goto unregister;
 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)
 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 static const 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,
 255                                                         unsigned long long *value)
 256 {
 257         acpi_status status;
 258
 259         if ((index != 0 && index != 1) || !value)
 260                 return -EINVAL;
 261
 262         status = acpi_evaluate_integer(handle, index ? GET_AUX1 : GET_AUX0,
 263                                        NULL, value);
 264         if (ACPI_FAILURE(status))
 265                 return -EIO;
 266
 267         return 0;
 268 }
 269
 270 /*
 271  * sensor_set_auxtrip - set the new auxtrip value to sensor
 272  * @name: Thermalzone name
 273  * @auxtype : AUX0/AUX1
 274  * @buf: syfs buffer
 275  */
 276 static int sensor_set_auxtrip(acpi_handle handle, int index, int value)
 277 {
 278         acpi_status status;
 279         union acpi_object arg = {
 280                 ACPI_TYPE_INTEGER
 281         };
 282         struct acpi_object_list args = {
 283                 1, &arg
 284         };
 285         unsigned long long temp;
 286
 287         if (index != 0 && index != 1)
 288                 return -EINVAL;
 289
 290         status = acpi_evaluate_integer(handle, index ? GET_AUX0 : GET_AUX1,
 291                                        NULL, &temp);
 292         if (ACPI_FAILURE(status))
 293                 return -EIO;
 294         if ((index && value < temp) || (!index && value > temp))
 295                 return -EINVAL;
 296
 297         arg.integer.value = value;
 298         status = acpi_evaluate_integer(handle, index ? SET_AUX1 : SET_AUX0,
 299                                        &args, &temp);
 300         if (ACPI_FAILURE(status))
 301                 return -EIO;
 302
 303         /* do we need to check the return value of SAX0/SAX1 ? */
 304
 305         return 0;
 306 }
 307
 308 #define to_intel_menlow_attr(_attr)     \
 309         container_of(_attr, struct intel_menlow_attribute, attr)
 310
 311 static ssize_t aux0_show(struct device *dev,
 312                          struct device_attribute *dev_attr, char *buf)
 313 {
 314         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 315         unsigned long long value;
 316         int result;
 317
 318         result = sensor_get_auxtrip(attr->handle, 0, &value);
 319
 320         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 321 }
 322
 323 static ssize_t aux1_show(struct device *dev,
 324                          struct device_attribute *dev_attr, char *buf)
 325 {
 326         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 327         unsigned long long value;
 328         int result;
 329
 330         result = sensor_get_auxtrip(attr->handle, 1, &value);
 331
 332         return result ? result : sprintf(buf, "%lu", KELVIN_TO_CELSIUS(value));
 333 }
 334
 335 static ssize_t aux0_store(struct device *dev,
 336                           struct device_attribute *dev_attr,
 337                           const char *buf, size_t count)
 338 {
 339         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 340         int value;
 341         int result;
 342
 343         /*Sanity check; should be a positive integer */
 344         if (!sscanf(buf, "%d", &value))
 345                 return -EINVAL;
 346
 347         if (value < 0)
 348                 return -EINVAL;
 349
 350         result = sensor_set_auxtrip(attr->handle, 0, CELSIUS_TO_KELVIN(value));
 351         return result ? result : count;
 352 }
 353
 354 static ssize_t aux1_store(struct device *dev,
 355                           struct device_attribute *dev_attr,
 356                           const char *buf, size_t count)
 357 {
 358         struct intel_menlow_attribute *attr = to_intel_menlow_attr(dev_attr);
 359         int value;
 360         int result;
 361
 362         /*Sanity check; should be a positive integer */
 363         if (!sscanf(buf, "%d", &value))
 364                 return -EINVAL;
 365
 366         if (value < 0)
 367                 return -EINVAL;
 368
 369         result = sensor_set_auxtrip(attr->handle, 1, CELSIUS_TO_KELVIN(value));
 370         return result ? result : count;
 371 }
 372
 373 /* BIOS can enable/disable the thermal user application in dabney platform */
 374 #define BIOS_ENABLED "\\_TZ.GSTS"
 375 static ssize_t bios_enabled_show(struct device *dev,
 376                                  struct device_attribute *attr, char *buf)
 377 {
 378         acpi_status status;
 379         unsigned long long bios_enabled;
 380
 381         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &bios_enabled);
 382         if (ACPI_FAILURE(status))
 383                 return -ENODEV;
 384
 385         return sprintf(buf, "%s\n", bios_enabled ? "enabled" : "disabled");
 386 }
 387
 388 static int intel_menlow_add_one_attribute(char *name, umode_t mode, void *show,
 389                                           void *store, struct device *dev,
 390                                           acpi_handle handle)
 391 {
 392         struct intel_menlow_attribute *attr;
 393         int result;
 394
 395         attr = kzalloc(sizeof(struct intel_menlow_attribute), GFP_KERNEL);
 396         if (!attr)
 397                 return -ENOMEM;
 398
 399         sysfs_attr_init(&attr->attr.attr); /* That is consistent naming :D */
 400         attr->attr.attr.name = name;
 401         attr->attr.attr.mode = mode;
 402         attr->attr.show = show;
 403         attr->attr.store = store;
 404         attr->device = dev;
 405         attr->handle = handle;
 406
 407         result = device_create_file(dev, &attr->attr);
 408         if (result) {
 409                 kfree(attr);
 410                 return result;
 411         }
 412
 413         mutex_lock(&intel_menlow_attr_lock);
 414         list_add_tail(&attr->node, &intel_menlow_attr_list);
 415         mutex_unlock(&intel_menlow_attr_lock);
 416
 417         return 0;
 418 }
 419
 420 static acpi_status intel_menlow_register_sensor(acpi_handle handle, u32 lvl,
 421                                                 void *context, void **rv)
 422 {
 423         acpi_status status;
 424         acpi_handle dummy;
 425         struct thermal_zone_device *thermal;
 426         int result;
 427
 428         result = acpi_bus_get_private_data(handle, (void **)&thermal);
 429         if (result)
 430                 return 0;
 431
 432         /* _TZ must have the AUX0/1 methods */
 433         status = acpi_get_handle(handle, GET_AUX0, &dummy);
 434         if (ACPI_FAILURE(status))
 435                 return (status == AE_NOT_FOUND) ? AE_OK : status;
 436
 437         status = acpi_get_handle(handle, SET_AUX0, &dummy);
 438         if (ACPI_FAILURE(status))
 439                 return (status == AE_NOT_FOUND) ? AE_OK : status;
 440
 441         result = intel_menlow_add_one_attribute("aux0", 0644,
 442                                                 aux0_show, aux0_store,
 443                                                 &thermal->device, handle);
 444         if (result)
 445                 return AE_ERROR;
 446
 447         status = acpi_get_handle(handle, GET_AUX1, &dummy);
 448         if (ACPI_FAILURE(status))
 449                 goto aux1_not_found;
 450
 451         status = acpi_get_handle(handle, SET_AUX1, &dummy);
 452         if (ACPI_FAILURE(status))
 453                 goto aux1_not_found;
 454
 455         result = intel_menlow_add_one_attribute("aux1", 0644,
 456                                                 aux1_show, aux1_store,
 457                                                 &thermal->device, handle);
 458         if (result) {
 459                 intel_menlow_unregister_sensor();
 460                 return AE_ERROR;
 461         }
 462
 463         /*
 464          * create the "dabney_enabled" attribute which means the user app
 465          * should be loaded or not
 466          */
 467
 468         result = intel_menlow_add_one_attribute("bios_enabled", 0444,
 469                                                 bios_enabled_show, NULL,
 470                                                 &thermal->device, handle);
 471         if (result) {
 472                 intel_menlow_unregister_sensor();
 473                 return AE_ERROR;
 474         }
 475
 476         return AE_OK;
 477
 478  aux1_not_found:
 479         if (status == AE_NOT_FOUND)
 480                 return AE_OK;
 481
 482         intel_menlow_unregister_sensor();
 483         return status;
 484 }
 485
 486 static void intel_menlow_unregister_sensor(void)
 487 {
 488         struct intel_menlow_attribute *pos, *next;
 489
 490         mutex_lock(&intel_menlow_attr_lock);
 491         list_for_each_entry_safe(pos, next, &intel_menlow_attr_list, node) {
 492                 list_del(&pos->node);
 493                 device_remove_file(pos->device, &pos->attr);
 494                 kfree(pos);
 495         }
 496         mutex_unlock(&intel_menlow_attr_lock);
 497
 498         return;
 499 }
 500
 501 static int __init intel_menlow_module_init(void)
 502 {
 503         int result = -ENODEV;
 504         acpi_status status;
 505         unsigned long long enable;
 506
 507         if (acpi_disabled)
 508                 return result;
 509
 510         /* Looking for the \_TZ.GSTS method */
 511         status = acpi_evaluate_integer(NULL, BIOS_ENABLED, NULL, &enable);
 512         if (ACPI_FAILURE(status) || !enable)
 513                 return -ENODEV;
 514
 515         /* Looking for ACPI device MEM0 with hardware id INT0002 */
 516         result = acpi_bus_register_driver(&intel_menlow_memory_driver);
 517         if (result)
 518                 return result;
 519
 520         /* Looking for sensors in each ACPI thermal zone */
 521         status = acpi_walk_namespace(ACPI_TYPE_THERMAL, ACPI_ROOT_OBJECT,
 522                                      ACPI_UINT32_MAX,
 523                                      intel_menlow_register_sensor, NULL, NULL, NULL);
 524         if (ACPI_FAILURE(status)) {
 525                 acpi_bus_unregister_driver(&intel_menlow_memory_driver);
 526                 return -ENODEV;
 527         }
 528
 529         return 0;
 530 }
 531
 532 static void __exit intel_menlow_module_exit(void)
 533 {
 534         acpi_bus_unregister_driver(&intel_menlow_memory_driver);
 535         intel_menlow_unregister_sensor();
 536 }
 537
 538 module_init(intel_menlow_module_init);
 539 module_exit(intel_menlow_module_exit);