source: rubycfg_asp/trunk/asp_dcre/pdic/rx600/rx630_uart.c@ 313

/*
 *  TOPPERS/ASP Kernel
 *      Toyohashi Open Platform for Embedded Real-Time Systems/
 *      Advanced Standard Profile Kernel
 * 
 *  Copyright (C) 2008-2010 by Witz Corporation, JAPAN
 *  Copyright (C) 2013      by Mitsuhiro Matsuura
 * 
 *  上記著作権者
は，以下の(1)～(4)ã®æ¡ä»¶ã‚’æº€ãŸã™å ´åˆã«é™ã‚Šï¼Œæœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§
 *  ア（本ソフトウェアを改変したものを含む．以下同じ）を使用・複製・改
 *  変・再é…
å¸ƒï¼ˆä»¥ä¸‹ï¼Œåˆ©ç”¨ã¨å‘¼ã¶ï¼‰ã™ã‚‹ã“とを無償で許諾する．
 *  (1) æœ¬ã‚½ãƒ•ãƒˆã‚¦ã‚§ã‚¢ã‚’ã‚½ãƒ¼ã‚¹ã‚³ãƒ¼ãƒ‰ã®å½¢ã§åˆ©ç”¨ã™ã‚‹å ´åˆã«ã¯ï¼Œä¸Šè¨˜ã®è‘—ä½œ
 *      権表示，この利用条件および下記の無保証規定が，そのままの形でソー
 *      スコード中に含まれていること．
 *  (2) 本ソフトウェアを，ライブラリ形式など，他のソフトウェア開発に使
 *      用できる形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œå†é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨
 *      者
マニュアルなど）に，上記の著作権表示，この利用条件および下記
 *      の無保証規定を掲載すること．
 *  (3) 本ソフトウェアを，機器に組み込むなど，他のソフトウェア開発に使
 *      用できない形で再é…
å¸ƒã™ã‚‹å ´åˆã«ã¯ï¼Œæ¬¡ã®ã„ずれかの条件を満たすこ
 *      と．
 *    (a) 再é…
å¸ƒã«ä¼´ã†ãƒ‰ã‚­ãƒ¥ãƒ¡ãƒ³ãƒˆï¼ˆåˆ©ç”¨è€…
マニュアルなど）に，上記の著
 *        作権表示，この利用条件および下記の無保証規定を掲載すること．
 *    (b) 再é…
å¸ƒã®å½¢æ…
‹ã‚’，別に定める方法によって，TOPPERSプロジェクトに
 *        å ±å‘Šã™ã‚‹ã“ã¨ï¼Ž
 *  (4) 本ソフトウェアの利用により直接的または間接的に生じるいかなる損
 *      害からも，上記著作権者
およびTOPPERSプロジェクトをå…
è²¬ã™ã‚‹ã“と．
 *      また，本ソフトウェアのユーザまたはエンドユーザからのいかなる理
 *      由に基づく請求からも，上記著作権者
およびTOPPERSプロジェクトを
 *      å…
è²¬ã™ã‚‹ã“と．
 * 
 *  本ソフトウェアは，無保証で提供されているものである．上記著作権者
お
 *  よびTOPPERSプロジェクトは，本ソフトウェアに関して，特定の使用目的
 *  に対する適合性も含めて，いかなる保証も行わない．また，本ソフトウェ
 *  アの利用により直接的または間接的に生じたいかなる損害に関しても，そ
 *  ã®è²¬ä»»ã‚’è² ã‚ãªã„ï¼Ž
 * 
 *  @(#) $Id: rx630_uart.c 313 2017-07-23 04:50:32Z coas-nagasima $
 */


/*
 * UART用 簡易SIOドライバ
 */

#include <sil.h>
#include <kernel.h>
#include <t_syslog.h>
#include "target_syssvc.h"
#include "rx630_uart.h"

