[mirror_ubuntu-bionic-kernel.git] / include / linux / pwm.h

#ifndef __LINUX_PWM_H
#define __LINUX_PWM_H

#include <linux/err.h>
#include <linux/of.h>

struct pwm_device;
struct seq_file;

#if IS_ENABLED(CONFIG_PWM) || IS_ENABLED(CONFIG_HAVE_PWM)
/*
 * pwm_request - request a PWM device
 */
struct pwm_device *pwm_request(int pwm_id, const char *label);

/*
 * pwm_free - free a PWM device
 */
void pwm_free(struct pwm_device *pwm);

/*
 * pwm_config - change a PWM device configuration
 */
int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns);

/*
 * pwm_enable - start a PWM output toggling
 */
int pwm_enable(struct pwm_device *pwm);

/*
 * pwm_disable - stop a PWM output toggling
 */
void pwm_disable(struct pwm_device *pwm);
#else
static inline struct pwm_device *pwm_request(int pwm_id, const char *label)
{
	return ERR_PTR(-ENODEV);
}

static inline void pwm_free(struct pwm_device *pwm)
{
}

static inline int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
{
	return -EINVAL;
}

static inline int pwm_enable(struct pwm_device *pwm)
{
	return -EINVAL;
}

static inline void pwm_disable(struct pwm_device *pwm)
{
}
#endif

struct pwm_chip;

/**
 * enum pwm_polarity - polarity of a PWM signal
 * @PWM_POLARITY_NORMAL: a high signal for the duration of the duty-
 * cycle, followed by a low signal for the remainder of the pulse
 * period
 * @PWM_POLARITY_INVERSED: a low signal for the duration of the duty-
 * cycle, followed by a high signal for the remainder of the pulse
 * period
 */
enum pwm_polarity {
	PWM_POLARITY_NORMAL,
	PWM_POLARITY_INVERSED,
};

enum {
	PWMF_REQUESTED = 1 << 0,
	PWMF_ENABLED = 1 << 1,
	PWMF_EXPORTED = 1 << 2,
};

struct pwm_device {
	const char		*label;
	unsigned long		flags;
	unsigned int		hwpwm;
	unsigned int		pwm;
	struct pwm_chip		*chip;
	void			*chip_data;

	unsigned int		period; 	/* in nanoseconds */
	unsigned int		duty_cycle;	/* in nanoseconds */
	enum pwm_polarity	polarity;
};

static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
{
	if (pwm)
		pwm->period = period;
}

static inline unsigned int pwm_get_period(struct pwm_device *pwm)
{
	return pwm ? pwm->period : 0;
}

static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty)
{
	if (pwm)
		pwm->duty_cycle = duty;
}

static inline unsigned int pwm_get_duty_cycle(struct pwm_device *pwm)
{
	return pwm ? pwm->duty_cycle : 0;
}

/*
 * pwm_set_polarity - configure the polarity of a PWM signal
 */
int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity);

/**
 * 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
 * @enable: enable PWM output toggling
 * @disable: disable PWM output toggling
 * @dbg_show: optional routine to show contents in debugfs
 * @owner: helps prevent removal of modules exporting active PWMs
 */
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			(*enable)(struct pwm_chip *chip,
					  struct pwm_device *pwm);
	void			(*disable)(struct pwm_chip *chip,
					   struct pwm_device *pwm);
#ifdef CONFIG_DEBUG_FS
	void			(*dbg_show)(struct pwm_chip *chip,
					    struct seq_file *s);
#endif
	struct module		*owner;
};

/**
 * 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
 * @can_sleep: must be true if the .config(), .enable() or .disable()
 *             operations may sleep
 */
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;
	bool			can_sleep;
};

#if IS_ENABLED(CONFIG_PWM)
int pwm_set_chip_data(struct pwm_device *pwm, void *data);
void *pwm_get_chip_data(struct pwm_device *pwm);

int pwmchip_add(struct pwm_chip *chip);
int pwmchip_remove(struct pwm_chip *chip);
struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
					 unsigned int index,
					 const char *label);

struct pwm_device *of_pwm_xlate_with_flags(struct pwm_chip *pc,
		const struct of_phandle_args *args);

struct pwm_device *pwm_get(struct device *dev, const char *con_id);
struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id);
void pwm_put(struct pwm_device *pwm);

struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id);
struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
				   const char *con_id);
void devm_pwm_put(struct device *dev, struct pwm_device *pwm);

bool pwm_can_sleep(struct pwm_device *pwm);
#else
static inline int pwm_set_chip_data(struct pwm_device *pwm, void *data)
{
	return -EINVAL;
}

