libcamera: ipa_interface: Document the ownership of dmabufs passed to map_buffers()
The ownership of the dmabuf file handles passed to map_buffers() is not clear. Explicitly document that they are borrowed from the caller and only guaranteed to be valid for the duration of the map_buffers() call. Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
This commit is contained in:
parent
a1c5450be5
commit
4b9bd6c3ad
1 changed files with 5 additions and 0 deletions
|
@ -258,6 +258,11 @@
|
||||||
* \param[in] buffers The buffers to map
|
* \param[in] buffers The buffers to map
|
||||||
* \param[in] num_buffers The number of entries in the \a buffers array
|
* \param[in] num_buffers The number of entries in the \a buffers array
|
||||||
*
|
*
|
||||||
|
* The dmabuf file descriptors provided in \a buffers are borrowed from the
|
||||||
|
* caller and are only guaranteed to be valid during the map_buffers() call.
|
||||||
|
* Should the callee need to store a copy of the file descriptors, it shall
|
||||||
|
* duplicate them first with ::dup().
|
||||||
|
*
|
||||||
* \sa libcamera::IPAInterface::mapBuffers()
|
* \sa libcamera::IPAInterface::mapBuffers()
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue