source: mainline/uspace/drv/nic/virtio-net/virtio-net.c@ da0cf6ac

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since da0cf6ac was 1e472ee, checked in by Jakub Jermar <jakub@…>, 7 years ago

Move DMA buffers allocation functions to libvirtio
  • Property mode set to 100644
File size: 12.3 KB
Line 
1/*
2 * Copyright (c) 2018 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#include "virtio-net.h"
30
31#include <stdio.h>
32#include <stdint.h>
33
34#include <as.h>
35#include <ddf/driver.h>
36#include <ddf/interrupt.h>
37#include <ddf/log.h>
38#include <ops/nic.h>
39#include <pci_dev_iface.h>
40#include <nic/nic.h>
41
42#include <nic.h>
43
44#include <virtio-pci.h>
45
46#define NAME "virtio-net"
47
48#define VIRTIO_NET_NUM_QUEUES 3
49
50#define RX_QUEUE_1 0
51#define TX_QUEUE_1 1
52#define CT_QUEUE_1 2
53
54#define BUFFER_SIZE 2048
55#define RX_BUF_SIZE BUFFER_SIZE
56#define TX_BUF_SIZE BUFFER_SIZE
57#define CT_BUF_SIZE BUFFER_SIZE
58
59static ddf_dev_ops_t virtio_net_dev_ops;
60
61static errno_t virtio_net_dev_add(ddf_dev_t *dev);
62
63static driver_ops_t virtio_net_driver_ops = {
64 .dev_add = virtio_net_dev_add
65};
66
67static driver_t virtio_net_driver = {
68 .name = NAME,
69 .driver_ops = &virtio_net_driver_ops
70};
71
72static void virtio_net_irq_handler(ipc_call_t *icall, ddf_dev_t *dev)
73{
74 nic_t *nic = ddf_dev_data_get(dev);
75 virtio_net_t *virtio_net = nic_get_specific(nic);
76 virtio_dev_t *vdev = &virtio_net->virtio_dev;
77
78 uint16_t descno;
79 uint32_t len;
80 while (virtio_virtq_consume_used(vdev, RX_QUEUE_1, &descno, &len)) {
81 virtio_net_hdr_t *hdr =
82 (virtio_net_hdr_t *) virtio_net->rx_buf[descno];
83 if (len <= sizeof(*hdr)) {
84 ddf_msg(LVL_WARN,
85 "RX data length too short, packet dropped");
86 virtio_virtq_produce_available(vdev, RX_QUEUE_1,
87 descno);
88 continue;
89 }
90
91 nic_frame_t *frame = nic_alloc_frame(nic, len - sizeof(*hdr));
92 if (frame) {
93 memcpy(frame->data, &hdr[1], len - sizeof(*hdr));
94 nic_received_frame(nic, frame);
95 } else {
96 ddf_msg(LVL_WARN,
97 "Cannot allocate RX frame, packet dropped");
98 }
99
100 virtio_virtq_produce_available(vdev, RX_QUEUE_1, descno);
101 }
102
103 while (virtio_virtq_consume_used(vdev, TX_QUEUE_1, &descno, &len)) {
104 virtio_free_desc(vdev, TX_QUEUE_1, &virtio_net->tx_free_head,
105 descno);
106 }
107 while (virtio_virtq_consume_used(vdev, CT_QUEUE_1, &descno, &len)) {
108 virtio_free_desc(vdev, CT_QUEUE_1, &virtio_net->ct_free_head,
109 descno);
110 }
111}
112
113static errno_t virtio_net_register_interrupt(ddf_dev_t *dev)
114{
115 nic_t *nic = ddf_dev_data_get(dev);
116 virtio_net_t *virtio_net = nic_get_specific(nic);
117 virtio_dev_t *vdev = &virtio_net->virtio_dev;
118
119 hw_res_list_parsed_t res;
120 hw_res_list_parsed_init(&res);
121
122 errno_t rc = nic_get_resources(nic, &res);
123 if (rc != EOK)
124 return rc;
125
126 if (res.irqs.count < 1) {
127 hw_res_list_parsed_clean(&res);
128 rc = EINVAL;
129 return rc;
130 }
131
132 virtio_net->irq = res.irqs.irqs[0];
133 hw_res_list_parsed_clean(&res);
134
135 irq_pio_range_t pio_ranges[] = {
136 {
137 .base = vdev->isr_phys,
138 .size = sizeof(vdev->isr_phys),
139 }
140 };
141
142 irq_cmd_t irq_commands[] = {
143 {
144 .cmd = CMD_PIO_READ_8,
145 .addr = (void *) vdev->isr_phys,
146 .dstarg = 2
147 },
148 {
149 .cmd = CMD_PREDICATE,
150 .value = 1,
151 .srcarg = 2
152 },
153 {
154 .cmd = CMD_ACCEPT
155 }
156 };
157
158 irq_code_t irq_code = {
159 .rangecount = sizeof(pio_ranges) / sizeof(irq_pio_range_t),
160 .ranges = pio_ranges,
161 .cmdcount = sizeof(irq_commands) / sizeof(irq_cmd_t),
162 .cmds = irq_commands
163 };
164
165 return register_interrupt_handler(dev, virtio_net->irq,
166 virtio_net_irq_handler, &irq_code, &virtio_net->irq_handle);
167}
168
169static errno_t virtio_net_initialize(ddf_dev_t *dev)
170{
171 nic_t *nic = nic_create_and_bind(dev);
172 if (!nic)
173 return ENOMEM;
174
175 virtio_net_t *virtio_net = calloc(1, sizeof(virtio_net_t));
176 if (!virtio_net) {
177 nic_unbind_and_destroy(dev);
178 return ENOMEM;
179 }
180
181 nic_set_specific(nic, virtio_net);
182
183 errno_t rc = virtio_pci_dev_initialize(dev, &virtio_net->virtio_dev);
184 if (rc != EOK)
185 return rc;
186
187 virtio_dev_t *vdev = &virtio_net->virtio_dev;
188 virtio_pci_common_cfg_t *cfg = virtio_net->virtio_dev.common_cfg;
189 virtio_net_cfg_t *netcfg = virtio_net->virtio_dev.device_cfg;
190
191 /*
192 * Register IRQ
193 */
194 rc = virtio_net_register_interrupt(dev);
195 if (rc != EOK)
196 goto fail;
197
198 /* Reset the device and negotiate the feature bits */
199 rc = virtio_device_setup_start(vdev,
200 VIRTIO_NET_F_MAC | VIRTIO_NET_F_CTRL_VQ);
201 if (rc != EOK)
202 goto fail;
203
204 /* Perform device-specific setup */
205
206 /*
207 * Discover and configure the virtqueues
208 */
209 uint16_t num_queues = pio_read_le16(&cfg->num_queues);
210 if (num_queues != VIRTIO_NET_NUM_QUEUES) {
211 ddf_msg(LVL_NOTE, "Unsupported number of virtqueues: %u",
212 num_queues);
213 goto fail;
214 }
215
216 vdev->queues = calloc(sizeof(virtq_t), num_queues);
217 if (!vdev->queues) {
218 rc = ENOMEM;
219 goto fail;
220 }
221
222 rc = virtio_virtq_setup(vdev, RX_QUEUE_1, RX_BUFFERS);
223 if (rc != EOK)
224 goto fail;
225 rc = virtio_virtq_setup(vdev, TX_QUEUE_1, TX_BUFFERS);
226 if (rc != EOK)
227 goto fail;
228 rc = virtio_virtq_setup(vdev, CT_QUEUE_1, CT_BUFFERS);
229 if (rc != EOK)
230 goto fail;
231
232 /*
233 * Setup DMA buffers
234 */
235 rc = virtio_setup_dma_bufs(RX_BUFFERS, RX_BUF_SIZE, false,
236 virtio_net->rx_buf, virtio_net->rx_buf_p);
237 if (rc != EOK)
238 goto fail;
239 rc = virtio_setup_dma_bufs(TX_BUFFERS, TX_BUF_SIZE, true,
240 virtio_net->tx_buf, virtio_net->tx_buf_p);
241 if (rc != EOK)
242 goto fail;
243 rc = virtio_setup_dma_bufs(CT_BUFFERS, CT_BUF_SIZE, true,
244 virtio_net->ct_buf, virtio_net->ct_buf_p);
245 if (rc != EOK)
246 goto fail;
247
248 /*
249 * Give all RX buffers to the NIC
250 */
251 for (unsigned i = 0; i < RX_BUFFERS; i++) {
252 /*
253 * Associtate the buffer with the descriptor, set length and
254 * flags.
255 */
256 virtio_virtq_desc_set(vdev, RX_QUEUE_1, i,
257 virtio_net->rx_buf_p[i], RX_BUF_SIZE, VIRTQ_DESC_F_WRITE,
258 0);
259 /*
260 * Put the set descriptor into the available ring of the RX
261 * queue.
262 */
263 virtio_virtq_produce_available(vdev, RX_QUEUE_1, i);
264 }
265
266 /*
267 * Put all TX and CT buffers on a free list
268 */
269 virtio_create_desc_free_list(vdev, TX_QUEUE_1, TX_BUFFERS,
270 &virtio_net->tx_free_head);
271 virtio_create_desc_free_list(vdev, CT_QUEUE_1, CT_BUFFERS,
272 &virtio_net->ct_free_head);
273
274 /*
275 * Read the MAC address
276 */
277 nic_address_t nic_addr;
278 for (unsigned i = 0; i < ETH_ADDR; i++)
279 nic_addr.address[i] = pio_read_8(&netcfg->mac[i]);
280 rc = nic_report_address(nic, &nic_addr);
281 if (rc != EOK)
282 goto fail;
283
284 ddf_msg(LVL_NOTE, "MAC address: " PRIMAC, ARGSMAC(nic_addr.address));
285
286 /*
287 * Enable IRQ
288 */
289 rc = hw_res_enable_interrupt(ddf_dev_parent_sess_get(dev),
290 virtio_net->irq);
291 if (rc != EOK) {
292 ddf_msg(LVL_NOTE, "Failed to enable interrupt");
293 goto fail;
294 }
295
296 ddf_msg(LVL_NOTE, "Registered IRQ %d", virtio_net->irq);
297
298 /* Go live */
299 virtio_device_setup_finalize(vdev);
300
301 return EOK;
302
303fail:
304 virtio_teardown_dma_bufs(virtio_net->rx_buf);
305 virtio_teardown_dma_bufs(virtio_net->tx_buf);
306 virtio_teardown_dma_bufs(virtio_net->ct_buf);
307
308 virtio_device_setup_fail(vdev);
309 virtio_pci_dev_cleanup(vdev);
310 return rc;
311}
312
313static void virtio_net_uninitialize(ddf_dev_t *dev)
314{
315 nic_t *nic = ddf_dev_data_get(dev);
316 virtio_net_t *virtio_net = (virtio_net_t *) nic_get_specific(nic);
317
318 virtio_teardown_dma_bufs(virtio_net->rx_buf);
319 virtio_teardown_dma_bufs(virtio_net->tx_buf);
320 virtio_teardown_dma_bufs(virtio_net->ct_buf);
321
322 virtio_device_setup_fail(&virtio_net->virtio_dev);
323 virtio_pci_dev_cleanup(&virtio_net->virtio_dev);
324}
325
326static void virtio_net_send(nic_t *nic, void *data, size_t size)
327{
328 virtio_net_t *virtio_net = nic_get_specific(nic);
329 virtio_dev_t *vdev = &virtio_net->virtio_dev;
330
331 if (size > sizeof(virtio_net) + TX_BUF_SIZE) {
332 ddf_msg(LVL_WARN, "TX data too big, frame dropped");
333 return;
334 }
335
336 uint16_t descno = virtio_alloc_desc(vdev, TX_QUEUE_1,
337 &virtio_net->tx_free_head);
338 if (descno == (uint16_t) -1U) {
339 ddf_msg(LVL_WARN, "No TX buffers available, frame dropped");
340 return;
341 }
342 assert(descno < TX_BUFFERS);
343
344 /* Setup the packed header */
345 virtio_net_hdr_t *hdr = (virtio_net_hdr_t *) virtio_net->tx_buf[descno];
346 memset(hdr, 0, sizeof(virtio_net_hdr_t));
347 hdr->gso_type = VIRTIO_NET_HDR_GSO_NONE;
348
349 /* Copy packet data into the buffer just past the header */
350 memcpy(&hdr[1], data, size);
351
352 /*
353 * Set the descriptor, put it into the virtqueue and notify the device
354 */
355 virtio_virtq_desc_set(vdev, TX_QUEUE_1, descno,
356 virtio_net->tx_buf_p[descno], sizeof(virtio_net_hdr_t) + size, 0, 0);
357 virtio_virtq_produce_available(vdev, TX_QUEUE_1, descno);
358}
359
360
361static errno_t virtio_net_on_multicast_mode_change(nic_t *nic,
362 nic_multicast_mode_t new_mode, const nic_address_t *address_list,
363 size_t address_count)
364{
365 switch (new_mode) {
366 case NIC_MULTICAST_BLOCKED:
367 nic_report_hw_filtering(nic, -1, 0, -1);
368 return EOK;
369 case NIC_MULTICAST_LIST:
370 nic_report_hw_filtering(nic, -1, 0, -1);
371 return EOK;
372 case NIC_MULTICAST_PROMISC:
373 nic_report_hw_filtering(nic, -1, 0, -1);
374 return EOK;
375 default:
376 return ENOTSUP;
377 }
378 return EOK;
379}
380
381static errno_t virtio_net_on_broadcast_mode_change(nic_t *nic,
382 nic_broadcast_mode_t new_mode)
383{
384 switch (new_mode) {
385 case NIC_BROADCAST_BLOCKED:
386 return ENOTSUP;
387 case NIC_BROADCAST_ACCEPTED:
388 return EOK;
389 default:
390 return ENOTSUP;
391 }
392}
393
394static errno_t virtio_net_dev_add(ddf_dev_t *dev)
395{
396 ddf_msg(LVL_NOTE, "%s %s (handle = %zu)", __func__,
397 ddf_dev_get_name(dev), ddf_dev_get_handle(dev));
398
399 errno_t rc = virtio_net_initialize(dev);
400 if (rc != EOK)
401 return rc;
402
403 ddf_fun_t *fun = ddf_fun_create(dev, fun_exposed, "port0");
404 if (fun == NULL) {
405 rc = ENOMEM;
406 goto error;
407 }
408 nic_t *nic = ddf_dev_data_get(dev);
409 nic_set_ddf_fun(nic, fun);
410 ddf_fun_set_ops(fun, &virtio_net_dev_ops);
411
412 nic_set_send_frame_handler(nic, virtio_net_send);
413 nic_set_filtering_change_handlers(nic, NULL,
414 virtio_net_on_multicast_mode_change,
415 virtio_net_on_broadcast_mode_change, NULL, NULL);
416
417 rc = ddf_fun_bind(fun);
418 if (rc != EOK) {
419 ddf_msg(LVL_ERROR, "Failed binding device function");
420 goto uninitialize;
421 }
422
423 rc = ddf_fun_add_to_category(fun, DEVICE_CATEGORY_NIC);
424 if (rc != EOK) {
425 ddf_msg(LVL_ERROR, "Failed adding function to category");
426 goto unbind;
427 }
428
429 ddf_msg(LVL_NOTE, "The %s device has been successfully initialized.",
430 ddf_dev_get_name(dev));
431
432 return EOK;
433
434unbind:
435 ddf_fun_unbind(fun);
436uninitialize:
437 virtio_net_uninitialize(dev);
438error:
439 return rc;
440}
441
442static errno_t virtio_net_get_device_info(ddf_fun_t *fun,
443 nic_device_info_t *info)
444{
445 nic_t *nic = nic_get_from_ddf_fun(fun);
446 if (!nic)
447 return ENOENT;
448
449 str_cpy(info->vendor_name, sizeof(info->vendor_name), "Red Hat, Inc.");
450 str_cpy(info->model_name, sizeof(info->model_name),
451 "Virtio network device");
452
453 return EOK;
454}
455
456static errno_t virtio_net_get_cable_state(ddf_fun_t *fun,
457 nic_cable_state_t *state)
458{
459 *state = NIC_CS_PLUGGED;
460 return EOK;
461}
462
463static errno_t virtio_net_get_operation_mode(ddf_fun_t *fun, int *speed,
464 nic_channel_mode_t *duplex, nic_role_t *role)
465{
466 *speed = 1000;
467 *duplex = NIC_CM_FULL_DUPLEX;
468 *role = NIC_ROLE_UNKNOWN;
469 return EOK;
470}
471
472static nic_iface_t virtio_net_nic_iface = {
473 .get_device_info = virtio_net_get_device_info,
474 .get_cable_state = virtio_net_get_cable_state,
475 .get_operation_mode = virtio_net_get_operation_mode,
476};
477
478int main(void)
479{
480 printf("%s: HelenOS virtio-net driver\n", NAME);
481
482 if (nic_driver_init(NAME) != EOK)
483 return 1;
484
485 nic_driver_implement(&virtio_net_driver_ops, &virtio_net_dev_ops,
486 &virtio_net_nic_iface);
487
488 (void) ddf_log_init(NAME);
489 return ddf_driver_main(&virtio_net_driver);
490}
Note: See TracBrowser for help on using the repository browser.