summaryrefslogtreecommitdiffstats
path: root/src/vlib/dma/dma.rst
blob: 4048d49b218cbea93ed415e88b44f7b1fb780567 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
.. _dma_plugin:

.. toctree::

DMA plugin
==========

Overview
--------
This plugin utilize platform DMA accelerators like CBDMA/DSA for streaming
data movement. Modern DMA accelerators has high memory bandwidth and benefit
cross-numa traffic. Accelerator like DSA has the capability to do IO page
fault recovery, it will save IOMMU setup for the memory which not pinned.

Terminology & Usage
-------------------

A ``backend`` is the abstract of resource which inherited from DMA device,
it support necessary operations for DMA offloading like configuration, DMA
request and result query.

A ``config`` is the abstract of application DMA capability. Application can
request a config instance through DMA node. DMA node will check the
requirements of application and bind suitable backend with it.

Enable DSA work queue:
----------------------

.. code-block:: console
  # configure 1 groups, each with one engine
  accel-config config-engine dsa0/engine0.0 --group-id=0

  # configure 1 queues, putting each in a different group, so each
  # is backed by a single engine
  accel-config config-wq dsa0/wq0.0 --group-id=0 --type=user  \
    --priority=10 --max-batch-size=1024 --mode=dedicated -b 1 -a 0 --name=vpp1

DMA transfer:
-------------

In this sample, application will request DMA capability which can hold
a batch contained maximum 256 transfers and each transfer hold maximum 4K bytes
from DMA node. If config_index value is not negative, mean resource has
been allocated and DMA engine is ready for serve.

.. code-block:: console
  void dma_completion_cb (vlib_main_t *vm, vlib_dma_batch_t *b);

  vlib_dma_config_args_t args;
  args->max_transfers = 256;
  args->max_transfer_size = 4096;
  args->cpu_fallback = 1;
  args->barrier_before_last = 1;
  args->cb = dma_completion_cb;
  u32 config_index = vlib_dma_config (vm, &args);
  if (config_index < 0)
    return;

  u8 *dst[n_transfers];
  u8 *src[n_transfers];
  u32 i = 0, size = 4096;

  vlib_dma_batch_t *b;
  b = vlib_dma_batch_new (vm, config_index);
  while (wrk_t->config_index >= 0 && n_transfers) {
    vlib_dma_batch_add (vm, b, dst[i], src[i], size);
    n_transfers --;
    i ++;
  }
  vlib_dma_batch_submit (vm, config_index);
'n435' href='#n435'>435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603