From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1753679Ab1HHRbo (ORCPT <rfc822;w@1wt.eu>);
	Mon, 8 Aug 2011 13:31:44 -0400
Received: from oproxy8-pub.bluehost.com ([69.89.22.20]:37965 "HELO
	oproxy8-pub.bluehost.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
	with SMTP id S1753519Ab1HHRbm (ORCPT
	<rfc822;linux-kernel@vger.kernel.org>);
	Mon, 8 Aug 2011 13:31:42 -0400
Date: Mon, 8 Aug 2011 10:31:40 -0700
From: Randy Dunlap <rdunlap@xenotime.net>
To: Sergiu Iordache <sergiu@chromium.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] char drivers: ramoops documentation
Message-Id: <20110808103140.7726a203.rdunlap@xenotime.net>
In-Reply-To: <1312823540-7509-1-git-send-email-sergiu@chromium.org>
References: <1312823540-7509-1-git-send-email-sergiu@chromium.org>
Organization: YPO4
X-Mailer: Sylpheed 2.7.1 (GTK+ 2.16.6; x86_64-unknown-linux-gnu)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
X-Identified-User: {1807:box742.bluehost.com:xenotime:xenotime.net} {sentby:smtp auth 50.53.38.135 authed with rdunlap@xenotime.net}
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On Mon,  8 Aug 2011 10:12:19 -0700 Sergiu Iordache wrote:

> Add a documentation file describing the usage of Ramoops
> 
> Signed-off-by: Sergiu Iordache <sergiu@chromium.org>
> ---
>  Documentation/ramoops.txt |   76 +++++++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 76 insertions(+), 0 deletions(-)
>  create mode 100644 Documentation/ramoops.txt
> 
> diff --git a/Documentation/ramoops.txt b/Documentation/ramoops.txt
> new file mode 100644
> index 0000000..8fb1ba7
> --- /dev/null
> +++ b/Documentation/ramoops.txt
> @@ -0,0 +1,76 @@
> +Ramoops oops/panic logger
> +=========================
> +
> +Sergiu Iordache <sergiu@chromium.org>
> +
> +Updated: 8 August 2011
> +
> +0. Introduction
> +
> +Ramoops is an oops/panic logger that writes its logs to RAM before the system
> +crashes. It works by logging oopses and panics in a circular buffer. Ramoops
> +needs a system with persistent RAM so that the content of that area can
> +survive after a restart.
> +
> +1. Ramoops concepts
> +
> +Ramoops uses a predefined memory area to store the dump. The start and size of
> +the memory area are set using two variables:
> +  * "mem_address" for the start
> +  * "mem_size" for the size. The memory size will be rounded down to a
> +  power of two.
> +
> +The memory area is divided into "record_size" chunks (also rounded down to
> +power of two) and each oops/panic writes a "record_size" chunk of
> +information.
> +
> +Dumping both oopses and panics can be done by setting 1 in the "dump_oops"
> +variable while setting 0 in that variable dumps only the panics.
> +
> +The module uses a counter to record multiple dumps but the counter gets reset
> +on restart (i.e. new dumps after the restart will overwrite old ones).
> +
> +2. Setting the parameters
> +
> +Setting the ramoops parameters can be done in 2 different manners:
> + 1. Use the module parameters (which have the names of the variables described
> + as before).
> + 2. Use a platform device and set the platform data. The parameters can then
> + be set through that platform data. An example of doing that is:
> +
> +#include <linux/ramoops.h>
> +[...]
> +
> +static struct ramoops_platform_data ramoops_data = {
> +        .mem_size               = <...>,
> +        .mem_address            = <...>,
> +        .record_size            = <...>,
> +        .dump_oops              = <...>,
> +};
> +
> +static struct platform_device ramoops_dev = {
> +        .name = "ramoops",
> +        .dev = {
> +                .platform_data = &ramoops_data,
> +        },
> +};
> +
> +[... inside a function ...]
> +int ret;
> +
> +ret = platform_device_register(&ramoops_dev);
> +if (ret) {
> +	printk(KERN_ERR "unable to register platform device\n");
> +	return ret;
> +}
> +
> +3. Dump format
> +
> +The data dump begins with a header, currently defined as "====" followed by a
> +timestamp and a new line. The dump then continues with the actual data.
> +
> +4. Reading the data
> +
> +The dump data can be read from memory (through /dev/mem or other means).
> +Getting the module parameters, which are needed in order to parse the data, can
> +be done through /sys/module/ramoops/parameters/* .
> -- 

Thanks.  I can merge it, but the patch needs one more thing:
a addition to Documentation/00-INDEX for this new file,
so please resend the patch including that addition.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***