netdev - Re: [RFC PATCH v7 2/8] dpll: Add DPLL framework base functions

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230504142123.5fdb4e96@kernel.org>
Date: Thu, 4 May 2023 14:21:23 -0700
From: Jakub Kicinski <kuba@...nel.org>
To: Vadim Fedorenko <vadfed@...a.com>
Cc: Jiri Pirko <jiri@...nulli.us>, Arkadiusz Kubalewski
 <arkadiusz.kubalewski@...el.com>, Jonathan Lemon
 <jonathan.lemon@...il.com>, Paolo Abeni <pabeni@...hat.com>, Milena Olech
 <milena.olech@...el.com>, Michal Michalik <michal.michalik@...el.com>,
 <linux-arm-kernel@...ts.infradead.org>, Vadim Fedorenko
 <vadim.fedorenko@...ux.dev>, <poros@...hat.com>, <mschmidt@...hat.com>,
 <netdev@...r.kernel.org>, <linux-clk@...r.kernel.org>
Subject: Re: [RFC PATCH v7 2/8] dpll: Add DPLL framework base functions

On Thu, 27 Apr 2023 17:20:03 -0700 Vadim Fedorenko wrote:
> +/**
> + * struct dpll_pin - structure for a dpll pin
> + * @idx:		unique idx given by alloc on global pin's XA
> + * @dev_driver_id:	id given by dev driver
> + * @clock_id:		clock_id of creator
> + * @module:		module of creator
> + * @dpll_refs:		hold referencees to dplls that pin is registered with
> + * @pin_refs:		hold references to pins that pin is registered with
> + * @prop:		properties given by registerer
> + * @rclk_dev_name:	holds name of device when pin can recover clock from it
> + * @refcount:		refcount
> + **/
> +struct dpll_pin {
> +	u32 id;
> +	u32 pin_idx;
> +	u64 clock_id;
> +	struct module *module;
> +	struct xarray dpll_refs;
> +	struct xarray parent_refs;
> +	struct dpll_pin_properties prop;
> +	char *rclk_dev_name;
> +	refcount_t refcount;
> +};

The kdoc for structures is quite out of date, please run
./scripts/kernel-doc -none $DPLL_FILES

> +/**
> + * dpll_device_notify - notify on dpll device change
> + * @dpll: dpll device pointer
> + * @attr: changed attribute
> + *
> + * Broadcast event to the netlink multicast registered listeners.
> + *
> + * Return:
> + * * 0 - success
> + * * negative - error
> + */

Let's move the kdoc to the implementation. I believe that's 
the preferred kernel coding style.