(C) by T.IZUMI, Sep 2015
Ver. 2017.7.13.a

組込みシステム開発トレーニング課題

Xilinx Zynq による ARM と周辺回路、ソフトウェアの開発サンプル Vivado版

ソースコードを含むアーカイブ一式はこちら： http://www.ritsumei.ac.jp/se/re/izumilab/lecture/15ZyboVivado.zip

ターゲットボードとFPGA

ZYBO & XC7Z010-1CLG400C   (or ZedBoard & XC7Z020-1CLG484C)

• ZYBOで実行する場合はボード定義ファイルをインストールしておくこと。
  https://reference.digilentinc.com/vivado:boardfiles
  このとき古いボード定義ファイル （Xilinx/Vivado/????.?/data/boards/board_parts/zynq/zybo 以下）は 削除すること。
• ZedBoard で実施する場合には以下の ZYBO/zybo を ZedBoard/zedboard に読み替える。
• それ以外のボードでトライする場合は、ボードの仕様に合わせてxdcファイルとトップ記述、およびIP Integrator でのProcessor Systemの設定を書き換えるべし。

ZYBO	ZedBoard
zybo.xdc	zedboard.xdc
zybo_top.v	zedboard_top.v
zybo_test.c	zedboard_test.c
PS-SRST	PS-RST
LD10 DONE	LD12 DONE
PROG UART（１本）	PROG と UART（２本）
BTN3	BTNL
BTN2	BTNR
BTN1	BTNU
BTN0	BTND

開発環境

Xilinx Vivado 2015.2

Xilinx SDK 2015.2

※バージョンは 2014.?, 2015.? であれば詳細は異なってもほぼ同じように設計できるはず

• この課題の習得項目は次の通り。
  • Vivado IP Integrator によるZynq PL+PS 組込みシステムの構築 (without board presets)
  • PL と PL の単純な連携（PS に接続されたPush ButtonでPLに接続されたLEDを光らせる、およびその逆）
  • Xilinx SDK によるソフトウェア開発
  • Zybo (or ZedBoard) による実機動作確認
• この課題は次の項目を習得済みの者を対象とする。
  • 計算機アーキテクチャの基本（プロセッサ、バス、メモリ、レジスタ、Ｉ／Ｏ）
  • Verilog 記述、シミュレーション
  • C言語
  • OS, コンパイラの基本
  • Vivado による RTL 設計の基礎（→推奨）
  • Vivado IP Integrator, SDKの基本操作（→推奨）
  • LED/SW の取扱い
  • UART の取扱い
• この課題終了後には次の課題を推奨する。
  • Zynq での中低速 Stream 接続のサンプルデザイン
  • Zynq での DMA - AXI Stream 接続のサンプルデザイン
  • Vivado HLS によるモジュール設計例
  • Vivado HLS チュートリアル補足版（含Zynq+VivadoHLS）
• 以下、特に指定の無い項目は規定値（デフォルト、最初から入っている値）を設定する。
• Vivado は深くフォルダを掘ってトラブルを起こすので、 課題を実行するフォルダにドライブ文字を割り当てておくとよい。 subst_dir.bat のフォルダ名を変更して実行すると良い。

1. プロジェクトの生成(Vivado)

• Vivado を起動する。 既存のプロジェクトが開いていたら [File] -> [Close Project] する。

1-1. プロジェクト生成

• [File]->[New Project]して New Project Wizard を起動する。
• プロジェクト名と場所を次のように設定する。

  Name                zybotest
  Project Location    例 C:/cygwin/home/t-izumi/ZYBO_Vivado
  

• プロジェクトタイプを「RTL Project」に設定する。
• board を指定する。Zybo を探して選択。 （ボードファイルが無い場合は parts で FPGA デバイスを直接指定する。 XC7Z010-1CLG400C, xc7z020clg484-1 等）
• Finish

1-2. 画面の確認

• 左側 Flow Navigator (B)で、大まかに何をするか指定する。
• 右側 (C)で、各種設定、操作指示、ファイル編集、などを行う。
• 下側 (D)で、ログや状況の確認を行う。
• 見たい画面が行方不明なときのチェックリスト
  • それぞれの領域のタブで切り替える
  • (B)Flow Navigator で対象手順を選択
  • (E)対象のファイル、モジュール、信号などを選択
  • (D)で対象のオブジェクトを選択
  • (A)メインメニューの Window で選択

