[qemu.git] / hw / xilinx_ethlite.c

/*
 * QEMU model of the Xilinx Ethernet Lite MAC.
 *
 * Copyright (c) 2009 Edgar E. Iglesias.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#include "sysbus.h"
#include "hw.h"
#include "net/net.h"

#define D(x)
#define R_TX_BUF0     0
#define R_TX_LEN0     (0x07f4 / 4)
#define R_TX_GIE0     (0x07f8 / 4)
#define R_TX_CTRL0    (0x07fc / 4)
#define R_TX_BUF1     (0x0800 / 4)
#define R_TX_LEN1     (0x0ff4 / 4)
#define R_TX_CTRL1    (0x0ffc / 4)

#define R_RX_BUF0     (0x1000 / 4)
#define R_RX_CTRL0    (0x17fc / 4)
#define R_RX_BUF1     (0x1800 / 4)
#define R_RX_CTRL1    (0x1ffc / 4)
#define R_MAX         (0x2000 / 4)

#define GIE_GIE    0x80000000

#define CTRL_I     0x8
#define CTRL_P     0x2
#define CTRL_S     0x1

struct xlx_ethlite
{
    SysBusDevice busdev;
    MemoryRegion mmio;
    qemu_irq irq;
    NICState *nic;
    NICConf conf;

    uint32_t c_tx_pingpong;
    uint32_t c_rx_pingpong;
    unsigned int txbuf;
    unsigned int rxbuf;

    uint32_t regs[R_MAX];
};

static inline void eth_pulse_irq(struct xlx_ethlite *s)
{
    /* Only the first gie reg is active.  */
    if (s->regs[R_TX_GIE0] & GIE_GIE) {
        qemu_irq_pulse(s->irq);
    }
}

static uint64_t
eth_read(void *opaque, hwaddr addr, unsigned int size)
{
    struct xlx_ethlite *s = opaque;
    uint32_t r = 0;

    addr >>= 2;

    switch (addr)
    {
        case R_TX_GIE0:
        case R_TX_LEN0:
        case R_TX_LEN1:
        case R_TX_CTRL1:
        case R_TX_CTRL0:
        case R_RX_CTRL1:
        case R_RX_CTRL0:
            r = s->regs[addr];
            D(qemu_log("%s " TARGET_FMT_plx "=%x\n", __func__, addr * 4, r));
            break;

        default:
            r = tswap32(s->regs[addr]);
            break;
    }
    return r;
}

static void
eth_write(void *opaque, hwaddr addr,
          uint64_t val64, unsigned int size)
{
    struct xlx_ethlite *s = opaque;
    unsigned int base = 0;
    uint32_t value = val64;

    addr >>= 2;
    switch (addr) 
    {
        case R_TX_CTRL0:
        case R_TX_CTRL1:
            if (addr == R_TX_CTRL1)
                base = 0x800 / 4;

            D(qemu_log("%s addr=" TARGET_FMT_plx " val=%x\n",
                       __func__, addr * 4, value));
            if ((value & (CTRL_P | CTRL_S)) == CTRL_S) {
                qemu_send_packet(qemu_get_queue(s->nic),
                                 (void *) &s->regs[base],
                                 s->regs[base + R_TX_LEN0]);
                D(qemu_log("eth_tx %d\n", s->regs[base + R_TX_LEN0]));
                if (s->regs[base + R_TX_CTRL0] & CTRL_I)
                    eth_pulse_irq(s);
            } else if ((value & (CTRL_P | CTRL_S)) == (CTRL_P | CTRL_S)) {
                memcpy(&s->conf.macaddr.a[0], &s->regs[base], 6);
                if (s->regs[base + R_TX_CTRL0] & CTRL_I)
                    eth_pulse_irq(s);
            }

            /* We are fast and get ready pretty much immediately so
               we actually never flip the S nor P bits to one.  */
            s->regs[addr] = value & ~(CTRL_P | CTRL_S);
            break;

        /* Keep these native.  */
        case R_RX_CTRL0:
        case R_RX_CTRL1:
            if (!(value & CTRL_S)) {
                qemu_flush_queued_packets(qemu_get_queue(s->nic));
            }
        case R_TX_LEN0:
        case R_TX_LEN1:
        case R_TX_GIE0:
            D(qemu_log("%s addr=" TARGET_FMT_plx " val=%x\n",
                       __func__, addr * 4, value));
            s->regs[addr] = value;
            break;

        default:
            s->regs[addr] = tswap32(value);
            break;
    }
}

