git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/FreeTCPIP/net/lc.h

   1 /*\r
   2  * Copyright (c) 2004-2005, Swedish Institute of Computer Science.\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without\r
   6  * modification, are permitted provided that the following conditions\r
   7  * are met:\r
   8  * 1. Redistributions of source code must retain the above copyright\r
   9  *    notice, this list of conditions and the following disclaimer.\r
  10  * 2. Redistributions in binary form must reproduce the above copyright\r
  11  *    notice, this list of conditions and the following disclaimer in the\r
  12  *    documentation and/or other materials provided with the distribution.\r
  13  * 3. Neither the name of the Institute nor the names of its contributors\r
  14  *    may be used to endorse or promote products derived from this software\r
  15  *    without specific prior written permission.\r
  16  *\r
  17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND\r
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\r
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE\r
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT\r
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY\r
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF\r
  27  * SUCH DAMAGE.\r
  28  *\r
  29  * This file is part of the uIP TCP/IP stack\r
  30  *\r
  31  * Author: Adam Dunkels <adam@sics.se>\r
  32  *\r
  33  * $Id: lc.h,v 1.2 2006/06/12 08:00:30 adam Exp $\r
  34  */\r
  35 \r
  36 /**\r
  37  * \addtogroup pt\r
  38  * @{\r
  39  */\r
  40 \r
  41 /**\r
  42  * \defgroup lc Local continuations\r
  43  * @{\r
  44  *\r
  45  * Local continuations form the basis for implementing protothreads. A\r
  46  * local continuation can be <i>set</i> in a specific function to\r
  47  * capture the state of the function. After a local continuation has\r
  48  * been set can be <i>resumed</i> in order to restore the state of the\r
  49  * function at the point where the local continuation was set.\r
  50  *\r
  51  *\r
  52  */\r
  53 \r
  54 /**\r
  55  * \file lc.h\r
  56  * Local continuations\r
  57  * \author\r
  58  * Adam Dunkels <adam@sics.se>\r
  59  *\r
  60  */\r
  61 \r
  62 #ifdef DOXYGEN\r
  63 /**\r
  64  * Initialize a local continuation.\r
  65  *\r
  66  * This operation initializes the local continuation, thereby\r
  67  * unsetting any previously set continuation state.\r
  68  *\r
  69  * \hideinitializer\r
  70  */\r
  71 #define LC_INIT(lc)\r
  72 \r
  73 /**\r
  74  * Set a local continuation.\r
  75  *\r
  76  * The set operation saves the state of the function at the point\r
  77  * where the operation is executed. As far as the set operation is\r
  78  * concerned, the state of the function does <b>not</b> include the\r
  79  * call-stack or local (automatic) variables, but only the program\r
  80  * counter and such CPU registers that needs to be saved.\r
  81  *\r
  82  * \hideinitializer\r
  83  */\r
  84 #define LC_SET(lc)\r
  85 \r
  86 /**\r
  87  * Resume a local continuation.\r
  88  *\r
  89  * The resume operation resumes a previously set local continuation, thus\r
  90  * restoring the state in which the function was when the local\r
  91  * continuation was set. If the local continuation has not been\r
  92  * previously set, the resume operation does nothing.\r
  93  *\r
  94  * \hideinitializer\r
  95  */\r
  96 #define LC_RESUME(lc)\r
  97 \r
  98 /**\r
  99  * Mark the end of local continuation usage.\r
 100  *\r
 101  * The end operation signifies that local continuations should not be\r
 102  * used any more in the function. This operation is not needed for\r
 103  * most implementations of local continuation, but is required by a\r
 104  * few implementations.\r
 105  *\r
 106  * \hideinitializer\r
 107  */\r
 108 #define LC_END(lc)\r
 109 \r
 110 /**\r
 111  * \var typedef lc_t;\r
 112  *\r
 113  * The local continuation type.\r
 114  *\r
 115  * \hideinitializer\r
 116  */\r
 117 #endif /* DOXYGEN */\r
 118 \r
 119 #ifndef __LC_H__\r
 120 #define __LC_H__\r
 121 \r
 122 #ifdef LC_CONF_INCLUDE\r
 123 #include LC_CONF_INCLUDE\r
 124 #else\r
 125 #include "lc-switch.h"\r
 126 #endif /* LC_CONF_INCLUDE */\r
 127 \r
 128 #endif /* __LC_H__ */\r
 129 \r
 130 /** @} */\r
 131 /** @} */\r