From patchwork Wed Jun 10 17:08:47 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: John McNamara X-Patchwork-Id: 5372 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 225EDB38D; Wed, 10 Jun 2015 19:09:01 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id EC2C5C300 for ; Wed, 10 Jun 2015 19:08:59 +0200 (CEST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga102.fm.intel.com with ESMTP; 10 Jun 2015 10:08:51 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.13,588,1427785200"; d="scan'208";a="506213649" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by FMSMGA003.fm.intel.com with ESMTP; 10 Jun 2015 10:08:50 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id t5AH8olp026793; Wed, 10 Jun 2015 18:08:50 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id t5AH8nH7009865; Wed, 10 Jun 2015 18:08:49 +0100 Received: (from jmcnam2x@localhost) by sivswdev02.ir.intel.com with id t5AH8n6k009861; Wed, 10 Jun 2015 18:08:49 +0100 From: John McNamara To: dev@dpdk.org Date: Wed, 10 Jun 2015 18:08:47 +0100 Message-Id: <1433956127-9813-3-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.4.1 In-Reply-To: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> References: <1433956127-9813-1-git-send-email-john.mcnamara@intel.com> MIME-Version: 1.0 Subject: [dpdk-dev] =?utf-8?q?=5BPATCH_2/2=5D_drivers=3A_add_warning_note_?= =?utf-8?q?to_base_dirs_readme?= X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch adds a note to the README files in the drivers/net/pmd/base dirs to highlight that the code should not be modifed by the user apart from the pmd_osdep.[ch] files. Signed-off-by: John McNamara --- drivers/net/e1000/base/README | 13 +++++++++---- drivers/net/ixgbe/base/README | 16 +++++----------- drivers/net/vmxnet3/base/README | 13 +++++-------- 3 files changed, 19 insertions(+), 23 deletions(-) diff --git a/drivers/net/e1000/base/README b/drivers/net/e1000/base/README index 851e54e..59275b6 100644 --- a/drivers/net/e1000/base/README +++ b/drivers/net/e1000/base/README @@ -33,7 +33,12 @@ This directory contains source code of FreeBSD em & igb drivers of version cid-shared-code.2014.04.21 released by LAD. The sub-directory of lad/ contains the original source package. -Few changes to the original FreeBSD sources were made to: -- Adopt it for PMD usage mode: - e1000_osdep.c - e1000_osdep.h + +Updating the driver +=================== + +NOTE: The source code in this directory should not be modified apart from +the following file(s): + + e1000_osdep.c + e1000_osdep.h diff --git a/drivers/net/ixgbe/base/README b/drivers/net/ixgbe/base/README index ba1249b..b629dc8 100644 --- a/drivers/net/ixgbe/base/README +++ b/drivers/net/ixgbe/base/README @@ -52,16 +52,10 @@ This driver is valid for the product(s) listed below * Intel® Ethernet Server Adapter X520-T2 * Intel® Ethernet Controller X550-BT2 -Updating driver -=============== - -The following modifications have been made to this code to integrate it with the -Intel® DPDK: - +Updating the driver +=================== -ixgbe_osdep.h -------------- +NOTE: The source code in this directory should not be modified apart from +the following file(s): -The OS dependency layer has been extensively modified to support the drivers in -the Intel® DPDK environment. It is expected that these files will not need to be -changed on updating the driver. + ixgbe_osdep.h diff --git a/drivers/net/vmxnet3/base/README b/drivers/net/vmxnet3/base/README index f13fec7..599a366 100644 --- a/drivers/net/vmxnet3/base/README +++ b/drivers/net/vmxnet3/base/README @@ -38,13 +38,10 @@ In which, upt1_defs.h and vmxnet3_defs.h is introduced without any change. The other 4 files: includeCheck.h, vmware_pack_begin.h, vmware_pack_end.h and vmxnet3_osdep.h are crated to adapt to the needs from above 2 files. -Updating driver -=============== - -The following modifications have been made to this code to integrate it with the -Intel DPDK: - - -------------- +Updating the driver +=================== +NOTE: The source code in this directory should not be modified apart from +the following file(s): + vmxnet3_osdep.h