Home | History | Annotate | Line # | Download | only in virtio
virtio_mmio.c revision 1.7.4.3
      1  1.7.4.3    martin /*	$NetBSD: virtio_mmio.c,v 1.7.4.3 2023/07/09 13:39:27 martin Exp $	*/
      2      1.1  jakllsch /*	$OpenBSD: virtio_mmio.c,v 1.2 2017/02/24 17:12:31 patrick Exp $	*/
      3      1.1  jakllsch 
      4      1.1  jakllsch /*
      5      1.1  jakllsch  * Copyright (c) 2014 Patrick Wildt <patrick (at) blueri.se>
      6      1.1  jakllsch  * Copyright (c) 2012 Stefan Fritsch.
      7      1.1  jakllsch  * Copyright (c) 2010 Minoura Makoto.
      8      1.1  jakllsch  * All rights reserved.
      9      1.1  jakllsch  *
     10      1.1  jakllsch  * Redistribution and use in source and binary forms, with or without
     11      1.1  jakllsch  * modification, are permitted provided that the following conditions
     12      1.1  jakllsch  * are met:
     13      1.1  jakllsch  * 1. Redistributions of source code must retain the above copyright
     14      1.1  jakllsch  *    notice, this list of conditions and the following disclaimer.
     15      1.1  jakllsch  * 2. Redistributions in binary form must reproduce the above copyright
     16      1.1  jakllsch  *    notice, this list of conditions and the following disclaimer in the
     17      1.1  jakllsch  *    documentation and/or other materials provided with the distribution.
     18      1.1  jakllsch  *
     19      1.1  jakllsch  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     20      1.1  jakllsch  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     21      1.1  jakllsch  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     22      1.1  jakllsch  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     23      1.1  jakllsch  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     24      1.1  jakllsch  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     25      1.1  jakllsch  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     26      1.1  jakllsch  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     27      1.1  jakllsch  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     28      1.1  jakllsch  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     29      1.1  jakllsch  */
     30      1.1  jakllsch 
     31      1.1  jakllsch #include <sys/cdefs.h>
     32  1.7.4.3    martin __KERNEL_RCSID(0, "$NetBSD: virtio_mmio.c,v 1.7.4.3 2023/07/09 13:39:27 martin Exp $");
     33      1.1  jakllsch 
     34      1.1  jakllsch #include <sys/param.h>
     35      1.1  jakllsch #include <sys/systm.h>
     36      1.1  jakllsch #include <sys/kernel.h>
     37      1.1  jakllsch #include <sys/device.h>
     38      1.1  jakllsch #include <sys/mutex.h>
     39      1.1  jakllsch 
     40      1.1  jakllsch #define VIRTIO_PRIVATE
     41      1.1  jakllsch #include <dev/virtio/virtio_mmiovar.h>
     42      1.1  jakllsch 
     43      1.1  jakllsch #define VIRTIO_MMIO_MAGIC		('v' | 'i' << 8 | 'r' << 16 | 't' << 24)
     44      1.1  jakllsch 
     45      1.1  jakllsch #define VIRTIO_MMIO_MAGIC_VALUE		0x000
     46      1.1  jakllsch #define VIRTIO_MMIO_VERSION		0x004
     47      1.1  jakllsch #define VIRTIO_MMIO_DEVICE_ID		0x008
     48      1.1  jakllsch #define VIRTIO_MMIO_VENDOR_ID		0x00c
     49      1.1  jakllsch #define VIRTIO_MMIO_HOST_FEATURES	0x010
     50      1.1  jakllsch #define VIRTIO_MMIO_HOST_FEATURES_SEL	0x014
     51      1.1  jakllsch #define VIRTIO_MMIO_GUEST_FEATURES	0x020
     52      1.1  jakllsch #define VIRTIO_MMIO_GUEST_FEATURES_SEL	0x024
     53      1.1  jakllsch #define VIRTIO_MMIO_GUEST_PAGE_SIZE	0x028
     54      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_SEL		0x030
     55      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_NUM_MAX	0x034
     56      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_NUM		0x038
     57      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_ALIGN		0x03c
     58      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_PFN		0x040
     59      1.1  jakllsch #define VIRTIO_MMIO_QUEUE_NOTIFY	0x050
     60      1.1  jakllsch #define VIRTIO_MMIO_INTERRUPT_STATUS	0x060
     61      1.1  jakllsch #define VIRTIO_MMIO_INTERRUPT_ACK	0x064
     62      1.1  jakllsch #define VIRTIO_MMIO_STATUS		0x070
     63      1.1  jakllsch #define VIRTIO_MMIO_CONFIG		0x100
     64      1.1  jakllsch 
     65      1.1  jakllsch #define VIRTIO_MMIO_INT_VRING		(1 << 0)
     66      1.1  jakllsch #define VIRTIO_MMIO_INT_CONFIG		(1 << 1)
     67      1.1  jakllsch 
     68      1.1  jakllsch /*
     69      1.4   reinoud  * MMIO configuration space for virtio-mmio v1 is in guest byte order.
     70      1.4   reinoud  *
     71  1.7.4.3    martin  * XXX For big-endian aarch64 and arm, see note in virtio_pci.c.
     72      1.3  jmcneill  */
     73      1.4   reinoud 
     74  1.7.4.3    martin #if (defined(__aarch64__) || defined(__arm__)) && BYTE_ORDER == BIG_ENDIAN
     75      1.5   reinoud #	define READ_ENDIAN	LITTLE_ENDIAN
     76      1.5   reinoud #	define STRUCT_ENDIAN	BIG_ENDIAN
     77      1.5   reinoud #elif BYTE_ORDER == BIG_ENDIAN
     78      1.5   reinoud #	define READ_ENDIAN	BIG_ENDIAN
     79      1.5   reinoud #	define STRUCT_ENDIAN	BIG_ENDIAN
     80      1.3  jmcneill #else
     81      1.5   reinoud #	define READ_ENDIAN	LITTLE_ENDIAN
     82      1.5   reinoud #	define STRUCT_ENDIAN	LITTLE_ENDIAN
     83      1.3  jmcneill #endif
     84      1.3  jmcneill 
     85      1.1  jakllsch 
     86      1.1  jakllsch static void	virtio_mmio_kick(struct virtio_softc *, uint16_t);
     87      1.1  jakllsch static uint16_t	virtio_mmio_read_queue_size(struct virtio_softc *, uint16_t);
     88      1.4   reinoud static void	virtio_mmio_setup_queue(struct virtio_softc *, uint16_t, uint64_t);
     89      1.1  jakllsch static void	virtio_mmio_set_status(struct virtio_softc *, int);
     90      1.4   reinoud static void	virtio_mmio_negotiate_features(struct virtio_softc *, uint64_t);
     91      1.7  yamaguch static int	virtio_mmio_alloc_interrupts(struct virtio_softc *);
     92      1.1  jakllsch static void	virtio_mmio_free_interrupts(struct virtio_softc *);
     93      1.7  yamaguch static int	virtio_mmio_setup_interrupts(struct virtio_softc *, int);
     94      1.1  jakllsch 
     95      1.1  jakllsch static const struct virtio_ops virtio_mmio_ops = {
     96      1.1  jakllsch 	.kick = virtio_mmio_kick,
     97      1.1  jakllsch 	.read_queue_size = virtio_mmio_read_queue_size,
     98      1.1  jakllsch 	.setup_queue = virtio_mmio_setup_queue,
     99      1.1  jakllsch 	.set_status = virtio_mmio_set_status,
    100      1.1  jakllsch 	.neg_features = virtio_mmio_negotiate_features,
    101      1.7  yamaguch 	.alloc_interrupts = virtio_mmio_alloc_interrupts,
    102      1.7  yamaguch 	.free_interrupts = virtio_mmio_free_interrupts,
    103      1.1  jakllsch 	.setup_interrupts = virtio_mmio_setup_interrupts,
    104      1.1  jakllsch };
    105      1.1  jakllsch 
    106      1.1  jakllsch static uint16_t
    107      1.1  jakllsch virtio_mmio_read_queue_size(struct virtio_softc *vsc, uint16_t idx)
    108      1.1  jakllsch {
    109      1.1  jakllsch 	struct virtio_mmio_softc *sc = (struct virtio_mmio_softc *)vsc;
    110      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_SEL, idx);
    111      1.1  jakllsch 	return bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    112      1.1  jakllsch 	    VIRTIO_MMIO_QUEUE_NUM_MAX);
    113      1.1  jakllsch }
    114      1.1  jakllsch 
    115      1.1  jakllsch static void
    116      1.4   reinoud virtio_mmio_setup_queue(struct virtio_softc *vsc, uint16_t idx, uint64_t addr)
    117      1.1  jakllsch {
    118      1.1  jakllsch 	struct virtio_mmio_softc *sc = (struct virtio_mmio_softc *)vsc;
    119      1.1  jakllsch 
    120      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_SEL, idx);
    121      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_NUM,
    122      1.1  jakllsch 	    bus_space_read_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_NUM_MAX));
    123      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_ALIGN,
    124      1.1  jakllsch 	    VIRTIO_PAGE_SIZE);
    125      1.4   reinoud 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_PFN,
    126      1.4   reinoud 	    addr / VIRTIO_PAGE_SIZE);
    127      1.1  jakllsch }
    128      1.1  jakllsch 
    129      1.1  jakllsch static void
    130      1.1  jakllsch virtio_mmio_set_status(struct virtio_softc *vsc, int status)
    131      1.1  jakllsch {
    132      1.1  jakllsch 	struct virtio_mmio_softc *sc = (struct virtio_mmio_softc *)vsc;
    133      1.1  jakllsch 	int old = 0;
    134      1.1  jakllsch 
    135      1.1  jakllsch 	if (status != 0)
    136      1.1  jakllsch 		old = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    137      1.1  jakllsch 				       VIRTIO_MMIO_STATUS);
    138      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_STATUS,
    139      1.1  jakllsch 			  status|old);
    140      1.1  jakllsch }
    141      1.1  jakllsch 
    142      1.6   reinoud bool
    143      1.6   reinoud virtio_mmio_common_probe_present(struct virtio_mmio_softc *sc)
    144      1.6   reinoud {
    145      1.6   reinoud 	uint32_t magic;
    146      1.6   reinoud 
    147      1.6   reinoud 	magic = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    148      1.6   reinoud 	    VIRTIO_MMIO_MAGIC_VALUE);
    149      1.6   reinoud 	return (magic == VIRTIO_MMIO_MAGIC);
    150      1.6   reinoud }
    151      1.6   reinoud 
    152      1.1  jakllsch void
    153      1.1  jakllsch virtio_mmio_common_attach(struct virtio_mmio_softc *sc)
    154      1.1  jakllsch {
    155      1.1  jakllsch 	struct virtio_softc *vsc = &sc->sc_sc;
    156      1.4   reinoud 	device_t self = vsc->sc_dev;
    157      1.1  jakllsch 	uint32_t id, magic, ver;
    158      1.1  jakllsch 
    159      1.1  jakllsch 	magic = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    160      1.1  jakllsch 	    VIRTIO_MMIO_MAGIC_VALUE);
    161      1.1  jakllsch 	if (magic != VIRTIO_MMIO_MAGIC) {
    162      1.1  jakllsch 		aprint_error_dev(vsc->sc_dev,
    163      1.1  jakllsch 		    "wrong magic value 0x%08x; giving up\n", magic);
    164      1.1  jakllsch 		return;
    165      1.1  jakllsch 	}
    166      1.1  jakllsch 
    167      1.1  jakllsch 	ver = bus_space_read_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_VERSION);
    168      1.1  jakllsch 	if (ver != 1) {
    169      1.1  jakllsch 		aprint_error_dev(vsc->sc_dev,
    170      1.1  jakllsch 		    "unknown version 0x%02x; giving up\n", ver);
    171      1.1  jakllsch 		return;
    172      1.1  jakllsch 	}
    173      1.1  jakllsch 
    174      1.1  jakllsch 	id = bus_space_read_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_DEVICE_ID);
    175      1.1  jakllsch 
    176      1.1  jakllsch 	/* we could use PAGE_SIZE, but virtio(4) assumes 4KiB for now */
    177      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_GUEST_PAGE_SIZE,
    178      1.1  jakllsch 	    VIRTIO_PAGE_SIZE);
    179      1.1  jakllsch 
    180      1.4   reinoud 	/* no device connected. */
    181      1.1  jakllsch 	if (id == 0)
    182      1.1  jakllsch 		return;
    183      1.1  jakllsch 
    184      1.4   reinoud 	virtio_print_device_type(self, id, ver);
    185      1.1  jakllsch 	vsc->sc_ops = &virtio_mmio_ops;
    186      1.5   reinoud 	vsc->sc_bus_endian    = READ_ENDIAN;
    187      1.5   reinoud 	vsc->sc_struct_endian = STRUCT_ENDIAN;
    188      1.4   reinoud 
    189      1.4   reinoud 	/* set up our device config tag */
    190      1.4   reinoud 	vsc->sc_devcfg_iosize = sc->sc_iosize - VIRTIO_MMIO_CONFIG;
    191      1.4   reinoud 	vsc->sc_devcfg_iot = sc->sc_iot;
    192      1.4   reinoud 	if (bus_space_subregion(sc->sc_iot, sc->sc_ioh,
    193      1.4   reinoud 			VIRTIO_MMIO_CONFIG, vsc->sc_devcfg_iosize,
    194      1.4   reinoud 			&vsc->sc_devcfg_ioh)) {
    195      1.4   reinoud 		aprint_error_dev(self, "can't map config i/o space\n");
    196      1.4   reinoud 		return;
    197      1.4   reinoud 	}
    198      1.1  jakllsch 
    199      1.1  jakllsch 	virtio_device_reset(vsc);
    200      1.1  jakllsch 	virtio_mmio_set_status(vsc, VIRTIO_CONFIG_DEVICE_STATUS_ACK);
    201      1.1  jakllsch 	virtio_mmio_set_status(vsc, VIRTIO_CONFIG_DEVICE_STATUS_DRIVER);
    202      1.1  jakllsch 
    203      1.1  jakllsch 	/* XXX: use softc as aux... */
    204      1.1  jakllsch 	vsc->sc_childdevid = id;
    205      1.1  jakllsch 	vsc->sc_child = NULL;
    206      1.1  jakllsch }
    207      1.1  jakllsch 
    208      1.1  jakllsch int
    209      1.1  jakllsch virtio_mmio_common_detach(struct virtio_mmio_softc *sc, int flags)
    210      1.1  jakllsch {
    211      1.1  jakllsch 	struct virtio_softc *vsc = &sc->sc_sc;
    212      1.1  jakllsch 	int r;
    213      1.1  jakllsch 
    214  1.7.4.1    martin 	r = config_detach_children(vsc->sc_dev, flags);
    215  1.7.4.1    martin 	if (r != 0)
    216  1.7.4.1    martin 		return r;
    217  1.7.4.1    martin 
    218  1.7.4.2    martin 	KASSERT(vsc->sc_child == NULL);
    219      1.1  jakllsch 	KASSERT(vsc->sc_vqs == NULL);
    220      1.1  jakllsch 	KASSERT(sc->sc_ih == NULL);
    221      1.1  jakllsch 
    222      1.1  jakllsch 	if (sc->sc_iosize) {
    223      1.1  jakllsch 		bus_space_unmap(sc->sc_iot, sc->sc_ioh, sc->sc_iosize);
    224      1.1  jakllsch 		sc->sc_iosize = 0;
    225      1.1  jakllsch 	}
    226      1.1  jakllsch 
    227      1.1  jakllsch 	return 0;
    228      1.1  jakllsch }
    229      1.1  jakllsch 
    230      1.1  jakllsch /*
    231      1.1  jakllsch  * Feature negotiation.
    232      1.1  jakllsch  */
    233      1.4   reinoud static void
    234      1.4   reinoud virtio_mmio_negotiate_features(struct virtio_softc *vsc, uint64_t
    235      1.1  jakllsch     guest_features)
    236      1.1  jakllsch {
    237      1.1  jakllsch 	struct virtio_mmio_softc *sc = (struct virtio_mmio_softc *)vsc;
    238      1.1  jakllsch 	uint32_t r;
    239      1.1  jakllsch 
    240      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    241      1.1  jakllsch 	    VIRTIO_MMIO_HOST_FEATURES_SEL, 0);
    242      1.1  jakllsch 	r = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    243      1.1  jakllsch 				VIRTIO_MMIO_HOST_FEATURES);
    244      1.1  jakllsch 	r &= guest_features;
    245      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    246      1.1  jakllsch 	    VIRTIO_MMIO_GUEST_FEATURES_SEL, 0);
    247      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    248      1.1  jakllsch 			  VIRTIO_MMIO_GUEST_FEATURES, r);
    249      1.4   reinoud 
    250      1.4   reinoud 	vsc->sc_active_features = r;
    251      1.1  jakllsch }
    252      1.1  jakllsch 
    253      1.1  jakllsch /*
    254      1.1  jakllsch  * Interrupt handler.
    255      1.1  jakllsch  */
    256      1.1  jakllsch int
    257      1.1  jakllsch virtio_mmio_intr(void *arg)
    258      1.1  jakllsch {
    259      1.1  jakllsch 	struct virtio_mmio_softc *sc = arg;
    260      1.1  jakllsch 	struct virtio_softc *vsc = &sc->sc_sc;
    261      1.1  jakllsch 	int isr, r = 0;
    262      1.1  jakllsch 
    263      1.1  jakllsch 	/* check and ack the interrupt */
    264      1.1  jakllsch 	isr = bus_space_read_4(sc->sc_iot, sc->sc_ioh,
    265      1.1  jakllsch 			       VIRTIO_MMIO_INTERRUPT_STATUS);
    266      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh,
    267      1.1  jakllsch 			  VIRTIO_MMIO_INTERRUPT_ACK, isr);
    268      1.1  jakllsch 	if ((isr & VIRTIO_MMIO_INT_CONFIG) &&
    269      1.1  jakllsch 	    (vsc->sc_config_change != NULL))
    270      1.1  jakllsch 		r = (vsc->sc_config_change)(vsc);
    271      1.1  jakllsch 	if ((isr & VIRTIO_MMIO_INT_VRING) &&
    272      1.1  jakllsch 	    (vsc->sc_intrhand != NULL)) {
    273      1.1  jakllsch 		if (vsc->sc_soft_ih != NULL)
    274      1.1  jakllsch 			softint_schedule(vsc->sc_soft_ih);
    275      1.1  jakllsch 		else
    276      1.1  jakllsch 			r |= (vsc->sc_intrhand)(vsc);
    277      1.1  jakllsch 	}
    278      1.1  jakllsch 
    279      1.1  jakllsch 	return r;
    280      1.1  jakllsch }
    281      1.1  jakllsch 
    282      1.1  jakllsch static void
    283      1.1  jakllsch virtio_mmio_kick(struct virtio_softc *vsc, uint16_t idx)
    284      1.1  jakllsch {
    285      1.1  jakllsch 	struct virtio_mmio_softc *sc = (struct virtio_mmio_softc *)vsc;
    286      1.1  jakllsch 	bus_space_write_4(sc->sc_iot, sc->sc_ioh, VIRTIO_MMIO_QUEUE_NOTIFY,
    287      1.1  jakllsch 	    idx);
    288      1.1  jakllsch }
    289      1.1  jakllsch 
    290      1.1  jakllsch static int
    291      1.7  yamaguch virtio_mmio_alloc_interrupts(struct virtio_softc *vsc)
    292      1.1  jakllsch {
    293      1.1  jakllsch 	struct virtio_mmio_softc * const sc = (struct virtio_mmio_softc *)vsc;
    294      1.1  jakllsch 
    295      1.7  yamaguch 	return sc->sc_alloc_interrupts(sc);
    296      1.1  jakllsch }
    297      1.1  jakllsch 
    298      1.1  jakllsch static void
    299      1.1  jakllsch virtio_mmio_free_interrupts(struct virtio_softc *vsc)
    300      1.1  jakllsch {
    301      1.1  jakllsch 	struct virtio_mmio_softc * const sc = (struct virtio_mmio_softc *)vsc;
    302      1.1  jakllsch 
    303      1.1  jakllsch 	sc->sc_free_interrupts(sc);
    304      1.1  jakllsch }
    305      1.7  yamaguch 
    306      1.7  yamaguch static int
    307      1.7  yamaguch virtio_mmio_setup_interrupts(struct virtio_softc *vsc __unused,
    308      1.7  yamaguch     int reinit __unused)
    309      1.7  yamaguch {
    310      1.7  yamaguch 
    311      1.7  yamaguch 	return 0;
    312      1.7  yamaguch }
    313