/* シリアルモードレジスタ（SMR) */
#define CKS                     UINT_C(0x03)
#define STOP            UINT_C(0x08)
#define PM                      UINT_C(0x10)
#define PE                      UINT_C(0x20)
#define CHR                     UINT_C(0x40)
#define CM                      UINT_C(0x80)
#define ASYNC_7BIT      UINT_C(0x00)
#define ASYNC_8BIT      UINT_C(0x40)

/* シリアルコントロールレジスタ（SCR) */
#define CKE                     UINT_C(0x03)
#define TEIE            UINT_C(0x04)
#define RE                      UINT_C(0x10)
#define TE                      UINT_C(0x20)
#define RIE                     UINT_C(0x40)
#define TIE                     UINT_C(0x80)

/* シリアルステータスレジスタ（SSR） */
#define TEND            UINT_C(0x04)
#define PER                     UINT_C(0x08)
#define FER                     UINT_C(0x10)
#define ORER            UINT_C(0x20)

/* シリアル拡張モードレジスタ（SEMR) */
#define ACS0            UINT_C(0x01)
#define ABCS            UINT_C(0x10)

#define SCI_SCR_FLG_ENABLE      (RE | TE)
#define SCI_SMR_FLG_ENABLE      (STOP | PM | PE | CHR | CM)

/*
 *  シリアルI/Oポート初期化ブロックの定義
 */
typedef struct sio_port_initialization_block {
        volatile uint8_t        *ctlreg;                /* シリアルコントロールレジスタ（SCR) */
        volatile uint8_t        *modereg;               /* シリアルモードレジスタ（SMR) */
        volatile uint8_t        *extmodereg;    /* シリアル拡張モードレジスタ（SEMR) */   
        volatile uint8_t        *statusreg;             /* シリアルステータスレジスタ（SSR） */
        volatile uint8_t        *tdreg;                 /* トランスミットデータレジスタ（TDR)*/
        volatile uint8_t        *rdreg;                 /* レシーブデータレジスタ（RDR) */
        volatile uint8_t        *bitratereg;    /* ビットレートレジスタ（BRR) */
        volatile uint32_t       *mstpcrreg;             /* モジュールストップコントロールレジスタ（MSTPCR） */
        volatile uint8_t        *ssrreg;                /* ステータスレジスタ */
        volatile uint8_t        *rxiirreg;              /* RXI用割込み要求レジスタ */
        uint8_t                         tx_intno;               /* 送信（データエンプティ）割り込み番号 */
        uint8_t                         rx_intno;               /* 受信（データフル）割り込み番号 */
        uint8_t                         te_intno;               /* 送信（終了）割り込み番号 */
        uint8_t                         sci_no;                 /* SCIの番号(SCI0～SCI6) */
        uint32_t                        mstpcr_offset;  /* MSTPCRの対応するビットオフセット */
} SIOPINIB;

/*
 *  シリアルI/Oポート管理ブロックの定義
 */
struct sio_port_control_block {
        const SIOPINIB  *p_siopinib;                            /* シリアルI/Oポート初期化ブロック */
        intptr_t        exinf;                                                  /* 拡張情
å ± */
        bool_t          openflag;                                               /* オープン済みフラグ */
        bool_t          sendflag;                                               /* 送信割込みイネーブルフラグ */
        bool_t          getready;                                               /* 文字を受信した状æ…
‹ */
        bool_t          putready;                                               /* 文字を送信できる状æ…
‹ */
        bool_t          is_initialized;                                 /* デバイス初期化済みフラグ */
};

/*
 *  シリアルI/Oポート管理ブロックのエリア
 */
static SIOPCB   siopcb_table[TNUM_SIOP];

