include/linux/pwm.h

   1 #ifndef __LINUX_PWM_H
   2 #define __LINUX_PWM_H
   3
   4 #include <linux/err.h>
   5 #include <linux/of.h>
   6
   7 struct pwm_device;
   8 struct seq_file;
   9
  10 #if IS_ENABLED(CONFIG_PWM)
  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);
  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
  59
  60 struct pwm_chip;
  61
  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
  76 enum {
  77         PWMF_REQUESTED = 1 << 0,
  78         PWMF_ENABLED = 1 << 1,
  79         PWMF_EXPORTED = 1 << 2,
  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
  90         unsigned int period;
  91         unsigned int duty_cycle;
  92         enum pwm_polarity polarity;
  93 };
  94
  95 static inline bool pwm_is_enabled(const struct pwm_device *pwm)
  96 {
  97         return test_bit(PWMF_ENABLED, &pwm->flags);
  98 }
  99
 100 static inline void pwm_set_period(struct pwm_device *pwm, unsigned int period)
 101 {
 102         if (pwm)
 103                 pwm->period = period;
 104 }
 105
 106 static inline unsigned int pwm_get_period(const struct pwm_device *pwm)
 107 {
 108         return pwm ? pwm->period : 0;
 109 }
 110
 111 static inline void pwm_set_duty_cycle(struct pwm_device *pwm, unsigned int duty)
 112 {
 113         if (pwm)
 114                 pwm->duty_cycle = duty;
 115 }
 116
 117 static inline unsigned int pwm_get_duty_cycle(const struct pwm_device *pwm)
 118 {
 119         return pwm ? pwm->duty_cycle : 0;
 120 }
 121
 122 /*
 123  * pwm_set_polarity - configure the polarity of a PWM signal
 124  */
 125 int pwm_set_polarity(struct pwm_device *pwm, enum pwm_polarity polarity);
 126
 127 static inline enum pwm_polarity pwm_get_polarity(const struct pwm_device *pwm)
 128 {
 129         return pwm ? pwm->polarity : PWM_POLARITY_NORMAL;
 130 }
 131
 132 /**
 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
 142  */
 143 struct pwm_ops {
 144         int (*request)(struct pwm_chip *chip, struct pwm_device *pwm);
 145         void (*free)(struct pwm_chip *chip, struct pwm_device *pwm);
 146         int (*config)(struct pwm_chip *chip, struct pwm_device *pwm,
 147                       int duty_ns, int period_ns);
 148         int (*set_polarity)(struct pwm_chip *chip, struct pwm_device *pwm,
 149                             enum pwm_polarity polarity);
 150         int (*enable)(struct pwm_chip *chip, struct pwm_device *pwm);
 151         void (*disable)(struct pwm_chip *chip, struct pwm_device *pwm);
 152 #ifdef CONFIG_DEBUG_FS
 153         void (*dbg_show)(struct pwm_chip *chip, struct seq_file *s);
 154 #endif
 155         struct module *owner;
 156 };
 157
 158 /**
 159  * struct pwm_chip - abstract a PWM controller
 160  * @dev: device providing the PWMs
 161  * @list: list node for internal use
 162  * @ops: callbacks for this PWM controller
 163  * @base: number of first PWM controlled by this chip
 164  * @npwm: number of PWMs controlled by this chip
 165  * @pwms: array of PWM devices allocated by the framework
 166  * @can_sleep: must be true if the .config(), .enable() or .disable()
 167  *             operations may sleep
 168  */
 169 struct pwm_chip {
 170         struct device *dev;
 171         struct list_head list;
 172         const struct pwm_ops *ops;
 173         int base;
 174         unsigned int npwm;
 175
 176         struct pwm_device *pwms;
 177
 178         struct pwm_device * (*of_xlate)(struct pwm_chip *pc,
 179                                         const struct of_phandle_args *args);
 180         unsigned int of_pwm_n_cells;
 181         bool can_sleep;
 182 };
 183
 184 #if IS_ENABLED(CONFIG_PWM)
 185 int pwm_set_chip_data(struct pwm_device *pwm, void *data);
 186 void *pwm_get_chip_data(struct pwm_device *pwm);
 187
 188 int pwmchip_add_with_polarity(struct pwm_chip *chip,
 189                               enum pwm_polarity polarity);
 190 int pwmchip_add(struct pwm_chip *chip);
 191 int pwmchip_remove(struct pwm_chip *chip);
 192 struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
 193                                          unsigned int index,
 194                                          const char *label);
 195
 196 struct pwm_device *of_pwm_xlate_with_flags(struct pwm_chip *pc,
 197                 const struct of_phandle_args *args);
 198
 199 struct pwm_device *pwm_get(struct device *dev, const char *con_id);
 200 struct pwm_device *of_pwm_get(struct device_node *np, const char *con_id);
 201 void pwm_put(struct pwm_device *pwm);
 202
 203 struct pwm_device *devm_pwm_get(struct device *dev, const char *con_id);
 204 struct pwm_device *devm_of_pwm_get(struct device *dev, struct device_node *np,
 205                                    const char *con_id);
 206 void devm_pwm_put(struct device *dev, struct pwm_device *pwm);
 207
 208 bool pwm_can_sleep(struct pwm_device *pwm);
 209 #else
 210 static inline int pwm_set_chip_data(struct pwm_device *pwm, void *data)
 211 {
 212         return -EINVAL;
 213 }
 214
 215 static inline void *pwm_get_chip_data(struct pwm_device *pwm)
 216 {
 217         return NULL;
 218 }
 219
 220 static inline int pwmchip_add(struct pwm_chip *chip)
 221 {
 222         return -EINVAL;
 223 }
 224
 225 static inline int pwmchip_add_inversed(struct pwm_chip *chip)
 226 {
 227         return -EINVAL;
 228 }
 229
 230 static inline int pwmchip_remove(struct pwm_chip *chip)
 231 {
 232         return -EINVAL;
 233 }
 234
 235 static inline struct pwm_device *pwm_request_from_chip(struct pwm_chip *chip,
 236                                                        unsigned int index,
 237                                                        const char *label)
 238 {
 239         return ERR_PTR(-ENODEV);
 240 }
 241
 242 static inline struct pwm_device *pwm_get(struct device *dev,
 243                                          const char *consumer)
 244 {
 245         return ERR_PTR(-ENODEV);
 246 }
 247
 248 static inline struct pwm_device *of_pwm_get(struct device_node *np,
 249                                             const char *con_id)
 250 {
 251         return ERR_PTR(-ENODEV);
 252 }
 253
 254 static inline void pwm_put(struct pwm_device *pwm)
 255 {
 256 }
 257
 258 static inline struct pwm_device *devm_pwm_get(struct device *dev,
 259                                               const char *consumer)
 260 {
 261         return ERR_PTR(-ENODEV);
 262 }
 263
 264 static inline struct pwm_device *devm_of_pwm_get(struct device *dev,
 265                                                  struct device_node *np,
 266                                                  const char *con_id)
 267 {
 268         return ERR_PTR(-ENODEV);
 269 }
 270
 271 static inline void devm_pwm_put(struct device *dev, struct pwm_device *pwm)
 272 {
 273 }
 274
 275 static inline bool pwm_can_sleep(struct pwm_device *pwm)
 276 {
 277         return false;
 278 }
 279 #endif
 280
 281 struct pwm_lookup {
 282         struct list_head list;
 283         const char *provider;
 284         unsigned int index;
 285         const char *dev_id;
 286         const char *con_id;
 287         unsigned int period;
 288         enum pwm_polarity polarity;
 289 };
 290
 291 #define PWM_LOOKUP(_provider, _index, _dev_id, _con_id, _period, _polarity) \
 292         {                                               \
 293                 .provider = _provider,                  \
 294                 .index = _index,                        \
 295                 .dev_id = _dev_id,                      \
 296                 .con_id = _con_id,                      \
 297                 .period = _period,                      \
 298                 .polarity = _polarity                   \
 299         }
 300
 301 #if IS_ENABLED(CONFIG_PWM)
 302 void pwm_add_table(struct pwm_lookup *table, size_t num);
 303 void pwm_remove_table(struct pwm_lookup *table, size_t num);
 304 #else
 305 static inline void pwm_add_table(struct pwm_lookup *table, size_t num)
 306 {
 307 }
 308
 309 static inline void pwm_remove_table(struct pwm_lookup *table, size_t num)
 310 {
 311 }
 312 #endif
 313
 314 #ifdef CONFIG_PWM_SYSFS
 315 void pwmchip_sysfs_export(struct pwm_chip *chip);
 316 void pwmchip_sysfs_unexport(struct pwm_chip *chip);
 317 #else
 318 static inline void pwmchip_sysfs_export(struct pwm_chip *chip)
 319 {
 320 }
 321
 322 static inline void pwmchip_sysfs_unexport(struct pwm_chip *chip)
 323 {
 324 }
 325 #endif /* CONFIG_PWM_SYSFS */
 326
 327 #endif /* __LINUX_PWM_H */