From patchwork Thu May 20 19:00:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Lee Jones X-Patchwork-Id: 443318 Delivered-To: patch@linaro.org Received: by 2002:a02:7a1b:0:0:0:0:0 with SMTP id a27csp253204jac; Thu, 20 May 2021 12:01:42 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy1fASXMM2egONs1UW7mln7D5XUpl1MvrEVZge0tYbrPtCVVs2CFzwtPKgAOPuFKcm/DXAO X-Received: by 2002:a17:906:5388:: with SMTP id g8mr6355051ejo.413.1621537301994; Thu, 20 May 2021 12:01:41 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1621537301; cv=none; d=google.com; s=arc-20160816; b=kq07oVbWgz3GyXMkg28ydU7Qa4Z+oZSXUcrROvrICG1Alpv2sfp0qaR/SMfEQaVL63 41rdl7fb2/0/JpUaFqw0ImpKe694XN9W/FQH0JSZugi4XLepy/o+tf5HSXKJZmyVXbbM +8hRtcNFiAYnge1VBJBG66xYgUw+L6Nz85TB1dcMXYOl8DjJsLcZomUAm1LL7Hjeow7X HamGbzvEoo/ZsjkelCazlpgiZliU4nIHUy9DYfDJHB90T34BPEfSrNr6QQGRrh6aR5v7 7DQdAJWoFhUtTzvk1TniYptk3vh2HVGGo3d1VuAJ8scjl6EIVV6k1Agy8m33A2bZ3cY8 NgKA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=SBAKKQalOJHvEKpRKihiee3lgyfHDvw81EwoK2O6KMU=; b=Rfz/J21xGF1BwtU3ltEfFk/joC2w455Q/+0r3d66FEnUmR4tDTidivc7F+DgKH78W5 sFEIW8nZXLD9RdK7INN5mgCEeoia5Np4Gj0ROBXwoplIAXVN5iRcF5gVTTPIZHfHMX4i VEGwvUWzQMYsbw5Br9QHGQVjZ/xpeoI9b+nXmOoUlBXjM3MOw9J0QziwPWpTLNNQKUpU cFuiG3eQ0kYb2Sfij94BxL4CKJgyNKp6tL/YFHSDBt2Upf6I/+9RONWMexpPK5Uu5otc FNJfOkYEehPTbC6rHJM37GewyANZgFvK0EF43i60G2v4S0BhIfvvw8ovq6/FUu65uxI4 mfCQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TOvjUnEx; spf=pass (google.com: domain of linux-i2c-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-i2c-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id kv7si3142943ejc.678.2021.05.20.12.01.41; Thu, 20 May 2021 12:01:41 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-i2c-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=TOvjUnEx; spf=pass (google.com: domain of linux-i2c-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-i2c-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S237398AbhETTC6 (ORCPT + 2 others); Thu, 20 May 2021 15:02:58 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:32884 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S236877AbhETTCo (ORCPT ); Thu, 20 May 2021 15:02:44 -0400 Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0750CC0613ED for ; Thu, 20 May 2021 12:01:22 -0700 (PDT) Received: by mail-wr1-x42d.google.com with SMTP id y14so16635780wrm.13 for ; Thu, 20 May 2021 12:01:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=SBAKKQalOJHvEKpRKihiee3lgyfHDvw81EwoK2O6KMU=; b=TOvjUnExrJkfS1a45A6elsHA3Nl0rygE9dkkcvcFh7uIdhijihhEW8zz9F8JQcWqPR kvAVumtrWHiDB8TqE6unzMoO12ejgb5og9J8YLybBHJUDy7sgnIqJZsImgJEdH6I48kT +WLUmf3bQC8ISrYcCGnO25lOmgOJ60bVSo5aJu8sYffcdHdFmBWxtXJEJ/JCU8d1DzIn et09Sl6fYThOAIVhfqyZBsDepD2VA+Nxy9HMXXamTsLFUElmIWlTUeGR8jdX5M1AUC8y /h/c74ZlUYgJQRJl3cEgJr7yikN8q8eMcnajBiKVQvUpvC2lPlxt7tNsxJpNaRDpzCBD xh6A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=SBAKKQalOJHvEKpRKihiee3lgyfHDvw81EwoK2O6KMU=; b=Wmv2qPKAo2FSHyEYSURC7SnyCZy6p+ieCVcEU7cL4IzKvAVO4jfZNMaeSbfMRltx2G IWDxmoRKGdE3fJLRBebtXuZqd1+DyauNNp5oPzMKs3ozTKlCAkoROHs/hsKoxts/tMXd 92e4SaSRHCeM3jMY5lRAhGGlaVYmGrc61vg9KFkVSXGEOTEt3o7Y5lMZIV3DI7qLM7LR XkbTjAtOTVDmIj5iL2Vn47ket7JInMas7Ek8+b1zZegS7b2gQezQHR6Gw8Mvjes9Dmoi sB3OecoI8rEozr3txA2I2CqZM3xV3KlqVpS9juCyPA66vbocxvdyYXw6MbDZ73M9L9ls bX0g== X-Gm-Message-State: AOAM533BQF13QfKVWh6fGYSZyzD5Ip1/J+jQOK3RXYj2yYsB4CZzgwXW QU7zoNPz7OMhfRrZwfacIFqalg== X-Received: by 2002:a5d:4046:: with SMTP id w6mr5792880wrp.15.1621537280605; Thu, 20 May 2021 12:01:20 -0700 (PDT) Received: from dell.default ([91.110.221.215]) by smtp.gmail.com with ESMTPSA id p20sm9011899wmq.10.2021.05.20.12.01.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 May 2021 12:01:20 -0700 (PDT) From: Lee Jones To: lee.jones@linaro.org Cc: linux-kernel@vger.kernel.org, Peter Korsgaard , Andrew Lunn , Palmer Dabbelt , Paul Walmsley , Andreas Larsson , linux-i2c@vger.kernel.org, linux-riscv@lists.infradead.org Subject: [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Date: Thu, 20 May 2021 20:00:59 +0100 Message-Id: <20210520190105.3772683-11-lee.jones@linaro.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210520190105.3772683-1-lee.jones@linaro.org> References: <20210520190105.3772683-1-lee.jones@linaro.org> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org Fixes the following W=1 kernel build warning(s): drivers/i2c/busses/i2c-ocores.c:253: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:267: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:299: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst drivers/i2c/busses/i2c-ocores.c:347: warning: expecting prototype for It handles an IRQ(). Prototype was for ocores_process_polling() instead Cc: Peter Korsgaard Cc: Andrew Lunn Cc: Palmer Dabbelt Cc: Paul Walmsley Cc: Andreas Larsson Cc: linux-i2c@vger.kernel.org Cc: linux-riscv@lists.infradead.org Signed-off-by: Lee Jones --- drivers/i2c/busses/i2c-ocores.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) -- 2.31.1 Reviewed-by: Andrew Lunn Reviewed-by: Peter Korsgaard diff --git a/drivers/i2c/busses/i2c-ocores.c b/drivers/i2c/busses/i2c-ocores.c index 273222e38056e..a0af027db04c1 100644 --- a/drivers/i2c/busses/i2c-ocores.c +++ b/drivers/i2c/busses/i2c-ocores.c @@ -250,7 +250,7 @@ static irqreturn_t ocores_isr(int irq, void *dev_id) } /** - * Process timeout event + * ocores_process_timeout() - Process timeout event * @i2c: ocores I2C device instance */ static void ocores_process_timeout(struct ocores_i2c *i2c) @@ -264,7 +264,7 @@ static void ocores_process_timeout(struct ocores_i2c *i2c) } /** - * Wait until something change in a given register + * ocores_wait() - Wait until something change in a given register * @i2c: ocores I2C device instance * @reg: register to query * @mask: bitmask to apply on register value @@ -296,7 +296,7 @@ static int ocores_wait(struct ocores_i2c *i2c, } /** - * Wait until is possible to process some data + * ocores_poll_wait() - Wait until is possible to process some data * @i2c: ocores I2C device instance * * Used when the device is in polling mode (interrupts disabled). @@ -334,7 +334,7 @@ static int ocores_poll_wait(struct ocores_i2c *i2c) } /** - * It handles an IRQ-less transfer + * ocores_process_polling() - It handles an IRQ-less transfer * @i2c: ocores I2C device instance * * Even if IRQ are disabled, the I2C OpenCore IP behavior is exactly the same