%
% Copyright 2014, 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
{tcb_writeregisters}
{TCB - Write Registers}
{Set a thread's registers to the first \texttt{count} fields of a given seL4\_UserContext}
{static inline int seL4\_TCB\_WriteRegisters}
{
\param{seL4\_TCB}{\_service}{\tcbcapdesc}
\param{bool}{resume\_target}{\resumetargetdesc}
\param{uint8\_t}{arch\_flags}{\archflagsdesc}
\param{seL4\_Word}{count}{The number of registers to be set.}
\param{seL4\_UserContext*}{regs}{Data structure containing the new register values.}
}
{\errorenumdesc}
{See \autoref{sec:read_write_registers}}
