Merge pull request #136 in SEL4/sel4 from ~AWONDO/sel4:manual/arm-cache to master

* commit 'd2030938':
  Added API documentation for the ARM cache flushing functions.

manual/parts/api.tex

@@ -312,7 +312,10 @@ complete the \apifunc{seL4\_Untyped\_Retype}{untyped_retype} request.
 \label{sec:kobj_api_arm}
 \inputapidoc{arm_asidcontrol_makepool}
 \inputapidoc{arm_asidpool_assign}
-\inputapidoc{arm_page_flushcaches}
+\inputapidoc{arm_page_cleandata}
+\inputapidoc{arm_page_invalidatedata}
+\inputapidoc{arm_page_cleaninvalidatedata}
+\inputapidoc{arm_page_unifyinstruction}
 \inputapidoc{arm_page_map}
 \inputapidoc{arm_page_remap}
 \inputapidoc{arm_page_unmap}

manual/parts/api/arm_page_flushcaches.tex → manual/parts/api/arm_page_cleandata.tex

 %
-% Copyright 2014, General Dynamics C4 Systems
+% Copyright 2016, General Dynamics C4 Systems
 %
 % This software may be distributed and modified according to the terms of
 % the GNU General Public License version 2. Note that NO WARRANTY is provided.
@@ -9,12 +9,15 @@
 %
 
 \apidoc
-{arm_page_flushcaches}
-{ARM Page - Flush Caches}
-{Flush a cache range}
-{static inline int seL4\_ARM\_Page\_FlushCaches}
+{arm_page_cleandata}
+{ARM Page - Clean Data}
+{Cleans the data cache out to RAM. The start and end are relative to the page being serviced.}
+{static inline int seL4\_ARM\_Page\_Clean\_Data}
 {
 \param{seL4\_ARM\_Page}{\_service}{The page whose contents will be flushed.}
+\param{seL4\_Word}{start\_offset}{The offset, relative to the start of the page inclusive.}
+\param{seL4\_Word}{end\_offset}{The offset, relative to the start of the page exclusive.}
 }
 {\errorenumdesc}
 {See \autoref{ch:vspace}}
+

manual/parts/api/arm_page_cleaninvalidatedata.tex

+%
+% Copyright 2016, General Dynamics C4 Systems
+%
+% This software may be distributed and modified according to the terms of
+% the GNU General Public License version 2. Note that NO WARRANTY is provided.
+% See "LICENSE_GPLv2.txt" for details.
+%
+% @TAG(GD_GPL)
+%
+
+\apidoc
+{arm_page_cleaninvalidatedata}
+{ARM Page - Clean and Invalidate Data}
+{Clean and invalidates the cache range within the given page. The range will be flushed out to RAM. The start and end are relative to the page being serviced.}
+{static inline int seL4\_ARM\_Page\_CleanInvalidate\_Data}
+{
+\param{seL4\_ARM\_Page}{\_service}{The page whose contents will be flushed.}
+\param{seL4\_Word}{start\_offset}{The offset, relative to the start of the page inclusive.}
+\param{seL4\_Word}{end\_offset}{The offset, relative to the start of the page exclusive.}
+}
+{\errorenumdesc}
+{See \autoref{ch:vspace}}
+

manual/parts/api/arm_page_invalidatedata.tex

+%
+% Copyright 2016, General Dynamics C4 Systems
+%
+% This software may be distributed and modified according to the terms of
+% the GNU General Public License version 2. Note that NO WARRANTY is provided.
+% See "LICENSE_GPLv2.txt" for details.
+%
+% @TAG(GD_GPL)
+%
+
+\apidoc
+{arm_page_invalidatedata}
+{ARM Page - Invalidate Data}
+{Invalidates the cache range within the given page. The start and end are relative to the page being serviced 
+and should be aligned to a cache line boundary where possible. 
+An additional clean is performed on the outer cache lines if the start and end are 
+not aligned, to clean out the bytes between the requested and the cache line boundary.}
+{static inline int seL4\_ARM\_Page\_Invalidate\_Data}
+{
+\param{seL4\_ARM\_Page}{\_service}{The page whose contents will be flushed.}
+\param{seL4\_Word}{start\_offset}{The offset, relative to the start of the page inclusive.}
+\param{seL4\_Word}{end\_offset}{The offset, relative to the start of the page exclusive.}
+}
+{\errorenumdesc}
+{See \autoref{ch:vspace}}
+

manual/parts/api/arm_page_unifyinstruction.tex

+%
+% Copyright 2016, General Dynamics C4 Systems
+%
+% This software may be distributed and modified according to the terms of
+% the GNU General Public License version 2. Note that NO WARRANTY is provided.
+% See "LICENSE_GPLv2.txt" for details.
+%
+% @TAG(GD_GPL)
+%
+
+\apidoc
+{arm_page_unifyinstruction}
+{ARM Page - Unify Instruction Cache}
+{Unify Instruction Cache. Cleans data lines to point of unification, invalidate 
+corresponding instruction lines to point of unification, then invalidates branch
+predictors. The start and end are relative to the page being
+serviced.}
+{static inline int seL4\_ARM\_Page\_Unify\_Instruction}
+{
+\param{seL4\_ARM\_Page}{\_service}{The page whose contents will be flushed.}
+\param{seL4\_Word}{start\_offset}{The offset, relative to the start of the page inclusive.}
+\param{seL4\_Word}{end\_offset}{The offset, relative to the start of the page exclusive.}
+}
+{\errorenumdesc}
+{See \autoref{ch:vspace}}
+