Linux-mtd Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Josh Boyer <jwboyer@linux.vnet.ibm.com>
To: "Jörn Engel" <joern@logfs.org>
Cc: linux-mtd@lists.infradead.org, David Woodhouse <dwmw2@infradead.org>
Subject: Re: [PATCH] [MTD] Document erase interface.
Date: Fri, 21 Sep 2007 09:14:41 -0500	[thread overview]
Message-ID: <20070921091441.6fa649df@weaponx.rchland.ibm.com> (raw)
In-Reply-To: <20070921134143.GH1692@lazybastard.org>

On Fri, 21 Sep 2007 15:41:44 +0200
Jörn Engel <joern@logfs.org> wrote:

> Document mtd erase interface.
> 
> Signed-off-by: Jörn Engel <joern@logfs.org>
> ---
> 
>  include/linux/mtd/mtd.h |    7 +++++++
>  1 file changed, 7 insertions(+)
> 
> --- linux-2.6.21logfs/include/linux/mtd/mtd.h~mtd_erase_documentation	2007-05-31 13:41:41.000000000 +0200
> +++ linux-2.6.21logfs/include/linux/mtd/mtd.h	2007-09-21 15:43:18.000000000 +0200
> @@ -139,6 +139,13 @@ struct mtd_info {
>  	/* This really shouldn't be here. It can go away in 2.5 */
>  	u_int32_t bank_size;
>  
> +	/*
> +	 * Erase is an asynchronous operation.  Device drivers are supposed
> +	 * to call instr->callback() whenever the operation completes, even
> +	 * if it completes with a failure.
> +	 * Callers are supposed to pass a callback function and wait for it
> +	 * to be called before writing to the block.
> +	 */
>  	int (*erase) (struct mtd_info *mtd, struct erase_info *instr);

If you're going to go to the trouble, maybe doing it in KernelDoc style
would be better.

josh

  reply	other threads:[~2007-09-21 14:17 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-09-21 13:41 [PATCH] [MTD] Document erase interface Jörn Engel
2007-09-21 14:14 ` Josh Boyer [this message]
2007-09-21 14:14   ` Jörn Engel

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=20070921091441.6fa649df@weaponx.rchland.ibm.com \
    --to=jwboyer@linux.vnet.ibm.com \
    --cc=dwmw2@infradead.org \
    --cc=joern@logfs.org \
    --cc=linux-mtd@lists.infradead.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox