Intel IXP400 Software Version 3.0

Transcription

1 Software Release Notes August 10, 2007

2 INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER, AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT. Intel products are not intended for use in medical, life saving, life sustaining, critical control or safety systems, or in nuclear facility applications. Intel may make changes to specifications and product descriptions at any time, without notice. Intel Corporation may have patents or pending patent applications, trademarks, copyrights, or other intellectual property rights that relate to the presented subject matter. The furnishing of documents and other materials and information does not provide any license, express or implied, by estoppel or otherwise, to any such patents, trademarks, copyrights, or other intellectual property rights. Designers must not rely on the absence or characteristics of any features or instructions marked reserved or undefined. Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them. Intel processor numbers are not a measure of performance. Processor numbers differentiate features within each processor family, not across different processor families. See for details. This document contains information on products in the design phase of development. The information here is subject to change without notice. Do not finalize a design with this information. The Intel IXP400 Software may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request. This Software Release Notes as well as the software described in it is furnished under license and may only be used or copied in accordance with the terms of the license. The information in this manual is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Intel Corporation. Intel Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this document or any software that may be provided in association with this document. Except as permitted by such license, no part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without the express written consent of Intel Corporation. Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order. Copies of documents which have an order number and are referenced in this document, or other Intel literature may be obtained by calling or by visiting Intel's website at BunnyPeople, Celeron, Celeron Inside, Centrino, Centrino logo, Core Inside, FlashFile, i960, InstantIP, Intel, Intel logo, Intel386, Intel486, Intel740, IntelDX2, IntelDX4, IntelSX2, Intel Core, Intel Inside, Intel Inside logo, Intel. Leap ahead., Intel. Leap ahead. logo, Intel NetBurst, Intel NetMerge, Intel NetStructure, Intel SingleDriver, Intel SpeedStep, Intel StrataFlash, Intel Viiv, Intel vpro, Intel XScale, Itanium, Itanium Inside, MCS, MMX, Oplus, OverDrive, PDCharm, Pentium, Pentium Inside, skoool, Sound Mark, The Journey Inside, VTune, Xeon, and Xeon Inside are trademarks of Intel Corporation in the U.S. and other countries. *Other names and brands may be claimed as the property of others. Copyright 2007, Intel Corporation. All Rights Reserved. Release Notes August

3 Contents 1.0 Important Information about this Software Release What s New Additional Resources Obtaining the Intel IXP400 Software v3.0 and Related Software Components Installing and Building the Software Prerequisites Installation Building a Bootable Kernel Image Building the Kernel Modules Enabling and Building the Ethernet Kernel Module (NPE-based Ethernet Driver) and Other Modules Building the Intel IXP400 Software Access Library Loading and Using the Intel IXP400 Software Using RedBoot* to Load Linux* Kernel Images Installing and Running the NPE-Ethernet Driver Installing and Running the Intel IXP400 Software Codelet Modules Additional RedBoot* Information Additional Ethernet Device Driver Information Kernel Configuration Options Command-Line Options Intel IXP400 Software Makefile Makefile Commands Makefile Macros Available Codelets Access Library Source Code Documentation Issues with Third-Party Components Tables 1 Related Documents and Additional Resources Intel IXP400 Software and Related Software Packages Linux* Ethernet Device Driver Command-Line Options Makefile Commands Makefile Macros August 2007 Release Notes 3

4 1.0 Important Information about this Software Release This document provides important information to install and use the Intel IXP400 Software v3.0 release, which is intended to be used with the Intel IXP400 Software Programmer s Guide (Document Number: ). This release notes provides the steps for obtaining the necessary software, preparing the host and development systems, building a target-based image that includes the Intel IXP400 Software, and utilizing one of the supplied codelets to demonstrate functionality of the software. Following products/features are NOT SUPPORTED in the Intel IXP400 Software v3.0 release: The Intel IXP42X product line and the Intel IXC1100 Control Plane Processor Little Endian SMII (B, B1, B2, B3) on NPE-B for the Intel IXDP465 Development Platform real time preemption mode NAPI MAC learning/filtering, STP/firewall, VLAN offload in NPE and Wifi header conversion. NPE soft-reset Performance profiling component (perfprof) is not included in the Intel IXP400 Software v3.0 release package. However, this component can be obtained from separate release package. 2.0 What s New The following changes have been made to Intel IXP400 Software v3.0. Refer to Intel IXP400 Software Programmer s Guide for more specific information. NPE - NPE fast path without going through Intel XScale processor Rx QoS based on DSCP, VLAN QoS and Ethernet type Software upgrade (does not include kernel upgrade) Event driven Ethernet packet processing model Performance Monitoring Unit (PMU) on Intel IXP43X product line of network processors 3.0 Additional Resources The following table lists additional documents relevant to this release. These documents are available from your field representative or at: Release Notes August