static inline void *pwm_get_chip_data(struct pwm_device *pwm)
{
	return NULL;
}

static inline int pwmchip_add(struct pwm_chip *chip)
{
	return -EINVAL;
}

static inline int pwmchip_remove(struct pwm_chip *chip)
{
	return -EINVAL;
}

static inline struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
						       unsigned int index,
						       const char *label)
{
	return ERR_PTR(-ENODEV);
}

static inline struct pwm_device *pwm_get(struct device *dev,
					 const char *consumer)
{
	return ERR_PTR(-ENODEV);
}

static inline struct pwm_device *of_pwm_get(struct device_node *np,
					    const char *con_id)
{
	return ERR_PTR(-ENODEV);
}

static inline void pwm_put(struct pwm_device *pwm)
{
}

static inline struct pwm_device *devm_pwm_get(struct device *dev,
					      const char *consumer)
{
	return ERR_PTR(-ENODEV);
}

static inline struct pwm_device *devm_of_pwm_get(struct device *dev,
						 struct device_node *np,
						 const char *con_id)
{
	return ERR_PTR(-ENODEV);
}

static inline void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
{
}

static inline bool pwm_can_sleep(struct pwm_device *pwm)
{
	return false;
}
#endif

struct pwm_lookup {
	struct list_head list;
	const char *provider;
	unsigned int index;
	const char *dev_id;
	const char *con_id;
};

#define PWM_LOOKUP(_provider, _index, _dev_id, _con_id)	\
	{						\
		.provider = _provider,			\
		.index = _index,			\
		.dev_id = _dev_id,			\
		.con_id = _con_id,			\
	}

#if IS_ENABLED(CONFIG_PWM)
void pwm_add_table(struct pwm_lookup *table, size_t num);
#else
static inline void pwm_add_table(struct pwm_lookup *table, size_t num)
{
}
#endif

#ifdef CONFIG_PWM_SYSFS
void pwmchip_sysfs_export(struct pwm_chip *chip);
void pwmchip_sysfs_unexport(struct pwm_chip *chip);
#else
static inline void pwmchip_sysfs_export(struct pwm_chip *chip)
{
}

static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip)
{
}
#endif /* CONFIG_PWM_SYSFS */

#endif /* __LINUX_PWM_H */
Commit	Line	Data
1a189b97 RK	1	#ifndef __LINUX_PWM_H
	2	#define __LINUX_PWM_H
	3
0bcf168b	4	#include <linux/err.h>
7299ab70 TR	5	#include <linux/of.h>
7299ab70 TR	6
1a189b97	7	struct pwm_device;
62099abf	8	struct seq_file;
1a189b97	9
0bcf168b	10	#if IS_ENABLED(CONFIG_PWM) \|\| IS_ENABLED(CONFIG_HAVE_PWM)
1a189b97 RK	11	/*
	12	* pwm_request - request a PWM device
	13	*/
	14	struct pwm_device pwm_request(int pwm_id, const char label);
	15
	16	/*
	17	* pwm_free - free a PWM device
	18	*/
	19	void pwm_free(struct pwm_device *pwm);
	20
	21	/*
	22	* pwm_config - change a PWM device configuration
	23	*/
	24	int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns);
	25
	26	/*
	27	* pwm_enable - start a PWM output toggling
	28	*/
	29	int pwm_enable(struct pwm_device *pwm);
	30
	31	/*
	32	* pwm_disable - stop a PWM output toggling
	33	*/
	34	void pwm_disable(struct pwm_device *pwm);
0bcf168b TB	35	#else
	36	static inline struct pwm_device pwm_request(int pwm_id, const char label)
	37	{
	38	return ERR_PTR(-ENODEV);
	39	}
	40
	41	static inline void pwm_free(struct pwm_device *pwm)
	42	{
	43	}
	44
	45	static inline int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
	46	{
	47	return -EINVAL;
	48	}
	49
	50	static inline int pwm_enable(struct pwm_device *pwm)
	51	{
	52	return -EINVAL;
	53	}
	54
	55	static inline void pwm_disable(struct pwm_device *pwm)
	56	{
	57	}
	58	#endif
1a189b97	59
0c2498f1 SH	60	struct pwm_chip;
0c2498f1 SH	61
0aa0869c PA	62	/**
	63	* enum pwm_polarity - polarity of a PWM signal
	64	* @PWM_POLARITY_NORMAL: a high signal for the duration of the duty-
	65	* cycle, followed by a low signal for the remainder of the pulse
	66	* period
	67	* @PWM_POLARITY_INVERSED: a low signal for the duration of the duty-
	68	* cycle, followed by a high signal for the remainder of the pulse
	69	* period
	70	*/
	71	enum pwm_polarity {
	72	PWM_POLARITY_NORMAL,
	73	PWM_POLARITY_INVERSED,
	74	};
	75
