From mboxrd@z Thu Jan 1 00:00:00 1970 Return-path: Received: from lb2-smtp-cloud9.xs4all.net ([194.109.24.26]:54370 "EHLO lb2-smtp-cloud9.xs4all.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728341AbeJEUgh (ORCPT ); Fri, 5 Oct 2018 16:36:37 -0400 From: Hans Verkuil To: linux-media@vger.kernel.org Cc: dri-devel@lists.freedesktop.org, Hans Verkuil Subject: [PATCHv2 1/6] cec-core.rst: improve cec_transmit_done documentation Date: Fri, 5 Oct 2018 15:37:40 +0200 Message-Id: <20181005133745.8593-2-hverkuil@xs4all.nl> In-Reply-To: <20181005133745.8593-1-hverkuil@xs4all.nl> References: <20181005133745.8593-1-hverkuil@xs4all.nl> Sender: linux-media-owner@vger.kernel.org List-ID: From: Hans Verkuil Clarify that calling cec_transmit_done can start a new transmit and that you should put the hardware in a state that allows for a new transmit before calling this function. Signed-off-by: Hans Verkuil --- Documentation/media/kapi/cec-core.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/media/kapi/cec-core.rst b/Documentation/media/kapi/cec-core.rst index 1d989c544370..bca1d9d1d223 100644 --- a/Documentation/media/kapi/cec-core.rst +++ b/Documentation/media/kapi/cec-core.rst @@ -268,6 +268,10 @@ to 1, if the hardware does support retry then either set these counters to 0 if the hardware provides no feedback of which errors occurred and how many times, or fill in the correct values as reported by the hardware. +Be aware that calling these functions can immediately start a new transmit +if there is one pending in the queue. So make sure that the hardware is in +a state where new transmits can be started *before* calling these functions. + The cec_transmit_attempt_done() function is a helper for cases where the hardware never retries, so the transmit is always for just a single attempt. It will call cec_transmit_done() in turn, filling in 1 for the -- 2.18.0 From mboxrd@z Thu Jan 1 00:00:00 1970 From: Hans Verkuil Subject: [PATCHv2 1/6] cec-core.rst: improve cec_transmit_done documentation Date: Fri, 5 Oct 2018 15:37:40 +0200 Message-ID: <20181005133745.8593-2-hverkuil@xs4all.nl> References: <20181005133745.8593-1-hverkuil@xs4all.nl> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: Received: from lb1-smtp-cloud9.xs4all.net (lb1-smtp-cloud9.xs4all.net [194.109.24.22]) by gabe.freedesktop.org (Postfix) with ESMTPS id C40936E013 for ; Fri, 5 Oct 2018 13:37:51 +0000 (UTC) In-Reply-To: <20181005133745.8593-1-hverkuil@xs4all.nl> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" To: linux-media@vger.kernel.org Cc: Hans Verkuil , dri-devel@lists.freedesktop.org List-Id: dri-devel@lists.freedesktop.org RnJvbTogSGFucyBWZXJrdWlsIDxoYW5zLnZlcmt1aWxAY2lzY28uY29tPgoKQ2xhcmlmeSB0aGF0 IGNhbGxpbmcgY2VjX3RyYW5zbWl0X2RvbmUgY2FuIHN0YXJ0IGEgbmV3IHRyYW5zbWl0IGFuZAp0 aGF0IHlvdSBzaG91bGQgcHV0IHRoZSBoYXJkd2FyZSBpbiBhIHN0YXRlIHRoYXQgYWxsb3dzIGZv ciBhIG5ldwp0cmFuc21pdCBiZWZvcmUgY2FsbGluZyB0aGlzIGZ1bmN0aW9uLgoKU2lnbmVkLW9m Zi1ieTogSGFucyBWZXJrdWlsIDxoYW5zLnZlcmt1aWxAY2lzY28uY29tPgotLS0KIERvY3VtZW50 YXRpb24vbWVkaWEva2FwaS9jZWMtY29yZS5yc3QgfCA0ICsrKysKIDEgZmlsZSBjaGFuZ2VkLCA0 IGluc2VydGlvbnMoKykKCmRpZmYgLS1naXQgYS9Eb2N1bWVudGF0aW9uL21lZGlhL2thcGkvY2Vj LWNvcmUucnN0IGIvRG9jdW1lbnRhdGlvbi9tZWRpYS9rYXBpL2NlYy1jb3JlLnJzdAppbmRleCAx ZDk4OWM1NDQzNzAuLmJjYTFkOWQxZDIyMyAxMDA2NDQKLS0tIGEvRG9jdW1lbnRhdGlvbi9tZWRp YS9rYXBpL2NlYy1jb3JlLnJzdAorKysgYi9Eb2N1bWVudGF0aW9uL21lZGlhL2thcGkvY2VjLWNv cmUucnN0CkBAIC0yNjgsNiArMjY4LDEwIEBAIHRvIDEsIGlmIHRoZSBoYXJkd2FyZSBkb2VzIHN1 cHBvcnQgcmV0cnkgdGhlbiBlaXRoZXIgc2V0IHRoZXNlIGNvdW50ZXJzIHRvCiAwIGlmIHRoZSBo YXJkd2FyZSBwcm92aWRlcyBubyBmZWVkYmFjayBvZiB3aGljaCBlcnJvcnMgb2NjdXJyZWQgYW5k IGhvdyBtYW55CiB0aW1lcywgb3IgZmlsbCBpbiB0aGUgY29ycmVjdCB2YWx1ZXMgYXMgcmVwb3J0 ZWQgYnkgdGhlIGhhcmR3YXJlLgogCitCZSBhd2FyZSB0aGF0IGNhbGxpbmcgdGhlc2UgZnVuY3Rp b25zIGNhbiBpbW1lZGlhdGVseSBzdGFydCBhIG5ldyB0cmFuc21pdAoraWYgdGhlcmUgaXMgb25l IHBlbmRpbmcgaW4gdGhlIHF1ZXVlLiBTbyBtYWtlIHN1cmUgdGhhdCB0aGUgaGFyZHdhcmUgaXMg aW4KK2Egc3RhdGUgd2hlcmUgbmV3IHRyYW5zbWl0cyBjYW4gYmUgc3RhcnRlZCAqYmVmb3JlKiBj YWxsaW5nIHRoZXNlIGZ1bmN0aW9ucy4KKwogVGhlIGNlY190cmFuc21pdF9hdHRlbXB0X2RvbmUo KSBmdW5jdGlvbiBpcyBhIGhlbHBlciBmb3IgY2FzZXMgd2hlcmUgdGhlCiBoYXJkd2FyZSBuZXZl ciByZXRyaWVzLCBzbyB0aGUgdHJhbnNtaXQgaXMgYWx3YXlzIGZvciBqdXN0IGEgc2luZ2xlCiBh dHRlbXB0LiBJdCB3aWxsIGNhbGwgY2VjX3RyYW5zbWl0X2RvbmUoKSBpbiB0dXJuLCBmaWxsaW5n IGluIDEgZm9yIHRoZQotLSAKMi4xOC4wCgpfX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fX19fX19fX19fXwpkcmktZGV2ZWwgbWFpbGluZyBsaXN0CmRyaS1kZXZlbEBsaXN0cy5m cmVlZGVza3RvcC5vcmcKaHR0cHM6Ly9saXN0cy5mcmVlZGVza3RvcC5vcmcvbWFpbG1hbi9saXN0 aW5mby9kcmktZGV2ZWwK