xref: /OK3568_Linux_fs/kernel/drivers/soundwire/slave.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2*4882a593Smuzhiyun // Copyright(c) 2015-17 Intel Corporation.
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun #include <linux/acpi.h>
5*4882a593Smuzhiyun #include <linux/of.h>
6*4882a593Smuzhiyun #include <linux/soundwire/sdw.h>
7*4882a593Smuzhiyun #include <linux/soundwire/sdw_type.h>
8*4882a593Smuzhiyun #include "bus.h"
9*4882a593Smuzhiyun #include "sysfs_local.h"
10*4882a593Smuzhiyun 
sdw_slave_release(struct device * dev)11*4882a593Smuzhiyun static void sdw_slave_release(struct device *dev)
12*4882a593Smuzhiyun {
13*4882a593Smuzhiyun 	struct sdw_slave *slave = dev_to_sdw_dev(dev);
14*4882a593Smuzhiyun 
15*4882a593Smuzhiyun 	kfree(slave);
16*4882a593Smuzhiyun }
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun struct device_type sdw_slave_type = {
19*4882a593Smuzhiyun 	.name =		"sdw_slave",
20*4882a593Smuzhiyun 	.release =	sdw_slave_release,
21*4882a593Smuzhiyun 	.uevent =	sdw_slave_uevent,
22*4882a593Smuzhiyun };
23*4882a593Smuzhiyun 
sdw_slave_add(struct sdw_bus * bus,struct sdw_slave_id * id,struct fwnode_handle * fwnode)24*4882a593Smuzhiyun int sdw_slave_add(struct sdw_bus *bus,
25*4882a593Smuzhiyun 		  struct sdw_slave_id *id, struct fwnode_handle *fwnode)
26*4882a593Smuzhiyun {
27*4882a593Smuzhiyun 	struct sdw_slave *slave;
28*4882a593Smuzhiyun 	int ret;
29*4882a593Smuzhiyun 	int i;
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun 	slave = kzalloc(sizeof(*slave), GFP_KERNEL);
32*4882a593Smuzhiyun 	if (!slave)
33*4882a593Smuzhiyun 		return -ENOMEM;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun 	/* Initialize data structure */
36*4882a593Smuzhiyun 	memcpy(&slave->id, id, sizeof(*id));
37*4882a593Smuzhiyun 	slave->dev.parent = bus->dev;
38*4882a593Smuzhiyun 	slave->dev.fwnode = fwnode;
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	if (id->unique_id == SDW_IGNORED_UNIQUE_ID) {
41*4882a593Smuzhiyun 		/* name shall be sdw:link:mfg:part:class */
42*4882a593Smuzhiyun 		dev_set_name(&slave->dev, "sdw:%x:%x:%x:%x",
43*4882a593Smuzhiyun 			     bus->link_id, id->mfg_id, id->part_id,
44*4882a593Smuzhiyun 			     id->class_id);
45*4882a593Smuzhiyun 	} else {
46*4882a593Smuzhiyun 		/* name shall be sdw:link:mfg:part:class:unique */
47*4882a593Smuzhiyun 		dev_set_name(&slave->dev, "sdw:%x:%x:%x:%x:%x",
48*4882a593Smuzhiyun 			     bus->link_id, id->mfg_id, id->part_id,
49*4882a593Smuzhiyun 			     id->class_id, id->unique_id);
50*4882a593Smuzhiyun 	}
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	slave->dev.bus = &sdw_bus_type;
53*4882a593Smuzhiyun 	slave->dev.of_node = of_node_get(to_of_node(fwnode));
54*4882a593Smuzhiyun 	slave->dev.type = &sdw_slave_type;
55*4882a593Smuzhiyun 	slave->dev.groups = sdw_slave_status_attr_groups;
56*4882a593Smuzhiyun 	slave->bus = bus;
57*4882a593Smuzhiyun 	slave->status = SDW_SLAVE_UNATTACHED;
58*4882a593Smuzhiyun 	init_completion(&slave->enumeration_complete);
59*4882a593Smuzhiyun 	init_completion(&slave->initialization_complete);
60*4882a593Smuzhiyun 	slave->dev_num = 0;
61*4882a593Smuzhiyun 	init_completion(&slave->probe_complete);
62*4882a593Smuzhiyun 	slave->probed = false;
63*4882a593Smuzhiyun 	slave->first_interrupt_done = false;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	for (i = 0; i < SDW_MAX_PORTS; i++)
66*4882a593Smuzhiyun 		init_completion(&slave->port_ready[i]);
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	mutex_lock(&bus->bus_lock);
69*4882a593Smuzhiyun 	list_add_tail(&slave->node, &bus->slaves);
70*4882a593Smuzhiyun 	mutex_unlock(&bus->bus_lock);
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	ret = device_register(&slave->dev);
73*4882a593Smuzhiyun 	if (ret) {
74*4882a593Smuzhiyun 		dev_err(bus->dev, "Failed to add slave: ret %d\n", ret);
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 		/*
77*4882a593Smuzhiyun 		 * On err, don't free but drop ref as this will be freed
78*4882a593Smuzhiyun 		 * when release method is invoked.
79*4882a593Smuzhiyun 		 */
80*4882a593Smuzhiyun 		mutex_lock(&bus->bus_lock);
81*4882a593Smuzhiyun 		list_del(&slave->node);
82*4882a593Smuzhiyun 		mutex_unlock(&bus->bus_lock);
83*4882a593Smuzhiyun 		put_device(&slave->dev);
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 		return ret;
86*4882a593Smuzhiyun 	}
87*4882a593Smuzhiyun 	sdw_slave_debugfs_init(slave);
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun 	return ret;
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_ACPI)
93*4882a593Smuzhiyun 
find_slave(struct sdw_bus * bus,struct acpi_device * adev,struct sdw_slave_id * id)94*4882a593Smuzhiyun static bool find_slave(struct sdw_bus *bus,
95*4882a593Smuzhiyun 		       struct acpi_device *adev,
96*4882a593Smuzhiyun 		       struct sdw_slave_id *id)
97*4882a593Smuzhiyun {
98*4882a593Smuzhiyun 	unsigned long long addr;
99*4882a593Smuzhiyun 	unsigned int link_id;
100*4882a593Smuzhiyun 	acpi_status status;
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun 	status = acpi_evaluate_integer(adev->handle,
103*4882a593Smuzhiyun 				       METHOD_NAME__ADR, NULL, &addr);
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun 	if (ACPI_FAILURE(status)) {
106*4882a593Smuzhiyun 		dev_err(bus->dev, "_ADR resolution failed: %x\n",
107*4882a593Smuzhiyun 			status);
108*4882a593Smuzhiyun 		return false;
109*4882a593Smuzhiyun 	}
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun 	/* Extract link id from ADR, Bit 51 to 48 (included) */
112*4882a593Smuzhiyun 	link_id = SDW_DISCO_LINK_ID(addr);
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun 	/* Check for link_id match */
115*4882a593Smuzhiyun 	if (link_id != bus->link_id)
116*4882a593Smuzhiyun 		return false;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 	sdw_extract_slave_id(bus, addr, id);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	return true;
121*4882a593Smuzhiyun }
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun /*
124*4882a593Smuzhiyun  * sdw_acpi_find_slaves() - Find Slave devices in Master ACPI node
125*4882a593Smuzhiyun  * @bus: SDW bus instance
126*4882a593Smuzhiyun  *
127*4882a593Smuzhiyun  * Scans Master ACPI node for SDW child Slave devices and registers it.
128*4882a593Smuzhiyun  */
sdw_acpi_find_slaves(struct sdw_bus * bus)129*4882a593Smuzhiyun int sdw_acpi_find_slaves(struct sdw_bus *bus)
130*4882a593Smuzhiyun {
131*4882a593Smuzhiyun 	struct acpi_device *adev, *parent;
132*4882a593Smuzhiyun 	struct acpi_device *adev2, *parent2;
133*4882a593Smuzhiyun 
134*4882a593Smuzhiyun 	parent = ACPI_COMPANION(bus->dev);
135*4882a593Smuzhiyun 	if (!parent) {
136*4882a593Smuzhiyun 		dev_err(bus->dev, "Can't find parent for acpi bind\n");
137*4882a593Smuzhiyun 		return -ENODEV;
138*4882a593Smuzhiyun 	}
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	list_for_each_entry(adev, &parent->children, node) {
141*4882a593Smuzhiyun 		struct sdw_slave_id id;
142*4882a593Smuzhiyun 		struct sdw_slave_id id2;
143*4882a593Smuzhiyun 		bool ignore_unique_id = true;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 		if (!find_slave(bus, adev, &id))
146*4882a593Smuzhiyun 			continue;
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun 		/* brute-force O(N^2) search for duplicates */
149*4882a593Smuzhiyun 		parent2 = parent;
150*4882a593Smuzhiyun 		list_for_each_entry(adev2, &parent2->children, node) {
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 			if (adev == adev2)
153*4882a593Smuzhiyun 				continue;
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 			if (!find_slave(bus, adev2, &id2))
156*4882a593Smuzhiyun 				continue;
157*4882a593Smuzhiyun 
158*4882a593Smuzhiyun 			if (id.sdw_version != id2.sdw_version ||
159*4882a593Smuzhiyun 			    id.mfg_id != id2.mfg_id ||
160*4882a593Smuzhiyun 			    id.part_id != id2.part_id ||
161*4882a593Smuzhiyun 			    id.class_id != id2.class_id)
162*4882a593Smuzhiyun 				continue;
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 			if (id.unique_id != id2.unique_id) {
165*4882a593Smuzhiyun 				dev_dbg(bus->dev,
166*4882a593Smuzhiyun 					"Valid unique IDs %x %x for Slave mfg %x part %d\n",
167*4882a593Smuzhiyun 					id.unique_id, id2.unique_id,
168*4882a593Smuzhiyun 					id.mfg_id, id.part_id);
169*4882a593Smuzhiyun 				ignore_unique_id = false;
170*4882a593Smuzhiyun 			} else {
171*4882a593Smuzhiyun 				dev_err(bus->dev,
172*4882a593Smuzhiyun 					"Invalid unique IDs %x %x for Slave mfg %x part %d\n",
173*4882a593Smuzhiyun 					id.unique_id, id2.unique_id,
174*4882a593Smuzhiyun 					id.mfg_id, id.part_id);
175*4882a593Smuzhiyun 				return -ENODEV;
176*4882a593Smuzhiyun 			}
177*4882a593Smuzhiyun 		}
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun 		if (ignore_unique_id)
180*4882a593Smuzhiyun 			id.unique_id = SDW_IGNORED_UNIQUE_ID;
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 		/*
183*4882a593Smuzhiyun 		 * don't error check for sdw_slave_add as we want to continue
184*4882a593Smuzhiyun 		 * adding Slaves
185*4882a593Smuzhiyun 		 */
186*4882a593Smuzhiyun 		sdw_slave_add(bus, &id, acpi_fwnode_handle(adev));
187*4882a593Smuzhiyun 	}
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	return 0;
190*4882a593Smuzhiyun }
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun #endif
193*4882a593Smuzhiyun 
194*4882a593Smuzhiyun /*
195*4882a593Smuzhiyun  * sdw_of_find_slaves() - Find Slave devices in master device tree node
196*4882a593Smuzhiyun  * @bus: SDW bus instance
197*4882a593Smuzhiyun  *
198*4882a593Smuzhiyun  * Scans Master DT node for SDW child Slave devices and registers it.
199*4882a593Smuzhiyun  */
sdw_of_find_slaves(struct sdw_bus * bus)200*4882a593Smuzhiyun int sdw_of_find_slaves(struct sdw_bus *bus)
201*4882a593Smuzhiyun {
202*4882a593Smuzhiyun 	struct device *dev = bus->dev;
203*4882a593Smuzhiyun 	struct device_node *node;
204*4882a593Smuzhiyun 
205*4882a593Smuzhiyun 	for_each_child_of_node(bus->dev->of_node, node) {
206*4882a593Smuzhiyun 		int link_id, ret, len;
207*4882a593Smuzhiyun 		unsigned int sdw_version;
208*4882a593Smuzhiyun 		const char *compat = NULL;
209*4882a593Smuzhiyun 		struct sdw_slave_id id;
210*4882a593Smuzhiyun 		const __be32 *addr;
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 		compat = of_get_property(node, "compatible", NULL);
213*4882a593Smuzhiyun 		if (!compat)
214*4882a593Smuzhiyun 			continue;
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun 		ret = sscanf(compat, "sdw%01x%04hx%04hx%02hhx", &sdw_version,
217*4882a593Smuzhiyun 			     &id.mfg_id, &id.part_id, &id.class_id);
218*4882a593Smuzhiyun 
219*4882a593Smuzhiyun 		if (ret != 4) {
220*4882a593Smuzhiyun 			dev_err(dev, "Invalid compatible string found %s\n",
221*4882a593Smuzhiyun 				compat);
222*4882a593Smuzhiyun 			continue;
223*4882a593Smuzhiyun 		}
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 		addr = of_get_property(node, "reg", &len);
226*4882a593Smuzhiyun 		if (!addr || (len < 2 * sizeof(u32))) {
227*4882a593Smuzhiyun 			dev_err(dev, "Invalid Link and Instance ID\n");
228*4882a593Smuzhiyun 			continue;
229*4882a593Smuzhiyun 		}
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun 		link_id = be32_to_cpup(addr++);
232*4882a593Smuzhiyun 		id.unique_id = be32_to_cpup(addr);
233*4882a593Smuzhiyun 		id.sdw_version = sdw_version;
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun 		/* Check for link_id match */
236*4882a593Smuzhiyun 		if (link_id != bus->link_id)
237*4882a593Smuzhiyun 			continue;
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun 		sdw_slave_add(bus, &id, of_fwnode_handle(node));
240*4882a593Smuzhiyun 	}
241*4882a593Smuzhiyun 
242*4882a593Smuzhiyun 	return 0;
243*4882a593Smuzhiyun }
244