From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 010C0CD8CB9 for ; Wed, 10 Jun 2026 10:04:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender:List-Subscribe:List-Help :List-Post:List-Archive:List-Unsubscribe:List-Id:Content-Transfer-Encoding: Content-Type:MIME-Version:References:In-Reply-To:Message-ID:Date:Subject:CC: To:From:Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=nFESc/ROTnMfaSPz06S9eltmuIq5/PF9tu+Kh4WpQGQ=; b=j5ThTSvPedf+0j/aZp6IDnJCiu I55HNugzXkiwIvec44vi/Ztp7tT+RST/UteezKmvcuRANX4+919aP7e+szgb55yEuXKUBytH76P/E JrkOQze+yrWI9trGLUHq+T6qa1jZ0d8a8z2zYgxuRR4HJQing02YAy+SJLB4PngL7Og5zbwa1ZGon 28A9zJMtZrt+/NIfqnFhzPpq1qs0AIKQ8AXw/47XR+wZhNViNIs5yCM0/4cR/liDpqPvXFD87YKBY gcZxKNI5YPd1pLJ4i8AOQTT6utmaOwtZEA60iGBtzs+w+mUulq34OSmlQVfhpxgwaZTpsN+ghrqa/ ISDv+50g==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.99.1 #2 (Red Hat Linux)) id 1wXFmw-00000007LIq-0kx0; Wed, 10 Jun 2026 10:03:58 +0000 Received: from mail-westcentralusazon11013009.outbound.protection.outlook.com ([40.93.201.9] helo=CY3PR05CU001.outbound.protection.outlook.com) by bombadil.infradead.org with esmtps (Exim 4.99.1 #2 (Red Hat Linux)) id 1wXFmt-00000007LHX-2InG for linux-arm-kernel@lists.infradead.org; Wed, 10 Jun 2026 10:03:56 +0000 ARC-Seal: i=1; a=rsa-sha256; s=arcselector10001; d=microsoft.com; cv=none; b=EPkX4vpiwfzQUCd3FDl8y0KCjc8xyo/mTkeM1+SxxhSvkQmYauoNkXYr9mX2NP40aforAtjhxcZVi+laDB9rmRqY6miz+QXnJF3S5ZHvPZF/BV/JiMKGyujQ3dUVXEGXIafZ8xNvOk6LEhQGKYeeKHwAGdUJh7Xs4M3IqdWZHInTxaR2dZp2OE1ngY2U0iU0gZO98LJ5HTIvy5ugwOQSuPS+alyESnNXcdTd+IPAM+9rMqC8s1Wv5lZDsonRPo6Y3H4qUO99RZgzxLakKByvgWuZTOL9OnmwrODiZU9ZITNEyEKcPEE4f1zb8wSKcRzBgR1VkR+HdKDzPgnd86upaA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector10001; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=nFESc/ROTnMfaSPz06S9eltmuIq5/PF9tu+Kh4WpQGQ=; b=xglUM7lNviUb1lR707qvLBdQPW4C9EDfZtATi50x1t7Z6OlralErYzPlMGiDTu2ivs8ErDBgJRRjU92aaSsiHhCs9o8/kaq6gz0z+8h9XHNtKjFXyv3Z7WEfnxtCX8EVrko+sIP8P4xjNug2SgBJySeKAVSQL5198BypXDsQPwjmmR+sqtRPSeZH5tcIKLDzVg4XKVNgK1O5R6K5R5DRkkIMMGnLm7mbfxeJGUKoFbx2TdL4KX+tzmBtSCKHeblQqN6tgt5t6QqYF6jwN1XnlJ5BIxPtcw0SXxC8wm49N76MakuH4t1Y7VICmo1ljf4ZQ2xN+OgJA9MO+2HTEMZ1Tw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 198.47.21.195) smtp.rcpttodomain=vger.kernel.org smtp.mailfrom=ti.com; dmarc=pass (p=quarantine sp=none pct=100) action=none header.from=ti.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ti.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=nFESc/ROTnMfaSPz06S9eltmuIq5/PF9tu+Kh4WpQGQ=; b=BoH8+zumfVeDCKCuWN9rNYvKo3ubkF+MS+3bEzYDYzn4Ox+06KHVsWbJyTUnQNBDLPbs8wCk2vUITLD5kE27rXg/vUpYpH/LZZbQ1l1H4lfpsq0LT7JPm7zU858jxQh+EOYoiFwwyssYuQwlr7DJOvK9F2bcuFtogTSGSg7Xv0o= Received: from CH2PR16CA0004.namprd16.prod.outlook.com (2603:10b6:610:50::14) by CH3PR10MB7353.namprd10.prod.outlook.com (2603:10b6:610:12c::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.21.92.13; Wed, 10 Jun 2026 10:03:49 +0000 Received: from CH1PEPF0000AD7B.namprd04.prod.outlook.com (2603:10b6:610:50:cafe::2e) by CH2PR16CA0004.outlook.office365.com (2603:10b6:610:50::14) with Microsoft SMTP Server (version=TLS1_3, cipher=TLS_AES_256_GCM_SHA384) id 15.21.113.11 via Frontend Transport; Wed, 10 Jun 2026 10:03:48 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 198.47.21.195) smtp.mailfrom=ti.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=ti.com; Received-SPF: Pass (protection.outlook.com: domain of ti.com designates 198.47.21.195 as permitted sender) receiver=protection.outlook.com; client-ip=198.47.21.195; helo=flwvzet201.ext.ti.com; pr=C Received: from flwvzet201.ext.ti.com (198.47.21.195) by CH1PEPF0000AD7B.mail.protection.outlook.com (10.167.244.58) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.21.113.7 via Frontend Transport; Wed, 10 Jun 2026 10:03:48 +0000 Received: from DFLE201.ent.ti.com (10.64.6.59) by flwvzet201.ext.ti.com (10.248.192.32) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.2562.37; Wed, 10 Jun 2026 05:03:21 -0500 Received: from DFLE205.ent.ti.com (10.64.6.63) by DFLE201.ent.ti.com (10.64.6.59) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.2562.37; Wed, 10 Jun 2026 05:03:21 -0500 Received: from lelvem-mr05.itg.ti.com (10.180.75.9) by DFLE205.ent.ti.com (10.64.6.63) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.2562.37 via Frontend Transport; Wed, 10 Jun 2026 05:03:21 -0500 Received: from a0507033-hp.dhcp.ti.com (a0507033-hp.dhcp.ti.com [10.24.68.129]) by lelvem-mr05.itg.ti.com (8.18.1/8.18.1) with ESMTP id 65AA2u903620198; Wed, 10 Jun 2026 05:03:17 -0500 From: Aksh Garg To: , , , , , , , , , , CC: , , , , , Subject: [PATCH v5 4/4] Documentation: PCI: Add documentation for DOE endpoint support Date: Wed, 10 Jun 2026 15:32:56 +0530 Message-ID: <20260610100256.1889111-5-a-garg7@ti.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20260610100256.1889111-1-a-garg7@ti.com> References: <20260610100256.1889111-1-a-garg7@ti.com> MIME-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 8bit X-C2ProcessedOrg: 333ef613-75bf-4e12-a4b1-8e3623f5dcea X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH1PEPF0000AD7B:EE_|CH3PR10MB7353:EE_ X-MS-Office365-Filtering-Correlation-Id: d444c0cf-e6a9-45f4-6d0e-08dec6d790b6 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0;ARA:13230040|376014|23010399003|7416014|36860700016|82310400026|1800799024|921020|56012099006|3023799007|5023799004|6133799003|22082099003|18002099003; X-Microsoft-Antispam-Message-Info: KofdHXW2r7X13LbL7IY4ee5AJW/tMyCXbMT+Tb6BxL21ZlJ4+vsx/gDHAYV3aiX16o+fdA7oCTYhlyx6w3VV9iM4Wl+gFPB8xHPcE/JdOI5k3T3gA+yUK1R34w1rcQbNzsV3k597+nvSIUau2pEqYpe70Ov72AC1mdD4XyaNDySvibdVfkcU2+9PysJqE9/HiZigEycSsAyBG6pHpnHuagnDQgLF+KjBpPsehUWrgSYcdF/cNaP+V/slEjF99d+g71K/EOIN+murwZNFI015lEG57kbFPtg4+VHKbABKjSDFYif7XTg3dpcK8rDHXuGoviw8VyC6vufQn7FBPL6wqXStXVMYwNmnr7MxqOKtQlLk+K0q1I5pUwthK05AGFCIDmEXWlMAsD5E9pUOCGdHUJQol9UBHEC1EHwNc9Yno0MIYvwTH+wu+8dXkJ96z0SO0c397p8bZRukUt7UFh7kt4Zy1DJl4c0aIH4hLPOt7Tl3tGbzvG/T1N9rworX9XG709TpHJ4trg1W03qd9mzCRVwxq3mFjctJEsf0x+Mm6WxxRFYvrdf2Ho9F9NBF0jKa7E7XYEJsVMxSmWglYZbgYXZn/G1zaWc/eNJSf6ZeRdtFcaGS+B/tvuI0UwvzzFDCxhOFMYUZAC+aSYypqM7KAIEYfH33KMEcc/OEp+2YqG/mtMGKQCGHyA+DcXIgsSClhQyI8go9k2EYWrEfgfJBu6l1OlpRi3phaL7aSO0q20R6QzujBLhNbeunlIZ35Dzrwq8gEbJu4azZ8xMecyqbTfx7tTyqj9AraZB35o26x30= X-Forefront-Antispam-Report: CIP:198.47.21.195;CTRY:US;LANG:en;SCL:1;SRV:;IPV:NLI;SFV:NSPM;H:flwvzet201.ext.ti.com;PTR:ErrorRetry;CAT:NONE;SFS:(13230040)(376014)(23010399003)(7416014)(36860700016)(82310400026)(1800799024)(921020)(56012099006)(3023799007)(5023799004)(6133799003)(22082099003)(18002099003);DIR:OUT;SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: n+SIrGmLkffpAkLFJFJQ9mBKWCRqVJU/rqYprjDukqGGPiS7DzVbrS67FHZNJHKCAd6LO5Ra0AKN23CgZexiJk9mkBOLnOvfDJntkjCDWYgxRK13GAWv1f2mtuD88BLJtlcIy+q4QYeT3D6Ravk8s9GjLdctHQjhqCFZ3q+GVVzygSk3edCeA3viEoGBjVTSrcjOkQQZKIX/2AEvOXUi6uJ1VM55cLiCfDMCjlX1S7EOzhUt3eWTzN0Ifq81jKLSYv76QjXxFsxqxbp7nja3fjVCtjpKBZuugJpGpCaczwIkgUieEtK4kcYWDJJfo025hLvuNnhN9Cz3b62cm7Q5qu4DtZmHC+cyWeN2bOfejxT9177Gyk+jz4f0NUoJ/66IVFVVuwBThHzuAphpPUiJL5t4zITBEyVm+wKeQUCHiOsvlCy/tILw6KHsYxa79eyO X-OriginatorOrg: ti.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 10 Jun 2026 10:03:48.0402 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: d444c0cf-e6a9-45f4-6d0e-08dec6d790b6 X-MS-Exchange-CrossTenant-Id: e5b49634-450b-4709-8abb-1e2b19b982b7 X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=e5b49634-450b-4709-8abb-1e2b19b982b7;Ip=[198.47.21.195];Helo=[flwvzet201.ext.ti.com] X-MS-Exchange-CrossTenant-AuthSource: CH1PEPF0000AD7B.namprd04.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CH3PR10MB7353 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.9.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20260610_030355_645874_2B80A6D8 X-CRM114-Status: GOOD ( 21.17 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org Document the architecture and implementation details for the Data Object Exchange (DOE) framework for PCIe Endpoint devices. Co-developed-by: Siddharth Vadapalli Signed-off-by: Siddharth Vadapalli Signed-off-by: Aksh Garg --- Changes from v4 to v5: - Updated the DOE Abort handling setion. Changes from v3 to v4: - Updated the maximum size of the DOE object from 256KB to 1MB, as per PCIe spec. - Updated the DOE setup and cleanup sections. Changes from v2 to v3: - Rebased on 7.1-rc1. Changes since v1: - Squashed the patches [1] and [2], and moved the documentation file to Documentation/PCI/endpoint/pci-endpoint-doe.rst to match the existing naming scheme, as suggested by Niklas Cassel - Updated the documentation as per the design and implementaion changes made to previous patches in this series: * Updated for static protocol array instead of dynamic registration * Documented asynchronous callback model * Updated request/response flow with new callback signature * Updated memory ownership: DOE core frees request, driver frees response * Updated initialization and cleanup sections for new APIs v4: https://lore.kernel.org/all/20260522052434.802034-5-a-garg7@ti.com/ v3: https://lore.kernel.org/all/20260427051725.223704-5-a-garg7@ti.com/ v2: https://lore.kernel.org/all/20260401073022.215805-5-a-garg7@ti.com/ v1: [1] https://lore.kernel.org/all/20260213123603.420941-2-a-garg7@ti.com/ [2] https://lore.kernel.org/all/20260213123603.420941-5-a-garg7@ti.com/ Documentation/PCI/endpoint/index.rst | 1 + .../PCI/endpoint/pci-endpoint-doe.rst | 333 ++++++++++++++++++ 2 files changed, 334 insertions(+) create mode 100644 Documentation/PCI/endpoint/pci-endpoint-doe.rst diff --git a/Documentation/PCI/endpoint/index.rst b/Documentation/PCI/endpoint/index.rst index dd1f62e731c9..7c03d5abd2ef 100644 --- a/Documentation/PCI/endpoint/index.rst +++ b/Documentation/PCI/endpoint/index.rst @@ -9,6 +9,7 @@ PCI Endpoint Framework pci-endpoint pci-endpoint-cfs + pci-endpoint-doe pci-test-function pci-test-howto pci-ntb-function diff --git a/Documentation/PCI/endpoint/pci-endpoint-doe.rst b/Documentation/PCI/endpoint/pci-endpoint-doe.rst new file mode 100644 index 000000000000..679844e36493 --- /dev/null +++ b/Documentation/PCI/endpoint/pci-endpoint-doe.rst @@ -0,0 +1,333 @@ +.. SPDX-License-Identifier: GPL-2.0-only OR MIT + +.. include:: + +============================================= +Data Object Exchange (DOE) for PCIe Endpoint +============================================= + +:Copyright: |copy| 2026 Texas Instruments Incorporated +:Author: Aksh Garg +:Co-Author: Siddharth Vadapalli + +Overview +======== + +DOE (Data Object Exchange) is a standard PCIe extended capability feature +introduced in the Data Object Exchange (DOE) ECN for PCIe r5.0. It is an optional +mechanism for system firmware/software running on root complex (host) to perform +:ref:`data object ` exchanges with an endpoint function. Each +data object is uniquely identified by the Vendor ID of the vendor publishing the +data object definition and a Data Object Type value assigned by that vendor. + +Think of DOE as a sophisticated mailbox system built into PCIe. The root complex +can send structured requests to the endpoint device through DOE mailboxes, and +the endpoint device responds with appropriate data. DOE mailboxes are implemented +as PCIe Extended Capabilities in endpoint devices, allowing multiple mailboxes +per function, each potentially supporting different data object protocols. + +The DOE support for root complex devices has already been implemented in +``drivers/pci/doe.c``. + +How DOE Works +============= + +The DOE mailbox operates through a simple request-response model: + +1. **Host sends request**: The root complex writes a data object (vendor ID, type, + and payload) to the DOE write mailbox register (one DWORD at a time) of the + endpoint function's config space and sets the GO bit in the DOE Control register + to indicate that a request is ready for processing. +2. **Endpoint processes**: The endpoint function reads the request from DOE write + mailbox register, sets the BUSY bit in the DOE Status register, identifies the + protocol of the data object, and executes the appropriate handler. +3. **Endpoint responds**: The endpoint function writes the response data object to the + DOE read mailbox register (one DWORD at a time), and sets the READY bit in the DOE + Status register to indicate that the response is ready. If an error occurs during + request processing (such as unsupported protocol or handler failure), the endpoint + sets the ERROR bit in the DOE Status register instead of the READY bit. +4. **Host reads response**: The root complex retrieves the response data from the DOE read + mailbox register once the READY bit is set in the DOE Status register, and then writes + any value to this register to indicate a successful read. If the ERROR bit was set, + the root complex discards the response and performs error handling as needed. + +Each mailbox operates independently and can handle one transaction at a time. The +DOE specification supports data objects of size up to 1MB (2\ :sup:`18` dwords). + +For complete DOE capability details, refer to `PCI Express Base Specification Revision 7.0, +Section 6.30 - Data Object Exchange (DOE)`. + +Key Terminologies +================= + +.. _data-object-term: + +**Data Object** + A structured, vendor-defined, or standard-defined message exchanged between + root complex and endpoint function via DOE capability registers in configuration + space of the function. + +**Mailbox** + A DOE capability on the endpoint device, where each physical function can have + multiple mailboxes. + +**Protocol** + A specific type of DOE communication data object identified by a Vendor ID and Type. + +**Handler** + A function that processes DOE requests of a specific protocol and generates responses. + +Architecture of DOE Implementation for Endpoint +=============================================== + +.. code-block:: text + + +------------------+ + | | + | Root Complex | + | | + +--------^---------+ + | + | Config space access + | over PCIe link + | + +----------v-----------+ + | | + | PCIe Controller | + | as Endpoint | + | | + | +-----------------+ | + | | DOE Mailbox | | + | +-------^---------+ | + +----------|-----------+ + +-----------|---------------------------------------------------------------+ + | | +--------------------+ | + | +---------v--------+ Allocate | +--------------+ | | + | | |-------------------------------->| Request | | | + | | EP Controller | +--->| Buffer | | | + | | Driver | Free | | +--------------+ | | + | | |--------------------------+ | | | | + | +--------^---------+ | | | | | + | | | | | | | + | | | | | | | + | | pci_ep_doe_process_request() | | | | | + | | | | | | | + | +--------v---------+ Free | | | | | + | | |----------------------------+ | DDR | | + | | DOE EP Core |<----+ | | | | + | | (pci-ep-doe.c) | | Discovery | | | | + | | |-----+ Protocol Handler | | | | + | +--------^---------+ | | | | + | | | | | | + | | protocol_handler() | | | | + | | | | | | + | +--------v---------+ | | | | + | | | | | +--------------+ | | + | | Protocol Handler | +----->| Response | | | + | | Module |-------------------------------->| Buffer | | | + | | (CMA/SPDM/Other) | Allocate | +--------------+ | | + | | | | | | + | +------------------+ | | | + | +--------------------+ | + +---------------------------------------------------------------------------+ + +Initialization and Cleanup +-------------------------- + +**Framework Initialization and DOE Setup** + +The EPC core automatically initializes and sets up DOE mailboxes through the +``pci_epc_init_capabilities()`` internal function, which is invoked during +``pci_epc_init_notify()`` when the controller driver calls this API. +Controller drivers do not need to explicitly handle DOE initialization, +rather the EPC core manages this transparently. + +DOE initialization only occurs when the EPC driver reports DOE capability +through the ``doe_capable`` flag in its ``pci_epc_features``. + +This internal function performs the following steps: + +1. Calls ``pci_ep_doe_init(epc)`` to initialize the xarray data structure + (a resizable array data structure defined in linux) named ``doe_mbs`` that + stores metadata of DOE mailboxes for the controller in ``struct pci_epc``. +2. Calls ``pci_epc_doe_setup(epc)`` to discover all DOE capabilities in the + endpoint function's configuration space for each function. For each + discovered DOE capability, calls ``pci_ep_doe_add_mailbox(epc, func_no, + cap_offset)`` to register the mailbox. + +Each DOE mailbox structure created by ``pci_ep_doe_add_mailbox()`` gets an +ordered workqueue allocated for processing DOE requests sequentially for that +mailbox, enabling concurrent request handling across different mailboxes. Each +mailbox is uniquely identified by the combination of physical function number +and capability offset for that controller. + +**Cleanup** + +The EPC core automatically cleans up DOE mailboxes through the +``pci_epc_deinit_capabilities()`` internal function, which is invoked during +``pci_epc_deinit_notify()`` when the controller driver calls this API. +Controller drivers do not need to explicitly handle DOE cleanup, rather +the EPC core manages this transparently. + +DOE cleanup only occurs when the EPC device reported DOE capability +through the ``doe_capable`` flag in its ``pci_epc_features``. + +This internal function calls ``pci_ep_doe_destroy(epc)``, which destroys all +registered mailboxes, cancels any pending tasks, flushes and destroys the +workqueues, and frees all memory allocated to the mailboxes. + +Protocol Handler Support +------------------------ + +Protocol implementations (such as CMA, SPDM, or vendor-specific protocols) are +supported through a static array of protocol handlers. + +When a new DOE protocol library is introduced, its handler function is added to +the static ``pci_doe_protocols`` array in ``drivers/pci/endpoint/pci-ep-doe.c``. +The discovery protocol (VID = 0x0001 (PCI-SIG vendor ID), Type = 0x00 (discovery +protocol)) is included in this static array and handled internally by the +DOE EP core. + +Request Handling +---------------- + +The complete flow of a DOE request from the root complex to the response: + +**Step 1: Root Complex → EP Controller Driver** + +The root complex writes a DOE request (Vendor ID, Type, and Payload) to the +DOE write mailbox register in the endpoint function's configuration space and sets +the GO bit in the DOE Control register, indicating that the request is ready for +processing. + +**Step 2: EP Controller Driver → DOE EP Core** + +The controller driver reads the request header to determine the data object +length. Based on this length field, it allocates a request buffer in memory +(DDR) of the appropriate size. The driver then reads the complete request +payload from the DOE write mailbox register and converts the data from +little-endian format (the format followed in the PCIe transactions over the +link) to CPU-native format using ``le32_to_cpu()``. The driver defines a +completion callback function with signature ``void (*complete)(struct pci_epc *epc, +u8 func_no, u16 cap_offset, int status, u16 vendor, u8 type, void *response_pl, +size_t response_pl_sz)`` to be invoked when the request processing completes. +The driver then calls ``pci_ep_doe_process_request(epc, func_no, cap_offset, +vendor, type, request, request_sz, complete)`` to hand off the request to the +DOE EP core. This function returns immediately after queuing the work +(without blocking), and the driver sets the BUSY bit in the DOE Status register. + +**Step 3: DOE EP Core Processing** + +The DOE EP core creates a task structure and submits it to the mailbox's ordered +workqueue. This ensures that requests for each mailbox are processed +sequentially, one at a time, as required by the DOE specification. It looks up +the protocol handler based on the Vendor ID and Type from the request header, +and executes the handler function. + +**Step 4: Protocol Handler Execution** + +The workqueue executes the task by calling the registered protocol handler: +``handler(request, request_sz, &response, &response_sz)``. The handler processes +the request, allocates a response buffer in memory (DDR), builds the response +data, and returns the response pointer and size. For the discovery protocol, +the DOE EP core handles this directly without invoking an external handler. + +**Step 5: DOE EP Core → EP Controller Driver** + +After the protocol handler completes, the DOE EP core frees the request buffer, +and invokes the completion callback provided by the controller driver asynchronously. +The callback receives the struct pci_epc, function number, capability offset (to +identify the mailbox), status code indicating the result of request processing, +vendor ID and type of the data object, the response buffer, and its size. + +**Step 6: EP Controller Driver → Root Complex** + +The controller driver converts the response from CPU-native format to +little-endian format using ``cpu_to_le32()``, writes the response to DOE read +mailbox register, and sets the READY bit in the DOE Status register. The root +complex then reads the response from the read mailbox register. Finally, the controller +driver frees the response buffer (which the handler allocated). + +Asynchronous Request Processing +------------------------------- + +The DOE-EP framework implements asynchronous request processing because an +endpoint function can have multiple instances of DOE mailboxes, and requests may +be interleaved across these mailboxes. Request processing of one mailbox should +not result in blocking request processing of other mailboxes. Hence, requests +on each mailbox need to be handled in parallel for optimization. + +For the EP controller driver to handle requests on multiple mailboxes in +parallel, ``pci_ep_doe_process_request()`` must be asynchronous. The function +returns immediately after submitting the request to the mailbox's workqueue, +without waiting for the request to complete. A completion callback provided by +the controller driver is invoked asynchronously when request processing +finishes. This asynchronous design enables concurrent processing of requests +across different mailboxes. + +Abort Handling +-------------- + +The DOE specification allows the root complex to abort ongoing DOE operations +by setting the ABORT bit in the DOE Control register. + +**Trigger** + +When the root complex sets the ABORT bit, the EP controller driver detects this +condition (typically in an interrupt handler or register polling routine). The +action taken depends on the timing of the abort: + +- **ABORT before request transfer**: If the ABORT bit is set before the root complex + transfers the request to the mailbox registers, the controller driver should not + call ``pci_ep_doe_abort()`` API. + +- **ABORT during request transfer**: If the ABORT bit is set while the root complex + is still transferring the request to the mailbox registers, the controller driver + should discard the request, and should not call ``pci_ep_doe_abort()`` and + ``pci_ep_doe_process_request()`` APIs in the respective IRQ handlers. + +- **ABORT after request submission**: If the ABORT bit is set after the request + has been fully received and submitted to the DOE EP core via + ``pci_ep_doe_process_request()``, the controller driver must call + ``pci_ep_doe_abort(epc, func_no, cap_offset)`` for the affected mailbox to + perform abort sequence in the DOE EP core. + +**Abort Sequence** + +The abort function sets the CANCEL flag on the mailbox to prevent queued requests +from starting. Instead of waiting for the workqueue to flush, it returns immediately. + +The CANCEL flag gets cleared after invoking the completion callback, allowing the +mailbox to accept new requests. + +Queued requests that have not started execution will be aborted with an error +status. The currently executing request will complete normally, and the controller +will reject the response if it arrives after the abort sequence has been triggered. + +.. note:: + Independent of when the ABORT bit is triggered, the controller driver must + clear the ERROR, BUSY, and READY bits in the DOE Status register after + completing the abort operation to reset the mailbox to an idle state. + +Error Handling +-------------- + +Errors can occur during DOE request processing for various reasons, such as +unsupported protocols, handler failures, or memory allocation failures. + +**Error Detection** + +When an error occurs during DOE request processing, the DOE EP core propagates this error +back to the controller driver either through the ``pci_ep_doe_process_request()`` return value, +or the status code passed to the completion callback. + +**Error Response** + +When the controller driver receives an error code, it sets the ERROR bit in the DOE Status +register instead of writing a response to the read mailbox register, and frees the buffers. + +API Reference +============= + +.. kernel-doc:: drivers/pci/endpoint/pci-ep-doe.c + :export: -- 2.34.1