Skip to content

Commit 41814fe

Browse files
pdp7Uwe Kleine-König
pdp7
authored and
Uwe Kleine-König
committed
pwm: Add driver for AXI PWM generator
Add support for the Analog Devices AXI PWM Generator. This device is an FPGA-implemented peripheral used as PWM signal generator and can be interfaced with AXI4. The register map of this peripheral makes it possible to configure the period and duty cycle of the output signal. Link: https://analogdevicesinc.github.io/hdl/library/axi_pwm_gen/index.html Co-developed-by: Sergiu Cuciurean <sergiu.cuciurean@analog.com> Signed-off-by: Sergiu Cuciurean <sergiu.cuciurean@analog.com> Co-developed-by: David Lechner <dlechner@baylibre.com> Signed-off-by: David Lechner <dlechner@baylibre.com> Signed-off-by: Drew Fustini <dfustini@baylibre.com> Acked-by: Nuno Sa <nuno.sa@analog.com> Co-developed-by: Trevor Gamblin <tgamblin@baylibre.com> Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Link: https://lore.kernel.org/r/20240605203507.1934434-3-tgamblin@baylibre.com Signed-off-by: Uwe Kleine-König <ukleinek@kernel.org>
1 parent 1edf2c2 commit 41814fe

4 files changed

Lines changed: 256 additions & 0 deletions

File tree

‎MAINTAINERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3578,6 +3578,7 @@ L: linux-pwm@vger.kernel.org
35783578
S: Supported
35793579
W: https://ez.analog.com/linux-software-drivers
35803580
F: Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml
3581+
F: drivers/pwm/pwm-axi-pwmgen.c
35813582

35823583
AXXIA I2C CONTROLLER
35833584
M: Krzysztof Adamski <krzysztof.adamski@nokia.com>

‎drivers/pwm/Kconfig‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,19 @@ config PWM_ATMEL_TCB
9494
To compile this driver as a module, choose M here: the module
9595
will be called pwm-atmel-tcb.
9696

97+
config PWM_AXI_PWMGEN
98+
tristate "Analog Devices AXI PWM generator"
99+
depends on MICROBLAZE || NIOS2 || ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_INTEL_SOCFPGA || COMPILE_TEST
100+
select REGMAP_MMIO
101+
help
102+
This enables support for the Analog Devices AXI PWM generator.
103+
104+
This is a configurable PWM generator with variable pulse width and
105+
period.
106+
107+
To compile this driver as a module, choose M here: the module will be
108+
called pwm-axi-pwmgen.
109+
97110
config PWM_BCM_IPROC
98111
tristate "iProc PWM support"
99112
depends on ARCH_BCM_IPROC || COMPILE_TEST

‎drivers/pwm/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ obj-$(CONFIG_PWM_APPLE) += pwm-apple.o
55
obj-$(CONFIG_PWM_ATMEL) += pwm-atmel.o
66
obj-$(CONFIG_PWM_ATMEL_HLCDC_PWM) += pwm-atmel-hlcdc.o
77
obj-$(CONFIG_PWM_ATMEL_TCB) += pwm-atmel-tcb.o
8+
obj-$(CONFIG_PWM_AXI_PWMGEN) += pwm-axi-pwmgen.o
89
obj-$(CONFIG_PWM_BCM_IPROC) += pwm-bcm-iproc.o
910
obj-$(CONFIG_PWM_BCM_KONA) += pwm-bcm-kona.o
1011
obj-$(CONFIG_PWM_BCM2835) += pwm-bcm2835.o

‎drivers/pwm/pwm-axi-pwmgen.c‎

