Eric Lee / smarc-ti-linux-kernel

Download as
Browse Code ยป

Commit ab5bd20696485a3f8c2f27058ace1cc1d6b580b3

Authored by Mattia Dongili
Committed by Len Brown
1 parent a02d1c1d2a
Exists in master and in 20 other branches dlt-processor-sdk-linux-03.00.00.04, newt-ti-linux-3.12.y, processor-sdk-linux-01.00.00, processor-sdk-linux-02.00.01, smarc-ti-linux-3.12.10, smarc-ti-linux-3.12.y, smarc-ti-linux-3.14.y, smarc-ti-linux-3.15.y, smarc-ti-lsk-linux-4.1.y, smarct3x-processor-sdk-04.01.00.06, smarct3x-processor-sdk-linux-02.00.01, smarct3x-processor-sdk-linux-03.00.00.04, smarct4x-800-processor-sdk-linux-02.00.01, smarct4x-processor-sdk-04.01.00.06, smarct4x-processor-sdk-linux-02.00.01, smarct4x-processor-sdk-linux-03.00.00.04, ti-linux-3.12.y, ti-linux-3.14.y, ti-linux-3.15.y, ti-lsk-linux-4.1.y

sony-laptop: Update docs 

Update documentation to be consistent with current implementation
(backlight subsys and platform_device).

Signed-off-by: Mattia Dongili <malattia@linux.it>
Signed-off-by: Len Brown <len.brown@intel.com>

Showing 3 changed files with 113 additions and 94 deletions Side-by-side Diff

