Received-SPF: pass (google.com: domain of linux-kernel+bounces-174871-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Thu, 9 May 2024 22:01:47 +0200
From: Petr =?UTF-8?B?VGVzYcWZw61r?= <petr@tesarici.cz>
To: "T.J. Mercier" <tjmercier@google.com>
Cc: Thomas Gleixner <tglx@linutronix.de>, Ingo Molnar <mingo@redhat.com>,
 Borislav Petkov <bp@alien8.de>, Dave Hansen <dave.hansen@linux.intel.com>,
 x86@kernel.org, "H. Peter Anvin" <hpa@zytor.com>, Jonathan Corbet
 <corbet@lwn.net>, Tianyu Lan <Tianyu.Lan@microsoft.com>,
 mhklinux@outlook.com, robin.murphy@arm.com, linux-kernel@vger.kernel.org,
 linux-doc@vger.kernel.org
Subject: Re: [PATCH v2 2/3] doc: swiotlb: Document SWIOTLB areas parameter
Message-ID: <20240509220147.3b0a0073@meshulam.tesarici.cz>
In-Reply-To: <CABdmKX229OjjzQ9BYC96QtwKdVyqdYEkLaBi1GN4oDNMD5SDpQ@mail.gmail.com>
References: <20240507013502.3095744-1-tjmercier@google.com>
	<20240507013502.3095744-2-tjmercier@google.com>
	<20240509081403.28c424d5@meshulam.tesarici.cz>
	<CABdmKX229OjjzQ9BYC96QtwKdVyqdYEkLaBi1GN4oDNMD5SDpQ@mail.gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

On Thu, 9 May 2024 09:04:16 -0700
"T.J. Mercier" <tjmercier@google.com> wrote:

> On Wed, May 8, 2024 at 11:14=E2=80=AFPM Petr Tesa=C5=99=C3=ADk <petr@tesa=
rici.cz> wrote:
> >
> > On Tue,  7 May 2024 01:34:59 +0000
> > "T.J. Mercier" <tjmercier@google.com> wrote:
> > =20
> > > Commit 20347fca71a3 ("swiotlb: split up the global swiotlb lock") add=
ed
> > > the ability to specify the number of SWIOTLB areas, but boot-options.=
rst
> > > was not updated as part of that commit.
> > >
> > > Reported-by: Michael Kelley <mhklinux@outlook.com>
> > > Fixes: 20347fca71a3 ("swiotlb: split up the global swiotlb lock")
> > > Signed-off-by: T.J. Mercier <tjmercier@google.com>
> > > ---
> > >  Documentation/arch/x86/x86_64/boot-options.rst | 4 +++-
> > >  1 file changed, 3 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/Documentation/arch/x86/x86_64/boot-options.rst b/Documen=
tation/arch/x86/x86_64/boot-options.rst
> > > index a37139d1752f..18161657b301 100644
> > > --- a/Documentation/arch/x86/x86_64/boot-options.rst
> > > +++ b/Documentation/arch/x86/x86_64/boot-options.rst
> > > @@ -287,9 +287,11 @@ iommu options only relevant to the AMD GART hard=
ware IOMMU:
> > >  iommu options only relevant to the software bounce buffering (SWIOTL=
B) IOMMU
> > >  implementation:
> > >
> > > -    swiotlb=3D<slots>[,force,noforce]
> > > +    swiotlb=3D<slots>[,<areas>,force,noforce] =20
> >
> > This is not quite how this parameter is parsed. All the following
> > specifications are valid:
> >
> > - swiotlb=3D512        // only slots
> > - swiotlb=3D,4         // only areas
> > - swiotlb=3D512,4      // slots and areas
> > - swiotlb=3Dforce      // default size
> > - swiotlb=3D512,force  // default areas
> > - swiotlb=3D512,4,force // explicitly specify everything
> >
> > I believe the syntax should be somethig like:
> >
> >   swiotlb=3D{ | [<slots>][,<areas>],}{ force | noforce }
> >
> > Petr T
> > =20
> What does the leading | mean in front of slots?  How about brackets

I wanted to mark somehow that "force" and "noforce" alone do not
require a leading comma, but if you specify slots and/or areas, the
comma is required, like you write below.

> around force/noforce since they're also optional and mutually
> exclusive?

Right. I missed that.

> The Rebooting section uses double brackets instead of
> braces for groupings like that.

TBH I don't know what syntax is used here. Use anything that can capture
the variants I listed above.

> Only weird thing here is the
> force/noforce comma being potentially unneeded, but that's getting
> pretty picky and I think the intent is clear.
>=20
> swiotlb=3D[<slots>][,<areas>][, [force] | [noforce] ]

No objections from my side.

Petr T