Received-SPF: Pass (protection.outlook.com: domain of xilinx.com designates
 149.199.62.198 as permitted sender) receiver=protection.outlook.com;
 client-ip=149.199.62.198; helo=xsj-pvapexch01.xlnx.xilinx.com;
Envelope-to: dwmw2@infradead.org,
 mdf@kernel.org,
 robh@kernel.org,
 trix@redhat.com,
 devicetree@vger.kernel.org,
 linux-fpga@vger.kernel.org,
 linux-kernel@vger.kernel.org
From:   Lizhi Hou <lizhi.hou@xilinx.com>
To:     <linux-kernel@vger.kernel.org>
CC:     Lizhi Hou <lizhi.hou@xilinx.com>, <linux-fpga@vger.kernel.org>,
        <maxz@xilinx.com>, <sonal.santan@xilinx.com>, <yliu@xilinx.com>,
        <michal.simek@xilinx.com>, <stefanos@xilinx.com>,
        <devicetree@vger.kernel.org>, <trix@redhat.com>, <mdf@kernel.org>,
        <robh@kernel.org>, <dwmw2@infradead.org>
Subject: [PATCH V4 XRT Alveo Infrastructure 0/5] XRT Alveo driver infrastructure overview
Date:   Wed, 5 Jan 2022 14:50:08 -0800
Message-ID: <20220105225013.1567871-1-lizhi.hou@xilinx.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jan 2022 22:50:24.0546
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: ac2ffff6-523f-44b6-9b44-08d9d09dc283
X-MS-Exchange-CrossTenant-Id: 657af505-d5df-48d0-8300-c31994686c5c
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=657af505-d5df-48d0-8300-c31994686c5c;Ip=[149.199.62.198];Helo=[xsj-pvapexch01.xlnx.xilinx.com]
X-MS-Exchange-CrossTenant-AuthSource: DM3NAM02FT034.eop-nam02.prod.protection.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BL0PR02MB5650
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Hello,

This V4 of patch series builds the core infrastructure for Xilinx Alveo PCIe 
accelerator cards. This patch series incorporates feedback on the usage of
device tree for describing HW subsystems or endpoints as they are called
here. An endpoint is exposed as an addressable range in a PCIe BAR exposed
by the Alveo device and optionally includes an interrupt specification.

The patch series includes Documentation/xrt.rst which describes Alveo
platform, XRT driver architecture and deployment model in more detail.

The Alveo PCIe device uses Device Tree blob to describe its HW subsystems.
Each device tree node represents a hardware endpoint and each endpoint
is an hardware unit which requires a driver. XRT driver infrastructure 
unflattens the device tree blob and overlays the device nodes
to the system device tree. of/unittest.c, pci/hotplug/pnv_php.c and other
linux kernel code are referenced for usage of OF functions.

The unflattened device nodes will be populated by existing Linux platform
device and OF infrastructure. This means a platform device will be created
for each endpoint node. And the platform driver will be bound based on
'compatible' property defined in endpoint node.

This patch series uses a builtin test device tree blob which contains only
one endpoint as an input.

--
Changes since v3:
- Removed xrt bus type, device and driver. Instead, the device nodes are
  populated by existing platform device and OF infrastructure.
- fixed issue reported by kernel robot

Changes since v2:
- reversed the change of of_fdt_unflatten_tree()
- unified default of_root creation with unittest code

Changes since v1:
- fixed 'make dt_binding_check' errors.

--
References:
- V3 version of patch series.
    https://lore.kernel.org/lkml/20211204003957.1448567-1-lizhi.hou@xilinx.com/
- XRT V9 driver patch series before major restructure.
    https://lore.kernel.org/lkml/20210802160521.331031-1-lizhi.hou@xilinx.com/

Lizhi Hou (5):
  Documentation: fpga: Add a document describing XRT Alveo driver
    infrastructure
  Documentation: devicetree: bindings: add binding for Alveo platform
  of: create empty of root
  fpga: xrt: xrt-lib common interfaces
  fpga: xrt: management physical function driver

 .../bindings/fpga/xlnx,alveo-partition.yaml   |  76 ++++
 .../fpga/xlnx,alveo-pr-isolation.yaml         |  40 +++
 Documentation/fpga/index.rst                  |   1 +
 Documentation/fpga/xrt.rst                    | 337 ++++++++++++++++++
 MAINTAINERS                                   |  10 +
 drivers/fpga/Kconfig                          |   3 +
 drivers/fpga/Makefile                         |   4 +
 drivers/fpga/xrt/Kconfig                      |   7 +
 drivers/fpga/xrt/include/xpartition.h         |  28 ++
 drivers/fpga/xrt/lib/Kconfig                  |  17 +
 drivers/fpga/xrt/lib/Makefile                 |  15 +
 drivers/fpga/xrt/lib/lib-drv.c                | 178 +++++++++
 drivers/fpga/xrt/lib/lib-drv.h                |  15 +
 drivers/fpga/xrt/mgmt/Kconfig                 |  14 +
 drivers/fpga/xrt/mgmt/Makefile                |  16 +
 drivers/fpga/xrt/mgmt/dt-test.dts             |  12 +
 drivers/fpga/xrt/mgmt/dt-test.h               |  15 +
 drivers/fpga/xrt/mgmt/xmgmt-drv.c             | 158 ++++++++
 drivers/of/Makefile                           |   5 +
 drivers/of/fdt.c                              |  90 +++++
 drivers/of/fdt_default.dts                    |   5 +
 drivers/of/of_private.h                       |  17 +
 drivers/of/unittest.c                         |  72 +---
 23 files changed, 1066 insertions(+), 69 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,alveo-partition.yaml
 create mode 100644 Documentation/devicetree/bindings/fpga/xlnx,alveo-pr-isolation.yaml
 create mode 100644 Documentation/fpga/xrt.rst
 create mode 100644 drivers/fpga/xrt/Kconfig
 create mode 100644 drivers/fpga/xrt/include/xpartition.h
 create mode 100644 drivers/fpga/xrt/lib/Kconfig
 create mode 100644 drivers/fpga/xrt/lib/Makefile
 create mode 100644 drivers/fpga/xrt/lib/lib-drv.c
 create mode 100644 drivers/fpga/xrt/lib/lib-drv.h
 create mode 100644 drivers/fpga/xrt/mgmt/Kconfig
 create mode 100644 drivers/fpga/xrt/mgmt/Makefile
 create mode 100644 drivers/fpga/xrt/mgmt/dt-test.dts
 create mode 100644 drivers/fpga/xrt/mgmt/dt-test.h
 create mode 100644 drivers/fpga/xrt/mgmt/xmgmt-drv.c
 create mode 100644 drivers/of/fdt_default.dts

-- 
2.27.0