qapi-schema: dump-guest-memory: Improve text
[qemu/ar7.git] / hw / net / spapr_llan.c
blob1ca5e9ce6a9adda451ec9340a25b290f9a5f669e
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 NetClientInfo net_spapr_vlan_info = {
191 .type = NET_CLIENT_OPTIONS_KIND_NIC,
192 .size = sizeof(NICState),
193 .can_receive = spapr_vlan_can_receive,
194 .receive = spapr_vlan_receive,
197 static void spapr_vlan_reset(VIOsPAPRDevice *sdev)
199 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
201 dev->buf_list = 0;
202 dev->rx_bufs = 0;
203 dev->isopen = 0;
206 static void spapr_vlan_realize(VIOsPAPRDevice *sdev, Error **errp)
208 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
210 qemu_macaddr_default_if_unset(&dev->nicconf.macaddr);
212 dev->nic = qemu_new_nic(&net_spapr_vlan_info, &dev->nicconf,
213 object_get_typename(OBJECT(sdev)), sdev->qdev.id, dev);
214 qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
217 static void spapr_vlan_instance_init(Object *obj)
219 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(obj);
221 device_add_bootindex_property(obj, &dev->nicconf.bootindex,
222 "bootindex", "",
223 DEVICE(dev), NULL);
226 void spapr_vlan_create(VIOsPAPRBus *bus, NICInfo *nd)
228 DeviceState *dev;
230 dev = qdev_create(&bus->bus, "spapr-vlan");
232 qdev_set_nic_properties(dev, nd);
234 qdev_init_nofail(dev);
237 static int spapr_vlan_devnode(VIOsPAPRDevice *dev, void *fdt, int node_off)
239 VIOsPAPRVLANDevice *vdev = VIO_SPAPR_VLAN_DEVICE(dev);
240 uint8_t padded_mac[8] = {0, 0};
241 int ret;
243 /* Some old phyp versions give the mac address in an 8-byte
244 * property. The kernel driver has an insane workaround for this;
245 * rather than doing the obvious thing and checking the property
246 * length, it checks whether the first byte has 0b10 in the low
247 * bits. If a correct 6-byte property has a different first byte
248 * the kernel will get the wrong mac address, overrunning its
249 * buffer in the process (read only, thank goodness).
251 * Here we workaround the kernel workaround by always supplying an
252 * 8-byte property, with the mac address in the last six bytes */
253 memcpy(&padded_mac[2], &vdev->nicconf.macaddr, ETH_ALEN);
254 ret = fdt_setprop(fdt, node_off, "local-mac-address",
255 padded_mac, sizeof(padded_mac));
256 if (ret < 0) {
257 return ret;
260 ret = fdt_setprop_cell(fdt, node_off, "ibm,mac-address-filters", 0);
261 if (ret < 0) {
262 return ret;
265 return 0;
268 static int check_bd(VIOsPAPRVLANDevice *dev, vlan_bd_t bd,
269 target_ulong alignment)
271 if ((VLAN_BD_ADDR(bd) % alignment)
272 || (VLAN_BD_LEN(bd) % alignment)) {
273 return -1;
276 if (!spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
277 VLAN_BD_LEN(bd), DMA_DIRECTION_FROM_DEVICE)
278 || !spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
279 VLAN_BD_LEN(bd), DMA_DIRECTION_TO_DEVICE)) {
280 return -1;
283 return 0;
286 static target_ulong h_register_logical_lan(PowerPCCPU *cpu,
287 sPAPRMachineState *spapr,
288 target_ulong opcode,
289 target_ulong *args)
291 target_ulong reg = args[0];
292 target_ulong buf_list = args[1];
293 target_ulong rec_queue = args[2];
294 target_ulong filter_list = args[3];
295 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
296 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
297 vlan_bd_t filter_list_bd;
299 if (!dev) {
300 return H_PARAMETER;
303 if (dev->isopen) {
304 hcall_dprintf("H_REGISTER_LOGICAL_LAN called twice without "
305 "H_FREE_LOGICAL_LAN\n");
306 return H_RESOURCE;
309 if (check_bd(dev, VLAN_VALID_BD(buf_list, SPAPR_TCE_PAGE_SIZE),
310 SPAPR_TCE_PAGE_SIZE) < 0) {
311 hcall_dprintf("Bad buf_list 0x" TARGET_FMT_lx "\n", buf_list);
312 return H_PARAMETER;
315 filter_list_bd = VLAN_VALID_BD(filter_list, SPAPR_TCE_PAGE_SIZE);
316 if (check_bd(dev, filter_list_bd, SPAPR_TCE_PAGE_SIZE) < 0) {
317 hcall_dprintf("Bad filter_list 0x" TARGET_FMT_lx "\n", filter_list);
318 return H_PARAMETER;
321 if (!(rec_queue & VLAN_BD_VALID)
322 || (check_bd(dev, rec_queue, VLAN_RQ_ALIGNMENT) < 0)) {
323 hcall_dprintf("Bad receive queue\n");
324 return H_PARAMETER;
327 dev->buf_list = buf_list;
328 sdev->signal_state = 0;
330 rec_queue &= ~VLAN_BD_TOGGLE;
332 /* Initialize the buffer list */
333 vio_stq(sdev, buf_list, rec_queue);
334 vio_stq(sdev, buf_list + 8, filter_list_bd);
335 spapr_vio_dma_set(sdev, buf_list + VLAN_RX_BDS_OFF, 0,
336 SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF);
337 dev->add_buf_ptr = VLAN_RX_BDS_OFF - 8;
338 dev->use_buf_ptr = VLAN_RX_BDS_OFF - 8;
339 dev->rx_bufs = 0;
340 dev->rxq_ptr = 0;
342 /* Initialize the receive queue */
343 spapr_vio_dma_set(sdev, VLAN_BD_ADDR(rec_queue), 0, VLAN_BD_LEN(rec_queue));
345 dev->isopen = 1;
346 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
348 return H_SUCCESS;
352 static target_ulong h_free_logical_lan(PowerPCCPU *cpu,
353 sPAPRMachineState *spapr,
354 target_ulong opcode, target_ulong *args)
356 target_ulong reg = args[0];
357 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
358 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
360 if (!dev) {
361 return H_PARAMETER;
364 if (!dev->isopen) {
365 hcall_dprintf("H_FREE_LOGICAL_LAN called without "
366 "H_REGISTER_LOGICAL_LAN\n");
367 return H_RESOURCE;
370 spapr_vlan_reset(sdev);
371 return H_SUCCESS;
374 static target_ulong h_add_logical_lan_buffer(PowerPCCPU *cpu,
375 sPAPRMachineState *spapr,
376 target_ulong opcode,
377 target_ulong *args)
379 target_ulong reg = args[0];
380 target_ulong buf = args[1];
381 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
382 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
383 vlan_bd_t bd;
385 DPRINTF("H_ADD_LOGICAL_LAN_BUFFER(0x" TARGET_FMT_lx
386 ", 0x" TARGET_FMT_lx ")\n", reg, buf);
388 if (!sdev) {
389 hcall_dprintf("Bad device\n");
390 return H_PARAMETER;
393 if ((check_bd(dev, buf, 4) < 0)
394 || (VLAN_BD_LEN(buf) < 16)) {
395 hcall_dprintf("Bad buffer enqueued\n");
396 return H_PARAMETER;
399 if (!dev->isopen || dev->rx_bufs >= VLAN_MAX_BUFS) {
400 return H_RESOURCE;
403 do {
404 dev->add_buf_ptr += 8;
405 if (dev->add_buf_ptr >= (VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF)) {
406 dev->add_buf_ptr = VLAN_RX_BDS_OFF;
409 bd = vio_ldq(sdev, dev->buf_list + dev->add_buf_ptr);
410 } while (bd & VLAN_BD_VALID);
412 vio_stq(sdev, dev->buf_list + dev->add_buf_ptr, buf);
414 dev->rx_bufs++;
416 qemu_flush_queued_packets(qemu_get_queue(dev->nic));
418 DPRINTF("h_add_logical_lan_buffer(): Added buf ptr=%d rx_bufs=%d"
419 " bd=0x%016llx\n", dev->add_buf_ptr, dev->rx_bufs,
420 (unsigned long long)buf);
422 return H_SUCCESS;
425 static target_ulong h_send_logical_lan(PowerPCCPU *cpu,
426 sPAPRMachineState *spapr,
427 target_ulong opcode, target_ulong *args)
429 target_ulong reg = args[0];
430 target_ulong *bufs = args + 1;
431 target_ulong continue_token = args[7];
432 VIOsPAPRDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
433 VIOsPAPRVLANDevice *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
434 unsigned total_len;
435 uint8_t *lbuf, *p;
436 int i, nbufs;
437 int ret;
439 DPRINTF("H_SEND_LOGICAL_LAN(0x" TARGET_FMT_lx ", <bufs>, 0x"
440 TARGET_FMT_lx ")\n", reg, continue_token);
442 if (!sdev) {
443 return H_PARAMETER;
446 DPRINTF("rxbufs = %d\n", dev->rx_bufs);
448 if (!dev->isopen) {
449 return H_DROPPED;
452 if (continue_token) {
453 return H_HARDWARE; /* FIXME actually handle this */
456 total_len = 0;
457 for (i = 0; i < 6; i++) {
458 DPRINTF(" buf desc: 0x" TARGET_FMT_lx "\n", bufs[i]);
459 if (!(bufs[i] & VLAN_BD_VALID)) {
460 break;
462 total_len += VLAN_BD_LEN(bufs[i]);
465 nbufs = i;
466 DPRINTF("h_send_logical_lan() %d buffers, total length 0x%x\n",
467 nbufs, total_len);
469 if (total_len == 0) {
470 return H_SUCCESS;
473 if (total_len > MAX_PACKET_SIZE) {
474 /* Don't let the guest force too large an allocation */
475 return H_RESOURCE;
478 lbuf = alloca(total_len);
479 p = lbuf;
480 for (i = 0; i < nbufs; i++) {
481 ret = spapr_vio_dma_read(sdev, VLAN_BD_ADDR(bufs[i]),
482 p, VLAN_BD_LEN(bufs[i]));
483 if (ret < 0) {
484 return ret;
487 p += VLAN_BD_LEN(bufs[i]);
490 qemu_send_packet(qemu_get_queue(dev->nic), lbuf, total_len);
492 return H_SUCCESS;
495 static target_ulong h_multicast_ctrl(PowerPCCPU *cpu, sPAPRMachineState *spapr,
496 target_ulong opcode, target_ulong *args)
498 target_ulong reg = args[0];
499 VIOsPAPRDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
501 if (!dev) {
502 return H_PARAMETER;
505 return H_SUCCESS;
508 static Property spapr_vlan_properties[] = {
509 DEFINE_SPAPR_PROPERTIES(VIOsPAPRVLANDevice, sdev),
510 DEFINE_NIC_PROPERTIES(VIOsPAPRVLANDevice, nicconf),
511 DEFINE_PROP_END_OF_LIST(),
514 static const VMStateDescription vmstate_spapr_llan = {
515 .name = "spapr_llan",
516 .version_id = 1,
517 .minimum_version_id = 1,
518 .fields = (VMStateField[]) {
519 VMSTATE_SPAPR_VIO(sdev, VIOsPAPRVLANDevice),
520 /* LLAN state */
521 VMSTATE_BOOL(isopen, VIOsPAPRVLANDevice),
522 VMSTATE_UINTTL(buf_list, VIOsPAPRVLANDevice),
523 VMSTATE_UINT32(add_buf_ptr, VIOsPAPRVLANDevice),
524 VMSTATE_UINT32(use_buf_ptr, VIOsPAPRVLANDevice),
525 VMSTATE_UINT32(rx_bufs, VIOsPAPRVLANDevice),
526 VMSTATE_UINTTL(rxq_ptr, VIOsPAPRVLANDevice),
528 VMSTATE_END_OF_LIST()
532 static void spapr_vlan_class_init(ObjectClass *klass, void *data)
534 DeviceClass *dc = DEVICE_CLASS(klass);
535 VIOsPAPRDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
537 k->realize = spapr_vlan_realize;
538 k->reset = spapr_vlan_reset;
539 k->devnode = spapr_vlan_devnode;
540 k->dt_name = "l-lan";
541 k->dt_type = "network";
542 k->dt_compatible = "IBM,l-lan";
543 k->signal_mask = 0x1;
544 set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
545 dc->props = spapr_vlan_properties;
546 k->rtce_window_size = 0x10000000;
547 dc->vmsd = &vmstate_spapr_llan;
550 static const TypeInfo spapr_vlan_info = {
551 .name = TYPE_VIO_SPAPR_VLAN_DEVICE,
552 .parent = TYPE_VIO_SPAPR_DEVICE,
553 .instance_size = sizeof(VIOsPAPRVLANDevice),
554 .class_init = spapr_vlan_class_init,
555 .instance_init = spapr_vlan_instance_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)