spapr-vlan: Don't touch last entry in buffer list
[qemu/ar7.git] / hw / net / spapr_llan.c
blob23c47d397c599af259a4470a914be206e0729bee
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 "hw/hw.h"
28 #include "net/net.h"
29 #include "hw/qdev.h"
30 #include "hw/ppc/spapr.h"
31 #include "hw/ppc/spapr_vio.h"
32 #include "sysemu/sysemu.h"
34 #include <libfdt.h>
36 #define ETH_ALEN 6
37 #define MAX_PACKET_SIZE 65536
39 /*#define DEBUG*/
41 #ifdef DEBUG
42 #define DPRINTF(fmt...) do { fprintf(stderr, fmt); } while (0)
43 #else
44 #define DPRINTF(fmt...)
45 #endif
48 * Virtual LAN device
51 typedef uint64_t vlan_bd_t;
53 #define VLAN_BD_VALID 0x8000000000000000ULL
54 #define VLAN_BD_TOGGLE 0x4000000000000000ULL
55 #define VLAN_BD_NO_CSUM 0x0200000000000000ULL
56 #define VLAN_BD_CSUM_GOOD 0x0100000000000000ULL
57 #define VLAN_BD_LEN_MASK 0x00ffffff00000000ULL
58 #define VLAN_BD_LEN(bd) (((bd) & VLAN_BD_LEN_MASK) >> 32)
59 #define VLAN_BD_ADDR_MASK 0x00000000ffffffffULL
60 #define VLAN_BD_ADDR(bd) ((bd) & VLAN_BD_ADDR_MASK)
62 #define VLAN_VALID_BD(addr, len) (VLAN_BD_VALID | \
63 (((len) << 32) & VLAN_BD_LEN_MASK) | \
64 (addr & VLAN_BD_ADDR_MASK))
66 #define VLAN_RXQC_TOGGLE 0x80
67 #define VLAN_RXQC_VALID 0x40
68 #define VLAN_RXQC_NO_CSUM 0x02
69 #define VLAN_RXQC_CSUM_GOOD 0x01
71 #define VLAN_RQ_ALIGNMENT 16
72 #define VLAN_RXQ_BD_OFF 0
73 #define VLAN_FILTER_BD_OFF 8
74 #define VLAN_RX_BDS_OFF 16
76 * The final 8 bytes of the buffer list is a counter of frames dropped
77 * because there was not a buffer in the buffer list capable of holding
78 * the frame. We must avoid it, or the operating system will report garbage
79 * for this statistic.
81 #define VLAN_RX_BDS_LEN (SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF - 8)
82 #define VLAN_MAX_BUFS (VLAN_RX_BDS_LEN / 8)
84 #define TYPE_VIO_SPAPR_VLAN_DEVICE "spapr-vlan"
85 #define VIO_SPAPR_VLAN_DEVICE(obj) \
86 OBJECT_CHECK(VIOsPAPRVLANDevice, (obj), TYPE_VIO_SPAPR_VLAN_DEVICE)
88 typedef struct VIOsPAPRVLANDevice {
89 VIOsPAPRDevice sdev;
90 NICConf nicconf;
91 NICState *nic;
92 bool isopen;
93 target_ulong buf_list;
94 uint32_t add_buf_ptr, use_buf_ptr, rx_bufs;
95 target_ulong rxq_ptr;
96 } VIOsPAPRVLANDevice;
98 static int spapr_vlan_can_receive(NetClientState *nc)
100 VIOsPAPRVLANDevice *dev = qemu_get_nic_opaque(nc);
102 return (dev->isopen && dev->rx_bufs > 0);
105 static ssize_t spapr_vlan_receive(NetClientState *nc, const uint8_t *buf,
106 size_t size)
108 VIOsPAPRVLANDevice *dev = qemu_get_nic_opaque(nc);
109 VIOsPAPRDevice *sdev = VIO_SPAPR_DEVICE(dev);
110 vlan_bd_t rxq_bd = vio_ldq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF);
111 vlan_bd_t bd;
112 int buf_ptr = dev->use_buf_ptr;
113 uint64_t handle;
114 uint8_t control;
116 DPRINTF("spapr_vlan_receive() [%s] rx_bufs=%d\n", sdev->qdev.id,
117 dev->rx_bufs);
119 if (!dev->isopen) {
120 return -1;
123 if (!dev->rx_bufs) {
124 return -1;
127 do {
128 buf_ptr += 8;
129 if (buf_ptr >= (VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF)) {
130 buf_ptr = VLAN_RX_BDS_OFF;
133 bd = vio_ldq(sdev, dev->buf_list + buf_ptr);
134 DPRINTF("use_buf_ptr=%d bd=0x%016llx\n",
135 buf_ptr, (unsigned long long)bd);
136 } while ((!(bd & VLAN_BD_VALID) || (VLAN_BD_LEN(bd) < (size + 8)))
137 && (buf_ptr != dev->use_buf_ptr));
139 if (!(bd & VLAN_BD_VALID) || (VLAN_BD_LEN(bd) < (size + 8))) {
140 /* Failed to find a suitable buffer */
141 return -1;
144 /* Remove the buffer from the pool */
145 dev->rx_bufs--;
146 dev->use_buf_ptr = buf_ptr;
147 vio_stq(sdev, dev->buf_list + dev->use_buf_ptr, 0);
149 DPRINTF("Found buffer: ptr=%d num=%d\n", dev->use_buf_ptr, dev->rx_bufs);
151 /* Transfer the packet data */
152 if (spapr_vio_dma_write(sdev, VLAN_BD_ADDR(bd) + 8, buf, size) < 0) {
153 return -1;
156 DPRINTF("spapr_vlan_receive: DMA write completed\n");
158 /* Update the receive queue */
159 control = VLAN_RXQC_TOGGLE | VLAN_RXQC_VALID;
160 if (rxq_bd & VLAN_BD_TOGGLE) {
161 control ^= VLAN_RXQC_TOGGLE;
164 handle = vio_ldq(sdev, VLAN_BD_ADDR(bd));
165 vio_stq(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 8, handle);
166 vio_stl(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 4, size);
167 vio_sth(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 2, 8);
168 vio_stb(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr, control);
170 DPRINTF("wrote rxq entry (ptr=0x%llx): 0x%016llx 0x%016llx\n",
171 (unsigned long long)dev->rxq_ptr,
172 (unsigned long long)vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
173 dev->rxq_ptr),
174 (unsigned long long)vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
175 dev->rxq_ptr + 8));
177 dev->rxq_ptr += 16;
178 if (dev->rxq_ptr >= VLAN_BD_LEN(rxq_bd)) {
179 dev->rxq_ptr = 0;
180 vio_stq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF, rxq_bd ^ VLAN_BD_TOGGLE);
183 if (sdev->signal_state & 1) {
184 qemu_irq_pulse(spapr_vio_qirq(sdev));
187 return size;
190 static void spapr_vlan_cleanup(NetClientState *nc)
192 VIOsPAPRVLANDevice *dev = qemu_get_nic_opaque(nc);
194 dev->nic = NULL;
197 static NetClientInfo net_spapr_vlan_info = {
198 .type = NET_CLIENT_OPTIONS_KIND_NIC,
199 .size = sizeof(NICState),
200 .can_receive = spapr_vlan_can_receive,
201 .receive = spapr_vlan_receive,
202 .cleanup = spapr_vlan_cleanup,
205 static void spapr_vlan_reset(VIOsPAPRDevice *sdev)
207 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
209 dev->buf_list = 0;
210 dev->rx_bufs = 0;
211 dev->isopen = 0;
214 static int spapr_vlan_init(VIOsPAPRDevice *sdev)
216 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
218 qemu_macaddr_default_if_unset(&dev->nicconf.macaddr);
220 dev->nic = qemu_new_nic(&net_spapr_vlan_info, &dev->nicconf,
221 object_get_typename(OBJECT(sdev)), sdev->qdev.id, dev);
222 qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
224 add_boot_device_path(dev->nicconf.bootindex, DEVICE(dev), "");
226 return 0;
229 void spapr_vlan_create(VIOsPAPRBus *bus, NICInfo *nd)
231 DeviceState *dev;
233 dev = qdev_create(&bus->bus, "spapr-vlan");
235 qdev_set_nic_properties(dev, nd);
237 qdev_init_nofail(dev);
240 static int spapr_vlan_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
242 VIOsPAPRVLANDevice *vdev = VIO_SPAPR_VLAN_DEVICE(dev);
243 uint8_t padded_mac[8] = {0, 0};
244 int ret;
246 /* Some old phyp versions give the mac address in an 8-byte
247 * property. The kernel driver has an insane workaround for this;
248 * rather than doing the obvious thing and checking the property
249 * length, it checks whether the first byte has 0b10 in the low
250 * bits. If a correct 6-byte property has a different first byte
251 * the kernel will get the wrong mac address, overrunning its
252 * buffer in the process (read only, thank goodness).
254 * Here we workaround the kernel workaround by always supplying an
255 * 8-byte property, with the mac address in the last six bytes */
256 memcpy(&padded_mac[2], &vdev->nicconf.macaddr, ETH_ALEN);
257 ret = fdt_setprop(fdt, node_off, "local-mac-address",
258 padded_mac, sizeof(padded_mac));
259 if (ret < 0) {
260 return ret;
263 ret = fdt_setprop_cell(fdt, node_off, "ibm,mac-address-filters", 0);
264 if (ret < 0) {
265 return ret;
268 return 0;
271 static int check_bd(VIOsPAPRVLANDevice *dev, vlan_bd_t bd,
272 target_ulong alignment)
274 if ((VLAN_BD_ADDR(bd) % alignment)
275 || (VLAN_BD_LEN(bd) % alignment)) {
276 return -1;
279 if (!spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
280 VLAN_BD_LEN(bd), DMA_DIRECTION_FROM_DEVICE)
281 || !spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
282 VLAN_BD_LEN(bd), DMA_DIRECTION_TO_DEVICE)) {
283 return -1;
286 return 0;
289 static target_ulong h_register_logical_lan(PowerPCCPU *cpu,
290 sPAPREnvironment *spapr,
291 target_ulong opcode,
292 target_ulong *args)
294 target_ulong reg = args[0];
295 target_ulong buf_list = args[1];
296 target_ulong rec_queue = args[2];
297 target_ulong filter_list = args[3];
298 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
299 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
300 vlan_bd_t filter_list_bd;
302 if (!dev) {
303 return H_PARAMETER;
306 if (dev->isopen) {
307 hcall_dprintf("H_REGISTER_LOGICAL_LAN called twice without "
308 "H_FREE_LOGICAL_LAN\n");
309 return H_RESOURCE;
312 if (check_bd(dev, VLAN_VALID_BD(buf_list, SPAPR_TCE_PAGE_SIZE),
313 SPAPR_TCE_PAGE_SIZE) < 0) {
314 hcall_dprintf("Bad buf_list 0x" TARGET_FMT_lx "\n", buf_list);
315 return H_PARAMETER;
318 filter_list_bd = VLAN_VALID_BD(filter_list, SPAPR_TCE_PAGE_SIZE);
319 if (check_bd(dev, filter_list_bd, SPAPR_TCE_PAGE_SIZE) < 0) {
320 hcall_dprintf("Bad filter_list 0x" TARGET_FMT_lx "\n", filter_list);
321 return H_PARAMETER;
324 if (!(rec_queue & VLAN_BD_VALID)
325 || (check_bd(dev, rec_queue, VLAN_RQ_ALIGNMENT) < 0)) {
326 hcall_dprintf("Bad receive queue\n");
327 return H_PARAMETER;
330 dev->buf_list = buf_list;
331 sdev->signal_state = 0;
333 rec_queue &= ~VLAN_BD_TOGGLE;
335 /* Initialize the buffer list */
336 vio_stq(sdev, buf_list, rec_queue);
337 vio_stq(sdev, buf_list + 8, filter_list_bd);
338 spapr_vio_dma_set(sdev, buf_list + VLAN_RX_BDS_OFF, 0,
339 SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF);
340 dev->add_buf_ptr = VLAN_RX_BDS_OFF - 8;
341 dev->use_buf_ptr = VLAN_RX_BDS_OFF - 8;
342 dev->rx_bufs = 0;
343 dev->rxq_ptr = 0;
345 /* Initialize the receive queue */
346 spapr_vio_dma_set(sdev, VLAN_BD_ADDR(rec_queue), 0, VLAN_BD_LEN(rec_queue));
348 dev->isopen = 1;
349 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
351 return H_SUCCESS;
355 static target_ulong h_free_logical_lan(PowerPCCPU *cpu, sPAPREnvironment *spapr,
356 target_ulong opcode, target_ulong *args)
358 target_ulong reg = args[0];
359 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
360 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
362 if (!dev) {
363 return H_PARAMETER;
366 if (!dev->isopen) {
367 hcall_dprintf("H_FREE_LOGICAL_LAN called without "
368 "H_REGISTER_LOGICAL_LAN\n");
369 return H_RESOURCE;
372 spapr_vlan_reset(sdev);
373 return H_SUCCESS;
376 static target_ulong h_add_logical_lan_buffer(PowerPCCPU *cpu,
377 sPAPREnvironment *spapr,
378 target_ulong opcode,
379 target_ulong *args)
381 target_ulong reg = args[0];
382 target_ulong buf = args[1];
383 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
384 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
385 vlan_bd_t bd;
387 DPRINTF("H_ADD_LOGICAL_LAN_BUFFER(0x" TARGET_FMT_lx
388 ", 0x" TARGET_FMT_lx ")\n", reg, buf);
390 if (!sdev) {
391 hcall_dprintf("Bad device\n");
392 return H_PARAMETER;
395 if ((check_bd(dev, buf, 4) < 0)
396 || (VLAN_BD_LEN(buf) < 16)) {
397 hcall_dprintf("Bad buffer enqueued\n");
398 return H_PARAMETER;
401 if (!dev->isopen || dev->rx_bufs >= VLAN_MAX_BUFS) {
402 return H_RESOURCE;
405 do {
406 dev->add_buf_ptr += 8;
407 if (dev->add_buf_ptr >= (VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF)) {
408 dev->add_buf_ptr = VLAN_RX_BDS_OFF;
411 bd = vio_ldq(sdev, dev->buf_list + dev->add_buf_ptr);
412 } while (bd & VLAN_BD_VALID);
414 vio_stq(sdev, dev->buf_list + dev->add_buf_ptr, buf);
416 dev->rx_bufs++;
418 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
420 DPRINTF("h_add_logical_lan_buffer(): Added buf ptr=%d rx_bufs=%d"
421 " bd=0x%016llx\n", dev->add_buf_ptr, dev->rx_bufs,
422 (unsigned long long)buf);
424 return H_SUCCESS;
427 static target_ulong h_send_logical_lan(PowerPCCPU *cpu, sPAPREnvironment *spapr,
428 target_ulong opcode, target_ulong *args)
430 target_ulong reg = args[0];
431 target_ulong *bufs = args + 1;
432 target_ulong continue_token = args[7];
433 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
434 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
435 unsigned total_len;
436 uint8_t *lbuf, *p;
437 int i, nbufs;
438 int ret;
440 DPRINTF("H_SEND_LOGICAL_LAN(0x" TARGET_FMT_lx ", <bufs>, 0x"
441 TARGET_FMT_lx ")\n", reg, continue_token);
443 if (!sdev) {
444 return H_PARAMETER;
447 DPRINTF("rxbufs = %d\n", dev->rx_bufs);
449 if (!dev->isopen) {
450 return H_DROPPED;
453 if (continue_token) {
454 return H_HARDWARE; /* FIXME actually handle this */
457 total_len = 0;
458 for (i = 0; i < 6; i++) {
459 DPRINTF(" buf desc: 0x" TARGET_FMT_lx "\n", bufs[i]);
460 if (!(bufs[i] & VLAN_BD_VALID)) {
461 break;
463 total_len += VLAN_BD_LEN(bufs[i]);
466 nbufs = i;
467 DPRINTF("h_send_logical_lan() %d buffers, total length 0x%x\n",
468 nbufs, total_len);
470 if (total_len == 0) {
471 return H_SUCCESS;
474 if (total_len > MAX_PACKET_SIZE) {
475 /* Don't let the guest force too large an allocation */
476 return H_RESOURCE;
479 lbuf = alloca(total_len);
480 p = lbuf;
481 for (i = 0; i < nbufs; i++) {
482 ret = spapr_vio_dma_read(sdev, VLAN_BD_ADDR(bufs[i]),
483 p, VLAN_BD_LEN(bufs[i]));
484 if (ret < 0) {
485 return ret;
488 p += VLAN_BD_LEN(bufs[i]);
491 qemu_send_packet(qemu_get_queue(dev->nic), lbuf, total_len);
493 return H_SUCCESS;
496 static target_ulong h_multicast_ctrl(PowerPCCPU *cpu, sPAPREnvironment *spapr,
497 target_ulong opcode, target_ulong *args)
499 target_ulong reg = args[0];
500 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
502 if (!dev) {
503 return H_PARAMETER;
506 return H_SUCCESS;
509 static Property spapr_vlan_properties[] = {
510 DEFINE_SPAPR_PROPERTIES(VIOsPAPRVLANDevice, sdev),
511 DEFINE_NIC_PROPERTIES(VIOsPAPRVLANDevice, nicconf),
512 DEFINE_PROP_END_OF_LIST(),
515 static const VMStateDescription vmstate_spapr_llan = {
516 .name = "spapr_llan",
517 .version_id = 1,
518 .minimum_version_id = 1,
519 .fields = (VMStateField[]) {
520 VMSTATE_SPAPR_VIO(sdev, VIOsPAPRVLANDevice),
521 /* LLAN state */
522 VMSTATE_BOOL(isopen, VIOsPAPRVLANDevice),
523 VMSTATE_UINTTL(buf_list, VIOsPAPRVLANDevice),
524 VMSTATE_UINT32(add_buf_ptr, VIOsPAPRVLANDevice),
525 VMSTATE_UINT32(use_buf_ptr, VIOsPAPRVLANDevice),
526 VMSTATE_UINT32(rx_bufs, VIOsPAPRVLANDevice),
527 VMSTATE_UINTTL(rxq_ptr, VIOsPAPRVLANDevice),
529 VMSTATE_END_OF_LIST()
533 static void spapr_vlan_class_init(ObjectClass *klass, void *data)
535 DeviceClass *dc = DEVICE_CLASS(klass);
536 VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
538 k->init = spapr_vlan_init;
539 k->reset = spapr_vlan_reset;
540 k->devnode = spapr_vlan_devnode;
541 k->dt_name = "l-lan";
542 k->dt_type = "network";
543 k->dt_compatible = "IBM,l-lan";
544 k->signal_mask = 0x1;
545 set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
546 dc->props = spapr_vlan_properties;
547 k->rtce_window_size = 0x10000000;
548 dc->vmsd = &vmstate_spapr_llan;
551 static const TypeInfo spapr_vlan_info = {
552 .name = TYPE_VIO_SPAPR_VLAN_DEVICE,
553 .parent = TYPE_VIO_SPAPR_DEVICE,
554 .instance_size = sizeof(VIOsPAPRVLANDevice),
555 .class_init = spapr_vlan_class_init,
558 static void spapr_vlan_register_types(void)
560 spapr_register_hypercall(H_REGISTER_LOGICAL_LAN, h_register_logical_lan);
561 spapr_register_hypercall(H_FREE_LOGICAL_LAN, h_free_logical_lan);
562 spapr_register_hypercall(H_SEND_LOGICAL_LAN, h_send_logical_lan);
563 spapr_register_hypercall(H_ADD_LOGICAL_LAN_BUFFER,
564 h_add_logical_lan_buffer);
565 spapr_register_hypercall(H_MULTICAST_CTRL, h_multicast_ctrl);
566 type_register_static(&spapr_vlan_info);
569 type_init(spapr_vlan_register_types)