sys/arch/arm/xscale/ixp425-fw.README

   1 $NetBSD$
   2
   3 IXP425 NPE Microcode
   4 ~~~~~~~~~~~~~~~~~~~~
   5
   6 The IXP425 contains up to three network co-processors called NPEs,
   7 "Network Processing Engines". These control all the networking features
   8 of the IXP425 and are usually supported by Access Library (AL) software
   9 and NPE microcode obtained from Intel.
  10
  11 The AL source code and compiled object files are encumbered by a license
  12 which precludes its distribution with NetBSD.
  13
  14 However, NetBSD includes source for a native driver for NPE Ethernet
  15 written by Sam Leffler. The driver requires that Intel's microcode is
  16 loaded onto the NPE, but since we cannot distribute the microcode, it
  17 must be downloaded from Intel's website after agreeing to their click-
  18 through license.
  19
  20 You must grab the NPE microcode from here:
  21
  22  http://www.intel.com/design/network/products/npfamily/ixp400_current.htm
  23
  24 Select the "Download (without Crypto)" link in the "NPE Microcode"
  25 section. Note that there is no benefit in selecting the "with Cypto"
  26 microcode at this time since NetBSD does not support it.
  27
  28 Note: At the time of writing (December 2006), the NPE Microcode is at
  29 version 2.3. Newer versions may not work with NetBSD's native Ethernet
  30 driver. If this is the case, let us know via send-pr(1).
  31
  32 After clicking the link, you will be directed to a click-through license
  33 page. Assuming you agree to the terms of the license (and you are
  34 *strongly* advised to print it out and read it carefully) you will then
  35 be able to download a ZIP file containing the microcode.
  36
  37 Extract the microcode under any decent Unix-like system using the "unzip"
  38 command provided with the OS, or with the version included in the pkgsrc
  39 collection under archivers/unzip:
  40
  41         $ unzip IPL_ixp400NpeLibrary-2_3.zip
  42
  43 Next, you must generate a microcode image suitable for inclusion in the
  44 NetBSD kernel.
  45
  46         $ cd ixp400_xscale_sw/src/npeDl
  47
  48 In this directory, create a file called IxNpeMicrocode.h, and populate
  49 it with the following two #defines:
  50
  51 #define IX_NPEDL_NPEIMAGE_NPEB_ETH
  52 #define IX_NPEDL_NPEIMAGE_NPEC_ETH
  53
  54 Note: If you know that you will only ever use Ethernet on NPE-B, you can
  55 omit the second line, and vice-versa.
  56
  57 Now compile and run ixNpeDlImageConverter.c:
  58
  59         $ cc ixNpeDlImageConverter.c -o foo
  60         $ ./foo
  61
  62 Congratulations! You should now have a file called "IxNpeMicrocode.dat"
  63 in the current directory. Please take heed of the license you agreed to
  64 when you downloaded the Microcode. The license contains clauses which
  65 control the redistribution of this microcode object file.
  66
  67 Now copy "IxNpeMicrocode.dat" to the sys/arch/arm/xscale directory in
  68 your NetBSD source tree. All you have to do now is run config(1) and
  69 build your kernel.
  70
  71 If all went as planned, the Ethernet controller(s) will show up as npe0
  72 and npe1. That's all there is to it!
  73
  74 It is planned that pkgsrc will, eventually, automate most of the above
  75 procedure.