1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * simple driver for PWM (Pulse Width Modulator) controller 4 * 5 * Derived from pxa PWM driver by eric miao <eric.miao@marvell.com> 6 * 7 * Limitations: 8 * - When disabled the output is driven to 0 independent of the configured 9 * polarity. 10 */ 11 12 #include <linux/bitfield.h> 13 #include <linux/bitops.h> 14 #include <linux/clk.h> 15 #include <linux/delay.h> 16 #include <linux/err.h> 17 #include <linux/io.h> 18 #include <linux/kernel.h> 19 #include <linux/module.h> 20 #include <linux/of.h> 21 #include <linux/platform_device.h> 22 #include <linux/pwm.h> 23 #include <linux/slab.h> 24 25 #define MX3_PWMCR 0x00 /* PWM Control Register */ 26 #define MX3_PWMSR 0x04 /* PWM Status Register */ 27 #define MX3_PWMSAR 0x0C /* PWM Sample Register */ 28 #define MX3_PWMPR 0x10 /* PWM Period Register */ 29 30 #define MX3_PWMCR_FWM GENMASK(27, 26) 31 #define MX3_PWMCR_STOPEN BIT(25) 32 #define MX3_PWMCR_DOZEN BIT(24) 33 #define MX3_PWMCR_WAITEN BIT(23) 34 #define MX3_PWMCR_DBGEN BIT(22) 35 #define MX3_PWMCR_BCTR BIT(21) 36 #define MX3_PWMCR_HCTR BIT(20) 37 38 #define MX3_PWMCR_POUTC GENMASK(19, 18) 39 #define MX3_PWMCR_POUTC_NORMAL 0 40 #define MX3_PWMCR_POUTC_INVERTED 1 41 #define MX3_PWMCR_POUTC_OFF 2 42 43 #define MX3_PWMCR_CLKSRC GENMASK(17, 16) 44 #define MX3_PWMCR_CLKSRC_OFF 0 45 #define MX3_PWMCR_CLKSRC_IPG 1 46 #define MX3_PWMCR_CLKSRC_IPG_HIGH 2 47 #define MX3_PWMCR_CLKSRC_IPG_32K 3 48 49 #define MX3_PWMCR_PRESCALER GENMASK(15, 4) 50 51 #define MX3_PWMCR_SWR BIT(3) 52 53 #define MX3_PWMCR_REPEAT GENMASK(2, 1) 54 #define MX3_PWMCR_REPEAT_1X 0 55 #define MX3_PWMCR_REPEAT_2X 1 56 #define MX3_PWMCR_REPEAT_4X 2 57 #define MX3_PWMCR_REPEAT_8X 3 58 59 #define MX3_PWMCR_EN BIT(0) 60 61 #define MX3_PWMSR_FWE BIT(6) 62 #define MX3_PWMSR_CMP BIT(5) 63 #define MX3_PWMSR_ROV BIT(4) 64 #define MX3_PWMSR_FE BIT(3) 65 66 #define MX3_PWMSR_FIFOAV GENMASK(2, 0) 67 #define MX3_PWMSR_FIFOAV_EMPTY 0 68 #define MX3_PWMSR_FIFOAV_1WORD 1 69 #define MX3_PWMSR_FIFOAV_2WORDS 2 70 #define MX3_PWMSR_FIFOAV_3WORDS 3 71 #define MX3_PWMSR_FIFOAV_4WORDS 4 72 73 #define MX3_PWMCR_PRESCALER_SET(x) FIELD_PREP(MX3_PWMCR_PRESCALER, (x) - 1) 74 #define MX3_PWMCR_PRESCALER_GET(x) (FIELD_GET(MX3_PWMCR_PRESCALER, \ 75 (x)) + 1) 76 77 #define MX3_PWM_SWR_LOOP 5 78 79 /* PWMPR register value of 0xffff has the same effect as 0xfffe */ 80 #define MX3_PWMPR_MAX 0xfffe 81 82 struct pwm_imx27_chip { 83 struct clk *clk_ipg; 84 struct clk *clk_per; 85 void __iomem *mmio_base; 86 struct pwm_chip chip; 87 88 /* 89 * The driver cannot read the current duty cycle from the hardware if 90 * the hardware is disabled. Cache the last programmed duty cycle 91 * value to return in that case. 92 */ 93 unsigned int duty_cycle; 94 }; 95 96 #define to_pwm_imx27_chip(chip) container_of(chip, struct pwm_imx27_chip, chip) 97 98 static int pwm_imx27_clk_prepare_enable(struct pwm_imx27_chip *imx) 99 { 100 int ret; 101 102 ret = clk_prepare_enable(imx->clk_ipg); 103 if (ret) 104 return ret; 105 106 ret = clk_prepare_enable(imx->clk_per); 107 if (ret) { 108 clk_disable_unprepare(imx->clk_ipg); 109 return ret; 110 } 111 112 return 0; 113 } 114 115 static void pwm_imx27_clk_disable_unprepare(struct pwm_imx27_chip *imx) 116 { 117 clk_disable_unprepare(imx->clk_per); 118 clk_disable_unprepare(imx->clk_ipg); 119 } 120 121 static void pwm_imx27_get_state(struct pwm_chip *chip, 122 struct pwm_device *pwm, struct pwm_state *state) 123 { 124 struct pwm_imx27_chip *imx = to_pwm_imx27_chip(chip); 125 u32 period, prescaler, pwm_clk, val; 126 u64 tmp; 127 int ret; 128 129 ret = pwm_imx27_clk_prepare_enable(imx); 130 if (ret < 0) 131 return; 132 133 val = readl(imx->mmio_base + MX3_PWMCR); 134 135 if (val & MX3_PWMCR_EN) 136 state->enabled = true; 137 else 138 state->enabled = false; 139 140 switch (FIELD_GET(MX3_PWMCR_POUTC, val)) { 141 case MX3_PWMCR_POUTC_NORMAL: 142 state->polarity = PWM_POLARITY_NORMAL; 143 break; 144 case MX3_PWMCR_POUTC_INVERTED: 145 state->polarity = PWM_POLARITY_INVERSED; 146 break; 147 default: 148 dev_warn(chip->dev, "can't set polarity, output disconnected"); 149 } 150 151 prescaler = MX3_PWMCR_PRESCALER_GET(val); 152 pwm_clk = clk_get_rate(imx->clk_per); 153 pwm_clk = DIV_ROUND_CLOSEST_ULL(pwm_clk, prescaler); 154 val = readl(imx->mmio_base + MX3_PWMPR); 155 period = val >= MX3_PWMPR_MAX ? MX3_PWMPR_MAX : val; 156 157 /* PWMOUT (Hz) = PWMCLK / (PWMPR + 2) */ 158 tmp = NSEC_PER_SEC * (u64)(period + 2); 159 state->period = DIV_ROUND_CLOSEST_ULL(tmp, pwm_clk); 160 161 /* 162 * PWMSAR can be read only if PWM is enabled. If the PWM is disabled, 163 * use the cached value. 164 */ 165 if (state->enabled) 166 val = readl(imx->mmio_base + MX3_PWMSAR); 167 else 168 val = imx->duty_cycle; 169 170 tmp = NSEC_PER_SEC * (u64)(val); 171 state->duty_cycle = DIV_ROUND_CLOSEST_ULL(tmp, pwm_clk); 172 173 pwm_imx27_clk_disable_unprepare(imx); 174 } 175 176 static void pwm_imx27_sw_reset(struct pwm_chip *chip) 177 { 178 struct pwm_imx27_chip *imx = to_pwm_imx27_chip(chip); 179 struct device *dev = chip->dev; 180 int wait_count = 0; 181 u32 cr; 182 183 writel(MX3_PWMCR_SWR, imx->mmio_base + MX3_PWMCR); 184 do { 185 usleep_range(200, 1000); 186 cr = readl(imx->mmio_base + MX3_PWMCR); 187 } while ((cr & MX3_PWMCR_SWR) && 188 (wait_count++ < MX3_PWM_SWR_LOOP)); 189 190 if (cr & MX3_PWMCR_SWR) 191 dev_warn(dev, "software reset timeout\n"); 192 } 193 194 static void pwm_imx27_wait_fifo_slot(struct pwm_chip *chip, 195 struct pwm_device *pwm) 196 { 197 struct pwm_imx27_chip *imx = to_pwm_imx27_chip(chip); 198 struct device *dev = chip->dev; 199 unsigned int period_ms; 200 int fifoav; 201 u32 sr; 202 203 sr = readl(imx->mmio_base + MX3_PWMSR); 204 fifoav = FIELD_GET(MX3_PWMSR_FIFOAV, sr); 205 if (fifoav == MX3_PWMSR_FIFOAV_4WORDS) { 206 period_ms = DIV_ROUND_UP(pwm_get_period(pwm), 207 NSEC_PER_MSEC); 208 msleep(period_ms); 209 210 sr = readl(imx->mmio_base + MX3_PWMSR); 211 if (fifoav == FIELD_GET(MX3_PWMSR_FIFOAV, sr)) 212 dev_warn(dev, "there is no free FIFO slot\n"); 213 } 214 } 215 216 static int pwm_imx27_apply(struct pwm_chip *chip, struct pwm_device *pwm, 217 const struct pwm_state *state) 218 { 219 unsigned long period_cycles, duty_cycles, prescale; 220 struct pwm_imx27_chip *imx = to_pwm_imx27_chip(chip); 221 struct pwm_state cstate; 222 unsigned long long c; 223 int ret; 224 u32 cr; 225 226 pwm_get_state(pwm, &cstate); 227 228 c = clk_get_rate(imx->clk_per); 229 c *= state->period; 230 231 do_div(c, 1000000000); 232 period_cycles = c; 233 234 prescale = period_cycles / 0x10000 + 1; 235 236 period_cycles /= prescale; 237 c = (unsigned long long)period_cycles * state->duty_cycle; 238 do_div(c, state->period); 239 duty_cycles = c; 240 241 /* 242 * according to imx pwm RM, the real period value should be PERIOD 243 * value in PWMPR plus 2. 244 */ 245 if (period_cycles > 2) 246 period_cycles -= 2; 247 else 248 period_cycles = 0; 249 250 /* 251 * Wait for a free FIFO slot if the PWM is already enabled, and flush 252 * the FIFO if the PWM was disabled and is about to be enabled. 253 */ 254 if (cstate.enabled) { 255 pwm_imx27_wait_fifo_slot(chip, pwm); 256 } else { 257 ret = pwm_imx27_clk_prepare_enable(imx); 258 if (ret) 259 return ret; 260 261 pwm_imx27_sw_reset(chip); 262 } 263 264 writel(duty_cycles, imx->mmio_base + MX3_PWMSAR); 265 writel(period_cycles, imx->mmio_base + MX3_PWMPR); 266 267 /* 268 * Store the duty cycle for future reference in cases where the 269 * MX3_PWMSAR register can't be read (i.e. when the PWM is disabled). 270 */ 271 imx->duty_cycle = duty_cycles; 272 273 cr = MX3_PWMCR_PRESCALER_SET(prescale) | 274 MX3_PWMCR_STOPEN | MX3_PWMCR_DOZEN | MX3_PWMCR_WAITEN | 275 FIELD_PREP(MX3_PWMCR_CLKSRC, MX3_PWMCR_CLKSRC_IPG_HIGH) | 276 MX3_PWMCR_DBGEN; 277 278 if (state->polarity == PWM_POLARITY_INVERSED) 279 cr |= FIELD_PREP(MX3_PWMCR_POUTC, 280 MX3_PWMCR_POUTC_INVERTED); 281 282 if (state->enabled) 283 cr |= MX3_PWMCR_EN; 284 285 writel(cr, imx->mmio_base + MX3_PWMCR); 286 287 if (!state->enabled) 288 pwm_imx27_clk_disable_unprepare(imx); 289 290 return 0; 291 } 292 293 static const struct pwm_ops pwm_imx27_ops = { 294 .apply = pwm_imx27_apply, 295 .get_state = pwm_imx27_get_state, 296 .owner = THIS_MODULE, 297 }; 298 299 static const struct of_device_id pwm_imx27_dt_ids[] = { 300 { .compatible = "fsl,imx27-pwm", }, 301 { /* sentinel */ } 302 }; 303 MODULE_DEVICE_TABLE(of, pwm_imx27_dt_ids); 304 305 static int pwm_imx27_probe(struct platform_device *pdev) 306 { 307 struct pwm_imx27_chip *imx; 308 int ret; 309 u32 pwmcr; 310 311 imx = devm_kzalloc(&pdev->dev, sizeof(*imx), GFP_KERNEL); 312 if (imx == NULL) 313 return -ENOMEM; 314 315 platform_set_drvdata(pdev, imx); 316 317 imx->clk_ipg = devm_clk_get(&pdev->dev, "ipg"); 318 if (IS_ERR(imx->clk_ipg)) { 319 int ret = PTR_ERR(imx->clk_ipg); 320 321 if (ret != -EPROBE_DEFER) 322 dev_err(&pdev->dev, 323 "getting ipg clock failed with %d\n", 324 ret); 325 return ret; 326 } 327 328 imx->clk_per = devm_clk_get(&pdev->dev, "per"); 329 if (IS_ERR(imx->clk_per)) { 330 int ret = PTR_ERR(imx->clk_per); 331 332 if (ret != -EPROBE_DEFER) 333 dev_err(&pdev->dev, 334 "failed to get peripheral clock: %d\n", 335 ret); 336 337 return ret; 338 } 339 340 imx->chip.ops = &pwm_imx27_ops; 341 imx->chip.dev = &pdev->dev; 342 imx->chip.base = -1; 343 imx->chip.npwm = 1; 344 345 imx->chip.of_xlate = of_pwm_xlate_with_flags; 346 imx->chip.of_pwm_n_cells = 3; 347 348 imx->mmio_base = devm_platform_ioremap_resource(pdev, 0); 349 if (IS_ERR(imx->mmio_base)) 350 return PTR_ERR(imx->mmio_base); 351 352 ret = pwm_imx27_clk_prepare_enable(imx); 353 if (ret) 354 return ret; 355 356 /* keep clks on if pwm is running */ 357 pwmcr = readl(imx->mmio_base + MX3_PWMCR); 358 if (!(pwmcr & MX3_PWMCR_EN)) 359 pwm_imx27_clk_disable_unprepare(imx); 360 361 return pwmchip_add(&imx->chip); 362 } 363 364 static int pwm_imx27_remove(struct platform_device *pdev) 365 { 366 struct pwm_imx27_chip *imx; 367 368 imx = platform_get_drvdata(pdev); 369 370 return pwmchip_remove(&imx->chip); 371 } 372 373 static struct platform_driver imx_pwm_driver = { 374 .driver = { 375 .name = "pwm-imx27", 376 .of_match_table = pwm_imx27_dt_ids, 377 }, 378 .probe = pwm_imx27_probe, 379 .remove = pwm_imx27_remove, 380 }; 381 module_platform_driver(imx_pwm_driver); 382 383 MODULE_LICENSE("GPL v2"); 384 MODULE_AUTHOR("Sascha Hauer <s.hauer@pengutronix.de>"); 385