static const MemoryRegionOps eth_ops = {
    .read = eth_read,
    .write = eth_write,
    .endianness = DEVICE_NATIVE_ENDIAN,
    .valid = {
        .min_access_size = 4,
        .max_access_size = 4
    }
};

static int eth_can_rx(NetClientState *nc)
{
    struct xlx_ethlite *s = qemu_get_nic_opaque(nc);
    unsigned int rxbase = s->rxbuf * (0x800 / 4);

    return !(s->regs[rxbase + R_RX_CTRL0] & CTRL_S);
}

static ssize_t eth_rx(NetClientState *nc, const uint8_t *buf, size_t size)
{
    struct xlx_ethlite *s = qemu_get_nic_opaque(nc);
    unsigned int rxbase = s->rxbuf * (0x800 / 4);

    /* DA filter.  */
    if (!(buf[0] & 0x80) && memcmp(&s->conf.macaddr.a[0], buf, 6))
        return size;

    if (s->regs[rxbase + R_RX_CTRL0] & CTRL_S) {
        D(qemu_log("ethlite lost packet %x\n", s->regs[R_RX_CTRL0]));
        return -1;
    }

    D(qemu_log("%s %zd rxbase=%x\n", __func__, size, rxbase));
    memcpy(&s->regs[rxbase + R_RX_BUF0], buf, size);

    s->regs[rxbase + R_RX_CTRL0] |= CTRL_S;
    if (s->regs[rxbase + R_RX_CTRL0] & CTRL_I)
        eth_pulse_irq(s);

    /* If c_rx_pingpong was set flip buffers.  */
    s->rxbuf ^= s->c_rx_pingpong;
    return size;
}

static void eth_cleanup(NetClientState *nc)
{
    struct xlx_ethlite *s = qemu_get_nic_opaque(nc);

    s->nic = NULL;
}

static NetClientInfo net_xilinx_ethlite_info = {
    .type = NET_CLIENT_OPTIONS_KIND_NIC,
    .size = sizeof(NICState),
    .can_receive = eth_can_rx,
    .receive = eth_rx,
    .cleanup = eth_cleanup,
};

static int xilinx_ethlite_init(SysBusDevice *dev)
{
    struct xlx_ethlite *s = FROM_SYSBUS(typeof (*s), dev);

    sysbus_init_irq(dev, &s->irq);
    s->rxbuf = 0;

    memory_region_init_io(&s->mmio, &eth_ops, s, "xlnx.xps-ethernetlite",
                                                                    R_MAX * 4);
    sysbus_init_mmio(dev, &s->mmio);

    qemu_macaddr_default_if_unset(&s->conf.macaddr);
    s->nic = qemu_new_nic(&net_xilinx_ethlite_info, &s->conf,
                          object_get_typename(OBJECT(dev)), dev->qdev.id, s);
    qemu_format_nic_info_str(qemu_get_queue(s->nic), s->conf.macaddr.a);
    return 0;
}

static Property xilinx_ethlite_properties[] = {
    DEFINE_PROP_UINT32("tx-ping-pong", struct xlx_ethlite, c_tx_pingpong, 1),
    DEFINE_PROP_UINT32("rx-ping-pong", struct xlx_ethlite, c_rx_pingpong, 1),
    DEFINE_NIC_PROPERTIES(struct xlx_ethlite, conf),
    DEFINE_PROP_END_OF_LIST(),
};

static void xilinx_ethlite_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);

    k->init = xilinx_ethlite_init;
    dc->props = xilinx_ethlite_properties;
}

static const TypeInfo xilinx_ethlite_info = {
    .name          = "xlnx.xps-ethernetlite",
    .parent        = TYPE_SYS_BUS_DEVICE,
    .instance_size = sizeof(struct xlx_ethlite),
    .class_init    = xilinx_ethlite_class_init,
};

