hw_serial.h

toppers操作系统源码

/*
 *  TOPPERS/JSP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Just Standard Profile Kernel
 *
 *  Copyright (C) 2000-2004 by Embedded and Real-Time Systems Laboratory
 *                              Toyohashi Univ. of Technology, JAPAN
 *  Copyright (C) 2001-2004 by Industrial Technology Institute,
 *                              Miyagi Prefectural Government, JAPAN
 *  Copyright (C) 2001-2004 by Dep. of Computer Science and Engineering
 *                   Tomakomai National College of Technology, JAPAN
 *
 *  惧淡螟侯涪荚は·笆布の (1)×(4) の掘凤か·Free Software Foundation
 *  によって给山されている GNU General Public License の Version 2 に淡
 *  揭されている掘凤を塔たす眷圭に嘎り·塑ソフトウェア∈塑ソフトウェア
 *  を猖恃したものを崔むˉ笆布票じ∷を蝗脱ˇ剩澜ˇ猖恃ˇ浩芹邵∈笆布·
 *  网脱と钙ぶ∷することを痰浸で钓满するˉ
 *  (1) 塑ソフトウェアをソ〖スコ〖ドの妨で网脱する眷圭には·惧淡の螟侯
 *      涪山绩·この网脱掘凤および布淡の痰瘦沮惮年が·そのままの妨でソ〖
 *      スコ〖ド面に崔まれていることˉ
 *  (2) 塑ソフトウェアを·ライブラリ妨及など·戮のソフトウェア倡券に蝗
 *      脱できる妨で浩芹邵する眷圭には·浩芹邵に燃うドキュメント∈网脱
 *      荚マニュアルなど∷に·惧淡の螟侯涪山绩·この网脱掘凤および布淡
 *      の痰瘦沮惮年を非很することˉ
 *  (3) 塑ソフトウェアを·怠达に寥み哈むなど·戮のソフトウェア倡券に蝗
 *      脱できない妨で浩芹邵する眷圭には·肌のいずれかの掘凤を塔たすこ
 *      とˉ
 *    (a) 浩芹邵に燃うドキュメント∈网脱荚マニュアルなど∷に·惧淡の螟
 *        侯涪山绩·この网脱掘凤および布淡の痰瘦沮惮年を非很することˉ
 *    (b) 浩芹邵の妨轮を·侍に年める数恕によって·TOPPERSプロジェクトに
 *        鼠桂することˉ
 *  (4) 塑ソフトウェアの网脱により木儡弄または粗儡弄に栏じるいかなる禄
 *      巢からも·惧淡螟侯涪荚およびTOPPERSプロジェクトを倘勒することˉ
 *
 *  塑ソフトウェアは·痰瘦沮で捏丁されているものであるˉ惧淡螟侯涪荚お
 *  よびTOPPERSプロジェクトは·塑ソフトウェアに簇して·その努脱材墙拉も
 *  崔めて·いかなる瘦沮も乖わないˉまた·塑ソフトウェアの网脱により木
 *  儡弄または粗儡弄に栏じたいかなる禄巢に簇しても·その勒扦を砷わないˉ
 *
 *  @(#) $Id: hw_serial.h,v 1.6 2005/11/13 14:05:01 honda Exp $
 */

#ifndef _HW_SERIAL_H_
#define _HW_SERIAL_H_

/*
 *  タ〖ゲット巴赂シリアルI/Oモジュ〖ル∈H8脱∷
 *    ˇポ〖トが 1塑の眷圭は HWPORT1_ADDRに回年されたポ〖トを蝗脱し、
 *      2塑の眷圭は、HWPORT1_ADDRをユ〖ザ脱、HWPORT2_ADDRをコンソ〖ル
 *      叫蜗として蝗脱する。
 *      HWPORTx_ADDRは タ〖ゲット巴赂の sys_config.h面で回年する。
 *    ˇ鼎奶婶のモジュ〖ルによって、XON/XOFFフロ〖扩告が乖わ
 *      れているので、慨规俐はTxDとRxDの2塑でよい
 */

#include <s_services.h>
#include <h8_sil.h>

#ifndef _MACRO_ONLY

/*
 *  シリアルポ〖トの介袋步ブロック
 */
typedef struct sio_port_initialization_block {
        UB      *base;          /* SCI のベ〖スアドレス */
        UW      baudrate;       /* ボ〖レイト           */
        UB      smr_init;       /* SMR の肋年猛         */
        IRC     irc;            /* 充哈みレベル肋年攫鼠 */
} SIOPINIB;

/*
 *  シリアルポ〖トの扩告ブロック
 */

typedef struct sio_port_control_block {
        const SIOPINIB  *inib;          /* 介袋步ブロック       */
        VP_INT          exinf;          /* 橙磨攫鼠             */
        BOOL            openflag;       /* オ〖プン貉みフラグ   */
} SIOPCB;

extern SIOPCB siopcb_table[TNUM_PORT];

/*
 *  SIO ID から瓷妄ブロックへの恃垂
 */
#define INDEX_SIO(sioid)        ((UINT)(sioid) - 1u)

Inline SIOPCB *get_siopcb(ID sioid);

Inline SIOPCB*
get_siopcb(ID sioid)
{
	UINT index = INDEX_SIO(sioid);
	
	assert(index < TNUM_PORT);
	
    return(&(siopcb_table[index]));
}

/*
 *  コ〖ルバックル〖チンの急侍戎规
 */
#define SIO_ERDY_SND            1u              /* 流慨材墙コ〖ルバック                 */
#define SIO_ERDY_RCV            2u              /* 减慨奶梦コ〖ルバック                 */

/*
 *  SCI 簇眶の徊救
 */
extern void     SCI_initialize (ID sioid);      /* SCI の介袋步                         */
extern void     SCI_cls_por(UB *base);          /* SCI のクロ〖ズ                       */
extern void     SCI_in_handler(ID sioid);       /* SCI 掐蜗充り哈みハンドラ             */
extern void     SCI_out_handler(ID sioid);      /* SCI 叫蜗充り哈みハンドラ             */
extern void     SCI_err_handler(ID sioid);      /* SCI 掐蜗エラ〖充り哈みハンドラ       */
extern void     SCI_ierdy_snd(VP_INT exinf);    /* シリアル I/O からの流慨材墙コ〖ルバック */
extern void     SCI_ierdy_rcv(VP_INT exinf);    /* シリアル I/O からの减慨奶梦コ〖ルバック */

/*
 *  SCI レベルの簇眶
 */

/*
 *  インライン簇眶のプロトタイプ离咐
 */
Inline SIOPCB *SCI_opn_por(ID sioid);
Inline void SCI_putchar(const SIOPCB *p, UB c);
Inline void SCI_putchar_pol(UB c);
Inline INT SCI_getchar(const SIOPCB *p);
Inline BOOL SCI_putready(const SIOPCB *pcb);
Inline BOOL SCI_getready(const SIOPCB *pcb);
Inline void SCI_enable_send(const SIOPCB *p);
Inline void SCI_disable_send(const SIOPCB *p);
Inline void SCI_enable_recv(const SIOPCB *p);
Inline void SCI_disable_recv(const SIOPCB *p);

/*
 *  SCI のオ〖プン
 */
Inline SIOPCB *
SCI_opn_por (ID sioid)
{
        SCI_initialize(sioid);
        return get_siopcb(sioid);
}

/*
 *  SCI_putchar -- 流慨する矢机の今き哈み
 */
Inline void
SCI_putchar(const SIOPCB *p, UB c)
{
        UB *base_addr = p->inib->base;

        sil_wrb_mem((VP)(base_addr + H8TDR), (VB)c);
        bitclr(base_addr + H8SSR, (UB)H8SSR_TDRE_BIT);
}


/*
 *  你レベル叫蜗に脱いるシリアルポ〖トを
 *  扩告するレジスタ凡の黎片アドレス
 */
#if SCI_LOW_PORTID == SCI_PORTID1
#define SCI_LOW_BASE			SCI_PORT1_BASE
#else /* SCI_LOW_PORTID == SCI_PORTID1 */
#define SCI_LOW_BASE			SCI_PORT2_BASE
#endif

/*
 *  SCI_putchar_pol -- ポ〖リング数及による你レベル叫蜗
 */
Inline void
SCI_putchar_pol(UB c)
{
        UB *base = (UB*)SCI_LOW_BASE;
        UB *addr = base + H8SSR;
        UB tdre = 0;

        /* TDREがセットされるまで略つ */
        while (tdre == 0) {
			/*  コンパイラの焚桂を娃扩するため、キャストしている  */
			tdre = (UB)((UB)sil_reb_mem((VP)addr) & H8SSR_TDRE);
		}
        sil_wrb_mem((VP)(base + H8TDR), (VB)c);
        bitclr(addr, (UB)H8SSR_TDRE_BIT);
}

/*
 *  SCI_getchar -- 减慨した矢机の粕み叫し
 */
Inline INT
SCI_getchar(const SIOPCB *p)
{
        UB      *base_addr = p->inib->base;
        INT     ch = (UB)sil_reb_mem((VP)(base_addr + H8RDR));
                /* UB のキャストは、射规橙磨を松贿するため */

        bitclr(base_addr + H8SSR, (UB)H8SSR_RDRF_BIT);
        return ch;
}

/*
 *  SCI_putready -- 流慨材墙か
 */
Inline BOOL
SCI_putready(const SIOPCB *pcb)
{
        BOOL ret = TRUE;
        UB ssr = sil_reb_mem((VP)(pcb->inib->base + H8SSR));
        
        ssr &= (UB)H8SSR_TDRE;
        if (ssr == 0) {
			ret = FALSE;
		}
        return(ret);
}

/*
 *  SCI_getready -- 减慨材墙か
 */
Inline BOOL
SCI_getready(const SIOPCB *pcb)
{
        BOOL ret = TRUE;
        UB ssr = sil_reb_mem((VP)(pcb->inib->base + H8SSR));

        ssr &= (UB)H8SSR_RDRF;
        if (ssr == 0) {
			ret = FALSE;
		}
        return(ret);
}

/*
 *  流慨充り哈み扩告簇眶
 */
Inline void
SCI_enable_send(const SIOPCB *p)
{
        UB *addr = p->inib->base + H8SCR;
        bitset(addr, (UB)H8SCR_TIE_BIT);
}

Inline void
SCI_disable_send(const SIOPCB *p)
{
        UB *addr = p->inib->base + H8SCR;
        bitclr(addr, (UB)H8SCR_TIE_BIT);
}

/*
 *  减慨充り哈み扩告簇眶
 */
Inline void
SCI_enable_recv(const SIOPCB *p)
{
        UB *addr = p->inib->base + H8SCR;
        bitset(addr, (UB)H8SCR_RIE_BIT);
}

Inline void
SCI_disable_recv(const SIOPCB *p)
{
        UB *addr = p->inib->base + H8SCR;
        bitclr(addr, (UB)H8SCR_RIE_BIT);
}

/*
 *  SIO 簇眶の徊救
 */
                                /* SCI の介袋步                         */
extern void     sio_initialize(void);
                                /* シリアル I/O からのコ〖ルバック钓材  */
extern void     sio_ena_cbr(SIOPCB *pcb, UINT cbrtn);
                                /* シリアル I/O からのコ〖ルバック敦贿  */
extern void     sio_dis_cbr(SIOPCB *pcb, UINT cbrtn);

/*
 *  簇眶シミュレ〖ションマクロ
 */

                        /* SCI からの矢机减慨                           */
#define sio_snd_chr(p,c)        SCI_snd_chr(p,c)
                        /* SCI からの矢机减慨                           */
#define sio_rcv_chr(p)          SCI_rcv_chr(p)
                        /* シリアル I/O からの流慨材墙コ〖ルバック      */
#define sio_ierdy_snd(e)        SCI_ierdy_snd(e)
                        /* シリアル I/O からの减慨奶梦コ〖ルバック      */
#define sio_ierdy_rcv(e)        SCI_ierdy_rcv(e)

/*
 *  SIO レベルの簇眶
 */

extern void sio_in_handler (void);
extern void sio_out_handler (void);

#ifdef H8_CFG_SCI_ERR_HANDLER
extern void sio_err_handler (void);
#endif  /* of #ifdef H8_CFG_SCI_ERR_HANDLER */

#if TNUM_PORT >= 2u
extern void sio_in2_handler (void);
extern void sio_out2_handler (void);

#ifdef H8_CFG_SCI_ERR_HANDLER
extern void sio_err2_handler (void);
#endif  /* of #ifdef H8_CFG_SCI_ERR_HANDLER */

#endif  /* of #if TNUM_PORT >= 2u */

/*
 *  インライン簇眶のプロトタイプ离咐
 */
Inline SIOPCB *sio_opn_por(ID sioid, VP_INT exinf);
Inline void sio_cls_por(SIOPCB *pcb);
Inline BOOL sio_snd_chr(const SIOPCB *pcb, INT chr);
Inline INT sio_rcv_chr(const SIOPCB *pcb);

/*
 *  sio_opn_por -- ポ〖トのオ〖プン
 */
Inline SIOPCB *
sio_opn_por(ID sioid, VP_INT exinf)
{
        SIOPCB  *pcb = SCI_opn_por(sioid);

        pcb->exinf    = exinf;
        pcb->openflag = TRUE;
        return pcb;
}

/*
 *  sio_cls_por -- ポ〖トのクロ〖ズ
 */
Inline void
sio_cls_por(SIOPCB *pcb)
{
        SCI_cls_por(pcb->inib->base);
        pcb->openflag = FALSE;
}

/*
 *  sio_snd_chr -- 矢机流慨
 */
Inline BOOL
sio_snd_chr(const SIOPCB *pcb, INT chr)
{
        BOOL ret = FALSE;
        if (SCI_putready(pcb) == TRUE) {
                SCI_putchar(pcb, (UB)chr);
                ret = TRUE;
        }
        return ret;
}

/*
 *  sio_rcv_chr -- 矢机减慨
 */
Inline INT
sio_rcv_chr(const SIOPCB *pcb)
{
        INT ret = 0;
        if (SCI_getready(pcb) == TRUE) {
                ret = SCI_getchar(pcb);
        } else {
                ret = -1;
        }
        return(ret);
}

#endif  /* of #ifndef _MACRO_ONLY */

#endif /* _HW_SERIAL_H_ */