Altera Nios II＋WIZnet W5300でTCPが動くまで

WIZnetのTCPプロセッサ[W5300](https://strawberry-linux.com/catalog/items?code=36002)を載せたボード[WIZ830MJ](https://strawberry-linux.com/catalog/items?code=36012)が[くさるほど届いた](https://plus.google.com/u/0/+KazunoriSato/posts/KzKvWxvPPCH)ので、もったいないからなんとか動かそうとしている。

![Screen Shot 2014-11-09 at 22.42.43.png](https://qiita-image-store.s3.amazonaws.com/0/38290/837a25c7-28b5-82a2-c459-9bfacb7743dc.png)

いろいろ試行錯誤の結果、[Terasic DE0](http://www.terasic.com.tw/cgi-bin/page/archive.pl?Language=English&No=364)上に[Qsys](http://www.altera.co.jp/products/software/quartus-ii/subscription-edition/qsys/qts-qsys.html)で[Nios IIプロセッサ](http://www.altera.co.jp/devices/processor/nios2/ni2-index.html)を作り、W5300とつないでTCPリスナーを作るところまで動いたので、その手順をざっとまとめておく（disclaimer: ハード開発については素人なので、間違ってる部分も大いにあるかもしれない）。

## W5300について

W5300は、WIZnetがけっこう昔に開発したハードウェアベースのTCP/IPプロセッサ。CPUやOSが不要なので、Linuxの載らない小さなマイコンにTCP通信機能を持たせるためによく用いられている。ストロベリー・リナックスで評価ボードを買うと1個2000円くらい。主要スペックは以下のとおり：

- TCP, UDP, ICMP, ARP, IGMP, PPPoEをハードウェア実装
- 8または16ビットのバスインタフェースを備える
- DMAに対応し、最大80Mbpsで動作
- 最大8本のソケット（リスナまたはクライアント）に対応
- 128KBバッファ搭載
- 10BaseT/100BaseTXコネクタ装備

![Screen Shot 2014-11-09 at 22.58.25.png](https://qiita-image-store.s3.amazonaws.com/0/38290/fa9dd8f5-3710-8c3c-f0a5-b6776ca5f4fa.png)

ハード実装だから仕方がないけど、ソケットは8本しか使えない。また下位製品のW5200/W5100はSPIでお手軽にマイコンとつなげられる一方で、W5300は速度重視のため16ビットのバスインタフェースでつなぐ必要がある。

## DE0とWIZ830MJの接続

まずは、WIZ830MJに付いている2つの28ピンコネクタをどうやってDE0に物理的に結線するかを考えた。

![Screen Shot 2014-11-09 at 22.51.16.png](https://qiita-image-store.s3.amazonaws.com/0/38290/c02498cf-8599-d88f-1d86-0750484c1dc4.png)

これを、[aitendoで売ってるピンヘッダ接続ケーブル](http://www.aitendo.com/product/2228)を使ってひたすら一本ずつDE0のGPIOにつなげてく。こんな感じ：

![Screen Shot 2014-11-10 at 8.46.29.png](https://qiita-image-store.s3.amazonaws.com/0/38290/32cee945-3dcd-5bab-564c-f35e09ff1ccb.png)

こんなにたくさんケーブル挿して、一本でも断線しててデバッグではまったりするのは嫌だったので、念のためWIZに繋いだところでテスターで一本ずつ導通確認しておいた。

DE0とWIZ間のマッピングはこんなふうにメモっておいて、あとのピンアサイン時に使った。これも1つでも間違えるとハマりそう。

![Screen Shot 2014-11-09 at 23.16.56.png](https://qiita-image-store.s3.amazonaws.com/0/38290/a14ad6ec-2a0c-09b9-6a60-4539ade14c40.png)

## とりあえずLチカ

このバスをどんなふうに使うのかはさておき、とりあえずは電源を入れてLEDがチカチカするところまで確認する。WIZのピンから出てるLED用の出力（Ethernetのリンク状態やTx/Rx動作など）をそのままDE0のLEDにつなげるVerilog HDLを書く。

```
assign WIZ_BIT16EN = 1'b1; // 16 bit mode
assign WIZ_RESET_N = RST_N; // reset
assign LED9 = !WIZ_LINKLED_N;
assign LED8 = !WIZ_TXLED_N;
assign LED7 = !WIZ_RXLED_N;
assign LED6 = !WIZ_COLLED_N;
assign LED5 = !WIZ_FDXLED_N;
assign LED4 = !WIZ_SPDLED_N;
assign LED3 = !WIZ_ACTLED_N;
assign LED2 = 1'b0;
assign LED1 = 1'b0;
assign LED0 = 1'b0;
```

さらにQuartusのPin Plannerでは、さっきメモったマッピング通りにLocationを設定、またすべてのピンのI/O StandardをW5300の仕様に合わせて3.3-V LVCMOSにセットする。

![Screen Shot 2014-11-09 at 23.29.06.png](https://qiita-image-store.s3.amazonaws.com/0/38290/ac1d0e21-270c-d990-4247-7651c40da71c.png)

（Pin Plannerの画面ってなんかカッコいい...）

ここまでできたらDE0の電源を入れて、Quartusでコードをビルド、Programmerで流してみる。イーサケーブルをWIZのコネクタに挿したらDE0のLEDがチカチカして、どうやら壊れずに動いてるらしいことを確認。リセットボタンも動いている。

## W5300のバスの使い方

さて、最大の難関はW5300のバスをうまく使いこなせるかである。生まれてこのかたバスなんて使ったことない。My First Bus! ほんまにうごくんかいな。。

W5300のドキュメントを見る限りは、とてもシンプルそうなバスではある。

![Screen Shot 2014-11-09 at 23.39.39.png](https://qiita-image-store.s3.amazonaws.com/0/38290/43fae6d0-fbbc-dd27-5424-4d92a4f27709.png)

まあつまり、

- 10ビットの`ADDR`に読み書きしたいW5300のレジスタのアドレスを渡して、
- `CS` (chip select) で「これから君と通信するよー」と伝えて、
- `RD` (read) で「データ読んでー」と伝えると、アドレスで指定したレジスタの値が16ビットの`DATA`に載ってくる

という仕組みだ。図に書くとこんな流れ：

![Screen Shot 2014-11-09 at 23.44.01.png](https://qiita-image-store.s3.amazonaws.com/0/38290/33327fcd-e95a-e752-c3c5-2bcf3c14a25f.png)

ここに書かれた`tRD`やら`tDATAs`やらで決められたタイミングを外れないようにする必要がある。今回、DE0のクロックは50MHz=20nsなので、例えば`tRD`の最小値65nsを下回らないように`RD`は4クロック以上維持する、などなど。

### W5300のレジスタ

W5300を使うには、とりあえずこのバスを経由したレジスタの読み書きさえできればよい。割り込み信号`INT`やDMAを使うといろいろ高度なこともできるけど、hello worldしたい段階ではこれらは考えなくてもよい。TCP接続に必要なコマンド送信や状態管理はすべてレジスタの読み書きのみで行える。

![Screen Shot 2014-11-09 at 23.53.13.png](https://qiita-image-store.s3.amazonaws.com/0/38290/815c1ad8-b491-8b0b-4fe3-68b60a2ebb69.png)

例えば、8本のソケットそれぞれのTCPステータスを見るには、対象のソケットのSocket Status Register (SSR)レジスタをバスから読めばよい。仕様書にはその値が以下のいずれかのTCPステータスに対応するかが記載されている。

![Screen Shot 2014-11-09 at 23.57.33.png](https://qiita-image-store.s3.amazonaws.com/0/38290/d92cce65-5a9b-5b61-2edf-4114bed7a868.png)

ホスト側では、この状態に応じて次に出すべきコマンドや、ソース／宛先IPアドレス等のデータを別のレジスタに書き込みして、W5300に仕事を依頼する。なるほど、原理的にはそんな難しくはなさそうだ。

## QsysでNios IIを作る

その仕事の依頼方法には、以下の2つが考えられる。

- W5300の制御をすべてハードウェアで実装する
- W5300をバス経由でCPUにつなぎ、制御をソフトウェアで実装する

我が師匠のみよしさんは、仕事の合間にあっという間に[ハードウェア実装でW5300を動かして](http://wasa-labo.com/wp/?p=112)しまっていた。プロこわい。しかも[Synthesijer](http://synthesijer.sourceforge.net/)という、みよしさんお手製の高位合成ツール（高級言語からハードウェア記述言語を自動生成するやつ）を使って、[あっさりJavaで書いてある](https://github.com/miyo/de0nano/blob/master/wiz830mj/WIZ830MJ_Test.java)。これからのハードウェア開発はこんなふうにソフトウェアプログラミングにどんどん近くなっていくのだろうなー。。

しかし師匠のコレをそのまんま使ったのでは修行にならないので、今回はオーソドックスに後者の方法で行くことにした。Quartusに付属のSoCツールQsysを使ってMIPSベースCPUであるNios IIをFPGA上に作成し、その上でCで書いたコードを動かして上述のようなW5300のレジスタの読み書きを行う。

これまでQsysもNios IIも使ったことがなかったのだけど、神本「[FPGAスタータ・キットで初体験！オリジナル・マイコン作り](http://www.amazon.co.jp/dp/4789848191)」のおかげで、あまり引っかかることなくQsys上のNios II作成とLチカまでを進めることができた。This is the god's bookである。

![Screen Shot 2014-11-10 at 0.22.30.png](https://qiita-image-store.s3.amazonaws.com/0/38290/b5d80cf2-bf12-41b5-3900-b800589d8b7b.png)

この本を読みながら、QsysでNios IIやSDRAMコントローラを作り、クロック信号やAvalonバスをぽちぽちUI上でつないでいく。さらにQuartus付属のEclipseでCのコードを書き、Qsys上で適当に指定したメモリマップI/Oのアドレスにデータを読み書きすると、そのI/Oに繋いだLEDがチカチカしたりする。これは楽しいぞ。。Alteraにお金を払わずにここまでできるなんて。

![Screen Shot 2014-11-10 at 0.23.53.png](https://qiita-image-store.s3.amazonaws.com/0/38290/0f410ba9-c440-6c2d-8535-e6c4e296ba99.png)

まぁ、クロックは50MHzだし、無償版のNios IIにはキャッシュもパイプラインもないので激遅ではあるのだけど。SDRAMとの転送帯域を実測してみたら280KB/sだった。RAMなのに、GCEのLocal SSDより2500倍くらい遅いｗ

### Avalon MM Slave TranslatorでW5300のバス制御

QsysではNios IIにAvalonというバスがつながっているのだけど、AvalonとW5300のバスはどうやってつなげよう？ と、Qsysのライブラリをいろいろ探したら、どうやらAvalon MM Slave Translatorというやつを使えばいい感じに行けそうだ。詳細ドキュメントが見つからなかったので、ウィザード画面で指定するパラメータの最適構成を見つけるのに苦労したけど、以下のような設定で今のところいい感じの動きになっている：

![Screen Shot 2014-11-10 at 0.42.55.png](https://qiita-image-store.s3.amazonaws.com/0/38290/9fa9fcb2-3a00-d096-2234-95ee6f860566.png)

タイミングまわりのパラメータは、とりあえずすべて5クロックにしといてあとで追い込むつもり。このTranslatorに`wiz0`という名前を付けて、HDLの方では以下のようなコードでW5300と繋いだ。

```
nios2e u0 (
	.clk_clk (CLK),
	.reset_reset_n (RST_N),
	.wiz0_address		(WIZ_A),
	.wiz0_write		(wiz_wr),
	.wiz0_read		(wiz_rd),
	.wiz0_readdata		(wiz_readdata),
	.wiz0_writedata		(wiz_writedata),
	.wiz0_chipselect	(wiz_cs),
	.wiz0_byteenable	(wiz_byteenable)
);

wire [15:0] wiz_readdata;
wire [15:0] wiz_writedata;
wire [1:0] wiz_byteenable;
wire wiz_cs, wiz_wr, wiz_rd;
assign WIZ_CS_N = !wiz_cs;
assign WIZ_WR_N = !(wiz_wr && wiz_byteenable[0] && wiz_byteenable[1]);
assign WIZ_RD_N = !(wiz_rd && wiz_byteenable[0] && wiz_byteenable[1]);
assign WIZ_D = (!WIZ_CS_N && !WIZ_WR_N) ? wiz_writedata : 15'bz;
assign wiz_readdata = (!WIZ_CS_N && !WIZ_RD_N) ? WIZ_D : 15'b0;
```

こんな書き方でよいのか不明だが、、W5300のバスはトライステートなので`CS`と`WR`もしくは`RD`がイネーブルの時にだけリードやライトのデータを流す。それと、`byteenable`がワード書き込みの時だけ対応するようにした。

W5300のバスにはbyteenableがないので、こういうときどうすればよいのだろう？ と悩んだ。Nios II上のコードから`(char *)`のポインタを使い、バイト単位で書き込みすると、`byteenable`にはバイト単位書き込みのフラグが立つ。つまり、1バイトだけ更新したい。しかしW5300は1ワード（2バイト）単位でしか書き込みできない。なので、いちど対象ワードを読んで、そのうち1バイトのみ書き換え、ふたたびワード単位で書き戻すというread-modify-writeの動作が必要になる。これってI/O側でがんばってハード実装すべきなのかな？ と識者の皆さんに聞いてみたら、たけむら師匠ととよしま師匠から「そういうのはI/O側で勝手にやらずにホスト側でやるのが常道」とのアドバイスをいただいた。というわけで、I/O側ではバイト単位書き込みには対応しないことにした。Cコードからは`(unsigned short *)`のみで読み書きする。

このあたりのデバッグはQuartus付属のSignalTapなしでは不可能。もっとちゃんとしたデバッグ環境を整えるために、実機でなくシミュレーターを使おうかなとも考えたけけど、ひと通りのモデルを用意するのが面倒なのでとりあえず実機＋SignalTapで。

Nios IIのEclipse上で`Nios II Application and BSP from Template`プロジェクトを作成、hello worldテンプレートを使って以下のようなコードを書いて、W5300をソフトリセットしてみた。

```
  volatile unsigned short *p = WIZ0_BASE + 0x000; // W5300 base address + 0x000 register
  *p = *p | 0b10000000; // setting the reset flag
```

うまくリセットされ、レジスタから読み込んだ値の内容もOK。SignalTapでも、想定どおりに動いてるっぽいことを確認した。

![Screen Shot 2014-11-10 at 1.59.41.png](https://qiita-image-store.s3.amazonaws.com/0/38290/08f506bc-5bb0-f3db-0fb3-3e1fed1cf29a.png)

## WIZnetのドライバコードを動かす

これでCコードからW5300のレジスタを自由に読み書きできるようになったけど、レジスタの仕様を読むと結構細々とした状態遷移管理やビット操作が必要そうで、すべてを自分で書くのは面倒そう。しかしありがたいことに、WIZnetのサイトからCで書かれた[ドライバコード](http://www.wiznet.co.kr/sub_modules/en/product/product_detail.asp?Refid=681&page=1&cate1=5&cate2=7&cate3=25&pid=1012&cType=2)のサンプルをダウンロードすることができる。

このドライバはどうやらXscaleマイコン用に書かれたもののようで、そのままではログ出力のprintfまわりが引っかかって動かない。Altera提供のalt_printfと差し替えたりちょこちょこ直したりして動いた。

これを使うと、TCPソケットの作成をとても簡単に書くことができた。

```
setSIPR({ 192, 168, 1, 250 }); // set source IP address
setGAR({ 192, 168, 1, 1 }); // set gateway IP address
setSUBR({ 255, 255, 255, 0 }); // set subnet mask address
setSHAR({ 0x00, 0x08, 0xDC, 0x00, 111, 200 }); // set source hardware address
```

という感じにソースIPアドレスやゲートウェイ、サブネットマスク、MACアドレス等をレジスタにセットして、`main.c`にあるループバックテスト用の関数`loopback_tcps()`を呼び出せば、指定したポート番号でTCPリスナーを作成できる。

```
loopback_tcps(0, 5000, data_buf, 0);
```

接続テストのため、PCからtelnetでつないでみる。

```
$ telnet 192.168.1.250 5000
Trying 192.168.1.250...
Connected to 192.168.1.250.
Escape character is '^]'.
hello
hello
world
world
```

適当な文字列を叩くとそのままエコーバックされてきた。いえーい、動いたぜ！！！

## これからの野望

とりあえずCPU上のソフトウェアからW5300を制御してhello worldするという第一目標は達した。これからはTCPより上のプロトコルをソフトで実装し、さらにその一部をハード実装に移行する、、ってことをやってみるつもり。

ここまでに書いたドライバコード（WIZnetのドライバの修正版）やHDLコードは[GitHubリポジトリ](https://github.com/kazunori279/hdllesson/tree/master/Wiz)に置いておいた。