1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2 // Copyright(c) 2015-17 Intel Corporation.
4 #include <linux/acpi.h>
5 #include <linux/delay.h>
6 #include <linux/mod_devicetable.h>
7 #include <linux/pm_runtime.h>
8 #include <linux/soundwire/sdw_registers.h>
9 #include <linux/soundwire/sdw.h>
12 static DEFINE_IDA(sdw_ida);
14 static int sdw_get_id(struct sdw_bus *bus)
16 int rc = ida_alloc(&sdw_ida, GFP_KERNEL);
26 * sdw_bus_master_add() - add a bus Master instance
28 * @parent: parent device
29 * @fwnode: firmware node handle
31 * Initializes the bus instance, read properties and create child
34 int sdw_bus_master_add(struct sdw_bus *bus, struct device *parent,
35 struct fwnode_handle *fwnode)
37 struct sdw_master_prop *prop = NULL;
41 pr_err("SoundWire parent device is not set\n");
45 ret = sdw_get_id(bus);
47 dev_err(parent, "Failed to get bus id\n");
51 ret = sdw_master_device_add(bus, parent, fwnode);
53 dev_err(parent, "Failed to add master device at link %d\n",
59 dev_err(bus->dev, "SoundWire Bus ops are not set\n");
63 mutex_init(&bus->msg_lock);
64 mutex_init(&bus->bus_lock);
65 INIT_LIST_HEAD(&bus->slaves);
66 INIT_LIST_HEAD(&bus->m_rt_list);
69 * Initialize multi_link flag
70 * TODO: populate this flag by reading property from FW node
72 bus->multi_link = false;
73 if (bus->ops->read_prop) {
74 ret = bus->ops->read_prop(bus);
77 "Bus read properties failed:%d\n", ret);
82 sdw_bus_debugfs_init(bus);
85 * Device numbers in SoundWire are 0 through 15. Enumeration device
86 * number (0), Broadcast device number (15), Group numbers (12 and
87 * 13) and Master device number (14) are not used for assignment so
88 * mask these and other higher bits.
91 /* Set higher order bits */
92 *bus->assigned = ~GENMASK(SDW_BROADCAST_DEV_NUM, SDW_ENUM_DEV_NUM);
94 /* Set enumuration device number and broadcast device number */
95 set_bit(SDW_ENUM_DEV_NUM, bus->assigned);
96 set_bit(SDW_BROADCAST_DEV_NUM, bus->assigned);
98 /* Set group device numbers and master device number */
99 set_bit(SDW_GROUP12_DEV_NUM, bus->assigned);
100 set_bit(SDW_GROUP13_DEV_NUM, bus->assigned);
101 set_bit(SDW_MASTER_DEV_NUM, bus->assigned);
104 * SDW is an enumerable bus, but devices can be powered off. So,
105 * they won't be able to report as present.
107 * Create Slave devices based on Slaves described in
108 * the respective firmware (ACPI/DT)
110 if (IS_ENABLED(CONFIG_ACPI) && ACPI_HANDLE(bus->dev))
111 ret = sdw_acpi_find_slaves(bus);
112 else if (IS_ENABLED(CONFIG_OF) && bus->dev->of_node)
113 ret = sdw_of_find_slaves(bus);
115 ret = -ENOTSUPP; /* No ACPI/DT so error out */
118 dev_err(bus->dev, "Finding slaves failed:%d\n", ret);
123 * Initialize clock values based on Master properties. The max
124 * frequency is read from max_clk_freq property. Current assumption
125 * is that the bus will start at highest clock frequency when
128 * Default active bank will be 0 as out of reset the Slaves have
129 * to start with bank 0 (Table 40 of Spec)
132 bus->params.max_dr_freq = prop->max_clk_freq * SDW_DOUBLE_RATE_FACTOR;
133 bus->params.curr_dr_freq = bus->params.max_dr_freq;
134 bus->params.curr_bank = SDW_BANK0;
135 bus->params.next_bank = SDW_BANK1;
139 EXPORT_SYMBOL(sdw_bus_master_add);
141 static int sdw_delete_slave(struct device *dev, void *data)
143 struct sdw_slave *slave = dev_to_sdw_dev(dev);
144 struct sdw_bus *bus = slave->bus;
146 pm_runtime_disable(dev);
148 sdw_slave_debugfs_exit(slave);
150 mutex_lock(&bus->bus_lock);
152 if (slave->dev_num) /* clear dev_num if assigned */
153 clear_bit(slave->dev_num, bus->assigned);
155 list_del_init(&slave->node);
156 mutex_unlock(&bus->bus_lock);
158 device_unregister(dev);
163 * sdw_bus_master_delete() - delete the bus master instance
164 * @bus: bus to be deleted
166 * Remove the instance, delete the child devices.
168 void sdw_bus_master_delete(struct sdw_bus *bus)
170 device_for_each_child(bus->dev, NULL, sdw_delete_slave);
171 sdw_master_device_del(bus);
173 sdw_bus_debugfs_exit(bus);
174 ida_free(&sdw_ida, bus->id);
176 EXPORT_SYMBOL(sdw_bus_master_delete);
182 static inline int find_response_code(enum sdw_command_response resp)
188 case SDW_CMD_IGNORED:
191 case SDW_CMD_TIMEOUT:
199 static inline int do_transfer(struct sdw_bus *bus, struct sdw_msg *msg)
201 int retry = bus->prop.err_threshold;
202 enum sdw_command_response resp;
205 for (i = 0; i <= retry; i++) {
206 resp = bus->ops->xfer_msg(bus, msg);
207 ret = find_response_code(resp);
209 /* if cmd is ok or ignored return */
210 if (ret == 0 || ret == -ENODATA)
217 static inline int do_transfer_defer(struct sdw_bus *bus,
219 struct sdw_defer *defer)
221 int retry = bus->prop.err_threshold;
222 enum sdw_command_response resp;
226 defer->length = msg->len;
227 init_completion(&defer->complete);
229 for (i = 0; i <= retry; i++) {
230 resp = bus->ops->xfer_msg_defer(bus, msg, defer);
231 ret = find_response_code(resp);
232 /* if cmd is ok or ignored return */
233 if (ret == 0 || ret == -ENODATA)
240 static int sdw_reset_page(struct sdw_bus *bus, u16 dev_num)
242 int retry = bus->prop.err_threshold;
243 enum sdw_command_response resp;
246 for (i = 0; i <= retry; i++) {
247 resp = bus->ops->reset_page_addr(bus, dev_num);
248 ret = find_response_code(resp);
249 /* if cmd is ok or ignored return */
250 if (ret == 0 || ret == -ENODATA)
258 * sdw_transfer() - Synchronous transfer message to a SDW Slave device
260 * @msg: SDW message to be xfered
262 int sdw_transfer(struct sdw_bus *bus, struct sdw_msg *msg)
266 mutex_lock(&bus->msg_lock);
268 ret = do_transfer(bus, msg);
269 if (ret != 0 && ret != -ENODATA)
270 dev_err(bus->dev, "trf on Slave %d failed:%d\n",
274 sdw_reset_page(bus, msg->dev_num);
276 mutex_unlock(&bus->msg_lock);
282 * sdw_transfer_defer() - Asynchronously transfer message to a SDW Slave device
284 * @msg: SDW message to be xfered
285 * @defer: Defer block for signal completion
287 * Caller needs to hold the msg_lock lock while calling this
289 int sdw_transfer_defer(struct sdw_bus *bus, struct sdw_msg *msg,
290 struct sdw_defer *defer)
294 if (!bus->ops->xfer_msg_defer)
297 ret = do_transfer_defer(bus, msg, defer);
298 if (ret != 0 && ret != -ENODATA)
299 dev_err(bus->dev, "Defer trf on Slave %d failed:%d\n",
303 sdw_reset_page(bus, msg->dev_num);
308 int sdw_fill_msg(struct sdw_msg *msg, struct sdw_slave *slave,
309 u32 addr, size_t count, u16 dev_num, u8 flags, u8 *buf)
311 memset(msg, 0, sizeof(*msg));
312 msg->addr = addr; /* addr is 16 bit and truncated here */
314 msg->dev_num = dev_num;
318 if (addr < SDW_REG_NO_PAGE) /* no paging area */
321 if (addr >= SDW_REG_MAX) { /* illegal addr */
322 pr_err("SDW: Invalid address %x passed\n", addr);
326 if (addr < SDW_REG_OPTIONAL_PAGE) { /* 32k but no page */
327 if (slave && !slave->prop.paging_support)
329 /* no need for else as that will fall-through to paging */
332 /* paging mandatory */
333 if (dev_num == SDW_ENUM_DEV_NUM || dev_num == SDW_BROADCAST_DEV_NUM) {
334 pr_err("SDW: Invalid device for paging :%d\n", dev_num);
339 pr_err("SDW: No slave for paging addr\n");
343 if (!slave->prop.paging_support) {
345 "address %x needs paging but no support\n", addr);
349 msg->addr_page1 = (addr >> SDW_REG_SHIFT(SDW_SCP_ADDRPAGE1_MASK));
350 msg->addr_page2 = (addr >> SDW_REG_SHIFT(SDW_SCP_ADDRPAGE2_MASK));
351 msg->addr |= BIT(15);
358 * Read/Write IO functions.
359 * no_pm versions can only be called by the bus, e.g. while enumerating or
360 * handling suspend-resume sequences.
361 * all clients need to use the pm versions
365 sdw_nread_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
370 ret = sdw_fill_msg(&msg, slave, addr, count,
371 slave->dev_num, SDW_MSG_FLAG_READ, val);
375 return sdw_transfer(slave->bus, &msg);
379 sdw_nwrite_no_pm(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
384 ret = sdw_fill_msg(&msg, slave, addr, count,
385 slave->dev_num, SDW_MSG_FLAG_WRITE, val);
389 return sdw_transfer(slave->bus, &msg);
392 static int sdw_write_no_pm(struct sdw_slave *slave, u32 addr, u8 value)
394 return sdw_nwrite_no_pm(slave, addr, 1, &value);
398 sdw_bread_no_pm(struct sdw_bus *bus, u16 dev_num, u32 addr)
404 ret = sdw_fill_msg(&msg, NULL, addr, 1, dev_num,
405 SDW_MSG_FLAG_READ, &buf);
409 ret = sdw_transfer(bus, &msg);
417 sdw_bwrite_no_pm(struct sdw_bus *bus, u16 dev_num, u32 addr, u8 value)
422 ret = sdw_fill_msg(&msg, NULL, addr, 1, dev_num,
423 SDW_MSG_FLAG_WRITE, &value);
427 return sdw_transfer(bus, &msg);
431 sdw_read_no_pm(struct sdw_slave *slave, u32 addr)
436 ret = sdw_nread_no_pm(slave, addr, 1, &buf);
444 * sdw_nread() - Read "n" contiguous SDW Slave registers
446 * @addr: Register address
448 * @val: Buffer for values to be read
450 int sdw_nread(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
454 ret = pm_runtime_get_sync(slave->bus->dev);
455 if (ret < 0 && ret != -EACCES) {
456 pm_runtime_put_noidle(slave->bus->dev);
460 ret = sdw_nread_no_pm(slave, addr, count, val);
462 pm_runtime_mark_last_busy(slave->bus->dev);
463 pm_runtime_put(slave->bus->dev);
467 EXPORT_SYMBOL(sdw_nread);
470 * sdw_nwrite() - Write "n" contiguous SDW Slave registers
472 * @addr: Register address
474 * @val: Buffer for values to be read
476 int sdw_nwrite(struct sdw_slave *slave, u32 addr, size_t count, u8 *val)
480 ret = pm_runtime_get_sync(slave->bus->dev);
481 if (ret < 0 && ret != -EACCES) {
482 pm_runtime_put_noidle(slave->bus->dev);
486 ret = sdw_nwrite_no_pm(slave, addr, count, val);
488 pm_runtime_mark_last_busy(slave->bus->dev);
489 pm_runtime_put(slave->bus->dev);
493 EXPORT_SYMBOL(sdw_nwrite);
496 * sdw_read() - Read a SDW Slave register
498 * @addr: Register address
500 int sdw_read(struct sdw_slave *slave, u32 addr)
505 ret = sdw_nread(slave, addr, 1, &buf);
511 EXPORT_SYMBOL(sdw_read);
514 * sdw_write() - Write a SDW Slave register
516 * @addr: Register address
517 * @value: Register value
519 int sdw_write(struct sdw_slave *slave, u32 addr, u8 value)
521 return sdw_nwrite(slave, addr, 1, &value);
523 EXPORT_SYMBOL(sdw_write);
529 /* called with bus_lock held */
530 static struct sdw_slave *sdw_get_slave(struct sdw_bus *bus, int i)
532 struct sdw_slave *slave = NULL;
534 list_for_each_entry(slave, &bus->slaves, node) {
535 if (slave->dev_num == i)
542 static int sdw_compare_devid(struct sdw_slave *slave, struct sdw_slave_id id)
544 if (slave->id.mfg_id != id.mfg_id ||
545 slave->id.part_id != id.part_id ||
546 slave->id.class_id != id.class_id ||
547 (slave->id.unique_id != SDW_IGNORED_UNIQUE_ID &&
548 slave->id.unique_id != id.unique_id))
554 /* called with bus_lock held */
555 static int sdw_get_device_num(struct sdw_slave *slave)
559 bit = find_first_zero_bit(slave->bus->assigned, SDW_MAX_DEVICES);
560 if (bit == SDW_MAX_DEVICES) {
566 * Do not update dev_num in Slave data structure here,
567 * Update once program dev_num is successful
569 set_bit(bit, slave->bus->assigned);
575 static int sdw_assign_device_num(struct sdw_slave *slave)
578 bool new_device = false;
580 /* check first if device number is assigned, if so reuse that */
581 if (!slave->dev_num) {
582 if (!slave->dev_num_sticky) {
583 mutex_lock(&slave->bus->bus_lock);
584 dev_num = sdw_get_device_num(slave);
585 mutex_unlock(&slave->bus->bus_lock);
587 dev_err(slave->bus->dev, "Get dev_num failed: %d\n",
591 slave->dev_num = dev_num;
592 slave->dev_num_sticky = dev_num;
595 slave->dev_num = slave->dev_num_sticky;
600 dev_dbg(slave->bus->dev,
601 "Slave already registered, reusing dev_num:%d\n",
604 /* Clear the slave->dev_num to transfer message on device 0 */
605 dev_num = slave->dev_num;
608 ret = sdw_write_no_pm(slave, SDW_SCP_DEVNUMBER, dev_num);
610 dev_err(&slave->dev, "Program device_num %d failed: %d\n",
615 /* After xfer of msg, restore dev_num */
616 slave->dev_num = slave->dev_num_sticky;
621 void sdw_extract_slave_id(struct sdw_bus *bus,
622 u64 addr, struct sdw_slave_id *id)
624 dev_dbg(bus->dev, "SDW Slave Addr: %llx\n", addr);
626 id->sdw_version = SDW_VERSION(addr);
627 id->unique_id = SDW_UNIQUE_ID(addr);
628 id->mfg_id = SDW_MFG_ID(addr);
629 id->part_id = SDW_PART_ID(addr);
630 id->class_id = SDW_CLASS_ID(addr);
633 "SDW Slave class_id %x, part_id %x, mfg_id %x, unique_id %x, version %x\n",
634 id->class_id, id->part_id, id->mfg_id,
635 id->unique_id, id->sdw_version);
638 static int sdw_program_device_num(struct sdw_bus *bus)
640 u8 buf[SDW_NUM_DEV_ID_REGISTERS] = {0};
641 struct sdw_slave *slave, *_s;
642 struct sdw_slave_id id;
648 /* No Slave, so use raw xfer api */
649 ret = sdw_fill_msg(&msg, NULL, SDW_SCP_DEVID_0,
650 SDW_NUM_DEV_ID_REGISTERS, 0, SDW_MSG_FLAG_READ, buf);
655 ret = sdw_transfer(bus, &msg);
656 if (ret == -ENODATA) { /* end of device id reads */
657 dev_dbg(bus->dev, "No more devices to enumerate\n");
662 dev_err(bus->dev, "DEVID read fail:%d\n", ret);
667 * Construct the addr and extract. Cast the higher shift
668 * bits to avoid truncation due to size limit.
670 addr = buf[5] | (buf[4] << 8) | (buf[3] << 16) |
671 ((u64)buf[2] << 24) | ((u64)buf[1] << 32) |
674 sdw_extract_slave_id(bus, addr, &id);
676 /* Now compare with entries */
677 list_for_each_entry_safe(slave, _s, &bus->slaves, node) {
678 if (sdw_compare_devid(slave, id) == 0) {
682 * Assign a new dev_num to this Slave and
683 * not mark it present. It will be marked
684 * present after it reports ATTACHED on new
687 ret = sdw_assign_device_num(slave);
689 dev_err(slave->bus->dev,
690 "Assign dev_num failed:%d\n",
700 /* TODO: Park this device in Group 13 */
701 dev_err(bus->dev, "Slave Entry not found\n");
707 * Check till error out or retry (count) exhausts.
708 * Device can drop off and rejoin during enumeration
709 * so count till twice the bound.
712 } while (ret == 0 && count < (SDW_MAX_DEVICES * 2));
717 static void sdw_modify_slave_status(struct sdw_slave *slave,
718 enum sdw_slave_status status)
720 mutex_lock(&slave->bus->bus_lock);
722 dev_vdbg(&slave->dev,
723 "%s: changing status slave %d status %d new status %d\n",
724 __func__, slave->dev_num, slave->status, status);
726 if (status == SDW_SLAVE_UNATTACHED) {
728 "%s: initializing completion for Slave %d\n",
729 __func__, slave->dev_num);
731 init_completion(&slave->enumeration_complete);
732 init_completion(&slave->initialization_complete);
734 } else if ((status == SDW_SLAVE_ATTACHED) &&
735 (slave->status == SDW_SLAVE_UNATTACHED)) {
737 "%s: signaling completion for Slave %d\n",
738 __func__, slave->dev_num);
740 complete(&slave->enumeration_complete);
742 slave->status = status;
743 mutex_unlock(&slave->bus->bus_lock);
746 static enum sdw_clk_stop_mode sdw_get_clk_stop_mode(struct sdw_slave *slave)
748 enum sdw_clk_stop_mode mode;
751 * Query for clock stop mode if Slave implements
752 * ops->get_clk_stop_mode, else read from property.
754 if (slave->ops && slave->ops->get_clk_stop_mode) {
755 mode = slave->ops->get_clk_stop_mode(slave);
757 if (slave->prop.clk_stop_mode1)
758 mode = SDW_CLK_STOP_MODE1;
760 mode = SDW_CLK_STOP_MODE0;
766 static int sdw_slave_clk_stop_callback(struct sdw_slave *slave,
767 enum sdw_clk_stop_mode mode,
768 enum sdw_clk_stop_type type)
772 if (slave->ops && slave->ops->clk_stop) {
773 ret = slave->ops->clk_stop(slave, mode, type);
776 "Clk Stop type =%d failed: %d\n", type, ret);
784 static int sdw_slave_clk_stop_prepare(struct sdw_slave *slave,
785 enum sdw_clk_stop_mode mode,
792 wake_en = slave->prop.wake_capable;
795 val = SDW_SCP_SYSTEMCTRL_CLK_STP_PREP;
797 if (mode == SDW_CLK_STOP_MODE1)
798 val |= SDW_SCP_SYSTEMCTRL_CLK_STP_MODE1;
801 val |= SDW_SCP_SYSTEMCTRL_WAKE_UP_EN;
803 val = sdw_read_no_pm(slave, SDW_SCP_SYSTEMCTRL);
805 val &= ~(SDW_SCP_SYSTEMCTRL_CLK_STP_PREP);
808 ret = sdw_write_no_pm(slave, SDW_SCP_SYSTEMCTRL, val);
812 "Clock Stop prepare failed for slave: %d", ret);
817 static int sdw_bus_wait_for_clk_prep_deprep(struct sdw_bus *bus, u16 dev_num)
819 int retry = bus->clk_stop_timeout;
823 val = sdw_bread_no_pm(bus, dev_num, SDW_SCP_STAT) &
824 SDW_SCP_STAT_CLK_STP_NF;
826 dev_info(bus->dev, "clock stop prep/de-prep done slave:%d",
831 usleep_range(1000, 1500);
835 dev_err(bus->dev, "clock stop prep/de-prep failed slave:%d",
842 * sdw_bus_prep_clk_stop: prepare Slave(s) for clock stop
844 * @bus: SDW bus instance
846 * Query Slave for clock stop mode and prepare for that mode.
848 int sdw_bus_prep_clk_stop(struct sdw_bus *bus)
850 enum sdw_clk_stop_mode slave_mode;
851 bool simple_clk_stop = true;
852 struct sdw_slave *slave;
853 bool is_slave = false;
857 * In order to save on transition time, prepare
858 * each Slave and then wait for all Slave(s) to be
859 * prepared for clock stop.
861 list_for_each_entry(slave, &bus->slaves, node) {
865 /* Identify if Slave(s) are available on Bus */
868 if (slave->status != SDW_SLAVE_ATTACHED &&
869 slave->status != SDW_SLAVE_ALERT)
872 slave_mode = sdw_get_clk_stop_mode(slave);
873 slave->curr_clk_stop_mode = slave_mode;
875 ret = sdw_slave_clk_stop_callback(slave, slave_mode,
876 SDW_CLK_PRE_PREPARE);
879 "pre-prepare failed:%d", ret);
883 ret = sdw_slave_clk_stop_prepare(slave,
887 "pre-prepare failed:%d", ret);
891 if (slave_mode == SDW_CLK_STOP_MODE1)
892 simple_clk_stop = false;
895 if (is_slave && !simple_clk_stop) {
896 ret = sdw_bus_wait_for_clk_prep_deprep(bus,
897 SDW_BROADCAST_DEV_NUM);
902 /* Inform slaves that prep is done */
903 list_for_each_entry(slave, &bus->slaves, node) {
907 if (slave->status != SDW_SLAVE_ATTACHED &&
908 slave->status != SDW_SLAVE_ALERT)
911 slave_mode = slave->curr_clk_stop_mode;
913 if (slave_mode == SDW_CLK_STOP_MODE1) {
914 ret = sdw_slave_clk_stop_callback(slave,
916 SDW_CLK_POST_PREPARE);
920 "post-prepare failed:%d", ret);
927 EXPORT_SYMBOL(sdw_bus_prep_clk_stop);
930 * sdw_bus_clk_stop: stop bus clock
932 * @bus: SDW bus instance
934 * After preparing the Slaves for clock stop, stop the clock by broadcasting
935 * write to SCP_CTRL register.
937 int sdw_bus_clk_stop(struct sdw_bus *bus)
942 * broadcast clock stop now, attached Slaves will ACK this,
943 * unattached will ignore
945 ret = sdw_bwrite_no_pm(bus, SDW_BROADCAST_DEV_NUM,
946 SDW_SCP_CTRL, SDW_SCP_CTRL_CLK_STP_NOW);
950 "ClockStopNow Broadcast msg ignored %d", ret);
953 "ClockStopNow Broadcast msg failed %d", ret);
959 EXPORT_SYMBOL(sdw_bus_clk_stop);
962 * sdw_bus_exit_clk_stop: Exit clock stop mode
964 * @bus: SDW bus instance
966 * This De-prepares the Slaves by exiting Clock Stop Mode 0. For the Slaves
967 * exiting Clock Stop Mode 1, they will be de-prepared after they enumerate
970 int sdw_bus_exit_clk_stop(struct sdw_bus *bus)
972 enum sdw_clk_stop_mode mode;
973 bool simple_clk_stop = true;
974 struct sdw_slave *slave;
975 bool is_slave = false;
979 * In order to save on transition time, de-prepare
980 * each Slave and then wait for all Slave(s) to be
981 * de-prepared after clock resume.
983 list_for_each_entry(slave, &bus->slaves, node) {
987 /* Identify if Slave(s) are available on Bus */
990 if (slave->status != SDW_SLAVE_ATTACHED &&
991 slave->status != SDW_SLAVE_ALERT)
994 mode = slave->curr_clk_stop_mode;
996 if (mode == SDW_CLK_STOP_MODE1) {
997 simple_clk_stop = false;
1001 ret = sdw_slave_clk_stop_callback(slave, mode,
1002 SDW_CLK_PRE_DEPREPARE);
1004 dev_warn(&slave->dev,
1005 "clk stop deprep failed:%d", ret);
1007 ret = sdw_slave_clk_stop_prepare(slave, mode,
1011 dev_warn(&slave->dev,
1012 "clk stop deprep failed:%d", ret);
1015 if (is_slave && !simple_clk_stop)
1016 sdw_bus_wait_for_clk_prep_deprep(bus, SDW_BROADCAST_DEV_NUM);
1018 list_for_each_entry(slave, &bus->slaves, node) {
1019 if (!slave->dev_num)
1022 if (slave->status != SDW_SLAVE_ATTACHED &&
1023 slave->status != SDW_SLAVE_ALERT)
1026 mode = slave->curr_clk_stop_mode;
1027 sdw_slave_clk_stop_callback(slave, mode,
1028 SDW_CLK_POST_DEPREPARE);
1033 EXPORT_SYMBOL(sdw_bus_exit_clk_stop);
1035 int sdw_configure_dpn_intr(struct sdw_slave *slave,
1036 int port, bool enable, int mask)
1042 addr = SDW_DPN_INTMASK(port);
1044 /* Set/Clear port ready interrupt mask */
1047 val |= SDW_DPN_INT_PORT_READY;
1050 val &= ~SDW_DPN_INT_PORT_READY;
1053 ret = sdw_update(slave, addr, (mask | SDW_DPN_INT_PORT_READY), val);
1055 dev_err(slave->bus->dev,
1056 "SDW_DPN_INTMASK write failed:%d\n", val);
1061 static int sdw_initialize_slave(struct sdw_slave *slave)
1063 struct sdw_slave_prop *prop = &slave->prop;
1068 * Set bus clash, parity and SCP implementation
1069 * defined interrupt mask
1070 * TODO: Read implementation defined interrupt mask
1071 * from Slave property
1073 val = SDW_SCP_INT1_IMPL_DEF | SDW_SCP_INT1_BUS_CLASH |
1074 SDW_SCP_INT1_PARITY;
1076 /* Enable SCP interrupts */
1077 ret = sdw_update(slave, SDW_SCP_INTMASK1, val, val);
1079 dev_err(slave->bus->dev,
1080 "SDW_SCP_INTMASK1 write failed:%d\n", ret);
1084 /* No need to continue if DP0 is not present */
1085 if (!slave->prop.dp0_prop)
1088 /* Enable DP0 interrupts */
1089 val = prop->dp0_prop->imp_def_interrupts;
1090 val |= SDW_DP0_INT_PORT_READY | SDW_DP0_INT_BRA_FAILURE;
1092 ret = sdw_update(slave, SDW_DP0_INTMASK, val, val);
1094 dev_err(slave->bus->dev,
1095 "SDW_DP0_INTMASK read failed:%d\n", ret);
1099 static int sdw_handle_dp0_interrupt(struct sdw_slave *slave, u8 *slave_status)
1101 u8 clear = 0, impl_int_mask;
1102 int status, status2, ret, count = 0;
1104 status = sdw_read(slave, SDW_DP0_INT);
1106 dev_err(slave->bus->dev,
1107 "SDW_DP0_INT read failed:%d\n", status);
1112 if (status & SDW_DP0_INT_TEST_FAIL) {
1113 dev_err(&slave->dev, "Test fail for port 0\n");
1114 clear |= SDW_DP0_INT_TEST_FAIL;
1118 * Assumption: PORT_READY interrupt will be received only for
1119 * ports implementing Channel Prepare state machine (CP_SM)
1122 if (status & SDW_DP0_INT_PORT_READY) {
1123 complete(&slave->port_ready[0]);
1124 clear |= SDW_DP0_INT_PORT_READY;
1127 if (status & SDW_DP0_INT_BRA_FAILURE) {
1128 dev_err(&slave->dev, "BRA failed\n");
1129 clear |= SDW_DP0_INT_BRA_FAILURE;
1132 impl_int_mask = SDW_DP0_INT_IMPDEF1 |
1133 SDW_DP0_INT_IMPDEF2 | SDW_DP0_INT_IMPDEF3;
1135 if (status & impl_int_mask) {
1136 clear |= impl_int_mask;
1137 *slave_status = clear;
1140 /* clear the interrupt */
1141 ret = sdw_write(slave, SDW_DP0_INT, clear);
1143 dev_err(slave->bus->dev,
1144 "SDW_DP0_INT write failed:%d\n", ret);
1148 /* Read DP0 interrupt again */
1149 status2 = sdw_read(slave, SDW_DP0_INT);
1151 dev_err(slave->bus->dev,
1152 "SDW_DP0_INT read failed:%d\n", status2);
1159 /* we can get alerts while processing so keep retrying */
1160 } while (status != 0 && count < SDW_READ_INTR_CLEAR_RETRY);
1162 if (count == SDW_READ_INTR_CLEAR_RETRY)
1163 dev_warn(slave->bus->dev, "Reached MAX_RETRY on DP0 read\n");
1168 static int sdw_handle_port_interrupt(struct sdw_slave *slave,
1169 int port, u8 *slave_status)
1171 u8 clear = 0, impl_int_mask;
1172 int status, status2, ret, count = 0;
1176 return sdw_handle_dp0_interrupt(slave, slave_status);
1178 addr = SDW_DPN_INT(port);
1179 status = sdw_read(slave, addr);
1181 dev_err(slave->bus->dev,
1182 "SDW_DPN_INT read failed:%d\n", status);
1188 if (status & SDW_DPN_INT_TEST_FAIL) {
1189 dev_err(&slave->dev, "Test fail for port:%d\n", port);
1190 clear |= SDW_DPN_INT_TEST_FAIL;
1194 * Assumption: PORT_READY interrupt will be received only
1195 * for ports implementing CP_SM.
1197 if (status & SDW_DPN_INT_PORT_READY) {
1198 complete(&slave->port_ready[port]);
1199 clear |= SDW_DPN_INT_PORT_READY;
1202 impl_int_mask = SDW_DPN_INT_IMPDEF1 |
1203 SDW_DPN_INT_IMPDEF2 | SDW_DPN_INT_IMPDEF3;
1205 if (status & impl_int_mask) {
1206 clear |= impl_int_mask;
1207 *slave_status = clear;
1210 /* clear the interrupt */
1211 ret = sdw_write(slave, addr, clear);
1213 dev_err(slave->bus->dev,
1214 "SDW_DPN_INT write failed:%d\n", ret);
1218 /* Read DPN interrupt again */
1219 status2 = sdw_read(slave, addr);
1221 dev_err(slave->bus->dev,
1222 "SDW_DPN_INT read failed:%d\n", status2);
1229 /* we can get alerts while processing so keep retrying */
1230 } while (status != 0 && count < SDW_READ_INTR_CLEAR_RETRY);
1232 if (count == SDW_READ_INTR_CLEAR_RETRY)
1233 dev_warn(slave->bus->dev, "Reached MAX_RETRY on port read");
1238 static int sdw_handle_slave_alerts(struct sdw_slave *slave)
1240 struct sdw_slave_intr_status slave_intr;
1241 u8 clear = 0, bit, port_status[15] = {0};
1242 int port_num, stat, ret, count = 0;
1244 bool slave_notify = false;
1245 u8 buf, buf2[2], _buf, _buf2[2];
1247 sdw_modify_slave_status(slave, SDW_SLAVE_ALERT);
1249 ret = pm_runtime_get_sync(&slave->dev);
1250 if (ret < 0 && ret != -EACCES) {
1251 dev_err(&slave->dev, "Failed to resume device: %d\n", ret);
1252 pm_runtime_put_noidle(slave->bus->dev);
1256 /* Read Instat 1, Instat 2 and Instat 3 registers */
1257 ret = sdw_read(slave, SDW_SCP_INT1);
1259 dev_err(slave->bus->dev,
1260 "SDW_SCP_INT1 read failed:%d\n", ret);
1265 ret = sdw_nread(slave, SDW_SCP_INTSTAT2, 2, buf2);
1267 dev_err(slave->bus->dev,
1268 "SDW_SCP_INT2/3 read failed:%d\n", ret);
1274 * Check parity, bus clash and Slave (impl defined)
1277 if (buf & SDW_SCP_INT1_PARITY) {
1278 dev_err(&slave->dev, "Parity error detected\n");
1279 clear |= SDW_SCP_INT1_PARITY;
1282 if (buf & SDW_SCP_INT1_BUS_CLASH) {
1283 dev_err(&slave->dev, "Bus clash error detected\n");
1284 clear |= SDW_SCP_INT1_BUS_CLASH;
1288 * When bus clash or parity errors are detected, such errors
1289 * are unlikely to be recoverable errors.
1290 * TODO: In such scenario, reset bus. Make this configurable
1291 * via sysfs property with bus reset being the default.
1294 if (buf & SDW_SCP_INT1_IMPL_DEF) {
1295 dev_dbg(&slave->dev, "Slave impl defined interrupt\n");
1296 clear |= SDW_SCP_INT1_IMPL_DEF;
1297 slave_notify = true;
1300 /* Check port 0 - 3 interrupts */
1301 port = buf & SDW_SCP_INT1_PORT0_3;
1303 /* To get port number corresponding to bits, shift it */
1304 port = port >> SDW_REG_SHIFT(SDW_SCP_INT1_PORT0_3);
1305 for_each_set_bit(bit, &port, 8) {
1306 sdw_handle_port_interrupt(slave, bit,
1310 /* Check if cascade 2 interrupt is present */
1311 if (buf & SDW_SCP_INT1_SCP2_CASCADE) {
1312 port = buf2[0] & SDW_SCP_INTSTAT2_PORT4_10;
1313 for_each_set_bit(bit, &port, 8) {
1314 /* scp2 ports start from 4 */
1316 sdw_handle_port_interrupt(slave,
1318 &port_status[port_num]);
1322 /* now check last cascade */
1323 if (buf2[0] & SDW_SCP_INTSTAT2_SCP3_CASCADE) {
1324 port = buf2[1] & SDW_SCP_INTSTAT3_PORT11_14;
1325 for_each_set_bit(bit, &port, 8) {
1326 /* scp3 ports start from 11 */
1327 port_num = bit + 10;
1328 sdw_handle_port_interrupt(slave,
1330 &port_status[port_num]);
1334 /* Update the Slave driver */
1335 if (slave_notify && slave->ops &&
1336 slave->ops->interrupt_callback) {
1337 slave_intr.control_port = clear;
1338 memcpy(slave_intr.port, &port_status,
1339 sizeof(slave_intr.port));
1341 slave->ops->interrupt_callback(slave, &slave_intr);
1345 ret = sdw_write(slave, SDW_SCP_INT1, clear);
1347 dev_err(slave->bus->dev,
1348 "SDW_SCP_INT1 write failed:%d\n", ret);
1353 * Read status again to ensure no new interrupts arrived
1354 * while servicing interrupts.
1356 ret = sdw_read(slave, SDW_SCP_INT1);
1358 dev_err(slave->bus->dev,
1359 "SDW_SCP_INT1 read failed:%d\n", ret);
1364 ret = sdw_nread(slave, SDW_SCP_INTSTAT2, 2, _buf2);
1366 dev_err(slave->bus->dev,
1367 "SDW_SCP_INT2/3 read failed:%d\n", ret);
1371 /* Make sure no interrupts are pending */
1373 buf2[0] &= _buf2[0];
1374 buf2[1] &= _buf2[1];
1375 stat = buf || buf2[0] || buf2[1];
1378 * Exit loop if Slave is continuously in ALERT state even
1379 * after servicing the interrupt multiple times.
1383 /* we can get alerts while processing so keep retrying */
1384 } while (stat != 0 && count < SDW_READ_INTR_CLEAR_RETRY);
1386 if (count == SDW_READ_INTR_CLEAR_RETRY)
1387 dev_warn(slave->bus->dev, "Reached MAX_RETRY on alert read\n");
1390 pm_runtime_mark_last_busy(&slave->dev);
1391 pm_runtime_put_autosuspend(&slave->dev);
1396 static int sdw_update_slave_status(struct sdw_slave *slave,
1397 enum sdw_slave_status status)
1401 if (!slave->probed) {
1403 * the slave status update is typically handled in an
1404 * interrupt thread, which can race with the driver
1405 * probe, e.g. when a module needs to be loaded.
1407 * make sure the probe is complete before updating
1410 time = wait_for_completion_timeout(&slave->probe_complete,
1411 msecs_to_jiffies(DEFAULT_PROBE_TIMEOUT));
1413 dev_err(&slave->dev, "Probe not complete, timed out\n");
1418 if (!slave->ops || !slave->ops->update_status)
1421 return slave->ops->update_status(slave, status);
1425 * sdw_handle_slave_status() - Handle Slave status
1426 * @bus: SDW bus instance
1427 * @status: Status for all Slave(s)
1429 int sdw_handle_slave_status(struct sdw_bus *bus,
1430 enum sdw_slave_status status[])
1432 enum sdw_slave_status prev_status;
1433 struct sdw_slave *slave;
1434 bool attached_initializing;
1437 /* first check if any Slaves fell off the bus */
1438 for (i = 1; i <= SDW_MAX_DEVICES; i++) {
1439 mutex_lock(&bus->bus_lock);
1440 if (test_bit(i, bus->assigned) == false) {
1441 mutex_unlock(&bus->bus_lock);
1444 mutex_unlock(&bus->bus_lock);
1446 slave = sdw_get_slave(bus, i);
1450 if (status[i] == SDW_SLAVE_UNATTACHED &&
1451 slave->status != SDW_SLAVE_UNATTACHED)
1452 sdw_modify_slave_status(slave, SDW_SLAVE_UNATTACHED);
1455 if (status[0] == SDW_SLAVE_ATTACHED) {
1456 dev_dbg(bus->dev, "Slave attached, programming device number\n");
1457 ret = sdw_program_device_num(bus);
1459 dev_err(bus->dev, "Slave attach failed: %d\n", ret);
1461 * programming a device number will have side effects,
1462 * so we deal with other devices at a later time
1467 /* Continue to check other slave statuses */
1468 for (i = 1; i <= SDW_MAX_DEVICES; i++) {
1469 mutex_lock(&bus->bus_lock);
1470 if (test_bit(i, bus->assigned) == false) {
1471 mutex_unlock(&bus->bus_lock);
1474 mutex_unlock(&bus->bus_lock);
1476 slave = sdw_get_slave(bus, i);
1480 attached_initializing = false;
1482 switch (status[i]) {
1483 case SDW_SLAVE_UNATTACHED:
1484 if (slave->status == SDW_SLAVE_UNATTACHED)
1487 sdw_modify_slave_status(slave, SDW_SLAVE_UNATTACHED);
1490 case SDW_SLAVE_ALERT:
1491 ret = sdw_handle_slave_alerts(slave);
1494 "Slave %d alert handling failed: %d\n",
1498 case SDW_SLAVE_ATTACHED:
1499 if (slave->status == SDW_SLAVE_ATTACHED)
1502 prev_status = slave->status;
1503 sdw_modify_slave_status(slave, SDW_SLAVE_ATTACHED);
1505 if (prev_status == SDW_SLAVE_ALERT)
1508 attached_initializing = true;
1510 ret = sdw_initialize_slave(slave);
1513 "Slave %d initialization failed: %d\n",
1519 dev_err(bus->dev, "Invalid slave %d status:%d\n",
1524 ret = sdw_update_slave_status(slave, status[i]);
1526 dev_err(slave->bus->dev,
1527 "Update Slave status failed:%d\n", ret);
1528 if (attached_initializing)
1529 complete(&slave->initialization_complete);
1534 EXPORT_SYMBOL(sdw_handle_slave_status);
1536 void sdw_clear_slave_status(struct sdw_bus *bus, u32 request)
1538 struct sdw_slave *slave;
1541 /* Check all non-zero devices */
1542 for (i = 1; i <= SDW_MAX_DEVICES; i++) {
1543 mutex_lock(&bus->bus_lock);
1544 if (test_bit(i, bus->assigned) == false) {
1545 mutex_unlock(&bus->bus_lock);
1548 mutex_unlock(&bus->bus_lock);
1550 slave = sdw_get_slave(bus, i);
1554 if (slave->status != SDW_SLAVE_UNATTACHED)
1555 sdw_modify_slave_status(slave, SDW_SLAVE_UNATTACHED);
1557 /* keep track of request, used in pm_runtime resume */
1558 slave->unattach_request = request;
1561 EXPORT_SYMBOL(sdw_clear_slave_status);