5 Table 1. Related Documents and Additional Resources Title Document Number Intel IXP400 Software Programmer s Guide Intel IXP400 Software Specification Update Intel IXP400 Software: RedHat* Boot loader Software - Release Notes N/A Intel IXP4XX Product Line of Network Processors Specification Update Intel IXDP465 Development Platform Quick Start Guide Intel IXDP465 Development Platform User s Guide Intel IXP46X Product Line of Network Processors Developer s Manual Intel IXDP465 Development Platform Specification Update Intel IXP435 Multi-Service Residential Gateway Reference Platform User s Guide This document is on the software Web page at: Obtaining the Intel IXP400 Software v3.0 and Related Software Components The IXP400 software consists of two type of packages, or downloadable zipped (compressed) files. The packages required depend primarily on the inclusion of cryptographic acceleration support. The Intel website provides information about obtaining the proper packages. This section provides an overview of the types of packages and the providers of the various content. Table 2 describes the various packages that may be required. 1. To begin, go to the Download link at the following website: download_ixp400.htm 2. Acquire the version of the IXP400 software and NPE Microcode packages that provide the correct cryptographic acceleration capability and licensing terms. 3. See Table 2 (or the Intel website) for information about other required packages for your target development operating system. 4. Proceed to the instructions in Section 5.0 Table 2. Intel IXP400 Software and Related Software Packages Description File Names Required/ Optional Provider Intel IXP400 Software Access Library Intel IXP400 NPE Microcode Image BSD_ixp400AccessLibrary-3_0.zip OR BSD_ixp400AccessLibraryWithCrypto- 3_0.zip IPL_ixp400NpeLibrary-3_0.zip OR IPL_ixp400NpeLibraryWithCrypto- 3_0.zip Either one is required Either one is required Intel Corporation Intel Corporation Linux Support Package Varies Required Timesys* 1 August 2007 Release Notes 5

6 Table 2. Intel IXP400 Software and Related Software Packages (Continued) Description File Names Required/ Optional Provider Performance profiling component (perprof) BSD_ixp400PMU-3.0.zip Optional Intel Corporation Ethernet Device Driver and Patch GPL_ixp400LinuxEthernetDriverPatch- 3_0.zip Required Intel Corporation RedBoot Pre-Built Binaries npe_bins tar.gz Optional Red Hat * 1 NPE Microcode for RedBoot (for building binaries from source) RedBoot-v2_04-npe-microcode.zip Optional Intel Corporation RedBoot Source and Toolchain varies Optional Red Hat* 1 1 Intel does not control the content on other companies' web sites or endorse other companies supplying products or services. 1 The file names are not shown with the license type and version number from this point onwards. For example, BSD_ixp400AccessLibrary-3_0.zip is referred to as ixp400accesslibrary.zip. 5.0 Installing and Building the Software 5.1 Prerequisites Do the following before implementing the installation instructions: 1. Download the Timesys Getting Started release notes from the Timesys Linux Link website and follow the instructions to install the desired development platform LSP. 2. Set up the host development system. The general cross-development setup requires that the following services be set up and configured correctly: A DHCP server running on the host machine to provide an IP address for the RedBoot bootloader on the development platform and the Linux kernel. A TFTP service running on the host machine to allow the RedBoot bootloader to download the kernel image. An NFS service running on the host machine for supporting the default kernel configuration that mounts the remote file system for the target. An exported NFS directory on the host machine that provides a remote file system for the target platform and a place from which to install kernel modules. A serial connection using the UART 0 port on the target platform, and a terminal emulator (such as Minicom*) on the host platform set to baud, 8-N-1. The instructions in this document assume that the host system and the development board are connected through a cross-over Ethernet cable using the Intel 8255x-based PCI card in the target platform. Release Notes August

