=================
GPCIe 開発キット
=================

GPCIe は株式会社 K&F Computing Research 社開発の PCI Express IP コアで
す。ユーザ自身の設計した回路へ GPCIe を組み込むことで、PCI Express プ
ロトコルの詳細に立ち入らずに他の PCI Express デバイスとのインタフェー
スを実現できます。

このパッケージには以下の 3 つの回路が含まれます
(すべての回路は VHDL ソースコードで提供されます)。

  1) GPCIe 最上位階層に位置し、ユーザ回路に対して簡便なインタフェーシング
     を行う Host Interface Bridge (HIB)。

  2) PCI Express 規格で定められたトランザクション層、データリンク層、
    PHY MAC 層と、それらの上位に位置するアプリケーション層 (PCI
    Configuration Register や DMA コントローラ) を実現する GPCIe コア。

  3) Altera 社 FPGA の内蔵トランシーバ向け PHY PCS 層、PMA 層 を実現す
    るPHY。

またこのパッケージには、HIB を利用したインタフェース回路のリファレンス
デザイン (サンプル回路) と、それを Linux OS から制御するためのソフトウェ
アも含まれています。

このパッケージのファイル構成は以下の通りです。

gpciepkg/
  00readme-j                     -- 本ファイル。
  00readme                       -- 本ファイルの英語版。
  00license-j                    -- パッケージの利用許諾。
  00license                      -- 00license-j の英語版。
  doc/                           -- ユーザガイド、その他の文書。
  script/                        -- パッケージ管理ユーティリティ。
  software/                      -- HIB 制御用ソフトウェア
    driver/                      -- HIB デバイスドライバソースコード (Linux 用)。
      win/                       -- HIB デバイスドライバソースコード (Windows 用)。
    hibutil/                     -- HIB 制御ライブラリソースコード (Linux 用)。
      win/                       -- HIB 制御ライブラリソースコード (Windows 用)。
    include/                     -- HIB 制御ライブラリヘッダファイル。
    lib/                         -- HIB 制御ライブラリ。
    sample/                      -- HIB 制御ライブラリを使用したアプリケーションプログラムの例。
    tool/                        -- HIB 制御用ソフトウェアの管理ユーティリティ。
  hardware_altera/               -- GPCIe 本体およびリファレンスデザイン (Altera 社 FPGA 用)
    hib.vhd                      -- GPCIe 最上位階層 Host Interface Bridge (HIB)。
    gpcie.vhd                    -- GPCIe アプリケーション層、トランザクション層、データリンク層、PHY MAC 層。
    phy.vhd                      -- Altera 社 FPGA 内蔵トランシーバ用の PHY PCS 層、PHY PMA 層。
    topdesign/                   -- HIB を用いたインタフェース回路サンプルの最上位階層。
    synth/                       -- リファレンスデザインの合成に使用するファイル (.qpf, .qsf, .sdc)。
    Makefile                     -- テンプレートから hib.vhd, gpcie.vhd, phy.vhd を生成するための makefile。
    templates/                   -- VHDL ソーステンプレート
  hardware_xilinx/               -- GPCIe 本体およびリファレンスデザイン (Xilinx 社 FPGA 用)
    hib.vhd                      -- GPCIe 最上位階層 Host Interface Bridge (HIB)。
    gpcie.vhd                    -- GPCIe アプリケーション層、トランザクション層、データリンク層、PHY MAC 層。
    topdesign/                   -- HIB を用いたインタフェース回路サンプルの最上位階層。
    synth/                       -- リファレンスデザインの合成に使用するファイル (.qpf, .qsf, .sdc)。
    Makefile                     -- テンプレートから hib.vhd, gpcie.vhd を生成するための makefile。
    templates/                   -- VHDL ソーステンプレート

GPCIe の使用法および利用許諾については gpciepkg/doc/userguide-j.pdf を参照してください。

お問い合わせおよびバグレポートは下記へお願いします:
株式会社 K&F Computing Research (support@kfcr.jp)

------------------------------------------------------------------------------------------------------
version       date        author               note
------------------------------------------------------------------------------------------------------
1.4.5         20-Dec-2013 AK                   トレーニングシーケンスの不具合を修正。Gen3対応チップ
                                               セットでリンクアップ出来ない問題を解消。

1.4.4         19-Apr-2013 AK                   64-bit 版 Windows-7 をサポート。

1.4.3         08-Feb-2013 AK                   ユーザガイドに割込みの使用法を追記。

1.4.2         07-Apr-2012 AK                   Cyclone IV GX 向けに remote update 機能を追加。

1.4.1         14-Jan-2012 AK                   Cyclone IV GX 向けに backend_clk 周波数の動的変更機能を追加。

1.4.0         05-Dec-2011 AK                   Stratix II GX 向け Gen2 IP コア
                                               (これまで別個のパッケージで提供していたもの) を統合。

1.3.3         21-Nov-2011 AK                   Cyclone IV GX Dev Kit (soft IP Gen1 x1/x4) をサポート。

1.3.2         02-Mar-2011 AK                   Cyclone IV GX Starter Kit (soft IP Gen1 x1) をサポート。

1.3.1         10-Aug-2010 AK                   backend_clk 周波数の動的変更機能を追加 (Stratix IV GX のみ)。

1.3.0         04-Jul-2010 AK                   Stratix IV GX (soft IP Gen1 x1/x4/x8) をサポート。
                                               トレーニングシーケンスに L0s ステートを実装。

1.2.0         06-Mar-2010 AK                   GPCIe 機能限定版と DS のパッケージを統合。
                                               ディレクトリ構成を変更。

1.1.1         28-Nov-2009 AK                   ユーザガイドにタイミングチャートを追記。

1.1.0         27-Aug-2009 AK                   PHYチップ対応版およびWindows 用デバイスドライバを統合
                                               (これらは無償版には含まれません)。

1.0.0         03-Aug-2009 AK                   デバイスドライバを改良
                                               (kernel2.6.26 対応、PAT 対応、デバイス数の自動認識)。

0.9.4         26-Jun-2009 AK                   Quartus 8.1 用の alt2gxb (内蔵トランシーバ) への
                                               ラッパを追加。

0.9.3         28-May-2009 AK                   スクランブル無しのデータ転送に対応。

0.9.2         19-May-2009 AK                   拡張 configuration 空間アクセスに関するバグを修正。
                                               リンク再トレーニング要求への応答を実装。
                                               receiver 検出処理を実装。

0.9.1         20-Feb-2009 AK                   x1 メモリ消費を低減 (DLLP Tx バッファ)。

0.9           22-Jan-2009 AK                   I/O空間へのアクセスをサポート。

0.8.2         14-Jan-2009 AK                   微小なバグを修正。回路規模を低減。

0.8.1         03-Jan-2009 AK                   ユーザガイドを更新。

0.8           17-Nov-2008 AK                   回路を最適化。ユーザガイド PDF 版を作成。

0.7           09-Oct-2008 AK                   x1 をサポート。

0.6           28-Sep-2008 AK                   DMA read 機能を追加。

0.5           28-Jul-2008 AK                   DMA write 性能を向上。
                                               英文書類を追加。

0.1           10-Jul-2008 AK                   構成を変更。ユーザガイドを改訂。

0.0           09-Jul-2008 A. Kawai             初版作成。
------------------------------------------------------------------------------------------------------