On Mon, Mar 3, 2025 at 8:02 AM Maxime Ripard <mripard@xxxxxxxxxx> wrote: > > Following a recent discussion at last Plumbers, John Stultz, Sumit > Sewal, TJ Mercier and I came to an agreement that we should document > what the dma-buf heaps names are expected to be, and what the buffers > attributes you'll get should be documented. > > Let's create that doc to make sure those attributes and names are > guaranteed going forward. > > Signed-off-by: Maxime Ripard <mripard@xxxxxxxxxx> > > > --- > > Changes from v2: > - Remove exhaustive list of names for platforms, and just mention the > alternatives. > - Add MAINTAINERS entry > > Changes from v1: > - Add the mention that the cma / reserved heap is optional. > --- > Documentation/userspace-api/dma-buf-heaps.rst | 25 +++++++++++++++++++ > Documentation/userspace-api/index.rst | 1 + > MAINTAINERS | 1 + > 3 files changed, 27 insertions(+) > create mode 100644 Documentation/userspace-api/dma-buf-heaps.rst > > diff --git a/Documentation/userspace-api/dma-buf-heaps.rst b/Documentation/userspace-api/dma-buf-heaps.rst > new file mode 100644 > index 000000000000..5b92d69646f6 > --- /dev/null > +++ b/Documentation/userspace-api/dma-buf-heaps.rst > @@ -0,0 +1,25 @@ > +.. SPDX-License-Identifier: GPL-2.0 > + > +============================== > +Allocating dma-buf using heaps > +============================== > + > +Dma-buf Heaps are a way for userspace to allocate dma-buf objects. They are > +typically used to allocate buffers from a specific allocation pool, or to share > +buffers across frameworks. > + > +Heaps > +===== > + > +A heap represent a specific allocator. The Linux kernel currently supports the "represents" > +following heaps: > + > + - The ``system`` heap allocates virtually contiguous, cacheable, buffers Period at the end? This description is my understanding of the current state of things, so: Reviewed-by: T.J. Mercier <tjmercier@xxxxxxxxxx>
