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

From: Simon Horman
Date: Fri Aug 09 2024 - 12:04:13 EST


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;

...