1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2012, The Linux Foundation. All rights reserved.
6 #include <linux/acpi.h>
7 #include <linux/types.h>
9 #include <linux/slab.h>
10 #include <linux/clk.h>
12 #include <linux/of_address.h>
13 #include <linux/of_graph.h>
14 #include <linux/of_platform.h>
15 #include <linux/platform_device.h>
16 #include <linux/amba/bus.h>
17 #include <linux/coresight.h>
18 #include <linux/cpumask.h>
19 #include <asm/smp_plat.h>
21 #include "coresight-priv.h"
23 * coresight_alloc_conns: Allocate connections record for each output
24 * port from the device.
26 static int coresight_alloc_conns(struct device *dev,
27 struct coresight_platform_data *pdata)
29 if (pdata->nr_outport) {
30 pdata->conns = devm_kcalloc(dev, pdata->nr_outport,
31 sizeof(*pdata->conns), GFP_KERNEL);
39 static struct device *
40 coresight_find_device_by_fwnode(struct fwnode_handle *fwnode)
42 struct device *dev = NULL;
45 * If we have a non-configurable replicator, it will be found on the
48 dev = bus_find_device_by_fwnode(&platform_bus_type, fwnode);
53 * We have a configurable component - circle through the AMBA bus
54 * looking for the device that matches the endpoint node.
56 return bus_find_device_by_fwnode(&amba_bustype, fwnode);
60 * Find a registered coresight device from a device fwnode.
61 * The node info is associated with the AMBA parent, but the
62 * csdev keeps a copy so iterate round the coresight bus to
65 struct coresight_device *
66 coresight_find_csdev_by_fwnode(struct fwnode_handle *r_fwnode)
69 struct coresight_device *csdev = NULL;
71 dev = bus_find_device_by_fwnode(&coresight_bustype, r_fwnode);
73 csdev = to_coresight_device(dev);
80 static inline bool of_coresight_legacy_ep_is_input(struct device_node *ep)
82 return of_property_read_bool(ep, "slave-mode");
85 static void of_coresight_get_ports_legacy(const struct device_node *node,
86 int *nr_inport, int *nr_outport)
88 struct device_node *ep = NULL;
89 struct of_endpoint endpoint;
93 ep = of_graph_get_next_endpoint(node, ep);
97 if (of_graph_parse_endpoint(ep, &endpoint))
100 if (of_coresight_legacy_ep_is_input(ep)) {
101 in = (endpoint.port + 1 > in) ?
102 endpoint.port + 1 : in;
104 out = (endpoint.port + 1) > out ?
105 endpoint.port + 1 : out;
114 static struct device_node *of_coresight_get_port_parent(struct device_node *ep)
116 struct device_node *parent = of_graph_get_port_parent(ep);
119 * Skip one-level up to the real device node, if we
120 * are using the new bindings.
122 if (of_node_name_eq(parent, "in-ports") ||
123 of_node_name_eq(parent, "out-ports"))
124 parent = of_get_next_parent(parent);
129 static inline struct device_node *
130 of_coresight_get_input_ports_node(const struct device_node *node)
132 return of_get_child_by_name(node, "in-ports");
135 static inline struct device_node *
136 of_coresight_get_output_ports_node(const struct device_node *node)
138 return of_get_child_by_name(node, "out-ports");
142 of_coresight_count_ports(struct device_node *port_parent)
145 struct device_node *ep = NULL;
146 struct of_endpoint endpoint;
148 while ((ep = of_graph_get_next_endpoint(port_parent, ep))) {
149 /* Defer error handling to parsing */
150 if (of_graph_parse_endpoint(ep, &endpoint))
152 if (endpoint.port + 1 > i)
153 i = endpoint.port + 1;
159 static void of_coresight_get_ports(const struct device_node *node,
160 int *nr_inport, int *nr_outport)
162 struct device_node *input_ports = NULL, *output_ports = NULL;
164 input_ports = of_coresight_get_input_ports_node(node);
165 output_ports = of_coresight_get_output_ports_node(node);
167 if (input_ports || output_ports) {
169 *nr_inport = of_coresight_count_ports(input_ports);
170 of_node_put(input_ports);
173 *nr_outport = of_coresight_count_ports(output_ports);
174 of_node_put(output_ports);
177 /* Fall back to legacy DT bindings parsing */
178 of_coresight_get_ports_legacy(node, nr_inport, nr_outport);
182 static int of_coresight_get_cpu(struct device *dev)
185 struct device_node *dn;
190 dn = of_parse_phandle(dev->of_node, "cpu", 0);
194 cpu = of_cpu_node_to_id(dn);
201 * of_coresight_parse_endpoint : Parse the given output endpoint @ep
202 * and fill the connection information in @conn
204 * Parses the local port, remote device name and the remote port.
207 * 0 - If the parsing completed without any fatal errors.
208 * -Errno - Fatal error, abort the scanning.
210 static int of_coresight_parse_endpoint(struct device *dev,
211 struct device_node *ep,
212 struct coresight_platform_data *pdata)
215 struct of_endpoint endpoint, rendpoint;
216 struct device_node *rparent = NULL;
217 struct device_node *rep = NULL;
218 struct device *rdev = NULL;
219 struct fwnode_handle *rdev_fwnode;
220 struct coresight_connection *conn;
223 /* Parse the local port details */
224 if (of_graph_parse_endpoint(ep, &endpoint))
227 * Get a handle on the remote endpoint and the device it is
230 rep = of_graph_get_remote_endpoint(ep);
233 rparent = of_coresight_get_port_parent(rep);
236 if (of_graph_parse_endpoint(rep, &rendpoint))
239 rdev_fwnode = of_fwnode_handle(rparent);
240 /* If the remote device is not available, defer probing */
241 rdev = coresight_find_device_by_fwnode(rdev_fwnode);
247 conn = &pdata->conns[endpoint.port];
248 if (conn->child_fwnode) {
249 dev_warn(dev, "Duplicate output port %d\n",
254 conn->outport = endpoint.port;
256 * Hold the refcount to the target device. This could be
258 * 1) coresight_release_platform_data() if the probe fails or
259 * this device is unregistered.
260 * 2) While removing the target device via
261 * coresight_remove_match()
263 conn->child_fwnode = fwnode_handle_get(rdev_fwnode);
264 conn->child_port = rendpoint.port;
265 /* Connection record updated */
268 of_node_put(rparent);
275 static int of_get_coresight_platform_data(struct device *dev,
276 struct coresight_platform_data *pdata)
279 struct device_node *ep = NULL;
280 const struct device_node *parent = NULL;
281 bool legacy_binding = false;
282 struct device_node *node = dev->of_node;
284 /* Get the number of input and output port for this component */
285 of_coresight_get_ports(node, &pdata->nr_inport, &pdata->nr_outport);
287 /* If there are no output connections, we are done */
288 if (!pdata->nr_outport)
291 ret = coresight_alloc_conns(dev, pdata);
295 parent = of_coresight_get_output_ports_node(node);
297 * If the DT uses obsoleted bindings, the ports are listed
298 * under the device and we need to filter out the input
302 legacy_binding = true;
304 dev_warn_once(dev, "Uses obsolete Coresight DT bindings\n");
307 /* Iterate through each output port to discover topology */
308 while ((ep = of_graph_get_next_endpoint(parent, ep))) {
310 * Legacy binding mixes input/output ports under the
311 * same parent. So, skip the input ports if we are dealing
312 * with legacy binding, as they processed with their
313 * connected output ports.
315 if (legacy_binding && of_coresight_legacy_ep_is_input(ep))
318 ret = of_coresight_parse_endpoint(dev, ep, pdata);
327 of_get_coresight_platform_data(struct device *dev,
328 struct coresight_platform_data *pdata)
333 static inline int of_coresight_get_cpu(struct device *dev)
341 #include <acpi/actypes.h>
342 #include <acpi/processor.h>
344 /* ACPI Graph _DSD UUID : "ab02a46b-74c7-45a2-bd68-f7d344ef2153" */
345 static const guid_t acpi_graph_uuid = GUID_INIT(0xab02a46b, 0x74c7, 0x45a2,
346 0xbd, 0x68, 0xf7, 0xd3,
347 0x44, 0xef, 0x21, 0x53);
348 /* Coresight ACPI Graph UUID : "3ecbc8b6-1d0e-4fb3-8107-e627f805c6cd" */
349 static const guid_t coresight_graph_uuid = GUID_INIT(0x3ecbc8b6, 0x1d0e, 0x4fb3,
350 0x81, 0x07, 0xe6, 0x27,
351 0xf8, 0x05, 0xc6, 0xcd);
352 #define ACPI_CORESIGHT_LINK_SLAVE 0
353 #define ACPI_CORESIGHT_LINK_MASTER 1
355 static inline bool is_acpi_guid(const union acpi_object *obj)
357 return (obj->type == ACPI_TYPE_BUFFER) && (obj->buffer.length == 16);
361 * acpi_guid_matches - Checks if the given object is a GUID object and
362 * that it matches the supplied the GUID.
364 static inline bool acpi_guid_matches(const union acpi_object *obj,
367 return is_acpi_guid(obj) &&
368 guid_equal((guid_t *)obj->buffer.pointer, guid);
371 static inline bool is_acpi_dsd_graph_guid(const union acpi_object *obj)
373 return acpi_guid_matches(obj, &acpi_graph_uuid);
376 static inline bool is_acpi_coresight_graph_guid(const union acpi_object *obj)
378 return acpi_guid_matches(obj, &coresight_graph_uuid);
381 static inline bool is_acpi_coresight_graph(const union acpi_object *obj)
383 const union acpi_object *graphid, *guid, *links;
385 if (obj->type != ACPI_TYPE_PACKAGE ||
386 obj->package.count < 3)
389 graphid = &obj->package.elements[0];
390 guid = &obj->package.elements[1];
391 links = &obj->package.elements[2];
393 if (graphid->type != ACPI_TYPE_INTEGER ||
394 links->type != ACPI_TYPE_INTEGER)
397 return is_acpi_coresight_graph_guid(guid);
401 * acpi_validate_dsd_graph - Make sure the given _DSD graph conforms
402 * to the ACPI _DSD Graph specification.
404 * ACPI Devices Graph property has the following format:
406 * Revision - Integer, must be 0
407 * NumberOfGraphs - Integer, N indicating the following list.
413 * And each Graph entry has the following format:
415 * GraphID - Integer, identifying a graph the device belongs to.
416 * UUID - UUID identifying the specification that governs
417 * this graph. (e.g, see is_acpi_coresight_graph())
418 * NumberOfLinks - Number "N" of connections on this node of the graph.
424 * Where each "Links" entry has the following format:
427 * SourcePortAddress - Integer
428 * DestinationPortAddress - Integer
429 * DestinationDeviceName - Reference to another device
430 * ( --- CoreSight specific extensions below ---)
431 * DirectionOfFlow - Integer 1 for output(master)
436 * For a Funnel device
441 * Name (_DSD, Package() {
442 * // DSD Package contains tuples of { Proeprty_Type_UUID, Package() }
443 * ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301"), //Std. Property UUID
445 * Package(2) { "property-name", <property-value> }
448 * ToUUID("ab02a46b-74c7-45a2-bd68-f7d344ef2153"), // ACPI Graph UUID
451 * 1, // NumberOfGraphs.
452 * Package() { // Graph[0] Package
454 * // Coresight Graph UUID
455 * ToUUID("3ecbc8b6-1d0e-4fb3-8107-e627f805c6cd"),
456 * 3, // NumberOfLinks aka ports
457 * // Link[0]: Output_0 -> Replicator:Input_0
458 * Package () { 0, 0, \_SB_.RPL0, 1 },
459 * // Link[1]: Input_0 <- Cluster0_Funnel0:Output_0
460 * Package () { 0, 0, \_SB_.CLU0.FUN0, 0 },
461 * // Link[2]: Input_1 <- Cluster1_Funnel0:Output_0
462 * Package () { 1, 0, \_SB_.CLU1.FUN0, 0 },
463 * } // End of Graph[0] Package
465 * }, // End of ACPI Graph Property
468 static inline bool acpi_validate_dsd_graph(const union acpi_object *graph)
471 const union acpi_object *rev, *nr_graphs;
473 /* The graph must contain at least the Revision and Number of Graphs */
474 if (graph->package.count < 2)
477 rev = &graph->package.elements[0];
478 nr_graphs = &graph->package.elements[1];
480 if (rev->type != ACPI_TYPE_INTEGER ||
481 nr_graphs->type != ACPI_TYPE_INTEGER)
484 /* We only support revision 0 */
485 if (rev->integer.value != 0)
488 n = nr_graphs->integer.value;
489 /* CoreSight devices are only part of a single Graph */
493 /* Make sure the ACPI graph package has right number of elements */
494 if (graph->package.count != (n + 2))
498 * Each entry must be a graph package with at least 3 members :
499 * { GraphID, UUID, NumberOfLinks(n), Links[.],... }
501 for (i = 2; i < n + 2; i++) {
502 const union acpi_object *obj = &graph->package.elements[i];
504 if (obj->type != ACPI_TYPE_PACKAGE ||
505 obj->package.count < 3)
512 /* acpi_get_dsd_graph - Find the _DSD Graph property for the given device. */
513 static const union acpi_object *
514 acpi_get_dsd_graph(struct acpi_device *adev)
517 struct acpi_buffer buf = { ACPI_ALLOCATE_BUFFER };
519 const union acpi_object *dsd;
521 status = acpi_evaluate_object_typed(adev->handle, "_DSD", NULL,
522 &buf, ACPI_TYPE_PACKAGE);
523 if (ACPI_FAILURE(status))
529 * _DSD property consists tuples { Prop_UUID, Package() }
530 * Iterate through all the packages and find the Graph.
532 for (i = 0; i + 1 < dsd->package.count; i += 2) {
533 const union acpi_object *guid, *package;
535 guid = &dsd->package.elements[i];
536 package = &dsd->package.elements[i + 1];
538 /* All _DSD elements must have a UUID and a Package */
539 if (!is_acpi_guid(guid) || package->type != ACPI_TYPE_PACKAGE)
541 /* Skip the non-Graph _DSD packages */
542 if (!is_acpi_dsd_graph_guid(guid))
544 if (acpi_validate_dsd_graph(package))
546 /* Invalid graph format, continue */
547 dev_warn(&adev->dev, "Invalid Graph _DSD property\n");
554 acpi_validate_coresight_graph(const union acpi_object *cs_graph)
558 nlinks = cs_graph->package.elements[2].integer.value;
560 * Graph must have the following fields :
561 * { GraphID, GraphUUID, NumberOfLinks, Links... }
563 if (cs_graph->package.count != (nlinks + 3))
565 /* The links are validated in acpi_coresight_parse_link() */
570 * acpi_get_coresight_graph - Parse the device _DSD tables and find
571 * the Graph property matching the CoreSight Graphs.
573 * Returns the pointer to the CoreSight Graph Package when found. Otherwise
576 static const union acpi_object *
577 acpi_get_coresight_graph(struct acpi_device *adev)
579 const union acpi_object *graph_list, *graph;
582 graph_list = acpi_get_dsd_graph(adev);
586 nr_graphs = graph_list->package.elements[1].integer.value;
588 for (i = 2; i < nr_graphs + 2; i++) {
589 graph = &graph_list->package.elements[i];
590 if (!is_acpi_coresight_graph(graph))
592 if (acpi_validate_coresight_graph(graph))
594 /* Invalid graph format */
602 * acpi_coresight_parse_link - Parse the given Graph connection
603 * of the device and populate the coresight_connection for an output
606 * CoreSight Graph specification mandates that the direction of the data
607 * flow must be specified in the link. i.e,
609 * SourcePortAddress, // Integer
610 * DestinationPortAddress, // Integer
611 * DestinationDeviceName, // Reference to another device
612 * DirectionOfFlow, // 1 for output(master), 0 for input(slave)
614 * Returns the direction of the data flow [ Input(slave) or Output(master) ]
616 * Returns an negative error number otherwise.
618 static int acpi_coresight_parse_link(struct acpi_device *adev,
619 const union acpi_object *link,
620 struct coresight_connection *conn)
623 const union acpi_object *fields;
624 struct acpi_device *r_adev;
627 if (link->type != ACPI_TYPE_PACKAGE ||
628 link->package.count != 4)
631 fields = link->package.elements;
633 if (fields[0].type != ACPI_TYPE_INTEGER ||
634 fields[1].type != ACPI_TYPE_INTEGER ||
635 fields[2].type != ACPI_TYPE_LOCAL_REFERENCE ||
636 fields[3].type != ACPI_TYPE_INTEGER)
639 rc = acpi_bus_get_device(fields[2].reference.handle, &r_adev);
643 dir = fields[3].integer.value;
644 if (dir == ACPI_CORESIGHT_LINK_MASTER) {
645 conn->outport = fields[0].integer.value;
646 conn->child_port = fields[1].integer.value;
647 rdev = coresight_find_device_by_fwnode(&r_adev->fwnode);
649 return -EPROBE_DEFER;
651 * Hold the refcount to the target device. This could be
653 * 1) coresight_release_platform_data() if the probe fails or
654 * this device is unregistered.
655 * 2) While removing the target device via
656 * coresight_remove_match().
658 conn->child_fwnode = fwnode_handle_get(&r_adev->fwnode);
659 } else if (dir == ACPI_CORESIGHT_LINK_SLAVE) {
661 * We are only interested in the port number
662 * for the input ports at this component.
663 * Store the port number in child_port.
665 conn->child_port = fields[0].integer.value;
667 /* Invalid direction */
675 * acpi_coresight_parse_graph - Parse the _DSD CoreSight graph
676 * connection information and populate the supplied coresight_platform_data
679 static int acpi_coresight_parse_graph(struct acpi_device *adev,
680 struct coresight_platform_data *pdata)
683 const union acpi_object *graph;
684 struct coresight_connection *conns, *ptr;
686 pdata->nr_inport = pdata->nr_outport = 0;
687 graph = acpi_get_coresight_graph(adev);
691 nlinks = graph->package.elements[2].integer.value;
696 * To avoid scanning the table twice (once for finding the number of
697 * output links and then later for parsing the output links),
698 * cache the links information in one go and then later copy
701 conns = devm_kcalloc(&adev->dev, nlinks, sizeof(*conns), GFP_KERNEL);
705 for (i = 0; i < nlinks; i++) {
706 const union acpi_object *link = &graph->package.elements[3 + i];
709 dir = acpi_coresight_parse_link(adev, link, ptr);
713 if (dir == ACPI_CORESIGHT_LINK_MASTER) {
714 if (ptr->outport > pdata->nr_outport)
715 pdata->nr_outport = ptr->outport;
718 WARN_ON(pdata->nr_inport == ptr->child_port);
720 * We do not track input port connections for a device.
721 * However we need the highest port number described,
722 * which can be recorded now and reuse this connection
723 * record for an output connection. Hence, do not move
724 * the ptr for input connections
726 if (ptr->child_port > pdata->nr_inport)
727 pdata->nr_inport = ptr->child_port;
731 rc = coresight_alloc_conns(&adev->dev, pdata);
735 /* Copy the connection information to the final location */
736 for (i = 0; conns + i < ptr; i++) {
737 int port = conns[i].outport;
739 /* Duplicate output port */
740 WARN_ON(pdata->conns[port].child_fwnode);
741 pdata->conns[port] = conns[i];
744 devm_kfree(&adev->dev, conns);
749 * acpi_handle_to_logical_cpuid - Map a given acpi_handle to the
750 * logical CPU id of the corresponding CPU device.
752 * Returns the logical CPU id when found. Otherwise returns >= nr_cpus_id.
755 acpi_handle_to_logical_cpuid(acpi_handle handle)
758 struct acpi_processor *pr;
760 for_each_possible_cpu(i) {
761 pr = per_cpu(processors, i);
762 if (pr && pr->handle == handle)
770 * acpi_coresigh_get_cpu - Find the logical CPU id of the CPU associated
771 * with this coresight device. With ACPI bindings, the CoreSight components
772 * are listed as child device of the associated CPU.
774 * Returns the logical CPU id when found. Otherwise returns 0.
776 static int acpi_coresight_get_cpu(struct device *dev)
779 acpi_handle cpu_handle;
781 struct acpi_device *adev = ACPI_COMPANION(dev);
785 status = acpi_get_parent(adev->handle, &cpu_handle);
786 if (ACPI_FAILURE(status))
789 cpu = acpi_handle_to_logical_cpuid(cpu_handle);
790 if (cpu >= nr_cpu_ids)
796 acpi_get_coresight_platform_data(struct device *dev,
797 struct coresight_platform_data *pdata)
799 struct acpi_device *adev;
801 adev = ACPI_COMPANION(dev);
805 return acpi_coresight_parse_graph(adev, pdata);
811 acpi_get_coresight_platform_data(struct device *dev,
812 struct coresight_platform_data *pdata)
817 static inline int acpi_coresight_get_cpu(struct device *dev)
823 int coresight_get_cpu(struct device *dev)
825 if (is_of_node(dev->fwnode))
826 return of_coresight_get_cpu(dev);
827 else if (is_acpi_device_node(dev->fwnode))
828 return acpi_coresight_get_cpu(dev);
831 EXPORT_SYMBOL_GPL(coresight_get_cpu);
833 struct coresight_platform_data *
834 coresight_get_platform_data(struct device *dev)
837 struct coresight_platform_data *pdata = NULL;
838 struct fwnode_handle *fwnode = dev_fwnode(dev);
840 if (IS_ERR_OR_NULL(fwnode))
843 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
849 if (is_of_node(fwnode))
850 ret = of_get_coresight_platform_data(dev, pdata);
851 else if (is_acpi_device_node(fwnode))
852 ret = acpi_get_coresight_platform_data(dev, pdata);
857 if (!IS_ERR_OR_NULL(pdata))
858 /* Cleanup the connection information */
859 coresight_release_platform_data(NULL, pdata);
862 EXPORT_SYMBOL_GPL(coresight_get_platform_data);