From patchwork Sat Dec 23 05:40:38 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 10131395 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 71ADD6056E for ; Sat, 23 Dec 2017 05:41:06 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 635FD29F30 for ; Sat, 23 Dec 2017 05:41:06 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 54B0D29F87; Sat, 23 Dec 2017 05:41:06 +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=-6.8 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI,T_DKIM_INVALID autolearn=unavailable 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 9B0FC29F77 for ; Sat, 23 Dec 2017 05:41:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1750855AbdLWFlC (ORCPT ); Sat, 23 Dec 2017 00:41:02 -0500 Received: from merlin.infradead.org ([205.233.59.134]:52944 "EHLO merlin.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750704AbdLWFlA (ORCPT ); Sat, 23 Dec 2017 00:41:00 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=merlin.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Date:Message-ID:Subject:From:Cc:To:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=ZCgMppG7hxznvOUgVuqRoOce2FYG2AHHu2POhqw9Z+Q=; b=oyZfk1tOsTc/D8aV555Jcp4nid yo+hrQXSQHiFA7qqCTqMJLEeN3oW/lMYNTaApC9QFZFm7DHdY6T7mSaTHjNjAhdPqKRlsNVVjguf8 6/Zk5Tv9PakmZvWFLg/OUmzm7XplPqkc+GDbOBfCFh0udEK4pRUT6fPV+Zdjc5JOlABWQvHya0OXq p51AUNX7yaBZ2wQgK9KKZYOqI+WnJ99RQVB7gk8/0+6YKLI39pgJLzwyJi5/gal8ybCRf63LB3gFz b7lCCXrxggXIfzd5PtdQ79WEv7Ura9xs6d2zeT8efWD59fDJ3cZsbt1WjznfYsy8ojxrLw75K0W6C r7HssuJA==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=midway.dunlap) by merlin.infradead.org with esmtpsa (Exim 4.89 #1 (Red Hat Linux)) id 1eScY6-0004QB-9k; Sat, 23 Dec 2017 05:40:42 +0000 To: linux-scsi , target-devel Cc: "linux-rdma@vger.kernel.org" , "Nicholas A. Bellinger" , Sagi Grimberg , "James E.J. Bottomley" , "Martin K. Petersen" , shli@kernel.org, Andy Grover From: Randy Dunlap Subject: [PATCH] target: add kernel-doc overview in target_core_user.[hc] Message-ID: <7e8662e8-f554-cc8c-0287-6a22f561692b@infradead.org> Date: Fri, 22 Dec 2017 21:40:38 -0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.0 MIME-Version: 1.0 Content-Language: en-US Sender: linux-scsi-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-scsi@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP From: Randy Dunlap Make documentation on target-supported userspace-I/O design be usable by kernel-doc by using "DOC:". Signed-off-by: Randy Dunlap Cc: "Nicholas A. Bellinger" Cc: linux-scsi@vger.kernel.org Cc: target-devel@vger.kernel.org Cc: Sagi Grimberg Cc: linux-rdma@vger.kernel.org Cc: "James E.J. Bottomley" Cc: "Martin K. Petersen" Cc: Shaohua Li Cc: Andy Grover --- drivers/target/target_core_user.c | 6 +++++- include/uapi/linux/target_core_user.h | 11 ++++++----- 2 files changed, 11 insertions(+), 6 deletions(-) --- linux-next-20171221.orig/drivers/target/target_core_user.c +++ linux-next-20171221/drivers/target/target_core_user.c @@ -42,7 +42,11 @@ #include -/* +/** + * DOC: Userspace I/O + * Userspace I/O + * ------------- + * * Define a shared-memory interface for LIO to pass SCSI commands and * data to userspace for processing. This is to allow backends that * are too complex for in-kernel support to be possible. --- linux-next-20171221.orig/include/uapi/linux/target_core_user.h +++ linux-next-20171221/include/uapi/linux/target_core_user.h @@ -9,21 +9,22 @@ #define TCMU_VERSION "2.0" -/* +/** + * DOC: Ring Design * Ring Design * ----------- * * The mmaped area is divided into three parts: - * 1) The mailbox (struct tcmu_mailbox, below) - * 2) The command ring - * 3) Everything beyond the command ring (data) + * 1) The mailbox (struct tcmu_mailbox, below); + * 2) The command ring; + * 3) Everything beyond the command ring (data). * * The mailbox tells userspace the offset of the command ring from the * start of the shared memory region, and how big the command ring is. * * The kernel passes SCSI commands to userspace by putting a struct * tcmu_cmd_entry in the ring, updating mailbox->cmd_head, and poking - * userspace via uio's interrupt mechanism. + * userspace via UIO's interrupt mechanism. * * tcmu_cmd_entry contains a header. If the header type is PAD, * userspace should skip hdr->length bytes (mod cmdr_size) to find the