1d46f01fdSAndrew Turner /*-
2d46f01fdSAndrew Turner * SPDX-License-Identifier: BSD-2-Clause
3d46f01fdSAndrew Turner *
4d46f01fdSAndrew Turner * Copyright (c) 2022 Ruslan Bukin <br@bsdpad.com>
5d46f01fdSAndrew Turner * Copyright (c) 2023 Arm Ltd
6d46f01fdSAndrew Turner *
7d46f01fdSAndrew Turner * This work was supported by Innovate UK project 105694, "Digital Security
8d46f01fdSAndrew Turner * by Design (DSbD) Technology Platform Prototype".
9d46f01fdSAndrew Turner *
10d46f01fdSAndrew Turner * Redistribution and use in source and binary forms, with or without
11d46f01fdSAndrew Turner * modification, are permitted provided that the following conditions
12d46f01fdSAndrew Turner * are met:
13d46f01fdSAndrew Turner * 1. Redistributions of source code must retain the above copyright
14d46f01fdSAndrew Turner * notice, this list of conditions and the following disclaimer.
15d46f01fdSAndrew Turner * 2. Redistributions in binary form must reproduce the above copyright
16d46f01fdSAndrew Turner * notice, this list of conditions and the following disclaimer in the
17d46f01fdSAndrew Turner * documentation and/or other materials provided with the distribution.
18d46f01fdSAndrew Turner *
19d46f01fdSAndrew Turner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20d46f01fdSAndrew Turner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21d46f01fdSAndrew Turner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22d46f01fdSAndrew Turner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23d46f01fdSAndrew Turner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24d46f01fdSAndrew Turner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25d46f01fdSAndrew Turner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26d46f01fdSAndrew Turner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27d46f01fdSAndrew Turner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28d46f01fdSAndrew Turner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29d46f01fdSAndrew Turner * SUCH DAMAGE.
30d46f01fdSAndrew Turner */
31d46f01fdSAndrew Turner
32d46f01fdSAndrew Turner #include <sys/cdefs.h>
33d46f01fdSAndrew Turner
34d46f01fdSAndrew Turner #include <sys/param.h>
35d46f01fdSAndrew Turner #include <sys/systm.h>
36d46f01fdSAndrew Turner #include <sys/bus.h>
37d46f01fdSAndrew Turner #include <sys/cpu.h>
38d46f01fdSAndrew Turner #include <sys/kernel.h>
39d46f01fdSAndrew Turner #include <sys/module.h>
40d46f01fdSAndrew Turner
41d46f01fdSAndrew Turner #include <dev/fdt/simplebus.h>
42d46f01fdSAndrew Turner #include <dev/fdt/fdt_common.h>
43d46f01fdSAndrew Turner #include <dev/ofw/ofw_bus_subr.h>
44d46f01fdSAndrew Turner
45d46f01fdSAndrew Turner #include "dev/mailbox/arm/arm_doorbell.h"
46d46f01fdSAndrew Turner
47d46f01fdSAndrew Turner #include "scmi.h"
48d46f01fdSAndrew Turner #include "scmi_protocols.h"
49cbcfdff0SCristian Marussi #include "scmi_shmem.h"
50d46f01fdSAndrew Turner
513595f18fSCristian Marussi #define SCMI_MBOX_POLL_INTERVAL_MS 3
523595f18fSCristian Marussi
53d46f01fdSAndrew Turner struct scmi_mailbox_softc {
54d46f01fdSAndrew Turner struct scmi_softc base;
55403ca28cSCristian Marussi device_t a2p_dev;
56d46f01fdSAndrew Turner struct arm_doorbell *db;
57d46f01fdSAndrew Turner };
58d46f01fdSAndrew Turner
59403ca28cSCristian Marussi static int scmi_mailbox_transport_init(device_t);
60403ca28cSCristian Marussi static void scmi_mailbox_transport_cleanup(device_t);
6135f93203SCristian Marussi static int scmi_mailbox_xfer_msg(device_t, struct scmi_msg *);
6235f93203SCristian Marussi static int scmi_mailbox_poll_msg(device_t, struct scmi_msg *,
633595f18fSCristian Marussi unsigned int);
6435f93203SCristian Marussi static int scmi_mailbox_collect_reply(device_t, struct scmi_msg *);
65403ca28cSCristian Marussi static void scmi_mailbox_tx_complete(device_t, void *);
66403ca28cSCristian Marussi
67403ca28cSCristian Marussi static int scmi_mailbox_probe(device_t);
68403ca28cSCristian Marussi
69d46f01fdSAndrew Turner static void
scmi_mailbox_a2p_callback(void * arg)703595f18fSCristian Marussi scmi_mailbox_a2p_callback(void *arg)
71d46f01fdSAndrew Turner {
72d46f01fdSAndrew Turner struct scmi_mailbox_softc *sc;
73*9342829dSCristian Marussi uint32_t msg_header, rx_len;
743595f18fSCristian Marussi int ret;
75d46f01fdSAndrew Turner
76d46f01fdSAndrew Turner sc = arg;
77d46f01fdSAndrew Turner
78*9342829dSCristian Marussi ret = scmi_shmem_read_msg_header(sc->a2p_dev, &msg_header, &rx_len);
793595f18fSCristian Marussi if (ret == 0)
80*9342829dSCristian Marussi scmi_rx_irq_callback(sc->base.dev, sc->a2p_dev, msg_header, rx_len);
81d46f01fdSAndrew Turner }
82d46f01fdSAndrew Turner
83d46f01fdSAndrew Turner static int
scmi_mailbox_transport_init(device_t dev)84403ca28cSCristian Marussi scmi_mailbox_transport_init(device_t dev)
85d46f01fdSAndrew Turner {
86d46f01fdSAndrew Turner struct scmi_mailbox_softc *sc;
87403ca28cSCristian Marussi phandle_t node;
88403ca28cSCristian Marussi
89403ca28cSCristian Marussi sc = device_get_softc(dev);
90403ca28cSCristian Marussi
91403ca28cSCristian Marussi node = ofw_bus_get_node(dev);
92403ca28cSCristian Marussi if (node == -1)
93403ca28cSCristian Marussi return (ENXIO);
94403ca28cSCristian Marussi /*
95403ca28cSCristian Marussi * TODO
96403ca28cSCristian Marussi * - Support P2A shmem + IRQ/doorbell
97403ca28cSCristian Marussi * - Support other mailbox devices
98403ca28cSCristian Marussi */
99403ca28cSCristian Marussi sc->a2p_dev = scmi_shmem_get(dev, node, SCMI_CHAN_A2P);
100403ca28cSCristian Marussi if (sc->a2p_dev == NULL) {
101403ca28cSCristian Marussi device_printf(dev, "A2P shmem dev not found.\n");
102403ca28cSCristian Marussi return (ENXIO);
103403ca28cSCristian Marussi }
104403ca28cSCristian Marussi
105403ca28cSCristian Marussi /* TODO: Fix ofw_get...mbox doorbell names NOT required in Linux DT */
106403ca28cSCristian Marussi sc->db = arm_doorbell_ofw_get(dev, "tx");
107403ca28cSCristian Marussi if (sc->db == NULL) {
108403ca28cSCristian Marussi device_printf(dev, "Doorbell device not found.\n");
109403ca28cSCristian Marussi return (ENXIO);
110403ca28cSCristian Marussi }
111403ca28cSCristian Marussi
1123595f18fSCristian Marussi sc->base.trs_desc.reply_timo_ms = 30;
1133595f18fSCristian Marussi
1143595f18fSCristian Marussi arm_doorbell_set_handler(sc->db, scmi_mailbox_a2p_callback, sc);
115403ca28cSCristian Marussi
116403ca28cSCristian Marussi return (0);
117403ca28cSCristian Marussi }
118403ca28cSCristian Marussi
119403ca28cSCristian Marussi static void
scmi_mailbox_transport_cleanup(device_t dev)120403ca28cSCristian Marussi scmi_mailbox_transport_cleanup(device_t dev)
121403ca28cSCristian Marussi {
122403ca28cSCristian Marussi struct scmi_mailbox_softc *sc;
123403ca28cSCristian Marussi
124403ca28cSCristian Marussi sc = device_get_softc(dev);
125403ca28cSCristian Marussi
126403ca28cSCristian Marussi arm_doorbell_set_handler(sc->db, NULL, NULL);
127403ca28cSCristian Marussi }
128403ca28cSCristian Marussi
129403ca28cSCristian Marussi static int
scmi_mailbox_xfer_msg(device_t dev,struct scmi_msg * msg)13035f93203SCristian Marussi scmi_mailbox_xfer_msg(device_t dev, struct scmi_msg *msg)
131403ca28cSCristian Marussi {
132403ca28cSCristian Marussi struct scmi_mailbox_softc *sc;
1333595f18fSCristian Marussi int ret;
134d46f01fdSAndrew Turner
135d46f01fdSAndrew Turner sc = device_get_softc(dev);
136d46f01fdSAndrew Turner
13735f93203SCristian Marussi ret = scmi_shmem_prepare_msg(sc->a2p_dev, (uint8_t *)&msg->hdr,
13835f93203SCristian Marussi msg->tx_len, msg->polling);
139403ca28cSCristian Marussi if (ret != 0)
140403ca28cSCristian Marussi return (ret);
141403ca28cSCristian Marussi
142d46f01fdSAndrew Turner /* Interrupt SCP firmware. */
143d46f01fdSAndrew Turner arm_doorbell_set(sc->db);
144d46f01fdSAndrew Turner
145d46f01fdSAndrew Turner return (0);
146d46f01fdSAndrew Turner }
147d46f01fdSAndrew Turner
148d46f01fdSAndrew Turner static int
scmi_mailbox_poll_msg(device_t dev,struct scmi_msg * msg,unsigned int tmo_ms)14935f93203SCristian Marussi scmi_mailbox_poll_msg(device_t dev, struct scmi_msg *msg, unsigned int tmo_ms)
1503595f18fSCristian Marussi {
1513595f18fSCristian Marussi struct scmi_mailbox_softc *sc;
1523595f18fSCristian Marussi unsigned int tmo_loops = tmo_ms / SCMI_MBOX_POLL_INTERVAL_MS;
1533595f18fSCristian Marussi
1543595f18fSCristian Marussi sc = device_get_softc(dev);
1553595f18fSCristian Marussi
1563595f18fSCristian Marussi do {
157*9342829dSCristian Marussi if (scmi_shmem_poll_msg(sc->a2p_dev, &msg->hdr, &msg->rx_len))
1583595f18fSCristian Marussi break;
1593595f18fSCristian Marussi DELAY(SCMI_MBOX_POLL_INTERVAL_MS * 1000);
1603595f18fSCristian Marussi } while (tmo_loops--);
1613595f18fSCristian Marussi
1623595f18fSCristian Marussi return (tmo_loops ? 0 : 1);
1633595f18fSCristian Marussi }
1643595f18fSCristian Marussi
1653595f18fSCristian Marussi static int
scmi_mailbox_collect_reply(device_t dev,struct scmi_msg * msg)16635f93203SCristian Marussi scmi_mailbox_collect_reply(device_t dev, struct scmi_msg *msg)
167403ca28cSCristian Marussi {
168403ca28cSCristian Marussi struct scmi_mailbox_softc *sc;
169403ca28cSCristian Marussi int ret;
170403ca28cSCristian Marussi
171403ca28cSCristian Marussi sc = device_get_softc(dev);
172403ca28cSCristian Marussi
17335f93203SCristian Marussi ret = scmi_shmem_read_msg_payload(sc->a2p_dev,
174*9342829dSCristian Marussi msg->payld, msg->rx_len - SCMI_MSG_HDR_SIZE, msg->rx_len);
17535f93203SCristian Marussi
176403ca28cSCristian Marussi return (ret);
177403ca28cSCristian Marussi }
178403ca28cSCristian Marussi
179403ca28cSCristian Marussi static void
scmi_mailbox_tx_complete(device_t dev,void * chan)180403ca28cSCristian Marussi scmi_mailbox_tx_complete(device_t dev, void *chan)
181403ca28cSCristian Marussi {
182403ca28cSCristian Marussi struct scmi_mailbox_softc *sc;
183403ca28cSCristian Marussi
184403ca28cSCristian Marussi sc = device_get_softc(dev);
185403ca28cSCristian Marussi scmi_shmem_tx_complete(sc->a2p_dev);
186403ca28cSCristian Marussi }
187403ca28cSCristian Marussi
1883595f18fSCristian Marussi static void
scmi_mailbox_clear_channel(device_t dev,void * chan)1893595f18fSCristian Marussi scmi_mailbox_clear_channel(device_t dev, void *chan)
1903595f18fSCristian Marussi {
1913595f18fSCristian Marussi /* Only P2A channel can be cleared forcibly by agent */
1923595f18fSCristian Marussi scmi_shmem_clear_channel(chan);
1933595f18fSCristian Marussi }
1943595f18fSCristian Marussi
195403ca28cSCristian Marussi static int
scmi_mailbox_probe(device_t dev)196d46f01fdSAndrew Turner scmi_mailbox_probe(device_t dev)
197d46f01fdSAndrew Turner {
198d46f01fdSAndrew Turner
199d46f01fdSAndrew Turner if (!ofw_bus_is_compatible(dev, "arm,scmi"))
200d46f01fdSAndrew Turner return (ENXIO);
201d46f01fdSAndrew Turner
202d46f01fdSAndrew Turner if (!ofw_bus_status_okay(dev))
203d46f01fdSAndrew Turner return (ENXIO);
204d46f01fdSAndrew Turner
20535f93203SCristian Marussi device_set_desc(dev, "ARM SCMI Mailbox Transport driver");
206d46f01fdSAndrew Turner
207d46f01fdSAndrew Turner return (BUS_PROBE_DEFAULT);
208d46f01fdSAndrew Turner }
209d46f01fdSAndrew Turner
210d46f01fdSAndrew Turner static device_method_t scmi_mailbox_methods[] = {
211d46f01fdSAndrew Turner DEVMETHOD(device_probe, scmi_mailbox_probe),
212d46f01fdSAndrew Turner
213d46f01fdSAndrew Turner /* SCMI interface */
214403ca28cSCristian Marussi DEVMETHOD(scmi_transport_init, scmi_mailbox_transport_init),
215403ca28cSCristian Marussi DEVMETHOD(scmi_transport_cleanup, scmi_mailbox_transport_cleanup),
216d46f01fdSAndrew Turner DEVMETHOD(scmi_xfer_msg, scmi_mailbox_xfer_msg),
2173595f18fSCristian Marussi DEVMETHOD(scmi_poll_msg, scmi_mailbox_poll_msg),
218403ca28cSCristian Marussi DEVMETHOD(scmi_collect_reply, scmi_mailbox_collect_reply),
219403ca28cSCristian Marussi DEVMETHOD(scmi_tx_complete, scmi_mailbox_tx_complete),
2203595f18fSCristian Marussi DEVMETHOD(scmi_clear_channel, scmi_mailbox_clear_channel),
221d46f01fdSAndrew Turner
222d46f01fdSAndrew Turner DEVMETHOD_END
223d46f01fdSAndrew Turner };
224d46f01fdSAndrew Turner
225d46f01fdSAndrew Turner DEFINE_CLASS_1(scmi_mailbox, scmi_mailbox_driver, scmi_mailbox_methods,
226d46f01fdSAndrew Turner sizeof(struct scmi_mailbox_softc), scmi_driver);
227d46f01fdSAndrew Turner
228d46f01fdSAndrew Turner DRIVER_MODULE(scmi_mailbox, simplebus, scmi_mailbox_driver, 0, 0);
229d46f01fdSAndrew Turner MODULE_VERSION(scmi_mailbox, 1);
230