netdev - Re: [PATCH net-next 04/11] dpll: spec: Add Netlink spec in YAML

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: <ZL6eQZ1yKpowjFeO@corigine.com>
Date: Mon, 24 Jul 2023 17:52:33 +0200
From: Simon Horman <simon.horman@...igine.com>
To: Vadim Fedorenko <vadim.fedorenko@...ux.dev>
Cc: Jakub Kicinski <kuba@...nel.org>, 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, poros@...hat.com,
	mschmidt@...hat.com, netdev@...r.kernel.org,
	linux-clk@...r.kernel.org, Bart Van Assche <bvanassche@....org>
Subject: Re: [PATCH net-next 04/11] dpll: spec: Add Netlink spec in YAML

On Thu, Jul 20, 2023 at 10:18:56AM +0100, Vadim Fedorenko wrote:

...

Hi Vadim,

Some minor feedback from my side.

> diff --git a/Documentation/netlink/specs/dpll.yaml b/Documentation/netlink/specs/dpll.yaml

...

> +  -
> +    type: flags
> +    name: pin-caps
> +    doc: |
> +      defines possible capabilities of a pin, valid flags on
> +      DPLL_A_PIN_CAPS attribute
> +    entries:
> +      -
> +        name: direction-can-change
> +        doc: pin direction can be changed
> +      -
> +        name: priority-can-change
> +        doc: pin prority can be changed

nit: prority -> priority

...

> diff --git a/include/uapi/linux/dpll.h b/include/uapi/linux/dpll.h

...

> +/**
> + * enum dpll_mode - working modes a dpll can support, differentiates if and how
> + *   dpll selects one of its inputs to syntonize with it, valid values for
> + *   DPLL_A_MODE attribute
> + * @DPLL_MODE_MANUAL: input can be only selected by sending a request to dpll
> + * @DPLL_MODE_AUTOMATIC: highest prio input pin auto selected by dpll
> + * @DPLL_MODE_FREERUN: dpll driven on system clk
> + */
> +enum dpll_mode {
> +	DPLL_MODE_MANUAL = 1,
> +	DPLL_MODE_AUTOMATIC,
> +	DPLL_MODE_FREERUN,

As __DPLL_MODE_MAX and DPLL_MODE_MAX are (rightly) not included
in the kernel doc above. I think it is appropriate to add the following
here.

	/* private: */

Likewise in several other places in this patch.

...

> +/**
> + * enum dpll_pin_caps - defines possible capabilities of a pin, valid flags on
> + *   DPLL_A_PIN_CAPS attribute
> + * @DPLL_PIN_CAPS_DIRECTION_CAN_CHANGE: pin direction can be changed
> + * @DPLL_PIN_CAPS_PRIORITY_CAN_CHANGE: pin prority can be changed

prority -> priority

> + * @DPLL_PIN_CAPS_STATE_CAN_CHANGE: pin state can be changed
> + */

...