7 5.2 Installation 1. Make a working directory by typing the following command: mkdir <workdir> The working directory is annotated as <workdir> for the purposes of this procedure. 2. Set up the LSP kernel source tree in the working directory if not already done as part of the Timesys Getting Started release note setup procedure. To set up the LSP kernel manually, copy the LSP kernel into a directory under <workdir>. $ cp -a /opt/timesys/linux/6.1/kernel ts.kixrp435.1 <workdir>/ 3. The directory of the LSP kernel source tree can be renamed as linux for convenience. This document assumes that the LSP kernel source tree is accessed as if it is under the directory <workdir>/linux from this point forward in the instructions. 4. Obtain and extract the contents of the access library zip file from Intel IXP400 Software v3.0 into the working directory. Execute by typing the following: $ cd <workdir> $ unzip <path-to-file>/ixp400accesslibrary.zip This file contains the IXP400 software access library and demo codelet source code. The access library source code is unzipped into the following directories: <workdir>/ixp400_xscale_sw <workdir>/ixp_osal At this point the working directory tree has the following structure: <workdir> --ixp400_xscale_sw --ixp_osal --linux 5. Extract the contents of the NPE Microcode Image zip file into the working directory. Execute by typing the following: $ unzip <path-to-file>/ixp400npelibrary.zip The NPE microcode file is unzipped into <workdir>/ixp400_xscale_sw/ src/npedl. 6. Configure the access library build environment by editing one of the following files. Change the values of the environment variables as appropriate, as shown in the following table: For Bourne-compatible shells: August 2007 Release Notes 7

8 $ <workdir>/ixp400_xscale_sw/buildutils/environment.linux.sh For C-Shell compatible shells: $ <workdir>/ixp400_xscale_sw/buildutils/environment.linux.csh linuxbe_kernel_dir This variable should point to <workdir>/linux CROSSCOMPILER_DIR Should point to the your toolchain bin directory(for example.: / opt/timesys/toolchains/armv5b-linux/bin) IX_LINUX_CROSSCOMPILER Should be the prefix of your cross compiler (e.g armv5b-linuxfor Timesys cross compiler) IX_XSCALE_SW Should point to the ixp400_xscale_sw directory: <workdir>/ixp400_xscale_sw IX_DEVICE Specifies the target processor. Refer to Section 6.2. IX_PLATFORM Specifies the target development platform. Refer to Section 6.2 IX_TARGET Should be linuxbe 7. Set up the environment using one of the following commands: $ source./ixp400_xscale_sw/buildutils/environment.linux.sh or $ source ixp400_xscale_sw/buildutils/environment.linux.csh The script sets the environment variables that allow the access library to be compiled with the Linux kernel. Whenever you exit from the terminal in which the environment settings were originally set, the script must be rerun for the environment settings to be available. 8. Verify that the environment variables are set correctly by typing: $ env grep IX 9. Obtain the Intel IXP400 Software Linux Ethernet Driver from the website. 10.Extract the zip file into the working directory. $ unzip <path-to-file>/ixp400linuxethernetdriverpatch.zip 11.Apply the contained patch files while in the <workdir>/linux directory. You may also refer to its readme.txt file located on the website. The website contains the most recent version of the patches and instructions. Unless instructed differently in the readme.txt, the general process for applying patches is as follows: $ cd linux $ patch -p1 <../ixp400linuxethernetdriver.patch $ cp../ixp400_eth.c./drivers/net $ cp../ixlinuxeddioctl.h./drivers/net Release Notes August

