From patchwork Thu Nov 21 15:54:59 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Schwebel X-Patchwork-Id: 1199018 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 47JkfX5ppFz9sPK for ; Fri, 22 Nov 2019 02:55:16 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726983AbfKUPzP (ORCPT ); Thu, 21 Nov 2019 10:55:15 -0500 Received: from metis.ext.pengutronix.de ([85.220.165.71]:59587 "EHLO metis.ext.pengutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726775AbfKUPzL (ORCPT ); Thu, 21 Nov 2019 10:55:11 -0500 Received: from gallifrey.ext.pengutronix.de ([2001:67c:670:201:5054:ff:fe8d:eefb] helo=leda.hi.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1iXonT-0002x1-0c; Thu, 21 Nov 2019 16:55:07 +0100 Received: by leda.hi.pengutronix.de (Postfix, from userid 1006) id ABCD72C877E4; Thu, 21 Nov 2019 16:55:05 +0100 (CET) From: Robert Schwebel To: Jonathan Corbet Cc: Robert Schwebel , "David S. Miller" , netdev@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH 1/5] docs: networking: nfc: change headlines to sphinx syntax Date: Thu, 21 Nov 2019 16:54:59 +0100 Message-Id: <20191121155503.52019-1-r.schwebel@pengutronix.de> X-Mailer: git-send-email 2.24.0 MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:201:5054:ff:fe8d:eefb X-SA-Exim-Mail-From: rsc@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: netdev@vger.kernel.org Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org The headlines in this file do are not in the standard kernel docu- mentation headline format. Change it, so this file can be switched to rst in the future. Signed-off-by: Robert Schwebel --- Documentation/networking/nfc.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.txt index b24c29bdae27..c053610bfadc 100644 --- a/Documentation/networking/nfc.txt +++ b/Documentation/networking/nfc.txt @@ -1,3 +1,4 @@ +=================== Linux NFC subsystem =================== @@ -8,7 +9,7 @@ This document covers the architecture overview, the device driver interface description and the userspace interface description. Architecture overview ---------------------- +===================== The NFC subsystem is responsible for: - NFC adapters management; @@ -51,7 +52,7 @@ PF_NFC. The NFC_SOCKPROTO_RAW performs raw communication with NFC targets. +-----------+ Device Driver Interface ------------------------ +======================= When registering on the NFC subsystem, the device driver must inform the core of the set of supported NFC protocols and the set of ops callbacks. The ops @@ -64,7 +65,7 @@ callbacks that must be implemented are the following: * data_exchange - send data and receive the response (transceive operation) Userspace interface --------------------- +=================== The userspace interface is divided in control operations and low-level data exchange operation. From patchwork Thu Nov 21 15:55:00 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Schwebel X-Patchwork-Id: 1199015 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 47JkfR6GSQz9sPK for ; Fri, 22 Nov 2019 02:55:11 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726574AbfKUPzK (ORCPT ); Thu, 21 Nov 2019 10:55:10 -0500 Received: from metis.ext.pengutronix.de ([85.220.165.71]:46645 "EHLO metis.ext.pengutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726822AbfKUPzK (ORCPT ); Thu, 21 Nov 2019 10:55:10 -0500 Received: from gallifrey.ext.pengutronix.de ([2001:67c:670:201:5054:ff:fe8d:eefb] helo=leda.hi.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1iXonT-0002x2-0c; Thu, 21 Nov 2019 16:55:07 +0100 Received: by leda.hi.pengutronix.de (Postfix, from userid 1006) id AE6BB2C877E3; Thu, 21 Nov 2019 16:55:05 +0100 (CET) From: Robert Schwebel To: Jonathan Corbet Cc: Robert Schwebel , "David S. Miller" , netdev@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH 2/5] docs: networking: nfc: change block diagram to sphinx syntax Date: Thu, 21 Nov 2019 16:55:00 +0100 Message-Id: <20191121155503.52019-2-r.schwebel@pengutronix.de> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191121155503.52019-1-r.schwebel@pengutronix.de> References: <20191121155503.52019-1-r.schwebel@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:201:5054:ff:fe8d:eefb X-SA-Exim-Mail-From: rsc@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: netdev@vger.kernel.org Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Change the block diagram to match the sphinx syntax. This will make it possible to switch this file to rst in the future. Signed-off-by: Robert Schwebel --- Documentation/networking/nfc.txt | 49 ++++++++++++++++---------------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.txt index c053610bfadc..b6056e597e20 100644 --- a/Documentation/networking/nfc.txt +++ b/Documentation/networking/nfc.txt @@ -26,30 +26,31 @@ The control operations are available to userspace via generic netlink. The low-level data exchange interface is provided by the new socket family PF_NFC. The NFC_SOCKPROTO_RAW performs raw communication with NFC targets. - - +--------------------------------------+ - | USER SPACE | - +--------------------------------------+ - ^ ^ - | low-level | control - | data exchange | operations - | | - | v - | +-----------+ - | AF_NFC | netlink | - | socket +-----------+ - | raw ^ - | | - v v - +---------+ +-----------+ - | rawsock | <--------> | core | - +---------+ +-----------+ - ^ - | - v - +-----------+ - | driver | - +-----------+ +.. code-block:: none + + +--------------------------------------+ + | USER SPACE | + +--------------------------------------+ + ^ ^ + | low-level | control + | data exchange | operations + | | + | v + | +-----------+ + | AF_NFC | netlink | + | socket +-----------+ + | raw ^ + | | + v v + +---------+ +-----------+ + | rawsock | <--------> | core | + +---------+ +-----------+ + ^ + | + v + +-----------+ + | driver | + +-----------+ Device Driver Interface ======================= From patchwork Thu Nov 21 15:55:01 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Schwebel X-Patchwork-Id: 1199016 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 47JkfS6WyQz9sPv for ; Fri, 22 Nov 2019 02:55:12 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726279AbfKUPzL (ORCPT ); Thu, 21 Nov 2019 10:55:11 -0500 Received: from metis.ext.pengutronix.de ([85.220.165.71]:60455 "EHLO metis.ext.pengutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726869AbfKUPzK (ORCPT ); Thu, 21 Nov 2019 10:55:10 -0500 Received: from gallifrey.ext.pengutronix.de ([2001:67c:670:201:5054:ff:fe8d:eefb] helo=leda.hi.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1iXonT-0002x3-0b; Thu, 21 Nov 2019 16:55:07 +0100 Received: by leda.hi.pengutronix.de (Postfix, from userid 1006) id B98322C877E6; Thu, 21 Nov 2019 16:55:05 +0100 (CET) From: Robert Schwebel To: Jonathan Corbet Cc: Robert Schwebel , "David S. Miller" , netdev@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH 3/5] docs: networking: nfc: fix bullet list syntax Date: Thu, 21 Nov 2019 16:55:01 +0100 Message-Id: <20191121155503.52019-3-r.schwebel@pengutronix.de> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191121155503.52019-1-r.schwebel@pengutronix.de> References: <20191121155503.52019-1-r.schwebel@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:201:5054:ff:fe8d:eefb X-SA-Exim-Mail-From: rsc@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: netdev@vger.kernel.org Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Fix this warning: Documentation/networking/nfc.rst:87: WARNING: Bullet list ends without a blank line; unexpected unindent. Signed-off-by: Robert Schwebel --- Documentation/networking/nfc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.txt index b6056e597e20..af69b3a90eaa 100644 --- a/Documentation/networking/nfc.txt +++ b/Documentation/networking/nfc.txt @@ -84,7 +84,7 @@ The operations are composed by commands and events, all listed below: * NFC_EVENT_DEVICE_ADDED - reports an NFC device addition * NFC_EVENT_DEVICE_REMOVED - reports an NFC device removal * NFC_EVENT_TARGETS_FOUND - reports START_POLL results when 1 or more targets -are found + are found The user must call START_POLL to poll for NFC targets, passing the desired NFC protocols through NFC_ATTR_PROTOCOLS attribute. The device remains in polling From patchwork Thu Nov 21 15:55:02 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Schwebel X-Patchwork-Id: 1199019 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 47JkfZ08wmz9sPK for ; Fri, 22 Nov 2019 02:55:18 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726976AbfKUPzP (ORCPT ); Thu, 21 Nov 2019 10:55:15 -0500 Received: from metis.ext.pengutronix.de ([85.220.165.71]:41037 "EHLO metis.ext.pengutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726858AbfKUPzL (ORCPT ); Thu, 21 Nov 2019 10:55:11 -0500 Received: from gallifrey.ext.pengutronix.de ([2001:67c:670:201:5054:ff:fe8d:eefb] helo=leda.hi.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1iXonT-0002x4-0a; Thu, 21 Nov 2019 16:55:07 +0100 Received: by leda.hi.pengutronix.de (Postfix, from userid 1006) id BDF7D2C877E7; Thu, 21 Nov 2019 16:55:05 +0100 (CET) From: Robert Schwebel To: Jonathan Corbet Cc: Robert Schwebel , "David S. Miller" , netdev@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH 4/5] docs: networking: nfc: fix code block syntax Date: Thu, 21 Nov 2019 16:55:02 +0100 Message-Id: <20191121155503.52019-4-r.schwebel@pengutronix.de> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191121155503.52019-1-r.schwebel@pengutronix.de> References: <20191121155503.52019-1-r.schwebel@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:201:5054:ff:fe8d:eefb X-SA-Exim-Mail-From: rsc@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: netdev@vger.kernel.org Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Silence this warning: Documentation/networking/nfc.rst:113: WARNING: Definition list ends without a blank line; unexpected unindent. Signed-off-by: Robert Schwebel --- Documentation/networking/nfc.txt | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.txt index af69b3a90eaa..63e483f6afb4 100644 --- a/Documentation/networking/nfc.txt +++ b/Documentation/networking/nfc.txt @@ -105,12 +105,14 @@ LOW-LEVEL DATA EXCHANGE: The userspace must use PF_NFC sockets to perform any data communication with targets. All NFC sockets use AF_NFC: -struct sockaddr_nfc { - sa_family_t sa_family; - __u32 dev_idx; - __u32 target_idx; - __u32 nfc_protocol; -}; +.. code-block:: none + + struct sockaddr_nfc { + sa_family_t sa_family; + __u32 dev_idx; + __u32 target_idx; + __u32 nfc_protocol; + }; To establish a connection with one target, the user must create an NFC_SOCKPROTO_RAW socket and call the 'connect' syscall with the sockaddr_nfc From patchwork Thu Nov 21 15:55:03 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robert Schwebel X-Patchwork-Id: 1199017 X-Patchwork-Delegate: davem@davemloft.net Return-Path: X-Original-To: patchwork-incoming-netdev@ozlabs.org Delivered-To: patchwork-incoming-netdev@ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=netdev-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=pengutronix.de Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 47JkfV1Pblz9sPK for ; Fri, 22 Nov 2019 02:55:14 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726957AbfKUPzN (ORCPT ); Thu, 21 Nov 2019 10:55:13 -0500 Received: from metis.ext.pengutronix.de ([85.220.165.71]:59419 "EHLO metis.ext.pengutronix.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726774AbfKUPzK (ORCPT ); Thu, 21 Nov 2019 10:55:10 -0500 Received: from gallifrey.ext.pengutronix.de ([2001:67c:670:201:5054:ff:fe8d:eefb] helo=leda.hi.pengutronix.de) by metis.ext.pengutronix.de with esmtp (Exim 4.92) (envelope-from ) id 1iXonT-0002x5-0a; Thu, 21 Nov 2019 16:55:07 +0100 Received: by leda.hi.pengutronix.de (Postfix, from userid 1006) id C40F42C877E8; Thu, 21 Nov 2019 16:55:05 +0100 (CET) From: Robert Schwebel To: Jonathan Corbet Cc: Robert Schwebel , "David S. Miller" , netdev@vger.kernel.org, linux-doc@vger.kernel.org Subject: [PATCH 5/5] docs: networking: nfc: change to rst format Date: Thu, 21 Nov 2019 16:55:03 +0100 Message-Id: <20191121155503.52019-5-r.schwebel@pengutronix.de> X-Mailer: git-send-email 2.24.0 In-Reply-To: <20191121155503.52019-1-r.schwebel@pengutronix.de> References: <20191121155503.52019-1-r.schwebel@pengutronix.de> MIME-Version: 1.0 X-SA-Exim-Connect-IP: 2001:67c:670:201:5054:ff:fe8d:eefb X-SA-Exim-Mail-From: rsc@pengutronix.de X-SA-Exim-Scanned: No (on metis.ext.pengutronix.de); SAEximRunCond expanded to false X-PTX-Original-Recipient: netdev@vger.kernel.org Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org Now that the sphinx syntax has been fixed, change the document from txt to rst and add it to the index. Signed-off-by: Robert Schwebel --- Documentation/networking/{nfc.txt => nfc.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename Documentation/networking/{nfc.txt => nfc.rst} (100%) diff --git a/Documentation/networking/nfc.txt b/Documentation/networking/nfc.rst similarity index 100% rename from Documentation/networking/nfc.txt rename to Documentation/networking/nfc.rst