Lines changed: 241 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,241 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/*
3+
* Analog Devices AXI PWM generator
4+
*
5+
* Copyright 2024 Analog Devices Inc.
6+
* Copyright 2024 Baylibre SAS
7+
*
8+
* Device docs: https://analogdevicesinc.github.io/hdl/library/axi_pwm_gen/index.html
9+
*
10+
* Limitations:
11+
* - The writes to registers for period and duty are shadowed until
12+
* LOAD_CONFIG is written to AXI_PWMGEN_REG_CONFIG, at which point
13+
* they take effect.
14+
* - Writing LOAD_CONFIG also has the effect of re-synchronizing all
15+
* enabled channels, which could cause glitching on other channels. It
16+
* is therefore expected that channels are assigned harmonic periods
17+
* and all have a single user coordinating this.
18+
* - Supports normal polarity. Does not support changing polarity.
19+
* - On disable, the PWM output becomes low (inactive).
20+
*/
21+
#include <linux/bits.h>
22+
#include <linux/clk.h>
23+
#include <linux/err.h>
24+
#include <linux/fpga/adi-axi-common.h>
25+
#include <linux/io.h>
26+
#include <linux/module.h>
27+
#include <linux/platform_device.h>
28+
#include <linux/pwm.h>
29+
#include <linux/regmap.h>
30+
#include <linux/slab.h>
31+
32+
#define AXI_PWMGEN_REG_CORE_VERSION 0x00
33+
#define AXI_PWMGEN_REG_ID 0x04
34+
#define AXI_PWMGEN_REG_SCRATCHPAD 0x08
35+
#define AXI_PWMGEN_REG_CORE_MAGIC 0x0C
36+
#define AXI_PWMGEN_REG_CONFIG 0x10
37+
#define AXI_PWMGEN_REG_NPWM 0x14
38+
#define AXI_PWMGEN_CHX_PERIOD(ch) (0x40 + (4 * (ch)))
39+
#define AXI_PWMGEN_CHX_DUTY(ch) (0x80 + (4 * (ch)))
40+
#define AXI_PWMGEN_CHX_OFFSET(ch) (0xC0 + (4 * (ch)))
41+
#define AXI_PWMGEN_REG_CORE_MAGIC_VAL 0x601A3471 /* Identification number to test during setup */
42+
#define AXI_PWMGEN_LOAD_CONFIG BIT(1)
43+
#define AXI_PWMGEN_REG_CONFIG_RESET BIT(0)
44+
45+
struct axi_pwmgen_ddata {
46+
struct regmap *regmap;
47+
unsigned long clk_rate_hz;
48+
};
49+
50+
static const struct regmap_config axi_pwmgen_regmap_config = {
51+
.reg_bits = 32,
52+
.reg_stride = 4,
53+
.val_bits = 32,
54+
};
55+
56+
static int axi_pwmgen_apply(struct pwm_chip *chip, struct pwm_device *pwm,
57+
const struct pwm_state *state)
58+
{
59+
struct axi_pwmgen_ddata *ddata = pwmchip_get_drvdata(chip);
60+
unsigned int ch = pwm->hwpwm;
61+
struct regmap *regmap = ddata->regmap;
62+
u64 period_cnt, duty_cnt;
63+
int ret;
64+
65+
if (state->polarity != PWM_POLARITY_NORMAL)
66+
return -EINVAL;
67+
68+
if (state->enabled) {
69+
period_cnt = mul_u64_u64_div_u64(state->period, ddata->clk_rate_hz, NSEC_PER_SEC);
70+
if (period_cnt > UINT_MAX)
71+
period_cnt = UINT_MAX;
72+
73+
if (period_cnt == 0)
74+
return -EINVAL;
75+
76+
ret = regmap_write(regmap, AXI_PWMGEN_CHX_PERIOD(ch), period_cnt);
77+
if (ret)
78+
return ret;
79+
80+
duty_cnt = mul_u64_u64_div_u64(state->duty_cycle, ddata->clk_rate_hz, NSEC_PER_SEC);
81+
if (duty_cnt > UINT_MAX)
82+
duty_cnt = UINT_MAX;
83+
84+
ret = regmap_write(regmap, AXI_PWMGEN_CHX_DUTY(ch), duty_cnt);
85+
if (ret)
86+
return ret;
87+
} else {
88+
ret = regmap_write(regmap, AXI_PWMGEN_CHX_PERIOD(ch), 0);
89+
if (ret)
90+
return ret;
91+
92+
ret = regmap_write(regmap, AXI_PWMGEN_CHX_DUTY(ch), 0);
93+
if (ret)
94+
return ret;
95+
}
96+
97+
return regmap_write(regmap, AXI_PWMGEN_REG_CONFIG, AXI_PWMGEN_LOAD_CONFIG);
98+
}
99+
100+
static int axi_pwmgen_get_state(struct pwm_chip *chip, struct pwm_device *pwm,
101+
struct pwm_state *state)
102+
{
103+
struct axi_pwmgen_ddata *ddata = pwmchip_get_drvdata(chip);
104+
struct regmap *regmap = ddata->regmap;
105+
unsigned int ch = pwm->hwpwm;
106+
u32 cnt;
107+
int ret;
108+
109+
ret = regmap_read(regmap, AXI_PWMGEN_CHX_PERIOD(ch), &cnt);
110+
if (ret)
111+
return ret;
112+
113+
state->enabled = cnt != 0;
114+
115+
state->period = DIV_ROUND_UP_ULL((u64)cnt * NSEC_PER_SEC, ddata->clk_rate_hz);
116+
117+
ret = regmap_read(regmap, AXI_PWMGEN_CHX_DUTY(ch), &cnt);
118+
if (ret)
119+
return ret;
120+
121+
state->duty_cycle = DIV_ROUND_UP_ULL((u64)cnt * NSEC_PER_SEC, ddata->clk_rate_hz);
122+
123+
state->polarity = PWM_POLARITY_NORMAL;
124+
125+
return 0;
126+
}
127+
128+
static const struct pwm_ops axi_pwmgen_pwm_ops = {
129+
.apply = axi_pwmgen_apply,
130+
.get_state = axi_pwmgen_get_state,
131+
};
132+
133+
static int axi_pwmgen_setup(struct regmap *regmap, struct device *dev)
134+
{
135+
int ret;
136+
u32 val;
137+
138+
ret = regmap_read(regmap, AXI_PWMGEN_REG_CORE_MAGIC, &val);
139+
if (ret)
140+
return ret;
141+
142+
if (val != AXI_PWMGEN_REG_CORE_MAGIC_VAL)
143+
return dev_err_probe(dev, -ENODEV,
144+
"failed to read expected value from register: got %08x, expected %08x\n",
145+
val, AXI_PWMGEN_REG_CORE_MAGIC_VAL);
146+
147+
ret = regmap_read(regmap, AXI_PWMGEN_REG_CORE_VERSION, &val);
148+
if (ret)
149+
return ret;
150+
151+
if (ADI_AXI_PCORE_VER_MAJOR(val) != 2) {
152+
return dev_err_probe(dev, -ENODEV, "Unsupported peripheral version %u.%u.%u\n",
153+
ADI_AXI_PCORE_VER_MAJOR(val),
154+
ADI_AXI_PCORE_VER_MINOR(val),
155+
ADI_AXI_PCORE_VER_PATCH(val));
156+
}
157+
158+
/* Enable the core */
159+
ret = regmap_update_bits(regmap, AXI_PWMGEN_REG_CONFIG, AXI_PWMGEN_REG_CONFIG_RESET, 0);
160+
if (ret)
161+
return ret;
162+
163+
ret = regmap_read(regmap, AXI_PWMGEN_REG_NPWM, &val);
164+
if (ret)
165+
return ret;
166+
167+
/* Return the number of PWMs */
168+
return val;
169+
}
170+
171+
static int axi_pwmgen_probe(struct platform_device *pdev)
172+
{
173+
struct device *dev = &pdev->dev;
174+
struct regmap *regmap;
175+
struct pwm_chip *chip;
176+
struct axi_pwmgen_ddata *ddata;
177+
struct clk *clk;
178+
void __iomem *io_base;
179+
int ret;
180+
181+
io_base = devm_platform_ioremap_resource(pdev, 0);
182+
if (IS_ERR(io_base))
183+
return PTR_ERR(io_base);
184+
185+
regmap = devm_regmap_init_mmio(dev, io_base, &axi_pwmgen_regmap_config);
186+
if (IS_ERR(regmap))
187+
return dev_err_probe(dev, PTR_ERR(regmap),
188+
"failed to init register map\n");
189+
190+
ret = axi_pwmgen_setup(regmap, dev);
191+
if (ret < 0)
192+
return ret;
193+
194+
chip = devm_pwmchip_alloc(dev, ret, sizeof(*ddata));
195+
if (IS_ERR(chip))
196+
return PTR_ERR(chip);
197+
ddata = pwmchip_get_drvdata(chip);
198+
ddata->regmap = regmap;
199+
200+
clk = devm_clk_get_enabled(dev, NULL);
201+
if (IS_ERR(clk))
202+
return dev_err_probe(dev, PTR_ERR(clk), "failed to get clock\n");
203+
204+
ret = devm_clk_rate_exclusive_get(dev, clk);
205+
if (ret)
206+
return dev_err_probe(dev, ret, "failed to get exclusive rate\n");
207+
208+
ddata->clk_rate_hz = clk_get_rate(clk);
209+
if (!ddata->clk_rate_hz || ddata->clk_rate_hz > NSEC_PER_SEC)
210+
return dev_err_probe(dev, -EINVAL,
211+
"Invalid clock rate: %lu\n", ddata->clk_rate_hz);
212+
213+
chip->ops = &axi_pwmgen_pwm_ops;
214+
chip->atomic = true;
215+
216+
ret = devm_pwmchip_add(dev, chip);
217+
if (ret)
218+
return dev_err_probe(dev, ret, "could not add PWM chip\n");
219+
220+
return 0;
221+
}
222+
223+
static const struct of_device_id axi_pwmgen_ids[] = {
224+
{ .compatible = "adi,axi-pwmgen-2.00.a" },
225+
{ }
226+
};
227+
MODULE_DEVICE_TABLE(of, axi_pwmgen_ids);
228+
229+
static struct platform_driver axi_pwmgen_driver = {
230+
.driver = {
231+
.name = "axi-pwmgen",
232+
.of_match_table = axi_pwmgen_ids,
233+
},
234+
.probe = axi_pwmgen_probe,
235+
};
236+
module_platform_driver(axi_pwmgen_driver);
237+
238+
MODULE_LICENSE("GPL");
239+
MODULE_AUTHOR("Sergiu Cuciurean <sergiu.cuciurean@analog.com>");
240+
MODULE_AUTHOR("Trevor Gamblin <tgamblin@baylibre.com>");
241+
MODULE_DESCRIPTION("Driver for the Analog Devices AXI PWM generator");

0 commit comments

Comments
 (0)