9 In general, the IXP400 software Linux Ethernet patch is used to update the kernel source to integrate the NPE-enabled Ethernet driver. Source for the IXP400 software Linux Ethernet driver is also provided along with these patches. 5.3 Building a Bootable Kernel Image To build and configure a bootable kernel image, 1. Ensure that the environment is set (see step 6 in section 5.2) 2. Configure the kernel tree by running the following: For the Intel IXDP465 Development Platform: $ cd linux $ make $IX_KBUILD_CROSSCOMPILE ixp4xx_defconfig For the Intel IXP435 Multi-Service Residential Gateway Reference Platform: $ cd linux $ make $IX_KBUILD_CROSSCOMPILE kixrp435_defconfig To ensure the correct platform (please select only one platform at a time) is selected in kernel menu: $ make $IX_KBUILD_CROSSCOMPILE menuconfig Select: System Type --> Intel IXP4xx Implementation Options --> For IXDP465 Development platform, select IXDP465 ONLY For IXP435 reference platform, select KIXRP435 ONLY The module unloading feature is disabled by default. To turn on it, please go to: Loadable module support --> [*]Module unloading 3. Build the Linux* kernel image and execute the command: $ make $IX_KBUILD_CROSSCOMPILE zimage This creates a file named zimage that is located in <workdir>/linux/ arch/arm/boot/ This can be booted using the RedBoot* bootloader. 4. Copy zimage to the tftpboot directory, typically /tftpboot/ 5. Refer to Section for instructions on loading the image. August 2007 Release Notes 9

10 5.4 Building the Kernel Modules Enabling and Building the Ethernet Kernel Module (NPE-based Ethernet Driver) and Other Modules The IXDP465 development platform and the IXP435 reference platform provide multiple NPE-based Ethernet devices in addition to an Intel 8255x-based PCI card. The NPE Ethernet devices are supported by a driver (ixp400_eth.ko) that is implemented as a standard Linux network driver. To enable the Ethernet driver, do the following: $ cd linux $ make $IX_KBUILD_CROSSCOMPILE menuconfig Type M if it is not already there to enable the Ethernet driver. <M> Intel IXP400 Ethernet Device support - under the menu Device Drivers --> "Network device support" --> "Ethernet (10 or 100Mbit)", To build the configured kernel modules: 1. Change the working directory to the Linux kernel source directory: <workdir>/linux 2. Make sure the environment is set. (See step 6 in Section 5.2.) 3. Build the configured kernel modules, including the NPE-based Ethernet driver (ixp400_eth.ko), using the command: $ make $IX_KBUILD_CROSSCOMPILE modules, To build the NPE-based Ethernet driver please ensure steps 9-11 in Section 5.2 are implemented. 4. Copy the ixp400_eth.ko from the kernel source tree under the drivers/ net directory and other desired modules into the embedded target file system on the host machine <TARGET_FILE_SYSTEM>/, for example: $ cp <workdir>/linux/drivers/net/ixp400_eth.ko /opt/timesys/linux/6.1/armv5bstd/rfs/ Building the Intel IXP400 Software Access Library You can begin to modify and/or build the IXP400 software access library by itself using the following procedures. These procedures assume that the kernel has already been built and is properly configured. 1. Ensure that the environment is set. (See Step 6 in Section 5.2.) 2. Change the working directory to the access library source directory: <workdir>/ixp400_xscale_sw 3. To build a module containing the access library components, use the command: Release Notes August

11 $ make ixp To build a module containing one of the codelets (refer to Section 6.3 for other codelets available with their respective naming conventions), use the following command for building the Ethernet codelet: $ make module COMP=codelets_ethAcc 5. To build all modules, use the following command: $ make modules 6. The resulting modules are located in one of the following library directories, as appropriate: For IXDP465 development platform: <workdir>/ixp400_xscale_sw/ixp46x/lib/linuxbe For IXP435 reference platform: <workdir>/ixp400_xscale_sw/ixp43x/lib/linuxbe Copy the required loadable modules (for example, ixp400.ko, ixp400_codelets_ethacc.ko and so on) into the TARGET_FILE_SYSTEM directory on the host machine. Example for the IXP435 reference platform: $ cp <workdir>/ixp400_xscale_sw/ixp43x/lib/linuxbe/ixp400.ko /opt/timesys/linux/ 6.1/armv5b-std/rfs/ 7. Copy the IxNpeMicrocode.dat from the library directory, as appropriate to the TARGET_FILE_SYSTEM directory. For example, the following command works for a big endian IXP435 reference platform: $ cp <workdir>/ixp400_xscale_sw/ixp43x/lib/linuxbe/ixnpemicrocode.dat /opt/ timesys/linux/6.1/armv5b-std/rfs/ The make modules in <workdir>/ixp400_xscale_sw is different from the make modules that is issued in the <workdir>/linux directory. The make modules that is issued in <workdir>/ixp400_xscale_sw is to compile the IXP400 software Access Library 5.5 Loading and Using the Intel IXP400 Software Using RedBoot* to Load Linux* Kernel Images This procedure assumes that the target platform has RedBoot preprogrammed into flash. IXP400 software has not been validated on version 2.04 Little-Endian target configurations. Also refer to the appropriate IXP400 software RedBoot software release notes for more information on command s parameters/flags, how to program the flash images or how to configure RedBoot to connect to the host platform. See Section It is recommended that the MAC addresses for the target platform be set at this point. This process is documented in the appropriate Intel IXP400 Software RedBoot* Software Release Notes. August 2007 Release Notes 11

