FPGA OS

FPGAアプリケーションのオペレーティングシステムランタイム

Copyright（c）2018-2020、Wuklab、UCSD。

これは、FPGAアプリケーションのおなじみのOS抽象化（MM、スケジュール、ネットなど）を提供するFPGA内で実行されるオペレーティングシステム（OS）です。これは、初期の初期段階の研究プロトタイプです。ほとんどのコードはXilinx HLSで記述されています。 VCU118およびVCU108でテストされています。

それは教育目的のために公開されています。あなたがそれが役に立つと思うことを願っています。

コードベース組織の原則

• 各サブフォルダーを単独でIPにします。これは、独自のスクリプト、RTLまたはHLSコード、およびTestBenchが必要なことを意味します。
• 階層IPSには依存関係があります。対応する構築スクリプトで順序を明示的に表現する必要があります。
• 最終的な大規模なプロジェクトは、小さなIPコアを究極する図または静的RTLコードで表現する必要があります。
• 全体として、このプロジェクトは多くの小さなIPを構成し、それらは内部で使用されて大きなものを構築します。私たちの目標は、可能な限りIPSを再利用し、新しいIPを簡単に構築できるようにすることです。

コードベースディレクトリ

• ホスト側：
  • host/ ：ホストサイドネットワークスタックとDMAドライバー
• FPGA側：
  • alloc/ ：メモリアロケーター
  • mm/ ：メモリ管理
  • net/ ：ネットワークサブシステム
  • kernel/ ：いくつかのPR関連コード
  • system/ ：最終的な大きな統合システム
• 両方の世界：
  • app/ ：アプリケーションには、FPGAとホストコードの両方を含めることができます。
  • include/ ：FPGAとホストコードの両方で使用されるヘッダーファイル。たとえば、ネットワークヘッダー。
    • include/fpga ：HLSのみが使用するヘッダー
    • include/uapi ：HLSとホストコードの両方で使用されるヘッダー
• ヘルパー
  • tools/ ：さまざまなヘルパー
  • scripts/ ：テンプレートスクリプトファイル
• 生成
  • generated_ip/ ：ここで生成されたすべてのIPSがスリープします
  • generated_hls_project/ ：Vivado HLSプロジェクト
  • generated_vivado_project/ ：Vivadoプロジェクト

形式：

• 一般的な
  • 他の人のために読みやすくします。
  • エンディングスペースとタブを削除します。
  • Linuxカーネルコーディングスタイルを使用してみてください。
• Vivado HLS
  • すべてのVivado HLSスクリプトはrun_hls.tcl名を使用します。
• verilog
• IP
  • 名前を一貫して名前。サブシステム名をプレフィックスとして使用します。たとえば、 mm_axi_wrapper 、mmサブシステムの下でのAxiラッパーIPです。

チュートリアル

ハウツーの構築

• タイプは、詳細な説明を見るためにmake help 。
• Type make at Top-Levelは、デフォルトボードを使用してプロジェクト全体をコンパイルします。
  • カーネルIPSが最初にコンパイルされます
  • 大型システムはsystem/フォルダーにあります
• 各サブフォルダーでのタイプmake 、そのフォルダーのみをコンパイルします。

ワークフロー：ソースコードを最初にダウンロードしたら、プロジェクトをコンパイルする必要があります。すべての小さく、中程度のIP、および大きなプロジェクトは、使用する準備ができています。この後、構築しているIPSに集中できます。 Vivado内で変更は自動的に反映されます。

また、あなたがターゲットにしているボードに注意してください。

Vivadoスクリプトの使用方法

スクリプトを使用するという目標は2つあります

• 建築プロセスを簡単にします
• GITを使用して、ソースファイルのみを追跡します。デフォルトでは、Vivadoはバンチファイルを作成し、それらすべてをGitで追跡すべきではないためです。このプロジェクトでは、すべてのVivadoプロジェクトモード関連ファイルは、対応するスクリプトとソースコードがあるのと同じフォルダーに、 generated_vivado_project/ folderの下に配置されます。

これらのVivadoプロジェクトモードスクリプトは、Vivado自体によって生成されます。また、これらのスクリプトを使用して、プロジェクト全体をそのまま再構築できます。

これらは、これらのスクリプトを作成してハッキングするための私の非形式的な手順です。

走る：

• スクリプトを実行します：
  • vivado -mode tcl -source run_vivado.tcl
    • 新しいgenerated_vivado_project/が現在のフォルダーで作成されます
    • 新しいIPがパッケージ化され、 generated_ip/フォルダーにエクスポートされます。
  • 毎回入力したくない場合は、テンプレートMakeFileを使用してください。

作成：

