2023-12-26 03:08:06

by kernel test robot

[permalink] [raw]
Subject: drivers/hid/hid-magicmouse.c:146: warning: Function parameter or member 'battery_timer' not described in 'magicmouse_sc'

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: fbafc3e621c3f4ded43720fdb1d6ce1728ec664e
commit: 0b91b4e4dae63cd43871fc2012370b86ee588f91 HID: magicmouse: Report battery level over USB
date: 2 years, 1 month ago
config: x86_64-randconfig-x066-20230529 (https://download.01.org/0day-ci/archive/20231226/[email protected]/config)
compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231226/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

drivers/hid/hid-magicmouse.c:146: warning: Function parameter or member 'hdev' not described in 'magicmouse_sc'
drivers/hid/hid-magicmouse.c:146: warning: Function parameter or member 'work' not described in 'magicmouse_sc'
>> drivers/hid/hid-magicmouse.c:146: warning: Function parameter or member 'battery_timer' not described in 'magicmouse_sc'


vim +146 drivers/hid/hid-magicmouse.c

4f6fdf08681cecd Chase Douglas 2011-08-05 89
4f6fdf08681cecd Chase Douglas 2011-08-05 90 #define TRACKPAD_DIMENSION_X (float)13000
4f6fdf08681cecd Chase Douglas 2011-08-05 91 #define TRACKPAD_MIN_X -2909
4f6fdf08681cecd Chase Douglas 2011-08-05 92 #define TRACKPAD_MAX_X 3167
4f6fdf08681cecd Chase Douglas 2011-08-05 93 #define TRACKPAD_RES_X \
4f6fdf08681cecd Chase Douglas 2011-08-05 94 ((TRACKPAD_MAX_X - TRACKPAD_MIN_X) / (TRACKPAD_DIMENSION_X / 100))
4f6fdf08681cecd Chase Douglas 2011-08-05 95 #define TRACKPAD_DIMENSION_Y (float)11000
4f6fdf08681cecd Chase Douglas 2011-08-05 96 #define TRACKPAD_MIN_Y -2456
4f6fdf08681cecd Chase Douglas 2011-08-05 97 #define TRACKPAD_MAX_Y 2565
4f6fdf08681cecd Chase Douglas 2011-08-05 98 #define TRACKPAD_RES_Y \
4f6fdf08681cecd Chase Douglas 2011-08-05 99 ((TRACKPAD_MAX_Y - TRACKPAD_MIN_Y) / (TRACKPAD_DIMENSION_Y / 100))
4f6fdf08681cecd Chase Douglas 2011-08-05 100
9d7b18668956c41 Sean O'Brien 2018-10-02 101 #define TRACKPAD2_DIMENSION_X (float)16000
9d7b18668956c41 Sean O'Brien 2018-10-02 102 #define TRACKPAD2_MIN_X -3678
9d7b18668956c41 Sean O'Brien 2018-10-02 103 #define TRACKPAD2_MAX_X 3934
9d7b18668956c41 Sean O'Brien 2018-10-02 104 #define TRACKPAD2_RES_X \
9d7b18668956c41 Sean O'Brien 2018-10-02 105 ((TRACKPAD2_MAX_X - TRACKPAD2_MIN_X) / (TRACKPAD2_DIMENSION_X / 100))
9d7b18668956c41 Sean O'Brien 2018-10-02 106 #define TRACKPAD2_DIMENSION_Y (float)11490
9d7b18668956c41 Sean O'Brien 2018-10-02 107 #define TRACKPAD2_MIN_Y -2478
9d7b18668956c41 Sean O'Brien 2018-10-02 108 #define TRACKPAD2_MAX_Y 2587
9d7b18668956c41 Sean O'Brien 2018-10-02 109 #define TRACKPAD2_RES_Y \
9d7b18668956c41 Sean O'Brien 2018-10-02 110 ((TRACKPAD2_MAX_Y - TRACKPAD2_MIN_Y) / (TRACKPAD2_DIMENSION_Y / 100))
9d7b18668956c41 Sean O'Brien 2018-10-02 111
128537cea464d91 Michael Poole 2010-02-06 112 /**
128537cea464d91 Michael Poole 2010-02-06 113 * struct magicmouse_sc - Tracks Magic Mouse-specific data.
128537cea464d91 Michael Poole 2010-02-06 114 * @input: Input device through which we report events.
128537cea464d91 Michael Poole 2010-02-06 115 * @quirks: Currently unused.
128537cea464d91 Michael Poole 2010-02-06 116 * @ntouches: Number of touches in most recent touch report.
128537cea464d91 Michael Poole 2010-02-06 117 * @scroll_accel: Number of consecutive scroll motions.
128537cea464d91 Michael Poole 2010-02-06 118 * @scroll_jiffies: Time of last scroll motion.
128537cea464d91 Michael Poole 2010-02-06 119 * @touches: Most recent data for a touch, indexed by tracking ID.
128537cea464d91 Michael Poole 2010-02-06 120 * @tracking_ids: Mapping of current touch input data to @touches.
128537cea464d91 Michael Poole 2010-02-06 121 */
128537cea464d91 Michael Poole 2010-02-06 122 struct magicmouse_sc {
128537cea464d91 Michael Poole 2010-02-06 123 struct input_dev *input;
128537cea464d91 Michael Poole 2010-02-06 124 unsigned long quirks;
128537cea464d91 Michael Poole 2010-02-06 125
128537cea464d91 Michael Poole 2010-02-06 126 int ntouches;
128537cea464d91 Michael Poole 2010-02-06 127 int scroll_accel;
128537cea464d91 Michael Poole 2010-02-06 128 unsigned long scroll_jiffies;
128537cea464d91 Michael Poole 2010-02-06 129
128537cea464d91 Michael Poole 2010-02-06 130 struct {
128537cea464d91 Michael Poole 2010-02-06 131 short x;
128537cea464d91 Michael Poole 2010-02-06 132 short y;
c04266889b59116 Chase Douglas 2010-06-20 133 short scroll_x;
128537cea464d91 Michael Poole 2010-02-06 134 short scroll_y;
d4b9f10a0eb64c6 Jos? Exp?sito 2021-07-07 135 short scroll_x_hr;
d4b9f10a0eb64c6 Jos? Exp?sito 2021-07-07 136 short scroll_y_hr;
128537cea464d91 Michael Poole 2010-02-06 137 u8 size;
9d60648c607a2bf Jos? Exp?sito 2021-07-07 138 bool scroll_x_active;
9d60648c607a2bf Jos? Exp?sito 2021-07-07 139 bool scroll_y_active;
128537cea464d91 Michael Poole 2010-02-06 140 } touches[16];
128537cea464d91 Michael Poole 2010-02-06 141 int tracking_ids[16];
c0dc5582812dfaf John Chen 2021-03-30 142
c0dc5582812dfaf John Chen 2021-03-30 143 struct hid_device *hdev;
c0dc5582812dfaf John Chen 2021-03-30 144 struct delayed_work work;
0b91b4e4dae63cd Jos? Exp?sito 2021-11-18 145 struct timer_list battery_timer;
128537cea464d91 Michael Poole 2010-02-06 @146 };
128537cea464d91 Michael Poole 2010-02-06 147

:::::: The code at line 146 was first introduced by commit
:::::: 128537cea464d919febeaea2000e256749f317eb HID: add a device driver for the Apple Magic Mouse.

:::::: TO: Michael Poole <[email protected]>
:::::: CC: Jiri Kosina <[email protected]>

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki


2023-12-27 11:12:20

by Jiri Kosina

[permalink] [raw]
Subject: Re: drivers/hid/hid-magicmouse.c:146: warning: Function parameter or member 'battery_timer' not described in 'magicmouse_sc'

On Tue, 26 Dec 2023, kernel test robot wrote:

> tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head: fbafc3e621c3f4ded43720fdb1d6ce1728ec664e
> commit: 0b91b4e4dae63cd43871fc2012370b86ee588f91 HID: magicmouse: Report battery level over USB
> date: 2 years, 1 month ago
> config: x86_64-randconfig-x066-20230529 (https://download.01.org/0day-ci/archive/20231226/[email protected]/config)
> compiler: gcc-12 (Debian 12.2.0-14) 12.2.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231226/[email protected]/reproduce)
>
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <[email protected]>
> | Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

Thanks for the report. Now fixed in hid.git as below.



From: Jiri Kosina <[email protected]>
Subject: [PATCH] HID: magicmouse: fix kerneldoc for struct magicmouse_sc

Description for hdev, work and battery_timer of struct magicmouse_sc were
missing. Fix that.

Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
Signed-off-by: Jiri Kosina <[email protected]>
---
drivers/hid/hid-magicmouse.c | 3 +++
1 file changed, 3 insertions(+)

diff --git a/drivers/hid/hid-magicmouse.c b/drivers/hid/hid-magicmouse.c
index c9c968d4b36a..a46ff4e8b99f 100644
--- a/drivers/hid/hid-magicmouse.c
+++ b/drivers/hid/hid-magicmouse.c
@@ -120,6 +120,9 @@ MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state fie
* @scroll_jiffies: Time of last scroll motion.
* @touches: Most recent data for a touch, indexed by tracking ID.
* @tracking_ids: Mapping of current touch input data to @touches.
+ * @hdev: Pointer to the underlying HID device.
+ * @work: Workqueue to handle initialization retry for quirky devices.
+ * @battery_timer: Timer for obtaining battery level information.
*/
struct magicmouse_sc {
struct input_dev *input;

--
Jiri Kosina
SUSE Labs