12 2. Load and then execute the kernel using the RedBoot commands: Redboot> load -v r b %{FREEMEMLO} zimage Redboot> exec Installing and Running the NPE-Ethernet Driver After the zimage above is booted on the target platform, follow the procedure shown to load the kernel modules for the access-layer, microcode and NPE-Ethernet driver. localhost login: root -bash-2.05b# cd / -bash-2.05b# mknod dev/ixnpe c bash-2.05b# insmod ixp400.ko -bash-2.05b# cat IxNpeMicrocode.dat > /dev/ixnpe -bash-2.05b# insmod ixp400_eth.ko For the IXP435 reference platform, include no_phy_scan=1 during insmoding the ixp400_eth.ko. See below: -bash-2.05b# insmod ixp400_eth.ko no_phy_scan=1 At this point, the loadable modules containing the IXP400 software and the Ethernet driver for the NPE-based interfaces are loaded. More information about the Ethernet Device Driver is covered in Section 5.7. The NPE microcode is being loaded into memory via the character device driver immediately after the loading of the IXP400 software object file during runtime. These steps involve creating a special character device and cating the.dat file into the device Installing and Running the Intel IXP400 Software Codelet Modules The IXP400 software contains example codelets that demonstrate the functionality of various access-layer components. Some codelets (ixp400_codelets_ethacc.ko, for example) may not function if the embedded Ethernet driver (ixp400_eth.ko) is loaded since the codelet accesses the Ethernet hardware on the NPE directly and conflicts with resources used by the device driver. Additionally, only one codelet may be loaded at any one time. The commands listed below load the IxEthAcc codelet and execute a loop-back test between IXP 1 and IXP 2. Note that: inport0 = IXP0 = NPE-B (not applicable to IXP43X product line) inport1 = IXP1 = NPE-C inport2 = IXP2 = NPE-A Release Notes August

13 To test this codelet, connect an Ethernet cross-over cable between IXP 1 and IXP 2, and follow the instructions. localhost login: root -bash-2.05b# cd / -bash-2.05b# mknod dev/ixnpe c bash-2.05b# insmod ixp400.ko -bash-2.05b# cat IxNpeMicrocode.dat > /dev/ixnpe -bash-2.05b# insmod ixp400_codelets_ethacc.ko operationtype=3 inport=1 outport=2 See the following to remove and re-insert Ethernet codelets: -bash-2.05b# rmmod ixp400_codelets_ethacc.ko -bash-2.05b# rmmod ixp400.ko -bash-2.05b# mknod dev/ixnpe c bash-2.05b# insmod ixp400.ko -bash-2.05b# cat IxNpeMicrocode.dat > /dev/ixnpe -bash-2.05b# insmod ixp400_codelets_ethacc.ko operationtype=3 inport=1 outport=2 (or with different codelet) To remove a loaded ixp400_eth.ko, ensure there are no other dependencies on it. For example, make sure that all IXP interfaces are brought down. The ixp400_eth.ko will fail to be removed if the driver is still in use. -bash-2.05b# ifconfig ixp0 down (if this interface exists and is up) -bash-2.05b# ifconfig ixp1 down (if this interface exists and is up) -bash-2.05b# ifconfig ixp2 down (if this interface exists and is up) -bash-2.05b# rmmod ixp400_eth.ko -bash-2.05b# rmmod ixp400.ko -bash-2.05b# mknod dev/ixnpe c bash-2.05b# insmod ixp400.ko -bash-2.05b# cat IxNpeMicrocode.dat > /dev/ixnpe -bash-2.05b# insmod ixp400_eth.ko 5.6 Additional RedBoot* Information RedBoot is the bootloader that is used to boot Linux. The binaries for RedBoot and additional documentation can be obtained from: August 2007 Release Notes 13

