１１０．RTC(リアルタイムカウンタ)を使ってみよう (時計編)

110-1. はじめに

110-2. RTCを見てみよう

• 32.768kHzが入力されていて、それを中で128分周して、256Hz単位としている。(32768/128=256)
• カウントレジスタは40bitあって、4,294,967,296秒まで測れるので136年位測れる。(注：2^32=4,294,967,296ね)
• カウンタと一致する値を設定する、マッチレジスタがある。
• カウンタと個別に一致する値を設定する、インディビジュアルマッチレジスタがある。
• それぞれ40bit(5バイト)であるが、読みだすときはまず最下位のバイトを読みだしてから上位を読んでいくこと。
• コントロール/ステータスレジスタがあり、RTCやカウンタ有効などの制御ができる。

110-3. RTCを使った時計の仕様を決定しよう

• 時計は24時間計とする。
• OLEDへの表示は 12:34:56 のように秒まで表示する。
• SW1を押すと時の桁が1秒に1づつカウントアップ、SW2を押すと分の桁が1秒に1づつカウントアップ、SW1,SW2両押しで秒を0にする。
• MSSはRTCとI2C(OLED)だけで構成する。
• FablicはSW1,SW2の読取に使用しする。APBのアドレスはFabliceエリアの最初(最下位)、ビット割り当てはbit0にSW1、bit4にSW2を割り当てる。リードオンリーとし、ライトした場合は何もしない。
• リアルタイムカウンタの値を読み取り、ARMで計算で時分秒に変換しI2CによりOLEDに書きこむ。SW1,SW2の状態もモニタしそれに応じてカウンタの値を更新する。

110-4. MSSを構成しよう

1. LiberoIDEのProject Managerを立ち上げます。
2. Project->New Projectで、Project name:rtc_clock 、 Project location：C:\Actelprj\rtc_clock\rtc_clock 、 Verilog とします。
3. Family:SmartFusion、Die:A2F200M3F、Package:484FBGA 、あとはNext
4. Add Microcontroller Subsystemで、 Design Name:rtc_clock
5. Smart Design MSS Configurater で Fablic Interface と、I2C_0 だけチェックを残し、他はチェックを外します。 （I2C_0を追記 2011/10/30)
6. Clock Management を開いて、PLLの右側の3inセレクタを真中を選択、その横のクロクを20.000MHzに変更、FAB_CLK(GLA1)をチェック
7. Fablic Interfaceを開いて、Interface Type が AMBA APB3、Use Master Interface にチェックを入れ OK
8. Reset Managementを開いて、Enable MSS To Fablic Reset にチェックを入れOK
9. Smart Design MSS Configurater で File->Save rtc_clock 後、Design->Generate。完了したらFile->Exit

110-5. Fabの回路設計をしよう

///////////////////////////////////////////////////////////////////////////////////////////////////
// Company: Shibatchii Denki
//
// File: rtc_clock
// File history:
//      0.2: 2011/12/25: Modify PENABLE
//      0.2: 2011/10/23: Modify reset
//      0.1: 2011/10/09: New
//      : : 
//
// Description:
//
// RTC Clock
//
// Targeted device: SmartFusion A2F200M3F 484FBGA
// Author: @shibatchii
//
///////////////////////////////////////////////////////////////////////////////////////////////////
// このヘッダは Templates の Verilog->Common constructs -> File Header を使用

module rtl_clock(
    PCLK,
    PRESETn,
    PADDR,
    PSELx,
    PENABLE,
    PWRITE,
    PWDATA,
    PREADY,
    PRDATA,
    PSLVERR,
    SW1,
    SW2
);

// --------------------------------------------------------------------------

    // 入力宣言
    input           PCLK;       // クロック。回路で使用する基準クロック入力
    input           PRESETn;    // リセット。最初に回路を初期化する信号
    input   [7:0]   PADDR;      // アドレス。32bit単位アクセスなので下位2ビットは未使用
    input           PSELx;      // セレクト。この回路が選択されたことを示す
    input           PENABLE;    // イネーブル。データ転送期間であることを示す
    input           PWRITE;     // ライト、ライト時1、リード時0
    input   [31:0]  PWDATA;     // ライトデータ、32bitのうち下8bit使用
    input           SW1;        // SW1
    input           SW2;        // SW2入力

    // 出力宣言
    output          PREADY;     // レディ。今回は1固定で使用
    output  [31:0]  PRDATA;     // リードデータ、未使用のビットは0を出力
    output          PSLVERR;    // スレーブエラー。今回は0固定で使用

