drivers/platform/x86/intel_menlow.c

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