All of lore.kernel.org
 help / color / mirror / Atom feed
From: Len Brown <lenb@kernel.org>
To: linux-acpi@vger.kernel.org
Cc: Mattia Dongili <malattia@linux.it>, Len Brown <len.brown@intel.com>
Subject: [PATCH 22/41] sony-laptop: Update docs
Date: Tue, 13 Feb 2007 00:49:24 -0500	[thread overview]
Message-ID: <11713458122380-git-send-email-lenb@kernel.org> (raw)
Message-ID: <69bd3589ca7240c0ff16a0d1192c233bee144800.1171345630.git.len.brown@intel.com> (raw)
In-Reply-To: <11713458113695-git-send-email-lenb@kernel.org>
In-Reply-To: <268d175f131e33fe1aed4cd5080884ab5d0badb2.1171345630.git.len.brown@intel.com>

From: Mattia Dongili <malattia@linux.it>

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>
---
 Documentation/acpi/sony_acpi.txt |   87 -------------------------------
 Documentation/sony-laptop.txt    |  106 ++++++++++++++++++++++++++++++++++++++
 drivers/misc/Kconfig             |   14 +++---
 3 files changed, 113 insertions(+), 94 deletions(-)
 delete mode 100644 Documentation/acpi/sony_acpi.txt
 create mode 100644 Documentation/sony-laptop.txt

