PWM 驱动简析
设备树 PWM 控制器节点
I.MX6ULL 有 8 路 PWM 输出,因此对应 8 个 PWM 控制器,所有在设备树下就有 8 个PWM 控制器节点。这 8 路 PWM 都属于 I.MX6ULL 的 AIPS-1 域,但是在设备树 imx6ull.dtsi 中分为了两部分, PWM1~PWM4 在一起, PWM5~PWM8 在一起,这 8 路 PWM 并没有全部放到一起,这一点一定要注意,不要以为 imx6ull.dtsi 没有写完整。这 8 路 PWM 的设备树节点内容都是一样的,除了 reg 属性不同(毕竟不同的控制器,其地址范围不同)。本章实验我们使用GPIO1_IO04 这个引脚来完成 PWM 实验,而 GPIO1_IO04 就是 PWM3 的输出引脚,所以这里我们就以 PWM3 为例进行讲解, imx6ull.dtsi 文件中的 pwm3 节点信息如下:
1 pwm3: pwm@02088000 {
2 compatible = "fsl,imx6ul-pwm", "fsl,imx27-pwm";
3 reg = <0x02088000 0x4000>;
4 interrupts = <GIC_SPI 85 IRQ_TYPE_LEVEL_HIGH>;
5 clocks = <&clks IMX6UL_CLK_PWM3>,
6 <&clks IMX6UL_CLK_PWM3>;
7 clock-names = "ipg", "per";
8 #pwm-cells = <2>;
9 };
第 2 行, compatible 属性值有两个“fsl,imx6ul-pwm”和“fsl,imx27-pwm”,所以在整个 Linux源码里面搜索这两个字符窜即可找到 I.MX6ULL 的 PWM 驱动文件,这个文件就是drivers/pwm/pwm-imx.c。
关 于 I.MX6ULL 的 PWM 节 点 更 为 详 细 的 信 息 请 参 考 对 应 的 绑 定 文 档 :Documentation/devicetree/bindings/pwm/ imx-pwm.txt,这里就不去分析了。
PWM 子系统
Linux 内核提供了个 PWM 子系统框架,编写 PWM 驱动的时候一定要符合这个框架。 PWM子系统的核心是 pwm_chip 结构体,定义在文件 include/linux/pwm.h 中,定义如下:
1 struct pwm_chip {
2 struct device *dev;
3 struct list_head list;
4 const struct pwm_ops *ops;
5 int base;
6 unsigned int npwm;
7 struct pwm_device *pwms;
8 struct pwm_device * (*of_xlate)(struct pwm_chip *pc,
9 const struct of_phandle_args *args);
10 unsigned int of_pwm_n_cells;
11 bool can_sleep;
12 };
第 4 行, pwm_ops 结构体就是 PWM 外设的各种操作函数集合,编写 PWM 外设驱动的时候需要开发人员实现。 pwm_ops 结构体也定义在 pwm.h 头文件中,定义如下:
1 struct pwm_ops {
2 int (*request)(struct pwm_chip *chip, //请求 PWM
3 struct pwm_device *pwm);
4 void (*free)(struct pwm_chip *chip, //释放 PWM
5 struct pwm_device *pwm);
6 int (*config)(struct pwm_chip *chip, //配置 PWM 周期和占空比
7 struct pwm_device *pwm,
8 int duty_ns, int period_ns);
9 int (*set_polarity)(struct pwm_chip *chip, //设置 PWM 极性
10 struct pwm_device *pwm,
11 enum pwm_polarity polarity);
12 int (*enable)(struct pwm_chip *chip, //使能 PWM
13 struct pwm_device *pwm);
14 void (*disable)(struct pwm_chip *chip, //关闭 PWM
15 struct pwm_device *pwm);
16 struct module *owner;
17 };
pwm_ops 中的这些函数不一定全部实现,但是像 config、 enable 和 disable 这些肯定是需要实现的,否则的话打开/关闭 PWM,设置 PWM 的占空比这些就没操作了。PWM 子系统驱动的核心初始化 pwm_chip 结构体,然后向内核注册初始化完成以后的pwm_chip。这里就要用到 pwmchip_add 函数,此函数定义在 drivers/pwm/core.c 文件中,函数原型如下:
int pwmchip_add(struct pwm_chip *chip)
函数参数和返回值含义如下:
chip:要向内核注册的 pwm_chip。
返回值: 0 成功;负数 失败。
卸载 PWM 驱动的时候需要将前面注册的 pwm_chip 从内核移除掉,这里要用到pwmchip_remove 函数,函数原型如下:
int pwmchip_remove(struct pwm_chip *chip)
函数参数和返回值含义如下:
chip:要移除的 pwm_chip。
返回值: 0 成功;负数 失败。
PWM 驱动源码分析
我们简单分析一下 Linux 内核自带的 I.MX6ULL PWM 驱动,驱动文件前面都说了,是 pwmimx.c 这个文件。打开这个文件,可以看到,这是一个标准的平台设备驱动文件,如下所示:
1 static const struct of_device_id imx_pwm_dt_ids[] = {
2 { .compatible = "fsl,imx1-pwm", .data = &imx_pwm_data_v1, },
3 { .compatible = "fsl,imx27-pwm", .data = &imx_pwm_data_v2, },
4 { /* sentinel */ }
5 };
6
7
......
8
9 static struct platform_driver imx_pwm_driver = {
10 .driver = {
11 .name = "imx-pwm",
12 .of_match_table = imx_pwm_dt_ids,
13 },
14 .probe = imx_pwm_probe,
15 .remove = imx_pwm_remove,
16 };
17
18 module_platform_driver(imx_pwm_driver);
第 3 行,当设备树 PWM 节点的 compatible 属性值为“fsl,imx27-pwm”的话就会匹配此驱动,注意后面的.data 为 imx_pwm_data_v2,这是一个 imx_pwm_data 类型的结构体变量,内容如下:
1 static struct imx_pwm_data imx_pwm_data_v2 = {
2 .config = imx_pwm_config_v2,
3 .set_enable = imx_pwm_set_enable_v2,
4 };
imx_pwm_config_v2 函数就是最终操作 I.MX6ULL 的 PWM 外设寄存器,进行实际配置的函数。 imx_pwm_set_enable_v2 就是具体使能 PWM 的函数。
第 14 行,当设备树节点和驱动匹配以后 imx_pwm_probe 函数就会执行。
imx_pwm_probe 函数如下(有缩减):
1 static int imx_pwm_probe(struct platform_device *pdev)
2 {
3 const struct of_device_id *of_id =
4 of_match_device(imx_pwm_dt_ids, &pdev->dev);
5 const struct imx_pwm_data *data;
6 struct imx_chip *imx;
7 struct resource *r;
8 int ret = 0;
9
10 if (!of_id)
11 return -ENODEV;
12
13 imx = devm_kzalloc(&pdev->dev, sizeof(*imx), GFP_KERNEL);
14 if (imx == NULL)
15 return -ENOMEM;
......
31 imx->chip.ops = &imx_pwm_ops;
32 imx->chip.dev = &pdev->dev;
33 imx->chip.base = -1;
34 imx->chip.npwm = 1;
35 imx->chip.can_sleep = true;
36
37 r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
38 imx->mmio_base = devm_ioremap_resource(&pdev->dev, r);
39 if (IS_ERR(imx->mmio_base))
40 return PTR_ERR(imx->mmio_base);
41
42 data = of_id->data;
43 imx->config = data->config;
44 imx->set_enable = data->set_enable;
45
46 ret = pwmchip_add(&imx->chip);
47 if (ret < 0)
48 return ret;
49
50 platform_set_drvdata(pdev, imx);
51 return 0;
52 }
第 13 行, imx 是一个 imx_chip 类型的结构体指针变量,这里为其申请内存。 imx_chip 结构体有个重要的成员变量 chip, chip 是 pwm_chip 类型的。所以这一行就引出了 PWM 子系统核心部件 pwm_chip,稍后的重点就是初始化 chip。
第 31~35 行,初始化 imx 的 chip 成员变量,也就是初始化 pwm_chip!第 31 行设置 pwm_chip的 ops 操作集为 imx_pwm_ops, imx_pwm_ops 定义如下:
1 static struct pwm_ops imx_pwm_ops = {
2 .enable = imx_pwm_enable,
3 .disable = imx_pwm_disable,
4 .config = imx_pwm_config,
5 .owner = THIS_MODULE,
6 };
imx_pwm_enable、 imx_pwm_disable 和 imx_pwm_config 这三个函数就是使能、关闭和配置PWM 的函数。
37 和 38 行,从设备树中获取 PWM 节点中关于 PWM 控制器的地址信息,然后在进行内存映射,这样我们就得到了 PWM 控制器的基地址。
第 43 和 44 行,这两行设置 imx 的 config 和 set_enable 这两个成员变量为 data->config 和data->set_enable,也就是示例代码中的 imx_pwm_config_v2 和 imx_pwm_set_enable_v2这两个函数。 imx_pwm_enable、 imx_pwm_disable 和 imx_pwm_config 这三个函数最终调用就是imx_pwm_config_v2 和 imx_pwm_set_enable_v2。
整 个 pwm-imx.c 文 件 里 面 , 最 终 和 I.MX6ULL 的 PWM 寄 存 器 打 交 道 的 就 是imx_pwm_config_v2 和 imx_pwm_set_enable_v2 这 两 个 函 数 , 我 们 先 来 看 一 下
imx_pwm_set_enable_v2 函数,此函数用于打开或关闭对应的 PWM,函数内容如下:
1 static void imx_pwm_set_enable_v2(struct pwm_chip *chip, bool enable)
2 {
3 struct imx_chip *imx = to_imx_chip(chip);
4 u32 val;
5
6 val = readl(imx->mmio_base + MX3_PWMCR);
7
8 if (enable)
9 val |= MX3_PWMCR_EN;
10 else
11 val &= ~MX3_PWMCR_EN;
12
13 writel(val, imx->mmio_base + MX3_PWMCR);
14 }
第 6 行,读取 PWMCR 寄存器的值。
第 9 行,如果 enable 为真,表示使能 PWM,将 PWMCR 寄存器的 bit0 置 1 即可,宏MX3_PWMCR_EN 为(1<<0)。
第 11 行,如果 enable 不为真,表示关闭 PWM,将 PWMCR 寄存器的 bit0 清 0 即可。
第 13 行,将新的 val 值写入到 PWMCR 寄存器中。
imx_pwm_config_v2 函数用于设置 PWM 的频率和占空比,相关操作如下:
1 static int imx_pwm_config_v2(struct pwm_chip *chip,
2 struct pwm_device *pwm, int duty_ns, int period_ns)
3 {
4 struct imx_chip *imx = to_imx_chip(chip);
5 struct device *dev = chip->dev;
6 unsigned long long c;
7 unsigned long period_cycles, duty_cycles, prescale;
8 unsigned int period_ms;
9 bool enable = test_bit(PWMF_ENABLED, &pwm->flags);
10 int wait_count = 0, fifoav;
11 u32 cr, sr;
12
......
42
43 c = clk_get_rate(imx->clk_per);
44 c = c * period_ns;
45 do_div(c, 1000000000);
46 period_cycles = c;
47
48 prescale = period_cycles / 0x10000 + 1;
49
50 period_cycles /= prescale;
51 c = (unsigned long long)period_cycles * duty_ns;
52 do_div(c, period_ns);
53 duty_cycles = c;
54
55 /*
56 * according to imx pwm RM, the real period value should be
57 * PERIOD value in PWMPR plus 2.
58 */
59 if (period_cycles > 2)
60 period_cycles -= 2;
61 else
62 period_cycles = 0;
63
64 writel(duty_cycles, imx->mmio_base + MX3_PWMSAR);
65 writel(period_cycles, imx->mmio_base + MX3_PWMPR);
66
67 cr = MX3_PWMCR_PRESCALER(prescale) |
68 MX3_PWMCR_DOZEEN | MX3_PWMCR_WAITEN |
69 MX3_PWMCR_DBGEN | MX3_PWMCR_CLKSRC_IPG_HIGH;
70
71 if (enable)
72 cr |= MX3_PWMCR_EN;
73
74 writel(cr, imx->mmio_base + MX3_PWMCR);
75
76 return 0;
77 }
第43~62行,根据参数duty_ns和period_ns来计算出应该写入到寄存器里面的值duty_cycles和 period_cycles。
第 64 行,将计算得到的 duty_cycles 写入到 PWMSAR 寄存器中,设置 PWM 的占空比
第 65 行,将计算得到的 period_cycles 写入到 PWMPR 寄存器中,设置 PWM 的频率。
至此, I.MX6ULL 的 PWM 驱动我们就分析完了。
PWM 驱动测试
使用新的设备树启动系统,然后将开发板 JP2 排针上的 GPIO_4(GPIO1_IO04)引脚连接到示波器上,通过示波器来查看 PWM 波形图。我们可以直接在用户层来配置 PWM,进入目录
/sys/class/pwm 中,如图所示:
图中 pwmchip0~pwmchip7 对应 I.MX6ULL 的 PWM1~PWM8,所以我们需要用到pwmchip2。
首先需要调出 pwmchip2 下的 pwm0 目录,否则后续就没法操作了,输入如下命令:
echo 0 > /sys/class/pwm/pwmchip2/export
执行完成会在 pwmchip2 目录下生成一个名为“pwm0”的子目录,如图所示:
输入如下命令使能 PWM3:
echo 1 > /sys/class/pwm/pwmchip2/pwm0/enable
注意,这里设置的是周期值,单位为 ns,比如 20KHz 频率的周期就是 50000ns,输入如下命令:
echo 50000 > /sys/class/pwm/pwmchip2/pwm0/period
这里不能直接设置占空比,而是设置的一个周期的 ON 时间,也就是高电平时间,比如20KHz 频率下 20%占空比的 ON 时间就是 10000,输入如下命令:
echo 10000 > /sys/class/pwm/pwmchip2/pwm0/duty_cycle
设置完成使用示波器查看波形是否正确,正确的话如图所示: