hirado/kernel/pdic/simple_sio/uart.h

   1 /*
   2  *  TOPPERS/JSP Kernel
   3  *      Toyohashi Open Platform for Embedded Real-Time Systems/
   4  *      Just Standard Profile Kernel
   5  *
   6  *  Copyright (C) 2000-2003 by Embedded and Real-Time Systems Laboratory
   7  *                              Toyohashi Univ. of Technology, JAPAN
   8  *
   9  *  上記著作権者は，以下の (1)〜(4) の条件か，Free Software Foundation
  10  *  によって公表されている GNU General Public License の Version 2 に記
  11  *  述されている条件を満たす場合に限り，本ソフトウェア（本ソフトウェア
  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  *  本ソフトウェアは，無保証で提供されているものである．上記著作権者お
  32  *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，その適用可能性も
  33  *  含めて，いかなる保証も行わない．また，本ソフトウェアの利用により直
  34  *  接的または間接的に生じたいかなる損害に関しても，その責任を負わない．
  35  *
  36  */
  37
  38 /*
  39  *   ADSP-BF533 UART用 簡易SIOドライバ
  40  *
  41  *   このファイルは、TOPPERS/JSP 1.4.2の pdic/simple_sio/st16c2550.hを
  42  *   リネームし、内部の識別子を変更したものである。
  43  */
  44 #ifndef _UART_H_
  45 #define _UART_H_
  46
  47 #include <t_config.h>
  48
  49 /*
  50  *  シリアルI/Oポート初期化ブロック
  51  */
  52 typedef struct sio_port_initialization_block {
  53     UW reg_base;        /* レジスタのベースアドレス */
  54     UB dlm_val;         /* ボーレート上位の設定値   */
  55     UB dll_val;         /* ボーレート下位の設定値   */
  56     UB set_ucen:1;      /* 1のとき、GCTLのUCENを1にする(ADSP-BF53xのみ) */
  57 } SIOPINIB;
  58
  59 /*
  60  *  シリアルI/Oポート管理ブロック
  61  */
  62 typedef struct sio_port_control_block {
  63     const SIOPINIB  *siopinib; /* シリアルI/Oポート初期化ブロック */
  64     VP_INT          exinf;     /* 拡張情報 */
  65     BOOL    openflag;          /* オープン済みフラグ */
  66     BOOL    sendflag;          /* 送信割込みイネーブルフラグ */
  67     BOOL    getready;          /* 文字を受信した状態 */
  68     BOOL    putready;          /* 文字を送信できる状態 */
  69 }SIOPCB;
  70
  71
  72 /*
  73  *  コールバックルーチンの識別番号
  74  */
  75 #define SIO_ERDY_SND    1u      /* 送信可能コールバック */
  76 #define SIO_ERDY_RCV    2u      /* 受信通知コールバック */
  77
  78
  79 /*
  80  * カーネル起動時用の初期化(sys_putcを使用するため)
  81  */
  82 extern void uart_init(void);
  83
  84 /*
  85  *  シリアルI/Oポートへのポーリングでの出力
  86  */
  87 extern void uart_pol_putc(char c, ID siopid);
  88
  89
  90 /*
  91  *  SIOドライバの初期化ルーチン
  92  */
  93 extern void uart_initialize(void);
  94
  95
  96 /*
  97  *  オープンしているポートがあるか？
  98  */
  99 extern BOOL uart_openflag(void);
 100
 101
 102 /*
 103  *  シリアルI/Oポートのオープン
 104  */
 105 extern SIOPCB   *uart_opn_por(ID siopid, VP_INT exinf);
 106
 107
 108 /*
 109  *  シリアルI/Oポートのクローズ
 110  */
 111 extern void uart_cls_por(SIOPCB *siopcb);
 112
 113
 114 /*
 115  *  シリアルI/Oポートへの文字送信
 116  */
 117 extern BOOL uart_snd_chr(SIOPCB *siopcb, char c);
 118
 119
 120 /*
 121  *  シリアルI/Oポートからの文字受信
 122  */
 123 extern INT  uart_rcv_chr(SIOPCB *siopcb);
 124
 125
 126 /*
 127  *  シリアルI/Oポートからのコールバックの許可
 128  */
 129 extern void uart_ena_cbr(SIOPCB *siopcb, UINT cbrtn);
 130
 131
 132 /*
 133  *  シリアルI/Oポートからのコールバックの禁止
 134  */
 135 extern void uart_dis_cbr(SIOPCB *siopcb, UINT cbrtn);
 136
 137
 138 /*
 139  *  SIOの割込みサービスルーチン
 140  */
 141 extern void uart0_tx_isr(void);
 142 extern void uart0_rx_isr(void);
 143
 144
 145 /*
 146  *  シリアルI/Oポートからの送信可能コールバック
 147  */
 148 extern void uart_ierdy_snd(VP_INT exinf);
 149
 150
 151 /*
 152  *  シリアルI/Oポートからの受信通知コールバック
 153  */
 154 extern void uart_ierdy_rcv(VP_INT exinf);
 155
 156
 157 #endif