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:
Niklas Söderlund 2020-01-10 00:20:46 +01:00
parent a1c5450be5
commit 4b9bd6c3ad

View file

@ -258,6 +258,11 @@
* \param[in] buffers The buffers to map
* \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()
*/