Documentation/acpi/sony_acpi.txt
View file @ ab5bd20
1   -ACPI Sony Notebook Control Driver (SNC) Readme
2   -----------------------------------------------
3   - Copyright (C) 2004- 2005 Stelian Pop <stelian@popies.net>
4   -
5   -This mini-driver drives the ACPI SNC device present in the
6   -ACPI BIOS of the Sony Vaio laptops.
7   -
8   -It gives access to some extra laptop functionalities. In
9   -its current form, this driver is mainly useful for controlling the
10   -screen brightness, but it may do more in the future.
11   -
12   -You should probably start by trying the sonypi driver, and try
13   -sony_acpi only if sonypi doesn't work for you.
14   -
15   -Usage:
16   -------
17   -
18   -Loading the sony_acpi module will create a /proc/acpi/sony/
19   -directory populated with a couple of files.
20   -
21   -You then read/write integer values from/to those files by using
22   -standard UNIX tools.
23   -
24   -The files are:
25   - brightness current screen brightness
26   - brightness_default screen brightness which will be set
27   - when the laptop will be rebooted
28   - cdpower power on/off the internal CD drive
29   -
30   -Note that some files may be missing if they are not supported
31   -by your particular laptop model.
32   -
33   -Example usage:
34   - # echo "1" > /proc/acpi/sony/brightness
35   -sets the lowest screen brightness,
36   - # echo "8" > /proc/acpi/sony/brightness
37   -sets the highest screen brightness,
38   - # cat /proc/acpi/sony/brightness
39   -retrieves the current screen brightness.
40   -
41   -Development:
42   -------------
43   -
44   -If you want to help with the development of this driver (and
45   -you are not afraid of any side effects doing strange things with
46   -your ACPI BIOS could have on your laptop), load the driver and
47   -pass the option 'debug=1'.
48   -
49   -REPEAT: DON'T DO THIS IF YOU DON'T LIKE RISKY BUSINESS.
50   -
51   -In your kernel logs you will find the list of all ACPI methods
52   -the SNC device has on your laptop. You can see the GBRT/SBRT methods
53   -used to get/set the brightness, but there are others.
54   -
55   -I HAVE NO IDEA WHAT THOSE METHODS DO.
56   -
57   -The sony_acpi driver creates, for some of those methods (the most
58   -current ones found on several Vaio models), an entry under
59   -/proc/acpi/sony/, just like the 'brightness' one. You can create
60   -other entries corresponding to your own laptop methods by further
61   -editing the source (see the 'sony_acpi_values' table, and add a new
62   -structure to this table with your get/set method names).
63   -
64   -Your mission, should you accept it, is to try finding out what
65   -those entries are for, by reading/writing random values from/to those
66   -files and find out what is the impact on your laptop.
67   -
68   -Should you find anything interesting, please report it back to me,
69   -I will not disavow all knowledge of your actions :)
70   -
71   -Bugs/Limitations:
72   ------------------
73   -
74   -* This driver is not based on official documentation from Sony
75   - (because there is none), so there is no guarantee this driver
76   - will work at all, or do the right thing. Although this hasn't
77   - happened to me, this driver could do very bad things to your
78   - laptop, including permanent damage.
79   -
80   -* The sony_acpi and sonypi drivers do not interact at all. In the
81   - future, sonypi could use sony_acpi to do (part of) its business.
82   -
83   -* spicctrl, which is the userspace tool used to communicate with the
84   - sonypi driver (through /dev/sonypi) does not try to use the
85   - sony_acpi driver. In the future, spicctrl could try sonypi first,
86   - and if it isn't present, try sony_acpi instead.
Documentation/sony-laptop.txt
Diff comments   View file @ ab5bd20
  1 +Sony Notebook Control Driver (SNC) Readme
  2 +-----------------------------------------
  3 + Copyright (C) 2004- 2005 Stelian Pop <stelian@popies.net>
  4 + Copyright (C) 2007 Mattia Dongili <malattia@linux.it>
  5 +
  6 +This mini-driver drives the SNC device present in the ACPI BIOS of
  7 +the Sony Vaio laptops.
  8 +
  9 +It gives access to some extra laptop functionalities. In its current
  10 +form, this driver let the user set or query the screen brightness
  11 +through the backlight subsystem and remove/apply power to some devices.
  12 +
  13 +Backlight control:
  14 +------------------
  15 +If your laptop model supports it, you will find sysfs files in the
  16 +/sys/class/backlight/sony/
  17 +directory. You will be able to query and set the current screen
  18 +brightness:
  19 + brightness get/set screen brightness (an iteger
  20 + between 0 and 7)
  21 + actual_brightness reading from this file will query the HW
  22 + to get real brightness value
  23 + max_brightness the maximum brightness value
  24 +
  25 +
  26 +Platform specific:
  27 +------------------
  28 +Loading the sony-laptop module will create a
  29 +/sys/devices/platform/sony-laptop/
  30 +directory populated with some files.
  31 +
  32 +You then read/write integer values from/to those files by using
  33 +standard UNIX tools.
  34 +
  35 +The files are:
  36 + brightness_default screen brightness which will be set
  37 + when the laptop will be rebooted
  38 + cdpower power on/off the internal CD drive
  39 + audiopower power on/off the internal sound card
  40 + lanpower power on/off the internal ethernet card
  41 + (only in debug mode)
  42 +
  43 +Note that some files may be missing if they are not supported
  44 +by your particular laptop model.
  45 +
  46 +Example usage:
  47 + # echo "1" > /sys/devices/platform/sony-laptop/brightness_default
  48 +sets the lowest screen brightness for the next and later reboots,
  49 + # echo "8" > /sys/devices/platform/sony-laptop/brightness_default
  50 +sets the highest screen brightness for the next and later reboots,
  51 + # cat /sys/devices/platform/sony-laptop/brightness_default
  52 +retrieves the value.
  53 +
  54 + # echo "0" > /sys/devices/platform/sony-laptop/audiopower
  55 +powers off the sound card,
  56 + # echo "1" > /sys/devices/platform/sony-laptop/audiopower
  57 +powers on the sound card.
  58 +
  59 +Development:
  60 +------------
  61 +
  62 +If you want to help with the development of this driver (and
  63 +you are not afraid of any side effects doing strange things with
  64 +your ACPI BIOS could have on your laptop), load the driver and
  65 +pass the option 'debug=1'.
  66 +
  67 +REPEAT: DON'T DO THIS IF YOU DON'T LIKE RISKY BUSINESS.
  68 +
  69 +In your kernel logs you will find the list of all ACPI methods
  70 +the SNC device has on your laptop. You can see the GCDP/GCDP methods
  71 +used to pwer on/off the CD drive, but there are others.
  72 +
  73 +I HAVE NO IDEA WHAT THOSE METHODS DO.
  74 +
  75 +The sony-laptop driver creates, for some of those methods (the most
  76 +current ones found on several Vaio models), an entry under
  77 +/sys/devices/platform/sony-laptop, just like the 'cdpower' one.
  78 +You can create other entries corresponding to your own laptop methods by
  79 +further editing the source (see the 'sony_acpi_values' table, and add a new
  80 +entry to this table with your get/set method names using the
  81 +HANDLE_NAMES macro).
  82 +
  83 +Your mission, should you accept it, is to try finding out what
  84 +those entries are for, by reading/writing random values from/to those
  85 +files and find out what is the impact on your laptop.
  86 +
  87 +Should you find anything interesting, please report it back to me,
  88 +I will not disavow all knowledge of your actions :)
  89 +
  90 +Bugs/Limitations:
  91 +-----------------
  92 +
  93 +* This driver is not based on official documentation from Sony
  94 + (because there is none), so there is no guarantee this driver
  95 + will work at all, or do the right thing. Although this hasn't
  96 + happened to me, this driver could do very bad things to your
  97 + laptop, including permanent damage.
  98 +
  99 +* The sony-laptop and sonypi drivers do not interact at all. In the
  100 + future, sonypi could use sony-laptop to do (part of) its business.
  101 +
  102 +* spicctrl, which is the userspace tool used to communicate with the
  103 + sonypi driver (through /dev/sonypi) does not try to use the
  104 + sony-laptop driver. In the future, spicctrl could try sonypi first,
  105 + and if it isn't present, try sony-laptop instead.
drivers/misc/Kconfig
Diff comments   View file @ ab5bd20
... ... @@ -93,15 +93,15 @@
93 93 depends on X86 && ACPI
94 94 select BACKLIGHT_CLASS_DEVICE
95 95 ---help---
96   - This mini-driver drives the ACPI SNC device present in the
97   - ACPI BIOS of the Sony Vaio laptops.
  96 + This mini-driver drives the SNC device present in the ACPI BIOS of
  97 + the Sony Vaio laptops.
98 98  
99   - It gives access to some extra laptop functionalities. In
100   - its current form, the only thing this driver does is letting
101   - the user set or query the screen brightness and remove/apply
102   - power to some devices.
  99 + It gives access to some extra laptop functionalities. In its current
  100 + form, this driver let the user set or query the screen brightness
  101 + through the backlight subsystem and remove/apply power to some
  102 + devices.
103 103  
104   - Read <file:Documentation/acpi/sony_acpi.txt> for more information.
  104 + Read <file:Documentation/sony-laptop.txt> for more information.
105 105  
106 106 endmenu