From: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
To: linux-kernel@vger.kernel.org, marcos.souza.org@gmail.com
Cc: linux-block@vger.kernel.org, axboe@kernel.dk, bvanassche@acm.org,
Chaitanya.Kulkarni@wdc.com
Subject: [PATCH v3 2/3] blk-mq.c: Rework documention of blk_mq_init_sq_queue function
Date: Tue, 16 Apr 2019 23:10:29 -0300 [thread overview]
Message-ID: <20190417021030.82998-3-marcos.souza.org@gmail.com> (raw)
In-Reply-To: <20190417021030.82998-1-marcos.souza.org@gmail.com>
Describing better what the function does, what the arguments are meant for, and
what SQ stands for.
Reviewed-by: Chaitanya Kulkarni <chaitanya.kulkarni@wdc.com>
Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
---
block/blk-mq.c | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/block/blk-mq.c b/block/blk-mq.c
index 4a8277a54c03..03f45d0cd795 100644
--- a/block/blk-mq.c
+++ b/block/blk-mq.c
@@ -2675,9 +2675,21 @@ struct request_queue *blk_mq_init_queue(struct blk_mq_tag_set *set)
}
EXPORT_SYMBOL(blk_mq_init_queue);
-/*
- * Helper for setting up a queue with mq ops, given queue depth, and
- * the passed in mq ops flags.
+/**
+ * blk_mq_init_sq_queue - Create a new request queue with only one hw_queue (SQ)
+ * @set: tag set to be associated by the newly created request queue
+ * @ops: operations to be associated with @set
+ * @queue_depth: number of tags of @set
+ * @set_flags: flags that will be associated with @set, like BLK_MQ_F_TAG_SHARED
+ * or BLK_MQ_F_BLOCKING for example.
+ *
+ * Description:
+ * @set is initialized using @ops, @queue_depth, @set_flags, and using only one
+ * hw_queue (SQ). Later on blk_mq_alloc_tag_set() is called to validate and/or
+ * adjust values of the tag set. blk_mq_init_queue() is called passing @set as
+ * argument, returning a new request queue with @set associated.
+ *
+ * Returns the newly created request queue on success, or ERR_PTR() on failure.
*/
struct request_queue *blk_mq_init_sq_queue(struct blk_mq_tag_set *set,
const struct blk_mq_ops *ops,
--
2.16.4
next prev parent reply other threads:[~2019-04-17 2:10 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-17 2:10 [PATCH v3 0/3] Add documentation of some blk-mq functions Marcos Paulo de Souza
2019-04-17 2:10 ` [PATCH v3 1/3] blk-mq.c: Add documention of function blk_mq_init_queue Marcos Paulo de Souza
2019-04-17 2:10 ` Marcos Paulo de Souza [this message]
2019-04-17 2:10 ` [PATCH v3 3/3] Documentation: kernel-api.rst: Add block/blk-mq.c Marcos Paulo de Souza
2019-04-24 1:10 ` [PATCH v3 0/3] Add documentation of some blk-mq functions Marcos Paulo de Souza
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=20190417021030.82998-3-marcos.souza.org@gmail.com \
--to=marcos.souza.org@gmail.com \
--cc=Chaitanya.Kulkarni@wdc.com \
--cc=axboe@kernel.dk \
--cc=bvanassche@acm.org \
--cc=linux-block@vger.kernel.org \
--cc=linux-kernel@vger.kernel.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;
as well as URLs for NNTP newsgroup(s).