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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id A7D02C77B7C for ; Thu, 26 Jun 2025 01:50:18 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 48EE26B00D8; Wed, 25 Jun 2025 21:50:18 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 43F4F6B00D9; Wed, 25 Jun 2025 21:50:18 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 32DB26B00DA; Wed, 25 Jun 2025 21:50:18 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0010.hostedemail.com [216.40.44.10]) by kanga.kvack.org (Postfix) with ESMTP id 1BF426B00D8 for ; Wed, 25 Jun 2025 21:50:18 -0400 (EDT) Received: from smtpin19.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id CC99F1D6037 for ; Thu, 26 Jun 2025 01:50:17 +0000 (UTC) X-FDA: 83595871674.19.B7174BB Received: from mail-pf1-f171.google.com (mail-pf1-f171.google.com [209.85.210.171]) by imf17.hostedemail.com (Postfix) with ESMTP id CF31B40007 for ; Thu, 26 Jun 2025 01:50:15 +0000 (UTC) Authentication-Results: imf17.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=Jbg7E4z3; spf=pass (imf17.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.171 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1750902615; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=menFF1U22OaGLYsBSwHqWWPm6awV466wbz9FvtD4mjw=; b=ednytQofY+c7Zpnyv+dlCWzbdv4BPh6s0GjXKt0KTe6MQAheLukZUcRE0BYWGI6U/VhfHC kgJHTZ/dCGLkPAFQEHcurlYw2D8ZivUtHqmfRhd5e/EYodP5Aa1KPRPC/NgHSiM7Col37d LExc62pYsd1uje8Bu+8Z5supEhykpUw= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1750902615; a=rsa-sha256; cv=none; b=rVXY0Nd2RoEFm4RaVdBmQe70cChOGnF/aw6fFuihIoexFXzuBoiqHSzhtUImucHE/M0RTW HqQ0bPA6KdmkQQ5RT2v6G7Zk7NB3g8UStTWE05s64Yn8/tQqwSa912m7+2YodVtG4zg7J8 C7FdVBu4nyPxv8CQ0xDNP0O1inUceL8= ARC-Authentication-Results: i=1; imf17.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=Jbg7E4z3; spf=pass (imf17.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.210.171 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com; dmarc=pass (policy=none) header.from=gmail.com Received: by mail-pf1-f171.google.com with SMTP id d2e1a72fcca58-7390d21bb1cso515691b3a.2 for ; Wed, 25 Jun 2025 18:50:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1750902615; x=1751507415; darn=kvack.org; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=menFF1U22OaGLYsBSwHqWWPm6awV466wbz9FvtD4mjw=; b=Jbg7E4z3eDRGbYh+U+FO/lIZwJ4GzDDd0EY0tkT2LdP6wB+BXCg/70zylY/T4sbeRP 3eX92jRoHfmF5LtmeX0JvGy2foFLLLb9LHmmQgsk1M53oE7JXqPK3XEWtRtXSbdDNi/y pctX/uWwfibKHg/dVzzMVEtqjHcydk9TSL3vPm8TXizFeO0BTWplh3m5kFBlFaBKRyC6 ryhejvEIfC9kRfGzqImc+kEmgYRT8Y1Pu+ZeZcDcIjSSuF7Bph0dtbpicAWmG4dFfSFG Jcyz4ED/jeuwwSV95bGTJMRlH0e1Uf5+iQfSuOgadpcr3mRSfEnSoULqIhezQ7N8EG7/ kBQA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1750902615; x=1751507415; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=menFF1U22OaGLYsBSwHqWWPm6awV466wbz9FvtD4mjw=; b=KMpDRftw7vvngtSDrHdjhkUbNv8Rf9aBxkYxrAWIFAdo7WMRZ319CJhVCuDvMok8ae Vw4Sheh8H3XYKn+uEf5lXBn3+mkFx/5mkYYyaqnwE2B7HIgNphyCs9awh9Z6MVMEOTLn Wa2VAdkhEWO9oidTY4a4zbd2r/8M4xJTIQtsG5SfexbCjjybO2erLWe0DaLuaoFxLlIq lZRGtDOGW4RBDzNVaWg9ymU1VCd1mqIjOnXszzPvofN/uJhouWj+RLLuPpRCK3SeOsnf mUIu5u9FCvra22Goft99YuGvBvQKyC/21VpkGVzAl/3HNMIkv3KGTjUHac5kbjBP6+9+ Stig== X-Forwarded-Encrypted: i=1; AJvYcCUqvkV0+d7t0pvWx0Rycl5JHXxtHbY+Vq9VZDmbJvaqX7xMu6um7ZXraEkQ6/2LQgN6g041Jthkxg==@kvack.org X-Gm-Message-State: AOJu0YzUFoBf25AU/YKspUqTkxUuM1moStmGl5xsJPH94lO7tBpkrBZi m3tEuflEO3UYlSU2FENNN4Jp19gPm4cDRxmroirsLeKuuC6wCiAiub1mx166+w== X-Gm-Gg: ASbGncuUpmB/F7FYwOieXODXV1JaEWrg7kb4AWlGlIgpIfRPued1WPsjnoSPr5Hiza3 5PqL62g2qoDvyowSJvi7vBAMHduahMv305CdvC0D448njO47dl1WkVXt2FYmOl1Hunnsza2PAAn WhJZ+lMWelMx9AF+8F2aLV/f7oJNsxCeZWw5LHiHTvRxgYLGFHIWYBUlz1UCeZtDIyj+cnMLieN M3lEWQJt0fAkOhYqxcJO2pyRNTeApF5eZuDqJcK6s52eRzRU0Jj0hT+sVD6/ht6Dny2SWBm07wK eSSDRSp6i1LYet63EGcFZse2f6X9da1sYK789VffjNsfZ/6zBBctC57dS/C6DTNzsoA2bvhU X-Google-Smtp-Source: AGHT+IEeN+uIadKUTDZZKdBuJ8RBOTI4uF/P18CZw/f2cxNloJ7IHom8c66u6sCMY9pzvzuIs+bwCQ== X-Received: by 2002:a05:6a00:3a1f:b0:748:3849:e790 with SMTP id d2e1a72fcca58-74ae2dc4064mr2702982b3a.0.1750902614558; Wed, 25 Jun 2025 18:50:14 -0700 (PDT) Received: from archie.me ([103.124.138.155]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-749c88722e7sm5559739b3a.166.2025.06.25.18.50.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 25 Jun 2025 18:50:13 -0700 (PDT) Received: by archie.me (Postfix, from userid 1000) id 2A535420A9A6; Thu, 26 Jun 2025 08:50:09 +0700 (WIB) Date: Thu, 26 Jun 2025 08:50:09 +0700 From: Bagas Sanjaya To: Petr Tesarik , Jonathan Corbet , Morton Cc: Marek Szyprowski , Leon Romanovsky , Keith Busch , Caleb Sander Mateos , Sagi Grimberg , Jens Axboe , John Garry , "open list:DOCUMENTATION" , open list , "open list:MEMORY MANAGEMENT" Subject: Re: [PATCH 8/8] docs: dma-api: clean up documentation of dma_map_sg() Message-ID: References: <20250624133923.1140421-1-ptesarik@suse.com> <20250624133923.1140421-9-ptesarik@suse.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="VYv0BG3dP8FK4nmn" Content-Disposition: inline In-Reply-To: <20250624133923.1140421-9-ptesarik@suse.com> X-Rspamd-Queue-Id: CF31B40007 X-Stat-Signature: 7e3drbqpo53qrstrmesj8xh3q6b45s8u X-Rspam-User: X-Rspamd-Server: rspam01 X-HE-Tag: 1750902615-343278 X-HE-Meta: U2FsdGVkX18wPEvNHJ5YIAozv4WcLGWKEm8j9jt+yGwq4V2oj8+S0A1iBlAKt7cKcdG0jNCDAgN8JwdS6/KEvU1T1Yzvqo4uqQfvw0BSXAk3n96gefcrGwWNofxdAXinPEACZ9Z+QbSuhSHre6YG+SUWUgQZUkzX0fPSjMTMUN8bl2ioZoLkmoSF70+D43mCX6pX/yrZoVbpEV7RB77x4SPr2f1YHo/wS3ZeejPHsVVm+/kvMCNZVSfUT9hDt7EXwA70RMGUa3s6XOGH8EjGIzPaQL5LLXl11wgMAUjq9gTzp2o9H7ThJHXUvwGR3PZz61OFJLqSCsVt8LxO4U4ZkFJUCXJfNmS0+NZ0hvgw60NcmaOsF/Mz3H+RBGD3v1+f/9HY0AdhXOojFbS3LGH+UZcOsEReW5Xsfpa5ungy/MhmVBnaYlidfY2o6ar4Z2JfbRLeBWlaxiXLFQjlVxH+NfMqnghSkpeJNtnyNNeuuUqUdKU7uLgcWyNjRm5Uj11zfzB7gCHbN1I9wcTTt03fgSxQDmKyjXkKb9iu4QK/xiN9srItxBPgdGaB/dXnOG4hIIioaCIwhPHJ0V3WZR5T5eOl/PJhhvJXbZsrZqOPN/CSJqx3YT+tSazxUQN9rSiJhZw4xsWuFmGlna+G18p9IH8++NQv6727u8i4sKQk2UfIuRsFbxL4+ImjHQbDtPKuUp9KTPtWT3yIIfUEXSfZPrGUWDK+NOE4xdPbjTQok8kF9w+7WTQurk8n2d2wm3kD1T8FNLwB68h7X/27KmFLAjgzn+Nn3AE1100sOmc02KtGZ3tDZYmstnm285CehHv+sQdyJs4yRXXqioOmgmS/NY4mq3FkztqoMaWhl7NaiQAAWnxvqHN/vjR8mhWUfIAc8D06BUIWV75buKNz/sKiATw27+zKPAhj8cIZf8q7GQP0tE4HZDohXouUW+V3bWKzU6GCqfu8ALMFWcR9Pjg FtGpuODt AQW6BCt3Z+8xwN5cZJt4ICnDGKYKNEw91C0cdwLzSYw81JXZeNq4EECf7RsUAkG7212GuG7MQTqmahE+tvejXBG9MW4vuUkBcdF2uGe7L9ytDAjm8InlTrmZs1pOyUtOgP4lxBQQ6yH1rKWriefDuEkUu12wKwe/vX2NbsoS5i+dJVDeg6oQ+ptrWGtIBIRfzoLvGAZMynz3a/2rfiVQImcQZDnqmn1bX+G/s/zZYbQ8mXGC3BBwiKA5kzAtGHpRi/ne6Pm6OSLMrFH1s4fDHskz9jorWmdIk/19kTqXOdOebrzZqr1ekWCjQjvR0CPoWPzZH3KITCZZ++sD8BlNI/b77L1POgIDWa2SKVYq9XaChrRkuFj2XlXOqA7vF6ZOI11S8nsPwJ5Z+F3PtgCDSH/2sXzEDDjXgDwCNJFyTbvralB9vOIptzIaNHN2XQYk11Fx2XqhmoPrasSx56cQ8+aXC3h56jllAPBsdrGaB7nZXJBTHCOVQTu+n40hZ+1DNhhfsbycHDY1WWfmBja5aUToFeEN9iJNa/5Yeynzuf3kYILrAdP1X4kuZ1A== X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: --VYv0BG3dP8FK4nmn Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Tue, Jun 24, 2025 at 03:39:23PM +0200, Petr Tesarik wrote: > diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/= dma-api.rst > index 65132ec88104..f5aadb7f8626 100644 > --- a/Documentation/core-api/dma-api.rst > +++ b/Documentation/core-api/dma-api.rst > @@ -308,10 +308,10 @@ action (e.g. reduce current DMA mapping usage or de= lay and try again later). > dma_map_sg(struct device *dev, struct scatterlist *sg, > int nents, enum dma_data_direction direction) > =20 > -Returns: the number of DMA address segments mapped (this may be shorter > -than passed in if some elements of the scatter/gather list are > -physically or virtually adjacent and an IOMMU maps them with a single > -entry). > +Maps a scatter/gather list for DMA. Returns the number of DMA address se= gments > +mapped, which may be smaller than passed in if several consecuti= ve > +sglist entries are merged (e.g. with an IOMMU, or if some adjacent segme= nts > +just happen to be physically contiguous). > =20 > Please note that the sg cannot be mapped again if it has been mapped onc= e. > The mapping process is allowed to destroy information in the sg. > @@ -335,9 +335,8 @@ With scatterlists, you use the resulting mapping like= this:: > where nents is the number of entries in the sglist. > =20 > The implementation is free to merge several consecutive sglist entries > -into one (e.g. with an IOMMU, or if several pages just happen to be > -physically contiguous) and returns the actual number of sg entries it > -mapped them to. On failure 0, is returned. > +into one. The returned number is the actual number of sg entries it > +mapped them to. On failure, 0 is returned. > =20 > Then you should loop count times (note: this can be less than nents time= s) > and use sg_dma_address() and sg_dma_len() macros where you previously Looks good, thanks! Reviewed-by: Bagas Sanjaya --=20 An old man doll... just what I always wanted! - Clara --VYv0BG3dP8FK4nmn Content-Type: application/pgp-signature; name=signature.asc -----BEGIN PGP SIGNATURE----- iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCaFynUAAKCRD2uYlJVVFO ozs9AP9v8cUUS98Sbhde8tPcqpCwp86Kt5pFDUY5hgpDgUsAuwD9H6AqxbL7efqQ Ww2laLAW0niZvOyAeuqIxZai8PAdAw8= =aUqm -----END PGP SIGNATURE----- --VYv0BG3dP8FK4nmn--