[linux.git] / include / linux / pwm.h

#ifndef __LINUX_PWM_H
#define __LINUX_PWM_H

#include <linux/of.h>

struct pwm_device;
struct seq_file;

/*
 * 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);

#ifdef CONFIG_PWM
struct pwm_chip;

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

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 */
};

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;
}

/**
 * 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
 * @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			(*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
 */
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;
};

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 *pwm_get(struct device *dev, const char *consumer);
void pwm_put(struct pwm_device *pwm);

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,			\
	}

void pwm_add_table(struct pwm_lookup *table, size_t num);

#endif

#endif /* __LINUX_PWM_H */
Commit	Line	Data
1a189b97 RK	1	#ifndef __LINUX_PWM_H
	2	#define __LINUX_PWM_H
	3
7299ab70 TR	4	#include <linux/of.h>
7299ab70 TR	5
1a189b97	6	struct pwm_device;
62099abf	7	struct seq_file;
1a189b97 RK	8
	9	/*
	10	* pwm_request - request a PWM device
	11	*/
	12	struct pwm_device pwm_request(int pwm_id, const char label);
	13
	14	/*
	15	* pwm_free - free a PWM device
	16	*/
	17	void pwm_free(struct pwm_device *pwm);
	18
	19	/*
	20	* pwm_config - change a PWM device configuration
	21	*/
	22	int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns);
	23
	24	/*
	25	* pwm_enable - start a PWM output toggling
	26	*/
	27	int pwm_enable(struct pwm_device *pwm);
	28
	29	/*
	30	* pwm_disable - stop a PWM output toggling
	31	*/
	32	void pwm_disable(struct pwm_device *pwm);
	33
0c2498f1 SH	34	#ifdef CONFIG_PWM
	35	struct pwm_chip;
	36
f051c466 TR	37	enum {
	38	PWMF_REQUESTED = 1 << 0,
	39	PWMF_ENABLED = 1 << 1,
	40	};
	41
	42	struct pwm_device {
	43	const char *label;
	44	unsigned long flags;
	45	unsigned int hwpwm;
	46	unsigned int pwm;
	47	struct pwm_chip *chip;
	48	void *chip_data;
	49
	50	unsigned int period; /* in nanoseconds */
	51	};
	52
	53	static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
	54	{
	55	if (pwm)
	56	pwm->period = period;
	57	}
	58
	59	static inline unsigned int pwm_get_period(struct pwm_device *pwm)
	60	{
	61	return pwm ? pwm->period : 0;
	62	}
	63
0c2498f1 SH	64	/**
	65	* struct pwm_ops - PWM controller operations
	66	* @request: optional hook for requesting a PWM
	67	* @free: optional hook for freeing a PWM
	68	* @config: configure duty cycles and period length for this PWM
	69	* @enable: enable PWM output toggling
	70	* @disable: disable PWM output toggling
62099abf	71	* @dbg_show: optional routine to show contents in debugfs
0c2498f1 SH	72	* @owner: helps prevent removal of modules exporting active PWMs
	73	*/
	74	struct pwm_ops {
f051c466 TR	75	int (request)(struct pwm_chip chip,
	76	struct pwm_device *pwm);
	77	void (free)(struct pwm_chip chip,
	78	struct pwm_device *pwm);
	79	int (config)(struct pwm_chip chip,
	80	struct pwm_device *pwm,
	81	int duty_ns, int period_ns);
	82	int (enable)(struct pwm_chip chip,
	83	struct pwm_device *pwm);
	84	void (disable)(struct pwm_chip chip,
	85	struct pwm_device *pwm);
62099abf TR	86	#ifdef CONFIG_DEBUG_FS
	87	void (dbg_show)(struct pwm_chip chip,
	88	struct seq_file *s);
	89	#endif
0c2498f1 SH	90	struct module *owner;
	91	};
	92
	93	/**
f051c466 TR	94	* struct pwm_chip - abstract a PWM controller
	95	* @dev: device providing the PWMs
	96	* @list: list node for internal use
	97	* @ops: callbacks for this PWM controller
	98	* @base: number of first PWM controlled by this chip
	99	* @npwm: number of PWMs controlled by this chip
	100	* @pwms: array of PWM devices allocated by the framework
0c2498f1 SH	101	*/
0c2498f1 SH	102	struct pwm_chip {
f051c466 TR	103	struct device *dev;
	104	struct list_head list;
	105	const struct pwm_ops *ops;
	106	int base;
	107	unsigned int npwm;
	108
	109	struct pwm_device *pwms;
7299ab70 TR	110
	111	struct pwm_device * (of_xlate)(struct pwm_chip pc,
	112	const struct of_phandle_args *args);
	113	unsigned int of_pwm_n_cells;
0c2498f1 SH	114	};
0c2498f1 SH	115
f051c466 TR	116	int pwm_set_chip_data(struct pwm_device pwm, void data);
	117	void pwm_get_chip_data(struct pwm_device pwm);
	118
0c2498f1 SH	119	int pwmchip_add(struct pwm_chip *chip);
0c2498f1 SH	120	int pwmchip_remove(struct pwm_chip *chip);
f051c466 TR	121	struct pwm_device pwm_request_from_chip(struct pwm_chip chip,
	122	unsigned int index,
	123	const char *label);
8138d2dd TR	124
	125	struct pwm_device pwm_get(struct device dev, const char *consumer);
	126	void pwm_put(struct pwm_device *pwm);
	127
	128	struct pwm_lookup {
	129	struct list_head list;
	130	const char *provider;
	131	unsigned int index;
	132	const char *dev_id;
	133	const char *con_id;
	134	};
	135
	136	#define PWM_LOOKUP(_provider, _index, _dev_id, _con_id) \
	137	{ \
	138	.provider = _provider, \
	139	.index = _index, \
	140	.dev_id = _dev_id, \
	141	.con_id = _con_id, \
	142	}
	143
	144	void pwm_add_table(struct pwm_lookup *table, size_t num);
	145
0c2498f1 SH	146	#endif
0c2498f1 SH	147
5243ef8b	148	#endif /* __LINUX_PWM_H */