1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 // Copyright(c) 2015-17 Intel Corporation.
5 * SDW Intel Init Routines
7 * Initializes and creates SDW devices based on ACPI and Hardware values
10 #include <linux/acpi.h>
11 #include <linux/export.h>
12 #include <linux/interrupt.h>
14 #include <linux/module.h>
15 #include <linux/auxiliary_bus.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/soundwire/sdw_intel.h>
18 #include "cadence_master.h"
20 #include "intel_auxdevice.h"
22 static void intel_link_dev_release(struct device *dev)
24 struct auxiliary_device *auxdev = to_auxiliary_dev(dev);
25 struct sdw_intel_link_dev *ldev = auxiliary_dev_to_sdw_intel_link_dev(auxdev);
30 /* alloc, init and add link devices */
31 static struct sdw_intel_link_dev *intel_link_dev_register(struct sdw_intel_res *res,
32 struct sdw_intel_ctx *ctx,
33 struct fwnode_handle *fwnode,
37 struct sdw_intel_link_dev *ldev;
38 struct sdw_intel_link_res *link;
39 struct auxiliary_device *auxdev;
42 ldev = kzalloc(sizeof(*ldev), GFP_KERNEL);
44 return ERR_PTR(-ENOMEM);
46 auxdev = &ldev->auxdev;
48 auxdev->dev.parent = res->parent;
49 auxdev->dev.fwnode = fwnode;
50 auxdev->dev.release = intel_link_dev_release;
52 /* we don't use an IDA since we already have a link ID */
56 * keep a handle on the allocated memory, to be used in all other functions.
57 * Since the same pattern is used to skip links that are not enabled, there is
58 * no need to check if ctx->ldev[i] is NULL later on.
60 ctx->ldev[link_id] = ldev;
62 /* Add link information used in the driver probe */
63 link = &ldev->link_res;
64 link->hw_ops = res->hw_ops;
65 link->mmio_base = res->mmio_base;
66 link->registers = res->mmio_base + SDW_LINK_BASE
67 + (SDW_LINK_SIZE * link_id);
68 link->shim = res->mmio_base + res->shim_base;
69 link->alh = res->mmio_base + res->alh_base;
74 link->clock_stop_quirks = res->clock_stop_quirks;
75 link->shim_lock = &ctx->shim_lock;
76 link->shim_mask = &ctx->shim_mask;
77 link->link_mask = ctx->link_mask;
79 /* now follow the two-step init/add sequence */
80 ret = auxiliary_device_init(auxdev);
82 dev_err(res->parent, "failed to initialize link dev %s link_id %d\n",
88 ret = auxiliary_device_add(&ldev->auxdev);
90 dev_err(res->parent, "failed to add link dev %s link_id %d\n",
91 ldev->auxdev.name, link_id);
92 /* ldev will be freed with the put_device() and .release sequence */
93 auxiliary_device_uninit(&ldev->auxdev);
100 static void intel_link_dev_unregister(struct sdw_intel_link_dev *ldev)
102 auxiliary_device_delete(&ldev->auxdev);
103 auxiliary_device_uninit(&ldev->auxdev);
106 static int sdw_intel_cleanup(struct sdw_intel_ctx *ctx)
108 struct sdw_intel_link_dev *ldev;
112 link_mask = ctx->link_mask;
114 for (i = 0; i < ctx->count; i++) {
115 if (!(link_mask & BIT(i)))
120 pm_runtime_disable(&ldev->auxdev.dev);
121 if (!ldev->link_res.clock_stop_quirks)
122 pm_runtime_put_noidle(ldev->link_res.dev);
124 intel_link_dev_unregister(ldev);
130 irqreturn_t sdw_intel_thread(int irq, void *dev_id)
132 struct sdw_intel_ctx *ctx = dev_id;
133 struct sdw_intel_link_res *link;
135 list_for_each_entry(link, &ctx->link_list, list)
136 sdw_cdns_irq(irq, link->cdns);
140 EXPORT_SYMBOL_NS(sdw_intel_thread, SOUNDWIRE_INTEL_INIT);
142 static struct sdw_intel_ctx
143 *sdw_intel_probe_controller(struct sdw_intel_res *res)
145 struct sdw_intel_link_res *link;
146 struct sdw_intel_link_dev *ldev;
147 struct sdw_intel_ctx *ctx;
148 struct acpi_device *adev;
149 struct sdw_slave *slave;
150 struct list_head *node;
160 adev = acpi_fetch_acpi_dev(res->handle);
168 dev_dbg(&adev->dev, "Creating %d SDW Link devices\n", count);
171 * we need to alloc/free memory manually and can't use devm:
172 * this routine may be called from a workqueue, and not from
174 * If devm_ was used, the memory might never be freed on errors.
176 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
183 * allocate the array of pointers. The link-specific data is allocated
184 * as part of the first loop below and released with the auxiliary_device_uninit().
185 * If some links are disabled, the link pointer will remain NULL. Given that the
186 * number of links is small, this is simpler than using a list to keep track of links.
188 ctx->ldev = kcalloc(ctx->count, sizeof(*ctx->ldev), GFP_KERNEL);
194 ctx->mmio_base = res->mmio_base;
195 ctx->shim_base = res->shim_base;
196 ctx->alh_base = res->alh_base;
197 ctx->link_mask = res->link_mask;
198 ctx->handle = res->handle;
199 mutex_init(&ctx->shim_lock);
201 link_mask = ctx->link_mask;
203 INIT_LIST_HEAD(&ctx->link_list);
205 for (i = 0; i < count; i++) {
206 if (!(link_mask & BIT(i)))
210 * init and add a device for each link
212 * The name of the device will be soundwire_intel.link.[i],
213 * with the "soundwire_intel" module prefix automatically added
214 * by the auxiliary bus core.
216 ldev = intel_link_dev_register(res,
218 acpi_fwnode_handle(adev),
224 link = &ldev->link_res;
225 link->cdns = auxiliary_get_drvdata(&ldev->auxdev);
228 dev_err(&adev->dev, "failed to get link->cdns\n");
230 * 1 will be subtracted from i in the err label, but we need to call
231 * intel_link_dev_unregister for this ldev, so plus 1 now
236 list_add_tail(&link->list, &ctx->link_list);
237 bus = &link->cdns->bus;
238 /* Calculate number of slaves */
239 list_for_each(node, &bus->slaves)
243 ctx->ids = kcalloc(num_slaves, sizeof(*ctx->ids), GFP_KERNEL);
247 ctx->num_slaves = num_slaves;
249 list_for_each_entry(link, &ctx->link_list, list) {
250 bus = &link->cdns->bus;
251 list_for_each_entry(slave, &bus->slaves, node) {
252 ctx->ids[i].id = slave->id;
253 ctx->ids[i].link_id = bus->link_id;
262 if (!(link_mask & BIT(i)))
265 intel_link_dev_unregister(ldev);
273 sdw_intel_startup_controller(struct sdw_intel_ctx *ctx)
275 struct acpi_device *adev = acpi_fetch_acpi_dev(ctx->handle);
276 struct sdw_intel_link_dev *ldev;
286 link_mask = ctx->link_mask;
288 /* Startup SDW Master devices */
289 for (i = 0; i < ctx->count; i++) {
290 if (!(link_mask & BIT(i)))
295 intel_link_startup(&ldev->auxdev);
297 if (!ldev->link_res.clock_stop_quirks) {
299 * we need to prevent the parent PCI device
300 * from entering pm_runtime suspend, so that
301 * power rails to the SoundWire IP are not
304 pm_runtime_get_noresume(ldev->link_res.dev);
312 * sdw_intel_probe() - SoundWire Intel probe routine
313 * @res: resource data
315 * This registers an auxiliary device for each Master handled by the controller,
316 * and SoundWire Master and Slave devices will be created by the auxiliary
317 * device probe. All the information necessary is stored in the context, and
318 * the res argument pointer can be freed after this step.
319 * This function will be called after sdw_intel_acpi_scan() by SOF probe.
322 *sdw_intel_probe(struct sdw_intel_res *res)
324 return sdw_intel_probe_controller(res);
326 EXPORT_SYMBOL_NS(sdw_intel_probe, SOUNDWIRE_INTEL_INIT);
329 * sdw_intel_startup() - SoundWire Intel startup
330 * @ctx: SoundWire context allocated in the probe
332 * Startup Intel SoundWire controller. This function will be called after
333 * Intel Audio DSP is powered up.
335 int sdw_intel_startup(struct sdw_intel_ctx *ctx)
337 return sdw_intel_startup_controller(ctx);
339 EXPORT_SYMBOL_NS(sdw_intel_startup, SOUNDWIRE_INTEL_INIT);
341 * sdw_intel_exit() - SoundWire Intel exit
342 * @ctx: SoundWire context allocated in the probe
344 * Delete the controller instances created and cleanup
346 void sdw_intel_exit(struct sdw_intel_ctx *ctx)
348 sdw_intel_cleanup(ctx);
353 EXPORT_SYMBOL_NS(sdw_intel_exit, SOUNDWIRE_INTEL_INIT);
355 void sdw_intel_process_wakeen_event(struct sdw_intel_ctx *ctx)
357 struct sdw_intel_link_dev *ldev;
364 link_mask = ctx->link_mask;
366 /* Startup SDW Master devices */
367 for (i = 0; i < ctx->count; i++) {
368 if (!(link_mask & BIT(i)))
373 intel_link_process_wakeen_event(&ldev->auxdev);
376 EXPORT_SYMBOL_NS(sdw_intel_process_wakeen_event, SOUNDWIRE_INTEL_INIT);
378 MODULE_LICENSE("Dual BSD/GPL");
379 MODULE_DESCRIPTION("Intel Soundwire Init Library");