drivers/misc/sony-laptop.c

   1 /*
   2  * ACPI Sony Notebook Control Driver (SNC)
   3  *
   4  * Copyright (C) 2004-2005 Stelian Pop <stelian@popies.net>
   5  * Copyright (C) 2007 Mattia Dongili <malattia@linux.it>
   6  *
   7  * Parts of this driver inspired from asus_acpi.c and ibm_acpi.c
   8  * which are copyrighted by their respective authors.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23  *
  24  */
  25
  26 #include <linux/kernel.h>
  27 #include <linux/module.h>
  28 #include <linux/moduleparam.h>
  29 #include <linux/init.h>
  30 #include <linux/types.h>
  31 #include <linux/backlight.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/err.h>
  34 #include <acpi/acpi_drivers.h>
  35 #include <acpi/acpi_bus.h>
  36 #include <asm/uaccess.h>
  37
  38 #define ACPI_SNC_CLASS          "sony"
  39 #define ACPI_SNC_HID            "SNY5001"
  40 #define ACPI_SNC_DRIVER_NAME    "ACPI Sony Notebook Control Driver v0.4"
  41
  42 /* the device uses 1-based values, while the backlight subsystem uses
  43    0-based values */
  44 #define SONY_MAX_BRIGHTNESS     8
  45
  46 #define LOG_PFX                 KERN_WARNING "sony-laptop: "
  47
  48 MODULE_AUTHOR("Stelian Pop, Mattia Dongili");
  49 MODULE_DESCRIPTION(ACPI_SNC_DRIVER_NAME);
  50 MODULE_LICENSE("GPL");
  51
  52 static int debug;
  53 module_param(debug, int, 0);
  54 MODULE_PARM_DESC(debug, "set this to 1 (and RTFM) if you want to help "
  55                  "the development of this driver");
  56
  57 static ssize_t sony_acpi_show(struct device *, struct device_attribute *,
  58                               char *);
  59 static ssize_t sony_acpi_store(struct device *, struct device_attribute *,
  60                                const char *, size_t);
  61 static int boolean_validate(const int, const int);
  62 static int brightness_default_validate(const int, const int);
  63
  64 #define SNC_VALIDATE_IN         0
  65 #define SNC_VALIDATE_OUT        1
  66
  67 struct sony_acpi_value {
  68         char *name;             /* name of the entry */
  69         char **acpiget;         /* names of the ACPI get function */
  70         char **acpiset;         /* names of the ACPI set function */
  71         int (*validate)(const int, const int);  /* input/output validation */
  72         int value;              /* current setting */
  73         int valid;              /* Has ever been set */
  74         int debug;              /* active only in debug mode ? */
  75         struct device_attribute devattr;        /* sysfs atribute */
  76 };
  77
  78 #define HANDLE_NAMES(_name, _values...) \
  79         static char *snc_##_name[] = { _values, NULL }
  80
  81 #define SONY_ACPI_VALUE(_name, _getters, _setters, _validate, _debug) \
  82         { \
  83                 .name           = __stringify(_name), \
  84                 .acpiget        = _getters, \
  85                 .acpiset        = _setters, \
  86                 .validate       = _validate, \
  87                 .debug          = _debug, \
  88                 .devattr        = __ATTR(_name, 0, sony_acpi_show, sony_acpi_store), \
  89         }
  90
  91 #define SONY_ACPI_VALUE_NULL    { .name = NULL }
  92
  93 HANDLE_NAMES(fnkey_get, "GHKE");
  94
  95 HANDLE_NAMES(brightness_def_get, "GPBR");
  96 HANDLE_NAMES(brightness_def_set, "SPBR");
  97
  98 HANDLE_NAMES(cdpower_get, "GCDP");
  99 HANDLE_NAMES(cdpower_set, "SCDP", "CDPW");
 100
 101 HANDLE_NAMES(audiopower_get, "GAZP");
 102 HANDLE_NAMES(audiopower_set, "AZPW");
 103
 104 HANDLE_NAMES(lanpower_get, "GLNP");
 105 HANDLE_NAMES(lanpower_set, "LNPW");
 106
 107 HANDLE_NAMES(PID_get, "GPID");
 108
 109 HANDLE_NAMES(CTR_get, "GCTR");
 110 HANDLE_NAMES(CTR_set, "SCTR");
 111
 112 HANDLE_NAMES(PCR_get, "GPCR");
 113 HANDLE_NAMES(PCR_set, "SPCR");
 114
 115 HANDLE_NAMES(CMI_get, "GCMI");
 116 HANDLE_NAMES(CMI_set, "SCMI");
 117
 118 static struct sony_acpi_value sony_acpi_values[] = {
 119         SONY_ACPI_VALUE(brightness_default, snc_brightness_def_get,
 120                         snc_brightness_def_set, brightness_default_validate, 0),
 121         SONY_ACPI_VALUE(fnkey, snc_fnkey_get, NULL, NULL, 0),
 122         SONY_ACPI_VALUE(cdpower, snc_cdpower_get, snc_cdpower_set, boolean_validate, 0),
 123         SONY_ACPI_VALUE(audiopower, snc_audiopower_get, snc_audiopower_set,
 124                         boolean_validate, 0),
 125         SONY_ACPI_VALUE(lanpower, snc_lanpower_get, snc_lanpower_set,
 126                         boolean_validate, 1),
 127         /* unknown methods */
 128         SONY_ACPI_VALUE(PID, snc_PID_get, NULL, NULL, 1),
 129         SONY_ACPI_VALUE(CTR, snc_CTR_get, snc_CTR_set, NULL, 1),
 130         SONY_ACPI_VALUE(PCR, snc_PCR_get, snc_PCR_set, NULL, 1),
 131         SONY_ACPI_VALUE(CMI, snc_CMI_get, snc_CMI_set, NULL, 1),
 132         SONY_ACPI_VALUE_NULL
 133 };
 134
 135 static acpi_handle sony_acpi_handle;
 136 static struct acpi_device *sony_acpi_acpi_device = NULL;
 137
 138 /*
 139  * acpi_evaluate_object wrappers
 140  */
 141 static int acpi_callgetfunc(acpi_handle handle, char *name, int *result)
 142 {
 143         struct acpi_buffer output;
 144         union acpi_object out_obj;
 145         acpi_status status;
 146
 147         output.length = sizeof(out_obj);
 148         output.pointer = &out_obj;
 149
 150         status = acpi_evaluate_object(handle, name, NULL, &output);
 151         if ((status == AE_OK) && (out_obj.type == ACPI_TYPE_INTEGER)) {
 152                 *result = out_obj.integer.value;
 153                 return 0;
 154         }
 155
 156         printk(LOG_PFX "acpi_callreadfunc failed\n");
 157
 158         return -1;
 159 }
 160
 161 static int acpi_callsetfunc(acpi_handle handle, char *name, int value,
 162                             int *result)
 163 {
 164         struct acpi_object_list params;
 165         union acpi_object in_obj;
 166         struct acpi_buffer output;
 167         union acpi_object out_obj;
 168         acpi_status status;
 169
 170         params.count = 1;
 171         params.pointer = &in_obj;
 172         in_obj.type = ACPI_TYPE_INTEGER;
 173         in_obj.integer.value = value;
 174
 175         output.length = sizeof(out_obj);
 176         output.pointer = &out_obj;
 177
 178         status = acpi_evaluate_object(handle, name, &params, &output);
 179         if (status == AE_OK) {
 180                 if (result != NULL) {
 181                         if (out_obj.type != ACPI_TYPE_INTEGER) {
 182                                 printk(LOG_PFX "acpi_evaluate_object bad "
 183                                        "return type\n");
 184                                 return -1;
 185                         }
 186                         *result = out_obj.integer.value;
 187                 }
 188                 return 0;
 189         }
 190
 191         printk(LOG_PFX "acpi_evaluate_object failed\n");
 192
 193         return -1;
 194 }
 195
 196 /*
 197  * sony_acpi_values input/output validate functions
 198  */
 199
 200 /* brightness_default_validate:
 201  *
 202  * manipulate input output values to keep consistency with the
 203  * backlight framework for which brightness values are 0-based.
 204  */
 205 static int brightness_default_validate(const int direction, const int value)
 206 {
 207         switch (direction) {
 208                 case SNC_VALIDATE_OUT:
 209                         return value - 1;
 210                 case SNC_VALIDATE_IN:
 211                         if (value >= 0 && value < SONY_MAX_BRIGHTNESS)
 212                                 return value + 1;
 213         }
 214         return -EINVAL;
 215 }
 216
 217 /* boolean_validate:
 218  *
 219  * on input validate boolean values 0/1, on output just pass the
 220  * received value.
 221  */
 222 static int boolean_validate(const int direction, const int value)
 223 {
 224         if (direction == SNC_VALIDATE_IN) {
 225                 if (value != 0 && value != 1)
 226                         return -EINVAL;
 227         }
 228         return value;
 229 }
 230
 231 /*
 232  * Sysfs show/store common to all sony_acpi_values
 233  */
 234 static ssize_t sony_acpi_show(struct device *dev, struct device_attribute *attr,
 235                               char *buffer)
 236 {
 237         int value;
 238         struct sony_acpi_value *item =
 239             container_of(attr, struct sony_acpi_value, devattr);
 240
 241         if (!*item->acpiget)
 242                 return -EIO;
 243
 244         if (acpi_callgetfunc(sony_acpi_handle, *item->acpiget, &value) < 0)
 245                 return -EIO;
 246
 247         if (item->validate)
 248                 value = item->validate(SNC_VALIDATE_OUT, value);
 249
 250         return snprintf(buffer, PAGE_SIZE, "%d\n", value);
 251 }
 252
 253 static ssize_t sony_acpi_store(struct device *dev,
 254                                struct device_attribute *attr,
 255                                const char *buffer, size_t count)
 256 {
 257         int value;
 258         struct sony_acpi_value *item =
 259             container_of(attr, struct sony_acpi_value, devattr);
 260
 261         if (!item->acpiset)
 262                 return -EIO;
 263
 264         if (count > 31)
 265                 return -EINVAL;
 266
 267         value = simple_strtoul(buffer, NULL, 10);
 268
 269         if (item->validate)
 270                 value = item->validate(SNC_VALIDATE_IN, value);
 271
 272         if (value < 0)
 273                 return value;
 274
 275         if (acpi_callsetfunc(sony_acpi_handle, *item->acpiset, value, NULL) < 0)
 276                 return -EIO;
 277         item->value = value;
 278         item->valid = 1;
 279         return count;
 280 }
 281
 282 /*
 283  * Platform device
 284  */
 285 static struct platform_driver sncpf_driver = {
 286         .driver = {
 287                    .name = "sony-laptop",
 288                    .owner = THIS_MODULE,
 289                    }
 290 };
 291 static struct platform_device *sncpf_device;
 292
 293 static int sony_snc_pf_add(void)
 294 {
 295         acpi_handle handle;
 296         struct sony_acpi_value *item;
 297         int ret = 0;
 298
 299         ret = platform_driver_register(&sncpf_driver);
 300         if (ret)
 301                 goto out;
 302
 303         sncpf_device = platform_device_alloc("sony-laptop", -1);
 304         if (!sncpf_device) {
 305                 ret = -ENOMEM;
 306                 goto out_platform_registered;
 307         }
 308
 309         ret = platform_device_add(sncpf_device);
 310         if (ret)
 311                 goto out_platform_alloced;
 312
 313         for (item = sony_acpi_values; item->name; ++item) {
 314
 315                 if (!debug && item->debug)
 316                         continue;
 317
 318                 /* find the available acpiget as described in the DSDT */
 319                 for (; item->acpiget && *item->acpiget; ++item->acpiget) {
 320                         if (ACPI_SUCCESS(acpi_get_handle(sony_acpi_handle,
 321                                                          *item->acpiget,
 322                                                          &handle))) {
 323                                 if (debug)
 324                                         printk(LOG_PFX "Found %s getter: %s\n",
 325                                                item->name, *item->acpiget);
 326                                 item->devattr.attr.mode |= S_IRUGO;
 327                                 break;
 328                         }
 329                 }
 330
 331                 /* find the available acpiset as described in the DSDT */
 332                 for (; item->acpiset && *item->acpiset; ++item->acpiset) {
 333                         if (ACPI_SUCCESS(acpi_get_handle(sony_acpi_handle,
 334                                                          *item->acpiset,
 335                                                          &handle))) {
 336                                 if (debug)
 337                                         printk(LOG_PFX "Found %s setter: %s\n",
 338                                                item->name, *item->acpiset);
 339                                 item->devattr.attr.mode |= S_IWUSR;
 340                                 break;
 341                         }
 342                 }
 343
 344                 if (item->devattr.attr.mode != 0) {
 345                         ret =
 346                             device_create_file(&sncpf_device->dev,
 347                                                &item->devattr);
 348                         if (ret)
 349                                 goto out_sysfs;
 350                 }
 351         }
 352
 353         return 0;
 354
 355       out_sysfs:
 356         for (item = sony_acpi_values; item->name; ++item) {
 357                 device_remove_file(&sncpf_device->dev, &item->devattr);
 358         }
 359         platform_device_del(sncpf_device);
 360       out_platform_alloced:
 361         platform_device_put(sncpf_device);
 362       out_platform_registered:
 363         platform_driver_unregister(&sncpf_driver);
 364       out:
 365         return ret;
 366 }
 367
 368 static void sony_snc_pf_remove(void)
 369 {
 370         struct sony_acpi_value *item;
 371
 372         for (item = sony_acpi_values; item->name; ++item) {
 373                 device_remove_file(&sncpf_device->dev, &item->devattr);
 374         }
 375
 376         platform_device_del(sncpf_device);
 377         platform_device_put(sncpf_device);
 378         platform_driver_unregister(&sncpf_driver);
 379 }
 380
 381 /*
 382  * Backlight device
 383  */
 384 static int sony_backlight_update_status(struct backlight_device *bd)
 385 {
 386         return acpi_callsetfunc(sony_acpi_handle, "SBRT",
 387                                 bd->props.brightness + 1, NULL);
 388 }
 389
 390 static int sony_backlight_get_brightness(struct backlight_device *bd)
 391 {
 392         int value;
 393
 394         if (acpi_callgetfunc(sony_acpi_handle, "GBRT", &value))
 395                 return 0;
 396         /* brightness levels are 1-based, while backlight ones are 0-based */
 397         return value - 1;
 398 }
 399
 400 static struct backlight_device *sony_backlight_device;
 401 static struct backlight_ops sony_backlight_ops = {
 402         .update_status = sony_backlight_update_status,
 403         .get_brightness = sony_backlight_get_brightness,
 404 };
 405
 406 /*
 407  * ACPI callbacks
 408  */
 409 static void sony_acpi_notify(acpi_handle handle, u32 event, void *data)
 410 {
 411         if (debug)
 412                 printk(LOG_PFX "sony_acpi_notify, event: %d\n", event);
 413         acpi_bus_generate_event(sony_acpi_acpi_device, 1, event);
 414 }
 415
 416 static acpi_status sony_walk_callback(acpi_handle handle, u32 level,
 417                                       void *context, void **return_value)
 418 {
 419         struct acpi_namespace_node *node;
 420         union acpi_operand_object *operand;
 421
 422         node = (struct acpi_namespace_node *)handle;
 423         operand = (union acpi_operand_object *)node->object;
 424
 425         printk(LOG_PFX "method: name: %4.4s, args %X\n", node->name.ascii,
 426                (u32) operand->method.param_count);
 427
 428         return AE_OK;
 429 }
 430
 431 /*
 432  * ACPI device
 433  */
 434 static int sony_acpi_resume(struct acpi_device *device)
 435 {
 436         struct sony_acpi_value *item;
 437
 438         for (item = sony_acpi_values; item->name; item++) {
 439                 int ret;
 440
 441                 if (!item->valid)
 442                         continue;
 443                 ret = acpi_callsetfunc(sony_acpi_handle, *item->acpiset,
 444                                        item->value, NULL);
 445                 if (ret < 0) {
 446                         printk("%s: %d\n", __FUNCTION__, ret);
 447                         break;
 448                 }
 449         }
 450         return 0;
 451 }
 452
 453 static int sony_acpi_add(struct acpi_device *device)
 454 {
 455         acpi_status status;
 456         int result;
 457         acpi_handle handle;
 458
 459         sony_acpi_acpi_device = device;
 460
 461         sony_acpi_handle = device->handle;
 462
 463         if (debug) {
 464                 status = acpi_walk_namespace(ACPI_TYPE_METHOD, sony_acpi_handle,
 465                                              1, sony_walk_callback, NULL, NULL);
 466                 if (ACPI_FAILURE(status)) {
 467                         printk(LOG_PFX "unable to walk acpi resources\n");
 468                         result = -ENODEV;
 469                         goto outwalk;
 470                 }
 471         }
 472
 473         status = acpi_install_notify_handler(sony_acpi_handle,
 474                                              ACPI_DEVICE_NOTIFY,
 475                                              sony_acpi_notify, NULL);
 476         if (ACPI_FAILURE(status)) {
 477                 printk(LOG_PFX "unable to install notify handler\n");
 478                 result = -ENODEV;
 479                 goto outwalk;
 480         }
 481
 482         if (ACPI_SUCCESS(acpi_get_handle(sony_acpi_handle, "GBRT", &handle))) {
 483                 sony_backlight_device = backlight_device_register("sony", NULL,
 484                                                                   NULL,
 485                                                                   &sony_backlight_ops);
 486
 487                 if (IS_ERR(sony_backlight_device)) {
 488                         printk(LOG_PFX "unable to register backlight device\n");
 489                         sony_backlight_device = NULL;
 490                 } else {
 491                         sony_backlight_device->props.brightness =
 492                             sony_backlight_get_brightness
 493                             (sony_backlight_device);
 494                         sony_backlight_device->props.max_brightness =
 495                             SONY_MAX_BRIGHTNESS - 1;
 496                 }
 497
 498         }
 499
 500         if (sony_snc_pf_add())
 501                 goto outbacklight;
 502
 503         printk(KERN_INFO ACPI_SNC_DRIVER_NAME " successfully installed\n");
 504
 505         return 0;
 506
 507       outbacklight:
 508         if (sony_backlight_device)
 509                 backlight_device_unregister(sony_backlight_device);
 510
 511         status = acpi_remove_notify_handler(sony_acpi_handle,
 512                                             ACPI_DEVICE_NOTIFY,
 513                                             sony_acpi_notify);
 514         if (ACPI_FAILURE(status))
 515                 printk(LOG_PFX "unable to remove notify handler\n");
 516       outwalk:
 517         return result;
 518 }
 519
 520 static int sony_acpi_remove(struct acpi_device *device, int type)
 521 {
 522         acpi_status status;
 523
 524         if (sony_backlight_device)
 525                 backlight_device_unregister(sony_backlight_device);
 526
 527         sony_acpi_acpi_device = NULL;
 528
 529         status = acpi_remove_notify_handler(sony_acpi_handle,
 530                                             ACPI_DEVICE_NOTIFY,
 531                                             sony_acpi_notify);
 532         if (ACPI_FAILURE(status))
 533                 printk(LOG_PFX "unable to remove notify handler\n");
 534
 535         sony_snc_pf_remove();
 536
 537         printk(KERN_INFO ACPI_SNC_DRIVER_NAME " successfully removed\n");
 538
 539         return 0;
 540 }
 541
 542 static struct acpi_driver sony_acpi_driver = {
 543         .name = ACPI_SNC_DRIVER_NAME,
 544         .class = ACPI_SNC_CLASS,
 545         .ids = ACPI_SNC_HID,
 546         .ops = {
 547                 .add = sony_acpi_add,
 548                 .remove = sony_acpi_remove,
 549                 .resume = sony_acpi_resume,
 550                 },
 551 };
 552
 553 static int __init sony_acpi_init(void)
 554 {
 555         return acpi_bus_register_driver(&sony_acpi_driver);
 556 }
 557
 558 static void __exit sony_acpi_exit(void)
 559 {
 560         acpi_bus_unregister_driver(&sony_acpi_driver);
 561 }
 562
 563 module_init(sony_acpi_init);
 564 module_exit(sony_acpi_exit);