Commit 5d0a4c11 authored by Uwe Kleine-König's avatar Uwe Kleine-König Committed by Thierry Reding
Browse files

pwm: Rearrange structures to group members by purpose 



In pwm_ops there are a few callbacks that are not supposed to be used by
new drivers. Group them at the end of the structure and add a comment.

Similarily for struct pwm_chip group the members that drivers shouldn't
care about at the end and mark them as internal with another comment.

Signed-off-by: default avatarUwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: default avatarThierry Reding <thierry.reding@gmail.com>
parent cc2d2247

include/linux/pwm.h

+18 −15
Original line number Diff line number Diff line
@@ -242,11 +242,7 @@ pwm_set_relative_duty_cycle(struct pwm_state *state, unsigned int duty_cycle, 
 * struct pwm_ops - PWM controller operations

 * @request: optional hook for requesting a PWM

 * @free: optional hook for freeing a PWM

 * @config: configure duty cycles and period length for this PWM

 * @set_polarity: configure the polarity of this PWM

 * @capture: capture and report PWM signal

 * @enable: enable PWM output toggling

 * @disable: disable PWM output toggling

 * @apply: atomically apply a new PWM config. The state argument

 *	   should be adjusted with the real hardware config (if the

 *	   approximate the period or duty_cycle value, state should
@@ -255,48 +251,55 @@ pwm_set_relative_duty_cycle(struct pwm_state *state, unsigned int duty_cycle, 
 *	       called once per PWM device when the PWM chip is

 *	       registered.

 * @owner: helps prevent removal of modules exporting active PWMs

 * @config: configure duty cycles and period length for this PWM

 * @set_polarity: configure the polarity of this PWM

 * @enable: enable PWM output toggling

 * @disable: disable PWM output toggling

 */

struct pwm_ops {

	int (*request)(struct pwm_chip *chip, struct pwm_device *pwm);

	void (*free)(struct pwm_chip *chip, struct pwm_device *pwm);

	int (*config)(struct pwm_chip *chip, struct pwm_device *pwm,

		      int duty_ns, int period_ns);

	int (*set_polarity)(struct pwm_chip *chip, struct pwm_device *pwm,

			    enum pwm_polarity polarity);

	int (*capture)(struct pwm_chip *chip, struct pwm_device *pwm,

		       struct pwm_capture *result, unsigned long timeout);

	int (*enable)(struct pwm_chip *chip, struct pwm_device *pwm);

	void (*disable)(struct pwm_chip *chip, struct pwm_device *pwm);

	int (*apply)(struct pwm_chip *chip, struct pwm_device *pwm,

		     struct pwm_state *state);

	void (*get_state)(struct pwm_chip *chip, struct pwm_device *pwm,

			  struct pwm_state *state);

	struct module *owner;



	/* Only used by legacy drivers */

	int (*config)(struct pwm_chip *chip, struct pwm_device *pwm,

		      int duty_ns, int period_ns);

	int (*set_polarity)(struct pwm_chip *chip, struct pwm_device *pwm,

			    enum pwm_polarity polarity);

	int (*enable)(struct pwm_chip *chip, struct pwm_device *pwm);

	void (*disable)(struct pwm_chip *chip, struct pwm_device *pwm);

};



/**

 * struct pwm_chip - abstract a PWM controller

 * @dev: device providing the PWMs

 * @list: list node for internal use

 * @ops: callbacks for this PWM controller

 * @base: number of first PWM controlled by this chip

 * @npwm: number of PWMs controlled by this chip

 * @pwms: array of PWM devices allocated by the framework

 * @of_xlate: request a PWM device given a device tree PWM specifier

 * @of_pwm_n_cells: number of cells expected in the device tree PWM specifier

 * @list: list node for internal use

 * @pwms: array of PWM devices allocated by the framework

 */

struct pwm_chip {

	struct device *dev;

	struct list_head list;

	const struct pwm_ops *ops;

	int base;

	unsigned int npwm;



	struct pwm_device *pwms;



	struct pwm_device * (*of_xlate)(struct pwm_chip *pc,

					const struct of_phandle_args *args);

	unsigned int of_pwm_n_cells;



	/* only used internally by the PWM framework */

	struct list_head list;

	struct pwm_device *pwms;

};



/**