xref: /openbmc/qemu/hw/net/spapr_llan.c (revision 0e8e77d4)
1 /*
2  * QEMU PowerPC pSeries Logical Partition (aka sPAPR) hardware System Emulator
3  *
4  * PAPR Inter-VM Logical Lan, aka ibmveth
5  *
6  * Copyright (c) 2010,2011 David Gibson, IBM Corporation.
7  *
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:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
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.
25  *
26  */
27 
28 #include "qemu/osdep.h"
29 #include "cpu.h"
30 #include "qemu/log.h"
31 #include "qemu/module.h"
32 #include "net/net.h"
33 #include "migration/vmstate.h"
34 #include "hw/ppc/spapr.h"
35 #include "hw/ppc/spapr_vio.h"
36 #include "hw/qdev-properties.h"
37 #include "sysemu/sysemu.h"
38 #include "trace.h"
39 
40 #include <libfdt.h>
41 #include "qom/object.h"
42 
43 #define ETH_ALEN        6
44 #define MAX_PACKET_SIZE 65536
45 
46 /* Compatibility flags for migration */
47 #define SPAPRVLAN_FLAG_RX_BUF_POOLS_BIT  0
48 #define SPAPRVLAN_FLAG_RX_BUF_POOLS      (1 << SPAPRVLAN_FLAG_RX_BUF_POOLS_BIT)
49 
50 /*
51  * Virtual LAN device
52  */
53 
54 typedef uint64_t vlan_bd_t;
55 
56 #define VLAN_BD_VALID        0x8000000000000000ULL
57 #define VLAN_BD_TOGGLE       0x4000000000000000ULL
58 #define VLAN_BD_NO_CSUM      0x0200000000000000ULL
59 #define VLAN_BD_CSUM_GOOD    0x0100000000000000ULL
60 #define VLAN_BD_LEN_MASK     0x00ffffff00000000ULL
61 #define VLAN_BD_LEN(bd)      (((bd) & VLAN_BD_LEN_MASK) >> 32)
62 #define VLAN_BD_ADDR_MASK    0x00000000ffffffffULL
63 #define VLAN_BD_ADDR(bd)     ((bd) & VLAN_BD_ADDR_MASK)
64 
65 #define VLAN_VALID_BD(addr, len) (VLAN_BD_VALID | \
66                                   (((len) << 32) & VLAN_BD_LEN_MASK) |  \
67                                   (addr & VLAN_BD_ADDR_MASK))
68 
69 #define VLAN_RXQC_TOGGLE     0x80
70 #define VLAN_RXQC_VALID      0x40
71 #define VLAN_RXQC_NO_CSUM    0x02
72 #define VLAN_RXQC_CSUM_GOOD  0x01
73 
74 #define VLAN_RQ_ALIGNMENT    16
75 #define VLAN_RXQ_BD_OFF      0
76 #define VLAN_FILTER_BD_OFF   8
77 #define VLAN_RX_BDS_OFF      16
78 /*
79  * The final 8 bytes of the buffer list is a counter of frames dropped
80  * because there was not a buffer in the buffer list capable of holding
81  * the frame. We must avoid it, or the operating system will report garbage
82  * for this statistic.
83  */
84 #define VLAN_RX_BDS_LEN      (SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF - 8)
85 #define VLAN_MAX_BUFS        (VLAN_RX_BDS_LEN / 8)
86 
87 #define TYPE_VIO_SPAPR_VLAN_DEVICE "spapr-vlan"
88 OBJECT_DECLARE_SIMPLE_TYPE(SpaprVioVlan, VIO_SPAPR_VLAN_DEVICE)
89 
90 #define RX_POOL_MAX_BDS 4096
91 #define RX_MAX_POOLS 5
92 
93 typedef struct {
94     int32_t bufsize;
95     int32_t count;
96     vlan_bd_t bds[RX_POOL_MAX_BDS];
97 } RxBufPool;
98 
99 struct SpaprVioVlan {
100     SpaprVioDevice sdev;
101     NICConf nicconf;
102     NICState *nic;
103     MACAddr perm_mac;
104     bool isopen;
105     hwaddr buf_list;
106     uint32_t add_buf_ptr, use_buf_ptr, rx_bufs;
107     hwaddr rxq_ptr;
108     QEMUTimer *rxp_timer;
109     uint32_t compat_flags;             /* Compatibility flags for migration */
110     RxBufPool *rx_pool[RX_MAX_POOLS];  /* Receive buffer descriptor pools */
111 };
112 
113 static bool spapr_vlan_can_receive(NetClientState *nc)
114 {
115     SpaprVioVlan *dev = qemu_get_nic_opaque(nc);
116 
117     return dev->isopen && dev->rx_bufs > 0;
118 }
119 
120 /**
121  * The last 8 bytes of the receive buffer list page (that has been
122  * supplied by the guest with the H_REGISTER_LOGICAL_LAN call) contain
123  * a counter for frames that have been dropped because there was no
124  * suitable receive buffer available. This function is used to increase
125  * this counter by one.
126  */
127 static void spapr_vlan_record_dropped_rx_frame(SpaprVioVlan *dev)
128 {
129     uint64_t cnt;
130 
131     cnt = vio_ldq(&dev->sdev, dev->buf_list + 4096 - 8);
132     vio_stq(&dev->sdev, dev->buf_list + 4096 - 8, cnt + 1);
133 }
134 
135 /**
136  * Get buffer descriptor from one of our receive buffer pools
137  */
138 static vlan_bd_t spapr_vlan_get_rx_bd_from_pool(SpaprVioVlan *dev,
139                                                 size_t size)
140 {
141     vlan_bd_t bd;
142     int pool;
143 
144     for (pool = 0; pool < RX_MAX_POOLS; pool++) {
145         if (dev->rx_pool[pool]->count > 0 &&
146             dev->rx_pool[pool]->bufsize >= size + 8) {
147             break;
148         }
149     }
150     if (pool == RX_MAX_POOLS) {
151         /* Failed to find a suitable buffer */
152         return 0;
153     }
154 
155 
156     trace_spapr_vlan_get_rx_bd_from_pool_found(pool,
157                                                dev->rx_pool[pool]->count,
158                                                dev->rx_bufs);
159 
160     /* Remove the buffer from the pool */
161     dev->rx_pool[pool]->count--;
162     bd = dev->rx_pool[pool]->bds[dev->rx_pool[pool]->count];
163     dev->rx_pool[pool]->bds[dev->rx_pool[pool]->count] = 0;
164 
165     return bd;
166 }
167 
168 /**
169  * Get buffer descriptor from the receive buffer list page that has been
170  * supplied by the guest with the H_REGISTER_LOGICAL_LAN call
171  */
172 static vlan_bd_t spapr_vlan_get_rx_bd_from_page(SpaprVioVlan *dev,
173                                                 size_t size)
174 {
175     int buf_ptr = dev->use_buf_ptr;
176     vlan_bd_t bd;
177 
178     do {
179         buf_ptr += 8;
180         if (buf_ptr >= VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF) {
181             buf_ptr = VLAN_RX_BDS_OFF;
182         }
183 
184         bd = vio_ldq(&dev->sdev, dev->buf_list + buf_ptr);
185 
186         trace_spapr_vlan_get_rx_bd_from_page(buf_ptr, (uint64_t)bd);
187     } while ((!(bd & VLAN_BD_VALID) || VLAN_BD_LEN(bd) < size + 8)
188              && buf_ptr != dev->use_buf_ptr);
189 
190     if (!(bd & VLAN_BD_VALID) || VLAN_BD_LEN(bd) < size + 8) {
191         /* Failed to find a suitable buffer */
192         return 0;
193     }
194 
195     /* Remove the buffer from the pool */
196     dev->use_buf_ptr = buf_ptr;
197     vio_stq(&dev->sdev, dev->buf_list + dev->use_buf_ptr, 0);
198 
199     trace_spapr_vlan_get_rx_bd_from_page_found(dev->use_buf_ptr, dev->rx_bufs);
200 
201     return bd;
202 }
203 
204 static ssize_t spapr_vlan_receive(NetClientState *nc, const uint8_t *buf,
205                                   size_t size)
206 {
207     SpaprVioVlan *dev = qemu_get_nic_opaque(nc);
208     SpaprVioDevice *sdev = VIO_SPAPR_DEVICE(dev);
209     vlan_bd_t rxq_bd = vio_ldq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF);
210     vlan_bd_t bd;
211     uint64_t handle;
212     uint8_t control;
213 
214     trace_spapr_vlan_receive(sdev->qdev.id, dev->rx_bufs);
215 
216     if (!dev->isopen) {
217         return -1;
218     }
219 
220     if (!dev->rx_bufs) {
221         spapr_vlan_record_dropped_rx_frame(dev);
222         return 0;
223     }
224 
225     if (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) {
226         bd = spapr_vlan_get_rx_bd_from_pool(dev, size);
227     } else {
228         bd = spapr_vlan_get_rx_bd_from_page(dev, size);
229     }
230     if (!bd) {
231         spapr_vlan_record_dropped_rx_frame(dev);
232         return 0;
233     }
234 
235     dev->rx_bufs--;
236 
237     /* Transfer the packet data */
238     if (spapr_vio_dma_write(sdev, VLAN_BD_ADDR(bd) + 8, buf, size) < 0) {
239         return -1;
240     }
241 
242     trace_spapr_vlan_receive_dma_completed();
243 
244     /* Update the receive queue */
245     control = VLAN_RXQC_TOGGLE | VLAN_RXQC_VALID;
246     if (rxq_bd & VLAN_BD_TOGGLE) {
247         control ^= VLAN_RXQC_TOGGLE;
248     }
249 
250     handle = vio_ldq(sdev, VLAN_BD_ADDR(bd));
251     vio_stq(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 8, handle);
252     vio_stl(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 4, size);
253     vio_sth(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr + 2, 8);
254     vio_stb(sdev, VLAN_BD_ADDR(rxq_bd) + dev->rxq_ptr, control);
255 
256     trace_spapr_vlan_receive_wrote(dev->rxq_ptr,
257                                    vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
258                                                  dev->rxq_ptr),
259                                    vio_ldq(sdev, VLAN_BD_ADDR(rxq_bd) +
260                                                  dev->rxq_ptr + 8));
261 
262     dev->rxq_ptr += 16;
263     if (dev->rxq_ptr >= VLAN_BD_LEN(rxq_bd)) {
264         dev->rxq_ptr = 0;
265         vio_stq(sdev, dev->buf_list + VLAN_RXQ_BD_OFF, rxq_bd ^ VLAN_BD_TOGGLE);
266     }
267 
268     if (sdev->signal_state & 1) {
269         spapr_vio_irq_pulse(sdev);
270     }
271 
272     return size;
273 }
274 
275 static NetClientInfo net_spapr_vlan_info = {
276     .type = NET_CLIENT_DRIVER_NIC,
277     .size = sizeof(NICState),
278     .can_receive = spapr_vlan_can_receive,
279     .receive = spapr_vlan_receive,
280 };
281 
282 static void spapr_vlan_flush_rx_queue(void *opaque)
283 {
284     SpaprVioVlan *dev = opaque;
285 
286     qemu_flush_queued_packets(qemu_get_queue(dev->nic));
287 }
288 
289 static void spapr_vlan_reset_rx_pool(RxBufPool *rxp)
290 {
291     /*
292      * Use INT_MAX as bufsize so that unused buffers are moved to the end
293      * of the list during the qsort in spapr_vlan_add_rxbuf_to_pool() later.
294      */
295     rxp->bufsize = INT_MAX;
296     rxp->count = 0;
297     memset(rxp->bds, 0, sizeof(rxp->bds));
298 }
299 
300 static void spapr_vlan_reset(SpaprVioDevice *sdev)
301 {
302     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
303     int i;
304 
305     dev->buf_list = 0;
306     dev->rx_bufs = 0;
307     dev->isopen = 0;
308 
309     if (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) {
310         for (i = 0; i < RX_MAX_POOLS; i++) {
311             spapr_vlan_reset_rx_pool(dev->rx_pool[i]);
312         }
313     }
314 
315     memcpy(&dev->nicconf.macaddr.a, &dev->perm_mac.a,
316            sizeof(dev->nicconf.macaddr.a));
317     qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
318 }
319 
320 static void spapr_vlan_realize(SpaprVioDevice *sdev, Error **errp)
321 {
322     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
323 
324     qemu_macaddr_default_if_unset(&dev->nicconf.macaddr);
325 
326     memcpy(&dev->perm_mac.a, &dev->nicconf.macaddr.a, sizeof(dev->perm_mac.a));
327 
328     dev->nic = qemu_new_nic(&net_spapr_vlan_info, &dev->nicconf,
329                             object_get_typename(OBJECT(sdev)), sdev->qdev.id, dev);
330     qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
331 
332     dev->rxp_timer = timer_new_us(QEMU_CLOCK_VIRTUAL, spapr_vlan_flush_rx_queue,
333                                   dev);
334 }
335 
336 static void spapr_vlan_instance_init(Object *obj)
337 {
338     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(obj);
339     int i;
340 
341     device_add_bootindex_property(obj, &dev->nicconf.bootindex,
342                                   "bootindex", "",
343                                   DEVICE(dev));
344 
345     if (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) {
346         for (i = 0; i < RX_MAX_POOLS; i++) {
347             dev->rx_pool[i] = g_new(RxBufPool, 1);
348             spapr_vlan_reset_rx_pool(dev->rx_pool[i]);
349         }
350     }
351 }
352 
353 static void spapr_vlan_instance_finalize(Object *obj)
354 {
355     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(obj);
356     int i;
357 
358     if (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) {
359         for (i = 0; i < RX_MAX_POOLS; i++) {
360             g_free(dev->rx_pool[i]);
361             dev->rx_pool[i] = NULL;
362         }
363     }
364 
365     if (dev->rxp_timer) {
366         timer_del(dev->rxp_timer);
367         timer_free(dev->rxp_timer);
368     }
369 }
370 
371 void spapr_vlan_create(SpaprVioBus *bus, NICInfo *nd)
372 {
373     DeviceState *dev;
374 
375     dev = qdev_new("spapr-vlan");
376 
377     qdev_set_nic_properties(dev, nd);
378 
379     qdev_realize_and_unref(dev, &bus->bus, &error_fatal);
380 }
381 
382 static int spapr_vlan_devnode(SpaprVioDevice *dev, void *fdt, int node_off)
383 {
384     SpaprVioVlan *vdev = VIO_SPAPR_VLAN_DEVICE(dev);
385     uint8_t padded_mac[8] = {0, 0};
386     int ret;
387 
388     /* Some old phyp versions give the mac address in an 8-byte
389      * property.  The kernel driver (before 3.10) has an insane workaround;
390      * rather than doing the obvious thing and checking the property
391      * length, it checks whether the first byte has 0b10 in the low
392      * bits.  If a correct 6-byte property has a different first byte
393      * the kernel will get the wrong mac address, overrunning its
394      * buffer in the process (read only, thank goodness).
395      *
396      * Here we return a 6-byte address unless that would break a pre-3.10
397      * driver.  In that case we return a padded 8-byte address to allow the old
398      * workaround to succeed. */
399     if ((vdev->nicconf.macaddr.a[0] & 0x3) == 0x2) {
400         ret = fdt_setprop(fdt, node_off, "local-mac-address",
401                           &vdev->nicconf.macaddr, ETH_ALEN);
402     } else {
403         memcpy(&padded_mac[2], &vdev->nicconf.macaddr, ETH_ALEN);
404         ret = fdt_setprop(fdt, node_off, "local-mac-address",
405                           padded_mac, sizeof(padded_mac));
406     }
407     if (ret < 0) {
408         return ret;
409     }
410 
411     ret = fdt_setprop_cell(fdt, node_off, "ibm,mac-address-filters", 0);
412     if (ret < 0) {
413         return ret;
414     }
415 
416     return 0;
417 }
418 
419 static int check_bd(SpaprVioVlan *dev, vlan_bd_t bd,
420                     target_ulong alignment)
421 {
422     if ((VLAN_BD_ADDR(bd) % alignment)
423         || (VLAN_BD_LEN(bd) % alignment)) {
424         return -1;
425     }
426 
427     if (!spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
428                              VLAN_BD_LEN(bd), DMA_DIRECTION_FROM_DEVICE)
429         || !spapr_vio_dma_valid(&dev->sdev, VLAN_BD_ADDR(bd),
430                                 VLAN_BD_LEN(bd), DMA_DIRECTION_TO_DEVICE)) {
431         return -1;
432     }
433 
434     return 0;
435 }
436 
437 static target_ulong h_register_logical_lan(PowerPCCPU *cpu,
438                                            SpaprMachineState *spapr,
439                                            target_ulong opcode,
440                                            target_ulong *args)
441 {
442     target_ulong reg = args[0];
443     target_ulong buf_list = args[1];
444     target_ulong rec_queue = args[2];
445     target_ulong filter_list = args[3];
446     SpaprVioDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
447     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
448     vlan_bd_t filter_list_bd;
449 
450     if (!dev) {
451         return H_PARAMETER;
452     }
453 
454     if (dev->isopen) {
455         hcall_dprintf("H_REGISTER_LOGICAL_LAN called twice without "
456                       "H_FREE_LOGICAL_LAN\n");
457         return H_RESOURCE;
458     }
459 
460     if (check_bd(dev, VLAN_VALID_BD(buf_list, SPAPR_TCE_PAGE_SIZE),
461                  SPAPR_TCE_PAGE_SIZE) < 0) {
462         hcall_dprintf("Bad buf_list 0x" TARGET_FMT_lx "\n", buf_list);
463         return H_PARAMETER;
464     }
465 
466     filter_list_bd = VLAN_VALID_BD(filter_list, SPAPR_TCE_PAGE_SIZE);
467     if (check_bd(dev, filter_list_bd, SPAPR_TCE_PAGE_SIZE) < 0) {
468         hcall_dprintf("Bad filter_list 0x" TARGET_FMT_lx "\n", filter_list);
469         return H_PARAMETER;
470     }
471 
472     if (!(rec_queue & VLAN_BD_VALID)
473         || (check_bd(dev, rec_queue, VLAN_RQ_ALIGNMENT) < 0)) {
474         hcall_dprintf("Bad receive queue\n");
475         return H_PARAMETER;
476     }
477 
478     dev->buf_list = buf_list;
479     sdev->signal_state = 0;
480 
481     rec_queue &= ~VLAN_BD_TOGGLE;
482 
483     /* Initialize the buffer list */
484     vio_stq(sdev, buf_list, rec_queue);
485     vio_stq(sdev, buf_list + 8, filter_list_bd);
486     spapr_vio_dma_set(sdev, buf_list + VLAN_RX_BDS_OFF, 0,
487                       SPAPR_TCE_PAGE_SIZE - VLAN_RX_BDS_OFF);
488     dev->add_buf_ptr = VLAN_RX_BDS_OFF - 8;
489     dev->use_buf_ptr = VLAN_RX_BDS_OFF - 8;
490     dev->rx_bufs = 0;
491     dev->rxq_ptr = 0;
492 
493     /* Initialize the receive queue */
494     spapr_vio_dma_set(sdev, VLAN_BD_ADDR(rec_queue), 0, VLAN_BD_LEN(rec_queue));
495 
496     dev->isopen = 1;
497     qemu_flush_queued_packets(qemu_get_queue(dev->nic));
498 
499     return H_SUCCESS;
500 }
501 
502 
503 static target_ulong h_free_logical_lan(PowerPCCPU *cpu,
504                                        SpaprMachineState *spapr,
505                                        target_ulong opcode, target_ulong *args)
506 {
507     target_ulong reg = args[0];
508     SpaprVioDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
509     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
510 
511     if (!dev) {
512         return H_PARAMETER;
513     }
514 
515     if (!dev->isopen) {
516         hcall_dprintf("H_FREE_LOGICAL_LAN called without "
517                       "H_REGISTER_LOGICAL_LAN\n");
518         return H_RESOURCE;
519     }
520 
521     spapr_vlan_reset(sdev);
522     return H_SUCCESS;
523 }
524 
525 /**
526  * Used for qsort, this function compares two RxBufPools by size.
527  */
528 static int rx_pool_size_compare(const void *p1, const void *p2)
529 {
530     const RxBufPool *pool1 = *(RxBufPool **)p1;
531     const RxBufPool *pool2 = *(RxBufPool **)p2;
532 
533     if (pool1->bufsize < pool2->bufsize) {
534         return -1;
535     }
536     return pool1->bufsize > pool2->bufsize;
537 }
538 
539 /**
540  * Search for a matching buffer pool with exact matching size,
541  * or return -1 if no matching pool has been found.
542  */
543 static int spapr_vlan_get_rx_pool_id(SpaprVioVlan *dev, int size)
544 {
545     int pool;
546 
547     for (pool = 0; pool < RX_MAX_POOLS; pool++) {
548         if (dev->rx_pool[pool]->bufsize == size) {
549             return pool;
550         }
551     }
552 
553     return -1;
554 }
555 
556 /**
557  * Enqueuing receive buffer by adding it to one of our receive buffer pools
558  */
559 static target_long spapr_vlan_add_rxbuf_to_pool(SpaprVioVlan *dev,
560                                                 target_ulong buf)
561 {
562     int size = VLAN_BD_LEN(buf);
563     int pool;
564 
565     pool = spapr_vlan_get_rx_pool_id(dev, size);
566     if (pool < 0) {
567         /*
568          * No matching pool found? Try to use a new one. If the guest used all
569          * pools before, but changed the size of one pool in the meantime, we might
570          * need to recycle that pool here (if it's empty already). Thus scan
571          * all buffer pools now, starting with the last (likely empty) one.
572          */
573         for (pool = RX_MAX_POOLS - 1; pool >= 0 ; pool--) {
574             if (dev->rx_pool[pool]->count == 0) {
575                 dev->rx_pool[pool]->bufsize = size;
576                 /*
577                  * Sort pools by size so that spapr_vlan_receive()
578                  * can later find the smallest buffer pool easily.
579                  */
580                 qsort(dev->rx_pool, RX_MAX_POOLS, sizeof(dev->rx_pool[0]),
581                       rx_pool_size_compare);
582                 pool = spapr_vlan_get_rx_pool_id(dev, size);
583                 trace_spapr_vlan_add_rxbuf_to_pool_create(pool,
584                                                           VLAN_BD_LEN(buf));
585                 break;
586             }
587         }
588     }
589     /* Still no usable pool? Give up */
590     if (pool < 0 || dev->rx_pool[pool]->count >= RX_POOL_MAX_BDS) {
591         return H_RESOURCE;
592     }
593 
594     trace_spapr_vlan_add_rxbuf_to_pool(pool, VLAN_BD_LEN(buf),
595                                        dev->rx_pool[pool]->count);
596 
597     dev->rx_pool[pool]->bds[dev->rx_pool[pool]->count++] = buf;
598 
599     return 0;
600 }
601 
602 /**
603  * This is the old way of enqueuing receive buffers: Add it to the rx queue
604  * page that has been supplied by the guest (which is quite limited in size).
605  */
606 static target_long spapr_vlan_add_rxbuf_to_page(SpaprVioVlan *dev,
607                                                 target_ulong buf)
608 {
609     vlan_bd_t bd;
610 
611     if (dev->rx_bufs >= VLAN_MAX_BUFS) {
612         return H_RESOURCE;
613     }
614 
615     do {
616         dev->add_buf_ptr += 8;
617         if (dev->add_buf_ptr >= VLAN_RX_BDS_LEN + VLAN_RX_BDS_OFF) {
618             dev->add_buf_ptr = VLAN_RX_BDS_OFF;
619         }
620 
621         bd = vio_ldq(&dev->sdev, dev->buf_list + dev->add_buf_ptr);
622     } while (bd & VLAN_BD_VALID);
623 
624     vio_stq(&dev->sdev, dev->buf_list + dev->add_buf_ptr, buf);
625 
626     trace_spapr_vlan_add_rxbuf_to_page(dev->add_buf_ptr, dev->rx_bufs, buf);
627 
628     return 0;
629 }
630 
631 static target_ulong h_add_logical_lan_buffer(PowerPCCPU *cpu,
632                                              SpaprMachineState *spapr,
633                                              target_ulong opcode,
634                                              target_ulong *args)
635 {
636     target_ulong reg = args[0];
637     target_ulong buf = args[1];
638     SpaprVioDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
639     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
640     target_long ret;
641 
642     trace_spapr_vlan_h_add_logical_lan_buffer(reg, buf);
643 
644     if (!sdev) {
645         hcall_dprintf("Bad device\n");
646         return H_PARAMETER;
647     }
648 
649     if ((check_bd(dev, buf, 4) < 0)
650         || (VLAN_BD_LEN(buf) < 16)) {
651         hcall_dprintf("Bad buffer enqueued\n");
652         return H_PARAMETER;
653     }
654 
655     if (!dev->isopen) {
656         return H_RESOURCE;
657     }
658 
659     if (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) {
660         ret = spapr_vlan_add_rxbuf_to_pool(dev, buf);
661     } else {
662         ret = spapr_vlan_add_rxbuf_to_page(dev, buf);
663     }
664     if (ret) {
665         return ret;
666     }
667 
668     dev->rx_bufs++;
669 
670     /*
671      * Give guest some more time to add additional RX buffers before we
672      * flush the receive queue, so that e.g. fragmented IP packets can
673      * be passed to the guest in one go later (instead of passing single
674      * fragments if there is only one receive buffer available).
675      */
676     timer_mod(dev->rxp_timer, qemu_clock_get_us(QEMU_CLOCK_VIRTUAL) + 500);
677 
678     return H_SUCCESS;
679 }
680 
681 static target_ulong h_send_logical_lan(PowerPCCPU *cpu,
682                                        SpaprMachineState *spapr,
683                                        target_ulong opcode, target_ulong *args)
684 {
685     target_ulong reg = args[0];
686     target_ulong *bufs = args + 1;
687     target_ulong continue_token = args[7];
688     SpaprVioDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
689     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
690     unsigned total_len;
691     uint8_t *p;
692     g_autofree uint8_t *lbuf = NULL;
693     int i, nbufs;
694     int ret;
695 
696     trace_spapr_vlan_h_send_logical_lan(reg, continue_token);
697 
698     if (!sdev) {
699         return H_PARAMETER;
700     }
701 
702     trace_spapr_vlan_h_send_logical_lan_rxbufs(dev->rx_bufs);
703 
704     if (!dev->isopen) {
705         return H_DROPPED;
706     }
707 
708     if (continue_token) {
709         return H_HARDWARE; /* FIXME actually handle this */
710     }
711 
712     total_len = 0;
713     for (i = 0; i < 6; i++) {
714         trace_spapr_vlan_h_send_logical_lan_buf_desc(bufs[i]);
715         if (!(bufs[i] & VLAN_BD_VALID)) {
716             break;
717         }
718         total_len += VLAN_BD_LEN(bufs[i]);
719     }
720 
721     nbufs = i;
722     trace_spapr_vlan_h_send_logical_lan_total(nbufs, total_len);
723 
724     if (total_len == 0) {
725         return H_SUCCESS;
726     }
727 
728     if (total_len > MAX_PACKET_SIZE) {
729         /* Don't let the guest force too large an allocation */
730         return H_RESOURCE;
731     }
732 
733     lbuf = g_malloc(total_len);
734     p = lbuf;
735     for (i = 0; i < nbufs; i++) {
736         ret = spapr_vio_dma_read(sdev, VLAN_BD_ADDR(bufs[i]),
737                                  p, VLAN_BD_LEN(bufs[i]));
738         if (ret < 0) {
739             return ret;
740         }
741 
742         p += VLAN_BD_LEN(bufs[i]);
743     }
744 
745     qemu_send_packet(qemu_get_queue(dev->nic), lbuf, total_len);
746 
747     return H_SUCCESS;
748 }
749 
750 static target_ulong h_multicast_ctrl(PowerPCCPU *cpu, SpaprMachineState *spapr,
751                                      target_ulong opcode, target_ulong *args)
752 {
753     target_ulong reg = args[0];
754     SpaprVioDevice *dev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
755 
756     if (!dev) {
757         return H_PARAMETER;
758     }
759 
760     return H_SUCCESS;
761 }
762 
763 static target_ulong h_change_logical_lan_mac(PowerPCCPU *cpu,
764                                              SpaprMachineState *spapr,
765                                              target_ulong opcode,
766                                              target_ulong *args)
767 {
768     target_ulong reg = args[0];
769     target_ulong macaddr = args[1];
770     SpaprVioDevice *sdev = spapr_vio_find_by_reg(spapr->vio_bus, reg);
771     SpaprVioVlan *dev = VIO_SPAPR_VLAN_DEVICE(sdev);
772     int i;
773 
774     for (i = 0; i < ETH_ALEN; i++) {
775         dev->nicconf.macaddr.a[ETH_ALEN - i - 1] = macaddr & 0xff;
776         macaddr >>= 8;
777     }
778 
779     qemu_format_nic_info_str(qemu_get_queue(dev->nic), dev->nicconf.macaddr.a);
780 
781     return H_SUCCESS;
782 }
783 
784 static Property spapr_vlan_properties[] = {
785     DEFINE_SPAPR_PROPERTIES(SpaprVioVlan, sdev),
786     DEFINE_NIC_PROPERTIES(SpaprVioVlan, nicconf),
787     DEFINE_PROP_BIT("use-rx-buffer-pools", SpaprVioVlan,
788                     compat_flags, SPAPRVLAN_FLAG_RX_BUF_POOLS_BIT, true),
789     DEFINE_PROP_END_OF_LIST(),
790 };
791 
792 static bool spapr_vlan_rx_buffer_pools_needed(void *opaque)
793 {
794     SpaprVioVlan *dev = opaque;
795 
796     return (dev->compat_flags & SPAPRVLAN_FLAG_RX_BUF_POOLS) != 0;
797 }
798 
799 static const VMStateDescription vmstate_rx_buffer_pool = {
800     .name = "spapr_llan/rx_buffer_pool",
801     .version_id = 1,
802     .minimum_version_id = 1,
803     .needed = spapr_vlan_rx_buffer_pools_needed,
804     .fields = (VMStateField[]) {
805         VMSTATE_INT32(bufsize, RxBufPool),
806         VMSTATE_INT32(count, RxBufPool),
807         VMSTATE_UINT64_ARRAY(bds, RxBufPool, RX_POOL_MAX_BDS),
808         VMSTATE_END_OF_LIST()
809     }
810 };
811 
812 static const VMStateDescription vmstate_rx_pools = {
813     .name = "spapr_llan/rx_pools",
814     .version_id = 1,
815     .minimum_version_id = 1,
816     .needed = spapr_vlan_rx_buffer_pools_needed,
817     .fields = (VMStateField[]) {
818         VMSTATE_ARRAY_OF_POINTER_TO_STRUCT(rx_pool, SpaprVioVlan,
819                                            RX_MAX_POOLS, 1,
820                                            vmstate_rx_buffer_pool, RxBufPool),
821         VMSTATE_END_OF_LIST()
822     }
823 };
824 
825 static const VMStateDescription vmstate_spapr_llan = {
826     .name = "spapr_llan",
827     .version_id = 1,
828     .minimum_version_id = 1,
829     .fields = (VMStateField[]) {
830         VMSTATE_SPAPR_VIO(sdev, SpaprVioVlan),
831         /* LLAN state */
832         VMSTATE_BOOL(isopen, SpaprVioVlan),
833         VMSTATE_UINT64(buf_list, SpaprVioVlan),
834         VMSTATE_UINT32(add_buf_ptr, SpaprVioVlan),
835         VMSTATE_UINT32(use_buf_ptr, SpaprVioVlan),
836         VMSTATE_UINT32(rx_bufs, SpaprVioVlan),
837         VMSTATE_UINT64(rxq_ptr, SpaprVioVlan),
838 
839         VMSTATE_END_OF_LIST()
840     },
841     .subsections = (const VMStateDescription * []) {
842         &vmstate_rx_pools,
843         NULL
844     }
845 };
846 
847 static void spapr_vlan_class_init(ObjectClass *klass, void *data)
848 {
849     DeviceClass *dc = DEVICE_CLASS(klass);
850     SpaprVioDeviceClass *k = VIO_SPAPR_DEVICE_CLASS(klass);
851 
852     k->realize = spapr_vlan_realize;
853     k->reset = spapr_vlan_reset;
854     k->devnode = spapr_vlan_devnode;
855     k->dt_name = "l-lan";
856     k->dt_type = "network";
857     k->dt_compatible = "IBM,l-lan";
858     k->signal_mask = 0x1;
859     set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
860     device_class_set_props(dc, spapr_vlan_properties);
861     k->rtce_window_size = 0x10000000;
862     dc->vmsd = &vmstate_spapr_llan;
863 }
864 
865 static const TypeInfo spapr_vlan_info = {
866     .name          = TYPE_VIO_SPAPR_VLAN_DEVICE,
867     .parent        = TYPE_VIO_SPAPR_DEVICE,
868     .instance_size = sizeof(SpaprVioVlan),
869     .class_init    = spapr_vlan_class_init,
870     .instance_init = spapr_vlan_instance_init,
871     .instance_finalize = spapr_vlan_instance_finalize,
872 };
873 
874 static void spapr_vlan_register_types(void)
875 {
876     spapr_register_hypercall(H_REGISTER_LOGICAL_LAN, h_register_logical_lan);
877     spapr_register_hypercall(H_FREE_LOGICAL_LAN, h_free_logical_lan);
878     spapr_register_hypercall(H_SEND_LOGICAL_LAN, h_send_logical_lan);
879     spapr_register_hypercall(H_ADD_LOGICAL_LAN_BUFFER,
880                              h_add_logical_lan_buffer);
881     spapr_register_hypercall(H_MULTICAST_CTRL, h_multicast_ctrl);
882     spapr_register_hypercall(H_CHANGE_LOGICAL_LAN_MAC,
883                              h_change_logical_lan_mac);
884     type_register_static(&spapr_vlan_info);
885 }
886 
887 type_init(spapr_vlan_register_types)
888