1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 // Copyright(c) 2015-22 Intel Corporation.
5 * Soundwire Intel Manager Driver
8 #include <linux/acpi.h>
9 #include <linux/debugfs.h>
10 #include <linux/delay.h>
11 #include <linux/module.h>
12 #include <linux/interrupt.h>
14 #include <linux/auxiliary_bus.h>
15 #include <sound/pcm_params.h>
16 #include <linux/pm_runtime.h>
17 #include <sound/soc.h>
18 #include <linux/soundwire/sdw_registers.h>
19 #include <linux/soundwire/sdw.h>
20 #include <linux/soundwire/sdw_intel.h>
21 #include "cadence_master.h"
24 #include "intel_auxdevice.h"
26 #define INTEL_MASTER_SUSPEND_DELAY_MS 3000
29 * debug/config flags for the Intel SoundWire Master.
31 * Since we may have multiple masters active, we can have up to 8
32 * flags reused in each byte, with master0 using the ls-byte, etc.
35 #define SDW_INTEL_MASTER_DISABLE_PM_RUNTIME BIT(0)
36 #define SDW_INTEL_MASTER_DISABLE_CLOCK_STOP BIT(1)
37 #define SDW_INTEL_MASTER_DISABLE_PM_RUNTIME_IDLE BIT(2)
38 #define SDW_INTEL_MASTER_DISABLE_MULTI_LINK BIT(3)
41 module_param_named(sdw_md_flags, md_flags, int, 0444);
42 MODULE_PARM_DESC(sdw_md_flags, "SoundWire Intel Master device flags (0x0 all off)");
44 struct wake_capable_part {
49 static struct wake_capable_part wake_capable_list[] = {
66 static bool is_wake_capable(struct sdw_slave *slave)
70 for (i = 0; i < ARRAY_SIZE(wake_capable_list); i++)
71 if (slave->id.part_id == wake_capable_list[i].part_id &&
72 slave->id.mfg_id == wake_capable_list[i].mfg_id)
77 static int generic_pre_bank_switch(struct sdw_bus *bus)
79 struct sdw_cdns *cdns = bus_to_cdns(bus);
80 struct sdw_intel *sdw = cdns_to_intel(cdns);
82 return sdw->link_res->hw_ops->pre_bank_switch(sdw);
85 static int generic_post_bank_switch(struct sdw_bus *bus)
87 struct sdw_cdns *cdns = bus_to_cdns(bus);
88 struct sdw_intel *sdw = cdns_to_intel(cdns);
90 return sdw->link_res->hw_ops->post_bank_switch(sdw);
93 static void generic_new_peripheral_assigned(struct sdw_bus *bus,
94 struct sdw_slave *slave,
97 struct sdw_cdns *cdns = bus_to_cdns(bus);
98 struct sdw_intel *sdw = cdns_to_intel(cdns);
101 bool wake_capable = slave->prop.wake_capable || is_wake_capable(slave);
104 dev_num_min = SDW_INTEL_DEV_NUM_IDA_MIN;
105 dev_num_max = SDW_MAX_DEVICES;
108 dev_num_max = SDW_INTEL_DEV_NUM_IDA_MIN - 1;
111 /* paranoia check, this should never happen */
112 if (dev_num < dev_num_min || dev_num > dev_num_max) {
113 dev_err(bus->dev, "%s: invalid dev_num %d, wake supported %d\n",
114 __func__, dev_num, slave->prop.wake_capable);
118 if (sdw->link_res->hw_ops->program_sdi && wake_capable)
119 sdw->link_res->hw_ops->program_sdi(sdw, dev_num);
122 static int sdw_master_read_intel_prop(struct sdw_bus *bus)
124 struct sdw_master_prop *prop = &bus->prop;
125 struct fwnode_handle *link;
129 /* Find master handle */
130 snprintf(name, sizeof(name),
131 "mipi-sdw-link-%d-subproperties", bus->link_id);
133 link = device_get_named_child_node(bus->dev, name);
135 dev_err(bus->dev, "Master node %s not found\n", name);
139 fwnode_property_read_u32(link,
140 "intel-sdw-ip-clock",
143 /* the values reported by BIOS are the 2x clock, not the bus clock */
144 prop->mclk_freq /= 2;
146 fwnode_property_read_u32(link,
150 if (quirk_mask & SDW_INTEL_QUIRK_MASK_BUS_DISABLE)
151 prop->hw_disabled = true;
153 prop->quirks = SDW_MASTER_QUIRKS_CLEAR_INITIAL_CLASH |
154 SDW_MASTER_QUIRKS_CLEAR_INITIAL_PARITY;
159 static int intel_prop_read(struct sdw_bus *bus)
161 /* Initialize with default handler to read all DisCo properties */
162 sdw_master_read_prop(bus);
164 /* read Intel-specific properties */
165 sdw_master_read_intel_prop(bus);
170 static DEFINE_IDA(intel_peripheral_ida);
172 static int intel_get_device_num_ida(struct sdw_bus *bus, struct sdw_slave *slave)
176 if (slave->prop.wake_capable || is_wake_capable(slave))
177 return ida_alloc_range(&intel_peripheral_ida,
178 SDW_INTEL_DEV_NUM_IDA_MIN, SDW_MAX_DEVICES,
181 bit = find_first_zero_bit(slave->bus->assigned, SDW_MAX_DEVICES);
182 if (bit == SDW_MAX_DEVICES)
188 static void intel_put_device_num_ida(struct sdw_bus *bus, struct sdw_slave *slave)
190 if (slave->prop.wake_capable || is_wake_capable(slave))
191 ida_free(&intel_peripheral_ida, slave->dev_num);
194 static struct sdw_master_ops sdw_intel_ops = {
195 .read_prop = intel_prop_read,
196 .override_adr = sdw_dmi_override_adr,
197 .xfer_msg = cdns_xfer_msg,
198 .xfer_msg_defer = cdns_xfer_msg_defer,
199 .set_bus_conf = cdns_bus_conf,
200 .pre_bank_switch = generic_pre_bank_switch,
201 .post_bank_switch = generic_post_bank_switch,
202 .read_ping_status = cdns_read_ping_status,
203 .get_device_num = intel_get_device_num_ida,
204 .put_device_num = intel_put_device_num_ida,
205 .new_peripheral_assigned = generic_new_peripheral_assigned,
209 * probe and init (aux_dev_id argument is required by function prototype but not used)
211 static int intel_link_probe(struct auxiliary_device *auxdev,
212 const struct auxiliary_device_id *aux_dev_id)
215 struct device *dev = &auxdev->dev;
216 struct sdw_intel_link_dev *ldev = auxiliary_dev_to_sdw_intel_link_dev(auxdev);
217 struct sdw_intel *sdw;
218 struct sdw_cdns *cdns;
222 sdw = devm_kzalloc(dev, sizeof(*sdw), GFP_KERNEL);
229 sdw->instance = auxdev->id;
230 sdw->link_res = &ldev->link_res;
232 cdns->registers = sdw->link_res->registers;
233 cdns->ip_offset = sdw->link_res->ip_offset;
234 cdns->instance = sdw->instance;
237 /* single controller for all SoundWire links */
238 bus->controller_id = 0;
240 bus->link_id = auxdev->id;
241 bus->clk_stop_timeout = 1;
243 sdw_cdns_probe(cdns);
246 bus->ops = &sdw_intel_ops;
248 /* set driver data, accessed by snd_soc_dai_get_drvdata() */
249 auxiliary_set_drvdata(auxdev, cdns);
251 /* use generic bandwidth allocation algorithm */
252 sdw->cdns.bus.compute_params = sdw_compute_params;
254 /* avoid resuming from pm_runtime suspend if it's not required */
255 dev_pm_set_driver_flags(dev, DPM_FLAG_SMART_SUSPEND);
257 ret = sdw_bus_master_add(bus, dev, dev->fwnode);
259 dev_err(dev, "sdw_bus_master_add fail: %d\n", ret);
263 if (bus->prop.hw_disabled)
265 "SoundWire master %d is disabled, will be ignored\n",
268 * Ignore BIOS err_threshold, it's a really bad idea when dealing
269 * with multiple hardware synchronized links
271 bus->prop.err_threshold = 0;
276 int intel_link_startup(struct auxiliary_device *auxdev)
278 struct device *dev = &auxdev->dev;
279 struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
280 struct sdw_intel *sdw = cdns_to_intel(cdns);
281 struct sdw_bus *bus = &cdns->bus;
284 u32 clock_stop_quirks;
287 if (bus->prop.hw_disabled) {
289 "SoundWire master %d is disabled, ignoring\n",
294 link_flags = md_flags >> (bus->link_id * 8);
295 multi_link = !(link_flags & SDW_INTEL_MASTER_DISABLE_MULTI_LINK);
297 dev_dbg(dev, "Multi-link is disabled\n");
300 * hardware-based synchronization is required regardless
301 * of the number of segments used by a stream: SSP-based
302 * synchronization is gated by gsync when the multi-master
305 bus->hw_sync_min_links = 1;
307 bus->multi_link = multi_link;
309 /* Initialize shim, controller */
310 ret = sdw_intel_link_power_up(sdw);
315 ret = sdw_intel_register_dai(sdw);
317 dev_err(dev, "DAI registration failed: %d\n", ret);
321 sdw_intel_debugfs_init(sdw);
323 /* Enable runtime PM */
324 if (!(link_flags & SDW_INTEL_MASTER_DISABLE_PM_RUNTIME)) {
325 pm_runtime_set_autosuspend_delay(dev,
326 INTEL_MASTER_SUSPEND_DELAY_MS);
327 pm_runtime_use_autosuspend(dev);
328 pm_runtime_mark_last_busy(dev);
330 pm_runtime_set_active(dev);
331 pm_runtime_enable(dev);
333 pm_runtime_resume(bus->dev);
337 ret = sdw_intel_start_bus(sdw);
339 dev_err(dev, "bus start failed: %d\n", ret);
343 clock_stop_quirks = sdw->link_res->clock_stop_quirks;
344 if (clock_stop_quirks & SDW_INTEL_CLK_STOP_NOT_ALLOWED) {
346 * To keep the clock running we need to prevent
347 * pm_runtime suspend from happening by increasing the
349 * This quirk is specified by the parent PCI device in
350 * case of specific latency requirements. It will have
351 * no effect if pm_runtime is disabled by the user via
352 * a module parameter for testing purposes.
354 pm_runtime_get_noresume(dev);
358 * The runtime PM status of Slave devices is "Unsupported"
359 * until they report as ATTACHED. If they don't, e.g. because
360 * there are no Slave devices populated or if the power-on is
361 * delayed or dependent on a power switch, the Master will
362 * remain active and prevent its parent from suspending.
364 * Conditionally force the pm_runtime core to re-evaluate the
365 * Master status in the absence of any Slave activity. A quirk
366 * is provided to e.g. deal with Slaves that may be powered on
367 * with a delay. A more complete solution would require the
368 * definition of Master properties.
370 if (!(link_flags & SDW_INTEL_MASTER_DISABLE_PM_RUNTIME_IDLE)) {
371 pm_runtime_mark_last_busy(bus->dev);
372 pm_runtime_mark_last_busy(dev);
373 pm_runtime_idle(dev);
376 sdw->startup_done = true;
380 if (!(link_flags & SDW_INTEL_MASTER_DISABLE_PM_RUNTIME))
381 pm_runtime_disable(dev);
383 sdw_intel_link_power_down(sdw);
388 static void intel_link_remove(struct auxiliary_device *auxdev)
390 struct sdw_cdns *cdns = auxiliary_get_drvdata(auxdev);
391 struct sdw_intel *sdw = cdns_to_intel(cdns);
392 struct sdw_bus *bus = &cdns->bus;
395 * Since pm_runtime is already disabled, we don't decrease
396 * the refcount when the clock_stop_quirk is
397 * SDW_INTEL_CLK_STOP_NOT_ALLOWED
399 if (!bus->prop.hw_disabled) {
400 sdw_intel_debugfs_exit(sdw);
401 sdw_cdns_enable_interrupt(cdns, false);
403 sdw_bus_master_delete(bus);
406 int intel_link_process_wakeen_event(struct auxiliary_device *auxdev)
408 struct device *dev = &auxdev->dev;
409 struct sdw_intel *sdw;
412 sdw = auxiliary_get_drvdata(auxdev);
413 bus = &sdw->cdns.bus;
415 if (bus->prop.hw_disabled || !sdw->startup_done) {
416 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
421 if (!sdw_intel_shim_check_wake(sdw))
424 /* disable WAKEEN interrupt ASAP to prevent interrupt flood */
425 sdw_intel_shim_wake(sdw, false);
428 * resume the Master, which will generate a bus reset and result in
429 * Slaves re-attaching and be re-enumerated. The SoundWire physical
430 * device which generated the wake will trigger an interrupt, which
431 * will in turn cause the corresponding Linux Slave device to be
432 * resumed and the Slave codec driver to check the status.
434 pm_request_resume(dev);
443 static int intel_resume_child_device(struct device *dev, void *data)
446 struct sdw_slave *slave = dev_to_sdw_dev(dev);
448 if (!slave->probed) {
449 dev_dbg(dev, "skipping device, no probed driver\n");
452 if (!slave->dev_num_sticky) {
453 dev_dbg(dev, "skipping device, never detected on bus\n");
457 ret = pm_request_resume(dev);
459 dev_err(dev, "%s: pm_request_resume failed: %d\n", __func__, ret);
466 static int __maybe_unused intel_pm_prepare(struct device *dev)
468 struct sdw_cdns *cdns = dev_get_drvdata(dev);
469 struct sdw_intel *sdw = cdns_to_intel(cdns);
470 struct sdw_bus *bus = &cdns->bus;
471 u32 clock_stop_quirks;
474 if (bus->prop.hw_disabled || !sdw->startup_done) {
475 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
480 clock_stop_quirks = sdw->link_res->clock_stop_quirks;
482 if (pm_runtime_suspended(dev) &&
483 pm_runtime_suspended(dev->parent) &&
484 ((clock_stop_quirks & SDW_INTEL_CLK_STOP_BUS_RESET) ||
485 !clock_stop_quirks)) {
487 * if we've enabled clock stop, and the parent is suspended, the SHIM registers
488 * are not accessible and the shim wake cannot be disabled.
489 * The only solution is to resume the entire bus to full power
493 * If any operation in this block fails, we keep going since we don't want
494 * to prevent system suspend from happening and errors should be recoverable
499 * first resume the device for this link. This will also by construction
500 * resume the PCI parent device.
502 ret = pm_request_resume(dev);
504 dev_err(dev, "%s: pm_request_resume failed: %d\n", __func__, ret);
509 * Continue resuming the entire bus (parent + child devices) to exit
510 * the clock stop mode. If there are no devices connected on this link
512 * The resume to full power could have been implemented with a .prepare
513 * step in SoundWire codec drivers. This would however require a lot
514 * of code to handle an Intel-specific corner case. It is simpler in
515 * practice to add a loop at the link level.
517 ret = device_for_each_child(bus->dev, NULL, intel_resume_child_device);
520 dev_err(dev, "%s: intel_resume_child_device failed: %d\n", __func__, ret);
526 static int __maybe_unused intel_suspend(struct device *dev)
528 struct sdw_cdns *cdns = dev_get_drvdata(dev);
529 struct sdw_intel *sdw = cdns_to_intel(cdns);
530 struct sdw_bus *bus = &cdns->bus;
531 u32 clock_stop_quirks;
534 if (bus->prop.hw_disabled || !sdw->startup_done) {
535 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
540 if (pm_runtime_suspended(dev)) {
541 dev_dbg(dev, "pm_runtime status: suspended\n");
543 clock_stop_quirks = sdw->link_res->clock_stop_quirks;
545 if ((clock_stop_quirks & SDW_INTEL_CLK_STOP_BUS_RESET) ||
546 !clock_stop_quirks) {
548 if (pm_runtime_suspended(dev->parent)) {
550 * paranoia check: this should not happen with the .prepare
551 * resume to full power
553 dev_err(dev, "%s: invalid config: parent is suspended\n", __func__);
555 sdw_intel_shim_wake(sdw, false);
562 ret = sdw_intel_stop_bus(sdw, false);
564 dev_err(dev, "%s: cannot stop bus: %d\n", __func__, ret);
571 static int __maybe_unused intel_suspend_runtime(struct device *dev)
573 struct sdw_cdns *cdns = dev_get_drvdata(dev);
574 struct sdw_intel *sdw = cdns_to_intel(cdns);
575 struct sdw_bus *bus = &cdns->bus;
576 u32 clock_stop_quirks;
579 if (bus->prop.hw_disabled || !sdw->startup_done) {
580 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
585 clock_stop_quirks = sdw->link_res->clock_stop_quirks;
587 if (clock_stop_quirks & SDW_INTEL_CLK_STOP_TEARDOWN) {
588 ret = sdw_intel_stop_bus(sdw, false);
590 dev_err(dev, "%s: cannot stop bus during teardown: %d\n",
594 } else if (clock_stop_quirks & SDW_INTEL_CLK_STOP_BUS_RESET || !clock_stop_quirks) {
595 ret = sdw_intel_stop_bus(sdw, true);
597 dev_err(dev, "%s: cannot stop bus during clock_stop: %d\n",
602 dev_err(dev, "%s clock_stop_quirks %x unsupported\n",
603 __func__, clock_stop_quirks);
610 static int __maybe_unused intel_resume(struct device *dev)
612 struct sdw_cdns *cdns = dev_get_drvdata(dev);
613 struct sdw_intel *sdw = cdns_to_intel(cdns);
614 struct sdw_bus *bus = &cdns->bus;
618 if (bus->prop.hw_disabled || !sdw->startup_done) {
619 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
624 link_flags = md_flags >> (bus->link_id * 8);
626 if (pm_runtime_suspended(dev)) {
627 dev_dbg(dev, "pm_runtime status was suspended, forcing active\n");
629 /* follow required sequence from runtime_pm.rst */
630 pm_runtime_disable(dev);
631 pm_runtime_set_active(dev);
632 pm_runtime_mark_last_busy(dev);
633 pm_runtime_enable(dev);
635 pm_runtime_resume(bus->dev);
637 link_flags = md_flags >> (bus->link_id * 8);
639 if (!(link_flags & SDW_INTEL_MASTER_DISABLE_PM_RUNTIME_IDLE))
640 pm_runtime_idle(dev);
643 ret = sdw_intel_link_power_up(sdw);
645 dev_err(dev, "%s failed: %d\n", __func__, ret);
650 * make sure all Slaves are tagged as UNATTACHED and provide
651 * reason for reinitialization
653 sdw_clear_slave_status(bus, SDW_UNATTACH_REQUEST_MASTER_RESET);
655 ret = sdw_intel_start_bus(sdw);
657 dev_err(dev, "cannot start bus during resume\n");
658 sdw_intel_link_power_down(sdw);
663 * after system resume, the pm_runtime suspend() may kick in
664 * during the enumeration, before any children device force the
665 * master device to remain active. Using pm_runtime_get()
666 * routines is not really possible, since it'd prevent the
667 * master from suspending.
668 * A reasonable compromise is to update the pm_runtime
669 * counters and delay the pm_runtime suspend by several
670 * seconds, by when all enumeration should be complete.
672 pm_runtime_mark_last_busy(bus->dev);
673 pm_runtime_mark_last_busy(dev);
678 static int __maybe_unused intel_resume_runtime(struct device *dev)
680 struct sdw_cdns *cdns = dev_get_drvdata(dev);
681 struct sdw_intel *sdw = cdns_to_intel(cdns);
682 struct sdw_bus *bus = &cdns->bus;
683 u32 clock_stop_quirks;
686 if (bus->prop.hw_disabled || !sdw->startup_done) {
687 dev_dbg(dev, "SoundWire master %d is disabled or not-started, ignoring\n",
692 /* unconditionally disable WAKEEN interrupt */
693 sdw_intel_shim_wake(sdw, false);
695 clock_stop_quirks = sdw->link_res->clock_stop_quirks;
697 if (clock_stop_quirks & SDW_INTEL_CLK_STOP_TEARDOWN) {
698 ret = sdw_intel_link_power_up(sdw);
700 dev_err(dev, "%s: power_up failed after teardown: %d\n", __func__, ret);
705 * make sure all Slaves are tagged as UNATTACHED and provide
706 * reason for reinitialization
708 sdw_clear_slave_status(bus, SDW_UNATTACH_REQUEST_MASTER_RESET);
710 ret = sdw_intel_start_bus(sdw);
712 dev_err(dev, "%s: cannot start bus after teardown: %d\n", __func__, ret);
713 sdw_intel_link_power_down(sdw);
717 } else if (clock_stop_quirks & SDW_INTEL_CLK_STOP_BUS_RESET) {
718 ret = sdw_intel_link_power_up(sdw);
720 dev_err(dev, "%s: power_up failed after bus reset: %d\n", __func__, ret);
724 ret = sdw_intel_start_bus_after_reset(sdw);
726 dev_err(dev, "%s: cannot start bus after reset: %d\n", __func__, ret);
727 sdw_intel_link_power_down(sdw);
730 } else if (!clock_stop_quirks) {
732 sdw_intel_check_clock_stop(sdw);
734 ret = sdw_intel_link_power_up(sdw);
736 dev_err(dev, "%s: power_up failed: %d\n", __func__, ret);
740 ret = sdw_intel_start_bus_after_clock_stop(sdw);
742 dev_err(dev, "%s: cannot start bus after clock stop: %d\n", __func__, ret);
743 sdw_intel_link_power_down(sdw);
747 dev_err(dev, "%s: clock_stop_quirks %x unsupported\n",
748 __func__, clock_stop_quirks);
755 static const struct dev_pm_ops intel_pm = {
756 .prepare = intel_pm_prepare,
757 SET_SYSTEM_SLEEP_PM_OPS(intel_suspend, intel_resume)
758 SET_RUNTIME_PM_OPS(intel_suspend_runtime, intel_resume_runtime, NULL)
761 static const struct auxiliary_device_id intel_link_id_table[] = {
762 { .name = "soundwire_intel.link" },
765 MODULE_DEVICE_TABLE(auxiliary, intel_link_id_table);
767 static struct auxiliary_driver sdw_intel_drv = {
768 .probe = intel_link_probe,
769 .remove = intel_link_remove,
771 /* auxiliary_driver_register() sets .name to be the modname */
774 .id_table = intel_link_id_table
776 module_auxiliary_driver(sdw_intel_drv);
778 MODULE_LICENSE("Dual BSD/GPL");
779 MODULE_DESCRIPTION("Intel Soundwire Link Driver");