{"id":442,"url":"https://patchwork.libcamera.org/api/patches/442/?format=json","web_url":"https://patchwork.libcamera.org/patch/442/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20190129135357.32339-3-kieran.bingham@ideasonboard.com>","date":"2019-01-29T13:53:55","name":"[libcamera-devel,2/4] libcamera: buffer: Document the BufferPool","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"81581e742d004216c0b47ed05f582dab12aaa26d","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/?format=json","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/442/mbox/","series":[{"id":154,"url":"https://patchwork.libcamera.org/api/series/154/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=154","date":"2019-01-29T13:53:53","name":"libcamera: Buffer Objects","version":1,"mbox":"https://patchwork.libcamera.org/series/154/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/442/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/442/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 60E2260DB9\n\tfor ;\n\tTue, 29 Jan 2019 14:54:02 +0100 (CET)","from localhost.localdomain\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id ECA8E2F5;\n\tTue, 29 Jan 2019 14:54:01 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1548770042;\n\tbh=tWyZl+2uCZsk1WDXmI44TZGPn6aXbCqwQIT7f9XvXOY=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=tL5bEWQybWSAX2mRAi45p6hPl7CGOEo7tvB2OGG8E27hO1l+kDf0JG/4QV1DmJetw\n\tiJc7mdIJeB+jEfgQlSIMUoaVSS8OeGksJrt0S/4M1Dh9bfyT17E+85ZCbypZFc/uO6\n\tAItP70Jr3w2QSuFWat6akAzuxXhaT0gz5ngH1yFM=","From":"Kieran Bingham ","To":"LibCamera Devel ","Date":"Tue, 29 Jan 2019 13:53:55 +0000","Message-Id":"<20190129135357.32339-3-kieran.bingham@ideasonboard.com>","X-Mailer":"git-send-email 2.19.1","In-Reply-To":"<20190129135357.32339-1-kieran.bingham@ideasonboard.com>","References":"<20190129135357.32339-1-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 2/4] libcamera: buffer: Document the\n\tBufferPool","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Tue, 29 Jan 2019 13:54:02 -0000"},"content":"Add Doxygen documentation for the existing code in the BufferPool class.\n\nSigned-off-by: Kieran Bingham \n---\n src/libcamera/buffer.cpp | 42 ++++++++++++++++++++++++++++++++++++++++\n 1 file changed, 42 insertions(+)","diff":"diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp\nindex 6dfebfc6bb28..5c580b540a67 100644\n--- a/src/libcamera/buffer.cpp\n+++ b/src/libcamera/buffer.cpp\n@@ -64,6 +64,37 @@ int Buffer::setDmabuf(int fd)\n /**\n * \\class BufferPool\n * \\brief A pool of buffers\n+ *\n+ * The BufferPool class groups together a collection of Buffers for passing\n+ * between devices. The buffers must be exported by a device before they can be\n+ * imported into another device for further use.\n+ */\n+\n+/**\n+ * \\enum BufferPool::Memory\n+ * \\brief Identify the memory type used in the BufferPool\n+ */\n+\n+/**\n+ * \\var BufferPool::Internal\n+ * \\brief The memory for the Buffers in this pool is allocated internally by the\n+ * device associated with the pool\n+ */\n+\n+/**\n+ * \\var BufferPool::External\n+ * \\brief The memory for the Buffers in this pool is allocated externally by\n+ * another device and can be imported for use by other devices.\n+ *\n+ * The buffers in the pool have been exported to make them available for sharing\n+ * with other devices, and can be managed using their own file descriptors.\n+ */\n+\n+/**\n+ * \\brief Construct a buffer pool. The \\a memory argument declares the intent of\n+ * the pool to be either internal or external to a device.\n+ *\n+ * \\sa BufferPool::Memory\n */\n BufferPool::BufferPool(BufferPool::Memory memory)\n \t: memory_(memory)\n@@ -75,6 +106,9 @@ BufferPool::~BufferPool()\n \tfree();\n }\n \n+/**\n+ * \\brief Allocate buffers in a pool\n+ */\n int BufferPool::allocate(unsigned int count)\n {\n \tfor (unsigned int i = 0; i < count; ++i) {\n@@ -91,6 +125,9 @@ int BufferPool::allocate(unsigned int count)\n \treturn 0;\n }\n \n+/**\n+ * \\brief Release all buffers from pool.\n+ */\n void BufferPool::free()\n {\n \tfor (Buffer *buffer : buffers_)\n@@ -99,4 +136,9 @@ void BufferPool::free()\n \tbuffers_.clear();\n }\n \n+/**\n+ * \\fn BufferPool::count()\n+ * \\brief Get the number of Buffers contained within this pool\n+ */\n+\n } /* namespace libcamera */\n","prefixes":["libcamera-devel","2/4"]}