/* レジスタテーブル */
static const SIOPINIB siopinib_table[TNUM_SIOP] =
{
        {
                (volatile uint8_t *)SCI0_SCR_ADDR,
                (volatile uint8_t *)SCI0_SMR_ADDR,
                (volatile uint8_t *)SCI0_SEMR_ADDR,
                (volatile uint8_t *)SCI0_SSR_ADDR,
                (volatile uint8_t *)SCI0_TDR_ADDR,
                (volatile uint8_t *)SCI0_RDR_ADDR,
                (volatile uint8_t *)SCI0_BRR_ADDR,
                (volatile uint32_t *)SYSTEM_MSTPCRB_ADDR,
                (volatile uint8_t *)SCI0_SSR_ADDR,
                (volatile uint8_t *)ICU_IR215_ADDR,
                INT_SCI0_TXI,
                INT_SCI0_RXI,
                INT_SCI0_TEI,
                0,
                SYSTEM_MSTPCRB_MSTPB31_BIT,
        } ,                     /* UART0 */
#if TNUM_SIOP > 1
        {
                (volatile uint8_t *)SCI2_SCR_ADDR,
                (volatile uint8_t *)SCI2_SMR_ADDR,
                (volatile uint8_t *)SCI2_SEMR_ADDR,
                (volatile uint8_t *)SCI2_SSR_ADDR,
                (volatile uint8_t *)SCI2_TDR_ADDR,
                (volatile uint8_t *)SCI2_RDR_ADDR,
                (volatile uint8_t *)SCI2_BRR_ADDR,
                (volatile uint32_t *)SYSTEM_MSTPCRB_ADDR,
                (volatile uint8_t *)SCI2_SSR_ADDR,
                (volatile uint8_t *)ICU_IR223_ADDR,
                INT_SCI2_TXI,
                INT_SCI2_RXI,
                INT_SCI2_TEI,
                2,
                SYSTEM_MSTPCRB_MSTPB29_BIT,
        } ,                     /* UART2 */
#endif
};

/*
 *  シリアルI/OポートIDから管理ブロックを取り出すためのマクロ
 */
#define INDEX_SIOP(siopid)       ((uint_t)((siopid) - 1))
#define get_siopcb(siopid)       (&(siopcb_table[INDEX_SIOP(siopid)]))
#define get_siopinib(siopid) (&(siopinib_table[INDEX_SIOP(siopid)]))


/*
 *  SIOドライバのシリアルモードレジスタ(SMR)
 */
static void
rx630_uart_setmode(const SIOPINIB *p_siopinib, uint8_t bitrate, uint8_t clksrc)
{
        volatile uint8_t i;

        /*
         *  SCIドライバの初期化ルーチン
         */

        /*
         *  割り込み要求å…
ˆãƒ¬ã‚¸ã‚¹ã‚¿ã®è¨­å®š(ISELRi)
         *
         *  リセット値と同じ値を設定することになるため,
         *  処理は省略する.
         */

        /*
         *  モジュールストップ機能の設定
         */
        sil_wrh_mem(SYSTEM_PRCR_ADDR, (uint16_t)0xA502);        /* 書込み許可 */
        sil_wrw_mem(p_siopinib->mstpcrreg,
                sil_rew_mem(p_siopinib->mstpcrreg) & ~p_siopinib->mstpcr_offset);
        sil_wrh_mem(SYSTEM_PRCR_ADDR, (uint16_t)0xA500);        /* 書込み禁止 */

        /* 送受信禁止, SCKn端子はå…
¥å‡ºåŠ›ãƒãƒ¼ãƒˆã¨ã—て使用 */
        sil_wrb_mem(p_siopinib->ctlreg, 0x00U);

        /* クロック選択ビット(SMR.CKS[1:0]ビットを設定) */
        sil_wrb_mem(p_siopinib->modereg, 
                                        sil_reb_mem(p_siopinib->modereg) | clksrc);

        /* SMRに送信／ 受信フォーマットを設定) */
        sil_wrb_mem(p_siopinib->modereg, 
                        sil_reb_mem(p_siopinib->modereg) & (~SCI_SMR_FLG_ENABLE));

        /* ビットレートを設定 */
        sil_wrb_mem(p_siopinib->bitratereg, bitrate);

        /* ビット期間(基本クロック16サイクルの期間が1ビット期間となる) */
        for(i = 0; i < 16; i++) { }

        /* 送受信許可 */
        sil_wrb_mem(p_siopinib->ctlreg, 
                (sil_reb_mem(p_siopinib->ctlreg) | SCI_SCR_FLG_ENABLE));
}


