cpu/z80/mtarch.h

   1 /*
   2  * Copyright (c) 2007, Takahide Matsutsuka.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above
  11  *    copyright notice, this list of conditions and the following
  12  *    disclaimer in the documentation and/or other materials provided
  13  *    with the distribution.
  14  * 3. The name of the author may not be used to endorse or promote
  15  *    products derived from this software without specific prior
  16  *    written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
  19  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  24  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  26  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  27  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  */
  31  /*
  32   * \file
  33   *     Z80 machine-specific difinitions for supporting multithread.
  34   *
  35   * \author
  36   *     Takahide Matsutsuka <markn@markn.org>
  37   */
  38 #ifndef __MTARCH_H__
  39 #define __MTARCH_H__
  40
  41 /* Unit of the stack is 2byte wide. */
  42 #ifndef MTARCH_STACKSIZE
  43 #define MTARCH_STACKSIZE 128
  44 #endif /* MTARCH_STACKSIZE */
  45
  46 struct mtarch_thread {
  47   /*
  48    * On top of the mtarch_thread must be the address for the stack pointer.
  49    * See details at mtarch_switch in mtarch.c
  50    */
  51   u16_t *sp;
  52   /*
  53    * Stack is 2-byte wide, so please note that you need 2 * MTARCH_STACKSIZE
  54    * bytes for the stack area for each thread.
  55    */
  56   u16_t stack[MTARCH_STACKSIZE];
  57 };
  58
  59 /*
  60  * A function for debugging purpose, placed here by following other implementations.
  61  */
  62 int mtarch_stack_usage(struct mtarch_thread *t);
  63
  64 #endif /* __MTARCH_H__ */
  65