static void xilinx_ethlite_register_types(void)
{
    type_register_static(&xilinx_ethlite_info);
}

type_init(xilinx_ethlite_register_types)
Commit	Line	Data
b43848a1 EI	1	/*
	2	* QEMU model of the Xilinx Ethernet Lite MAC.
	3	*
	4	* Copyright (c) 2009 Edgar E. Iglesias.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24
	25	#include "sysbus.h"
	26	#include "hw.h"
1422e32d	27	#include "net/net.h"
b43848a1 EI	28
	29	#define D(x)
	30	#define R_TX_BUF0 0
	31	#define R_TX_LEN0 (0x07f4 / 4)
	32	#define R_TX_GIE0 (0x07f8 / 4)
	33	#define R_TX_CTRL0 (0x07fc / 4)
	34	#define R_TX_BUF1 (0x0800 / 4)
	35	#define R_TX_LEN1 (0x0ff4 / 4)
	36	#define R_TX_CTRL1 (0x0ffc / 4)
	37
	38	#define R_RX_BUF0 (0x1000 / 4)
	39	#define R_RX_CTRL0 (0x17fc / 4)
	40	#define R_RX_BUF1 (0x1800 / 4)
	41	#define R_RX_CTRL1 (0x1ffc / 4)
	42	#define R_MAX (0x2000 / 4)
	43
	44	#define GIE_GIE 0x80000000
	45
	46	#define CTRL_I 0x8
	47	#define CTRL_P 0x2
	48	#define CTRL_S 0x1
	49
	50	struct xlx_ethlite
	51	{
	52	SysBusDevice busdev;
010f3f5f	53	MemoryRegion mmio;
b43848a1	54	qemu_irq irq;
d7539ab4	55	NICState *nic;
17d1ae3c	56	NICConf conf;
b43848a1	57
ee6847d1 GH	58	uint32_t c_tx_pingpong;
ee6847d1 GH	59	uint32_t c_rx_pingpong;
b43848a1 EI	60	unsigned int txbuf;
	61	unsigned int rxbuf;
	62
b43848a1 EI	63	uint32_t regs[R_MAX];
	64	};
	65
	66	static inline void eth_pulse_irq(struct xlx_ethlite *s)
	67	{
	68	/* Only the first gie reg is active. */
	69	if (s->regs[R_TX_GIE0] & GIE_GIE) {
	70	qemu_irq_pulse(s->irq);
	71	}
	72	}
	73
010f3f5f	74	static uint64_t
a8170e5e	75	eth_read(void *opaque, hwaddr addr, unsigned int size)
b43848a1 EI	76	{
	77	struct xlx_ethlite *s = opaque;
	78	uint32_t r = 0;
	79
	80	addr >>= 2;
	81
	82	switch (addr)
	83	{
	84	case R_TX_GIE0:
	85	case R_TX_LEN0:
	86	case R_TX_LEN1:
	87	case R_TX_CTRL1:
	88	case R_TX_CTRL0:
	89	case R_RX_CTRL1:
	90	case R_RX_CTRL0:
	91	r = s->regs[addr];
6034fe7b	92	D(qemu_log("%s " TARGET_FMT_plx "=%x\n", __func__, addr * 4, r));
b43848a1 EI	93	break;
b43848a1 EI	94
b43848a1	95	default:
d48751ed	96	r = tswap32(s->regs[addr]);
b43848a1 EI	97	break;
	98	}
	99	return r;
	100	}
	101
	102	static void
