Orange Pi5 kernel

^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   1) ===========================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   2) Release Notes for Linux on Intel's IXP4xx Network Processor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   3) ===========================================================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   4) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   5) Maintained by Deepak Saxena <dsaxena@plexity.net>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   6) -------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   7) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   8) 1. Overview
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300   9) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  10) Intel's IXP4xx network processor is a highly integrated SOC that
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  11) is targeted for network applications, though it has become popular
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  12) in industrial control and other areas due to low cost and power
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  13) consumption. The IXP4xx family currently consists of several processors
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  14) that support different network offload functions such as encryption,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  15) routing, firewalling, etc. The IXP46x family is an updated version which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  16) supports faster speeds, new memory and flash configurations, and more
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  17) integration such as an on-chip I2C controller.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  18) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  19) For more information on the various versions of the CPU, see:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  20) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  21)    http://developer.intel.com/design/network/products/npfamily/ixp4xx.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  22) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  23) Intel also made the IXCP1100 CPU for sometime which is an IXP4xx
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  24) stripped of much of the network intelligence.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  25) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  26) 2. Linux Support
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  27) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  28) Linux currently supports the following features on the IXP4xx chips:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  29) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  30) - Dual serial ports
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  31) - PCI interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  32) - Flash access (MTD/JFFS)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  33) - I2C through GPIO on IXP42x
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  34) - GPIO for input/output/interrupts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  35)   See arch/arm/mach-ixp4xx/include/mach/platform.h for access functions.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  36) - Timers (watchdog, OS)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  37) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  38) The following components of the chips are not supported by Linux and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  39) require the use of Intel's proprietary CSR software:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  40) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  41) - USB device interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  42) - Network interfaces (HSS, Utopia, NPEs, etc)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  43) - Network offload functionality
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  44) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  45) If you need to use any of the above, you need to download Intel's
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  46) software from:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  47) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  48)    http://developer.intel.com/design/network/products/npfamily/ixp425.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  49) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  50) DO NOT POST QUESTIONS TO THE LINUX MAILING LISTS REGARDING THE PROPRIETARY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  51) SOFTWARE.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  52) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  53) There are several websites that provide directions/pointers on using
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  54) Intel's software:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  55) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  56)    - http://sourceforge.net/projects/ixp4xx-osdg/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  57)      Open Source Developer's Guide for using uClinux and the Intel libraries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  58) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  59)    - http://gatewaymaker.sourceforge.net/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  60)      Simple one page summary of building a gateway using an IXP425 and Linux
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  61) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  62)    - http://ixp425.sourceforge.net/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  63)      ATM device driver for IXP425 that relies on Intel's libraries
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  64) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  65) 3. Known Issues/Limitations
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  66) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  67) 3a. Limited inbound PCI window
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  68) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  69) The IXP4xx family allows for up to 256MB of memory but the PCI interface
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  70) can only expose 64MB of that memory to the PCI bus. This means that if
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  71) you are running with > 64MB, all PCI buffers outside of the accessible
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  72) range will be bounced using the routines in arch/arm/common/dmabounce.c.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  73) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  74) 3b. Limited outbound PCI window
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  75) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  76) IXP4xx provides two methods of accessing PCI memory space:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  77) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  78) 1) A direct mapped window from 0x48000000 to 0x4bffffff (64MB).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  79)    To access PCI via this space, we simply ioremap() the BAR
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  80)    into the kernel and we can use the standard read[bwl]/write[bwl]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  81)    macros. This is the preffered method due to speed but it
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  82)    limits the system to just 64MB of PCI memory. This can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  83)    problamatic if using video cards and other memory-heavy devices.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  84) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  85) 2) If > 64MB of memory space is required, the IXP4xx can be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  86)    configured to use indirect registers to access PCI This allows
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  87)    for up to 128MB (0x48000000 to 0x4fffffff) of memory on the bus.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  88)    The disadvantage of this is that every PCI access requires
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  89)    three local register accesses plus a spinlock, but in some
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  90)    cases the performance hit is acceptable. In addition, you cannot
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  91)    mmap() PCI devices in this case due to the indirect nature
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  92)    of the PCI window.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  93) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  94) By default, the direct method is used for performance reasons. If
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  95) you need more PCI memory, enable the IXP4XX_INDIRECT_PCI config option.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  96) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  97) 3c. GPIO as Interrupts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  98) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300  99) Currently the code only handles level-sensitive GPIO interrupts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) 4. Supported platforms
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) ADI Engineering Coyote Gateway Reference Platform
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) http://www.adiengineering.com/productsCoyote.html
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106)    The ADI Coyote platform is reference design for those building
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)    small residential/office gateways. One NPE is connected to a 10/100
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108)    interface, one to 4-port 10/100 switch, and the third to and ADSL
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)    interface. In addition, it also supports to POTs interfaces connected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)    via SLICs. Note that those are not supported by Linux ATM. Finally,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)    the platform has two mini-PCI slots used for 802.11[bga] cards.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112)    Finally, there is an IDE port hanging off the expansion bus.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) Gateworks Avila Network Platform
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) http://www.gateworks.com/support/overview.php
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)    The Avila platform is basically and IXDP425 with the 4 PCI slots
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118)    replaced with mini-PCI slots and a CF IDE interface hanging off
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)    the expansion bus.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) Intel IXDP425 Development Platform
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) http://www.intel.com/design/network/products/npfamily/ixdpg425.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124)    This is Intel's standard reference platform for the IXDP425 and is
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125)    also known as the Richfield board. It contains 4 PCI slots, 16MB
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)    of flash, two 10/100 ports and one ADSL port.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) Intel IXDP465 Development Platform
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) http://www.intel.com/design/network/products/npfamily/ixdp465.htm
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)    This is basically an IXDP425 with an IXP465 and 32M of flash instead
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132)    of just 16.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) Intel IXDPG425 Development Platform
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)    This is basically and ADI Coyote board with a NEC EHCI controller
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137)    added. One issue with this board is that the mini-PCI slots only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)    have the 3.3v line connected, so you can't use a PCI to mini-PCI
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139)    adapter with an E100 card. So to NFS root you need to use either
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140)    the CSR or a WiFi card and a ramdisk that BOOTPs and then does
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)    a pivot_root to NFS.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) Motorola PrPMC1100 Processor Mezanine Card
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) http://www.fountainsys.com
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146)    The PrPMC1100 is based on the IXCP1100 and is meant to plug into
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147)    and IXP2400/2800 system to act as the system controller. It simply
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)    contains a CPU and 16MB of flash on the board and needs to be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149)    plugged into a carrier board to function. Currently Linux only
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)    supports the Motorola PrPMC carrier board for this platform.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) 5. TODO LIST
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) - Add support for Coyote IDE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) - Add support for edge-based GPIO interrupts
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) - Add support for CF IDE on expansion bus
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) 6. Thanks
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) The IXP4xx work has been funded by Intel Corp. and MontaVista Software, Inc.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) The following people have contributed patches/comments/etc:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) - Lennerty Buytenhek
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) - Lutz Jaenicke
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) - Justin Mayfield
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) - Robert E. Ranslam
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) [I know I've forgotten others, please email me to be added]
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) -------------------------------------------------------------------------
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) 
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) Last Update: 01/04/2005