rom/exec/preparecontext.c

   1 /*
   2     Copyright © 1995-2010, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: PrepareContext() - Prepare a task context for dispatch.
   6     Lang: english
   7 */
   8
   9 #include <exec/types.h>
  10 #include <exec/execbase.h>
  11 #include <exec/memory.h>
  12 #include <utility/tagitem.h>
  13
  14 /*****i***********************************************************************
  15
  16     NAME */
  17         AROS_LH4(BOOL, PrepareContext,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(VOLATILE struct Task *, task,       A0),
  21         AROS_LHA(APTR,                   entryPoint, A1),
  22         AROS_LHA(APTR,                   fallBack,   A2),
  23         AROS_LHA(struct TagItem *,       tagList,    A3),
  24
  25 /*  LOCATION */
  26         struct ExecBase *, SysBase, 6, Exec)
  27
  28 /*  FUNCTION
  29         Prepare the context (set of registers) for a new task.
  30         The context/stack will be set so that when the entryPoint
  31         function returns, the fallback function will be called.
  32
  33     INPUTS
  34         task            -   Pointer to task
  35         entryPoint      -   Function to call when the new context
  36                             comes alive.
  37         fallBack        -   Address of the function to be called
  38                             when the entryPoint function returns.
  39         tagList         -   Additional options. Like for passing
  40                             arguments to the entryPoint() functions.
  41
  42     RESULT
  43         TRUE on success. FALSE on failure.
  44
  45     NOTES
  46         This function is private and is not meant to be used
  47         by any software. On other operating systems of Amiga(tm) family
  48         it does not exist.
  49
  50         This function is very CPU dependant. In fact it can differ
  51         over different models of the same processor family.
  52
  53     EXAMPLE
  54
  55     BUGS
  56
  57     SEE ALSO
  58         Dispatch()
  59
  60     INTERNALS
  61
  62 ******************************************************************************/
  63 {
  64     AROS_LIBFUNC_INIT
  65
  66     /*
  67      * The actual implementation of this function is CPU-specific.
  68      * Please see files in arch/<cpu>-all/exec/ for working examples.
  69      */
  70     return FALSE;
  71
  72     AROS_LIBFUNC_EXIT
  73 } /* PrepareContext() */