f051c466 TR	76	enum {
	77	PWMF_REQUESTED = 1 << 0,
	78	PWMF_ENABLED = 1 << 1,
76abbdde	79	PWMF_EXPORTED = 1 << 2,
f051c466 TR	80	};
	81
	82	struct pwm_device {
	83	const char *label;
	84	unsigned long flags;
	85	unsigned int hwpwm;
	86	unsigned int pwm;
	87	struct pwm_chip *chip;
	88	void *chip_data;
	89
76abbdde HS	90	unsigned int period; /* in nanoseconds */
	91	unsigned int duty_cycle; /* in nanoseconds */
	92	enum pwm_polarity polarity;
f051c466 TR	93	};
	94
	95	static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
	96	{
	97	if (pwm)
	98	pwm->period = period;
	99	}
	100
	101	static inline unsigned int pwm_get_period(struct pwm_device *pwm)
	102	{
	103	return pwm ? pwm->period : 0;
	104	}
	105
76abbdde HS	106	static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty)
	107	{
	108	if (pwm)
	109	pwm->duty_cycle = duty;
	110	}
	111
	112	static inline unsigned int pwm_get_duty_cycle(struct pwm_device *pwm)
	113	{
	114	return pwm ? pwm->duty_cycle : 0;
	115	}
	116
0aa0869c PA	117	/*
	118	* pwm_set_polarity - configure the polarity of a PWM signal
	119	*/
	120	int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity);
	121
0c2498f1 SH	122	/**
	123	* struct pwm_ops - PWM controller operations
	124	* @request: optional hook for requesting a PWM
	125	* @free: optional hook for freeing a PWM
	126	* @config: configure duty cycles and period length for this PWM
0aa0869c	127	* @set_polarity: configure the polarity of this PWM
0c2498f1 SH	128	* @enable: enable PWM output toggling
0c2498f1 SH	129	* @disable: disable PWM output toggling
62099abf	130	* @dbg_show: optional routine to show contents in debugfs
0c2498f1 SH	131	* @owner: helps prevent removal of modules exporting active PWMs
	132	*/
	133	struct pwm_ops {
f051c466 TR	134	int (request)(struct pwm_chip chip,
	135	struct pwm_device *pwm);
	136	void (free)(struct pwm_chip chip,
	137	struct pwm_device *pwm);
	138	int (config)(struct pwm_chip chip,
	139	struct pwm_device *pwm,
	140	int duty_ns, int period_ns);
0aa0869c PA	141	int (set_polarity)(struct pwm_chip chip,
	142	struct pwm_device *pwm,
	143	enum pwm_polarity polarity);
f051c466 TR	144	int (enable)(struct pwm_chip chip,
	145	struct pwm_device *pwm);
	146	void (disable)(struct pwm_chip chip,
	147	struct pwm_device *pwm);
62099abf TR	148	#ifdef CONFIG_DEBUG_FS
	149	void (dbg_show)(struct pwm_chip chip,
	150	struct seq_file *s);
	151	#endif
0c2498f1 SH	152	struct module *owner;
	153	};
	154
	155	/**
f051c466 TR	156	* struct pwm_chip - abstract a PWM controller
	157	* @dev: device providing the PWMs
	158	* @list: list node for internal use
	159	* @ops: callbacks for this PWM controller
	160	* @base: number of first PWM controlled by this chip
	161	* @npwm: number of PWMs controlled by this chip
	162	* @pwms: array of PWM devices allocated by the framework
6e69ab13 FV	163	* @can_sleep: must be true if the .config(), .enable() or .disable()
6e69ab13 FV	164	* operations may sleep
0c2498f1 SH	165	*/
0c2498f1 SH	166	struct pwm_chip {
f051c466 TR	167	struct device *dev;
	168	struct list_head list;
	169	const struct pwm_ops *ops;
	170	int base;
	171	unsigned int npwm;
	172
	173	struct pwm_device *pwms;
7299ab70 TR	174
	175	struct pwm_device * (of_xlate)(struct pwm_chip pc,
	176	const struct of_phandle_args *args);
	177	unsigned int of_pwm_n_cells;
6e69ab13	178	bool can_sleep;
0c2498f1 SH	179	};
0c2498f1 SH	180
0bcf168b	181	#if IS_ENABLED(CONFIG_PWM)
f051c466 TR	182	int pwm_set_chip_data(struct pwm_device pwm, void data);
	183	void pwm_get_chip_data(struct pwm_device pwm);
	184
