Skip to content

Add OpenCPI Ethernet Transport Performance Tuning Guide

Lisa Zahn requested to merge 3464-add-tuning-guide into develop

What this MR does / why we need it:

This MR adds the OpenCPI Ethernet Transport Performance Tuning Guide to the OpenCPI documentation set. The target category on opencpi.gitlab.io is "Additional Guides". This guide was contributed by ML/DSTL to address the need for performance tuning guidelines when developing L2 Ethernet-based OpenCPI SDR applications.

Steps to complete before submitting MR:

  • I have read Contribution guidelines

  • I have ensured I have a changelog written in the imperative form that is meaningful and accurately summarizes the work done

  • I have added the release notes label if applicable (more information below)

  • I have ensured the workflow labels are up to date and will continue to do so up until this work is merged into develop

  • I have added a category, type, and target release label along with all other labels as need be

  • My branch is up to date with develop. If it is not, then I have ensured my work does not conflict with other work

  • I agree my bugfix MR does not include new features/enhancements

  • I represent that bugfixes have been locally tested against the most recent major.minor release in which the bug exists

  • (REVIEWER ONLY) I have thoroughly gone through the above steps to ensure that they have been followed

Release Notes

This release provides the first version of the OpenCPI reference document "OpenCPI Ethernet Transport Performance Tuning Guide". This document provides performance tuning guidelines and mitigation strategies for developers of OpenCPI SDR applications running over L2 Ethernet-based protocols such as DGRDMA.

Changelog

  • enh(doc): add ethernet transport performance tuning guide

Which issue(s) this MR closes

Closes #3464 (closed)

Edited by Robert Tracy

Merge request reports