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
30 #include "hw/ppc/spapr.h"
31 #include "hw/ppc/spapr_vio.h"
32 #include "sysemu/sysemu.h"
37 #define MAX_PACKET_SIZE 65536
42 #define DPRINTF(fmt...) do { fprintf(stderr, fmt); } while (0)
44 #define DPRINTF(fmt...)
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
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
{
93 target_ulong buf_list
;
94 uint32_t add_buf_ptr
, use_buf_ptr
, rx_bufs
;
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
,
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
);
112 int buf_ptr
= dev
->use_buf_ptr
;
116 DPRINTF("spapr_vlan_receive() [%s] rx_bufs=%d\n", sdev
->qdev
.id
,
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 */
144 /* Remove the buffer from the pool */
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) {
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
) +
174 (unsigned long long)vio_ldq(sdev
, VLAN_BD_ADDR(rxq_bd
) +
178 if (dev
->rxq_ptr
>= VLAN_BD_LEN(rxq_bd
)) {
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
));
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
);
206 static int spapr_vlan_init(VIOsPAPRDevice
*sdev
)
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
);
219 static void spapr_vlan_instance_init(Object
*obj
)
221 VIOsPAPRVLANDevice
*dev
= VIO_SPAPR_VLAN_DEVICE(obj
);
223 device_add_bootindex_property(obj
, &dev
->nicconf
.bootindex
,
228 void spapr_vlan_create(VIOsPAPRBus
*bus
, NICInfo
*nd
)
232 dev
= qdev_create(&bus
->bus
, "spapr-vlan");
234 qdev_set_nic_properties(dev
, nd
);
236 qdev_init_nofail(dev
);
239 static int spapr_vlan_devnode(VIOsPAPRDevice
*dev
, void *fdt
, int node_off
)
241 VIOsPAPRVLANDevice
*vdev
= VIO_SPAPR_VLAN_DEVICE(dev
);
242 uint8_t padded_mac
[8] = {0, 0};
245 /* Some old phyp versions give the mac address in an 8-byte
246 * property. The kernel driver has an insane workaround for this;
247 * rather than doing the obvious thing and checking the property
248 * length, it checks whether the first byte has 0b10 in the low
249 * bits. If a correct 6-byte property has a different first byte
250 * the kernel will get the wrong mac address, overrunning its
251 * buffer in the process (read only, thank goodness).
253 * Here we workaround the kernel workaround by always supplying an
254 * 8-byte property, with the mac address in the last six bytes */
255 memcpy(&padded_mac
[2], &vdev
->nicconf
.macaddr
, ETH_ALEN
);
256 ret
= fdt_setprop(fdt
, node_off
, "local-mac-address",
257 padded_mac
, sizeof(padded_mac
));
262 ret
= fdt_setprop_cell(fdt
, node_off
, "ibm,mac-address-filters", 0);
270 static int check_bd(VIOsPAPRVLANDevice
*dev
, vlan_bd_t bd
,
271 target_ulong alignment
)
273 if ((VLAN_BD_ADDR(bd
) % alignment
)
274 || (VLAN_BD_LEN(bd
) % alignment
)) {
278 if (!spapr_vio_dma_valid(&dev
->sdev
, VLAN_BD_ADDR(bd
),
279 VLAN_BD_LEN(bd
), DMA_DIRECTION_FROM_DEVICE
)
280 || !spapr_vio_dma_valid(&dev
->sdev
, VLAN_BD_ADDR(bd
),
281 VLAN_BD_LEN(bd
), DMA_DIRECTION_TO_DEVICE
)) {
288 static target_ulong
h_register_logical_lan(PowerPCCPU
*cpu
,
289 sPAPREnvironment
*spapr
,
293 target_ulong reg
= args
[0];
294 target_ulong buf_list
= args
[1];
295 target_ulong rec_queue
= args
[2];
296 target_ulong filter_list
= args
[3];
297 VIOsPAPRDevice
*sdev
= spapr_vio_find_by_reg(spapr
->vio_bus
, reg
);
298 VIOsPAPRVLANDevice
*dev
= VIO_SPAPR_VLAN_DEVICE(sdev
);
299 vlan_bd_t filter_list_bd
;
306 hcall_dprintf("H_REGISTER_LOGICAL_LAN called twice without "
307 "H_FREE_LOGICAL_LAN\n");
311 if (check_bd(dev
, VLAN_VALID_BD(buf_list
, SPAPR_TCE_PAGE_SIZE
),
312 SPAPR_TCE_PAGE_SIZE
) < 0) {
313 hcall_dprintf("Bad buf_list 0x" TARGET_FMT_lx
"\n", buf_list
);
317 filter_list_bd
= VLAN_VALID_BD(filter_list
, SPAPR_TCE_PAGE_SIZE
);
318 if (check_bd(dev
, filter_list_bd
, SPAPR_TCE_PAGE_SIZE
) < 0) {
319 hcall_dprintf("Bad filter_list 0x" TARGET_FMT_lx
"\n", filter_list
);
323 if (!(rec_queue
& VLAN_BD_VALID
)
324 || (check_bd(dev
, rec_queue
, VLAN_RQ_ALIGNMENT
) < 0)) {
325 hcall_dprintf("Bad receive queue\n");
329 dev
->buf_list
= buf_list
;
330 sdev
->signal_state
= 0;
332 rec_queue
&= ~VLAN_BD_TOGGLE
;
334 /* Initialize the buffer list */
335 vio_stq(sdev
, buf_list
, rec_queue
);
336 vio_stq(sdev
, buf_list
+ 8, filter_list_bd
);
337 spapr_vio_dma_set(sdev
, buf_list
+ VLAN_RX_BDS_OFF
, 0,
338 SPAPR_TCE_PAGE_SIZE
- VLAN_RX_BDS_OFF
);
339 dev
->add_buf_ptr
= VLAN_RX_BDS_OFF
- 8;
340 dev
->use_buf_ptr
= VLAN_RX_BDS_OFF
- 8;
344 /* Initialize the receive queue */
345 spapr_vio_dma_set(sdev
, VLAN_BD_ADDR(rec_queue
), 0, VLAN_BD_LEN(rec_queue
));
348 qemu_flush_queued_packets(qemu_get_queue(dev
->nic
));
354 static target_ulong
h_free_logical_lan(PowerPCCPU
*cpu
, sPAPREnvironment
*spapr
,
355 target_ulong opcode
, target_ulong
*args
)
357 target_ulong reg
= args
[0];
358 VIOsPAPRDevice
*sdev
= spapr_vio_find_by_reg(spapr
->vio_bus
, reg
);
359 VIOsPAPRVLANDevice
*dev
= VIO_SPAPR_VLAN_DEVICE(sdev
);
366 hcall_dprintf("H_FREE_LOGICAL_LAN called without "
367 "H_REGISTER_LOGICAL_LAN\n");
371 spapr_vlan_reset(sdev
);
375 static target_ulong
h_add_logical_lan_buffer(PowerPCCPU
*cpu
,
376 sPAPREnvironment
*spapr
,
380 target_ulong reg
= args
[0];
381 target_ulong buf
= args
[1];
382 VIOsPAPRDevice
*sdev
= spapr_vio_find_by_reg(spapr
->vio_bus
, reg
);
383 VIOsPAPRVLANDevice
*dev
= VIO_SPAPR_VLAN_DEVICE(sdev
);
386 DPRINTF("H_ADD_LOGICAL_LAN_BUFFER(0x" TARGET_FMT_lx
387 ", 0x" TARGET_FMT_lx
")\n", reg
, buf
);
390 hcall_dprintf("Bad device\n");
394 if ((check_bd(dev
, buf
, 4) < 0)
395 || (VLAN_BD_LEN(buf
) < 16)) {
396 hcall_dprintf("Bad buffer enqueued\n");
400 if (!dev
->isopen
|| dev
->rx_bufs
>= VLAN_MAX_BUFS
) {
405 dev
->add_buf_ptr
+= 8;
406 if (dev
->add_buf_ptr
>= (VLAN_RX_BDS_LEN
+ VLAN_RX_BDS_OFF
)) {
407 dev
->add_buf_ptr
= VLAN_RX_BDS_OFF
;
410 bd
= vio_ldq(sdev
, dev
->buf_list
+ dev
->add_buf_ptr
);
411 } while (bd
& VLAN_BD_VALID
);
413 vio_stq(sdev
, dev
->buf_list
+ dev
->add_buf_ptr
, buf
);
417 qemu_flush_queued_packets(qemu_get_queue(dev
->nic
));
419 DPRINTF("h_add_logical_lan_buffer(): Added buf ptr=%d rx_bufs=%d"
420 " bd=0x%016llx\n", dev
->add_buf_ptr
, dev
->rx_bufs
,
421 (unsigned long long)buf
);
426 static target_ulong
h_send_logical_lan(PowerPCCPU
*cpu
, sPAPREnvironment
*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
);
439 DPRINTF("H_SEND_LOGICAL_LAN(0x" TARGET_FMT_lx
", <bufs>, 0x"
440 TARGET_FMT_lx
")\n", reg
, continue_token
);
446 DPRINTF("rxbufs = %d\n", dev
->rx_bufs
);
452 if (continue_token
) {
453 return H_HARDWARE
; /* FIXME actually handle this */
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
)) {
462 total_len
+= VLAN_BD_LEN(bufs
[i
]);
466 DPRINTF("h_send_logical_lan() %d buffers, total length 0x%x\n",
469 if (total_len
== 0) {
473 if (total_len
> MAX_PACKET_SIZE
) {
474 /* Don't let the guest force too large an allocation */
478 lbuf
= alloca(total_len
);
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
]));
487 p
+= VLAN_BD_LEN(bufs
[i
]);
490 qemu_send_packet(qemu_get_queue(dev
->nic
), lbuf
, total_len
);
495 static target_ulong
h_multicast_ctrl(PowerPCCPU
*cpu
, sPAPREnvironment
*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
);
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",
517 .minimum_version_id
= 1,
518 .fields
= (VMStateField
[]) {
519 VMSTATE_SPAPR_VIO(sdev
, VIOsPAPRVLANDevice
),
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
->init
= spapr_vlan_init
;
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
)