diff --git a/Documentation/acpi/sony_acpi.txt b/Documentation/acpi/sony_acpi.txt
deleted file mode 100644
index 35a04be..0000000
--- a/Documentation/acpi/sony_acpi.txt
+++ /dev/null
@@ -1,87 +0,0 @@
-ACPI Sony Notebook Control Driver (SNC) Readme
-----------------------------------------------
-	Copyright (C) 2004- 2005 Stelian Pop <stelian@popies.net>
-
-This mini-driver drives the ACPI SNC device present in the
-ACPI BIOS of the Sony Vaio laptops.
-
-It gives access to some extra laptop functionalities. In
-its current form, this driver is mainly useful for controlling the
-screen brightness, but it may do more in the future.
-
-You should probably start by trying the sonypi driver, and try
-sony_acpi only if sonypi doesn't work for you.
-
-Usage:
-------
-
-Loading the sony_acpi module will create a /proc/acpi/sony/
-directory populated with a couple of files.
-
-You then read/write integer values from/to those files by using
-standard UNIX tools.
-
-The files are:
-	brightness		current screen brightness
-	brightness_default	screen brightness which will be set
-				when the laptop will be rebooted
-	cdpower			power on/off the internal CD drive
-
-Note that some files may be missing if they are not supported
-by your particular laptop model.
-
-Example usage:
-	# echo "1" > /proc/acpi/sony/brightness
-sets the lowest screen brightness,
-	# echo "8" > /proc/acpi/sony/brightness
-sets the highest screen brightness,
-	# cat /proc/acpi/sony/brightness
-retrieves the current screen brightness.
-
-Development:
-------------
-
-If you want to help with the development of this driver (and
-you are not afraid of any side effects doing strange things with
-your ACPI BIOS could have on your laptop), load the driver and
-pass the option 'debug=1'.
-
-REPEAT: DON'T DO THIS IF YOU DON'T LIKE RISKY BUSINESS.
-
-In your kernel logs you will find the list of all ACPI methods
-the SNC device has on your laptop. You can see the GBRT/SBRT methods
-used to get/set the brightness, but there are others.
-
-I HAVE NO IDEA WHAT THOSE METHODS DO.
-
-The sony_acpi driver creates, for some of those methods (the most
-current ones found on several Vaio models), an entry under
-/proc/acpi/sony/, just like the 'brightness' one. You can create
-other entries corresponding to your own laptop methods by further
-editing the source (see the 'sony_acpi_values' table, and add a new
-structure to this table with your get/set method names).
-
-Your mission, should you accept it, is to try finding out what
-those entries are for, by reading/writing random values from/to those
-files and find out what is the impact on your laptop.
-
-Should you find anything interesting, please report it back to me,
-I will not disavow all knowledge of your actions :)
-
-Bugs/Limitations:
------------------
-
-* This driver is not based on official documentation from Sony
-  (because there is none), so there is no guarantee this driver
-  will work at all, or do the right thing. Although this hasn't
-  happened to me, this driver could do very bad things to your
-  laptop, including permanent damage.
-
-* The sony_acpi and sonypi drivers do not interact at all. In the
-  future, sonypi could use sony_acpi to do (part of) its business.
-
-* spicctrl, which is the userspace tool used to communicate with the
-  sonypi driver (through /dev/sonypi) does not try to use the
-  sony_acpi driver. In the future, spicctrl could try sonypi first,
-  and if it isn't present, try sony_acpi instead.
-
diff --git a/Documentation/sony-laptop.txt b/Documentation/sony-laptop.txt
new file mode 100644
index 0000000..dfd26df
--- /dev/null
+++ b/Documentation/sony-laptop.txt
@@ -0,0 +1,106 @@
+Sony Notebook Control Driver (SNC) Readme
+-----------------------------------------
+	Copyright (C) 2004- 2005 Stelian Pop <stelian@popies.net>
+	Copyright (C) 2007 Mattia Dongili <malattia@linux.it>
+
+This mini-driver drives the SNC device present in the ACPI BIOS of
+the Sony Vaio laptops.
+
+It gives access to some extra laptop functionalities. In its current
+form, this driver let the user set or query the screen brightness
+through the backlight subsystem and remove/apply power to some devices.
+
+Backlight control:
+------------------
+If your laptop model supports it, you will find sysfs files in the
+/sys/class/backlight/sony/
+directory. You will be able to query and set the current screen
+brightness:
+	brightness		get/set screen brightness (an iteger
+				between 0 and 7)
+	actual_brightness	reading from this file will query the HW
+				to get real brightness value
+	max_brightness		the maximum brightness value
+
+
+Platform specific:
+------------------
+Loading the sony-laptop module will create a
+/sys/devices/platform/sony-laptop/
+directory populated with some files.
+
+You then read/write integer values from/to those files by using
+standard UNIX tools.
+
+The files are:
+	brightness_default	screen brightness which will be set
+				when the laptop will be rebooted
+	cdpower			power on/off the internal CD drive
+	audiopower		power on/off the internal sound card
+	lanpower		power on/off the internal ethernet card
+				(only in debug mode)
+
+Note that some files may be missing if they are not supported
+by your particular laptop model.
+
+Example usage:
+	# echo "1" > /sys/devices/platform/sony-laptop/brightness_default
+sets the lowest screen brightness for the next and later reboots,
+	# echo "8" > /sys/devices/platform/sony-laptop/brightness_default
+sets the highest screen brightness for the next and later reboots,
+	# cat /sys/devices/platform/sony-laptop/brightness_default
+retrieves the value.
+
+	# echo "0" > /sys/devices/platform/sony-laptop/audiopower
+powers off the sound card,
+	# echo "1" > /sys/devices/platform/sony-laptop/audiopower
+powers on the sound card.
+
+Development:
+------------
+
+If you want to help with the development of this driver (and
+you are not afraid of any side effects doing strange things with
+your ACPI BIOS could have on your laptop), load the driver and
+pass the option 'debug=1'.
+
+REPEAT: DON'T DO THIS IF YOU DON'T LIKE RISKY BUSINESS.
+
+In your kernel logs you will find the list of all ACPI methods
+the SNC device has on your laptop. You can see the GCDP/GCDP methods
+used to pwer on/off the CD drive, but there are others.
+
+I HAVE NO IDEA WHAT THOSE METHODS DO.
+
+The sony-laptop driver creates, for some of those methods (the most
+current ones found on several Vaio models), an entry under
+/sys/devices/platform/sony-laptop, just like the 'cdpower' one.
+You can create other entries corresponding to your own laptop methods by
+further editing the source (see the 'sony_acpi_values' table, and add a new
+entry to this table with your get/set method names using the
+HANDLE_NAMES macro).
+
+Your mission, should you accept it, is to try finding out what
+those entries are for, by reading/writing random values from/to those
+files and find out what is the impact on your laptop.
+
+Should you find anything interesting, please report it back to me,
+I will not disavow all knowledge of your actions :)
+
+Bugs/Limitations:
+-----------------
+
+* This driver is not based on official documentation from Sony
+  (because there is none), so there is no guarantee this driver
+  will work at all, or do the right thing. Although this hasn't
+  happened to me, this driver could do very bad things to your
+  laptop, including permanent damage.
+
+* The sony-laptop and sonypi drivers do not interact at all. In the
+  future, sonypi could use sony-laptop to do (part of) its business.
+
+* spicctrl, which is the userspace tool used to communicate with the
+  sonypi driver (through /dev/sonypi) does not try to use the
+  sony-laptop driver. In the future, spicctrl could try sonypi first,
+  and if it isn't present, try sony-laptop instead.
+
diff --git a/drivers/misc/Kconfig b/drivers/misc/Kconfig
index 009aff8..d7e8969 100644
--- a/drivers/misc/Kconfig
+++ b/drivers/misc/Kconfig
@@ -93,14 +93,14 @@ config SONY_LAPTOP
 	depends on X86 && ACPI
 	select BACKLIGHT_CLASS_DEVICE
 	  ---help---
