hw/net/spapr_llan: Extract rx buffer code into separate functions
[qemu/ar7.git] / hw / net / spapr_llan.c
blob39a1dd1d1339d5dabffd70d61340be638fefad7b
1 /*
2 * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
4 * PAPR Inter-VM Logical Lan, aka ibmveth
6 * Copyright (c) 2010,2011 David Gibson, IBM Corporation.
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
27 #include "qemu/osdep.h"
28 #include "hw/hw.h"
29 #include "net/net.h"
30 #include "hw/qdev.h"
31 #include "hw/ppc/spapr.h"
32 #include "hw/ppc/spapr_vio.h"
33 #include "sysemu/sysemu.h"
35 #include <libfdt.h>
37 #define ETH_ALEN 6
38 #define MAX_PACKET_SIZE 65536
40 /*#define DEBUG*/
42 #ifdef DEBUG
43 #define DPRINTF(fmt...) do { fprintf(stderr, fmt); } while (0)
44 #else
45 #define DPRINTF(fmt...)
46 #endif
49 * Virtual LAN device
52 typedef uint64_t vlan_bd_t;
54 #define VLAN_BD_VALID 0x8000000000000000ULL
55 #define VLAN_BD_TOGGLE 0x4000000000000000ULL
56 #define VLAN_BD_NO_CSUM 0x0200000000000000ULL
57 #define VLAN_BD_CSUM_GOOD 0x0100000000000000ULL
58 #define VLAN_BD_LEN_MASK 0x00ffffff00000000ULL
59 #define VLAN_BD_LEN(bd) (((bd) & VLAN_BD_LEN_MASK) >> 32)
60 #define VLAN_BD_ADDR_MASK 0x00000000ffffffffULL
61 #define VLAN_BD_ADDR(bd) ((bd) & VLAN_BD_ADDR_MASK)
63 #define VLAN_VALID_BD(addr, len) (VLAN_BD_VALID | \
64 (((len) << 32) & VLAN_BD_LEN_MASK) | \
65 (addr & VLAN_BD_ADDR_MASK))
67 #define VLAN_RXQC_TOGGLE 0x80
68 #define VLAN_RXQC_VALID 0x40
69 #define VLAN_RXQC_NO_CSUM 0x02
70 #define VLAN_RXQC_CSUM_GOOD 0x01
72 #define VLAN_RQ_ALIGNMENT 16
73 #define VLAN_RXQ_BD_OFF 0
74 #define VLAN_FILTER_BD_OFF 8
75 #define VLAN_RX_BDS_OFF 16
77 * The final 8 bytes of the buffer list is a counter of frames dropped
78 * because there was not a buffer in the buffer list capable of holding
79 * the frame. We must avoid it, or the operating system will report garbage
80 * for this statistic.
82 #define VLAN_RX_BDS_LEN (SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF - 8)
83 #define VLAN_MAX_BUFS (VLAN_RX_BDS_LEN / 8)
85 #define TYPE_VIO_SPAPR_VLAN_DEVICE "spapr-vlan"
86 #define VIO_SPAPR_VLAN_DEVICE(obj) \
87 OBJECT_CHECK(VIOsPAPRVLANDevice, (obj), TYPE_VIO_SPAPR_VLAN_DEVICE)
89 typedef struct VIOsPAPRVLANDevice {
90 VIOsPAPRDevice sdev;
91 NICConf nicconf;
92 NICState *nic;
93 bool isopen;
94 target_ulong buf_list;
95 uint32_t add_buf_ptr, use_buf_ptr, rx_bufs;
96 target_ulong rxq_ptr;
97 } VIOsPAPRVLANDevice;
99 static int spapr_vlan_can_receive(NetClientState *nc)
101 VIOsPAPRVLANDevice *dev = qemu_get_nic_opaque(nc);
103 return (dev->isopen && dev->rx_bufs > 0);
107 * Get buffer descriptor from the receive buffer list page that has been
108 * supplied by the guest with the H_REGISTER_LOGICAL_LAN call
110 static vlan_bd_t spapr_vlan_get_rx_bd_from_page(VIOsPAPRVLANDevice *dev,
111 size_t size)
113 int buf_ptr = dev->use_buf_ptr;
114 vlan_bd_t bd;
116 do {
117 buf_ptr += 8;
118 if (buf_ptr >= VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF) {
119 buf_ptr = VLAN_RX_BDS_OFF;
122 bd = vio_ldq(&dev->sdev, dev->buf_list + buf_ptr);
123 DPRINTF("use_buf_ptr=%d bd=0x%016llx\n",
124 buf_ptr, (unsigned long long)bd);
125 } while ((!(bd & VLAN_BD_VALID) || VLAN_BD_LEN(bd) < size + 8)
126 && buf_ptr != dev->use_buf_ptr);
128 if (!(bd & VLAN_BD_VALID) || VLAN_BD_LEN(bd) < size + 8) {
129 /* Failed to find a suitable buffer */
130 return 0;
133 /* Remove the buffer from the pool */
134 dev->use_buf_ptr = buf_ptr;
135 vio_stq(&dev->sdev, dev->buf_list + dev->use_buf_ptr, 0);
137 DPRINTF("Found buffer: ptr=%d rxbufs=%d\n", dev->use_buf_ptr, dev->rx_bufs);
139 return bd;
142 static ssize_t spapr_vlan_receive(NetClientState *nc, const uint8_t *buf,
143 size_t size)
145 VIOsPAPRVLANDevice *dev = qemu_get_nic_opaque(nc);
146 VIOsPAPRDevice *sdev = VIO_SPAPR_DEVICE(dev);
147 vlan_bd_t rxq_bd = vio_ldq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF);
148 vlan_bd_t bd;
149 uint64_t handle;
150 uint8_t control;
152 DPRINTF("spapr_vlan_receive() [%s] rx_bufs=%d\n", sdev->qdev.id,
153 dev->rx_bufs);
155 if (!dev->isopen) {
156 return -1;
159 if (!dev->rx_bufs) {
160 return -1;
163 bd = spapr_vlan_get_rx_bd_from_page(dev, size);
164 if (!bd) {
165 return -1;
168 dev->rx_bufs--;
170 /* Transfer the packet data */
171 if (spapr_vio_dma_write(sdev, VLAN_BD_ADDR(bd) + 8, buf, size) < 0) {
172 return -1;
175 DPRINTF("spapr_vlan_receive: DMA write completed\n");
177 /* Update the receive queue */
178 control = VLAN_RXQC_TOGGLE | VLAN_RXQC_VALID;
179 if (rxq_bd & VLAN_BD_TOGGLE) {
180 control ^= VLAN_RXQC_TOGGLE;
183 handle = vio_ldq(sdev, VLAN_BD_ADDR(bd));
184 vio_stq(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 8, handle);
185 vio_stl(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 4, size);
186 vio_sth(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 2, 8);
187 vio_stb(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr, control);
189 DPRINTF("wrote rxq entry (ptr=0x%llx): 0x%016llx 0x%016llx\n",
190 (unsigned long long)dev->rxq_ptr,
191 (unsigned long long)vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
192 dev->rxq_ptr),
193 (unsigned long long)vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
194 dev->rxq_ptr + 8));
196 dev->rxq_ptr += 16;
197 if (dev->rxq_ptr >= VLAN_BD_LEN(rxq_bd)) {
198 dev->rxq_ptr = 0;
199 vio_stq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF, rxq_bd ^ VLAN_BD_TOGGLE);
202 if (sdev->signal_state & 1) {
203 qemu_irq_pulse(spapr_vio_qirq(sdev));
206 return size;
209 static NetClientInfo net_spapr_vlan_info = {
210 .type = NET_CLIENT_OPTIONS_KIND_NIC,
211 .size = sizeof(NICState),
212 .can_receive = spapr_vlan_can_receive,
213 .receive = spapr_vlan_receive,
216 static void spapr_vlan_reset(VIOsPAPRDevice *sdev)
218 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
220 dev->buf_list = 0;
221 dev->rx_bufs = 0;
222 dev->isopen = 0;
225 static void spapr_vlan_realize(VIOsPAPRDevice *sdev, Error **errp)
227 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
229 qemu_macaddr_default_if_unset(&dev->nicconf.macaddr);
231 dev->nic = qemu_new_nic(&net_spapr_vlan_info, &dev->nicconf,
232 object_get_typename(OBJECT(sdev)), sdev->qdev.id, dev);
233 qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
236 static void spapr_vlan_instance_init(Object *obj)
238 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(obj);
240 device_add_bootindex_property(obj, &dev->nicconf.bootindex,
241 "bootindex", "",
242 DEVICE(dev), NULL);
245 void spapr_vlan_create(VIOsPAPRBus *bus, NICInfo *nd)
247 DeviceState *dev;
249 dev = qdev_create(&bus->bus, "spapr-vlan");
251 qdev_set_nic_properties(dev, nd);
253 qdev_init_nofail(dev);
256 static int spapr_vlan_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
258 VIOsPAPRVLANDevice *vdev = VIO_SPAPR_VLAN_DEVICE(dev);
259 uint8_t padded_mac[8] = {0, 0};
260 int ret;
262 /* Some old phyp versions give the mac address in an 8-byte
263 * property. The kernel driver has an insane workaround for this;
264 * rather than doing the obvious thing and checking the property
265 * length, it checks whether the first byte has 0b10 in the low
266 * bits. If a correct 6-byte property has a different first byte
267 * the kernel will get the wrong mac address, overrunning its
268 * buffer in the process (read only, thank goodness).
270 * Here we workaround the kernel workaround by always supplying an
271 * 8-byte property, with the mac address in the last six bytes */
272 memcpy(&padded_mac[2], &vdev->nicconf.macaddr, ETH_ALEN);
273 ret = fdt_setprop(fdt, node_off, "local-mac-address",
274 padded_mac, sizeof(padded_mac));
275 if (ret < 0) {
276 return ret;
279 ret = fdt_setprop_cell(fdt, node_off, "ibm,mac-address-filters", 0);
280 if (ret < 0) {
281 return ret;
284 return 0;
287 static int check_bd(VIOsPAPRVLANDevice *dev, vlan_bd_t bd,
288 target_ulong alignment)
290 if ((VLAN_BD_ADDR(bd) % alignment)
291 || (VLAN_BD_LEN(bd) % alignment)) {
292 return -1;
295 if (!spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
296 VLAN_BD_LEN(bd), DMA_DIRECTION_FROM_DEVICE)
297 || !spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
298 VLAN_BD_LEN(bd), DMA_DIRECTION_TO_DEVICE)) {
299 return -1;
302 return 0;
305 static target_ulong h_register_logical_lan(PowerPCCPU *cpu,
306 sPAPRMachineState *spapr,
307 target_ulong opcode,
308 target_ulong *args)
310 target_ulong reg = args[0];
311 target_ulong buf_list = args[1];
312 target_ulong rec_queue = args[2];
313 target_ulong filter_list = args[3];
314 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
315 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
316 vlan_bd_t filter_list_bd;
318 if (!dev) {
319 return H_PARAMETER;
322 if (dev->isopen) {
323 hcall_dprintf("H_REGISTER_LOGICAL_LAN called twice without "
324 "H_FREE_LOGICAL_LAN\n");
325 return H_RESOURCE;
328 if (check_bd(dev, VLAN_VALID_BD(buf_list, SPAPR_TCE_PAGE_SIZE),
329 SPAPR_TCE_PAGE_SIZE) < 0) {
330 hcall_dprintf("Bad buf_list 0x" TARGET_FMT_lx "\n", buf_list);
331 return H_PARAMETER;
334 filter_list_bd = VLAN_VALID_BD(filter_list, SPAPR_TCE_PAGE_SIZE);
335 if (check_bd(dev, filter_list_bd, SPAPR_TCE_PAGE_SIZE) < 0) {
336 hcall_dprintf("Bad filter_list 0x" TARGET_FMT_lx "\n", filter_list);
337 return H_PARAMETER;
340 if (!(rec_queue & VLAN_BD_VALID)
341 || (check_bd(dev, rec_queue, VLAN_RQ_ALIGNMENT) < 0)) {
342 hcall_dprintf("Bad receive queue\n");
343 return H_PARAMETER;
346 dev->buf_list = buf_list;
347 sdev->signal_state = 0;
349 rec_queue &= ~VLAN_BD_TOGGLE;
351 /* Initialize the buffer list */
352 vio_stq(sdev, buf_list, rec_queue);
353 vio_stq(sdev, buf_list + 8, filter_list_bd);
354 spapr_vio_dma_set(sdev, buf_list + VLAN_RX_BDS_OFF, 0,
355 SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF);
356 dev->add_buf_ptr = VLAN_RX_BDS_OFF - 8;
357 dev->use_buf_ptr = VLAN_RX_BDS_OFF - 8;
358 dev->rx_bufs = 0;
359 dev->rxq_ptr = 0;
361 /* Initialize the receive queue */
362 spapr_vio_dma_set(sdev, VLAN_BD_ADDR(rec_queue), 0, VLAN_BD_LEN(rec_queue));
364 dev->isopen = 1;
365 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
367 return H_SUCCESS;
371 static target_ulong h_free_logical_lan(PowerPCCPU *cpu,
372 sPAPRMachineState *spapr,
373 target_ulong opcode, target_ulong *args)
375 target_ulong reg = args[0];
376 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
377 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
379 if (!dev) {
380 return H_PARAMETER;
383 if (!dev->isopen) {
384 hcall_dprintf("H_FREE_LOGICAL_LAN called without "
385 "H_REGISTER_LOGICAL_LAN\n");
386 return H_RESOURCE;
389 spapr_vlan_reset(sdev);
390 return H_SUCCESS;
393 static target_long spapr_vlan_add_rxbuf_to_page(VIOsPAPRVLANDevice *dev,
394 target_ulong buf)
396 vlan_bd_t bd;
398 if (dev->rx_bufs >= VLAN_MAX_BUFS) {
399 return H_RESOURCE;
402 do {
403 dev->add_buf_ptr += 8;
404 if (dev->add_buf_ptr >= VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF) {
405 dev->add_buf_ptr = VLAN_RX_BDS_OFF;
408 bd = vio_ldq(&dev->sdev, dev->buf_list + dev->add_buf_ptr);
409 } while (bd & VLAN_BD_VALID);
411 vio_stq(&dev->sdev, dev->buf_list + dev->add_buf_ptr, buf);
413 DPRINTF("h_add_llan_buf(): Added buf ptr=%d rx_bufs=%d bd=0x%016llx\n",
414 dev->add_buf_ptr, dev->rx_bufs, (unsigned long long)buf);
416 return 0;
419 static target_ulong h_add_logical_lan_buffer(PowerPCCPU *cpu,
420 sPAPRMachineState *spapr,
421 target_ulong opcode,
422 target_ulong *args)
424 target_ulong reg = args[0];
425 target_ulong buf = args[1];
426 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
427 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
428 target_long ret;
430 DPRINTF("H_ADD_LOGICAL_LAN_BUFFER(0x" TARGET_FMT_lx
431 ", 0x" TARGET_FMT_lx ")\n", reg, buf);
433 if (!sdev) {
434 hcall_dprintf("Bad device\n");
435 return H_PARAMETER;
438 if ((check_bd(dev, buf, 4) < 0)
439 || (VLAN_BD_LEN(buf) < 16)) {
440 hcall_dprintf("Bad buffer enqueued\n");
441 return H_PARAMETER;
444 if (!dev->isopen) {
445 return H_RESOURCE;
448 ret = spapr_vlan_add_rxbuf_to_page(dev, buf);
449 if (ret) {
450 return ret;
453 dev->rx_bufs++;
455 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
457 return H_SUCCESS;
460 static target_ulong h_send_logical_lan(PowerPCCPU *cpu,
461 sPAPRMachineState *spapr,
462 target_ulong opcode, target_ulong *args)
464 target_ulong reg = args[0];
465 target_ulong *bufs = args + 1;
466 target_ulong continue_token = args[7];
467 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
468 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
469 unsigned total_len;
470 uint8_t *lbuf, *p;
471 int i, nbufs;
472 int ret;
474 DPRINTF("H_SEND_LOGICAL_LAN(0x" TARGET_FMT_lx ", <bufs>, 0x"
475 TARGET_FMT_lx ")\n", reg, continue_token);
477 if (!sdev) {
478 return H_PARAMETER;
481 DPRINTF("rxbufs = %d\n", dev->rx_bufs);
483 if (!dev->isopen) {
484 return H_DROPPED;
487 if (continue_token) {
488 return H_HARDWARE; /* FIXME actually handle this */
491 total_len = 0;
492 for (i = 0; i < 6; i++) {
493 DPRINTF(" buf desc: 0x" TARGET_FMT_lx "\n", bufs[i]);
494 if (!(bufs[i] & VLAN_BD_VALID)) {
495 break;
497 total_len += VLAN_BD_LEN(bufs[i]);
500 nbufs = i;
501 DPRINTF("h_send_logical_lan() %d buffers, total length 0x%x\n",
502 nbufs, total_len);
504 if (total_len == 0) {
505 return H_SUCCESS;
508 if (total_len > MAX_PACKET_SIZE) {
509 /* Don't let the guest force too large an allocation */
510 return H_RESOURCE;
513 lbuf = alloca(total_len);
514 p = lbuf;
515 for (i = 0; i < nbufs; i++) {
516 ret = spapr_vio_dma_read(sdev, VLAN_BD_ADDR(bufs[i]),
517 p, VLAN_BD_LEN(bufs[i]));
518 if (ret < 0) {
519 return ret;
522 p += VLAN_BD_LEN(bufs[i]);
525 qemu_send_packet(qemu_get_queue(dev->nic), lbuf, total_len);
527 return H_SUCCESS;
530 static target_ulong h_multicast_ctrl(PowerPCCPU *cpu, sPAPRMachineState *spapr,
531 target_ulong opcode, target_ulong *args)
533 target_ulong reg = args[0];
534 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
536 if (!dev) {
537 return H_PARAMETER;
540 return H_SUCCESS;
543 static Property spapr_vlan_properties[] = {
544 DEFINE_SPAPR_PROPERTIES(VIOsPAPRVLANDevice, sdev),
545 DEFINE_NIC_PROPERTIES(VIOsPAPRVLANDevice, nicconf),
546 DEFINE_PROP_END_OF_LIST(),
549 static const VMStateDescription vmstate_spapr_llan = {
550 .name = "spapr_llan",
551 .version_id = 1,
552 .minimum_version_id = 1,
553 .fields = (VMStateField[]) {
554 VMSTATE_SPAPR_VIO(sdev, VIOsPAPRVLANDevice),
555 /* LLAN state */
556 VMSTATE_BOOL(isopen, VIOsPAPRVLANDevice),
557 VMSTATE_UINTTL(buf_list, VIOsPAPRVLANDevice),
558 VMSTATE_UINT32(add_buf_ptr, VIOsPAPRVLANDevice),
559 VMSTATE_UINT32(use_buf_ptr, VIOsPAPRVLANDevice),
560 VMSTATE_UINT32(rx_bufs, VIOsPAPRVLANDevice),
561 VMSTATE_UINTTL(rxq_ptr, VIOsPAPRVLANDevice),
563 VMSTATE_END_OF_LIST()
567 static void spapr_vlan_class_init(ObjectClass *klass, void *data)
569 DeviceClass *dc = DEVICE_CLASS(klass);
570 VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
572 k->realize = spapr_vlan_realize;
573 k->reset = spapr_vlan_reset;
574 k->devnode = spapr_vlan_devnode;
575 k->dt_name = "l-lan";
576 k->dt_type = "network";
577 k->dt_compatible = "IBM,l-lan";
578 k->signal_mask = 0x1;
579 set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
580 dc->props = spapr_vlan_properties;
581 k->rtce_window_size = 0x10000000;
582 dc->vmsd = &vmstate_spapr_llan;
585 static const TypeInfo spapr_vlan_info = {
586 .name = TYPE_VIO_SPAPR_VLAN_DEVICE,
587 .parent = TYPE_VIO_SPAPR_DEVICE,
588 .instance_size = sizeof(VIOsPAPRVLANDevice),
589 .class_init = spapr_vlan_class_init,
590 .instance_init = spapr_vlan_instance_init,
593 static void spapr_vlan_register_types(void)
595 spapr_register_hypercall(H_REGISTER_LOGICAL_LAN, h_register_logical_lan);
596 spapr_register_hypercall(H_FREE_LOGICAL_LAN, h_free_logical_lan);
597 spapr_register_hypercall(H_SEND_LOGICAL_LAN, h_send_logical_lan);
598 spapr_register_hypercall(H_ADD_LOGICAL_LAN_BUFFER,
599 h_add_logical_lan_buffer);
600 spapr_register_hypercall(H_MULTICAST_CTRL, h_multicast_ctrl);
601 type_register_static(&spapr_vlan_info);
604 type_init(spapr_vlan_register_types)