14 You could use the binaries from Intel to take advantage of NPE-enabled RedBoot. These binaries are certified by Red Hat and allow the NPE Ethernet interfaces to be immediately used on the different IXP4XX product line-based development platforms. 5.7 Additional Ethernet Device Driver Information The Linux Ethernet Device Driver includes a number of options that govern its behavior during compile-time and run-time. The available configuration options are discussed here. The Linux Ethernet Device Driver is provided separately from the IXP400 software source code Kernel Configuration Options To configure the kernel for Ethernet Device Driver, run the standard Linux kernel configuration utilities make $IX_KBUILD_CROSSCOMPILE xconfig (or make $IX_KBUILD_CROSSCOMPILE menuconfig). The options fall into three categories, board, system, and driver. Boards The Linux Ethernet Device Driver is designed specifically to support a number of development and reference platforms based upon the Intel IXP4XX product line processors. Available options are: System Type --> Intel IXP4xx Implementation Options --> []IXDP465 []KIXRP435 CONFIG_MACH_IXDP465 -> IXDP465 development platform CONFIG_MACH_KIXRP435 -> IXP435 reference platform System Options System options define Linux kernel modules or configuration settings that should be set to interact appropriately with the Ethernet Device Driver. Available option is: Driver Options Release Notes August

15 Driver options define how the Ethernet Device Driver is to be configured prior to compilation of the driver source. Available options are: Device Driver --> Network device support --> Ethernet (10 or 100Mbit) --> <M> Intel IXP400 Ethernet Device support Intel IXP400 Ethernet Device Drive NPE support (ALL_NPEs)--> (*) All_NPEs () NPEA-Only () NPEB-Only () NPEC-Only [] Intel IXP400 Ethernet Device Driver Fast Skb Recycling support [] Intel IXP400 Ethernet Device Driver Fast QDisc support [] Intel IXP400 Ethernet Device Driver Ethernet Database Support CONFIG_IXP400_ETH_ALL (All_NPEs): This option directs the device driver to use all available NPE ports. NPE A is assigned to IXP2, NPE B assigned to IXP0 and NPE C assigned to IXP1 on the IXDP465 development platform. For IXP435 reference platform, this assigns NPE C to use the IXP1 and NPE A to use IXP2. There is no NPE B on IXP43X product line. CONFIG_IXP400_ETH_NPEA_ONLY (NPEA-Only): Set this option to enable the driver to use ixp2 over NPE A. Only ixp2 is created. This can be used to configure the driver for the boards using some variants of the IXP4XX product line with only a single Ethernet NPE. When used with no_phy_scan=1, the default setting of the internal array phyaddress[ ]is used. When used with no_phy_scan=0 and PHY discovery, the PHY used for NPE A is the one with the lowest MDIO address. The command-line option dev_max_count modifies the default setting to add additional ports. CONFIG_IXP400_ETH_NPEB_ONLY (NPEB-Only): Set this option to enable the driver to use ixp0 over NPE B. Only ixp0 is created. This can be used to configure the driver for the boards using some variants of the IXP4XX product line with only a single Ethernet NPE. When used with no_phy_scan=1, the default setting of the internal array phyaddress[ ]is used. When used with no_phy_scan=0 and PHY discovery, the PHY used for NPE B is the one with the lowest MDIO address. The command-line option dev_max_count modifies the default setting to add additional ports. CONFIG_IXP400_ETH_NPEC_ONLY (NPEC-Only): Set this option to enable the driver to use ixp1 over NPE C. Only ixp1 is created. This can be used to configure the driver for the boards using some variants of the IXP4XX product line with only a single Ethernet NPE. When used with no_phy_scan=1, the default setting of the internal array phyaddress[ ] is used. When used with no_phy_scan=0 and PHY discovery, the PHY used for NPE C is the one with the lowest MDIO address. The command-line option dev_max_count modifies the default setting to add additional ports. CONFIG_IXP400_ETH_SKB_RECYCLE (Intel IXP400 Ethernet Device Driver Fast Skb Recycling support): This option disables the August 2007 Release Notes 15

