{"id":624,"url":"https://patchwork.libcamera.org/api/1.1/patches/624/?format=json","web_url":"https://patchwork.libcamera.org/patch/624/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20190226021857.28255-4-niklas.soderlund@ragnatech.se>","date":"2019-02-26T02:18:52","name":"[libcamera-devel,3/8] libcamera: camera: document return values for application facing functions","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"58d9bd1f51e1f2b761e498aa65980034cd8845f9","submitter":{"id":5,"url":"https://patchwork.libcamera.org/api/1.1/people/5/?format=json","name":"Niklas Söderlund","email":"niklas.soderlund@ragnatech.se"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/624/mbox/","series":[{"id":192,"url":"https://patchwork.libcamera.org/api/1.1/series/192/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=192","date":"2019-02-26T02:18:50","name":"libcamera: improve validation of camera operations","version":1,"mbox":"https://patchwork.libcamera.org/series/192/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/624/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/624/checks/","tags":{},"headers":{"Return-Path":"","Received":["from vsp-unauthed02.binero.net (vsp-unauthed02.binero.net\n\t[195.74.38.227])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id C7994610BB\n\tfor ;\n\tTue, 26 Feb 2019 03:19:18 +0100 (CET)","from bismarck.berto.se (unknown [89.233.230.99])\n\tby bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA\n\tid eab9f82b-396c-11e9-985a-005056917f90;\n\tTue, 26 Feb 2019 03:19:17 +0100 (CET)"],"X-Halon-ID":"eab9f82b-396c-11e9-985a-005056917f90","Authorized-sender":"niklas@soderlund.pp.se","From":"=?utf-8?q?Niklas_S=C3=B6derlund?= ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 26 Feb 2019 03:18:52 +0100","Message-Id":"<20190226021857.28255-4-niklas.soderlund@ragnatech.se>","X-Mailer":"git-send-email 2.20.1","In-Reply-To":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>","References":"<20190226021857.28255-1-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH 3/8] libcamera: camera: document return\n\tvalues for application facing functions","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, 26 Feb 2019 02:19:19 -0000"},"content":"In preparation for adding a state machine to control access to the\nfunctions facing the application document the error codes which will be\nreturned once it's in place.\n\nSigned-off-by: Niklas Söderlund \n---\n src/libcamera/camera.cpp | 12 +++++++++---\n 1 file changed, 9 insertions(+), 3 deletions(-)","diff":"diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp\nindex e2372fea31e2921a..d4258fe3c7551af3 100644\n--- a/src/libcamera/camera.cpp\n+++ b/src/libcamera/camera.cpp\n@@ -158,6 +158,7 @@ void Camera::disconnect()\n * \\todo Implement exclusive access across processes.\n *\n * \\return 0 on success or a negative error code\n+ * \\retval -EBUSY The camera is not free and can't be acquired by the caller.\n */\n int Camera::acquire()\n {\n@@ -236,9 +237,8 @@ Camera::streamConfiguration(std::vector &streams)\n * to calling this function, otherwise an -EACCES error will be returned.\n *\n * \\return 0 on success or a negative error code\n- * \\retval -ENODEV The camera is not connected to any hardware\n- * \\retval -EACCES The user has not acquired exclusive access to the camera\n- * \\retval -EINVAL The configuration is not valid\n+ * \\retval -EACCES The camera is not in a state where it can be configured.\n+ * \\retval -EINVAL The configuration is not valid.\n */\n int Camera::configureStreams(std::map &config)\n {\n@@ -279,6 +279,8 @@ int Camera::configureStreams(std::map &config)\n /**\n * \\brief Allocate buffers for all configured streams\n * \\return 0 on success or a negative error code\n+ * \\retval -EACCES The camera is not in a state where it can allocate buffers.\n+ * \\retval -EINVAL The configuration is not valid.\n */\n int Camera::allocateBuffers()\n {\n@@ -330,6 +332,7 @@ void Camera::freeBuffers()\n * responsible for either queueing the request or deleting it.\n *\n * \\return A pointer to the newly created request, or nullptr on error\n+ * \\retval -EACCES The camera is not in a state where requests can be created.\n */\n Request *Camera::createRequest()\n {\n@@ -351,6 +354,7 @@ Request *Camera::createRequest()\n * automatically after it completes.\n *\n * \\return 0 on success or a negative error code\n+ * \\retval -EACCES The camera is not running so requests can't be queued.\n */\n int Camera::queueRequest(Request *request)\n {\n@@ -377,6 +381,7 @@ int Camera::queueRequest(Request *request)\n * until the capture session is terminated with \\a stop().\n *\n * \\return 0 on success or a negative error code\n+ * \\retval -EACCES The camera is not in a state where it can be started.\n */\n int Camera::start()\n {\n@@ -396,6 +401,7 @@ int Camera::start()\n * requests are cancelled and complete synchronously in an error state.\n *\n * \\return 0 on success or a negative error code\n+ * \\retval -EACCES The camera is not running so can't be stopped.\n */\n int Camera::stop()\n {\n","prefixes":["libcamera-devel","3/8"]}