Commit 72a2707a authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'nfc-convert-from-txt-to-rst' 



Robert Schwebel says:

====================
here is v2 of the series converting the NFC documentation from txt to
rst. Thanks to Jonathan and Dave for the input.

Changes since (implicit) v1:

* replace code-block by more compact :: syntax

* really add the rst file to the index
====================

Signed-off-by: default avatarJakub Kicinski <jakub.kicinski@netronome.com>
parents a5d66f81 4791d77a

Documentation/networking/index.rst

+1 −0
Original line number Original line Diff line number Diff line
@@ -33,6 +33,7 @@ Contents: 
   scaling

   scaling

   tls

   tls

   tls-offload

   tls-offload

   nfc





.. only::  subproject and html

.. only::  subproject and html

Documentation/networking/nfc.txt→Documentation/networking/nfc.rst

+38 −36
Original line number Original line Diff line number Diff line 
===================

Linux NFC subsystem

Linux NFC subsystem

===================

===================
@@ -8,7 +9,7 @@ This document covers the architecture overview, the device driver interface 
description and the userspace interface description.

description and the userspace interface description.





Architecture overview

Architecture overview

---------------------

=====================





The NFC subsystem is responsible for:

The NFC subsystem is responsible for:

      - NFC adapters management;

      - NFC adapters management;
@@ -25,6 +26,7 @@ The control operations are available to userspace via generic netlink. 
The low-level data exchange interface is provided by the new socket family

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.

PF_NFC. The NFC_SOCKPROTO_RAW performs raw communication with NFC targets.





.. code-block:: none





        +--------------------------------------+

        +--------------------------------------+

        |              USER SPACE              |

        |              USER SPACE              |
@@ -51,7 +53,7 @@ PF_NFC. The NFC_SOCKPROTO_RAW performs raw communication with NFC targets. 
                               +-----------+

                               +-----------+





Device Driver Interface

Device Driver Interface

-----------------------

=======================





When registering on the NFC subsystem, the device driver must inform the core

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

of the set of supported NFC protocols and the set of ops callbacks. The ops
@@ -64,7 +66,7 @@ callbacks that must be implemented are the following: 
* data_exchange - send data and receive the response (transceive operation)

* data_exchange - send data and receive the response (transceive operation)





Userspace interface

Userspace interface

--------------------

===================





The userspace interface is divided in control operations and low-level data

The userspace interface is divided in control operations and low-level data

exchange operation.

exchange operation.
@@ -101,7 +103,7 @@ it's closed. 
LOW-LEVEL DATA EXCHANGE:

LOW-LEVEL DATA EXCHANGE:





The userspace must use PF_NFC sockets to perform any data communication with

The userspace must use PF_NFC sockets to perform any data communication with

targets. All NFC sockets use AF_NFC:

targets. All NFC sockets use AF_NFC::





        struct sockaddr_nfc {

        struct sockaddr_nfc {

               sa_family_t sa_family;

               sa_family_t sa_family;