/*
 *  SIOドライバの初期化ルーチン
 */
void
rx630_uart_initialize(void)
{
        SIOPCB  *p_siopcb;
        uint_t  i;

        /*
         *  シリアルI/Oポート管理ブロックの初期化
         */
        for (p_siopcb = siopcb_table, i = 0; i < TNUM_SIOP; p_siopcb++, i++){
                p_siopcb->p_siopinib = &(siopinib_table[i]);
                p_siopcb->openflag = false;
                p_siopcb->sendflag = false;
        }
}

/*
 *  カーネル起動時のバナー出力用の初期化
 */
void
rx630_uart_init(ID siopid, uint8_t bitrate, uint8_t clksrc)
{
        SIOPCB          *p_siopcb   = get_siopcb(siopid);
        const SIOPINIB  *p_siopinib = get_siopinib(siopid);
        /*  この時点では、p_siopcb->p_siopinibは初期化されていない  */

        /*  二重初期化の防止  */
        p_siopcb->is_initialized = true;

        /*  ハードウェアの初期化処理と送信許可  */
        rx630_uart_setmode(p_siopinib , bitrate, clksrc);
        sil_wrb_mem(p_siopinib->ctlreg, 
                (uint8_t)(sil_reb_mem((uint8_t *)p_siopinib->ctlreg) | TE));
}

/*
 *  シリアルI/Oポートへのポーリングでの出力
 */
void
rx630_uart_pol_putc(char c, ID siopid)
{
        const SIOPINIB *p_siopinib;

        p_siopinib = get_siopinib(siopid);

        /*
         *  送信レジスタが空になるまで待
つ
         */
        while((sil_reb_mem(p_siopinib->ssrreg) & SCI_SSR_TEND_BIT) == 0U);

        sil_wrb_mem(p_siopinib->tdreg, (uint8_t)c);
}

/*
 *  シリアルI/Oポートのオープン
 */
SIOPCB *
rx630_uart_opn_por
        (ID siopid, intptr_t exinf, uint8_t bitrate, uint8_t clksrc)
{
        SIOPCB          *p_siopcb;
        const SIOPINIB  *p_siopinib;

        p_siopcb = get_siopcb(siopid);
        p_siopinib = p_siopcb->p_siopinib;

        /*
         *  ハードウェアの初期化
         *
         *  æ—¢ã«åˆæœŸåŒ–ã—ã¦ã„ã‚‹å ´åˆã¯, 二重に初期化しない.
         */
        if(!(p_siopcb->is_initialized)){
                rx630_uart_setmode(p_siopinib, bitrate, clksrc);
                p_siopcb->is_initialized = true;
        }

        p_siopcb->exinf = exinf;
        p_siopcb->getready = p_siopcb->putready = false;
        p_siopcb->openflag = true;

        return (p_siopcb);
}

/*
 *  シリアルI/Oポートのクローズ
 */
void
rx630_uart_cls_por(SIOPCB *p_siopcb)
{
        /*
         *  UART停止
         */
        sil_wrh_mem((volatile uint16_t *)p_siopcb->p_siopinib->ctlreg, 0x00U);
        p_siopcb->openflag = false;
        p_siopcb->is_initialized = false;
}

/*
 *  シリアルI/Oポートへの文字送信
 */
bool_t
rx630_uart_snd_chr(SIOPCB *p_siopcb, char c)
{
        bool_t ercd = false;

        if((sil_reb_mem(p_siopcb->p_siopinib->ssrreg) & SCI_SSR_TEND_BIT) != 0){
                sil_wrb_mem(p_siopcb->p_siopinib->tdreg, (uint8_t)c);
                ercd = true;
        }

        return ercd;
}

/*
 *  シリアルI/Oポートからの文字受信
 */
