doc/doxygen: backport updates from branch mic-scc-merge

doc/doxygen/Makefile.am

@@ -41,6 +41,7 @@ chapters =	\
 	chapters/configure_options.doxy \
 	chapters/fdl-1.3.doxy \
 	chapters/scaling-vector-example.doxy \
+	chapters/mic_scc_support.doxy \
 	chapters/code/hello_pragma2.c \
 	chapters/code/hello_pragma.c \
 	chapters/code/matmul_pragma.c \

doc/doxygen/chapters/environment_variables.doxy

@@ -345,6 +345,31 @@ to 0. It is enabled by default or for any other values of the variable
 \ref STARPU_MPI_CACHE.
 </dd>
 
+<dt>STARPU_MIC_HOST</dt>
+<dd>
+\anchor STARPU_MIC_HOST
+\addindex __env__STARPU_MIC_HOST
+Defines the value of the parameter <c>--host</c> passed to
+<c>configure</c> for the cross-compilation. The current default is
+<c>x86_64-k1om-linux</c>.
+</dd>
+
+<dt>STARPU_MIC_CC_PATH</dt>
+<dd>
+\anchor STARPU_MIC_CC_PATH
+\addindex __env__STARPU_MIC_CC_PATH
+Defines the path to the MIC cross-compiler. The current default is
+<c>/usr/linux-k1om-4.7/bin/</c>
+</dd>
+
+<dt>STARPU_COI_DIR</dt>
+<dd>
+\anchor STARPU_COI_DIR
+\addindex __env__STARPU_COI_DIR
+Defines the path to the COI library. The current default is
+<c>/opt/intel/mic/coi</c>.
+</dd>
+
 </dl>
 
 \section MiscellaneousAndDebug Miscellaneous And Debug

doc/doxygen/chapters/mic_scc_support.doxy

@@ -0,0 +1,56 @@
+/*
+ * This file is part of the StarPU Handbook.
+ * Copyright (C) 2009--2011  Universit@'e de Bordeaux 1
+ * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
+ * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
+ * See the file version.doxy for copying conditions.
+ */
+
+/*! \page MICSCCSupport MIC/SCC Support
+
+\section Compilation Compilation
+
+SCC support just needs the presence of the RCCE library.
+
+MIC support actually needs two compilations of StarPU, one for the host and one for
+the device. The script <c>mic-configure</c> can be used to achieve this: it basically
+calls <c>configure</c> as appropriate from two new directories: <c>build_mic</c> and
+<c>build_host</c>. <c>make</c> and <c>make install</c> can then be used as usual and will
+recurse into both directories.
+
+\internal
+TODO: move to configuration section?
+\endinternal
+
+It can be parameterized with the environment variables \ref
+STARPU_MIC_HOST, \ref STARPU_MIC_CC_PATH and \ref STARPU_COI_DIR.
+
+
+\section PortingApplicationsToMICSCC Porting Applications To MIC/SCC
+
+The simplest way to port an application to MIC/SCC is to set the field
+starpu_codelet::cpu_funcs_name, to provide StarPU with the function
+name of the CPU implementation. StarPU will thus simply use the
+existing CPU implementation (cross-rebuilt in the MIC case). The
+functions have to be globally-visible (i.e. not <c>static</c>) for
+StarPU to be able to look them up.
+
+For SCC execution, the function starpu_initialize() also has to be
+used instead of starpu_init(), so as to pass <c>argc</c> and
+<c>argv</c>.
+
+\section LaunchingPrograms Launching Programs
+
+SCC programs are started through RCCE.
+
+MIC programs are started from the host. StarPU automatically
+starts the same program on MIC devices. It however needs to get
+the MIC-cross-built binary. It will look for the file given by the
+environment variable \ref STARPU_MIC_SINK_PROGRAM_NAME or in the
+directory given by the environment variable \ref
+STARPU_MIC_SINK_PROGRAM_PATH, or in the field
+starpu_config::mic_sink_program_path. It will also look in the current
+directory for the same binary name plus the suffix <c>-mic</c> or
+<c>_mic</c>.
+
+*/

doc/doxygen/refman.tex

@@ -139,6 +139,11 @@ Documentation License”.
 \hypertarget{FFTSupport}{}
 \input{FFTSupport}
 
+\chapter{MIC/SCC Support}
+\label{MICSCCSupport}
+\hypertarget{MICSCCSupport}{}
+\input{MICSCCSupport}
+
 \chapter{C Extensions}
 \label{cExtensions}
 \hypertarget{cExtensions}{}