0c2498f1 SH	185	int pwmchip_add(struct pwm_chip *chip);
0c2498f1 SH	186	int pwmchip_remove(struct pwm_chip *chip);
f051c466 TR	187	struct pwm_device pwm_request_from_chip(struct pwm_chip chip,
	188	unsigned int index,
	189	const char *label);
8138d2dd	190
83af2402 PA	191	struct pwm_device of_pwm_xlate_with_flags(struct pwm_chip pc,
	192	const struct of_phandle_args *args);
	193
d4c0c470	194	struct pwm_device pwm_get(struct device dev, const char *con_id);
8eb96127	195	struct pwm_device of_pwm_get(struct device_node np, const char *con_id);
8138d2dd TR	196	void pwm_put(struct pwm_device *pwm);
8138d2dd TR	197
d4c0c470	198	struct pwm_device devm_pwm_get(struct device dev, const char *con_id);
261a5edd PU	199	struct pwm_device devm_of_pwm_get(struct device dev, struct device_node *np,
261a5edd PU	200	const char *con_id);
6354316d	201	void devm_pwm_put(struct device dev, struct pwm_device pwm);
6e69ab13 FV	202
6e69ab13 FV	203	bool pwm_can_sleep(struct pwm_device *pwm);
0bcf168b TB	204	#else
	205	static inline int pwm_set_chip_data(struct pwm_device pwm, void data)
	206	{
	207	return -EINVAL;
	208	}
	209
	210	static inline void pwm_get_chip_data(struct pwm_device pwm)
	211	{
	212	return NULL;
	213	}
	214
	215	static inline int pwmchip_add(struct pwm_chip *chip)
	216	{
	217	return -EINVAL;
	218	}
	219
	220	static inline int pwmchip_remove(struct pwm_chip *chip)
	221	{
	222	return -EINVAL;
	223	}
	224
	225	static inline struct pwm_device pwm_request_from_chip(struct pwm_chip chip,
	226	unsigned int index,
	227	const char *label)
	228	{
	229	return ERR_PTR(-ENODEV);
	230	}
	231
	232	static inline struct pwm_device pwm_get(struct device dev,
	233	const char *consumer)
	234	{
	235	return ERR_PTR(-ENODEV);
	236	}
	237
8eb96127 PU	238	static inline struct pwm_device of_pwm_get(struct device_node np,
	239	const char *con_id)
	240	{
	241	return ERR_PTR(-ENODEV);
	242	}
	243
0bcf168b TB	244	static inline void pwm_put(struct pwm_device *pwm)
	245	{
	246	}
	247
	248	static inline struct pwm_device devm_pwm_get(struct device dev,
	249	const char *consumer)
	250	{
	251	return ERR_PTR(-ENODEV);
	252	}
	253
261a5edd PU	254	static inline struct pwm_device devm_of_pwm_get(struct device dev,
	255	struct device_node *np,
	256	const char *con_id)
	257	{
	258	return ERR_PTR(-ENODEV);
	259	}
	260
0bcf168b TB	261	static inline void devm_pwm_put(struct device dev, struct pwm_device pwm)
	262	{
	263	}
6e69ab13 FV	264
	265	static inline bool pwm_can_sleep(struct pwm_device *pwm)
	266	{
	267	return false;
	268	}
0bcf168b	269	#endif
6354316d	270
8138d2dd TR	271	struct pwm_lookup {
	272	struct list_head list;
	273	const char *provider;
	274	unsigned int index;
	275	const char *dev_id;
	276	const char *con_id;
	277	};
	278
	279	#define PWM_LOOKUP(_provider, _index, _dev_id, _con_id) \
	280	{ \
	281	.provider = _provider, \
	282	.index = _index, \
	283	.dev_id = _dev_id, \
	284	.con_id = _con_id, \
	285	}
	286
0bcf168b	287	#if IS_ENABLED(CONFIG_PWM)
8138d2dd	288	void pwm_add_table(struct pwm_lookup *table, size_t num);
0bcf168b TB	289	#else
	290	static inline void pwm_add_table(struct pwm_lookup *table, size_t num)
	291	{
	292	}
0c2498f1 SH	293	#endif
0c2498f1 SH	294
76abbdde HS	295	#ifdef CONFIG_PWM_SYSFS
	296	void pwmchip_sysfs_export(struct pwm_chip *chip);
	297	void pwmchip_sysfs_unexport(struct pwm_chip *chip);
	298	#else
	299	static inline void pwmchip_sysfs_export(struct pwm_chip *chip)
	300	{
	301	}
	302
	303	static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip)
	304	{
	305	}
	306	#endif /* CONFIG_PWM_SYSFS */
	307
5243ef8b	308	#endif /* __LINUX_PWM_H */