sys/contrib/octeon-sdk/README.txt

   1 Readme for the Octeon Executive Library
   2
   3
   4 The Octeon Executive Library provides runtime support and hardware
   5 abstraction for the Octeon processor.  The executive is composed of the
   6 libcvmx.a library as well as header files that provide
   7 functionality with inline functions.
   8
   9
  10 Usage:
  11
  12 The libcvmx.a library is built for every application as part of the
  13 application build. (Please refer to the 'related pages' section of the
  14 HTML documentation for more information on the build system.)
  15 Applications using the executive should include the header files from
  16 $OCTEON_ROOT/target/include and link against the library that is built in
  17 the local obj directory. Each file using the executive
  18 should include the following two header files in order:
  19
  20 #include "cvmx-config.h"
  21 #include "cvmx.h"
  22
  23 The cvmx-config.h file contains configuration information for the
  24 executive and is generated by the cvmx-config script from an
  25 'executive-config.h' file. A sample version of this file is provided
  26 in the executive directory as 'executive-config.h.template'.
  27
  28 Copy this file to 'executive-config.h' into the 'config' subdirectory
  29 of the application directory and customize as required by the application.
  30 Applications that don't use any simple executive functionality can omit
  31 the cvmx-config.h header file. Please refer to the examples for a
  32 demonstration of where to put the executive-config.h file and for an
  33 example of generated cvmx-config.h.
  34
  35 For file specific information please see the documentation within the
  36 source files or the HTML documentation provided in docs/html/index.html.
  37 The HTML documentation is automatically generated by Doxygen from the
  38 source files.
  39
  40
  41
  42 ==========================================================================
  43 Please see the release notes for version specific information.