1-3. ソースファイルの登録

• (A)メインメニュー File, Add Sources を選択。
• (*) Add or create constraints を選択。
• ＋を押下、Add Files を実行、zybo.xdc を登録。
• 同様に、上端メインメニュー File, Add Sources を選択。
• (*) Add or create design sources を選択。
• ＋を押下、Add Files を実行、zybo_top.v, uart.v を登録。
• (C)ウィンドウで Sources タブを選ぶ。
• Design Sources の中に登録したモジュールがあることを確認する。
• ZYBO_top がトップ（太字）になっていることを確認する。
• Constraints の中に zybo.xdc があることを確認する。
• それぞれのモジュールやファイルをダブルクリックすると (E)ウィンドウにファイルが表示されることを確認する。 そこで編集や保存もできる。

2. システム構築(Vivado)

2-1. Block Design の生成と登録

• (B) Flow Navigator の IP Integrator から Create Block Design を実行。
• Design name = Zynq_PS として生成。
• 右側にBlock Design のウィンドウ群が現れる。

2-2. Zynq PS(ARM) の配置と設定

• Diagram ウィンドウ(E)の左側＋ボタンを押下してZYNQ7 Processing Systemを追加。
• Diagram ウィンドウ内の下地を右クリックして[Run Block Automation]を選択、 [Apply Board Preset] にチェックして、[OK]する。
  ※Vivado にボード定義ファイルをインストールした際、 古いボード定義ファイルを削除していないと以下の設定がうまくされない。
• Procesing System のオブジェクトを右クリックし Customize Block を実行。
• 左側 MIO Configuration を選択。
• Bank0 I/O Voltage (LVCMOS3.3V), Bank1 I/O Voltage (LVCMOS1.8V) の設定を確認する。(ZYBO, ZedBoard とも同じ)
• 画面中の Peripheral を展開し、設定を確認する。
• 詳細は ZYBO Reference Manual (ZYBO_RM_B_V6.pdf)や ZedBoard Hardware User's Guide (ZedBoard_HW_UG_v2_2.pdf)を参照。 下図は ZedBoard の例。
• （インポートする定義ファイルが無い場合はボードのマニュアルを確認してここで個別指定する。）
• ここでは特に、実際に使う UART1 (MIO48,49), LED(MIO7), Push Button(MIO50,51) にチェックが入り設定されていることを確認する。 設定されていなければ個別に設定する。 (ZYBO, ZedBoard とも同じ)
• Customize Block 終了。

 MIO Configration
 Bank0 I/O Voltage (LVCMOS3.3V) Bank1 I/O Voltage (LVCMOS1.8V)
 + Memory Interfaces
  +[*] Quad SSPI Flash (MIO1..6)
   +[*] Single SS 4-bit IO
    + Quad SPI Flash .... LVCMOS 3.3V, fast, disabled, ...
 + I/O Peripherals
  +[*] ENET0 (MIO16..27) (UG:p.21 Table15参照)
   +[*] MDIO (MIO52..53)
    MIO52,53 1.8V, slow, dsabled
    MIO16-27 1.8V, fast, dsabled
  +[*] USB0 (MIO28..39)  (UG:p.11 Table5参照)
    MIO28-39 1.8V, fast, dsabled
  +[*] SD0 (MIO40..45)   (UG:p.10 Table4参照)
   +[*] CD (MIO47)
   +[*] WP (MIO46)
    MIO46-47 1.8V, slow, dsabled
    MIO40-45 1.8V, fast, dsabled
  +[*] UART1 (MIO48..49) (UG:p.12 Table6参照)
    MIO48,49 1.8V, slow, dsabled
  + GPIO
   +[*] GPIO MIO         (UG:p.19 Table12, p.20 Table14, p.23 Table16参照)
    MIO0,7,9-15  3.3V, slow, disabled
    MIO8       3.3V, fast, disabled
    MIO50,51     1.8V, slow, disabled
   +[*] ENET Reset (Share reset pin)
   +[*] USB Reset (Share reset pin)
   +[*] I2C Reset
 + Application Processor Unit
  +[*] Timer0 (EMIO)
 Clock Configuration
 + PL Fabric Clocks
 | +[*] FCLK_CLK0 (IO PLL) (100)