a8170e5e	103	eth_write(void *opaque, hwaddr addr,
010f3f5f	104	uint64_t val64, unsigned int size)
b43848a1 EI	105	{
	106	struct xlx_ethlite *s = opaque;
	107	unsigned int base = 0;
010f3f5f	108	uint32_t value = val64;
b43848a1 EI	109
	110	addr >>= 2;
	111	switch (addr)
	112	{
	113	case R_TX_CTRL0:
	114	case R_TX_CTRL1:
	115	if (addr == R_TX_CTRL1)
	116	base = 0x800 / 4;
	117
6034fe7b EI	118	D(qemu_log("%s addr=" TARGET_FMT_plx " val=%x\n",
6034fe7b EI	119	__func__, addr * 4, value));
b43848a1	120	if ((value & (CTRL_P \| CTRL_S)) == CTRL_S) {
b356f76d	121	qemu_send_packet(qemu_get_queue(s->nic),
b43848a1 EI	122	(void *) &s->regs[base],
	123	s->regs[base + R_TX_LEN0]);
	124	D(qemu_log("eth_tx %d\n", s->regs[base + R_TX_LEN0]));
	125	if (s->regs[base + R_TX_CTRL0] & CTRL_I)
	126	eth_pulse_irq(s);
	127	} else if ((value & (CTRL_P \| CTRL_S)) == (CTRL_P \| CTRL_S)) {
17d1ae3c	128	memcpy(&s->conf.macaddr.a[0], &s->regs[base], 6);
b43848a1 EI	129	if (s->regs[base + R_TX_CTRL0] & CTRL_I)
	130	eth_pulse_irq(s);
	131	}
	132
	133	/* We are fast and get ready pretty much immediately so
	134	we actually never flip the S nor P bits to one. */
	135	s->regs[addr] = value & ~(CTRL_P \| CTRL_S);
	136	break;
	137
	138	/* Keep these native. */
2f991adb PC	139	case R_RX_CTRL0:
	140	case R_RX_CTRL1:
	141	if (!(value & CTRL_S)) {
b356f76d	142	qemu_flush_queued_packets(qemu_get_queue(s->nic));
2f991adb	143	}
b43848a1 EI	144	case R_TX_LEN0:
	145	case R_TX_LEN1:
	146	case R_TX_GIE0:
6034fe7b EI	147	D(qemu_log("%s addr=" TARGET_FMT_plx " val=%x\n",
6034fe7b EI	148	__func__, addr * 4, value));
b43848a1 EI	149	s->regs[addr] = value;
	150	break;
	151
b43848a1	152	default:
d48751ed	153	s->regs[addr] = tswap32(value);
b43848a1 EI	154	break;
	155	}
	156	}
	157
010f3f5f EI	158	static const MemoryRegionOps eth_ops = {
	159	.read = eth_read,
	160	.write = eth_write,
	161	.endianness = DEVICE_NATIVE_ENDIAN,
	162	.valid = {
	163	.min_access_size = 4,
	164	.max_access_size = 4
	165	}
b43848a1 EI	166	};
b43848a1 EI	167
4e68f7a0	168	static int eth_can_rx(NetClientState *nc)
b43848a1	169	{
cc1f0f45	170	struct xlx_ethlite *s = qemu_get_nic_opaque(nc);
808fb9f2 PC	171	unsigned int rxbase = s->rxbuf * (0x800 / 4);
	172
	173	return !(s->regs[rxbase + R_RX_CTRL0] & CTRL_S);
b43848a1 EI	174	}
b43848a1 EI	175
4e68f7a0	176	static ssize_t eth_rx(NetClientState nc, const uint8_t buf, size_t size)
b43848a1	177	{
cc1f0f45	178	struct xlx_ethlite *s = qemu_get_nic_opaque(nc);
b43848a1	179	unsigned int rxbase = s->rxbuf * (0x800 / 4);
b43848a1 EI	180
b43848a1 EI	181	/* DA filter. */
17d1ae3c	182	if (!(buf[0] & 0x80) && memcmp(&s->conf.macaddr.a[0], buf, 6))
df12c1f5	183	return size;
b43848a1 EI	184
	185	if (s->regs[rxbase + R_RX_CTRL0] & CTRL_S) {
	186	D(qemu_log("ethlite lost packet %x\n", s->regs[R_RX_CTRL0]));
df12c1f5	187	return -1;
b43848a1 EI	188	}
b43848a1 EI	189
6034fe7b	190	D(qemu_log("%s %zd rxbase=%x\n", __func__, size, rxbase));
b43848a1 EI	191	memcpy(&s->regs[rxbase + R_RX_BUF0], buf, size);
b43848a1 EI	192
b43848a1 EI	193	s->regs[rxbase + R_RX_CTRL0] \|= CTRL_S;
	194	if (s->regs[rxbase + R_RX_CTRL0] & CTRL_I)
	195	eth_pulse_irq(s);
	196
	197	/* If c_rx_pingpong was set flip buffers. */
	198	s->rxbuf ^= s->c_rx_pingpong;
df12c1f5	199	return size;
b43848a1 EI	200	}
b43848a1 EI	201
4e68f7a0	202	static void eth_cleanup(NetClientState *nc)
b43848a1	203	{
cc1f0f45	204	struct xlx_ethlite *s = qemu_get_nic_opaque(nc);
17d1ae3c	205
d7539ab4	206	s->nic = NULL;
b43848a1 EI	207	}
b43848a1 EI	208
d7539ab4	209	static NetClientInfo net_xilinx_ethlite_info = {
2be64a68	210	.type = NET_CLIENT_OPTIONS_KIND_NIC,
d7539ab4 MM	211	.size = sizeof(NICState),
	212	.can_receive = eth_can_rx,
	213	.receive = eth_rx,
	214	.cleanup = eth_cleanup,
	215	};
	216