16 fast buffer recycling within the driver. When defined, throughput performance is higher but may not be compatible with some patched kernels. Some applications may implement a patch over the SK buff mechanisms. If this is the case, then you need to ensure that the sequence in the driver dev_skb_enqueue() function is compatible with the contents of the kernel function skb_headerinit() in net/core/skbuf.c. CONFIG_IXP400_ETH_QDISC_ENABLED (Intel IXP400 Ethernet Device Driver Fast QDisc support): The option enables the driver s internal queuing discipline. When defined, this may increase the driver throughput performance but may affect the performance of some debug utilities, such as tcpdump. CONFIG_IXP400_ETH_DB (Intel IXP400 Ethernet Device Driver Ethernet Database Support): This option enables IXP400 Ethernet database support. This option enables Rx QoS, fast-path, customized Ethernet header support and module upgrade support. Default Settings The default configuration defines the following: # CONFIG_IXP400_ETH is not set # CONFIG_IXP400_ETH_ALL=y (if only CONFIG_IXP400_ETH is set) # CONFIG_IXP400_ETH_NPEA_ONLY is not set # CONFIG_IXP400_ETH_NPEB_ONLY is not set # CONFIG_IXP400_ETH_NPEC_ONLY is not set # CONFIG_IXP400_ETH_SKB_RECYCLE is set (if only CONFIG_IXP400_ETH is set) # CONFIG_IXP400_ETH_QDISC_ENABLED is set (if only CONFIG_IXP400_ETH is set) # CONFIG_IXP400_ETH_DB is set Command-Line Options The following commands can be used while insmoding the driver: Table 3. Linux* Ethernet Device Driver Command-Line Options Option log_level=0 log_level=1 log_level=2 no_ixp400_sw_init=0 no_ixp400_sw_init=1 No display, except errors. (Default) Verbose display. Description Debug display, additional logging available when the -DDEBUG compile-time option is enabled. Initialize the IXP400 software components necessary for driver. (Default) Do NOT initialize the IXP400 software components. It is useful if using codelets to avoid redundant initialization. Release Notes August

17 Table 3. Linux* Ethernet Device Driver Command-Line Options (Continued) Option no_phy_scan=0 no_phy_scan=1 phy_reset=0 phy_reset=1 dev_max_count=1 dev_max_count=2 dev_max_count=3 hss_coexist=1 hss_coexist=0 customized_eth_hdr_a=1 customized_eth_hdr_b=1 customized_eth_hdr_c=1 customized_eth_hdr_a=0 customized_eth_hdr_b=0 customized_eth_hdr_c=0 module_upgrade_init=1 module_upgrade_init=0 Description PHY interfaces polling and discovery, mapping to ixp ports on a first-found basis. (Default) Use the array phyaddresses[..] from driver s source code. Do not reset the PHYs at initialization. (Default) Reset all PHYs at initialization. Configure ixp0 only. Configure ixp1 and ixp2 if CONFIG_MACH_KIXRP435 Configure ixp0, ixp1, ixp2. (Default if CONFIG_MACH_IXDP465) NPE-A Ethernet-HSS coexistence is enabled (only if CONFIG_MACH_IXDP465 or CONFIG_MACH_KIXRP435) NPE-A Ethernet-HSS coexistence is disabled. (Default) Option only available when CONFIG_IXP400_ETH_DB=y Customized 16-byte Ethernet Header for NPE A Option only available when CONFIG_IXP400_ETH_DB=y Customized 16-byte Ethernet Header for NPE B Option only available when CONFIG_IXP400_ETH_DB=y Customized 16-byte Ethernet Header for NPE C Option only available when CONFIG_IXP400_ETH_DB=y Not customized 16-byte Ethernet Header for NPE A. (Default) Option only available when CONFIG_IXP400_ETH_DB=y Not customized 16-byte Ethernet Header for NPE B. (Default) Option only available when CONFIG_IXP400_ETH_DB=y Not customized 16-byte Ethernet Header for NPE C. (Default) Driver is recovered from previous module upgrade action (CMD_MISCFEATURE_MODUPGRADE_TRUE) Driver is not recovered from previous module upgrade action. (Default) 6.0 Intel IXP400 Software Makefile 6.1 Makefile Commands The following tables show additional makefile options supported by IXP400 software. These commands are only applicable when using the top-level makefile located in the following directory: /ixp400_xscale_sw Table 4. Makefile Commands Command Description, Notes make clean Deletes all files that can be rebuilt by the build system. This includes object files, library files and dependency information. A make clean should be performed any time a MACRO value is changed to ensure the new MACRO values take effect. August 2007 Release Notes 17

