X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Feventdevs%2Focteontx2.rst;h=fad84cf42d54169bbd1da137c94cbc564ea13ee7;hb=0f2f911deb0cc3c1204b127ac21683390f068ed8;hp=1e79bd916a5247d058b73531b04763710d8854a2;hpb=d457de0fe0f0550e9bebcd7efc984f0a936d5877;p=dpdk.git diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst index 1e79bd916a..fad84cf42d 100644 --- a/doc/guides/eventdevs/octeontx2.rst +++ b/doc/guides/eventdevs/octeontx2.rst @@ -32,6 +32,12 @@ Features of the OCTEON TX2 SSO PMD are: time granularity of 2.5us. - Up to 256 TIM rings aka event timer adapters. - Up to 8 rings traversed in parallel. +- HW managed packets enqueued from ethdev to eventdev exposed through event eth + RX adapter. +- N:1 ethernet device Rx queue to Event queue mapping. +- Lockfree Tx from event eth Tx adapter using ``DEV_TX_OFFLOAD_MT_LOCKFREE`` + capability while maintaining receive packet order. +- Full Rx/Tx offload support defined through ethdev queue config. Prerequisites and Compilation procedure --------------------------------------- @@ -114,6 +120,34 @@ Runtime Config Options --dev "0002:0e:00.0,tim_chnk_slots=1023" +- ``TIM enable arm/cancel statistics`` + + The ``tim_stats_ena`` devargs can be used to enable arm and cancel stats of + event timer adapter. + For example:: + + --dev "0002:0e:00.0,tim_stats_ena=1" + +- ``TIM limit max rings reserved`` + + The ``tim_rings_lmt`` devargs can be used to limit the max number of TIM + rings i.e. event timer adapter reserved on probe. Since, TIM rings are HW + resources we can avoid starving other applications by not grabbing all the + rings. + For example:: + + --dev "0002:0e:00.0,tim_rings_lmt=5" + +- ``TIM ring control internal parameters`` + + When using multiple TIM rings the ``tim_ring_ctl`` devargs can be used to + control each TIM rings internal parameters uniquely. The following dict + format is expected [ring-chnk_slots-disable_npa-stats_ena]. 0 represents + default values. + For Example:: + + --dev "0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]" + Debugging Options ~~~~~~~~~~~~~~~~~