int_t
rx630_uart_rcv_chr(SIOPCB *p_siopcb)
{
        int_t c = -1;

        /*
         *  受信フラグがONのときのみ受信バッファから文字を取得する.
         *  これは, ポーリング受信に対応するためである.
         *  しかし, RX600シリーズでは受信フラグがないこと, システムサービス
         *  では受信割込みの中からしかデータを受信しに来ないことから, 常に
         *  受信バッファから文字を取得する.
         */
        c = (int)(sil_reb_mem(p_siopcb->p_siopinib->rdreg));

        return c;
}

/*
 *  シリアルI/Oポートからのコールバックの許可
 */
void
rx630_uart_ena_cbr(SIOPCB *p_siopcb, uint_t cbrtn)
{
        switch (cbrtn) {
                case SIO_RDY_SND:
                        sil_wrb_mem(p_siopcb->p_siopinib->ctlreg, 
                                (sil_reb_mem(p_siopcb->p_siopinib->ctlreg) | SCI_SCR_TEIE_BIT));
                        break;
                case SIO_RDY_RCV:
                        sil_wrb_mem(p_siopcb->p_siopinib->ctlreg, 
                                (sil_reb_mem(p_siopcb->p_siopinib->ctlreg) | SCI_SCR_RIE_BIT));
                        break;
                default:
                        assert(1);
                        break;
        }
}

/*
 *  シリアルI/Oポートからのコールバックの禁止
 */
void
rx630_uart_dis_cbr(SIOPCB *p_siopcb, uint_t cbrtn)
{
        switch (cbrtn) {
                case SIO_RDY_SND:
                        sil_wrb_mem(p_siopcb->p_siopinib->ctlreg, 
                                (sil_reb_mem(p_siopcb->p_siopinib->ctlreg) & (~SCI_SCR_TEIE_BIT)));
                        break;
                case SIO_RDY_RCV:
                        sil_wrb_mem(p_siopcb->p_siopinib->ctlreg, 
                                (sil_reb_mem(p_siopcb->p_siopinib->ctlreg) & (~SCI_SCR_RIE_BIT)));
                        break;
                default:
                        assert(1);
                        break;
        }
}

/*
 *  SIOの割込みサービスルーチン
 */
void
rx630_uart_tx_isr(ID siopid)
{
        SIOPCB  *p_siopcb = get_siopcb(siopid);

        if((sil_reb_mem(
                (void *)p_siopcb->p_siopinib->ssrreg) & SCI_SSR_TEND_BIT) != 0U){
                /*
                 *  送信可能コールバックルーチンを呼び出す．
                 */
                rx630_uart_irdy_snd(p_siopcb->exinf);
        }
}

void
rx630_uart_rx_isr(ID siopid)
{
        SIOPCB  *p_siopcb = get_siopcb(siopid);

        /*
         *  受信フラグがONのときのみ受信通知コールバックルーチンを呼び出す.
         *  しかし, RX600シリーズでは受信フラグがないため, 常に受信通知
         *  コールバックルーチンを呼び出す.
         *  ここでは受信割込みの発生を信じる.
         */
        /*
         *  受信通知コールバックルーチンを呼び出す．
         */
        rx630_uart_irdy_rcv(p_siopcb->exinf);
}


/*
 *  ポート番号から管理ブロックのå…
ˆé ­ç•ªåœ°ã¸ã®å¤‰æ›
 */
SIOPCB *
rx630_uart_get_siopcb(ID siopid) {
        SIOPCB *p_siopcb = get_siopcb(siopid);
        return(p_siopcb);
}

/*
 * 管理ブロックのå…
ˆé ­ç•ªåœ°ã‹ã‚‰å—信割込み番号への変換
 */
INTNO 
rx630_uart_intno_rx(SIOPCB *p_siopcb) {
        INTNO intno = p_siopcb->p_siopinib->rx_intno;
        return(intno);
}

/*
 * 管理ブロックのå…
ˆé ­ç•ªåœ°ã‹ã‚‰é€ä¿¡å‰²è¾¼ã¿ç•ªå·ã¸ã®å¤‰æ›
 */
INTNO 
rx630_uart_intno_tx(SIOPCB *p_siopcb) {
        INTNO intno = p_siopcb->p_siopinib->te_intno;
        return(intno);
}