Linux Documentation
 help / color / mirror / Atom feed
From: Matthew Wilcox <willy@infradead.org>
To: mhklinux@outlook.com
Cc: robin.murphy@arm.com, joro@8bytes.org, will@kernel.org,
	hch@lst.de, m.szyprowski@samsung.com, corbet@lwn.net,
	iommu@lists.linux.dev, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org, petr@tesarici.cz,
	roberto.sassu@huaweicloud.com
Subject: Re: [PATCH 1/1] Documentation/core-api: Add swiotlb documentation
Date: Thu, 18 Apr 2024 15:28:40 +0100	[thread overview]
Message-ID: <ZiEuGIoa-FCE0p4X@casper.infradead.org> (raw)
In-Reply-To: <20240418135213.426671-1-mhklinux@outlook.com>

On Thu, Apr 18, 2024 at 06:52:13AM -0700, mhkelley58@gmail.com wrote:
> There's currently no documentation for the swiotlb. Add documentation
> describing usage scenarios, the key APIs, and implementation details.
> Group the new documentation with other DMA-related documentation.

This is really well written.  Thank you.  One minor nit below.

> +Usage Scenarios
> +---------------
> +The swiotlb was originally created to handle DMA for devices
> +with addressing limitations. As physical memory sizes grew
> +beyond 4 Gbytes, some devices could only provide 32-bit DMA
> +addresses. By allocating bounce buffer memory below the 4 Gbyte

I'd prefer GiB to Gbytes; we might also prefer GB, Gigabyte or Gibibyte,
but Gbytes seems wrong.

You've written a lot here, and I'm not an expert on swiommu, but nothing
else leapt out at me.

  reply	other threads:[~2024-04-18 14:28 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-18 13:52 [PATCH 1/1] Documentation/core-api: Add swiotlb documentation mhkelley58
2024-04-18 14:28 ` Matthew Wilcox [this message]
2024-04-18 15:25   ` Michael Kelley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ZiEuGIoa-FCE0p4X@casper.infradead.org \
    --to=willy@infradead.org \
    --cc=corbet@lwn.net \
    --cc=hch@lst.de \
    --cc=iommu@lists.linux.dev \
    --cc=joro@8bytes.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=m.szyprowski@samsung.com \
    --cc=mhklinux@outlook.com \
    --cc=petr@tesarici.cz \
    --cc=roberto.sassu@huaweicloud.com \
    --cc=robin.murphy@arm.com \
    --cc=will@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox