hirado/kernel/include/serial.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  *  @(#) $Id: serial.h,v 1.1 2009/01/31 05:27:37 suikan Exp $
  37  */
  38
  39 /*
  40  *  シリアルインタフェースドライバ
  41  */
  42
  43 #ifndef _SERIAL_H_
  44 #define _SERIAL_H_
  45
  46 /*
  47  *  シリアルインタフェースドライバの用いるパケット
  48  */
  49 typedef struct {
  50         UINT    reacnt;     /* 受信バッファ中の文字数 */
  51         UINT    wricnt;     /* 送信バッファ中の文字数 */
  52     } T_SERIAL_RPOR;
  53
  54 /*
  55  *  シリアルインタフェースドライバの初期化ルーチン
  56  */
  57 extern void serial_initialize(VP_INT exinf) throw();
  58
  59 /*
  60  *  シリアルインタフェースドライバのサービスコール
  61  */
  62 extern ER   serial_opn_por(ID portid) throw();
  63 extern ER   serial_cls_por(ID portid) throw();
  64 extern ER_UINT  serial_rea_dat(ID portid, char *buf, UINT len) throw();
  65 extern ER_UINT  serial_wri_dat(ID portid, char *buf, UINT len) throw();
  66 extern ER   serial_ctl_por(ID portid, UINT ioctl) throw();
  67 extern ER   serial_ref_por(ID portid, T_SERIAL_RPOR *pk_rpor) throw();
  68
  69 /*
  70  *  シリアルインタフェースドライバの動作制御用のための定数
  71  *
  72  *  以下の定数は，ビット毎に論理和をとって用いる．
  73  */
  74 #define IOCTL_NULL  0u      /* 指定なし */
  75 #define IOCTL_ECHO  0x0001u     /* 受信した文字をエコーバック */
  76 #define IOCTL_CRLF  0x0010u     /* LF を送信する前に CR を付加 */
  77 #define IOCTL_FCSND 0x0100u     /* 送信に対してフロー制御を行う */
  78 #define IOCTL_FCANY 0x0200u     /* どのような文字でも送信再開 */
  79 #define IOCTL_FCRCV 0x0400u     /* 受信に対してフロー制御を行う */
  80
  81 #endif /* _SERIAL_H_ */