freebsd-dev/sys/contrib/octeon-sdk
Juli Mallett cea2b8b915 Update the port of FreeBSD to Cavium Octeon to use the Cavium Simple Executive
library:
o) Increase inline unit / large function growth limits for MIPS to accommodate
   the needs of the Simple Executive, which uses a shocking amount of inlining.
o) Remove TARGET_OCTEON and use CPU_CNMIPS to do things required by cnMIPS and
   the Octeon SoC.
o) Add OCTEON_VENDOR_LANNER to use Lanner's allocation of vendor-specific
   board numbers, specifically to support the MR320.
o) Add OCTEON_BOARD_CAPK_0100ND to hard-wire configuration for the CAPK-0100nd,
   which improperly uses an evaluation board's board number and breaks board
   detection at runtime.  This board is sold by Portwell as the CAM-0100.
o) Add support for the RTC available on some Octeon boards.
o) Add support for the Octeon PCI bus.  Note that rman_[sg]et_virtual for IO
   ports can not work unless building for n64.
o) Clean up the CompactFlash driver to use Simple Executive macros and
   structures where possible (it would be advisable to use the Simple Executive
   API to set the PIO mode, too, but that is not done presently.)  Also use
   structures from FreeBSD's ATA layer rather than structures copied from
   Linux.
o) Print available Octeon SoC features on boot.
o) Add support for the Octeon timecounter.
o) Use the Simple Executive's routines rather than local copies for doing reads
   and writes to 64-bit addresses and use its macros for various device
   addresses rather than using local copies.
o) Rename octeon_board_real to octeon_is_simulation to reduce differences with
   Cavium-provided code originally written for Linux.  Also make it use the
   same simplified test that the Simple Executive and Linux both use rather
   than our complex one.
o) Add support for the Octeon CIU, which is the main interrupt unit, as a bus
   to use normal interrupt allocation and setup routines.
o) Use the Simple Executive's bootmem facility to allocate physical memory for
   the kernel, rather than assuming we know which addresses we can steal.
   NB: This may reduce the amount of RAM the kernel reports you as having if
       you are leaving large temporary allocations made by U-Boot allocated
       when starting FreeBSD.
o) Add a port of the Cavium-provided Ethernet driver for Linux.  This changes
   Ethernet interface naming from rgmxN to octeN.  The new driver has vast
   improvements over the old one, both in performance and functionality, but
   does still have some features which have not been ported entirely and there
   may be unimplemented code that can be hit in everyday use.  I will make
   every effort to correct those as they are reported.
o) Support loading the kernel on non-contiguous cores.
o) Add very conservative support for harvesting randomness from the Octeon
   random number device.
o) Turn SMP on by default.
o) Clean up the style of the Octeon kernel configurations a little and make
   them compile with -march=octeon.
o) Add support for the Lanner MR320 and the CAPK-0100nd to the Simple
   Executive.
o) Modify the Simple Executive to build on FreeBSD and to build without
   executive-config.h or cvmx-config.h.  In the future we may want to
   revert part of these changes and supply executive-config.h and
   cvmx-config.h and access to the options contained in those files via
   kernel configuration files.
o) Modify the Simple Executive USB routines to support getting and setting
   of the USB PID.
