linux-kernel - Re: [PATCH 2/6] regulator: regulator driver interface.

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]

Date:	Sat, 23 Feb 2008 00:05:32 -0800
From:	Andrew Morton <akpm@...ux-foundation.org>
To:	Liam Girdwood <lg@...nsource.wolfsonmicro.com>
Cc:	linux-kernel <linux-kernel@...r.kernel.org>,
	linux-arm-kernel <linux-arm-kernel@...ts.arm.linux.org.uk>,
	Mark Brown <broonie@...nsource.wolfsonmicro.com>
Subject: Re: [PATCH 2/6] regulator: regulator driver interface.

On Wed, 20 Feb 2008 17:09:00 +0000 Liam Girdwood <lg@...nsource.wolfsonmicro.com> wrote:

> This interface allows regulator drivers to register their voltage and current
> regulators with the core. It also has a notifier call chain for propagating
> regulator events to clients.
> 
> +
> +/**
> + * struct regulator_ops - regulator operations.
> + *
> + * This struct describes regulator operations.
> + */

You can actually document the struct's fields in the kerneldoc comment
here, although I tend to think that it's better to document them as you
have done - ther eis more room, and people are more likely to remember to
update the comments when adding/removing/modifying fields.

> +struct regulator_ops {
> +
> +	/* get/set regulator voltage */
> +	int (*set_voltage)(struct regulator_cdev *, int uV);
> +	int (*get_voltage)(struct regulator_cdev *);
> +
> +	/* get/set regulator current  */
> +	int (*set_current)(struct regulator_cdev *, int uA);
> +	int (*get_current)(struct regulator_cdev *);
> +
> +	/* enable/disable regulator */
> +	int (*enable)(struct regulator_cdev *);
> +	int (*disable)(struct regulator_cdev *);
> +	int (*is_enabled)(struct regulator_cdev *);
> +
> +	/* get/set regulator operating mode (defined in regulator.h) */
> +	int (*set_mode)(struct regulator_cdev *, unsigned int mode);
> +	unsigned int (*get_mode)(struct regulator_cdev *);
> +
> +	/* get most efficient regulator operating mode for load */
> +	unsigned int (*get_optimum_mode)(struct regulator_cdev *, int input_uV,
> +		int output_uV, int load_uA);
> +};
>
> ...
>
> +/**
> + * regulator_get_drvdata - get regulator driver data
> + * @regulator: regulator
> + */
> +void *rcdev_get_drvdata (struct regulator_cdev *rcdev);
> +
> +/**
> + * regulator_get_id - get regulator ID
> + * @regulator: regulator
> + */
> +int rcdev_get_id (struct regulator_cdev *rcdev);

Please use scripts/checkpatch.pl...
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/