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 864C5D339AE for ; Mon, 28 Oct 2024 18:12:54 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1A4276B00A5; Mon, 28 Oct 2024 14:12:54 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 154786B00A6; Mon, 28 Oct 2024 14:12:54 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 042796B00A7; Mon, 28 Oct 2024 14:12:53 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id DAD7C6B00A5 for ; Mon, 28 Oct 2024 14:12:53 -0400 (EDT) Received: from smtpin08.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay10.hostedemail.com (Postfix) with ESMTP id 851EDC0E96 for ; Mon, 28 Oct 2024 18:12:53 +0000 (UTC) X-FDA: 82723805976.08.6BAD7D8 Received: from ale.deltatee.com (ale.deltatee.com [204.191.154.188]) by imf20.hostedemail.com (Postfix) with ESMTP id 4999B1C0020 for ; Mon, 28 Oct 2024 18:12:22 +0000 (UTC) Authentication-Results: imf20.hostedemail.com; dkim=pass header.d=deltatee.com header.s=20200525 header.b=K19VSXkL; dmarc=pass (policy=quarantine) header.from=deltatee.com; spf=pass (imf20.hostedemail.com: domain of logang@deltatee.com designates 204.191.154.188 as permitted sender) smtp.mailfrom=logang@deltatee.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1730138997; 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:content-transfer-encoding: in-reply-to:in-reply-to:references:references:dkim-signature; bh=PVgGO8I+aKJHmvYCR04uOsA3HSUhN0BC0EboYMzK8as=; b=hiU2OR/vPEf0p9uv2rYC1idvxqsf9SfVmuER9k/+T1/i7ftQby95hiegQMIRHIX/hfzoz7 tvUubQ+bvED8EFvkLGaulCM18to97k+8+9djg3AAiEn5qGYBKHVSc8vn1ZFQldyvUD0QB5 srzKyxZWedx8d491la5B/zPOM0/xsz8= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1730138997; a=rsa-sha256; cv=none; b=DLGdHltOeBYuLMDhQdGjnwDXyrW0ILDEUlNI5tkyMGiujU17Wb5JYk0fFXMzpgAD6BddBG OmhpHq0FlYs05hkYbJdLoqJuTUHKx6l3xyy+A1PtGa07jexinxFVl3+s0agmkpdD4V385A fZ1Xc1yMIEtdKhpkc9utOyuSzO0NoH4= ARC-Authentication-Results: i=1; imf20.hostedemail.com; dkim=pass header.d=deltatee.com header.s=20200525 header.b=K19VSXkL; dmarc=pass (policy=quarantine) header.from=deltatee.com; spf=pass (imf20.hostedemail.com: domain of logang@deltatee.com designates 204.191.154.188 as permitted sender) smtp.mailfrom=logang@deltatee.com DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=deltatee.com; s=20200525; h=Subject:In-Reply-To:From:References:Cc:To: MIME-Version:Date:Message-ID:content-disposition; bh=PVgGO8I+aKJHmvYCR04uOsA3HSUhN0BC0EboYMzK8as=; b=K19VSXkL0jbE9wKlLQwlzKl5Qt dFI8msaT1mELaj5hwKIwDlCJ46EwcaMmEobLfzfEKq+Eq7nTnteRjLb92tlfPf+mQ1jHZs/uau/Zv btPElz6z7lxamWA9dafk7bpsCpOHuPE5ytvXdPKxSvkskCQz9G9p+Cd3hVlToTbBzJvAgoSIlT37A r+ZWM2l+KvYFm7d2b43t3ljFpzoofdPK8h6WvgnWHW7sU/zCs1CIEnQebX78Y3u5+eOJI3mrSnt5j dSSu52KwvY+eSIGe4RXd3JdoU0j37bdCROcQ7YHpM0slV0+MpM5Xaz7qZFasLUl12Cvd6Oj0uBW7u ffpSvEzg==; Received: from d104-157-31-28.abhsia.telus.net ([104.157.31.28] helo=[192.168.1.250]) by ale.deltatee.com with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (Exim 4.96) (envelope-from ) id 1t5UEF-002ZWw-0E; Mon, 28 Oct 2024 12:12:35 -0600 Message-ID: <30e87c78-1021-4fa4-8aa6-e81245e77379@deltatee.com> Date: Mon, 28 Oct 2024 12:12:34 -0600 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird To: Leon Romanovsky , Jens Axboe , Jason Gunthorpe , Robin Murphy , Joerg Roedel , Will Deacon , Christoph Hellwig , Sagi Grimberg Cc: Keith Busch , Bjorn Helgaas , Yishai Hadas , Shameer Kolothum , Kevin Tian , Alex Williamson , Marek Szyprowski , =?UTF-8?B?SsOpcsO0bWUgR2xpc3Nl?= , Andrew Morton , Jonathan Corbet , linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-block@vger.kernel.org, linux-rdma@vger.kernel.org, iommu@lists.linux.dev, linux-nvme@lists.infradead.org, linux-pci@vger.kernel.org, kvm@vger.kernel.org, linux-mm@kvack.org References: Content-Language: en-CA From: Logan Gunthorpe In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-SA-Exim-Connect-IP: 104.157.31.28 X-SA-Exim-Rcpt-To: leon@kernel.org, axboe@kernel.dk, jgg@ziepe.ca, robin.murphy@arm.com, joro@8bytes.org, will@kernel.org, hch@lst.de, sagi@grimberg.me, kbusch@kernel.org, bhelgaas@google.com, yishaih@nvidia.com, shameerali.kolothum.thodi@huawei.com, kevin.tian@intel.com, alex.williamson@redhat.com, m.szyprowski@samsung.com, jglisse@redhat.com, akpm@linux-foundation.org, corbet@lwn.net, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-block@vger.kernel.org, linux-rdma@vger.kernel.org, iommu@lists.linux.dev, linux-nvme@lists.infradead.org, linux-pci@vger.kernel.org, kvm@vger.kernel.org, linux-mm@kvack.org X-SA-Exim-Mail-From: logang@deltatee.com Subject: Re: [PATCH 09/18] docs: core-api: document the IOVA-based API X-SA-Exim-Version: 4.2.1 (built Wed, 06 Jul 2022 17:57:39 +0000) X-SA-Exim-Scanned: Yes (on ale.deltatee.com) X-Rspamd-Server: rspam07 X-Rspamd-Queue-Id: 4999B1C0020 X-Stat-Signature: ux9fgqda7ke4w4zzqmbo9dzfstu74bz8 X-Rspam-User: X-HE-Tag: 1730139142-986681 X-HE-Meta: U2FsdGVkX1+0yMoChFbtgTbJsBqWOWI9NAJeK7imprqFVTSGBP8ZAhHztkQT7HdyLN2pDAVgjrHHhqTEmYHixJ2AfHdhwxMLDOuhm3HD8MNxm+gAbna0D6k7cIq14rMGsX5xrwGaTrz7z79vEVW3AwQ5cH0aEXmi9z3hCbE6op0UyXm8YLDl37FcrTslsImv0j6tI9X8/a9q6gKdlFbf7UReCF5/0fIOiqF14jsQJU+scnO2pTxOhWOAxKRRpqm33LHw/pDJB4TCIP6g2o5VJ9Y4rZjLrJBEe7G4oMLmlRIw2PPPBhHN4MsPF7w32/WXCoJ+nDZHogofijvjawGtxCAVnyx7ICzqfRhsEx9P0QwAUarIdUzAJxG3CBdAg+8L7wgjQtQS54d1mkIQ840SJ5O2BqbV7bk73FPUV5WCUexUOl9OHqBMXCIxRF3LLPyZ/O2IuZkH28k3TIFZ11p84gSKkP4gDm+3v050mmaMAN6qcDL9hO+WcUX4AV5AOFuAy4wmN2D1oddM+ypNEZFlueQF6v95lZGRh4ruU6OwX8GZKYYN1snKUM0me/0lAxxgJk6smkz7HlsXRG9amcsrnH1Zg3Hg8mXhEwZG330WoPh7l38A1YavjR5AUpNlQYGL60bFngckCi8WIfL+QH2XPGjDZ1xB6flUjc5KRIhj2aOP6XHL2lyjS2zfrstzZYZZ6s7BICf6TbwaBzYPdTr7ZKyVK9PYzwPP2iSqfuJX1QXQWPkuQZJqqHtjlTktrrMJ6OL6l6EWJR6LrDRqkpytF2tBL2sZUTvzytOJNSMZiXUYXejA0Hgbqe3bEY3Nw3nq/0zMDy8dRaIKksssC0WAiuIAzyUb/tKnhc4QSzbKsABAtSQBsZopQ8R+R9ApQ1ZfZlXskOJlUfSp6UWGcyF6JHLThAIZhvjPRYKdrkAD9ycb5OSRlNO03EvUfu1o1ifJSnLivbSoSy5U3xE4hdu 0/hOFmFI xmdHLcX/ZCWXX6PHqdIpuiyJOLkaNYGr1YTfLx2XjNgHuvRyB9aqvVudnSbjT89DLHSaqS1T532nNvlIYTagtO7u6OZim0mSmzbugDv7MpzA85usFBHQrtyuEWgNJTrEuplPDQYSUcN7+wlwbU/AFfX0jP/bEy9LM56pfjOWGoH+B+cvIF+1MDCJ97ERUcRGKe+62bzC5EsU1ad7NmQ8Tg/av1GmcQum+7L8XbLbeGtDk5WX8+Rg3D7tOpqoOMxyvprBHiNlZnPCpQRkYMxA1RsTxBOQfey+mExnHI5nSBpS2Xrk= 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: I noticed a couple of typos below: On 2024-10-27 08:21, Leon Romanovsky wrote: > +Part Ie - IOVA-based DMA mappings > +--------------------------------- > + > +These APIs allow a very efficient mapping when using an IOMMU. They are an > +optional path that requires extra code and are only recommended for drivers > +where DMA mapping performance, or the space usage for storing the dma addresses The second 'dma' should be capitalized as it is in other uses. > + int dma_iova_sync(struct device *dev, struct dma_iova_state *state, > + size_t offset, size_t size, int ret); > + > +Must called to sync the IOMMU page tables for IOVA-range mapped by one or > +more calls to ``dma_iova_link()``. "Must be called" instead of "Must called" Thanks, Logan