2010-07-20 19:25:11 +00:00
..
cvmx-malloc
cvmip.h
cvmx-abi.h
cvmx-access-native.h
cvmx-access.h
cvmx-address.h
cvmx-app-init-linux.c
cvmx-app-init.c
cvmx-app-init.h
cvmx-asm.h
cvmx-asx.h
cvmx-atomic.h
cvmx-bootloader.h
cvmx-bootmem.c
cvmx-bootmem.h
cvmx-ciu.h
cvmx-cmd-queue.c
cvmx-cmd-queue.h
cvmx-cn3010-evb-hs5.c
cvmx-cn3010-evb-hs5.h
cvmx-compactflash.c
cvmx-compactflash.h
cvmx-core.c
cvmx-core.h
cvmx-coremask.c
cvmx-coremask.h
cvmx-csr-addresses.h
cvmx-csr-db-support.c
cvmx-csr-db.c
cvmx-csr-db.h
cvmx-csr-enums.h
cvmx-csr-typedefs.h
cvmx-csr.h
cvmx-cvmmem.h
cvmx-dfa.c
cvmx-dfa.h
cvmx-dma-engine.c
cvmx-dma-engine.h
cvmx-ebt3000.c
cvmx-ebt3000.h
cvmx-fau.h
cvmx-flash.c
cvmx-flash.h
cvmx-fpa.c
cvmx-fpa.h
cvmx-gmx.h
cvmx-gpio.h
cvmx-helper-board.c
cvmx-helper-board.h
cvmx-helper-check-defines.h
cvmx-helper-errata.c
cvmx-helper-errata.h
cvmx-helper-fpa.c
cvmx-helper-fpa.h
cvmx-helper-loop.c
cvmx-helper-loop.h
cvmx-helper-npi.c
cvmx-helper-npi.h
cvmx-helper-rgmii.c
cvmx-helper-rgmii.h
cvmx-helper-sgmii.c
cvmx-helper-sgmii.h
cvmx-helper-spi.c
cvmx-helper-spi.h
cvmx-helper-util.c
cvmx-helper-util.h
cvmx-helper-xaui.c
cvmx-helper-xaui.h
cvmx-helper.c
cvmx-helper.h
cvmx-higig.h
cvmx-interrupt-decodes.c
cvmx-interrupt-handler.S
cvmx-interrupt-rsl.c
cvmx-interrupt.c
cvmx-interrupt.h
cvmx-iob.h
cvmx-ipd.h
cvmx-key.h
cvmx-l2c.c
cvmx-l2c.h
cvmx-llm.c
cvmx-llm.h
cvmx-lmc.h
cvmx-log-arc.S
cvmx-log.c
cvmx-log.h
cvmx-malloc.h
cvmx-mdio.h
cvmx-mgmt-port.c
cvmx-mgmt-port.h
cvmx-mio.h
cvmx-nand.c
cvmx-nand.h
cvmx-npi.h
cvmx-packet.h
cvmx-pci.h
cvmx-pcie.c
cvmx-pcie.h
cvmx-pip.h
cvmx-pko.c
cvmx-pko.h
cvmx-platform.h
cvmx-pow.c
cvmx-pow.h
cvmx-raid.c
cvmx-raid.h
cvmx-resources.config
cvmx-rng.h
cvmx-rtc.h
cvmx-rwlock.h
cvmx-scratch.h
cvmx-shared-linux-n32.ld
cvmx-shared-linux-o32.ld
cvmx-shared-linux.ld
cvmx-spi4000.c
cvmx-spi.c
cvmx-spi.h
cvmx-spinlock.h
cvmx-swap.h
cvmx-sysinfo.c
cvmx-sysinfo.h
cvmx-thunder.c
cvmx-thunder.h
cvmx-tim.c
cvmx-tim.h
cvmx-tra.c
cvmx-tra.h
cvmx-twsi-raw.c
cvmx-twsi-raw.h
cvmx-twsi.c
cvmx-twsi.h
cvmx-uart.h
cvmx-usb.c
cvmx-usb.h
cvmx-utils.h
cvmx-version.h
cvmx-warn.c
cvmx-warn.h
cvmx-wqe.h
cvmx-zip.c
cvmx-zip.h
cvmx-zone.c
cvmx.h
cvmx.mk
executive-config.h.template
octeon-feature.h
octeon-model.c
octeon-model.h
octeon-pci-console.c
octeon-pci-console.h
README.txt

Readme for the Octeon Executive Library


The Octeon Executive Library provides runtime support and hardware 
abstraction for the Octeon processor.  The executive is composed of the 
libcvmx.a library as well as header files that provide  
functionality with inline functions.


Usage:

The libcvmx.a library is built for every application as part of the
application build. (Please refer to the 'related pages' section of the 
HTML documentation for more information on the build system.)  
Applications using the executive should include the header files from
$OCTEON_ROOT/target/include and link against the library that is built in 
the local obj directory. Each file using the executive 
should include the following two header files in order:

#include "cvmx-config.h"
#include "cvmx.h"

The cvmx-config.h file contains configuration information for the 
executive and is generated by the cvmx-config script from an 
'executive-config.h' file. A sample version of this file is provided 
in the executive directory as 'executive-config.h.template'.  

Copy this file to 'executive-config.h' into the 'config' subdirectory 
of the application directory and customize as required by the application. 
Applications that don't use any simple executive functionality can omit 
the cvmx-config.h header file. Please refer to the examples for a 
demonstration of where to put the executive-config.h file and for an
example of generated cvmx-config.h.

For file specific information please see the documentation within the 
source files or the HTML documentation provided in docs/html/index.html.
The HTML documentation is automatically generated by Doxygen from the 
source files.



==========================================================================
Please see the release notes for version specific information.