2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2021 ARM Ltd
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 /* Arm CoreLink CMN-600 Coherent Mesh Network Driver */
30 #include <sys/cdefs.h>
33 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/malloc.h>
37 #include <sys/module.h>
41 #include <sys/sysctl.h>
43 #include <machine/bus.h>
44 #include <machine/cpu.h>
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <dev/acpica/acpivar.h>
49 #include <machine/cmn600_reg.h>
51 #define RD4(sc, r) bus_read_4((sc)->sc_res[0], (r))
52 #define RD8(sc, r) bus_read_8((sc)->sc_res[0], (r))
53 #define WR4(sc, r, v) bus_write_4((sc)->sc_res[0], (r), (v))
54 #define WR8(sc, r, v) bus_write_8((sc)->sc_res[0], (r), (v))
55 #define FLD(v, n) (((v) & n ## _MASK) >> n ## _SHIFT)
57 static char *cmn600_ids[] = {
62 static struct resource_spec cmn600_res_spec[] = {
63 { SYS_RES_MEMORY, 0, RF_ACTIVE },
64 { SYS_RES_MEMORY, 1, RF_ACTIVE | RF_UNMAPPED | RF_OPTIONAL },
65 { SYS_RES_IRQ, 0, RF_ACTIVE },
71 typedef uint64_t (*nd_read_8_t)(struct cmn600_node *, uint32_t);
72 typedef uint32_t (*nd_read_4_t)(struct cmn600_node *, uint32_t);
73 typedef void (*nd_write_8_t)(struct cmn600_node *, uint32_t, uint64_t);
74 typedef void (*nd_write_4_t)(struct cmn600_node *, uint32_t, uint32_t);
77 struct cmn600_softc *sc;
81 uint16_t nd_logical_id;
82 uint8_t nd_x, nd_y, nd_port, nd_sub;
83 uint16_t nd_child_count;
85 struct cmn600_node *nd_parent;
88 nd_write_8_t nd_write8;
89 nd_write_4_t nd_write4;
90 struct cmn600_node **nd_children;
100 struct resource *sc_res[3];
104 struct cmn600_node *sc_rootnode;
105 struct cmn600_node *sc_dtcnode;
106 struct cmn600_node *sc_dvmnode;
107 struct cmn600_node *sc_xpnodes[64];
108 int (*sc_pmu_ih)(struct trapframe *tf, int unit, int i);
111 static struct cmn600_pmc cmn600_pmcs[CMN600_UNIT_MAX];
112 static int cmn600_npmcs = 0;
114 static int cmn600_acpi_detach(device_t dev);
115 static int cmn600_intr(void *arg);
118 cmn600_pmc_register(int unit, void *arg, int domain)
121 if (unit >= CMN600_UNIT_MAX) {
126 cmn600_pmcs[unit].arg = arg;
127 cmn600_pmcs[unit].domain = domain;
132 cmn600_pmc_unregister(int unit)
135 cmn600_pmcs[unit].arg = NULL;
140 cmn600_pmc_nunits(void)
143 return (cmn600_npmcs);
147 cmn600_pmc_getunit(int unit, void **arg, int *domain)
150 if (unit >= cmn600_npmcs)
152 if (cmn600_pmcs[unit].arg == NULL)
154 *arg = cmn600_pmcs[unit].arg;
155 *domain = cmn600_pmcs[unit].domain;
160 pmu_cmn600_rev(void *arg)
162 struct cmn600_softc *sc;
164 sc = (struct cmn600_softc *)arg;
165 switch (sc->sc_rev) {
181 return (0x302); /* Unknown revision. */
185 cmn600_node_read8(struct cmn600_node *nd, uint32_t reg)
188 return (RD8(nd->sc, nd->nd_offset + reg));
192 cmn600_node_write8(struct cmn600_node *nd, uint32_t reg, uint64_t val)
195 WR8(nd->sc, nd->nd_offset + reg, val);
199 cmn600_node_read4(struct cmn600_node *nd, uint32_t reg)
202 return (RD4(nd->sc, nd->nd_offset + reg));
206 cmn600_node_write4(struct cmn600_node *nd, uint32_t reg, uint32_t val)
209 WR4(nd->sc, nd->nd_offset + reg, val);
213 cmn600_node_type_str(int type)
216 #define NAME_OF(t, n) case NODE_TYPE_ ## t: return n
218 NAME_OF(INVALID, "<invalid node>");
222 NAME_OF(HN_I, "HN-I");
223 NAME_OF(HN_F, "HN-F");
225 NAME_OF(SBSX, "SBSX");
226 NAME_OF(RN_I, "RN-I");
227 NAME_OF(RN_D, "RN-D");
228 NAME_OF(RN_SAM, "RN-SAM");
229 NAME_OF(CXRA, "CXRA");
230 NAME_OF(CXHA, "CXHA");
231 NAME_OF(CXLA, "CXLA");
233 return "<unknown node>";
239 cmn600_xpport_dev_type_str(uint8_t type)
242 #define NAME_OF(t, n) case POR_MXP_PX_INFO_DEV_TYPE_ ## t: return n
244 NAME_OF(RN_I, "RN-I");
245 NAME_OF(RN_D, "RN-D");
246 NAME_OF(RN_F_CHIB, "RN-F CHIB");
247 NAME_OF(RN_F_CHIB_ESAM, "RN-F CHIB ESAM");
248 NAME_OF(RN_F_CHIA, "RN-F CHIA");
249 NAME_OF(RN_F_CHIA_ESAM, "RN-F CHIA ESAM");
250 NAME_OF(HN_T, "HN-T");
251 NAME_OF(HN_I, "HN-I");
252 NAME_OF(HN_D, "HN-D");
253 NAME_OF(SN_F, "SN-F");
254 NAME_OF(SBSX, "SBSX");
255 NAME_OF(HN_F, "HN-F");
256 NAME_OF(CXHA, "CXHA");
257 NAME_OF(CXRA, "CXRA");
258 NAME_OF(CXRH, "CXRH");
266 cmn600_dump_node(struct cmn600_node *node, int lvl)
270 for (i = 0; i < lvl; i++) printf(" ");
271 printf("%s [%dx%d:%d:%d] id: 0x%x @0x%lx Logical Id: 0x%x",
272 cmn600_node_type_str(node->nd_type), node->nd_x, node->nd_y,
273 node->nd_port, node->nd_sub, node->nd_id, node->nd_offset,
274 node->nd_logical_id);
275 if (node->nd_child_count > 0)
276 printf(", Children: %d", node->nd_child_count);
278 if (node->nd_type == NODE_TYPE_XP)
279 printf("\tPort 0: %s\n\tPort 1: %s\n",
280 cmn600_xpport_dev_type_str(node->nd_read4(node,
281 POR_MXP_P0_INFO) & 0x1f),
282 cmn600_xpport_dev_type_str(node->nd_read4(node,
283 POR_MXP_P1_INFO) & 0x1f));
287 cmn600_dump_node_recursive(struct cmn600_node *node, int lvl)
291 cmn600_dump_node(node, lvl);
292 for (i = 0; i < node->nd_child_count; i++) {
293 cmn600_dump_node_recursive(node->nd_children[i], lvl + 1);
298 cmn600_dump_nodes_tree(struct cmn600_softc *sc)
301 device_printf(sc->sc_dev, " nodes:\n");
302 cmn600_dump_node_recursive(sc->sc_rootnode, 0);
306 cmn600_sysctl_dump_nodes(SYSCTL_HANDLER_ARGS)
308 struct cmn600_softc *sc;
312 sc = (struct cmn600_softc *)arg1;
314 err = sysctl_handle_int(oidp, &val, 0, req);
320 cmn600_dump_nodes_tree(sc);
325 static struct cmn600_node *
326 cmn600_create_node(struct cmn600_softc *sc, off_t node_offset,
327 struct cmn600_node *parent, int lvl)
329 struct cmn600_node *node;
334 node = malloc(sizeof(struct cmn600_node), M_DEVBUF, M_WAITOK);
339 node->nd_offset = node_offset;
340 node->nd_parent = parent;
341 node->nd_read4 = cmn600_node_read4;
342 node->nd_read8 = cmn600_node_read8;
343 node->nd_write4 = cmn600_node_write4;
344 node->nd_write8 = cmn600_node_write8;
346 val = node->nd_read8(node, POR_CFGM_NODE_INFO);
347 node->nd_type = FLD(val, POR_CFGM_NODE_INFO_NODE_TYPE);
348 node->nd_id = FLD(val, POR_CFGM_NODE_INFO_NODE_ID);
349 node->nd_logical_id = FLD(val, POR_CFGM_NODE_INFO_LOGICAL_ID);
351 val = node->nd_read8(node, POR_CFGM_CHILD_INFO);
352 node->nd_child_count = FLD(val, POR_CFGM_CHILD_INFO_CHILD_COUNT);
353 child_offset = FLD(val, POR_CFGM_CHILD_INFO_CHILD_PTR_OFFSET);
355 if (parent == NULL) {
356 /* Find XP node with Id 8. It have to be last in a row. */
357 for (i = 0; i < node->nd_child_count; i++) {
358 val = node->nd_read8(node, child_offset + (i * 8));
359 val &= POR_CFGM_CHILD_POINTER_BASE_MASK;
360 val = RD8(sc, val + POR_CFGM_NODE_INFO);
362 if (FLD(val, POR_CFGM_NODE_INFO_NODE_ID) != 8)
365 sc->sc_mesh_x = FLD(val, POR_CFGM_NODE_INFO_LOGICAL_ID);
366 sc->sc_mesh_y = node->nd_child_count / sc->sc_mesh_x;
368 printf("Mesh width X/Y %d/%d\n", sc->sc_mesh_x,
371 if ((sc->sc_mesh_x > 4) || (sc->sc_mesh_y > 4))
376 val = node->nd_read8(node, POR_INFO_GLOBAL);
377 sc->sc_r2 = (val & POR_INFO_GLOBAL_R2_ENABLE) ? 1 : 0;
378 val = node->nd_read4(node, POR_CFGM_PERIPH_ID_2_PERIPH_ID_3);
379 sc->sc_rev = FLD(val, POR_CFGM_PERIPH_ID_2_REV);
381 printf(" Rev: %d, R2_ENABLE = %s\n", sc->sc_rev,
382 sc->sc_r2 ? "true" : "false");
384 node->nd_sub = FLD(node->nd_id, NODE_ID_SUB);
385 node->nd_port = FLD(node->nd_id, NODE_ID_PORT);
387 if (sc->sc_longid == 1) {
388 node->nd_x = FLD(node->nd_id, NODE_ID_X3B);
389 node->nd_y = FLD(node->nd_id, NODE_ID_Y3B);
391 node->nd_x = FLD(node->nd_id, NODE_ID_X2B);
392 node->nd_y = FLD(node->nd_id, NODE_ID_Y2B);
396 cmn600_dump_node(node, lvl);
399 node->nd_children = (struct cmn600_node **)mallocarray(
400 node->nd_child_count, sizeof(struct cmn600_node *), M_DEVBUF,
402 if (node->nd_children == NULL)
404 for (i = 0; i < node->nd_child_count; i++) {
405 val = node->nd_read8(node, child_offset + (i * 8));
406 node->nd_children[i] = cmn600_create_node(sc, val &
407 POR_CFGM_CHILD_POINTER_BASE_MASK, node, lvl + 1);
409 switch (node->nd_type) {
411 sc->sc_dtcnode = node;
414 sc->sc_dvmnode = node;
417 sc->sc_xpnodes[node->nd_id >> NODE_ID_X2B_SHIFT] = node;
424 free(node, M_DEVBUF);
429 cmn600_destroy_node(struct cmn600_node *node)
433 for (i = 0; i < node->nd_child_count; i++) {
434 if (node->nd_children[i] == NULL)
436 cmn600_destroy_node(node->nd_children[i]);
438 free(node->nd_children, M_DEVBUF);
439 free(node, M_DEVBUF);
443 cmn600_find_node(struct cmn600_softc *sc, int node_id, int type,
444 struct cmn600_node **node)
446 struct cmn600_node *xp, *child;
451 case NODE_TYPE_INVALID:
454 *node = sc->sc_rootnode;
457 *node = sc->sc_dtcnode;
460 *node = sc->sc_dvmnode;
466 xp_xy = node_id >> NODE_ID_X2B_SHIFT;
469 if (sc->sc_xpnodes[xp_xy] == NULL)
474 *node = sc->sc_xpnodes[xp_xy];
477 xp = sc->sc_xpnodes[xp_xy];
478 for (i = 0; i < xp->nd_child_count; i++) {
479 child = xp->nd_children[i];
480 if (child->nd_id == node_id && child->nd_type == type) {
490 pmu_cmn600_alloc_localpmc(void *arg, int nodeid, int node_type, int *counter)
492 struct cmn600_node *node;
493 struct cmn600_softc *sc;
497 sc = (struct cmn600_softc *)arg;
502 node_type = NODE_TYPE_XP;
503 /* Parent XP node has always zero port and device bits. */
506 ret = cmn600_find_node(sc, nodeid, node_type, &node);
509 for (i = 0; i < 4; i++) {
510 new = old = node->nd_paired;
513 if ((old & (1 << i)) != 0)
516 if (atomic_cmpset_32(&node->nd_paired, old, new) != 0)
524 pmu_cmn600_free_localpmc(void *arg, int nodeid, int node_type, int counter)
526 struct cmn600_node *node;
527 struct cmn600_softc *sc;
531 sc = (struct cmn600_softc *)arg;
536 node_type = NODE_TYPE_XP;
538 ret = cmn600_find_node(sc, nodeid, node_type, &node);
543 new = old = node->nd_paired;
544 new &= ~(1 << counter);
545 } while (atomic_cmpset_32(&node->nd_paired, old, new) == 0);
550 pmu_cmn600_rd4(void *arg, int nodeid, int node_type, off_t reg)
552 struct cmn600_node *node;
553 struct cmn600_softc *sc;
556 sc = (struct cmn600_softc *)arg;
557 ret = cmn600_find_node(sc, nodeid, node_type, &node);
560 return (cmn600_node_read4(node, reg));
564 pmu_cmn600_wr4(void *arg, int nodeid, int node_type, off_t reg, uint32_t val)
566 struct cmn600_node *node;
567 struct cmn600_softc *sc;
570 sc = (struct cmn600_softc *)arg;
571 ret = cmn600_find_node(sc, nodeid, node_type, &node);
574 cmn600_node_write4(node, reg, val);
579 pmu_cmn600_rd8(void *arg, int nodeid, int node_type, off_t reg)
581 struct cmn600_node *node;
582 struct cmn600_softc *sc;
585 sc = (struct cmn600_softc *)arg;
586 ret = cmn600_find_node(sc, nodeid, node_type, &node);
589 return (cmn600_node_read8(node, reg));
593 pmu_cmn600_wr8(void *arg, int nodeid, int node_type, off_t reg, uint64_t val)
595 struct cmn600_node *node;
596 struct cmn600_softc *sc;
599 sc = (struct cmn600_softc *)arg;
600 ret = cmn600_find_node(sc, nodeid, node_type, &node);
603 cmn600_node_write8(node, reg, val);
608 pmu_cmn600_set8(void *arg, int nodeid, int node_type, off_t reg, uint64_t val)
610 struct cmn600_node *node;
611 struct cmn600_softc *sc;
614 sc = (struct cmn600_softc *)arg;
615 ret = cmn600_find_node(sc, nodeid, node_type, &node);
618 cmn600_node_write8(node, reg, cmn600_node_read8(node, reg) | val);
623 pmu_cmn600_clr8(void *arg, int nodeid, int node_type, off_t reg, uint64_t val)
625 struct cmn600_node *node;
626 struct cmn600_softc *sc;
629 sc = (struct cmn600_softc *)arg;
630 ret = cmn600_find_node(sc, nodeid, node_type, &node);
633 cmn600_node_write8(node, reg, cmn600_node_read8(node, reg) & ~val);
638 pmu_cmn600_md8(void *arg, int nodeid, int node_type, off_t reg, uint64_t mask,
641 struct cmn600_node *node;
642 struct cmn600_softc *sc;
645 sc = (struct cmn600_softc *)arg;
646 ret = cmn600_find_node(sc, nodeid, node_type, &node);
649 cmn600_node_write8(node, reg, (cmn600_node_read8(node, reg) & ~mask) |
655 cmn600_acpi_probe(device_t dev)
659 err = ACPI_ID_PROBE(device_get_parent(dev), dev, cmn600_ids, NULL);
661 device_set_desc(dev, "Arm CoreLink CMN-600 Coherent Mesh Network");
667 cmn600_acpi_attach(device_t dev)
669 struct sysctl_ctx_list *ctx;
670 struct sysctl_oid_list *child;
671 struct cmn600_softc *sc;
672 int cpu, domain, i, u;
674 rman_res_t count, periph_base, rootnode_base;
675 struct cmn600_node *node;
677 dname = device_get_name(dev);
678 sc = device_get_softc(dev);
680 u = device_get_unit(dev);
684 if ((resource_int_value(dname, u, "domain", &domain) == 0 ||
685 bus_get_domain(dev, &domain) == 0) && domain < MAXMEMDOM) {
686 sc->sc_domain = domain;
688 if (domain == -1) /* NUMA not supported. Use single domain. */
690 sc->sc_domain = domain;
691 device_printf(dev, "domain=%d\n", sc->sc_domain);
693 cpu = CPU_FFS(&cpuset_domain[domain]) - 1;
695 i = bus_alloc_resources(dev, cmn600_res_spec, sc->sc_res);
697 device_printf(dev, "cannot allocate resources for device (%d)\n",
702 bus_get_resource(dev, cmn600_res_spec[0].type, cmn600_res_spec[0].rid,
703 &periph_base, &count);
704 bus_get_resource(dev, cmn600_res_spec[1].type, cmn600_res_spec[1].rid,
705 &rootnode_base, &count);
706 rootnode_base -= periph_base;
708 printf("ROOTNODE at %lx x %lx\n", rootnode_base, count);
710 sc->sc_rootnode = cmn600_create_node(sc, rootnode_base, NULL, 0);
711 ctx = device_get_sysctl_ctx(sc->sc_dev);
713 child = SYSCTL_CHILDREN(device_get_sysctl_tree(sc->sc_dev));
714 SYSCTL_ADD_PROC(ctx, child, OID_AUTO, "dump_nodes", CTLTYPE_INT |
715 CTLFLAG_RW | CTLFLAG_NEEDGIANT, sc, 0, cmn600_sysctl_dump_nodes,
716 "U", "Dump CMN-600 nodes tree");
718 node = sc->sc_dtcnode;
722 cmn600_pmc_register(sc->sc_unit, (void *)sc, domain);
724 node->nd_write8(node, POR_DT_PMCR, 0);
725 node->nd_write8(node, POR_DT_PMOVSR_CLR, POR_DT_PMOVSR_ALL);
726 node->nd_write8(node, POR_DT_PMCR, POR_DT_PMCR_OVFL_INTR_EN);
727 node->nd_write8(node, POR_DT_DTC_CTL, POR_DT_DTC_CTL_DT_EN);
729 if (bus_setup_intr(dev, sc->sc_res[2], INTR_TYPE_MISC | INTR_MPSAFE,
730 cmn600_intr, NULL, sc, &sc->sc_ih)) {
731 bus_release_resources(dev, cmn600_res_spec, sc->sc_res);
732 device_printf(dev, "cannot setup interrupt handler\n");
733 cmn600_acpi_detach(dev);
736 if (bus_bind_intr(dev, sc->sc_res[2], cpu)) {
737 bus_teardown_intr(dev, sc->sc_res[2], sc->sc_ih);
738 bus_release_resources(dev, cmn600_res_spec, sc->sc_res);
739 device_printf(dev, "cannot setup interrupt handler\n");
740 cmn600_acpi_detach(dev);
747 cmn600_acpi_detach(device_t dev)
749 struct cmn600_softc *sc;
750 struct cmn600_node *node;
752 sc = device_get_softc(dev);
753 if (sc->sc_res[2] != NULL) {
754 bus_teardown_intr(dev, sc->sc_res[2], sc->sc_ih);
757 node = sc->sc_dtcnode;
758 node->nd_write4(node, POR_DT_DTC_CTL,
759 node->nd_read4(node, POR_DT_DTC_CTL) & ~POR_DT_DTC_CTL_DT_EN);
760 node->nd_write8(node, POR_DT_PMOVSR_CLR, POR_DT_PMOVSR_ALL);
762 cmn600_pmc_unregister(sc->sc_unit);
763 cmn600_destroy_node(sc->sc_rootnode);
764 bus_release_resources(dev, cmn600_res_spec, sc->sc_res);
770 cmn600_pmu_intr_cb(void *arg, int (*handler)(struct trapframe *tf, int unit,
773 struct cmn600_softc *sc;
775 sc = (struct cmn600_softc *) arg;
776 sc->sc_pmu_ih = handler;
781 cmn600_intr(void *arg)
783 struct cmn600_node *node;
784 struct cmn600_softc *sc;
785 struct trapframe *tf;
786 uint64_t mask, ready, val;
789 tf = PCPU_GET(curthread)->td_intr_frame;
790 sc = (struct cmn600_softc *) arg;
791 node = sc->sc_dtcnode;
792 val = node->nd_read8(node, POR_DT_PMOVSR);
793 if (val & POR_DT_PMOVSR_CYCLE_COUNTER)
794 node->nd_write8(node, POR_DT_PMOVSR_CLR,
795 POR_DT_PMOVSR_CYCLE_COUNTER);
796 if (val & POR_DT_PMOVSR_EVENT_COUNTERS) {
797 for (ready = 0, i = 0; i < 8; i++) {
799 if ((val & mask) == 0)
801 if (sc->sc_pmu_ih != NULL)
802 sc->sc_pmu_ih(tf, sc->sc_unit, i);
806 node->nd_write8(node, POR_DT_PMOVSR_CLR, ready);
809 return (FILTER_HANDLED);
812 static device_method_t cmn600_acpi_methods[] = {
813 /* Device interface */
814 DEVMETHOD(device_probe, cmn600_acpi_probe),
815 DEVMETHOD(device_attach, cmn600_acpi_attach),
816 DEVMETHOD(device_detach, cmn600_acpi_detach),
822 static driver_t cmn600_acpi_driver = {
825 sizeof(struct cmn600_softc),
828 DRIVER_MODULE(cmn600, acpi, cmn600_acpi_driver, 0, 0);
829 MODULE_VERSION(cmn600, 1);