asp/kernel/dataqueue.h

   1 /*
   2  *  TOPPERS/ASP Kernel
   3  *      Toyohashi Open Platform for Embedded Real-Time Systems/
   4  *      Advanced Standard Profile Kernel
   5  *
   6  *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
   7  *                              Toyohashi Univ. of Technology, JAPAN
   8  *  Copyright (C) 2005-2008 by Embedded and Real-Time Systems Laboratory
   9  *              Graduate School of Information Science, Nagoya Univ., JAPAN
  10  *
  11  *  上記著作権者は，以下の(1)〜(4)の条件を満たす場合に限り，本ソフトウェ
  12  *  ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
  13  *  変・再配布（以下，利用と呼ぶ）することを無償で許諾する．
  14  *  (1) 本ソフトウェアをソースコードの形で利用する場合には，上記の著作
  15  *      権表示，この利用条件および下記の無保証規定が，そのままの形でソー
  16  *      スコード中に含まれていること．
  17  *  (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
  18  *      用できる形で再配布する場合には，再配布に伴うドキュメント（利用
  19  *      者マニュアルなど）に，上記の著作権表示，この利用条件および下記
  20  *      の無保証規定を掲載すること．
  21  *  (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
  22  *      用できない形で再配布する場合には，次のいずれかの条件を満たすこ
  23  *      と．
  24  *    (a) 再配布に伴うドキュメント（利用者マニュアルなど）に，上記の著
  25  *        作権表示，この利用条件および下記の無保証規定を掲載すること．
  26  *    (b) 再配布の形態を，別に定める方法によって，TOPPERSプロジェクトに
  27  *        報告すること．
  28  *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
  29  *      害からも，上記著作権者およびTOPPERSプロジェクトを免責すること．
  30  *      また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
  31  *      由に基づく請求からも，上記著作権者およびTOPPERSプロジェクトを
  32  *      免責すること．
  33  *
  34  *  本ソフトウェアは，無保証で提供されているものである．上記著作権者お
  35  *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
  36  *  に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
  37  *  アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
  38  *  の責任を負わない．
  39  *
  40  *  @(#) $Id: dataqueue.h 748 2008-03-07 17:18:06Z hiro $
  41  */
  42
  43 /*
  44  *              データキュー機能
  45  */
  46
  47 #ifndef TOPPERS_DATAQUEUE_H
  48 #define TOPPERS_DATAQUEUE_H
  49
  50 #include <queue.h>
  51
  52 /*
  53  *  データキュー初期化ブロック
  54  *
  55  *  この構造体は，同期・通信オブジェクトの初期化ブロックの共通部分
  56  *  （WOBJINIB）を拡張（オブジェクト指向言語の継承に相当）したもので，
  57  *  最初のフィールドが共通になっている．
  58  */
  59 typedef struct dataqueue_initialization_block {
  60         ATR                     dtqatr;                 /* データキュー属性 */
  61         uint_t          dtqcnt;                 /* データキューの容量 */
  62         intptr_t        *p_dtqmb;               /* データキュー管理領域の先頭番地 */
  63 } DTQINIB;
  64
  65 /*
  66  *  データキュー管理ブロック
  67  *
  68  *  この構造体は，同期・通信オブジェクトの管理ブロックの共通部分（WOBJCB）
  69  *  を拡張（オブジェクト指向言語の継承に相当）したもので，最初の2つの
  70  *  フィールドが共通になっている．
  71  */
  72 typedef struct dataqueue_control_block {
  73         QUEUE           swait_queue;    /* データキュー送信待ちキュー */
  74         const DTQINIB *p_dtqinib;       /* 初期化ブロックへのポインタ */
  75         QUEUE           rwait_queue;    /* データキュー受信待ちキュー */
  76         uint_t          count;                  /* データキュー中のデータの数 */
  77         uint_t          head;                   /* 最初のデータの格納場所 */
  78         uint_t          tail;                   /* 最後のデータの格納場所の次 */
  79 } DTQCB;
  80
  81 /*
  82  *  データキュー待ち情報ブロックの定義
  83  *
  84  *  この構造体は，同期・通信オブジェクトの待ち情報ブロックの共通部分
  85  *  （WINFO_WOBJ）を拡張（オブジェクト指向言語の継承に相当）したもので，
  86  *  最初の2つのフィールドが共通になっている．
  87  *  データキューへの送信待ちとデータキューからの受信待ちで，同じ待ち情
  88  *  報ブロックを使う．
  89  */
  90 typedef struct dataqueue_waiting_information {
  91         WINFO           winfo;                  /* 標準の待ち情報ブロック */
  92         DTQCB           *p_dtqcb;               /* 待っているデータキューの管理ブロック */
  93         intptr_t        data;                   /* 送受信データ */
  94 } WINFO_DTQ;
  95
  96 /*
  97  *  データキューIDの最大値（kernel_cfg.c）
  98  */
  99 extern const ID tmax_dtqid;
 100
 101 /*
 102  *  データキュー初期化ブロックのエリア（kernel_cfg.c）
 103  */
 104 extern const DTQINIB    dtqinib_table[];
 105
 106 /*
 107  *  データキュー管理ブロックのエリア（kernel_cfg.c）
 108  */
 109 extern DTQCB    dtqcb_table[];
 110
 111 /*
 112  *  データキュー管理ブロックからデータキューIDを取り出すためのマクロ
 113  */
 114 #define DTQID(p_dtqcb)  ((ID)(((p_dtqcb) - dtqcb_table) + TMIN_DTQID))
 115
 116 /*
 117  *  データキュー機能の初期化
 118  */
 119 extern void     initialize_dataqueue(void);
 120
 121 /*
 122  *  データキュー管理領域へのデータの格納
 123  */
 124 extern void     enqueue_data(DTQCB *p_dtqcb, intptr_t data);
 125
 126 /*
 127  *  データキュー管理領域へのデータの強制格納
 128  */
 129 extern void     force_enqueue_data(DTQCB *p_dtqcb, intptr_t data);
 130
 131 /*
 132  *  データキュー管理領域からのデータの取出し
 133  */
 134 extern void     dequeue_data(DTQCB *p_dtqcb, intptr_t *p_data);
 135
 136 /*
 137  *  データキューへのデータ送信
 138  */
 139 extern bool_t   send_data(DTQCB *p_dtqcb, intptr_t data, bool_t *p_reqdsp);
 140
 141 /*
 142  *  データキューへのデータ強制送信
 143  */
 144 extern bool_t   force_send_data(DTQCB *p_dtqcb, intptr_t data);
 145
 146 /*
 147  *  データキューからのデータ受信
 148  */
 149 extern bool_t   receive_data(DTQCB *p_dtqcb, intptr_t *p_data,
 150                                                                                                         bool_t *p_reqdsp);
 151
 152 #endif /* TOPPERS_DATAQUEUE_H */