2-3. 基本モジュールの配置

• Diagram ウィンドウ(E)の左側＋ボタンを押下してGPIOをふたつ追加。
• Diagram ウィンドウ内の下地で右クリック、Run Connection Automation を実行。 axi_gpio_0 と axi_gpio_1 の S_AXI にチェックし、OK。
• Diagram ウィンドウ内に Processor System Reset, AXI Interconnect が配置され接続されていることを確認。

2-4. プロセッサのクロック、リセットを出力

• Processing System の FCLK_CLK0 を右クリックし、Create Port を実行。 Port name: clko とする。
• Processing System の FCLK_RESET0_N を右クリックし、Create Port を実行。 Port name: rstno とする。

2-5. GPIO の追加

• axi_gpio_0 を右クリックしCustomize Block を実行。[*]Enable Dual Channel をチェックする。
• 同様に axi_gpio_1 を Dual Channel にする。
• 右クリック Customize Block で [*] Enable Dual Channel にチェック（両方）
• axi_gpio_0 モジュールの GPIO インターフェースの＋をクリックして展開
• gpio_io_i[31:0] を右クリック、Make External する。
• 出来た外部ポートを指カーソルで選択し、External Port Propertiesする。
• 左側 External Port Properties 画面(D)で Name: gpi0 に設定
• 以下同様に、インターフェースの展開、外部ポート作成と名前設定を行う
  • axi_gpio_0 の gpio_io_i → gpi0
  • axi_gpio_0 の gpio_io_o → gpo0
  • axi_gpio_0 の gpio2_io_i → gpi1
  • axi_gpio_0 の gpio2_io_o → gpo1
  • axi_gpio_1 の gpio_io_i → gpi2
  • axi_gpio_1 の gpio_io_o → gpo2
  • axi_gpio_1 の gpio2_io_i → gpi3
  • axi_gpio_1 の gpio2_io_o → gpo3

2-6. アドレス空間の設定

• ウィンドウ(E)上部 [Address Editor] タブを開く。
• それぞれの項目を展開して割り当てられているアドレスを確認する。
• Unmapped Slaves があれば右クリックし Auto Assign Address する。

2-7. システム生成

• ウィンドウ(E)上部 [Diagram] タブを開く。
• Diagram 下地で右クリック、Validate Design
• 何か問題があったら警告が出るので対処する
• Flow Navigator(B) の IP Integratorメニュー内 Generate Block Design を実行
• Flow Navigator(B) の Project Manager を選択
• Souces ウィンドウ(C)内、Design Sources の Zynq_PSを展開し、 設計結果が組み込まれていることを確認する。

2-8. 構成の確認

