README

/*
 * Copyright 2008 Sony Corporation of America
 *
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

MARS Sources README


-- Future releases and other information for MARS:

   ftp://ftp.infradead.org/pub/Sony-PS3/mars/

-- Source repository for MARS:

   git://git.infradead.org/ps3/mars-src.git

-- Send bug reports and other MARS inquiries to the cbe-oss-dev mailing list:

   cbe-oss-dev@ozlabs.org
   https://ozlabs.org/mailman/listinfo/cbe-oss-dev


Overview
========

Please read the README in each sub-directory for more specific details.

/mars-src
|
|---/scripts		Build configuration scripts
|
|---/base		Sources to build MARS base libraries.
|
|---/task		Sources to build MARS task libraries.
|
|---/doxygen		Sources to build MARS documentation.
|
|---/samples		Sources to build MARS samples.
|
|---/tests		Sources to build MARS tests.


Building
========

* See the source file INSTALL for generic build info.

* The configure scripts require the option --with-mars-platform.  Currently,
only the Cell Broadband Engine (--with-mars-platfrom=cell) is supported.

* Use the prefixes PPU_ and SPU_ on command line variables to the top level
configure to specify variables for the different Cell toolchains.

* When building 64-bit libraries for a powerpc host it is customary to use
the --libdir configure option to install the libraries in a EPREFIX/lib64
directory.  Run configure with the --help option for more info.

For example, when using the Cell SDK toolchains use options similar to these:

32-bit powerpc host
-------------------
  ./configure \
    --with-mars-platform=cell SPU_CC=spu-gcc PPU_CC=ppu-gcc PPU_CFLAGS=-m32

64-bit powerpc host
-------------------
  ./configure \
    --libdir="/usr/lib64" \
    --with-mars-platform=cell SPU_CC=spu-gcc PPU_CC=ppu-gcc PPU_CFLAGS=-m64

Note:
	The configure options above may vary based on Linux distribution or Cell
	toolchain.

	For example, Gentoo on PS3 might use options similar to:

  ./configure --with-mars-platform=cell SPU_CC=spu-elf-gcc SPU_AR=spu-elf-ar