• トップレベルのスクリプトを作成します。
  • Vivado GUIを使用して新しいプロジェクトを作成し、既存のソース/TB/XDCを追加し、パーツを設定します。
  • write_project_tclを使用してスクリプトを生成します。新しいスクリプトに、再構築されるプロジェクトをフォルダーのgenerated_vivado_projectの下に置くべきであることを知らせる必要があります。そして、 run_vivado.tclにスクリプトに名前を付ける必要があります。
  • プロジェクト内にブロック図（bd）設計がない場合は、 write_project_tcl -force -no_copy_sources -target_proj_dir ./generated_vivado_project ./run_vivado.tclを使用してください。
  • プロジェクト内にBDデザインがある場合は、 write_project_tcl -force -target_proj_dir ./generated_vivado_project ./run_vivado.tclを使用してください。

ハック：

• トップレベルのスクリプトにIPパスを追加します。

  • これはすべてのスクリプトに追加する必要があります。
  • 生成されたすべてのIPはgenerated_ip/フォルダーにあります。これにより、IPトラッキングが簡単になります。 Vivadoが新しいIPSを探す場所を知ることができるように、スクリプトにいくつかの行を追加できます。これらの行のscripts/template_vivado_ip.tclをご覧ください。

• 自動的にパッケージIP：

  • これはすべてのスクリプトに追加する必要があります。
  • スクリプトにIPを自動的にパッケージ化できるようにしたいと思います。これは、スクリプトの最後に数行を追加することで実現できます。宛先の場所、IPの名前などを指定する必要があることに注意してください。生成されたすべてのIPはgenerated_ip/にあります。たとえば、 ipx::package_project -root_dir ../../generated_ip/mm_axi_wrapper -vendor wuklab -library user -taxonomy UserIP -import_files -set_current false -force
  • IPとしてBDをパッケージ化： ipx::package_project -root_dir ../../generated_ip/mm_axi_rab_vcu118 -vendor wuklab -library user -taxonomy UserIP -module THE_BD_NAME -import_files

• ソース/XDC/シミュレーションファイルを追加する：

  • 最初の解決策は、生成されたスクリプトを手動で変更します。これらの既存のファイルがどのように追加されているかを調べてみてください。次に、同様の方法でスクリプトを変更できます。ヒント： top.v 、 add_filesなどを検索します。
  • 2番目の解決策は、Vivado GUIを介してファイルを追加してから、 write_project_tcl再度使用して別のスクリプトを生成します。次に、違いを確認してください。

• BDラッパーを自動依頼します

  • トップレベルのデザインがBDである場合、これを追加する必要があります
  • その理由は、BDにAXI界面がある場合、このAXIには事前定義された周波数プロパティが必要です（これを実行する必要があります。デフォルトでは、100 MHzです。このBDからIPが生成され、より大きなIPで使用される場合、この頻度を変更することはできません。ただし、BDのラッパーを作成し、プロジェクト全体をIPとしてパッケージ化すると、IP統合中に周波数プロパティを自動的に更新できます。

• その他の設定：

  • 重要！
  • Vivado GUI（例：注文、XDC注文、シミュレーションのトップファイルなど）を介して行った変更があり、他の人が使用するために保存する場合は、 write_project_tclを使用して新しいスクリプトを生成し、対応する変更を保存する必要があります。 Vivadoコマンドに精通したら、スクリプトを変更することで手動で実行できるはずです。

警告：

• 生成されたスクリプトを確認します
  • Vivado自動生成フォルダー内のソースファイルがスクリプトで使用されているかどうかを確認してください。これは、write_project_tclが正しく使用されない場合に発生します。自動生成されたファイルを持つことは、本質的に鶏と卵の問題に等しくなります。

今のところ、 mm/axi_wrapper/run_vivado.tcl mm/sys/run_vivado.tclサンプルスクリプトを見つけることができます。

IPバージョンを処理する方法

Vivadoは、各バージョンで1つのIPバージョンのみをサポートしています。生成されたスクリプトを使用する場合、それは非常に承認します。幸いなことに、それを回避する1つの方法があります。次のコードは、IP文字列を変数に置き換えます。ただし、更新されたIPに異なるポートがある場合は注意してください。

 set axis_data_fifo [get_ipdefs -filter NAME==axis_data_fifo]
Replace all `xilinx.com:ip:axis_data_fifo:1.1` with `$axis_data_fifo

Vivado HLSスクリプトの使用方法

Vivado HLSスクリプトは、Vivadoスクリプトよりも比較的簡単です。 Templateスクリプトはscripts/template_run_hls.tclで見つけることができます。パーツ、追加されたファイル、頻度などをカスタマイズする必要があります。同じフォルダーの下で複数のHLSを自動的に構築する場合は、 scripts/template_generate_hls.shを使用します

参照

• ug1118 vivado作成およびパッケージ化カスタムIP