netdev - Re: [PATCH v3 12/17] wifi: cc33xx: Add scan.c, scan.h

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20240809160355.GD1951@kernel.org>
Date: Fri, 9 Aug 2024 17:03:55 +0100
From: Simon Horman <horms@...nel.org>
To: Michael Nemanov <michael.nemanov@...com>
Cc: Kalle Valo <kvalo@...nel.org>, "David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	Rob Herring <robh@...nel.org>,
	Krzysztof Kozlowski <krzk+dt@...nel.org>,
	Conor Dooley <conor+dt@...nel.org>, linux-wireless@...r.kernel.org,
	netdev@...r.kernel.org, devicetree@...r.kernel.org,
	linux-kernel@...r.kernel.org, Sabeeh Khan <sabeeh-khan@...com>
Subject: Re: [PATCH v3 12/17] wifi: cc33xx: Add scan.c, scan.h

On Tue, Aug 06, 2024 at 08:00:13PM +0300, Michael Nemanov wrote:

...

> diff --git a/drivers/net/wireless/ti/cc33xx/scan.h b/drivers/net/wireless/ti/cc33xx/scan.h

...

> +/**
> + * struct cc33xx_cmd_ssid_list - scan SSID list description
> + *
> + * @role_id:            roleID
> + *
> + * @num_of_ssids:       Number of SSID in the list. MAX 16 entries

@num_of_ssids -> @n_ssids

> + *
> + * @ssid_list:          SSIDs to scan for (active scan only)

@ssid_list -> @ssids

Please document all non-private fields,
and annotate those that are private.

There are a number of similar minor Kernel doc problems with this patch.
Please consider using W=1 builds or ./scripts/kernel-doc -none
(bonus points for -Wall) 

> + */
> +struct cc33xx_cmd_ssid_list {
> +	struct cc33xx_cmd_header header;
> +
> +	u8 role_id;
> +	u8 scan_type;
> +	u8 n_ssids;
> +	struct cc33xx_ssid ssids[SCHED_SCAN_MAX_SSIDS];
> +	u8 padding;
> +} __packed;

...