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