18 Table 4. Makefile Commands Command make module COMP=(component) make modules make ixp400 Description, Notes Builds a Linux kernel module of component code. Builds all of the Linux kernel modules Builds a Linux kernel module containing the access drivers 6.2 Makefile Macros Parameters are passed to the build system as make macro definitions by defining them as environment variables or as command line arguments to make in the following form: <macro_name>=<value> Warning: The settings of any macros other than IX_TARGET and COMP only affect code rebuilt during the current make invocation. To ensure that the changes propagate to the code structure, a make clean should be done when any values are changed. Table 5. Makefile Macros (Sheet 1 of 2) Macro Values Description COMP A software component name or codelet name prefixed by codelets_. Identifies the software component when building loadable object files of codelets or access layer components. IX_TARGET IX_DEVICE IX_PLATFORM IX_CFLAGS IX_LDFLAGS IX_DEBUG linuxbe ixp46x ixp43x ixdp46x kixrp43x Any legal GCC compiler flags Any value, or undefined Controls that are used to build the code for Intel XScale processor hardware running Linux big-endian (linuxbe) Specifies the target processor. Case-sensitive. Specifies the target development platform. Additional compiler or linker flags to use while compiling code. Enables additional parameter checks and trace messages. If set to any value, the C macro IX_DEBUG is defined for all source code. Otherwise, the C macro NDEBUG is defined. IX_NOSYM Any value, or undefined If set to any value, no debugging symbol information is included in the build products. IX_NOOPT Any value, or undefined Disable compiler optimizations IX_CONTROLLED_COUNTRY_BUILD IX_BYPASS_DEPS IX_LINUX_CROSSCOMPILER Any value, or undefined Any value, or undefined prefix of cross compiler (e.g armv5b-linux- for timesys cross compiler) Builds an image without cryptography support. Cryptography features must not be released to controlled countries, as defined by United States export laws. Used along side make clean to bypass the unnecessary building of dependencies. Used to specify the cross compiler prefix IX_UTOPIAMODE Any value, or undefined Used when ATM SPHY 1 port support is required (default) Release Notes August

19 Table 5. Makefile Macros (Sheet 2 of 2) Macro Values Description IX_MPHY Any value, or undefined Used when ATM MPHY 12 Port support is required IX_NPE_HSS_MPHY4PORT IX_EXTRA_WARNINGS Any value, or undefined Any value, or undefined Used when the coexistence of HSS and ATM MPHY 4 port is required (IX_NPEDL_NPEIMAGE_NPEA_HSS0_ATM_MPHY_4_PORT image) Used when extra warning message is needed about Linux header files but not in Intel production code 6.3 Available Codelets The following table lists the codelets available in this release. These values can be used with the COMP macro. codelets_atm codelets_cryptoacc codelets_ethacc codelets_hssacc codelets_parityenacc codelets_timesyncacc 7.0 Access Library Source Code Documentation The IXP400 software compressed file contains the source code documentation in the following format: Printable form in Adobe* Acrobat* Portable Document Format (PDF) at: ixp400_xscale_sw\doc\ixp400_software_api_reference.pdf and ixp_osal\doc\ixp400_software_osal_api_reference.pdf 8.0 Issues with Third-Party Components This section provides the details reported as issues while using third-party software and tools. It is provided as a convenience for the developer. These are not considered as errata in the IXP400 software. See the Intel IXP400 Software Specification Update for a detailed list of software release 3.0 errata. There may exist additional errata with third-party software and tools. Refer to the third-party vendor for additional information. August 2007 Release Notes 19