10 #if IS_ENABLED(CONFIG_PWM)
12 * pwm_request - request a PWM device
14 struct pwm_device *pwm_request(int pwm_id, const char *label);
17 * pwm_free - free a PWM device
19 void pwm_free(struct pwm_device *pwm);
22 * pwm_config - change a PWM device configuration
24 int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns);
27 * pwm_enable - start a PWM output toggling
29 int pwm_enable(struct pwm_device *pwm);
32 * pwm_disable - stop a PWM output toggling
34 void pwm_disable(struct pwm_device *pwm);
36 static inline struct pwm_device *pwm_request(int pwm_id, const char *label)
38 return ERR_PTR(-ENODEV);
41 static inline void pwm_free(struct pwm_device *pwm)
45 static inline int pwm_config(struct pwm_device *pwm, int duty_ns, int period_ns)
50 static inline int pwm_enable(struct pwm_device *pwm)
55 static inline void pwm_disable(struct pwm_device *pwm)
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
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
73 PWM_POLARITY_INVERSED,
77 PWMF_REQUESTED = 1 << 0,
78 PWMF_ENABLED = 1 << 1,
79 PWMF_EXPORTED = 1 << 2,
87 struct pwm_chip *chip;
90 unsigned int period; /* in nanoseconds */
91 unsigned int duty_cycle; /* in nanoseconds */
92 enum pwm_polarity polarity;
95 static inline bool pwm_is_enabled(const struct pwm_device *pwm)
97 return test_bit(PWMF_ENABLED, &pwm->flags);
100 static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
103 pwm->period = period;
106 static inline unsigned int pwm_get_period(const struct pwm_device *pwm)
108 return pwm ? pwm->period : 0;
111 static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty)
114 pwm->duty_cycle = duty;
117 static inline unsigned int pwm_get_duty_cycle(const struct pwm_device *pwm)
119 return pwm ? pwm->duty_cycle : 0;
123 * pwm_set_polarity - configure the polarity of a PWM signal
125 int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity);
127 static inline enum pwm_polarity pwm_get_polarity(const struct pwm_device *pwm)
129 return pwm ? pwm->polarity : PWM_POLARITY_NORMAL;
133 * struct pwm_ops - PWM controller operations
134 * @request: optional hook for requesting a PWM
135 * @free: optional hook for freeing a PWM
136 * @config: configure duty cycles and period length for this PWM
137 * @set_polarity: configure the polarity of this PWM
138 * @enable: enable PWM output toggling
139 * @disable: disable PWM output toggling
140 * @dbg_show: optional routine to show contents in debugfs
141 * @owner: helps prevent removal of modules exporting active PWMs
144 int (*request)(struct pwm_chip *chip,
145 struct pwm_device *pwm);
146 void (*free)(struct pwm_chip *chip,
147 struct pwm_device *pwm);
148 int (*config)(struct pwm_chip *chip,
149 struct pwm_device *pwm,
150 int duty_ns, int period_ns);
151 int (*set_polarity)(struct pwm_chip *chip,
152 struct pwm_device *pwm,
153 enum pwm_polarity polarity);
154 int (*enable)(struct pwm_chip *chip,
155 struct pwm_device *pwm);
156 void (*disable)(struct pwm_chip *chip,
157 struct pwm_device *pwm);
158 #ifdef CONFIG_DEBUG_FS
159 void (*dbg_show)(struct pwm_chip *chip,
162 struct module *owner;
166 * struct pwm_chip - abstract a PWM controller
167 * @dev: device providing the PWMs
168 * @list: list node for internal use
169 * @ops: callbacks for this PWM controller
170 * @base: number of first PWM controlled by this chip
171 * @npwm: number of PWMs controlled by this chip
172 * @pwms: array of PWM devices allocated by the framework
173 * @can_sleep: must be true if the .config(), .enable() or .disable()
174 * operations may sleep
178 struct list_head list;
179 const struct pwm_ops *ops;
183 struct pwm_device *pwms;
185 struct pwm_device * (*of_xlate)(struct pwm_chip *pc,
186 const struct of_phandle_args *args);
187 unsigned int of_pwm_n_cells;
191 #if IS_ENABLED(CONFIG_PWM)
192 int pwm_set_chip_data(struct pwm_device *pwm, void *data);
193 void *pwm_get_chip_data(struct pwm_device *pwm);
195 int pwmchip_add_with_polarity(struct pwm_chip *chip,
196 enum pwm_polarity polarity);
197 int pwmchip_add(struct pwm_chip *chip);
198 int pwmchip_remove(struct pwm_chip *chip);
199 struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
203 struct pwm_device *of_pwm_xlate_with_flags(struct pwm_chip *pc,
204 const struct of_phandle_args *args);
206 struct pwm_device *pwm_get(struct device *dev, const char *con_id);
207 struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id);
208 void pwm_put(struct pwm_device *pwm);
210 struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id);
211 struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
213 void devm_pwm_put(struct device *dev, struct pwm_device *pwm);
215 bool pwm_can_sleep(struct pwm_device *pwm);
217 static inline int pwm_set_chip_data(struct pwm_device *pwm, void *data)
222 static inline void *pwm_get_chip_data(struct pwm_device *pwm)
227 static inline int pwmchip_add(struct pwm_chip *chip)
232 static inline int pwmchip_add_inversed(struct pwm_chip *chip)
237 static inline int pwmchip_remove(struct pwm_chip *chip)
242 static inline struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
246 return ERR_PTR(-ENODEV);
249 static inline struct pwm_device *pwm_get(struct device *dev,
250 const char *consumer)
252 return ERR_PTR(-ENODEV);
255 static inline struct pwm_device *of_pwm_get(struct device_node *np,
258 return ERR_PTR(-ENODEV);
261 static inline void pwm_put(struct pwm_device *pwm)
265 static inline struct pwm_device *devm_pwm_get(struct device *dev,
266 const char *consumer)
268 return ERR_PTR(-ENODEV);
271 static inline struct pwm_device *devm_of_pwm_get(struct device *dev,
272 struct device_node *np,
275 return ERR_PTR(-ENODEV);
278 static inline void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
282 static inline bool pwm_can_sleep(struct pwm_device *pwm)
289 struct list_head list;
290 const char *provider;
295 enum pwm_polarity polarity;
298 #define PWM_LOOKUP(_provider, _index, _dev_id, _con_id, _period, _polarity) \
300 .provider = _provider, \
305 .polarity = _polarity \
308 #if IS_ENABLED(CONFIG_PWM)
309 void pwm_add_table(struct pwm_lookup *table, size_t num);
310 void pwm_remove_table(struct pwm_lookup *table, size_t num);
312 static inline void pwm_add_table(struct pwm_lookup *table, size_t num)
316 static inline void pwm_remove_table(struct pwm_lookup *table, size_t num)
321 #ifdef CONFIG_PWM_SYSFS
322 void pwmchip_sysfs_export(struct pwm_chip *chip);
323 void pwmchip_sysfs_unexport(struct pwm_chip *chip);
325 static inline void pwmchip_sysfs_export(struct pwm_chip *chip)
329 static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip)
332 #endif /* CONFIG_PWM_SYSFS */
334 #endif /* __LINUX_PWM_H */