| .. | .. |
|---|
| 1 | +// SPDX-License-Identifier: GPL-2.0-only |
|---|
| 1 | 2 | /* |
|---|
| 2 | 3 | * STM32 ALSA SoC Digital Audio Interface (SAI) driver. |
|---|
| 3 | 4 | * |
|---|
| 4 | 5 | * Copyright (C) 2016, STMicroelectronics - All Rights Reserved |
|---|
| 5 | 6 | * Author(s): Olivier Moysan <olivier.moysan@st.com> for STMicroelectronics. |
|---|
| 6 | | - * |
|---|
| 7 | | - * License terms: GPL V2.0. |
|---|
| 8 | | - * |
|---|
| 9 | | - * This program is free software; you can redistribute it and/or modify it |
|---|
| 10 | | - * under the terms of the GNU General Public License version 2 as published by |
|---|
| 11 | | - * the Free Software Foundation. |
|---|
| 12 | | - * |
|---|
| 13 | | - * This program is distributed in the hope that it will be useful, but |
|---|
| 14 | | - * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|---|
| 15 | | - * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more |
|---|
| 16 | | - * details. |
|---|
| 17 | 7 | */ |
|---|
| 18 | 8 | |
|---|
| 19 | 9 | #include <linux/bitfield.h> |
|---|
| .. | .. |
|---|
| 21 | 11 | #include <linux/delay.h> |
|---|
| 22 | 12 | #include <linux/module.h> |
|---|
| 23 | 13 | #include <linux/of_platform.h> |
|---|
| 14 | +#include <linux/pinctrl/consumer.h> |
|---|
| 24 | 15 | #include <linux/reset.h> |
|---|
| 25 | 16 | |
|---|
| 26 | 17 | #include <sound/dmaengine_pcm.h> |
|---|
| .. | .. |
|---|
| 29 | 20 | #include "stm32_sai.h" |
|---|
| 30 | 21 | |
|---|
| 31 | 22 | static const struct stm32_sai_conf stm32_sai_conf_f4 = { |
|---|
| 32 | | - .version = SAI_STM32F4, |
|---|
| 33 | | - .has_spdif = false, |
|---|
| 23 | + .version = STM_SAI_STM32F4, |
|---|
| 24 | + .fifo_size = 8, |
|---|
| 25 | + .has_spdif_pdm = false, |
|---|
| 34 | 26 | }; |
|---|
| 35 | 27 | |
|---|
| 28 | +/* |
|---|
| 29 | + * Default settings for stm32 H7 socs and next. |
|---|
| 30 | + * These default settings will be overridden if the soc provides |
|---|
| 31 | + * support of hardware configuration registers. |
|---|
| 32 | + */ |
|---|
| 36 | 33 | static const struct stm32_sai_conf stm32_sai_conf_h7 = { |
|---|
| 37 | | - .version = SAI_STM32H7, |
|---|
| 38 | | - .has_spdif = true, |
|---|
| 34 | + .version = STM_SAI_STM32H7, |
|---|
| 35 | + .fifo_size = 8, |
|---|
| 36 | + .has_spdif_pdm = true, |
|---|
| 39 | 37 | }; |
|---|
| 40 | 38 | |
|---|
| 41 | 39 | static const struct of_device_id stm32_sai_ids[] = { |
|---|
| .. | .. |
|---|
| 44 | 42 | {} |
|---|
| 45 | 43 | }; |
|---|
| 46 | 44 | |
|---|
| 47 | | -static int stm32_sai_sync_conf_client(struct stm32_sai_data *sai, int synci) |
|---|
| 45 | +static int stm32_sai_pclk_disable(struct device *dev) |
|---|
| 48 | 46 | { |
|---|
| 47 | + struct stm32_sai_data *sai = dev_get_drvdata(dev); |
|---|
| 48 | + |
|---|
| 49 | + clk_disable_unprepare(sai->pclk); |
|---|
| 50 | + |
|---|
| 51 | + return 0; |
|---|
| 52 | +} |
|---|
| 53 | + |
|---|
| 54 | +static int stm32_sai_pclk_enable(struct device *dev) |
|---|
| 55 | +{ |
|---|
| 56 | + struct stm32_sai_data *sai = dev_get_drvdata(dev); |
|---|
| 49 | 57 | int ret; |
|---|
| 50 | 58 | |
|---|
| 51 | | - /* Enable peripheral clock to allow GCR register access */ |
|---|
| 52 | 59 | ret = clk_prepare_enable(sai->pclk); |
|---|
| 53 | 60 | if (ret) { |
|---|
| 54 | 61 | dev_err(&sai->pdev->dev, "failed to enable clock: %d\n", ret); |
|---|
| 55 | 62 | return ret; |
|---|
| 56 | 63 | } |
|---|
| 57 | 64 | |
|---|
| 65 | + return 0; |
|---|
| 66 | +} |
|---|
| 67 | + |
|---|
| 68 | +static int stm32_sai_sync_conf_client(struct stm32_sai_data *sai, int synci) |
|---|
| 69 | +{ |
|---|
| 70 | + int ret; |
|---|
| 71 | + |
|---|
| 72 | + /* Enable peripheral clock to allow GCR register access */ |
|---|
| 73 | + ret = stm32_sai_pclk_enable(&sai->pdev->dev); |
|---|
| 74 | + if (ret) |
|---|
| 75 | + return ret; |
|---|
| 76 | + |
|---|
| 58 | 77 | writel_relaxed(FIELD_PREP(SAI_GCR_SYNCIN_MASK, (synci - 1)), sai->base); |
|---|
| 59 | 78 | |
|---|
| 60 | | - clk_disable_unprepare(sai->pclk); |
|---|
| 79 | + stm32_sai_pclk_disable(&sai->pdev->dev); |
|---|
| 61 | 80 | |
|---|
| 62 | 81 | return 0; |
|---|
| 63 | 82 | } |
|---|
| .. | .. |
|---|
| 68 | 87 | int ret; |
|---|
| 69 | 88 | |
|---|
| 70 | 89 | /* Enable peripheral clock to allow GCR register access */ |
|---|
| 71 | | - ret = clk_prepare_enable(sai->pclk); |
|---|
| 72 | | - if (ret) { |
|---|
| 73 | | - dev_err(&sai->pdev->dev, "failed to enable clock: %d\n", ret); |
|---|
| 90 | + ret = stm32_sai_pclk_enable(&sai->pdev->dev); |
|---|
| 91 | + if (ret) |
|---|
| 74 | 92 | return ret; |
|---|
| 75 | | - } |
|---|
| 76 | 93 | |
|---|
| 77 | | - dev_dbg(&sai->pdev->dev, "Set %s%s as synchro provider\n", |
|---|
| 78 | | - sai->pdev->dev.of_node->name, |
|---|
| 94 | + dev_dbg(&sai->pdev->dev, "Set %pOFn%s as synchro provider\n", |
|---|
| 95 | + sai->pdev->dev.of_node, |
|---|
| 79 | 96 | synco == STM_SAI_SYNC_OUT_A ? "A" : "B"); |
|---|
| 80 | 97 | |
|---|
| 81 | 98 | prev_synco = FIELD_GET(SAI_GCR_SYNCOUT_MASK, readl_relaxed(sai->base)); |
|---|
| 82 | 99 | if (prev_synco != STM_SAI_SYNC_OUT_NONE && synco != prev_synco) { |
|---|
| 83 | | - dev_err(&sai->pdev->dev, "%s%s already set as sync provider\n", |
|---|
| 84 | | - sai->pdev->dev.of_node->name, |
|---|
| 100 | + dev_err(&sai->pdev->dev, "%pOFn%s already set as sync provider\n", |
|---|
| 101 | + sai->pdev->dev.of_node, |
|---|
| 85 | 102 | prev_synco == STM_SAI_SYNC_OUT_A ? "A" : "B"); |
|---|
| 86 | | - clk_disable_unprepare(sai->pclk); |
|---|
| 103 | + stm32_sai_pclk_disable(&sai->pdev->dev); |
|---|
| 87 | 104 | return -EINVAL; |
|---|
| 88 | 105 | } |
|---|
| 89 | 106 | |
|---|
| 90 | 107 | writel_relaxed(FIELD_PREP(SAI_GCR_SYNCOUT_MASK, synco), sai->base); |
|---|
| 91 | 108 | |
|---|
| 92 | | - clk_disable_unprepare(sai->pclk); |
|---|
| 109 | + stm32_sai_pclk_disable(&sai->pdev->dev); |
|---|
| 93 | 110 | |
|---|
| 94 | 111 | return 0; |
|---|
| 95 | 112 | } |
|---|
| .. | .. |
|---|
| 104 | 121 | |
|---|
| 105 | 122 | if (!pdev) { |
|---|
| 106 | 123 | dev_err(&sai_client->pdev->dev, |
|---|
| 107 | | - "Device not found for node %s\n", np_provider->name); |
|---|
| 124 | + "Device not found for node %pOFn\n", np_provider); |
|---|
| 125 | + of_node_put(np_provider); |
|---|
| 108 | 126 | return -ENODEV; |
|---|
| 109 | 127 | } |
|---|
| 110 | 128 | |
|---|
| .. | .. |
|---|
| 113 | 131 | dev_err(&sai_client->pdev->dev, |
|---|
| 114 | 132 | "SAI sync provider data not found\n"); |
|---|
| 115 | 133 | ret = -EINVAL; |
|---|
| 116 | | - goto out_put_dev; |
|---|
| 134 | + goto error; |
|---|
| 117 | 135 | } |
|---|
| 118 | 136 | |
|---|
| 119 | 137 | /* Configure sync client */ |
|---|
| 120 | 138 | ret = stm32_sai_sync_conf_client(sai_client, synci); |
|---|
| 121 | 139 | if (ret < 0) |
|---|
| 122 | | - goto out_put_dev; |
|---|
| 140 | + goto error; |
|---|
| 123 | 141 | |
|---|
| 124 | 142 | /* Configure sync provider */ |
|---|
| 125 | 143 | ret = stm32_sai_sync_conf_provider(sai_provider, synco); |
|---|
| 126 | 144 | |
|---|
| 127 | | -out_put_dev: |
|---|
| 145 | +error: |
|---|
| 128 | 146 | put_device(&pdev->dev); |
|---|
| 147 | + of_node_put(np_provider); |
|---|
| 129 | 148 | return ret; |
|---|
| 130 | 149 | } |
|---|
| 131 | 150 | |
|---|
| .. | .. |
|---|
| 133 | 152 | { |
|---|
| 134 | 153 | struct stm32_sai_data *sai; |
|---|
| 135 | 154 | struct reset_control *rst; |
|---|
| 136 | | - struct resource *res; |
|---|
| 137 | 155 | const struct of_device_id *of_id; |
|---|
| 156 | + u32 val; |
|---|
| 157 | + int ret; |
|---|
| 138 | 158 | |
|---|
| 139 | 159 | sai = devm_kzalloc(&pdev->dev, sizeof(*sai), GFP_KERNEL); |
|---|
| 140 | 160 | if (!sai) |
|---|
| 141 | 161 | return -ENOMEM; |
|---|
| 142 | 162 | |
|---|
| 143 | | - res = platform_get_resource(pdev, IORESOURCE_MEM, 0); |
|---|
| 144 | | - sai->base = devm_ioremap_resource(&pdev->dev, res); |
|---|
| 163 | + sai->base = devm_platform_ioremap_resource(pdev, 0); |
|---|
| 145 | 164 | if (IS_ERR(sai->base)) |
|---|
| 146 | 165 | return PTR_ERR(sai->base); |
|---|
| 147 | 166 | |
|---|
| 148 | 167 | of_id = of_match_device(stm32_sai_ids, &pdev->dev); |
|---|
| 149 | 168 | if (of_id) |
|---|
| 150 | | - sai->conf = (struct stm32_sai_conf *)of_id->data; |
|---|
| 169 | + memcpy(&sai->conf, (const struct stm32_sai_conf *)of_id->data, |
|---|
| 170 | + sizeof(struct stm32_sai_conf)); |
|---|
| 151 | 171 | else |
|---|
| 152 | 172 | return -EINVAL; |
|---|
| 153 | 173 | |
|---|
| 154 | 174 | if (!STM_SAI_IS_F4(sai)) { |
|---|
| 155 | 175 | sai->pclk = devm_clk_get(&pdev->dev, "pclk"); |
|---|
| 156 | 176 | if (IS_ERR(sai->pclk)) { |
|---|
| 157 | | - dev_err(&pdev->dev, "missing bus clock pclk\n"); |
|---|
| 177 | + if (PTR_ERR(sai->pclk) != -EPROBE_DEFER) |
|---|
| 178 | + dev_err(&pdev->dev, "missing bus clock pclk: %ld\n", |
|---|
| 179 | + PTR_ERR(sai->pclk)); |
|---|
| 158 | 180 | return PTR_ERR(sai->pclk); |
|---|
| 159 | 181 | } |
|---|
| 160 | 182 | } |
|---|
| 161 | 183 | |
|---|
| 162 | 184 | sai->clk_x8k = devm_clk_get(&pdev->dev, "x8k"); |
|---|
| 163 | 185 | if (IS_ERR(sai->clk_x8k)) { |
|---|
| 164 | | - dev_err(&pdev->dev, "missing x8k parent clock\n"); |
|---|
| 186 | + if (PTR_ERR(sai->clk_x8k) != -EPROBE_DEFER) |
|---|
| 187 | + dev_err(&pdev->dev, "missing x8k parent clock: %ld\n", |
|---|
| 188 | + PTR_ERR(sai->clk_x8k)); |
|---|
| 165 | 189 | return PTR_ERR(sai->clk_x8k); |
|---|
| 166 | 190 | } |
|---|
| 167 | 191 | |
|---|
| 168 | 192 | sai->clk_x11k = devm_clk_get(&pdev->dev, "x11k"); |
|---|
| 169 | 193 | if (IS_ERR(sai->clk_x11k)) { |
|---|
| 170 | | - dev_err(&pdev->dev, "missing x11k parent clock\n"); |
|---|
| 194 | + if (PTR_ERR(sai->clk_x11k) != -EPROBE_DEFER) |
|---|
| 195 | + dev_err(&pdev->dev, "missing x11k parent clock: %ld\n", |
|---|
| 196 | + PTR_ERR(sai->clk_x11k)); |
|---|
| 171 | 197 | return PTR_ERR(sai->clk_x11k); |
|---|
| 172 | 198 | } |
|---|
| 173 | 199 | |
|---|
| 174 | 200 | /* init irqs */ |
|---|
| 175 | 201 | sai->irq = platform_get_irq(pdev, 0); |
|---|
| 176 | | - if (sai->irq < 0) { |
|---|
| 177 | | - dev_err(&pdev->dev, "no irq for node %s\n", pdev->name); |
|---|
| 202 | + if (sai->irq < 0) |
|---|
| 178 | 203 | return sai->irq; |
|---|
| 179 | | - } |
|---|
| 180 | 204 | |
|---|
| 181 | 205 | /* reset */ |
|---|
| 182 | | - rst = devm_reset_control_get_exclusive(&pdev->dev, NULL); |
|---|
| 183 | | - if (!IS_ERR(rst)) { |
|---|
| 184 | | - reset_control_assert(rst); |
|---|
| 185 | | - udelay(2); |
|---|
| 186 | | - reset_control_deassert(rst); |
|---|
| 206 | + rst = devm_reset_control_get_optional_exclusive(&pdev->dev, NULL); |
|---|
| 207 | + if (IS_ERR(rst)) { |
|---|
| 208 | + if (PTR_ERR(rst) != -EPROBE_DEFER) |
|---|
| 209 | + dev_err(&pdev->dev, "Reset controller error %ld\n", |
|---|
| 210 | + PTR_ERR(rst)); |
|---|
| 211 | + return PTR_ERR(rst); |
|---|
| 187 | 212 | } |
|---|
| 213 | + reset_control_assert(rst); |
|---|
| 214 | + udelay(2); |
|---|
| 215 | + reset_control_deassert(rst); |
|---|
| 216 | + |
|---|
| 217 | + /* Enable peripheral clock to allow register access */ |
|---|
| 218 | + ret = clk_prepare_enable(sai->pclk); |
|---|
| 219 | + if (ret) { |
|---|
| 220 | + dev_err(&pdev->dev, "failed to enable clock: %d\n", ret); |
|---|
| 221 | + return ret; |
|---|
| 222 | + } |
|---|
| 223 | + |
|---|
| 224 | + val = FIELD_GET(SAI_IDR_ID_MASK, |
|---|
| 225 | + readl_relaxed(sai->base + STM_SAI_IDR)); |
|---|
| 226 | + if (val == SAI_IPIDR_NUMBER) { |
|---|
| 227 | + val = readl_relaxed(sai->base + STM_SAI_HWCFGR); |
|---|
| 228 | + sai->conf.fifo_size = FIELD_GET(SAI_HWCFGR_FIFO_SIZE, val); |
|---|
| 229 | + sai->conf.has_spdif_pdm = !!FIELD_GET(SAI_HWCFGR_SPDIF_PDM, |
|---|
| 230 | + val); |
|---|
| 231 | + |
|---|
| 232 | + val = readl_relaxed(sai->base + STM_SAI_VERR); |
|---|
| 233 | + sai->conf.version = val; |
|---|
| 234 | + |
|---|
| 235 | + dev_dbg(&pdev->dev, "SAI version: %lu.%lu registered\n", |
|---|
| 236 | + FIELD_GET(SAI_VERR_MAJ_MASK, val), |
|---|
| 237 | + FIELD_GET(SAI_VERR_MIN_MASK, val)); |
|---|
| 238 | + } |
|---|
| 239 | + clk_disable_unprepare(sai->pclk); |
|---|
| 188 | 240 | |
|---|
| 189 | 241 | sai->pdev = pdev; |
|---|
| 190 | 242 | sai->set_sync = &stm32_sai_set_sync; |
|---|
| .. | .. |
|---|
| 193 | 245 | return devm_of_platform_populate(&pdev->dev); |
|---|
| 194 | 246 | } |
|---|
| 195 | 247 | |
|---|
| 248 | +#ifdef CONFIG_PM_SLEEP |
|---|
| 249 | +/* |
|---|
| 250 | + * When pins are shared by two sai sub instances, pins have to be defined |
|---|
| 251 | + * in sai parent node. In this case, pins state is not managed by alsa fw. |
|---|
| 252 | + * These pins are managed in suspend/resume callbacks. |
|---|
| 253 | + */ |
|---|
| 254 | +static int stm32_sai_suspend(struct device *dev) |
|---|
| 255 | +{ |
|---|
| 256 | + struct stm32_sai_data *sai = dev_get_drvdata(dev); |
|---|
| 257 | + int ret; |
|---|
| 258 | + |
|---|
| 259 | + ret = stm32_sai_pclk_enable(dev); |
|---|
| 260 | + if (ret) |
|---|
| 261 | + return ret; |
|---|
| 262 | + |
|---|
| 263 | + sai->gcr = readl_relaxed(sai->base); |
|---|
| 264 | + stm32_sai_pclk_disable(dev); |
|---|
| 265 | + |
|---|
| 266 | + return pinctrl_pm_select_sleep_state(dev); |
|---|
| 267 | +} |
|---|
| 268 | + |
|---|
| 269 | +static int stm32_sai_resume(struct device *dev) |
|---|
| 270 | +{ |
|---|
| 271 | + struct stm32_sai_data *sai = dev_get_drvdata(dev); |
|---|
| 272 | + int ret; |
|---|
| 273 | + |
|---|
| 274 | + ret = stm32_sai_pclk_enable(dev); |
|---|
| 275 | + if (ret) |
|---|
| 276 | + return ret; |
|---|
| 277 | + |
|---|
| 278 | + writel_relaxed(sai->gcr, sai->base); |
|---|
| 279 | + stm32_sai_pclk_disable(dev); |
|---|
| 280 | + |
|---|
| 281 | + return pinctrl_pm_select_default_state(dev); |
|---|
| 282 | +} |
|---|
| 283 | +#endif /* CONFIG_PM_SLEEP */ |
|---|
| 284 | + |
|---|
| 285 | +static const struct dev_pm_ops stm32_sai_pm_ops = { |
|---|
| 286 | + SET_SYSTEM_SLEEP_PM_OPS(stm32_sai_suspend, stm32_sai_resume) |
|---|
| 287 | +}; |
|---|
| 288 | + |
|---|
| 196 | 289 | MODULE_DEVICE_TABLE(of, stm32_sai_ids); |
|---|
| 197 | 290 | |
|---|
| 198 | 291 | static struct platform_driver stm32_sai_driver = { |
|---|
| 199 | 292 | .driver = { |
|---|
| 200 | 293 | .name = "st,stm32-sai", |
|---|
| 201 | 294 | .of_match_table = stm32_sai_ids, |
|---|
| 295 | + .pm = &stm32_sai_pm_ops, |
|---|
| 202 | 296 | }, |
|---|
| 203 | 297 | .probe = stm32_sai_probe, |
|---|
| 204 | 298 | }; |
|---|