ソースコードzybo_top.vのここ↓を確認して上図のような構成になっていることを理解すること。

        :

   IBUFG ibuf_clk(.I(CLK125M), .O(CLK125M_ibuf));
   BUFG  buf_clk(.I(CLK125M_ibuf),.O(clk0));

        :

   assign 	clk=arm_clko;

        :

   Zynq_PS Zynq_PS_i
     (.DDR_addr(DDR_addr),
        :
      .clko(arm_clko),
      .gpi0(arm_gpi0),
      .gpi1(arm_gpi1),
      .gpi2(arm_gpi2),
      .gpi3(arm_gpi3),
      .gpo0(arm_gpo0),
      .gpo1(arm_gpo1),
      .gpo2(arm_gpo2),
      .gpo3(arm_gpo3),
      .rstno(arm_rstno));

       :

   always @(posedge clk0)
     counter0<=counter0+1;

       :

   always @(posedge clk)
     if (!rstn) counter<=0;
     else counter<=counter+1;

       :

   assign led={btn[3],counter0[24],counter[24],arm_gpo0[0]};

        :

   assign 	arm_gpi0={29'b0,btn2_r,btn1_r,btn0_r};
   assign 	arm_gpi1={28'b0,sw_r};
   assign 	arm_gpi2=counter;
   assign 	arm_gpi3={8'b0,uartrxdata,uartrxcount,uarttxcount};

        :

3. コンパイル(Vivado)

• Flow Navigator領域内、Synthesis の Run Syntehsis を選択、実行。
• Flow Navigator領域内、Implementation の Run Implementation を選択、実行。
• Flow Navigator領域内、Program and Debug の Generate Bitstream を選択、実行。
• 各段階でProject Navigator 領域の右上 Project Summary, 下 Messages, Log, Reports などを確認。
• 必要に応じて、ファイルを編集し再実行。Flow Navigator 領域内左上 Sources でソースファイルを選択し開いて、左上で編集・保存する。

4. プロセッサシステム情報のエクスポート(Vivado)

• 上端メインメニューのFileから、Export → Export Hardware を実行。
• [*] Include bitstream をチェックしてOK。

5. ソフトウェア開発プロジェクトの設定(SDK)

SDK の起動

• Vivado の上端メインメニュー File から Launch SDK する。
• （SDKが起動できない→インストール確認）
• （次以降に SDK を立ち上げる時も Vivado のプロジェクトから Launch するのが無難）

プロジェクトの生成

• (A)上端メインメニュー File から New → Application Project
• Project name: zybo_test に設定し、 (Finish ではなく)  [Next] する。
• Hello World の Template を選択し、[Finish]する。

6. 動作確認(Hello World)(SDK)

FPGAの書き込み

• (ZYBO では JP5 が JTAG 側に刺さっていることを確認。)
• ZYBO の PROG UART(or ZedBoard の J17 PROG と J14 UART) に USB ケーブルを接続。電源投入。ドライバ類の認識を確認。
• (A)上端メインメニュー Xilinx Tools から、Program FPGA を実行。
• LD10 DONE(or LD12 DONE for ZedBoard) の点灯を確認。
• BTN3押下によるLD3の点灯を確認。 (or BTNC, LD7 for ZedBoard) （BTN->LED 直結、クロック無関係。）
• LD2の点滅を確認。 (or LD5 for ZedBoard) （ボード上のPL用クロックによるカウンタ動作。PL部の動作確認。）

コンパイル

• (B) Project Explorer ウィンドウで zybo_test 下 src 下 helloworld.c をダブルクリックして開く。
• (C)メインウィンドウでソースコードを確認する。必要なら編集して保存する。
• (A)上端メインメニュー Project から Build All する。
• (B) Project Explorer ウィンドウで zybo_test の下 Debug の下に 実行型式zybo_test.elfが生成されていることを確認。 （Vivadoに戻す時はこれを使う）

標準入出力とUARTの接続

• (F)エリアの Terminal タブを選択。
• Connect メニューを選択。以下に設定、

    Connection Type: Serial
    Port: Windows で ZYBO の USB Serial Port が接続されている番号を確認
    Baud Rate: 115200
    Data Bits: 8
    Stop Bits: 1
    Parity: None
    Flow Control: None
    Timeout: 5
  

実行

• (B) Project Explorer で zybo_testを右クリックし、 Run As → Launch on Hardware (System Debugger)を実行。
• LD1の点滅を確認。 (or LD4 for ZedBoard) （PSのリセットとクロックによるカウンタ動作。PSのハードウェア動作確認。）
• (F)エリアの Terminalタブで、Hello Wolrd の出力を確認。（PSのソフトウェア動作確認。） (ボードによっては Hello World 出力後、main 関数を return した後にエラーになるかも)

実行でトラブルが発生するときの対処療法

• BTN7 PS-RST して、Program FPGA しなおしてみる。
• Terminal をいったん Disconnect して Connect しなおしてみる。
• ボードの電源をいったん切って、再投入してみる。

7. ソースコードの登録(SDK)

• (B) Project Explorerのzybo_test/srcの下の helloworld.cを右クリックし、Delete する。
• Windows の Explorer から zybo_test.c をドラッグし、SDK の Project Explorer ウィンドウ内のzybo_test/srcにドロップする。 (*)Copy files にチェックし、OK。

8. コンパイルと実行(SDK)

• （ボードの電源を入れなおしたりリセットをかけたりしたばあいは Program FPGA を実行。）
• (A)上端メインメニュー Project から Build All する。
• (B) Project Explorer で zybo_testを右クリックし、 Run As → Launch on Hardware (System Debugger)を実行。
• BTN3押下によるLD3の点灯を確認。(PL) (BTNC,LD7 for ZedBoard)
• LD2の点滅を確認。(PLのクロック) (LD5 for ZedBoard)
• LD1の点滅を確認。(PSのリセットとクロック) (LD4 for ZedBoard)
• (F) Terminal ウインドウへの表示を確認。(PSのソフト)
• (none for ZedBoard) LD1,2,3 のカウントアップを確認。(PSのソフト→PLのLED)
• BTN4 MIO50押下によるLD0の点灯を確認。(PSのボタン→PLのLED) (BTN9 PB2 for ZedBoard)
• BTN0 押下によるLD4 MIO7の点灯を確認。(PLのボタン→PSのLED) (BTNL,LD9 for ZedBoard)
• BTN5 MIO51押下によりプログラム終了。 (BTN8 PB1 for ZedBoard)

文字表示器を使ったテスト

• 以下の表示器があればより詳しく値を表示できる。
• Pmod コネクタ JB の JB10,JB11,JB12 に それぞれ表示器のRXD,GND,+5Vを接続する。
• PSからのgpo0,gpo1,gpo2,gpo3がそれぞれ表示器の 左上、右上、左下、右下の各８桁に表示される。

共立電子産業 SO1602AWWB-UA-WB-U+OLED_DRV-S1

http://www.kyohritsu.jp/eclib/SIKIT/MANUAL/so1602awwboleddrvs1.pdf

http://www.siliconhouse.jp/drv-s1.pdf

http://eleshop.jp/shop/g/gC9B362/

99. その他

Verilog デバグ〜埋もれたタイプミスを見つける

• [Synth 8-3331] unconnected port
• [Synth 8-3848] does not have driver
• [Synth 8-3295] tying undriven pin to constant

Zynq の実機での再実行について

• 実行中のプログラムが残っている（直前のmain()が終了していない）と再実行がうまくいかないようだ。終了させること。
• プロセッサをリセット（PS-RST,PS-SRSTのボタン）する。
• Program FPGA する。
• Run As, Hardware する。

• Terminal をいったん Disconnect して Connect しなおしてみる
• ボードの電源をいったん切って、再投入してみる

Zynq の実機デバッグ時の実行

• ボードでプロセッサをリセット（PS-RST,PS-SRSTのボタン）する
• Vivado の Hardware Manager で Program Device する
• SDK で Run As, Hardware する
• Vivado の Hardware Manager で Reflesh Device する

Zynq の COMポートが認識できない

• ボードをＰＣから外す
• ＰＣの電源を切る
• ＰＣを起動する
• 後述の方法で未使用COMポートを削除
• ＰＣの電源を切る
• ボードを接続する
• ＰＣを起動する
• 認識するかどうか確認（しばらく時間がかかる）→認識すればそれでＯＫ
• Windows のデバイスマネージャーから、表示→デバイス（種類別）して当該デバイスを探す。 Cypress の USB Serial というような表示になると思われる。
• デバイスドライバを再インストールする。

• Xilinxのホームページでエラーコードを検索 (AR#55559)
• Helpにある「Add Design Tools or Devices 2015.2」から「Software Development kit」を選択し追加する。
• SDK をインストールしたら、コマンドプロンプトにて
  • C:\Xilinx\Vivado\2015.2\settings64.batを実行
  • C:\Xilinx\SDK\2015.2\settings64.batを実行
  • C:\Xilinx\Vivado\2015.2\bin\Vivado.batを実行
• 注意：実行前にプロジェクトは閉じておく

Windows の COM ポート番号について

• コンピュータのプロパティから詳細設定、環境変数の設定で DEVMGR_SHOW_NONPRESENT_DEVICES を 1 に設定する。
• デバイスマネージャを起動、表示→非表示のデバイスを表示 不要なポートを削除。