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