// --------------------------------------------------------------------------

    // 内部使用信号(reg)
    reg             w_dec_0;    // 0番地リード有効
    reg             r_sw1;      // SW1 リタイミング1
    reg             r_sw2;      // SW2 リタイミング1
    reg             r_sw1d;     // SW1 リタイミング2
    reg             r_sw2d;     // SW2 リタイミング2
    reg             r_sw1dd;    // SW1 出力選択後1
    reg             r_sw2dd;    // SW2 出力選択後

// --------------------------------------------------------------------------

    // 出力接続
    assign  PREADY          =   1'b1;
    assign  PRDATA[31:0]    =   {27'd0,r_sw2dd,3'd0,r_sw1dd};
    assign  PSLVERR         =   1'b0;

// --------------------------------------------------------------------------

    // 入力リタイミング
    always @( posedge PCLK or negedge PRESETn)begin : pr_r_sw
        if(PRESETn==1'b0)begin
            r_sw1 <= 1'b0;
            r_sw2 <= 1'b0;
            r_sw1d <= 1'b0;
            r_sw2d <= 1'b0;
        end
        else
        begin
            r_sw1 <= SW1;
            r_sw2 <= SW2;
            r_sw1d <= r_sw1;
            r_sw2d <= r_sw2;
        end
    end //

    // 0番地リード有効
    always @(
            PADDR
        or  PSELx
        or  PENABLE
        or  PWRITE
    ) begin : pr_w_dec_0
        // アドレス0で、このブロックがセレクト、リードの時
        if((PADDR[7:2] == 6'b0000_00) && (PSELx == 1'b1) && (PWRITE == 1'b0))begin
            w_dec_0 = 1'b1;
        end
        // それ以外
        else
        begin
            w_dec_0 = 1'b0;
        end //
    end


    // 出力有効
    always @( posedge PCLK or negedge PRESETn)begin : pr_r_swdd
        if(PRESETn==1'b0)begin
            r_sw1dd <= 1'b0;
            r_sw2dd <= 1'b0;
        end
        // アドレス0リードの時
        else
        if(w_dec_0 == 1'b1)begin
            r_sw1dd <= r_sw1d;
            r_sw2dd <= r_sw2d;
        end
        // それ以外
        else
        begin
            r_sw1dd <= 1'b0;
            r_sw2dd <= 1'b0;
        end
    end

// --------------------------------------------------------------------------

endmodule
        

1. Project Manager の Project Flow から SmartDesignをクリックします。
2. SmartDesign Compornetで Name: rtc_clk と入れ OK をクリックします。(すでに作成したプロジェクト名と同じだとNGのようです)
3. 左ペーンのDesign Exploreでrtc_clkを左クリック後右クリックし、Set As Root します。rtc_clkが太字になります。
4. 左ペーンのrtc_clock (IPのrtl_clock)をドラッグしてCanvasに持ってきてドロップします。
5. 左ペーンのrtc_clock (RTLのrtl_clock)をドラッグしてCanvasに持ってきてドロップします。
6. 右ペーンのCatalogのCoreタブでBus Interfaces のCareAPB3をドラッグドロップします。
7. Configuring CoreAPB3_0が開きます。
8. 　Direct or Indirect Addressing を Direct Addressing(legacy)にします。
9. 　APB Master Data Bus Width は 32bit
10. 　Enable APB Slave Slots を Slot 0: だけチェックを残し後はチェックを外します。
11. 　APB Slot Sizeは 256 locations にします。
12. 　Testbench:はUserにします。
13. OKをクリックします。
14. 右ペーンのCatalogからBus Definisionsタブを選択します。
15. APB AMBA AMBA2 slave を選択し、真中ペーンのrtl_clock_0 の上にドラッグドロップします。間違えやすいので注意！。
16. Add Bus Interface to [rtl_clock_0]が開くので Signal Map DefinitionのInstanceのSignalの表部分をクリックするとドロップダウンで信号名が開くので、左のBus DefinitionのSignalにあるにあわせていきます。RTLを作成するときにAPBの信号名で作成したので同じ名前のはずです。
17. 設定し終えたらOKで閉じます。
18. 真中ペーンのCanvasで左クリック後右クリックし、AutoConnectを選択します。
19. Modify Memory Mapが開きます。今回は1モジュールだけなのでそのままOKします。自動的に配線されたはずです。
20. Canvasで左クリック後右クリックで、Auto Arrange Instances を選びます。きれいに整えられるはずです。
21. Canvasで左クリック後右クリックで、Auto Arrange Connectionsを選びます。Arrangeできれいにならんだので今回は何も変わらないかもしれません。
22. SW1,SW2の接続がまだなので、これを外部ピン(ボード上のSW1,SW2が接続されているピン)に割り当てます。
23. Canvasの灰色の所(インスタンスがある白色では無く、外側)で左クリック後右クリックします。
24. Add Port を選択します。Add New Port が開くので Name:SW1 Direction:Inputにします。SW2も同様にします。
25. ツールバーのSmartDesign->Show I/O Attribute Editor View を開きます。これで各ポートのピン割り当てとか、今回は変更しませんがインターフェース電圧とか指定します。
26. PortNameが3つ示されているはずです。
27. SW1のPin Number をドロップダウンリストからG19を選択します。Use I/O Regもチェックします。
28. SW2のPin Number をドロップダウンリストからG20を選択します。Use I/O Regもチェックします。
29. SW1,SW2の割り当てられいるピンNo.はSmartFusion Evaluation Kit User’s Guide (A2F_EVAL_KIT_UG.pdf)のP17参照です。Use I/O RegはPadのところにあるDFFを使用することを指定します。入力遅延を小さくする事ができます。今回の場合は選択しなくてもあまり影響は無いと思いますが、一応設定しておきます。
30. Canvasの灰色の部分で左クリック後右クリックで、Edit Connectionsを選択します。Gridペーンが開きます。ここで接続まだ接続されていないSW1,SW2の接続関係を指定します。
31. rtl_clock_0 の SW1を横に見て行ってrtc_clkとの交点をクリックしドロップダウンからSW1を選択します。
32. rtl_clock_0 の SW2を横に見て行ってrtl_clkとの交点をクリックしドロップダウンからSW2を選択します。
34. これで接続の指定ができました。PortNameのIのホームベースのような形の所が緑色になりました。
35. Canvasに戻るとSW1,SW2が接続されています。もしされていなかったら、左クリック後右クリックでAuto Connectします。
37. これで接続できたのでCtrl+Sでセーブします。
38. ツールバーのSmartDesign->Check Design Rulesを行なって「Design Rules Check of SmartDesgin "rtc_clk" found no errors and no warning.」となったらOKです。もしエラーがあればCanvasに戻り修正します。
39. Smartdesign->Generate Design を行います。「Design "rtc_clk" was successfully generated.」とでれば完成です。
40. OKで閉じます。

110-6. Cプログラムを設計をしよう

/*
 * main.c
 *
 *  Created on: 2011/11/27
 *      Author: shibatchii
 */
#include "oled.h"
#define DELAY_COUNT   0x01000000
/*==============================================================================
 * main function.
 */
int main()
{
        OLED_init();
        OLED_set_cursor( FIRST_LINE, FIRST_CHARACTER );
        OLED_write_string("12:34:56");  
}

110-7. Cプログラムをコーディング、デバッグしよう

/*
 * main.c
 *
 *  Created on: 2011/11/27
 *  Modify  on: 2011/12/18
 *      Author: shibatchii
 */
#include <stdint.h>
#include <string.h>
#include "oled.h"
#include "drivers/mss_rtc/mss_rtc.h"
#define CHSIZE 16
/*==============================================================================
 * btoa function.
 */
void btoa(char a[3],int b)
{
    a[0] = (b/10)+0x30;
    a[1] = (b%10)+0x30;
    a[2] = (char)0x00;
}
/*==============================================================================
 * main function.
 */
int main()
{
    uint64_t rtc_count_val;
    uint64_t rtc_count_val_old;
    int loop;
    int hour,minute,second;
    char hour_ch[3],minute_ch[3],second_ch[3];
    char time_disp[CHSIZE];

    rtc_count_val = 0ULL;
    rtc_count_val_old = 0ULL;
    for(loop=0;loop<CHSIZE;loop++)time_disp[loop]=(char)0x00;
    OLED_init();
    MSS_RTC_init();
    MSS_RTC_set_rtc_count(0x0000000000000000ULL);
    MSS_RTC_set_rtc_match(0x00000000000000FFULL);
    MSS_RTC_configure( MSS_RTC_NO_COUNTER_RESET );
    MSS_RTC_start();
    loop=0;hour=0;minute=0;second=0;
    for(;;){
        rtc_count_val = MSS_RTC_get_rtc_count();
        if((rtc_count_val&(uint64_t)0xFFFFFFFFFFFFFF00ULL)!=(rtc_count_val_old&(uint64_t)0xFFFFFFFFFFFFFF00ULL)){
            rtc_count_val_old = rtc_count_val;
            if(second==59){
                if(minute==59){
                    if(hour==23){
                        hour=0;
                    }else{
                        hour++;
                    }
                    minute=0;
                }else{
                    minute++;
                }
                second=0;
            }else{
                second++;
            }
            btoa(hour_ch,hour);
            btoa(minute_ch,minute);
            btoa(second_ch,second);
            strcat(time_disp,hour_ch);
            strcat(time_disp,":");
            strcat(time_disp,minute_ch);
            strcat(time_disp,":");
            strcat(time_disp,second_ch);
            strcat(time_disp,"");
            OLED_set_cursor( FIRST_LINE, FIRST_CHARACTER );
            OLED_write_string(time_disp);
            for(loop=0;loop<CHSIZE;loop++)time_disp[loop]=(char)0x00;
        }
    }
    return(0);
}

• 最初の#includeの所で、stdint.hはuint64_tを使用するため。string.hはstrcatを使用するため、oled.hはOLED_*用、mss_rtc.hはMSS_RTC_*用です。
• bota()の関数は、最初 Cの関数である itoa() を使用しようとしたのですが、リンク時にそんな関数無いと言われた(実装されてない)ようなので整数値を2ケタの文字に変換する関数を作成しました。1桁の整数に0x30を加えるとちょうどASCIIの文字に変換できます。
• Main関数の最初は変数宣言と変数初期化、及びOLEDとRTCの初期化を行なっています。
• for(;;)内のループで、RTCからカウンタ値を読み出し、0x100の桁が変化したら時計をカウントアップをさせます。
• if文がネストしている部分は各桁のカウントアップと最大値59秒->0秒、59分->0分、23時->0時への処理です。
• btoa関数で各時分秒を文字に直し、strcatでコロンを挟みながら文字列の時刻にします。
• それをOLEDに表示します。

• SW1を押すと1秒ごとに時の桁がカウントアップします。
• SW2を押すと1秒ごとに分の桁がカウントアップします。
• SW1とSW2を同時に押すと1秒後に秒の桁が00に設定されます。 (最初の仕様にはありませんでしたが、追加してみました。)

/*
 * main.c
 *
 *  Created on: 2011/11/27 // disp only
 *  Modify  on: 2011/12/18 // count up
 *  Modify  on: 2011/12/25 // clock ajust
 *      Author: shibatchii
 */
#include <stdint.h>
#include <string.h>
#include "oled.h"
#include "drivers/mss_rtc/mss_rtc.h"
#define CHSIZE                  16          // キャラクタバッファサイズ
#define FPGA_FABRIC_BASE        0x40050000U // ファブリックベース
#define SW_ADD                  0x00U       // APB SW割り当てアドレス
#define SW1                     0x00000001U // SW1 ビット位置
#define SW2                     0x00000010U // SW2 ビット位置
#define ON                      1           // SW ON
#define OFF                     0           // SW OFF

/*==============================================================================
 * btoa function.
 */
void btoa(char a[3],int b)
{
    a[0] = (b/10)+0x30; // 10の桁
    a[1] = (b%10)+0x30; // 1の桁
    a[2] = (char)0x00;  // 区切り
}
/*==============================================================================
 * main function.
 */
int main()
{
    uint64_t rtc_count_val;     // RTCカウンタ値
    uint64_t rtc_count_val_old; // 1秒前のRTCカウンタ値
    int loop;                   // 初期化用ループ変数
    int hour,minute,second;     // 時、分、秒
    char hour_ch[3],minute_ch[3],second_ch[3];  // 時、分、秒 キャラクタ
    char time_disp[CHSIZE];     // 表示用キャラクタバッファ
    volatile unsigned int* CALC_BASE = (unsigned int*)FPGA_FABRIC_BASE; // ファブリック(FPGA)のベース設定

    // 初期化
    rtc_count_val = 0ULL;
    rtc_count_val_old = 0ULL;
    for(loop=0;loop<CHSIZE;loop++)time_disp[loop]=(char)0x00;
    OLED_init();
    MSS_RTC_init();
    MSS_RTC_set_rtc_count(0x0000000000000000ULL);
    MSS_RTC_set_rtc_match(0x00000000000000FFULL);
    MSS_RTC_configure( MSS_RTC_NO_COUNTER_RESET );
    MSS_RTC_start();
    loop=0;hour=0;minute=0;second=0;
    // 時計ループ
    for(;;){
        rtc_count_val = MSS_RTC_get_rtc_count();
        // 1秒経ったか判定、1秒経った時
        if((rtc_count_val&(uint64_t)0xFFFFFFFFFFFFFF00ULL)!=(rtc_count_val_old&(uint64_t)0xFFFFFFFFFFFFFF00ULL)){
            rtc_count_val_old = rtc_count_val;  // 現在のカウンタ値をセーブ
            // 秒00クリア
            if((((*(CALC_BASE + SW_ADD))&SW1)==0)&&(((*(CALC_BASE + SW_ADD))&SW2)==0)){
                second=0;
            // 時セットの時
            }else if(((*(CALC_BASE + SW_ADD))&SW1)==0){
                // 23時の時は0時へ
                if(hour==23){
                    hour=0;
                // それ以外はカウントアップ
                }else{
                    hour++;
                }
            // 分セットの時
            }else if(((*(CALC_BASE + SW_ADD))&SW2)==0){
                // 59分の時は0分へ
                if(minute==59){
                    minute=0;
                // それ以外はカウントアップ
                }else{
                    minute++;
                }
            // 通常の時計動作
            }else{
                // 59秒の時は0秒へ
                if(second==59){
                    // 59分の時は0分へ
                    if(minute==59){
                        // 23時の時は0時へ
                        if(hour==23){
                            hour=0;
                        // それ以外はカウントアップ
                        }else{
                            hour++;
                        }
                        minute=0;
                    // それ以外はカウントアップ
                    }else{
                        minute++;
                    }
                    second=0;
                // それ以外はカウントアップ
                }else{
                    second++;
                }
            }
            btoa(hour_ch,hour);     // 時をASCIIキャラクタへ
            btoa(minute_ch,minute); // 分をASCIIキャラクタへ
            btoa(second_ch,second); // 秒をASCIIキャラクタへ
            strcat(time_disp,hour_ch);      // 時
            strcat(time_disp,":");          // 区切り
            strcat(time_disp,minute_ch);    // 分
            strcat(time_disp,":");          // 区切り
            strcat(time_disp,second_ch);    // 秒
            strcat(time_disp,"");           // 終端
            OLED_set_cursor( FIRST_LINE, FIRST_CHARACTER ); // OLEDのカーソル位置を設定
            OLED_write_string(time_disp);                   // OLEDへ表示
            for(loop=0;loop<CHSIZE;loop++)time_disp[loop]=(char)0x00;   // バッファ初期化
        }
    }
    return(0);
}

• volatile unsigned int* CALC_BASE = (unsigned int*)FPGA_FABRIC_BASE; でAPBバスに割り当てられたファブリックアドレスを設定。volatileを忘れないように。
• (*(CALC_BASE + SW_ADD))&SW1 でAPBリードによりSW状態を読み出すとともに、 &SW1でSW1の状態のみ判定。SW2も同様。