libcamera v0.4.0
Supporting cameras in Linux since 2019
 
Loading...
Searching...
No Matches
dma_buf_allocator.h
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2020, Raspberry Pi Ltd
4 *
5 * Helper class for dma-buf allocations.
6 */
7
8#pragma once
9
10#include <memory>
11#include <stdint.h>
12#include <string>
13#include <vector>
14
18
19namespace libcamera {
20
21class FrameBuffer;
22
24{
25public:
27 CmaHeap = 1 << 0,
28 SystemHeap = 1 << 1,
29 UDmaBuf = 1 << 2,
30 };
31
33
36 bool isValid() const { return providerHandle_.isValid(); }
37 UniqueFD alloc(const char *name, std::size_t size);
38
39 int exportBuffers(unsigned int count,
40 const std::vector<unsigned int> &planeSizes,
41 std::vector<std::unique_ptr<FrameBuffer>> *buffers);
42
43private:
44 std::unique_ptr<FrameBuffer> createBuffer(
45 std::string name, const std::vector<unsigned int> &planeSizes);
46
47 UniqueFD allocFromHeap(const char *name, std::size_t size);
48 UniqueFD allocFromUDmaBuf(const char *name, std::size_t size);
49 UniqueFD providerHandle_;
51};
52
53class DmaSyncer final
54{
55public:
56 enum class SyncType {
57 Read = 0,
60 };
61
63
64 ~DmaSyncer();
65
66private:
67 void sync(uint64_t step);
68
69 SharedFD fd_;
70 uint64_t flags_ = 0;
71};
72
74
75} /* namespace libcamera */
bool isValid() const
Check if the DmaBufAllocator instance is valid.
Definition dma_buf_allocator.h:36
int exportBuffers(unsigned int count, const std::vector< unsigned int > &planeSizes, std::vector< std::unique_ptr< FrameBuffer > > *buffers)
Allocate and export buffers from the DmaBufAllocator.
Definition dma_buf_allocator.cpp:223
DmaBufAllocator(DmaBufAllocatorFlags flags=DmaBufAllocatorFlag::CmaHeap)
Construct a DmaBufAllocator of a given type.
Definition dma_buf_allocator.cpp:97
DmaBufAllocatorFlag
Type of the dma-buf provider.
Definition dma_buf_allocator.h:26
@ CmaHeap
Allocate from a CMA dma-heap, providing physically-contiguous memory.
Definition dma_buf_allocator.h:27
@ SystemHeap
Allocate from the system dma-heap, using the page allocator.
Definition dma_buf_allocator.h:28
@ UDmaBuf
Allocate using a memfd + /dev/udmabuf.
Definition dma_buf_allocator.h:29
Flags< DmaBufAllocatorFlag > DmaBufAllocatorFlags
A bitwise combination of DmaBufAllocator::DmaBufAllocatorFlag values.
Definition dma_buf_allocator.h:32
~DmaBufAllocator()
Destroy the DmaBufAllocator instance.
UniqueFD alloc(const char *name, std::size_t size)
Allocate a dma-buf from the DmaBufAllocator.
Definition dma_buf_allocator.cpp:200
Helper class for dma-buf's synchronization.
Definition dma_buf_allocator.h:54
SyncType
Read and/or write access via the CPU map.
Definition dma_buf_allocator.h:56
@ Write
Indicates that the mapped dm-buf will be written by the client via the CPU map.
Definition dma_buf_allocator.h:58
@ ReadWrite
Indicates that the mapped dma-buf will be read and written by the client via the CPU map.
Definition dma_buf_allocator.h:59
@ Read
Indicates that the mapped dma-buf will be read by the client via the CPU map.
Definition dma_buf_allocator.h:57
DmaSyncer(SharedFD fd, SyncType type=SyncType::ReadWrite)
Construct a DmaSyncer with a dma-buf's fd and the access type.
Definition dma_buf_allocator.cpp:296
Type-safe container for enum-based bitfields.
Definition flags.h:16
Frame buffer data and its associated dynamic metadata.
Definition framebuffer.h:49
RAII-style wrapper for file descriptors.
Definition shared_fd.h:17
unique_ptr-like wrapper for a file descriptor
Definition unique_fd.h:18
Enum-based bit fields.
#define LIBCAMERA_FLAGS_ENABLE_OPERATORS(_enum)
Enable bitwise operations on the enum enumeration.
Definition flags.h:189
Top-level libcamera namespace.
Definition backtrace.h:17
File descriptor wrapper.
File descriptor wrapper that owns a file descriptor.