From patchwork Fri Apr 20 08:29:51 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Linus Walleij X-Patchwork-Id: 10352185 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id ADCE16023A for ; Fri, 20 Apr 2018 08:32:04 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9FFD62434C for ; Fri, 20 Apr 2018 08:32:04 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 94A3E286A8; Fri, 20 Apr 2018 08:32:04 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 2CD632434C for ; Fri, 20 Apr 2018 08:32:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1754238AbeDTIb7 (ORCPT ); Fri, 20 Apr 2018 04:31:59 -0400 Received: from mail-lf0-f67.google.com ([209.85.215.67]:41965 "EHLO mail-lf0-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754228AbeDTIb6 (ORCPT ); Fri, 20 Apr 2018 04:31:58 -0400 Received: by mail-lf0-f67.google.com with SMTP id o123-v6so1401368lfe.8 for ; Fri, 20 Apr 2018 01:31:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id; bh=tqywrtM+fjd+IwEBtr1RpLbpf2cqi0NNeRMXtHhqwbU=; b=f6jU8vhKb1wHmb8FEErYdpP3M3jTW67Xsf5Z7EYlLzb4AZuz3SBIn5Snas5Aza/lnR 2+WCy3+YawtWXMlaJKLWK94D0ZnfhO8ayy6cW1wSKy7UUuSKUKBSptybJRLN1XLFcoqn 6j22XD5SVd0gkNUcwdaIHgjPKp8xVQac0cd9g= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=tqywrtM+fjd+IwEBtr1RpLbpf2cqi0NNeRMXtHhqwbU=; b=ISr46jQjJuTQSrFswRQOLOAB0G8EXooGXtD08enIhDkjelSUcnVAYMf/0F5qtxr2nH m14oaY/Na2EDsUXJi9C+1C6elaQd/lQDwMw8zuTFHGt4rEYT8NiQiUUZxZ2RgrWkWeEm H2Tvtgurzw5aOYk/1Jk7UdffIjIolH0MbvieykC21wyd7J96JCHpAkYztGzkf6QGZpnT qTFqTQZRT78gff8esqx6KWiAhu6fCvkdZRt64snGzzy56CjjJQxLx679zTL5xYQgKyxh /I6MHRHNtgQegnThRr+TcOsugDBwM+2SqDdBmaynz9ESsdYI0+h3oiF5EXpHgUw1mROT C4Wg== X-Gm-Message-State: ALQs6tCpOpEJtxfrfjQuDT6SpmHPzp5AcUd8tZvzsbNi0x0Ni5N06VKz yIWQDAwXFhY9ho3qDMhuo5ciZDdJ8Og= X-Google-Smtp-Source: AB8JxZo9ryzEnd5zr1khkmez9HZQtgBZRrCj9aMJmfVso9ntX1P9Yljmht//LcuiDoeL4h61K2T1dg== X-Received: by 2002:a19:d390:: with SMTP id k138-v6mr1401272lfg.118.1524213116354; Fri, 20 Apr 2018 01:31:56 -0700 (PDT) Received: from localhost.localdomain (c-cb7471d5.014-348-6c756e10.cust.bredbandsbolaget.se. [213.113.116.203]) by smtp.gmail.com with ESMTPSA id d4-v6sm1217639lfg.65.2018.04.20.01.31.55 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 20 Apr 2018 01:31:55 -0700 (PDT) From: Linus Walleij To: linux-block@vger.kernel.org, Jens Axboe Cc: Linus Walleij Subject: [PATCH] block: mq: Add some minor doc for core structs Date: Fri, 20 Apr 2018 10:29:51 +0200 Message-Id: <20180420082951.10481-1-linus.walleij@linaro.org> X-Mailer: git-send-email 2.14.3 Sender: linux-block-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-block@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP As it came up in discussion on the mailing list that the semantic meaning of 'blk_mq_ctx' and 'blk_mq_hw_ctx' isn't completely obvious to everyone, let's add some minimal kerneldoc for a starter. Signed-off-by: Linus Walleij --- block/blk-mq.h | 3 +++ include/linux/blk-mq.h | 3 +++ 2 files changed, 6 insertions(+) diff --git a/block/blk-mq.h b/block/blk-mq.h index 88c558f71819..89b5cd3a6c70 100644 --- a/block/blk-mq.h +++ b/block/blk-mq.h @@ -7,6 +7,9 @@ struct blk_mq_tag_set; +/** + * struct blk_mq_ctx - State for a software queue facing the submitting CPUs + */ struct blk_mq_ctx { struct { spinlock_t lock; diff --git a/include/linux/blk-mq.h b/include/linux/blk-mq.h index e3986f4b3461..ebc34a5686dc 100644 --- a/include/linux/blk-mq.h +++ b/include/linux/blk-mq.h @@ -9,6 +9,9 @@ struct blk_mq_tags; struct blk_flush_queue; +/** + * struct blk_mq_hw_ctx - State for a hardware queue facing the hardware block device + */ struct blk_mq_hw_ctx { struct { spinlock_t lock;