From patchwork Sat Jul 6 13:49:16 2013 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Rodolfo_Garc=C3=ADa_Pe=C3=B1as_=28kix=29?= X-Patchwork-Id: 2824498 Return-Path: X-Original-To: patchwork-linux-pm@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 438C9C0AB2 for ; Sat, 6 Jul 2013 13:56:49 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 41A112015D for ; Sat, 6 Jul 2013 13:56:48 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 8913420165 for ; Sat, 6 Jul 2013 13:56:46 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751514Ab3GFN4k (ORCPT ); Sat, 6 Jul 2013 09:56:40 -0400 Received: from mail.kix.es ([46.105.17.89]:54728 "EHLO what.com.es" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751307Ab3GFN4i (ORCPT ); Sat, 6 Jul 2013 09:56:38 -0400 Received: from osaka.kix.es (4.Red-217-127-226.staticIP.rima-tde.net [217.127.226.4]) by what.com.es (Postfix) with ESMTPA id E31156A09C3; Sat, 6 Jul 2013 15:49:33 +0200 (CEST) From: =?UTF-8?q?Rodolfo=20Garc=C3=ADa=20Pe=C3=B1as=20=28kix=29?= To: linux-pm@vger.kernel.org Cc: rjw@sisk.pl, =?UTF-8?q? "Rodolfo=20Garc=C3=ADa=20Pe=C3=B1as=20(kix)" ?= Subject: [PATCH 7/7] README: Documentation for s2ram options Date: Sat, 6 Jul 2013 15:49:16 +0200 Message-Id: <1373118556-27472-8-git-send-email-kix@kix.es> X-Mailer: git-send-email 1.7.10.4 In-Reply-To: <1373118556-27472-1-git-send-email-kix@kix.es> References: <1373118556-27472-1-git-send-email-kix@kix.es> MIME-Version: 1.0 Sender: linux-pm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pm@vger.kernel.org X-Spam-Status: No, score=-6.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: "Rodolfo García Peñas (kix)" This patch includes the documentation to use the s2ram options, for the configuration file and the command line. Signed-off-by: Rodolfo García Peñas (kix) --- README | 50 ++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 6 deletions(-) diff --git a/README b/README index 8ec0dd6..d5f493c 100644 --- a/README +++ b/README @@ -45,10 +45,48 @@ three different methods to suspend the machine: The flow of options is: 1. If the kernel supports KMS, then use it. This option can be overriding - using the argument "-k" in s2ram (s2ram -k). + using the argument "-k" in s2ram (s2ram -k). Is possible test if the + kernel supports KMS using the argument "-K". 2. If the kernel don't support KMS, or the user override it, then s2ram checks if the configuration file has the parameters. If the parameters - are included, s2ram use them, else, the whitelist is used. + are included, s2ram use them, else, the whitelist is used. Is possible + test if the machine is in the whitelist using the argument "-n". + +The full table of options is: + +User want = What the user needs for their machine (KMS, Whitelist or their + own specific quirks). +KMS support? = If the kernel has KMS support enabled. +In WL? = If the machine is included in the whitelist. +Command Line = What should do the user in the command line (s2ram options). +Config File = What should include the user in the configuration file. +N/A = Yes and No, for both cases. +Not possible = This option cannot be used!. +Nothing = The user must not include s2ram_force, s2ram_quirks and + s2ram_quirks lines in the configuration file. +"" = Quirks options to be used. In command line these options are + --vbe_save, --vbe_post,... and in the config file are + vbe_save, vb_post (same options, without the "--"). + +User want | KMS support? | In WL? | Command Line | Config File +==========+==============+========+================+======================== + | No | N/A | Not possible | Not possible +KMS (-K) +--------------+--------+----------------+------------------------ + | Yes | N/A | No arguments | Nothing +==========+==============+========+================+======================== + | N/A | No | Not possible | Not possible + +--------------+--------+----------------+------------------------ +WL (-n) | No | Yes | No arguments | Nothing + +--------------+--------+----------------+------------------------ + | Yes | Yes | -k | s2ram_disable_kms = y +==========+==============+========+================+======================== + | No | N/A | -f | s2ram_force = y + | | | | s2ram_quirks = +User +--------------+--------+----------------+------------------------ +Quirks | Yes | N/A | -k -f | s2ram_disable_kms = y + | | | | s2ram_force = y + | | | | s2ram_quirks = +----------+--------------+--------+----------------+------------------------ You need libx86 installed to build s2ram, the HOWTO document explains how to install it. @@ -61,16 +99,16 @@ can resume the system from disk using the resume tool otherwise However, this is only possible if your box is present in the s2ram whitelist. To build the s2ram and s2both tools you will need the pciutils-devel -(pciutils-dev) package and the libx86-dev package (which you can get from -http://www.codon.org.uk/~mjg59/libx86/downloads/). They are necessary to -compile the vbetool code (the vbetool code is based on vbetool-1.0 from +(pciutils-dev) package and the libx86-dev package (which you can get from +http://www.codon.org.uk/~mjg59/libx86/downloads/). They are necessary to +compile the vbetool code (the vbetool code is based on vbetool-1.0 from http://www.codon.org.uk/~mjg59/vbetool/). With newer pciutils (2.2.4 and above) you also have to install the zlib development package (zlib-devel on SUSE, zlib1g-dev on Debian). For debugging, see http://suspend.sf.net/s2ram-support.html. -acpi-support package from Ubuntu has *very* long whitelist of machines: +acpi-support package from Ubuntu has *very* long whitelist of machines: http://packages.ubuntu.org.cn/dapper/admin/acpi-support that are likely to work with s2ram.