From patchwork Wed Jul 8 03:45:11 2026 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Paul Elder X-Patchwork-Id: 27263 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 44061C3306 for ; Wed, 8 Jul 2026 03:45:36 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 4D94766076; Wed, 8 Jul 2026 05:45:35 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="u4Xb52tw"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id E5FA96601C for ; Wed, 8 Jul 2026 05:45:32 +0200 (CEST) Received: from neptunite.hamster-moth.ts.net (unknown [IPv6:2404:7a81:160:2100:7c23:cb25:99bc:17dc]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 461F1EAA; Wed, 8 Jul 2026 05:44:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1783482283; bh=0fxP4RS4gYgEVX2jMfJOjuCZYbGCf7dmq76CvA5REkc=; h=From:To:Cc:Subject:Date:From; b=u4Xb52twvr7ncWyWBuTxWP6krwZSx/T4to5YrrmLDOjOlnAp2mhyLcZV9TH3Pw0jl 1cjzbN4BPZnvuPuZ3s16HeVS/IUX3DtDH8rjBOGX0wT86XVREpCAMf9KiitED1cqKE Rir3/dR7eNK/Jvm+k46yNpE03JJwxUSx1toFPRBQ= From: Paul Elder To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [PATCH] Documentation: guides: ipa: Rename FileDescriptor to SharedFD Date: Wed, 8 Jul 2026 12:45:11 +0900 Message-ID: <20260708034511.149875-1-paul.elder@ideasonboard.com> X-Mailer: git-send-email 2.47.2 MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" When FileDescriptor was replaced with SharedFD, the documentation in the IPA guide was not updated. Fix this. Signed-off-by: Paul Elder --- Documentation/guides/ipa.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst index 42993924dd79..28d99acd18aa 100644 --- a/Documentation/guides/ipa.rst +++ b/Documentation/guides/ipa.rst @@ -86,7 +86,7 @@ definition, and may be used as function parameter types or struct field types: - libcamera.ControlInfoMap - libcamera.ControlList -- libcamera.FileDescriptor +- libcamera.SharedFD - libcamera.IPABuffer - libcamera.IPACameraSensorInfo - libcamera.IPASettings @@ -124,14 +124,14 @@ The following is an example of a definition of a struct: struct ConfigInput { uint32 op; uint32 transform; - libcamera.FileDescriptor lsTableHandle; + libcamera.SharedFD lsTableHandle; int32 lsTableHandleStatic = -1; map streamConfig; array buffers; }; This example has some special things about it. First of all, it uses the -FileDescriptor data type. This type must be used to ensure that the file +SharedFD data type. This type must be used to ensure that the file descriptor that it contains is translated properly across the IPC boundary (when the IPA is in an isolated process). @@ -360,7 +360,7 @@ fills all fields with the default values, and a second constructor that takes a value for every field. The default value constructor will fill in the fields with the specified default value if it exists. In the above example, `gainDelay_` will be initialized to 1. If no default value is specified, then it will be -filled in as zero (or -1 for a FileDescriptor type). +filled in as zero (or -1 for a SharedFD type). All fields and constructors/destructors in these generated structs are public.