draft/man4/sk98lin.4

   1 .\" (C)Copyright 1999-2003 Marvell(R) -- linux@syskonnect.de
   2 .\" sk98lin.4 1.1 2003/12/17 10:03:18
   3 .\" This manpage can be viewed using `groff -Tascii -man sk98lin.4 | less`
   4 .\"
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, write to the Free
  22 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  23 .\" USA.
  24 .\"
  25 .\"*******************************************************************
  26 .\"
  27 .\" This file was generated with po4a. Translate the source file.
  28 .\"
  29 .\"*******************************************************************
  30 .TH SK98LIN 4 2012\-05\-10 Linux "Linux Programmer's Manual"
  31 .SH 名前
  32 sk98lin \- Marvell/SysKonnect ギガビットイーサネットドライバ v6.21
  33 .SH 書式
  34 \fBinsmod sk98lin.o\fP [\fBSpeed_A=\fP\fIi,j,...\fP] [\fBSpeed_B=\fP\fIi,j,...\fP]
  35 [\fBAutoNeg_A=\fP\fIi,j,...\fP] [\fBAutoNeg_B=\fP\fIi,j,...\fP] [\fBDupCap_A=\fP\fIi,j,...\fP]
  36 [\fBDupCap_B=\fP\fIi,j,...\fP] [\fBFlowCtrl_A=\fP\fIi,j,...\fP]
  37 [\fBFlowCtrl_B=\fP\fIi,j,...\fP] [\fBRole_A=\fP\fIi,j,...\fP] [\fBRole_B=\fP\fIi,j,...\fP]
  38 [\fBConType=\fP\fIi,j,...\fP] [\fBModeration=\fP\fIi,j,...\fP]
  39 [\fBIntsPerSec=\fP\fIi,j,...\fP] [\fBPrefPort=\fP\fIi,j,...\fP] [\fBRlmtMode=\fP\fIi,j,...\fP]
  40 .SH 説明
  41 .ad l
  42 .hy 0
  43 \fB注意\fP: この時代遅れのドライバはカーネル 2.6.26 で削除された。
  44
  45 \fBsk98lin\fP は Marvell と SysKonnect のネットワークアダプタカードの ギガビットイーサネットドライバである。 これは
  46 SysKonnect SK\-98xx/SK\-95xx 互換のギガビットイーサネットアダプタと Yukon 互換のチップセットをサポートしている。
  47
  48 insmod を使ってドライバをロードする際、 ネットワークアダプタカードのパラメータを コンマで区切られたコマンドの列として指定することができる。 2
  49 つのネットワークアダプタが取り付けられている時に、 例えば、1 つ目のアダプタのポート A の自動ネゴシエーションは ON にするが、 2
  50 つ目のアダプタのポート A は OFF にする場合は、 以下のように入力すればよい:
  51
  52    insmod sk98lin.o AutoNeg_A=On,Off
  53
  54 \fBsk98lin\fP が 1 つ以上のアダプタカードに関連づけられていて、 かつ \fI/proc\fP ファイルシステムがシステムにマウントされている場合、
  55 取り付けられているネットワークアダプタカードの全てのポートについて、 (ポート単位に) 専用の統計ファイルがフォルダ
  56 \fI/proc/net/sk98lin\fP に作られる。 これらのファイルは \fIeth[x]\fP という名前であり、 \fIx\fP
  57 はインタフェースの番号である。 この番号はシステムによってポート毎に割り当てられたものである。
  58
  59 ロードが完了すると、 \fBifconfig\fP(8)  コマンドを使って、各 \fIeth[x]\fP インタフェースに希望する IP
  60 アドレスを割り当てることができる。 これによりアダプタがイーサネットに接続され、 コンソールに状態メッセージが表示される。 このメッセージでは、
  61 "ethx: network connection up using port y" の後に 設定されたり検出された接続パラメータが表示される。
  62
  63 \fBsk98lin\fP はラージフレーム (ジャンボフレームとも呼ばれる) もサポートする。 ジャンボフレームを使うと、大量のデータを転送する際に、
  64 スループットを大幅に向上させることができる。 ラージフレームを有効にするには、 インタフェースの MTU (maximum transfer unit,
  65 最大転送単位) サイズを 大きな値に設定すればよい。 デフォルトの MTU サイズは 1500 であり、 最大で 9000 (バイト)
  66 まで設定することができる。 MTU サイズを設定するのは、 インタフェースに IP アドレスを割り当てるときにもできるし、後から
  67 \fBifconfig\fP(8)  コマンドに mtu 引き数を指定することで設定することもできる。 例えば、eth0 に IP アドレスとラージフレーム
  68 MTU サイズを 割り当てたい場合、以下の 2 つのコマンドを実行すればよい:
  69
  70     ifconfig eth0 10.1.1.1
  71     ifconfig eth0 mtu 9000
  72
  73 これらの 2 つのコマンドは 1 つにまとめることもできる:
  74
  75     ifconfig eth0 10.1.1.1 mtu 9000
  76
  77 ラージフレームを使用できるのは、ネットワーク環境全体で ラージフレームの使用が認められている場合のみである点に注意すること。
  78 つまり、イーサネットで使われている全てのスイッチでも ラージフレームがサポートされていなければならない。
  79 多くのスイッチがラージフレームをサポートしてはいるが、 設定を行う必要がある。 多くの場合、デフォルトの設定では標準フレーム (1500 バイトの
  80 MTU サイズ) だけしかサポートしない。 ネットワーク内のスイッチに加え、 使用される全てのネットワークアダプタでも
  81 ジャンボフレームが有効になっていなければならない。 アダプタがラージフレームを受け取るように設定されていない場合、
  82 アダプタはそのフレームを単純に捨ててしまう。
  83
  84 標準のイーサネットフレームサイズに戻すのは、再び \fBifconfig\fP(8)  コマンドを使えばよい:
  85
  86     ifconfig eth0 mtu 1500
  87
  88 Linux の Marvell/SysKonnect ギガビットイーサネットドライバは、 IEEE 規格 802.1, 802.1q, 802.3ad
  89 に準拠する VLAN と Link Aggregation に対応している。 これらの機能は、インターネットにあるオープンソースモジュールを
  90 インストールした後でのみ利用可能である:
  91
  92 \fIVLAN\fP: http://www.candelatech.com/~greear/vlan.html
  93 .br
  94 \fILink\fP \fIAggregation\fP: http://www.st.rim.or.jp/~yumo
  95
  96 .br
  97 Marvell/SysKonnect は、これらのオープンソースモジュールに対するサポートは
  98 行っておらず、これらを使った場合に生じるいかなる失敗や問題についても 責任を負わない点に注意すること。
  99 .SS パラメータ
 100 .TP
 101 \fBSpeed_A=\fP\fIi,j,...\fP
 102 このパラメータはアダプタカードのポート A がサポートするリンク速度を 設定するのに使われる。これは Yukon copper
 103 アダプタでのみ有効である。 使用可能な値は以下の通り: \fI10\fP, \fI100\fP, \fI1000\fP, \fIAuto\fP。 デフォルトは \fIAuto\fP
 104 である。 通常、リンク速度はリンクの確立時に 2 つのポートの間で自動設定される。 これに失敗した場合、ポートはこの引き数で指定された設定になる。
 105 .TP
 106 \fBSpeed_B=\fP\fIi,j,...\fP
 107 このパラメータはアダプタカードのポート B がサポートするリンク速度を 設定するのに使われる。これは Yukon copper
 108 アダプタでのみ有効である。 使用可能な値は以下の通り: \fI10\fP, \fI100\fP, \fI1000\fP, \fIAuto\fP。 デフォルトは \fIAuto\fP
 109 である。 通常、リンク速度はリンクの確立時に 2 つのポートの間で自動設定される。 これに失敗した場合、ポートはこの引き数で指定された設定になる。
 110 .TP
 111 \fBAutoNeg_A=\fP\fIi,j,...\fP
 112 アダプタカードのポート A の自動設定 (autonegotiation) の使用を 有効または無効にする。使用可能な値は以下の通り: \fIOn\fP,
 113 \fIOff\fP, \fISense\fP。 デフォルトは \fIOn\fP である。 \fISense\fP モードはリンクパートナが自動設定をサポートしているか否かを
 114 自動的に検知する。
 115 .TP
 116 \fBAutoNeg_B=\fP\fIi,j,...\fP
 117 アダプタカードのポート B の自動設定 (autonegotiation) の使用を 有効または無効にする。使用可能な値は以下の通り: \fIOn\fP,
 118 \fIOff\fP, \fISense\fP。 デフォルトは \fIOn\fP である。 \fISense\fP モードはリンクパートナが自動設定をサポートしているか否かを
 119 自動的に検知する。
 120 .TP
 121 \fBDupCap_A=\fP\fIi,j,...\fP
 122 この引き数はアダプタカードのポート A で使う二重通信 (duplex) モードを示す。 使用可能な値は以下の通り: \fIHalf\fP, \fIFull\fP,
 123 \fIBoth\fP。 デフォルトは \fIBoth\fP である。 この引き数はポート A の AutoNeg_A が \fISense\fP
 124 に設定されていない場合にのみ有効である。 AutoNeg_A が \fIOn\fP の場合、DupCap_A の 3 つの値 (\fIHalf\fP,
 125 \fIFull\fP, \fIBoth\fP)  のうちどれでも指定することができる。 AutoNeg_A が \fIOff\fP の場合、DupCap_A の値
 126 \fIFull\fP と \fIHalf\fP のみを指定することができる。 この DupCap_A 引き数は、リンクパートナが全ての二重通信の組み合わせを
 127 サポートしていない場合に役に立つ。
 128 .TP
 129 \fBDupCap_B=\fP\fIi,j,...\fP
 130 この引き数はアダプタカードのポート B で使う二重通信モードを示す。 使用可能な値は以下の通り: \fIHalf\fP, \fIFull\fP, \fIBoth\fP。
 131 デフォルトは \fIBoth\fP である。 この引き数はポート B の AutoNeg_B が \fISense\fP に設定されていない場合にのみ有効である。
 132 AutoNeg_B が \fIOn\fP の場合、DupCap_B の 3 つの値 (\fIHalf\fP, \fIFull\fP, \fIBoth\fP)
 133 のうちどれでも指定することができる。 AutoNeg_B が \fIOff\fP の場合、DupCap_B の値 \fIFull\fP と \fIHalf\fP
 134 のみを指定することができる。 この DupCap_B 引き数は、リンクパートナが全ての二重通信の組み合わせを サポートしていない場合に役に立つ。
 135 .TP
 136 \fBFlowCtrl_A=\fP\fIi,j,...\fP
 137 この引き数は自動設定時にポートが対向に伝える フロー制御機能を設定する。 使用可能な値は以下の通り: \fISym\fP, \fISymOrRem\fP,
 138 \fILocSend\fP, \fINone\fP。 デフォルトは \fISymOrRem\fP である。 それぞれのモードには以下のような意味がある:
 139
 140 .br
 141 \fISym\fP
 142 = Symmetric
 143  リンクパートナの双方が PAUSE フレームを送ることができる。
 144 .br
 145 \fISymOrRem\fP
 146 = SymmetricOrRemote
 147  リンクパートナの双方またはリモートパートナのみが
 148 PAUSE フレームを送ることができる。
 149 .br
 150 \fILocSend\fP
 151 = LocalSend
 152  ローカルリンクパートナのみが PAUSE フレームを送ることができる。
 153 .br
 154 \fINone\fP
 155 = None
 156  リンクパートナのどちらも PAUSE フレームを送ることはできない。
 157
 158 このパラメータは AutoNeg_A が \fIOff\fP の場合には無視される点に注意すること。
 159 .TP
 160 \fBFlowCtrl_B=\fP\fIi,j,...\fP
 161 この引き数は自動設定時にポートが対向に伝える フロー制御機能を設定する。 使用可能な値は以下の通り: \fISym\fP, \fISymOrRem\fP,
 162 \fILocSend\fP, \fINone\fP。 デフォルトは \fISymOrRem\fP である。 それぞれのモードには以下のような意味がある:
 163
 164 \fISym\fP
 165 = Symmetric
 166  リンクパートナの双方が PAUSE フレームを送ることができる。
 167 .br
 168 \fISymOrRem\fP
 169 = SymmetricOrRemote
 170  リンクパートナの双方またはリモートパートナのみが
 171 PAUSE フレームを送ることができる。
 172 .br
 173 \fILocSend\fP
 174 = LocalSend
 175  ローカルリンクパートナのみが PAUSE フレームを送ることができる。
 176 .br
 177 \fINone\fP
 178 = None
 179  リンクパートナのどちらも PAUSE フレームを送ることはできない。
 180 .br
 181
 182 このパラメータは AutoNeg_B が \fIOff\fP の場合には無視される点に注意すること。
 183 .TP
 184 \fBRole_A=\fP\fIi,j,...\fP
 185 この引き数は 1000Base\-T アダプタカードでのみ有効である。 2 つの 1000Base\-T ポートが通信する場合、 片方が
 186 (タイミング情報を提供する) マスタの役割をしなければならず、 もう片方がスレーブにならなければならない。 使用可能な値は以下の通り: \fIAuto\fP,
 187 \fIMaster\fP, \fISlave\fP。 デフォルトは \fIAuto\fP である。 通常、ポートの役割は 2
 188 つのポートでリンクを確立するときに自動設定される。 自動設定に失敗した場合、 アダプタカードのポート A はこの引き数で指定された設定になる。
 189 .TP
 190 \fBRole_B=\fP\fIi,j,...\fP
 191 この引き数は 1000Base\-T アダプタカードでのみ有効である。 2 つの 1000Base\-T ポートが通信する場合、 片方が
 192 (タイミング情報を提供する) マスタの役割をしなければならず、 もう片方がスレーブにならなければならない。 使用可能な値は以下の通り: \fIAuto\fP,
 193 \fIMaster\fP, \fISlave\fP。 デフォルトは \fIAuto\fP である。 通常、ポートの役割は 2
 194 つのポートでリンクを確立するときに自動設定される。 自動設定に失敗した場合、 アダプタカードのポート B はこの引き数で指定された設定になる。
 195 .TP
 196 \fBConType=\fP\fIi,j,...\fP
 197 この引き数は、ポート毎に指定する、全部で 5 個の引き数の組み合わせを、 1 つの引き数にしたものである。 これによりアダプタカードの 2
 198 つのポートの設定を簡略化できる。 この変数のそれぞれの値は、 ポート引き数の最も意味のある組み合わせを反映したものである。
 199 使用可能な値とそれに対応するポート毎のパラメータの組み合わせは、 以下の通り:
 200
 201 .nf
 202 ConType | DupCap   AutoNeg   FlowCtrl   Role   Speed
 203 \-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 204 \fIAuto\fP    |  Both      On      SymOrRem   Auto   Auto
 205 .br
 206 \fI100FD\fP   |  Full      Off       None     Auto   100
 207 .br
 208 \fI100HD\fP   |  Half      Off       None     Auto   100
 209 .br
 210 \fI10FD\fP    |  Full      Off       None     Auto   10
 211 .br
 212 \fI10HD\fP    |  Half      Off       None     Auto   10
 213
 214 .fi
 215 その他のポート引き数を \fIConType\fP 引き数と組み合わせて指定すると、それらの設定を結合した設定となる。 これは、ポート毎の引き数 (例えば
 216 \fISpeed_A\fP)  の方が組み合わせ変数 \fIConType\fP より優先順位が高いためである。
 217 .TP
 218 \fBModeration=\fP\fIi,j,...\fP
 219 割り込み調停 (interrupt moderation) は、ドライバが処理を開始しなければ ならない割り込み回数の最大値を設定するために使用される。
 220 つまり、ドライバが処理を行うまで、1回以上の割り込み (送信または受信パケットが処理されること) がキューに入れられる。
 221 キューに入れられた割り込みがいつ処理されるかは、 以下で説明する \fIIntsPerSec\fP 引き数で決定される。 使用可能な調停モードは以下の通り:
 222 \fINone\fP, \fIStatic\fP, \fIDynamic\fP。 デフォルトは \fINone\fP である。 それぞれのモードは以下の意味を持つ:
 223
 224 \fINone\fP アダプタカードに対して割り込み調停を適用しない。 よって送信または受信割り込みは、
 225 アダプタカードの割り込み線に現れると直ぐに処理される。
 226
 227 .br
 228 \fIStatic\fP アダプタカードに対して割り込み調停が適用される。 全ての送信または受信割り込みは、調停間隔が完全に終わるまで キューに入れられる。
 229 この調停間隔が終わると、キューに入れられた全ての割り込みは、 1個の大きな塊として遅延なく処理される。 \fIStatic\fP
 230 という用語は、あるインタフェースに現在どれだけの ネットワーク負荷がかかっているかに関わらず、 割り込み調停が常に有効になることを表している。
 231 さらに、調停間隔の時間は固定で、ドライバが動作している間は変化しない。
 232
 233 .br
 234 \fIDynamic\fP システムの負荷に応じて、アダプタカードに対して割り込み調停が適用される。 ドライバがシステムの負荷が高すぎると検出した場合、
 235 割り込み調停を有効にすることにより、 過剰なネットワーク負荷からシステムを保護しようとする。 \(emその後に\(emCPU 利用率が再び下がった場合
 236 (またはネットワーク負荷が極わずかになった場合)、 割り込み調停は自動的に無効にされる。
 237
 238 ドライバが扱わなければならないインタフェースのうち ネットワーク負荷が高いものが 1 つ以上あり、 \(emその結果\(emCPU
 239 利用率が高くなっている場合、 割り込み調停を使うべきである。 ネットワーク負荷が高い状況で調停が適用されると、 遅いコンピュータでは CPU 負荷が
 240 20\-30% 削減されるだろう。
 241
 242 割り込み調停を使うことの欠点として、 往復遅延時間 (round\-trip\-time, RTT) の増加がある点に注意すること。
 243 これは、割り込みがキューに入れられ、まとめて処理されるためである。
 244 .TP
 245 \fBIntsPerSec=\fP\fIi,j,...\fP
 246 この引き数は割り込み調停の間隔を決定する。 静的 (static) 割り込み調停が使われている場合、 \fIIntsPerSec\fP 引き数の値が 2000
 247 であれば、割り込み調停の間隔は 500 ミリ秒になる。 この引き数に設定可能な値は 30...40000 の範囲で、 これは 1
 248 秒毎の割り込み回数である。 デフォルト値は 2000 である。
 249
 250 この引き数は静的 (static) または動的 (dynamic) 割り込み調停が 有効になっているときにのみ使用される。
 251 この引き数は割り込み調停が適用されていない場合には無視される。
 252
 253 調停間隔の期間は注意して選ぶこと。 一見したところでは、とても長い期間 (例えば 1 秒間に 100 回だけの割り込み) を
 254 選ぶことに意味があるように見えるかもしれないが、そうすると パケット処理の遅延が激しく増加する。
 255 一方で、とても短い調停時間を選ぶと、割り込み調停を使う意味がなくなってしまう。
 256 .TP
 257 \fBPrefPort=\fP\fIi,j,...\fP
 258 この引き数は (2 ポートのネットワークアダプタで)  優先 (preferred) ポートを A または B のどちらにするかを指定するのに使われる。
 259 優先ポートとは、A と B の両方のポートが完全に機能していると検知された場合に 使用されるポートである。 使用可能な値は以下の通り: \fIA\fP または
 260 \fIB\fP。 デフォルトは \fIA\fP である。
 261 .TP
 262 \fBRlmtMode=\fP\fIi,j,...\fP
 263 RLMT はポートの状態を監視する。 アクティブなポートのリンクが落ちた場合、 RLMT は即時に待機しているリンクに切り替える。 少なくとも 1
 264 つの「物理的」リンクが起動するまでは、仮想リンクが維持される。 この引き数は RLMT が両方のポートをどのように監視するかを決める。
 265 使用可能な値は以下の通り: \fICheckLinkState\fP, \fICheckLocalPort\fP, \fICheckSeg\fP, \fIDualNet\fP。
 266 デフォルトは \fICheckLinkState\fP である。 各モードは以下のような意味を持つ。
 267
 268 \fICheckLinkState\fP リンク状態のチェックのみ: RLMT は、各ポートについてアダプタハードウェアが報告するリンク状態を使い、
 269 そのポートが全てのネットワークトラフィックを送受信するのに使用可能かを 決定する。
 270
 271 .br
 272 \fICheckLocalPort\fP このモードでは、RLMT はアダプタカードの 2 つのポートの間で 定期的にパケットを交換することにより、 2
 273 つのポートの間のネットワーク経路を監視する。 このモードでは 2 つのポートが互いに「見える」ような ネットワーク設定が必要である
 274 (つまり、ポート間にルータがあってはならない)。
 275
 276 .br
 277 \fICheckSeg\fP ローカルポートとセグメントをチェックする。 このモードは CheckLocalPort モードと同じ機能を提供し、
 278 更にポート間のネットワークセグメントをチェックする。 よって、このモードはネットワーク上に スパニングツリープロトコル (Spanning Tree
 279 protocol) を 使うように設定されたギガビットイーサネットスイッチが 設置されている場合にのみ使用できる。
 280
 281 .br
 282 \fIDualNet\fP このモードでは、ポート A と B が別々のデバイスとして使用される。 2 ポートのアダプタを持っている場合、ポート A を
 283 \fIeth[x]\fP に、ポート B を \fIeth[x+1]\fP に設定することができる。 2 つのポートは別々の IP
 284 アドレスを付けて独立に使用することができる。 優先ポートの設定は使用されない。 RLMT は無効にされる。
 285
 286 RLMT モード \fICheckLocalPort\fP と \fICheckLinkState\fP は、1
 287 つのアダプタ上のポート間でネットワーク経路があるような設定で 動作するように設計されている。 さらに、このモードはアダプタ同士が直結
 288 (back\-to\-back) で 接続されている状態で動作するようには設計されていない。
 289 .SH ファイル
 290 .TP
 291 \fI/proc/net/sk98lin/eth[x]\fP
 292 .br
 293 アダプタカードの特定のインタフェースの統計ファイル。 このファイルには、アダプタカードの一般的な情報と、
 294 全ての送信・受信カウンタの詳細な一覧が含まれる。
 295 .TP
 296 \fI/usr/src/linux/Documentation/networking/sk98lin.txt\fP
 297 .br
 298 \fIsk98lin\fP ドライバの \fIREADME\fP ファイルである。 これには詳細なインストール HOWTO が含まれており、
 299 ドライバの全ての引き数が記述されている。 また一般的な問題とその解決法についても書かれている。
 300 .SH バグ
 301 .\" .SH AUTHORS
 302 .\" Ralph Roesler \(em rroesler@syskonnect.de
 303 .\" .br
 304 .\" Mirko Lindner \(em mlindner@syskonnect.de
 305 バグは linux@syskonnect.de に報告してほしい。
 306 .SH 関連項目
 307 \fBinsmod\fP(8), \fBifconfig\fP(8), \fBmodprobe\fP(8)
 308 .SH この文書について
 309 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
 310 である。プロジェクトの説明とバグ報告に関する情報は
 311 http://www.kernel.org/doc/man\-pages/ に書かれている。