All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
	"Srinivas Pandruvada" <srinivas.pandruvada@linux.intel.com>,
	"Jiri Kosina" <jikos@kernel.org>,
	"Benjamin Tissoires" <benjamin.tissoires@redhat.com>,
	"Uwe Kleine-König" <uwe@kleine-koenig.org>,
	linux-input@vger.kernel.org
Subject: [PATCH 04/25] HID: intel-ish: Supply some missing param descriptions
Date: Wed, 24 Mar 2021 17:33:43 +0000	[thread overview]
Message-ID: <20210324173404.66340-5-lee.jones@linaro.org> (raw)
In-Reply-To: <20210324173404.66340-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/hid/intel-ish-hid/ishtp/bus.c:173: warning: Function parameter or member 'fw_client' not described in 'ishtp_get_fw_client_id'
 drivers/hid/intel-ish-hid/ishtp/bus.c:845: warning: Function parameter or member 'device' not described in 'ishtp_device'
 drivers/hid/intel-ish-hid/ishtp/bus.c:858: warning: Function parameter or member 'device' not described in 'ishtp_get_pci_device'
 drivers/hid/intel-ish-hid/ishtp/bus.c:871: warning: Function parameter or member 'cl_device' not described in 'ishtp_trace_callback'
 drivers/hid/intel-ish-hid/ishtp/bus.c:884: warning: Function parameter or member 'dev' not described in 'ish_hw_reset'

Cc: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
Cc: Jiri Kosina <jikos@kernel.org>
Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
Cc: "Uwe Kleine-König" <uwe@kleine-koenig.org>
Cc: linux-input@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/hid/intel-ish-hid/ishtp/bus.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/drivers/hid/intel-ish-hid/ishtp/bus.c b/drivers/hid/intel-ish-hid/ishtp/bus.c
index ffc9ce5c86ee6..c1c7d5356208d 100644
--- a/drivers/hid/intel-ish-hid/ishtp/bus.c
+++ b/drivers/hid/intel-ish-hid/ishtp/bus.c
@@ -164,6 +164,7 @@ EXPORT_SYMBOL(ishtp_fw_cl_get_client);
 
 /**
  * ishtp_get_fw_client_id() - Get fw client id
+ * @fw_client:	firmware client used to fetch the ID
  *
  * This interface is used to reset HW get FW client id.
  *
@@ -835,6 +836,7 @@ int ishtp_use_dma_transfer(void)
 
 /**
  * ishtp_device() - Return device pointer
+ * @device: ISH-TP client device instance
  *
  * This interface is used to return device pointer from ishtp_cl_device
  * instance.
@@ -851,6 +853,7 @@ EXPORT_SYMBOL(ishtp_device);
  * ishtp_get_pci_device() - Return PCI device dev pointer
  * This interface is used to return PCI device pointer
  * from ishtp_cl_device instance.
+ * @device: ISH-TP client device instance
  *
  * Return: device *.
  */
@@ -862,6 +865,7 @@ EXPORT_SYMBOL(ishtp_get_pci_device);
 
 /**
  * ishtp_trace_callback() - Return trace callback
+ * @cl_device: ISH-TP client device instance
  *
  * This interface is used to return trace callback function pointer.
  *
@@ -875,6 +879,7 @@ EXPORT_SYMBOL(ishtp_trace_callback);
 
 /**
  * ish_hw_reset() - Call HW reset IPC callback
+ * @dev:	ISHTP device instance
  *
  * This interface is used to reset HW in case of error.
  *
-- 
2.27.0


  parent reply	other threads:[~2021-03-24 17:35 UTC|newest]

Thread overview: 35+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-24 17:33 [PATCH 00/25] Rid W=1 warnings from HID Lee Jones
2021-03-24 17:33 ` Lee Jones
2021-03-24 17:33 ` Lee Jones
2021-03-24 17:33 ` [PATCH 01/25] HID: intel-ish-hid: Remove unused variable 'err' Lee Jones
2021-03-24 17:33 ` [PATCH 02/25] HID: ishtp-hid-client: Move variable to where it's actually used Lee Jones
2021-03-24 17:33 ` [PATCH 03/25] HID: intel-ish-hid: pci-ish: Remove unused variable 'ret' Lee Jones
2021-03-24 17:33 ` Lee Jones [this message]
2021-03-24 17:33 ` [PATCH 05/25] HID: intel-ish: Fix a naming disparity and a formatting error Lee Jones
2021-03-24 17:33 ` [PATCH 06/25] HID: usbhid: Repair a formatting issue in a struct description Lee Jones
2021-03-24 17:33 ` [PATCH 07/25] HID: intel-ish-hid: Fix a little doc-rot Lee Jones
2021-03-24 17:33 ` [PATCH 08/25] HID: usbhid: hid-pidff: Demote a couple kernel-doc abuses Lee Jones
2021-03-24 17:33 ` [PATCH 09/25] HID: hid-alps: Correct struct misnaming Lee Jones
2021-03-24 17:33 ` [PATCH 10/25] HID: intel-ish-hid: Fix potential copy/paste error Lee Jones
2021-03-24 17:33 ` [PATCH 11/25] HID: hid-core: Fix incorrect function name in header Lee Jones
2021-03-24 17:33 ` [PATCH 12/25] HID: intel-ish-hid: ipc: Correct fw_reset_work_fn() " Lee Jones
2021-03-24 17:33 ` [PATCH 13/25] HID: ishtp-hid-client: Fix incorrect function name report_bad_packet() Lee Jones
2021-03-24 17:33 ` [PATCH 14/25] HID: hid-kye: Fix incorrect function name for kye_tablet_enable() Lee Jones
2021-03-24 17:33 ` [PATCH 15/25] HID: hid-picolcd_core: Remove unused variable 'ret' Lee Jones
2021-03-24 17:33 ` [PATCH 16/25] HID: hid-logitech-hidpp: Fix conformant kernel-doc header and demote abuses Lee Jones
2021-03-24 17:33 ` [PATCH 17/25] HID: hid-uclogic-rdesc: Kernel-doc is for functions and structs Lee Jones
2021-03-24 17:33 ` [PATCH 18/25] HID: hid-thrustmaster: Demote a bunch of kernel-doc abuses Lee Jones
2021-03-24 17:33   ` Lee Jones
2021-03-24 21:27 ` [PATCH 00/25] Rid W=1 warnings from HID Srinivas Pandruvada
2021-03-24 21:27   ` Srinivas Pandruvada
2021-03-24 21:27   ` Srinivas Pandruvada
2021-03-26 11:42 ` Jonathan Cameron
2021-03-26 11:42   ` Jonathan Cameron
2021-03-26 11:42   ` Jonathan Cameron
2021-03-26 14:20   ` Lee Jones
2021-03-26 14:20     ` Lee Jones
2021-03-26 14:20     ` Lee Jones
2021-03-26 14:22     ` Lee Jones
2021-03-26 14:22       ` Lee Jones
2021-03-26 14:22       ` Lee Jones
2021-03-26 14:34 [RESEND " Lee Jones
2021-03-26 14:34 ` [PATCH 04/25] HID: intel-ish: Supply some missing param descriptions Lee Jones

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210324173404.66340-5-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=benjamin.tissoires@redhat.com \
    --cc=jikos@kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=srinivas.pandruvada@linux.intel.com \
    --cc=uwe@kleine-koenig.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.