81a322d4	217	static int xilinx_ethlite_init(SysBusDevice *dev)
b43848a1 EI	218	{
b43848a1 EI	219	struct xlx_ethlite s = FROM_SYSBUS(typeof (s), dev);
b43848a1 EI	220
b43848a1 EI	221	sysbus_init_irq(dev, &s->irq);
b43848a1 EI	222	s->rxbuf = 0;
b43848a1 EI	223
7f4d6755 PC	224	memory_region_init_io(&s->mmio, &eth_ops, s, "xlnx.xps-ethernetlite",
7f4d6755 PC	225	R_MAX * 4);
750ecd44	226	sysbus_init_mmio(dev, &s->mmio);
b43848a1	227
17d1ae3c	228	qemu_macaddr_default_if_unset(&s->conf.macaddr);
d7539ab4	229	s->nic = qemu_new_nic(&net_xilinx_ethlite_info, &s->conf,
f79f2bfc	230	object_get_typename(OBJECT(dev)), dev->qdev.id, s);
b356f76d	231	qemu_format_nic_info_str(qemu_get_queue(s->nic), s->conf.macaddr.a);
81a322d4	232	return 0;
b43848a1 EI	233	}
b43848a1 EI	234
999e12bb	235	static Property xilinx_ethlite_properties[] = {
b2d85c34 PC	236	DEFINE_PROP_UINT32("tx-ping-pong", struct xlx_ethlite, c_tx_pingpong, 1),
b2d85c34 PC	237	DEFINE_PROP_UINT32("rx-ping-pong", struct xlx_ethlite, c_rx_pingpong, 1),
999e12bb AL	238	DEFINE_NIC_PROPERTIES(struct xlx_ethlite, conf),
	239	DEFINE_PROP_END_OF_LIST(),
	240	};
	241
	242	static void xilinx_ethlite_class_init(ObjectClass klass, void data)
	243	{
39bffca2	244	DeviceClass *dc = DEVICE_CLASS(klass);
999e12bb AL	245	SysBusDeviceClass *k = SYS_BUS_DEVICE_CLASS(klass);
	246
	247	k->init = xilinx_ethlite_init;
39bffca2	248	dc->props = xilinx_ethlite_properties;
999e12bb AL	249	}
999e12bb AL	250
8c43a6f0	251	static const TypeInfo xilinx_ethlite_info = {
7f4d6755	252	.name = "xlnx.xps-ethernetlite",
39bffca2 AL	253	.parent = TYPE_SYS_BUS_DEVICE,
	254	.instance_size = sizeof(struct xlx_ethlite),
	255	.class_init = xilinx_ethlite_class_init,
ee6847d1 GH	256	};
ee6847d1 GH	257
83f7d43a	258	static void xilinx_ethlite_register_types(void)
b43848a1	259	{
39bffca2	260	type_register_static(&xilinx_ethlite_info);
b43848a1 EI	261	}
b43848a1 EI	262
83f7d43a	263	type_init(xilinx_ethlite_register_types)