From patchwork Wed Dec 27 20:48:05 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy Dunlap X-Patchwork-Id: 10134057 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 ACB2C60318 for ; Wed, 27 Dec 2017 20:48:14 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9B7E82D0C0 for ; Wed, 27 Dec 2017 20:48:14 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 903AE2D0C1; Wed, 27 Dec 2017 20:48:14 +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 41A192D0A0 for ; Wed, 27 Dec 2017 20:48:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752561AbdL0UsM (ORCPT ); Wed, 27 Dec 2017 15:48:12 -0500 Received: from bombadil.infradead.org ([65.50.211.133]:42194 "EHLO bombadil.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751335AbdL0UsK (ORCPT ); Wed, 27 Dec 2017 15:48:10 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.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=ZzVdOUiEdyCwa0qkWKnCkwXyR442USYKmSeg7j1m8OU=; b=A+0skIO6K1n/GQvVIQyxgKgZp pQfX6pKi3WM2ZfLUwhmJZ+L8BO6f5UpUL4tt6FqhN4bBu1Y+7Pi0LnnZ7Mldb80hfDs5QREbhwiiQ DXLIbFo2MtJ3CDfekGaOk/2ThWjNF8Ab92V8tasjP4fMNrmhmOvZZytJt1DIqG4szhZZ6fdqJnSfK 5vn5pIt8jH7taXwXkjqlq+08Aa4KSG9174xkKY8hZB5iyAjqbKsPFxL2Pwl1wradzXQdMNXjy1LJu BpNb7Cryod7zk0NI5jOtXWsgv1I7W0NFLVGOTq3DQwwnfE9YClU8jYMkjga5KsLj4xz7J4hq46sKZ svcn2GY2Q==; Received: from static-50-53-52-16.bvtn.or.frontiernet.net ([50.53.52.16] helo=midway.dunlap) by bombadil.infradead.org with esmtpsa (Exim 4.89 #1 (Red Hat Linux)) id 1eUIcQ-0001ou-Bw; Wed, 27 Dec 2017 20:48:06 +0000 To: linux-scsi , target-devel , "linux-rdma@vger.kernel.org" Cc: "Nicholas A. Bellinger" , "James E.J. Bottomley" , "Martin K. Petersen" From: Randy Dunlap Subject: [PATCH v2] target: add a target/iscsi driver-api Documentation chapter Message-ID: <0a5cd0a8-2f3e-f001-8b69-2f5e34cc7cb2@infradead.org> Date: Wed, 27 Dec 2017 12:48:05 -0800 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.5.2 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 Add a driver-api document for target/iSCSI interfaces. Signed-off-by: Randy Dunlap --- This patch depends on 4 previous patches to driver source files: [PATCH] target: fix kernel-doc warnings in drivers/target/target_core_transport.c https://marc.info/?l=linux-scsi&m=151398041926906&w=2 [PATCH] scsi: fix iscsi-related kernel-doc warnings https://marc.info/?l=linux-scsi&m=151398051426923&w=2 [PATCH] target: add kernel-doc overview in target_core_user.[hc] [PATCH] target: add kernel-doc overview in target_core_user.[hc] [PATCH] target: cleanup target_core_transport.c for kernel-doc https://marc.info/?l=linux-scsi&m=151409284812033&w=2 v2: fix missing ':' on one line (:export:) Documentation/driver-api/index.rst | 1 Documentation/driver-api/scsi.rst | 2 Documentation/driver-api/target.rst | 64 ++++++++++++++++++++++++++ 3 files changed, 66 insertions(+), 1 deletion(-) --- linux-next-20171221.orig/Documentation/driver-api/index.rst +++ linux-next-20171221/Documentation/driver-api/index.rst @@ -34,6 +34,7 @@ available subsections can be seen below. edac scsi libata + target mtdnand miscellaneous w1 --- linux-next-20171221.orig/Documentation/driver-api/scsi.rst +++ linux-next-20171221/Documentation/driver-api/scsi.rst @@ -340,5 +340,5 @@ todo ~~~~ Parallel (fast/wide/ultra) SCSI, USB, SATA, SAS, Fibre Channel, -FireWire, ATAPI devices, Infiniband, I2O, iSCSI, Parallel ports, +FireWire, ATAPI devices, Infiniband, I2O, Parallel ports, netlink... --- /dev/null +++ linux-next-20171221/Documentation/driver-api/target.rst @@ -0,0 +1,64 @@ +================================= +target and iSCSI Interfaces Guide +================================= + +Introduction and Overview +========================= + +TBD + +Target core device interfaces +============================= + +.. kernel-doc:: drivers/target/target_core_device.c + :export: + +Target core transport interfaces +================================ + +.. kernel-doc:: drivers/target/target_core_transport.c + :export: + +Target-supported userspace I/O +============================== + +.. kernel-doc:: drivers/target/target_core_user.c + :doc: Userspace I/O + +.. kernel-doc:: include/uapi/linux/target_core_user.h + :doc: Ring Design + +iSCSI helper functions +====================== + +.. kernel-doc:: drivers/scsi/libiscsi.c + :export: + + +iSCSI boot information +====================== + +.. kernel-doc:: drivers/scsi/iscsi_boot_sysfs.c + :export: + + +iSCSI transport class +===================== + +The file drivers/scsi/scsi_transport_iscsi.c defines transport +attributes for the iSCSI class, which sends SCSI packets over TCP/IP +connections. + +.. kernel-doc:: drivers/scsi/scsi_transport_iscsi.c + :export: + + +iSCSI TCP interfaces +==================== + +.. kernel-doc:: drivers/scsi/iscsi_tcp.c + :internal: + +.. kernel-doc:: drivers/scsi/libiscsi_tcp.c + :export: +