From 8693b90556e89e7fafab749f76c9214785895bc4 Mon Sep 17 00:00:00 2001
From: =?utf8?q?M=C3=A1rton=20N=C3=A9meth?= <nm127@freemail.hu>
Date: Fri, 20 Feb 2009 08:12:51 +0100
Subject: [PATCH] block: add documentation for register_blkdev()
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit
Add documentation for register_blkdev() function and for the parameters.
Signed-off-by: Márton Németh <nm127@freemail.hu>
Cc: Greg Kroah-Hartman <gregkh@suse.de>
Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
---
block/genhd.c | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/block/genhd.c b/block/genhd.c
index e1eadcc9546a7..a9ec910974c19 100644
--- a/block/genhd.c
+++ b/block/genhd.c
@@ -256,6 +256,22 @@ void blkdev_show(struct seq_file *seqf, off_t offset)
}
#endif /* CONFIG_PROC_FS */
+/**
+ * register_blkdev - register a new block device
+ *
+ * @major: the requested major device number [1..255]. If @major=0, try to
+ * allocate any unused major number.
+ * @name: the name of the new block device as a zero terminated string
+ *
+ * The @name must be unique within the system.
+ *
+ * The return value depends on the @major input parameter.
+ * - if a major device number was requested in range [1..255] then the
+ * function returns zero on success, or a negative error code
+ * - if any unused major number was requested with @major=0 parameter
+ * then the return value is the allocated major number in range
+ * [1..255] or a negative error code otherwise
+ */
int register_blkdev(unsigned int major, const char *name)
{
struct blk_major_name **n, *p;
--
2.39.5