diff options
Diffstat (limited to 'src/plugins/marvell/README.md')
| -rw-r--r-- | src/plugins/marvell/README.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/src/plugins/marvell/README.md b/src/plugins/marvell/README.md new file mode 100644 index 00000000000..786c4c8241e --- /dev/null +++ b/src/plugins/marvell/README.md @@ -0,0 +1,55 @@ +# Marvel device plugin for VPP + +##Overview +This plugins provides native device support for Marvell PP2 network device, by use of Marvel Usermode SDK ([MUSDK][1]). +Code is developed and tested on [MACCHIATObin][2] board. + +##Prerequisites +Plugins depends on installed MUSDK and Marvell provided linux [kernel][3] with MUSDK provided kernel patches (see `patches/linux` in musdk repo and relevant documentation. +Kernel version used: **4.4.52 armada-17.10.1** +MUSDK version used: **armada-17.10.3** +MUSDK must be compiled with `--enable-bpool-dma=64` parameter. +Following kernel modules from MUSDK must be loaded for plugin to work: +* `musdk_uio.ko` +* `mv_pp_uio.ko` + +## Usage +### Interface Cration +Interfaces are dynamically created with following CLI: +``` +create interface marvell pp2 name eth0 +set interface state mv-ppio0/0 up +``` + +Where `eth0` is linux interface name and `mv-ppioX/Y` is VPP interface name where X is PP2 device ID and Y is PPIO ID +Interface needs to be assigned to MUSDK in FDT configuration and linux interface state must be up. + +### Interface Deletion +Interface can be deleted with following CLI: +``` +delete interface marvell pp2 <interface name> +``` + + +### Interface Statistics +Interface statistics can be displayed with `sh hardware-interface mv-ppio0/0` +command. + +### Interaction with DPDK plugin +This plugin doesn't have any dependency on DPDK or DPDK plugin but it can +work with DPDK plugin enabled or disabled. It is observed that performace is +better around 30% when DPDK plugin is disabled, as DPDK plugin registers +own buffer manager, which needs to deal with additional metadata in each packet. + +DPKD plugin can be disabled by adding following config to the startup.conf. + +``` +plugins { + dpdk_plugin.so { disable } +} +``` + + +[1]: https://github.com/MarvellEmbeddedProcessors/musdk-marvell +[2]: http://macchiatobin.net +[3]: https://github.com/MarvellEmbeddedProcessors/linux-marvell |