diff mbox series

[iwl-next,v1,1/3] igc: Add documentation

Message ID 20240730012247.775856-1-yoong.siang.song@intel.com (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series Add Default Rx Queue Setting for igc driver | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Guessed tree name to be net-next, async
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 42 this patch: 42
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 11 of 11 maintainers
netdev/build_clang success Errors and warnings before: 44 this patch: 44
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 49 this patch: 49
netdev/checkpatch warning WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Song Yoong Siang July 30, 2024, 1:22 a.m. UTC 
From: Blanco Alcaine Hector <hector.blanco.alcaine@intel.com>

This commit adds the documentation file for the Intel Ethernet Network
Controller I225 and I226 driver. The documentation includes:
 - Identifying Your Adapter
 - Command Line Parameters
 - Additional Configurations
 - Support
 - Trademarks

The file provides detailed information on how to identify the adapter, use
command line parameters, configure additional features, and obtain support.

Signed-off-by: Blanco Alcaine Hector <hector.blanco.alcaine@intel.com>
Signed-off-by: Song Yoong Siang <yoong.siang.song@intel.com>
---
 .../device_drivers/ethernet/index.rst         |  1 +
 .../device_drivers/ethernet/intel/igc.rst     | 82 +++++++++++++++++++
 2 files changed, 83 insertions(+)
 create mode 100644 Documentation/networking/device_drivers/ethernet/intel/igc.rst
diff mbox series

Patch

diff --git a/Documentation/networking/device_drivers/ethernet/index.rst b/Documentation/networking/device_drivers/ethernet/index.rst
index 6932d8c043c2..2b1dbb984f98 100644
--- a/Documentation/networking/device_drivers/ethernet/index.rst
+++ b/Documentation/networking/device_drivers/ethernet/index.rst
@@ -35,6 +35,7 @@  Contents:
    intel/idpf
    intel/igb
    intel/igbvf
+   intel/igc
    intel/ixgbe
    intel/ixgbevf
    intel/i40e
diff --git a/Documentation/networking/device_drivers/ethernet/intel/igc.rst b/Documentation/networking/device_drivers/ethernet/intel/igc.rst
new file mode 100644
index 000000000000..08b2cfacc7c0
--- /dev/null
+++ b/Documentation/networking/device_drivers/ethernet/intel/igc.rst
@@ -0,0 +1,82 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+========================================================================
+Linux Base Driver for Intel(R) Ethernet Network Controller I225 and I226
+========================================================================
+
+Intel igc Linux driver.
+Copyright(c) 1999-2024 Intel Corporation.
+
+
+Contents
+========
+- Identifying Your Adapter
+- Command Line Parameters
+- Additional Configurations
+- Support
+- Trademarks
+
+
+Identifying Your Adapter
+========================
+For information on how to identify your adapter, and for the latest Intel
+network drivers, refer to the Intel Support website:
+https://www.intel.com/support
+
+
+Command Line Parameters
+========================
+If the driver is built as a module, the following optional parameters are used
+by entering them on the command line with the modprobe command using this
+syntax::
+
+    modprobe igc [<option>=<VAL1>]
+
+NOTE: A descriptor describes a data buffer and attributes related to the data
+buffer. This information is accessed by the hardware.
+
+Debug
+-----
+:Valid Range: 0-16 (0=none,...,16=all)
+:Default Value: 0
+
+This parameter adjusts the level debug messages displayed in the system logs.
+
+
+Additional Features and Configurations
+======================================
+Time-Sensitive Networking
+-------------------------
+Selected models of Intel(R) Ethernet Controller I225 and Intel(R) Ethernet
+Controller I226 support Time-Sensitive Networking features. For more details
+about the features and supported models, please refer to:
+https://www.intel.com/content/www/us/en/support/articles/000096004/ethernet-products/gigabit-ethernet-controllers-up-to-2-5gbe.html
+
+For instructions about configuring Time-Sensitive Networking features on Linux,
+please refer to:
+https://tsn.readthedocs.io/
+
+ethtool
+-------
+The driver utilizes the ethtool interface for driver configuration and
+diagnostics, as well as displaying statistical information. The latest ethtool
+version is required for this functionality. Download it at:
+https://www.kernel.org/pub/software/network/ethtool/
+
+
+Support
+=======
+For general information, go to the Intel support website at:
+https://www.intel.com/support/
+
+If an issue is identified with the released source code on a supported kernel
+with a supported adapter, email the specific information related to the issue
+to intel-wired-lan@lists.osuosl.org
+
+
+Trademarks
+==========
+Intel is a trademark or registered trademark of Intel Corporation or its
+subsidiaries in the United States and/or other countries.
+
+* Other names and brands may be claimed as the property of others.