2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2006, Cisco Systems, Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of Cisco Systems, Inc. nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/module.h>
38 #include <sys/systm.h>
40 #include <sys/malloc.h>
41 #include <sys/kernel.h>
42 #include <sys/socket.h>
43 #include <sys/queue.h>
45 #include <machine/vmparam.h>
49 #include <machine/bus.h>
50 #include <machine/resource.h>
51 #include <machine/frame.h>
56 #include <machine/intr_machdep.h>
58 #include <machine/xen-os.h>
59 #include <machine/hypervisor.h>
60 #include <machine/hypervisor-ifs.h>
61 #include <machine/xen_intr.h>
62 #include <machine/evtchn.h>
63 #include <machine/xenbus.h>
64 #include <machine/gnttab.h>
65 #include <machine/xen-public/memory.h>
66 #include <machine/xen-public/io/pciif.h>
68 #include <sys/pciio.h>
69 #include <dev/pci/pcivar.h>
72 #ifdef XEN_PCIDEV_FE_DEBUG
73 #define DPRINTF(fmt, args...) \
74 printf("pcifront (%s:%d): " fmt, __FUNCTION__, __LINE__, ##args)
76 #define DPRINTF(fmt, args...) ((void)0)
78 #define WPRINTF(fmt, args...) \
79 printf("pcifront (%s:%d): " fmt, __FUNCTION__, __LINE__, ##args)
81 #define INVALID_GRANT_REF (0)
82 #define INVALID_EVTCHN (-1)
83 #define virt_to_mfn(x) (vtophys(x) >> PAGE_SHIFT)
85 struct pcifront_device {
86 STAILQ_ENTRY(pcifront_device) next;
88 struct xenbus_device *xdev;
94 /* Lock this when doing any operations in sh_info */
95 struct mtx sh_info_lock;
96 struct xen_pci_sharedinfo *sh_info;
103 static STAILQ_HEAD(pcifront_dlist, pcifront_device) pdev_list = STAILQ_HEAD_INITIALIZER(pdev_list);
108 struct pcifront_device *pdev;
111 /* Allocate a PCI device structure */
112 static struct pcifront_device *
113 alloc_pdev(struct xenbus_device *xdev)
115 struct pcifront_device *pdev = NULL;
118 err = sscanf(xdev->nodename, "device/pci/%d", &unit);
122 xenbus_dev_fatal(pdev->xdev, err, "Error scanning pci device instance number");
126 pdev = (struct pcifront_device *)malloc(sizeof(struct pcifront_device), M_DEVBUF, M_NOWAIT);
129 xenbus_dev_fatal(xdev, err, "Error allocating pcifront_device struct");
136 pdev->sh_info = (struct xen_pci_sharedinfo *)malloc(PAGE_SIZE, M_DEVBUF, M_NOWAIT);
137 if (pdev->sh_info == NULL) {
138 free(pdev, M_DEVBUF);
141 xenbus_dev_fatal(xdev, err, "Error allocating sh_info struct");
144 pdev->sh_info->flags = 0;
148 mtx_init(&pdev->sh_info_lock, "info_lock", "pci shared dev info lock", MTX_DEF);
150 pdev->evtchn = INVALID_EVTCHN;
151 pdev->gnt_ref = INVALID_GRANT_REF;
153 STAILQ_INSERT_TAIL(&pdev_list, pdev, next);
155 DPRINTF("Allocated pdev @ 0x%p (unit=%d)\n", pdev, unit);
161 /* Hold a reference to a pcifront device */
163 get_pdev(struct pcifront_device *pdev)
168 /* Release a reference to a pcifront device */
170 put_pdev(struct pcifront_device *pdev)
172 if (--pdev->ref_cnt > 0)
175 DPRINTF("freeing pdev @ 0x%p (ref_cnt=%d)\n", pdev, pdev->ref_cnt);
177 if (pdev->evtchn != INVALID_EVTCHN)
178 xenbus_free_evtchn(pdev->xdev, pdev->evtchn);
180 if (pdev->gnt_ref != INVALID_GRANT_REF)
181 gnttab_end_foreign_access(pdev->gnt_ref, 0, (void *)pdev->sh_info);
183 pdev->xdev->data = NULL;
185 free(pdev, M_DEVBUF);
189 /* Write to the xenbus info needed by backend */
191 pcifront_publish_info(struct pcifront_device *pdev)
194 struct xenbus_transaction *trans;
196 err = xenbus_grant_ring(pdev->xdev, virt_to_mfn(pdev->sh_info));
198 WPRINTF("error granting access to ring page\n");
204 err = xenbus_alloc_evtchn(pdev->xdev, &pdev->evtchn);
209 trans = xenbus_transaction_start();
211 xenbus_dev_fatal(pdev->xdev, err,
212 "Error writing configuration for backend "
213 "(start transaction)");
217 err = xenbus_printf(trans, pdev->xdev->nodename,
218 "pci-op-ref", "%u", pdev->gnt_ref);
220 err = xenbus_printf(trans, pdev->xdev->nodename,
221 "event-channel", "%u", pdev->evtchn);
223 err = xenbus_printf(trans, pdev->xdev->nodename,
224 "magic", XEN_PCI_MAGIC);
226 err = xenbus_switch_state(pdev->xdev, trans,
227 XenbusStateInitialised);
230 xenbus_transaction_end(trans, 1);
231 xenbus_dev_fatal(pdev->xdev, err,
232 "Error writing configuration for backend");
235 err = xenbus_transaction_end(trans, 0);
239 xenbus_dev_fatal(pdev->xdev, err,
240 "Error completing transaction for backend");
249 /* The backend is now connected so complete the connection process on our side */
251 pcifront_connect(struct pcifront_device *pdev)
254 devclass_t nexus_devclass;
256 /* We will add our device as a child of the nexus0 device */
257 if (!(nexus_devclass = devclass_find("nexus")) ||
258 !(nexus = devclass_get_device(nexus_devclass, 0))) {
259 WPRINTF("could not find nexus0!\n");
263 /* Create a newbus device representing this frontend instance */
264 pdev->ndev = BUS_ADD_CHILD(nexus, 0, "xpcife", pdev->unit);
266 WPRINTF("could not create xpcife%d!\n", pdev->unit);
270 device_set_ivars(pdev->ndev, pdev);
272 /* Good to go connected now */
273 xenbus_switch_state(pdev->xdev, NULL, XenbusStateConnected);
275 printf("pcifront: connected to %s\n", pdev->xdev->nodename);
278 device_probe_and_attach(pdev->ndev);
284 /* The backend is closing so process a disconnect */
286 pcifront_disconnect(struct pcifront_device *pdev)
289 XenbusState prev_state;
291 prev_state = xenbus_read_driver_state(pdev->xdev->nodename);
293 if (prev_state < XenbusStateClosing) {
294 err = xenbus_switch_state(pdev->xdev, NULL, XenbusStateClosing);
295 if (!err && prev_state == XenbusStateConnected) {
296 /* TODO - need to detach the newbus devices */
303 /* Process a probe from the xenbus */
305 pcifront_probe(struct xenbus_device *xdev,
306 const struct xenbus_device_id *id)
309 struct pcifront_device *pdev;
311 DPRINTF("xenbus probing\n");
313 if ((pdev = alloc_pdev(xdev)) == NULL)
316 err = pcifront_publish_info(pdev);
324 /* Remove the xenbus PCI device */
326 pcifront_remove(struct xenbus_device *xdev)
328 DPRINTF("removing xenbus device node (%s)\n", xdev->nodename);
330 put_pdev(xdev->data);
334 /* Called by xenbus when our backend node changes state */
336 pcifront_backend_changed(struct xenbus_device *xdev,
337 XenbusState be_state)
339 struct pcifront_device *pdev = xdev->data;
342 case XenbusStateClosing:
343 DPRINTF("backend closing (%s)\n", xdev->nodename);
344 pcifront_disconnect(pdev);
347 case XenbusStateClosed:
348 DPRINTF("backend closed (%s)\n", xdev->nodename);
349 pcifront_disconnect(pdev);
352 case XenbusStateConnected:
353 DPRINTF("backend connected (%s)\n", xdev->nodename);
354 pcifront_connect(pdev);
362 /* Process PCI operation */
364 do_pci_op(struct pcifront_device *pdev, struct xen_pci_op *op)
367 struct xen_pci_op *active_op = &pdev->sh_info->op;
368 evtchn_port_t port = pdev->evtchn;
371 mtx_lock(&pdev->sh_info_lock);
373 memcpy(active_op, op, sizeof(struct xen_pci_op));
377 set_bit(_XEN_PCIF_active, (unsigned long *)&pdev->sh_info->flags);
378 notify_remote_via_evtchn(port);
380 timeout = time_uptime + 2;
384 /* Spin while waiting for the answer */
386 (_XEN_PCIF_active, (unsigned long *)&pdev->sh_info->flags)) {
387 int err = HYPERVISOR_poll(&port, 1, 3 * hz);
389 panic("Failed HYPERVISOR_poll: err=%d", err);
391 if (time_uptime > timeout) {
392 WPRINTF("pciback not responding!!!\n");
393 clear_bit(_XEN_PCIF_active,
394 (unsigned long *)&pdev->sh_info->flags);
395 err = XEN_PCI_ERR_dev_not_found;
400 memcpy(op, active_op, sizeof(struct xen_pci_op));
404 mtx_unlock(&pdev->sh_info_lock);
408 /* ** XenBus Driver registration ** */
410 static struct xenbus_device_id pcifront_ids[] = {
415 static struct xenbus_driver pcifront = {
418 .probe = pcifront_probe,
419 .remove = pcifront_remove,
420 .otherend_changed = pcifront_backend_changed,
423 /* Register the driver with xenbus during sys init */
425 pcifront_init(void *unused)
427 if ((xen_start_info->flags & SIF_INITDOMAIN))
430 DPRINTF("xenbus registering\n");
432 xenbus_register_frontend(&pcifront);
435 SYSINIT(pciif, SI_SUB_PSEUDO, SI_ORDER_ANY, pcifront_init, NULL)
438 /* Newbus xpcife device driver probe */
440 xpcife_probe(device_t dev)
442 #ifdef XEN_PCIDEV_FE_DEBUG
443 struct pcifront_device *pdev = (struct pcifront_device *)device_get_ivars(dev);
444 DPRINTF("xpcife probe (unit=%d)\n", pdev->unit);
446 return (BUS_PROBE_NOWILDCARD);
449 /* Newbus xpcife device driver attach */
451 xpcife_attach(device_t dev)
453 struct pcifront_device *pdev = (struct pcifront_device *)device_get_ivars(dev);
454 int i, num_roots, len, err;
456 unsigned int domain, bus;
458 DPRINTF("xpcife attach (unit=%d)\n", pdev->unit);
460 err = xenbus_scanf(NULL, pdev->xdev->otherend,
461 "root_num", "%d", &num_roots);
465 xenbus_dev_fatal(pdev->xdev, err,
466 "Error reading number of PCI roots");
470 /* Add a pcib device for each root */
471 for (i = 0; i < num_roots; i++) {
474 len = snprintf(str, sizeof(str), "root-%d", i);
475 if (unlikely(len >= (sizeof(str) - 1))) {
480 err = xenbus_scanf(NULL, pdev->xdev->otherend, str,
481 "%x:%x", &domain, &bus);
485 xenbus_dev_fatal(pdev->xdev, err,
486 "Error reading PCI root %d", i);
490 if (domain != pdev->xdev->otherend_id) {
492 xenbus_dev_fatal(pdev->xdev, err,
493 "Domain mismatch %d != %d", domain, pdev->xdev->otherend_id);
497 child = device_add_child(dev, "pcib", bus);
500 xenbus_dev_fatal(pdev->xdev, err,
501 "Unable to create pcib%d", bus);
507 return bus_generic_attach(dev);
510 static devclass_t xpcife_devclass;
512 static device_method_t xpcife_methods[] = {
513 /* Device interface */
514 DEVMETHOD(device_probe, xpcife_probe),
515 DEVMETHOD(device_attach, xpcife_attach),
516 DEVMETHOD(device_detach, bus_generic_detach),
517 DEVMETHOD(device_shutdown, bus_generic_shutdown),
518 DEVMETHOD(device_suspend, bus_generic_suspend),
519 DEVMETHOD(device_resume, bus_generic_resume),
521 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
522 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
523 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
524 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
525 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
526 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
531 static driver_t xpcife_driver = {
537 DRIVER_MODULE(xpcife, nexus, xpcife_driver, xpcife_devclass, 0, 0);
540 /* Newbus xen pcib device driver probe */
542 xpcib_probe(device_t dev)
544 struct xpcib_softc *sc = (struct xpcib_softc *)device_get_softc(dev);
545 struct pcifront_device *pdev = (struct pcifront_device *)device_get_ivars(device_get_parent(dev));
547 DPRINTF("xpcib probe (bus=%d)\n", device_get_unit(dev));
549 sc->domain = pdev->xdev->otherend_id;
550 sc->bus = device_get_unit(dev);
556 /* Newbus xen pcib device driver attach */
558 xpcib_attach(device_t dev)
560 struct xpcib_softc *sc = (struct xpcib_softc *)device_get_softc(dev);
562 DPRINTF("xpcib attach (bus=%d)\n", sc->bus);
564 device_add_child(dev, "pci", -1);
565 return bus_generic_attach(dev);
569 xpcib_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
571 struct xpcib_softc *sc = (struct xpcib_softc *)device_get_softc(dev);
580 /* Return the number of slots supported */
582 xpcib_maxslots(device_t dev)
587 #define PCI_DEVFN(slot,func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
589 /* Read configuration space register */
591 xpcib_read_config(device_t dev, int bus, int slot, int func,
594 struct xpcib_softc *sc = (struct xpcib_softc *)device_get_softc(dev);
595 struct xen_pci_op op = {
596 .cmd = XEN_PCI_OP_conf_read,
597 .domain = sc->domain,
599 .devfn = PCI_DEVFN(slot, func),
605 err = do_pci_op(sc->pdev, &op);
607 DPRINTF("read config (b=%d, s=%d, f=%d, reg=%d, len=%d, val=%x, err=%d)\n",
608 bus, slot, func, reg, bytes, op.value, err);
616 /* Write configuration space register */
618 xpcib_write_config(device_t dev, int bus, int slot, int func,
619 int reg, u_int32_t data, int bytes)
621 struct xpcib_softc *sc = (struct xpcib_softc *)device_get_softc(dev);
622 struct xen_pci_op op = {
623 .cmd = XEN_PCI_OP_conf_write,
624 .domain = sc->domain,
626 .devfn = PCI_DEVFN(slot, func),
633 err = do_pci_op(sc->pdev, &op);
635 DPRINTF("write config (b=%d, s=%d, f=%d, reg=%d, len=%d, val=%x, err=%d)\n",
636 bus, slot, func, reg, bytes, data, err);
640 xpcib_route_interrupt(device_t pcib, device_t dev, int pin)
642 struct pci_devinfo *dinfo = device_get_ivars(dev);
643 pcicfgregs *cfg = &dinfo->cfg;
645 DPRINTF("route intr (pin=%d, line=%d)\n", pin, cfg->intline);
650 static device_method_t xpcib_methods[] = {
651 /* Device interface */
652 DEVMETHOD(device_probe, xpcib_probe),
653 DEVMETHOD(device_attach, xpcib_attach),
654 DEVMETHOD(device_detach, bus_generic_detach),
655 DEVMETHOD(device_shutdown, bus_generic_shutdown),
656 DEVMETHOD(device_suspend, bus_generic_suspend),
657 DEVMETHOD(device_resume, bus_generic_resume),
660 DEVMETHOD(bus_read_ivar, xpcib_read_ivar),
661 DEVMETHOD(bus_alloc_resource, bus_generic_alloc_resource),
662 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
663 DEVMETHOD(bus_release_resource, bus_generic_release_resource),
664 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
665 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr),
666 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
669 DEVMETHOD(pcib_maxslots, xpcib_maxslots),
670 DEVMETHOD(pcib_read_config, xpcib_read_config),
671 DEVMETHOD(pcib_write_config, xpcib_write_config),
672 DEVMETHOD(pcib_route_interrupt, xpcib_route_interrupt),
673 DEVMETHOD(pcib_request_feature, pcib_request_feature_allow),
678 static devclass_t xpcib_devclass;
680 DEFINE_CLASS_0(pcib, xpcib_driver, xpcib_methods, sizeof(struct xpcib_softc));
681 DRIVER_MODULE(pcib, xpcife, xpcib_driver, xpcib_devclass, 0, 0);
689 * indent-tabs-mode: t