-	  This mini-driver drives the ACPI SNC device present in the
-	  ACPI BIOS of the Sony Vaio laptops.
+	  This mini-driver drives the SNC device present in the ACPI BIOS of
+	  the Sony Vaio laptops.
 
-	  It gives access to some extra laptop functionalities. In
-	  its current form, the only thing this driver does is letting
-	  the user set or query the screen brightness and remove/apply
-	  power to some devices.
+	  It gives access to some extra laptop functionalities. In its current
+	  form, this driver let the user set or query the screen brightness
+	  through the backlight subsystem and remove/apply power to some
+	  devices.
 
-	  Read <file:Documentation/acpi/sony_acpi.txt> for more information.
+	  Read <file:Documentation/sony-laptop.txt> for more information.
 
 endmenu
-- 
1.5.0.rc4.345.gb4d2

  parent reply	other threads:[~2007-02-13  5:50 UTC|newest]

Thread overview: 42+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-02-13  5:49 ACPI related patches for 2.6.21 -- part II Len Brown
2007-02-13  5:49 ` [PATCH 01/41] sony_acpi: SNC device support for Sony Vaios Len Brown
2007-02-13  5:49   ` Len Brown
2007-02-13  5:49   ` [PATCH 02/41] sony_acpi: Avoid dimness on resume Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 03/41] sony_acpi: Fix sony_acpi_resume call Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 04/41] sony_acpi: Add backlight support to the sony_acpi Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 05/41] sony_acpi: Add backlight support to the sony_acpi v2 Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 06/41] sony_acpi: Video sysfs support take 2 Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 07/41] sony_acpi: Add acpi_bus_generate event Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 08/41] sony_acpi: Allow easier debugging for the unknown SNC methods Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 09/41] sony_acpi: Add lanpower and audiopower controls Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 10/41] sony_acpi: Allow multiple sony_acpi_values for the same .name Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 11/41] sony_acpi: Fix sony_acpi backlight registration and unregistration Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 12/41] sony-laptop: create from sony_acpi Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 13/41] sony-laptop: Remove /proc/acpi/sony interface and implement platform_device Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 14/41] sony-laptop: Small update to the Kconfig help to make people believe this driver is useful Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 15/41] sony-laptop: Group functions and structures to better draw subsytems usage Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 16/41] sony-laptop: Lindent Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 17/41] ACPI: bay: remove ACPI driver struct Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 18/41] ACPI: asus_acpi: Add support for Asus Z81SP Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49       ` [PATCH 19/41] ACPI: updates rtc-cmos device platform_data Len Brown
2007-02-13  5:49         ` Len Brown
2007-02-13  5:49   ` [PATCH 20/41] ACPI: bay: fix build warning Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` Len Brown [this message]
2007-02-13  5:49     ` [PATCH 22/41] sony-laptop: Update docs Len Brown
2007-02-13  5:49   ` [PATCH 23/41] sony-laptop: add to MAINTAINERS Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 24/41] ACPI: bay: fix wrong order of kzalloc arguments Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 25/41] ACPI: ibm-acpi: cleanup init and exit paths Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 26/41] ACPI: video: Fix null pointer in appledisplay driver Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  6:53       ` Len Brown
2007-02-13  5:49   ` [PATCH 27/41] ACPI: hotkey: remove driver, per feature-removal-schedule.txt Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 28/41] ACPI: Disable GPEs in preparation for sleep Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 29/41] ACPI: invoke acpi_sleep_init() earlier Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 30/41] ACPI: battery: check for battery present on /proc/battery access Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 31/41] ACPI: sbs: fix present rate Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 32/41] ACPI: add video driver MAINTAINER Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 33/41] ACPI: acpi_table_parse() now returns success/fail, not count Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 34/41] ACPI: acpi_madt_entry_handler() is not MADT specific Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 35/41] ACPI: acpi_table_parse_madt_family() " Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 36/41] ACPI: IA64: fix calculation of apic_id Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 37/41] ACPI: clean up ACPI_MODULE_NAME() use Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49       ` [PATCH 38/41] ACPI: fix acpi_driver.name usage Len Brown
2007-02-13  5:49         ` Len Brown
2007-02-13  5:49   ` [PATCH 39/41] ACPI: delete extra #defines in /drivers/acpi/ drivers Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 40/41] sony-laptop: allow complex per-value input/output validation Len Brown
2007-02-13  5:49     ` Len Brown
2007-02-13  5:49   ` [PATCH 41/41] ACPI: cleanup: make disable_acpi() valid w/o CONFIG_ACPI Len Brown
2007-02-13  5:49     ` Len Brown

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=11713458122380-git-send-email-lenb@kernel.org \
    --to=lenb@kernel.org \
    --cc=len.brown@intel.com \
    --cc=linux-acpi@vger.kernel.org \
    --cc=malattia@linux.it \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.