drivers/thermal/int340x_thermal/int3403_thermal.c

   1 /*
   2  * ACPI INT3403 thermal driver
   3  * Copyright (c) 2013, Intel Corporation.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms and conditions of the GNU General Public License,
   7  * version 2, as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  */
  14
  15 #include <linux/kernel.h>
  16 #include <linux/module.h>
  17 #include <linux/init.h>
  18 #include <linux/types.h>
  19 #include <linux/acpi.h>
  20 #include <linux/thermal.h>
  21 #include <linux/platform_device.h>
  22
  23 #define INT3403_TYPE_SENSOR             0x03
  24 #define INT3403_TYPE_CHARGER            0x0B
  25 #define INT3403_TYPE_BATTERY            0x0C
  26 #define INT3403_PERF_CHANGED_EVENT      0x80
  27 #define INT3403_THERMAL_EVENT           0x90
  28
  29 #define DECI_KELVIN_TO_MILLI_CELSIUS(t, off) (((t) - (off)) * 100)
  30 #define KELVIN_OFFSET   2732
  31 #define MILLI_CELSIUS_TO_DECI_KELVIN(t, off) (((t) / 100) + (off))
  32
  33 struct int3403_sensor {
  34         struct thermal_zone_device *tzone;
  35         unsigned long *thresholds;
  36         unsigned long   crit_temp;
  37         int             crit_trip_id;
  38         unsigned long   psv_temp;
  39         int             psv_trip_id;
  40
  41 };
  42
  43 struct int3403_performance_state {
  44         u64 performance;
  45         u64 power;
  46         u64 latency;
  47         u64 linear;
  48         u64 control;
  49         u64 raw_performace;
  50         char *raw_unit;
  51         int reserved;
  52 };
  53
  54 struct int3403_cdev {
  55         struct thermal_cooling_device *cdev;
  56         unsigned long max_state;
  57 };
  58
  59 struct int3403_priv {
  60         struct platform_device *pdev;
  61         struct acpi_device *adev;
  62         unsigned long long type;
  63         void *priv;
  64 };
  65
  66 static int sys_get_curr_temp(struct thermal_zone_device *tzone,
  67                                 unsigned long *temp)
  68 {
  69         struct int3403_priv *priv = tzone->devdata;
  70         struct acpi_device *device = priv->adev;
  71         unsigned long long tmp;
  72         acpi_status status;
  73
  74         status = acpi_evaluate_integer(device->handle, "_TMP", NULL, &tmp);
  75         if (ACPI_FAILURE(status))
  76                 return -EIO;
  77
  78         *temp = DECI_KELVIN_TO_MILLI_CELSIUS(tmp, KELVIN_OFFSET);
  79
  80         return 0;
  81 }
  82
  83 static int sys_get_trip_hyst(struct thermal_zone_device *tzone,
  84                 int trip, unsigned long *temp)
  85 {
  86         struct int3403_priv *priv = tzone->devdata;
  87         struct acpi_device *device = priv->adev;
  88         unsigned long long hyst;
  89         acpi_status status;
  90
  91         status = acpi_evaluate_integer(device->handle, "GTSH", NULL, &hyst);
  92         if (ACPI_FAILURE(status))
  93                 return -EIO;
  94
  95         *temp = DECI_KELVIN_TO_MILLI_CELSIUS(hyst, KELVIN_OFFSET);
  96
  97         return 0;
  98 }
  99
 100 static int sys_get_trip_temp(struct thermal_zone_device *tzone,
 101                 int trip, unsigned long *temp)
 102 {
 103         struct int3403_priv *priv = tzone->devdata;
 104         struct int3403_sensor *obj = priv->priv;
 105
 106         if (priv->type != INT3403_TYPE_SENSOR || !obj)
 107                 return -EINVAL;
 108
 109         if (trip == obj->crit_trip_id)
 110                 *temp = obj->crit_temp;
 111         else if (trip == obj->psv_trip_id)
 112                 *temp = obj->psv_temp;
 113         else {
 114                 /*
 115                  * get_trip_temp is a mandatory callback but
 116                  * PATx method doesn't return any value, so return
 117                  * cached value, which was last set from user space
 118                  */
 119                 *temp = obj->thresholds[trip];
 120         }
 121
 122         return 0;
 123 }
 124
 125 static int sys_get_trip_type(struct thermal_zone_device *thermal,
 126                 int trip, enum thermal_trip_type *type)
 127 {
 128         struct int3403_priv *priv = thermal->devdata;
 129         struct int3403_sensor *obj = priv->priv;
 130
 131         /* Mandatory callback, may not mean much here */
 132         if (trip == obj->crit_trip_id)
 133                 *type = THERMAL_TRIP_CRITICAL;
 134         else
 135                 *type = THERMAL_TRIP_PASSIVE;
 136
 137         return 0;
 138 }
 139
 140 int sys_set_trip_temp(struct thermal_zone_device *tzone, int trip,
 141                                                         unsigned long temp)
 142 {
 143         struct int3403_priv *priv = tzone->devdata;
 144         struct acpi_device *device = priv->adev;
 145         struct int3403_sensor *obj = priv->priv;
 146         acpi_status status;
 147         char name[10];
 148         int ret = 0;
 149
 150         snprintf(name, sizeof(name), "PAT%d", trip);
 151         if (acpi_has_method(device->handle, name)) {
 152                 status = acpi_execute_simple_method(device->handle, name,
 153                                 MILLI_CELSIUS_TO_DECI_KELVIN(temp,
 154                                                         KELVIN_OFFSET));
 155                 if (ACPI_FAILURE(status))
 156                         ret = -EIO;
 157                 else
 158                         obj->thresholds[trip] = temp;
 159         } else {
 160                 ret = -EIO;
 161                 dev_err(&device->dev, "sys_set_trip_temp: method not found\n");
 162         }
 163
 164         return ret;
 165 }
 166
 167 static struct thermal_zone_device_ops tzone_ops = {
 168         .get_temp = sys_get_curr_temp,
 169         .get_trip_temp = sys_get_trip_temp,
 170         .get_trip_type = sys_get_trip_type,
 171         .set_trip_temp = sys_set_trip_temp,
 172         .get_trip_hyst =  sys_get_trip_hyst,
 173 };
 174
 175 static struct thermal_zone_params int3403_thermal_params = {
 176         .governor_name = "user_space",
 177         .no_hwmon = true,
 178 };
 179
 180 static void int3403_notify(acpi_handle handle,
 181                 u32 event, void *data)
 182 {
 183         struct int3403_priv *priv = data;
 184         struct int3403_sensor *obj;
 185
 186         if (!priv)
 187                 return;
 188
 189         obj = priv->priv;
 190         if (priv->type != INT3403_TYPE_SENSOR || !obj)
 191                 return;
 192
 193         switch (event) {
 194         case INT3403_PERF_CHANGED_EVENT:
 195                 break;
 196         case INT3403_THERMAL_EVENT:
 197                 thermal_zone_device_update(obj->tzone);
 198                 break;
 199         default:
 200                 dev_err(&priv->pdev->dev, "Unsupported event [0x%x]\n", event);
 201                 break;
 202         }
 203 }
 204
 205 static int sys_get_trip_crt(struct acpi_device *device, unsigned long *temp)
 206 {
 207         unsigned long long crt;
 208         acpi_status status;
 209
 210         status = acpi_evaluate_integer(device->handle, "_CRT", NULL, &crt);
 211         if (ACPI_FAILURE(status))
 212                 return -EIO;
 213
 214         *temp = DECI_KELVIN_TO_MILLI_CELSIUS(crt, KELVIN_OFFSET);
 215
 216         return 0;
 217 }
 218
 219 static int sys_get_trip_psv(struct acpi_device *device, unsigned long *temp)
 220 {
 221         unsigned long long psv;
 222         acpi_status status;
 223
 224         status = acpi_evaluate_integer(device->handle, "_PSV", NULL, &psv);
 225         if (ACPI_FAILURE(status))
 226                 return -EIO;
 227
 228         *temp = DECI_KELVIN_TO_MILLI_CELSIUS(psv, KELVIN_OFFSET);
 229
 230         return 0;
 231 }
 232
 233 static int int3403_sensor_add(struct int3403_priv *priv)
 234 {
 235         int result = 0;
 236         acpi_status status;
 237         struct int3403_sensor *obj;
 238         unsigned long long trip_cnt;
 239         int trip_mask = 0;
 240
 241         obj = devm_kzalloc(&priv->pdev->dev, sizeof(*obj), GFP_KERNEL);
 242         if (!obj)
 243                 return -ENOMEM;
 244
 245         priv->priv = obj;
 246
 247         status = acpi_evaluate_integer(priv->adev->handle, "PATC", NULL,
 248                                                 &trip_cnt);
 249         if (ACPI_FAILURE(status))
 250                 trip_cnt = 0;
 251
 252         if (trip_cnt) {
 253                 /* We have to cache, thresholds can't be readback */
 254                 obj->thresholds = devm_kzalloc(&priv->pdev->dev,
 255                                         sizeof(*obj->thresholds) * trip_cnt,
 256                                         GFP_KERNEL);
 257                 if (!obj->thresholds) {
 258                         result = -ENOMEM;
 259                         goto err_free_obj;
 260                 }
 261                 trip_mask = BIT(trip_cnt) - 1;
 262         }
 263
 264         obj->psv_trip_id = -1;
 265         if (!sys_get_trip_psv(priv->adev, &obj->psv_temp))
 266                 obj->psv_trip_id = trip_cnt++;
 267
 268         obj->crit_trip_id = -1;
 269         if (!sys_get_trip_crt(priv->adev, &obj->crit_temp))
 270                 obj->crit_trip_id = trip_cnt++;
 271
 272         obj->tzone = thermal_zone_device_register(acpi_device_bid(priv->adev),
 273                                 trip_cnt, trip_mask, priv, &tzone_ops,
 274                                 &int3403_thermal_params, 0, 0);
 275         if (IS_ERR(obj->tzone)) {
 276                 result = PTR_ERR(obj->tzone);
 277                 obj->tzone = NULL;
 278                 goto err_free_obj;
 279         }
 280
 281         result = acpi_install_notify_handler(priv->adev->handle,
 282                         ACPI_DEVICE_NOTIFY, int3403_notify,
 283                         (void *)priv);
 284         if (result)
 285                 goto err_free_obj;
 286
 287         return 0;
 288
 289  err_free_obj:
 290         if (obj->tzone)
 291                 thermal_zone_device_unregister(obj->tzone);
 292         return result;
 293 }
 294
 295 static int int3403_sensor_remove(struct int3403_priv *priv)
 296 {
 297         struct int3403_sensor *obj = priv->priv;
 298
 299         thermal_zone_device_unregister(obj->tzone);
 300         return 0;
 301 }
 302
 303 /* INT3403 Cooling devices */
 304 static int int3403_get_max_state(struct thermal_cooling_device *cdev,
 305                                  unsigned long *state)
 306 {
 307         struct int3403_priv *priv = cdev->devdata;
 308         struct int3403_cdev *obj = priv->priv;
 309
 310         *state = obj->max_state;
 311         return 0;
 312 }
 313
 314 static int int3403_get_cur_state(struct thermal_cooling_device *cdev,
 315                                  unsigned long *state)
 316 {
 317         struct int3403_priv *priv = cdev->devdata;
 318         unsigned long long level;
 319         acpi_status status;
 320
 321         status = acpi_evaluate_integer(priv->adev->handle, "PPPC", NULL, &level);
 322         if (ACPI_SUCCESS(status)) {
 323                 *state = level;
 324                 return 0;
 325         } else
 326                 return -EINVAL;
 327 }
 328
 329 static int
 330 int3403_set_cur_state(struct thermal_cooling_device *cdev, unsigned long state)
 331 {
 332         struct int3403_priv *priv = cdev->devdata;
 333         acpi_status status;
 334
 335         status = acpi_execute_simple_method(priv->adev->handle, "SPPC", state);
 336         if (ACPI_SUCCESS(status))
 337                 return 0;
 338         else
 339                 return -EINVAL;
 340 }
 341
 342 static const struct thermal_cooling_device_ops int3403_cooling_ops = {
 343         .get_max_state = int3403_get_max_state,
 344         .get_cur_state = int3403_get_cur_state,
 345         .set_cur_state = int3403_set_cur_state,
 346 };
 347
 348 static int int3403_cdev_add(struct int3403_priv *priv)
 349 {
 350         int result = 0;
 351         acpi_status status;
 352         struct int3403_cdev *obj;
 353         struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER, NULL };
 354         union acpi_object *p;
 355
 356         obj = devm_kzalloc(&priv->pdev->dev, sizeof(*obj), GFP_KERNEL);
 357         if (!obj)
 358                 return -ENOMEM;
 359
 360         status = acpi_evaluate_object(priv->adev->handle, "PPSS", NULL, &buf);
 361         if (ACPI_FAILURE(status))
 362                 return -ENODEV;
 363
 364         p = buf.pointer;
 365         if (!p || (p->type != ACPI_TYPE_PACKAGE)) {
 366                 printk(KERN_WARNING "Invalid PPSS data\n");
 367                 return -EFAULT;
 368         }
 369
 370         obj->max_state = p->package.count - 1;
 371         obj->cdev =
 372                 thermal_cooling_device_register(acpi_device_bid(priv->adev),
 373                                 priv, &int3403_cooling_ops);
 374         if (IS_ERR(obj->cdev))
 375                 result = PTR_ERR(obj->cdev);
 376
 377         priv->priv = obj;
 378
 379         /* TODO: add ACPI notification support */
 380
 381         return result;
 382 }
 383
 384 static int int3403_cdev_remove(struct int3403_priv *priv)
 385 {
 386         struct int3403_cdev *obj = priv->priv;
 387
 388         thermal_cooling_device_unregister(obj->cdev);
 389         return 0;
 390 }
 391
 392 static int int3403_add(struct platform_device *pdev)
 393 {
 394         struct int3403_priv *priv;
 395         int result = 0;
 396         acpi_status status;
 397
 398         priv = devm_kzalloc(&pdev->dev, sizeof(struct int3403_priv),
 399                             GFP_KERNEL);
 400         if (!priv)
 401                 return -ENOMEM;
 402
 403         priv->pdev = pdev;
 404         priv->adev = ACPI_COMPANION(&(pdev->dev));
 405         if (!priv->adev) {
 406                 result = -EINVAL;
 407                 goto err;
 408         }
 409
 410         status = acpi_evaluate_integer(priv->adev->handle, "PTYP",
 411                                        NULL, &priv->type);
 412         if (ACPI_FAILURE(status)) {
 413                 result = -EINVAL;
 414                 goto err;
 415         }
 416
 417         platform_set_drvdata(pdev, priv);
 418         switch (priv->type) {
 419         case INT3403_TYPE_SENSOR:
 420                 result = int3403_sensor_add(priv);
 421                 break;
 422         case INT3403_TYPE_CHARGER:
 423         case INT3403_TYPE_BATTERY:
 424                 result = int3403_cdev_add(priv);
 425                 break;
 426         default:
 427                 result = -EINVAL;
 428         }
 429
 430         if (result)
 431                 goto err;
 432         return result;
 433
 434 err:
 435         return result;
 436 }
 437
 438 static int int3403_remove(struct platform_device *pdev)
 439 {
 440         struct int3403_priv *priv = platform_get_drvdata(pdev);
 441
 442         switch (priv->type) {
 443         case INT3403_TYPE_SENSOR:
 444                 int3403_sensor_remove(priv);
 445                 break;
 446         case INT3403_TYPE_CHARGER:
 447         case INT3403_TYPE_BATTERY:
 448                 int3403_cdev_remove(priv);
 449                 break;
 450         default:
 451                 break;
 452         }
 453
 454         return 0;
 455 }
 456
 457 static const struct acpi_device_id int3403_device_ids[] = {
 458         {"INT3403", 0},
 459         {"", 0},
 460 };
 461 MODULE_DEVICE_TABLE(acpi, int3403_device_ids);
 462
 463 static struct platform_driver int3403_driver = {
 464         .probe = int3403_add,
 465         .remove = int3403_remove,
 466         .driver = {
 467                 .name = "int3403 thermal",
 468                 .owner  = THIS_MODULE,
 469                 .acpi_match_table = int3403_device_ids,
 470         },
 471 };
 472
 473 module_platform_driver(int3403_driver);
 474
 475 MODULE_AUTHOR("Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>");
 476 MODULE_LICENSE("GPL v2");
 477 MODULE_DESCRIPTION("ACPI INT3403 thermal driver");