OSDN Git Service

(split) Convert release and draft pages to UTF-8.
[linuxjm/LDP_man-pages.git] / release / 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 .\" Japanese Version Copyright (c) 2004 Yuichi SATO
26 .\"         all rights reserved.
27 .\" Translated 2004-10-09, Yuichi SATO <ysato444@yahoo.co.jp>
28 .\" Modified 2007-06-05, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.51
29 .\"
30 .\"WORD:        autonegotiation 自動設定
31 .\"WORD:        interrupt moderation    割り込み調停
32 .\"
33 .TH SK98LIN 4 2007-11-25 "Linux" "Linux Programmer's Manual"
34 .SH 名前
35 sk98lin \- Marvell/SysKonnect ギガビットイーサネットドライバ v6.21
36 .SH 書式
37 .B insmod sk98lin.o
38 .RB [ Speed_A=\c
39 .IR i,j,... ]
40 .RB [ Speed_B=\c
41 .IR i,j,... ]
42 .RB [ AutoNeg_A=\c
43 .IR i,j,... ]
44 .RB [ AutoNeg_B=\c
45 .IR i,j,... ]
46 .RB [ DupCap_A=\c
47 .IR i,j,... ]
48 .RB [ DupCap_B=\c
49 .IR i,j,... ]
50 .RB [ FlowCtrl_A=\c
51 .IR i,j,... ]
52 .RB [ FlowCtrl_B=\c
53 .IR i,j,... ]
54 .RB [ Role_A=\c
55 .IR i,j,... ]
56 .RB [ Role_B=\c
57 .IR i,j,... ]
58 .RB [ ConType=\c
59 .IR i,j,... ]
60 .RB [ Moderation=\c
61 .IR i,j,... ]
62 .RB [ IntsPerSec=\c
63 .IR i,j,... ]
64 .RB [ PrefPort=\c
65 .IR i,j,... ]
66 .RB [ RlmtMode=\c
67 .IR i,j,... ]
68 .SH 説明
69 .ad l
70 .hy 0
71 .B sk98lin
72 は Marvell と SysKonnect のネットワークアダプタカードの
73 ギガビットイーサネットドライバである。
74 これは SysKonnect SK-98xx/SK-95xx 互換のギガビットイーサネットアダプタと
75 Yukon 互換のチップセットをサポートしている。
76
77 insmod を使ってドライバをロードする際、
78 ネットワークアダプタカードのパラメータを
79 コンマで区切られたコマンドの列として指定することができる。
80 2 つのネットワークアダプタが取り付けられている時に、
81 例えば、1 つ目のアダプタのポート A の自動ネゴシエーションは ON にするが、
82 2 つ目のアダプタのポート A は OFF にする場合は、
83 以下のように入力すればよい:
84
85    insmod sk98lin.o AutoNeg_A=On,Off
86
87 .B sk98lin
88 が 1 つ以上のアダプタカードに関連づけられていて、
89 かつ
90 .I /proc
91 ファイルシステムがシステムにマウントされている場合、
92 取り付けられているネットワークアダプタカードの全てのポートについて、
93 (ポート単位に) 専用の統計ファイルがフォルダ
94 .I /proc/net/sk98lin
95 に作られる。
96 これらのファイルは
97 .I eth[x]
98 という名前であり、
99 .I x
100 はインタフェースの番号である。
101 この番号はシステムによってポート毎に割り当てられたものである。
102
103 ロードが完了すると、
104 .BR ifconfig (8)
105 コマンドを使って、各
106 .I eth[x]
107 インタフェースに希望する IP アドレスを割り当てることができる。
108 これによりアダプタがイーサネットに接続され、
109 コンソールに状態メッセージが表示される。
110 このメッセージでは、
111 "ethx: network connection up using port y" の後に
112 設定されたり検出された接続パラメータが表示される。
113
114 .B sk98lin
115 はラージフレーム (ジャンボフレームとも呼ばれる) もサポートする。
116 ジャンボフレームを使うと、大量のデータを転送する際に、
117 スループットを大幅に向上させることができる。
118 ラージフレームを有効にするには、
119 インタフェースの MTU (maximum transfer unit, 最大転送単位) サイズを
120 大きな値に設定すればよい。
121 デフォルトの MTU サイズは 1500 であり、
122 最大で 9000 (バイト) まで設定することができる。
123 MTU サイズを設定するのは、
124 インタフェースに IP アドレスを割り当てるときにもできるし、後から
125 .BR ifconfig (8)
126 コマンドに mtu 引き数を指定することで設定することもできる。
127 例えば、eth0 に IP アドレスとラージフレーム MTU サイズを
128 割り当てたい場合、以下の 2 つのコマンドを実行すればよい:
129
130     ifconfig eth0 10.1.1.1
131     ifconfig eth0 mtu 9000
132
133 これらの 2 つのコマンドは 1 つにまとめることもできる:
134
135     ifconfig eth0 10.1.1.1 mtu 9000
136
137 ラージフレームを使用できるのは、ネットワーク環境全体で
138 ラージフレームの使用が認められている場合のみである点に注意すること。
139 つまり、イーサネットで使われている全てのスイッチでも
140 ラージフレームがサポートされていなければならない。
141 多くのスイッチがラージフレームをサポートしてはいるが、
142 設定を行う必要がある。
143 多くの場合、デフォルトの設定では標準フレーム
144 (1500 バイトの MTU サイズ) だけしかサポートしない。
145 ネットワーク内のスイッチに加え、
146 使用される全てのネットワークアダプタでも
147 ジャンボフレームが有効になっていなければならない。
148 アダプタがラージフレームを受け取るように設定されていない場合、
149 アダプタはそのフレームを単純に捨ててしまう。
150
151 標準のイーサネットフレームサイズに戻すのは、再び
152 .BR ifconfig (8)
153 コマンドを使えばよい:
154
155     ifconfig eth0 mtu 1500
156
157 Linux の Marvell/SysKonnect ギガビットイーサネットドライバは、
158 IEEE 規格 802.1, 802.1q, 802.3ad に準拠する
159 VLAN と Link Aggregation に対応している。
160 これらの機能は、インターネットにあるオープンソースモジュールを
161 インストールした後でのみ利用可能である:
162
163 .IR VLAN \c
164 : http://www.candelatech.com/~greear/vlan.html
165 .br
166 .I Link
167 .IR Aggregation \c
168 : http://www.st.rim.or.jp/~yumo
169
170 .br
171 Marvell/SysKonnect は、これらのオープンソースモジュールに対するサポートは
172 行っておらず、これらを使った場合に生じるいかなる失敗や問題についても
173 責任を負わない点に注意すること。
174 .SS 引き数
175 .TP
176 .BI Speed_A= i,j,...
177 このパラメータはアダプタカードのポート A がサポートするリンク速度を
178 設定するのに使われる。これは Yukon copper アダプタでのみ有効である。
179 使用可能な値は以下の通り:
180 .IR 10 ,
181 .IR 100 ,
182 .IR 1000 ,
183 .IR Auto 。
184 デフォルトは
185 .I Auto
186 である。
187 通常、リンク速度はリンクの確立時に 2 つのポートの間で自動設定される。
188 これに失敗した場合、ポートはこの引き数で指定された設定になる。
189 .TP
190 .BI Speed_B= i,j,...
191 このパラメータはアダプタカードのポート B がサポートするリンク速度を
192 設定するのに使われる。これは Yukon copper アダプタでのみ有効である。
193 使用可能な値は以下の通り:
194 .IR 10 ,
195 .IR 100 ,
196 .IR 1000 ,
197 .IR Auto 。
198 デフォルトは
199 .I Auto
200 である。
201 通常、リンク速度はリンクの確立時に 2 つのポートの間で自動設定される。
202 これに失敗した場合、ポートはこの引き数で指定された設定になる。
203 .TP
204 .BI AutoNeg_A= i,j,...
205 アダプタカードのポート A の自動設定 (autonegotiation) の使用を
206 有効または無効にする。使用可能な値は以下の通り:
207 .IR On ,
208 .IR Off ,
209 .IR Sense 。
210 デフォルトは
211 .I On
212 である。
213 .I Sense
214 モードはリンクパートナが自動設定をサポートしているか否かを
215 自動的に検知する。
216 .TP
217 .BI AutoNeg_B= i,j,...
218 アダプタカードのポート B の自動設定 (autonegotiation) の使用を
219 有効または無効にする。使用可能な値は以下の通り:
220 .IR On ,
221 .IR Off ,
222 .IR Sense 。
223 デフォルトは
224 .I On
225 である。
226 .I Sense
227 モードはリンクパートナが自動設定をサポートしているか否かを
228 自動的に検知する。
229 .TP
230 .BI DupCap_A= i,j,...
231 この引き数はアダプタカードのポート A で使う二重通信 (duplex) モードを示す。
232 使用可能な値は以下の通り:
233 .IR Half ,
234 .IR Full ,
235 .IR Both 。
236 デフォルトは
237 .I Both
238 である。
239 この引き数はポート A の AutoNeg_A が
240 .I Sense
241 に設定されていない場合にのみ有効である。
242 AutoNeg_A が
243 .I On
244 の場合、DupCap_A の 3 つの値
245 .RI ( Half ,
246 .IR Full ,
247 .IR Both )
248 のうちどれでも指定することができる。
249 AutoNeg_A が
250 .I Off
251 の場合、DupCap_A の値
252 .I Full
253
254 .I Half
255 のみを指定することができる。
256 この DupCap_A 引き数は、リンクパートナが全ての二重通信の組み合わせを
257 サポートしていない場合に役に立つ。
258 .TP
259 .BI DupCap_B= i,j,...
260 この引き数はアダプタカードのポート B で使う二重通信モードを示す。
261 使用可能な値は以下の通り:
262 .IR Half ,
263 .IR Full ,
264 .IR Both 。
265 デフォルトは
266 .I Both
267 である。
268 この引き数はポート B の AutoNeg_B が
269 .I Sense
270 に設定されていない場合にのみ有効である。
271 AutoNeg_B が
272 .I On
273 の場合、DupCap_B の 3 つの値
274 .RI ( Half ,
275 .IR Full ,
276 .IR Both )
277 のうちどれでも指定することができる。
278 AutoNeg_B が
279 .I Off
280 の場合、DupCap_B の値
281 .I Full
282
283 .I Half
284 のみを指定することができる。
285 この DupCap_B 引き数は、リンクパートナが全ての二重通信の組み合わせを
286 サポートしていない場合に役に立つ。
287 .TP
288 .BI FlowCtrl_A= i,j,...
289 この引き数は自動設定時にポートが対向に伝える
290 フロー制御機能を設定する。
291 使用可能な値は以下の通り:
292 .IR Sym ,
293 .IR SymOrRem ,
294 .IR LocSend ,
295 .IR None 。
296 デフォルトは
297 .I SymOrRem
298 である。
299 それぞれのモードには以下のような意味がある:
300
301 .br
302 .I Sym
303 = Symmetric
304  リンクパートナの双方が PAUSE フレームを送ることができる。
305 .br
306 .I SymOrRem
307 = SymmetricOrRemote
308  リンクパートナの双方またはリモートパートナのみが
309 PAUSE フレームを送ることができる。
310 .br
311 .I LocSend
312 = LocalSend
313  ローカルリンクパートナのみが PAUSE フレームを送ることができる。
314 .br
315 .I None
316 = None
317  リンクパートナのどちらも PAUSE フレームを送ることはできない。
318
319 このパラメータは AutoNeg_A が
320 .I Off
321 の場合には無視される点に注意すること。
322 .TP
323 .BI FlowCtrl_B= i,j,...
324 この引き数は自動設定時にポートが対向に伝える
325 フロー制御機能を設定する。
326 使用可能な値は以下の通り:
327 .IR Sym ,
328 .IR SymOrRem ,
329 .IR LocSend ,
330 .IR None 。
331 デフォルトは
332 .I SymOrRem
333 である。
334 それぞれのモードには以下のような意味がある:
335
336 .I Sym
337 = Symmetric
338  リンクパートナの双方が PAUSE フレームを送ることができる。
339 .br
340 .I SymOrRem
341 = SymmetricOrRemote
342  リンクパートナの双方またはリモートパートナのみが
343 PAUSE フレームを送ることができる。
344 .br
345 .I LocSend
346 = LocalSend
347  ローカルリンクパートナのみが PAUSE フレームを送ることができる。
348 .br
349 .I None
350 = None
351  リンクパートナのどちらも PAUSE フレームを送ることはできない。
352 .br
353
354 このパラメータは AutoNeg_B が
355 .I Off
356 の場合には無視される点に注意すること。
357 .TP
358 .BI Role_A= i,j,...
359 この引き数は 1000Base-T アダプタカードでのみ有効である。
360 2 つの 1000Base-T ポートが通信する場合、
361 片方が (タイミング情報を提供する) マスタの役割をしなければならず、
362 もう片方がスレーブにならなければならない。
363 使用可能な値は以下の通り:
364 .IR Auto ,
365 .IR Master ,
366 .IR Slave 。
367 デフォルトは
368 .I Auto
369 である。
370 通常、ポートの役割は 2 つのポートでリンクを確立するときに自動設定される。
371 自動設定に失敗した場合、
372 アダプタカードのポート A はこの引き数で指定された設定になる。
373 .TP
374 .BI Role_B= i,j,...
375 この引き数は 1000Base-T アダプタカードでのみ有効である。
376 2 つの 1000Base-T ポートが通信する場合、
377 片方が (タイミング情報を提供する) マスタの役割をしなければならず、
378 もう片方がスレーブにならなければならない。
379 使用可能な値は以下の通り:
380 .IR Auto ,
381 .IR Master ,
382 .IR Slave 。
383 デフォルトは
384 .I Auto
385 である。
386 通常、ポートの役割は 2 つのポートでリンクを確立するときに自動設定される。
387 自動設定に失敗した場合、
388 アダプタカードのポート B はこの引き数で指定された設定になる。
389 .TP
390 .BI ConType= i,j,...
391 この引き数は、ポート毎に指定する、全部で 5 個の引き数の組み合わせを、
392 1 つの引き数にしたものである。
393 これによりアダプタカードの 2 つのポートの設定を簡略化できる。
394 この変数のそれぞれの値は、
395 ポート引き数の最も意味のある組み合わせを反映したものである。
396 使用可能な値とそれに対応するポート毎のパラメータの組み合わせは、
397 以下の通り:
398
399 .nf
400 ConType | DupCap   AutoNeg   FlowCtrl   Role   Speed
401 --------+-------------------------------------------
402 \fIAuto\fP    |  Both      On      SymOrRem   Auto   Auto
403 .br
404 \fI100FD\fP   |  Full      Off       None     Auto   100
405 .br
406 \fI100HD\fP   |  Half      Off       None     Auto   100
407 .br
408 \fI10FD\fP    |  Full      Off       None     Auto   10
409 .br
410 \fI10HD\fP    |  Half      Off       None     Auto   10
411
412 .fi
413 その他のポート引き数を
414 .I ConType
415 引き数と組み合わせて指定すると、それらの設定を結合した設定となる。
416 これは、ポート毎の引き数 (例えば
417 .IR Speed_A )
418 の方が組み合わせ変数
419 .I ConType
420 より優先順位が高いためである。
421 .TP
422 .BI Moderation= i,j,...
423 割り込み調停 (interrupt moderation) は、ドライバが処理を開始しなければ
424 ならない割り込み回数の最大値を設定するために使用される。
425 つまり、ドライバが処理を行うまで、1回以上の割り込み
426 (送信または受信パケットが処理されること) がキューに入れられる。
427 キューに入れられた割り込みがいつ処理されるかは、
428 以下で説明する
429 .I IntsPerSec
430 引き数で決定される。
431 使用可能な調停モードは以下の通り:
432 .IR None ,
433 .IR Static ,
434 .IR Dynamic 。
435 デフォルトは
436 .I None
437 である。
438 それぞれのモードは以下の意味を持つ:
439
440 .I None
441 アダプタカードに対して割り込み調停を適用しない。
442 よって送信または受信割り込みは、
443 アダプタカードの割り込み線に現れると直ぐに処理される。
444
445 .br
446 .I Static
447 アダプタカードに対して割り込み調停が適用される。
448 全ての送信または受信割り込みは、調停間隔が完全に終わるまで
449 キューに入れられる。
450 この調停間隔が終わると、キューに入れられた全ての割り込みは、
451 1個の大きな塊として遅延なく処理される。
452 .I Static
453 という用語は、あるインタフェースに現在どれだけの
454 ネットワーク負荷がかかっているかに関わらず、
455 割り込み調停が常に有効になることを表している。
456 さらに、調停間隔の時間は固定で、ドライバが動作している間は変化しない。
457
458 .br
459 .I Dynamic
460 システムの負荷に応じて、アダプタカードに対して割り込み調停が適用される。
461 ドライバがシステムの負荷が高すぎると検出した場合、
462 割り込み調停を有効にすることにより、
463 過剰なネットワーク負荷からシステムを保護しようとする。
464 \(emその後に\(emCPU 利用率が再び下がった場合
465 (またはネットワーク負荷が極わずかになった場合)、
466 割り込み調停は自動的に無効にされる。
467
468 ドライバが扱わなければならないインタフェースのうち
469 ネットワーク負荷が高いものが 1 つ以上あり、
470 \(emその結果\(emCPU 利用率が高くなっている場合、
471 割り込み調停を使うべきである。
472 ネットワーク負荷が高い状況で調停が適用されると、
473 遅いコンピュータでは CPU 負荷が 20-30% 削減されるだろう。
474
475 割り込み調停を使うことの欠点として、
476 往復遅延時間 (round-trip-time, RTT) の増加がある点に注意すること。
477 これは、割り込みがキューに入れられ、まとめて処理されるためである。
478 .TP
479 .BI IntsPerSec= i,j,...
480 この引き数は割り込み調停の間隔を決定する。
481 静的 (static) 割り込み調停が使われている場合、
482 .I IntsPerSec
483 引き数の値が 2000 であれば、割り込み調停の間隔は 500 ミリ秒になる。
484 この引き数に設定可能な値は 30...40000 の範囲で、
485 これは 1 秒毎の割り込み回数である。
486 デフォルト値は 2000 である。
487
488 この引き数は静的 (static) または動的 (dynamic) 割り込み調停が
489 有効になっているときにのみ使用される。
490 この引き数は割り込み調停が適用されていない場合には無視される。
491
492 調停間隔の期間は注意して選ぶこと。
493 一見したところでは、とても長い期間 (例えば 1 秒間に 100 回だけの割り込み) を
494 選ぶことに意味があるように見えるかもしれないが、そうすると
495 パケット処理の遅延が激しく増加する。
496 一方で、とても短い調停時間を選ぶと、割り込み調停を使う意味がなくなってしまう。
497 .TP
498 .BI PrefPort= i,j,...
499 この引き数は (2 ポートのネットワークアダプタで)
500 優先 (preferred) ポートを A または B のどちらにするかを指定するのに使われる。
501 優先ポートとは、A と B の両方のポートが完全に機能していると検知された場合に
502 使用されるポートである。
503 使用可能な値は以下の通り:
504 .I A
505 または
506 .IR B 。
507 デフォルトは
508 .I A
509 である。
510 .TP
511 .BI RlmtMode= i,j,...
512 RLMT はポートの状態を監視する。
513 アクティブなポートのリンクが落ちた場合、
514 RLMT は即時に待機しているリンクに切り替える。
515 少なくとも 1 つの「物理的」リンクが起動するまでは、仮想リンクが維持される。
516 この引き数は RLMT が両方のポートをどのように監視するかを決める。
517 使用可能な値は以下の通り:
518 .IR CheckLinkState ,
519 .IR CheckLocalPort ,
520 .IR CheckSeg ,
521 .IR DualNet 。
522 デフォルトは
523 .I CheckLinkState
524 である。
525 各モードは以下のような意味を持つ。
526
527 .I CheckLinkState
528 リンク状態のチェックのみ:
529 RLMT は、各ポートについてアダプタハードウェアが報告するリンク状態を使い、
530 そのポートが全てのネットワークトラフィックを送受信するのに使用可能かを
531 決定する。
532
533 .br
534 .I CheckLocalPort
535 このモードでは、RLMT はアダプタカードの 2 つのポートの間で
536 定期的にパケットを交換することにより、
537 2 つのポートの間のネットワーク経路を監視する。
538 このモードでは 2 つのポートが互いに「見える」ような
539 ネットワーク設定が必要である
540 (つまり、ポート間にルータがあってはならない)。
541
542 .br
543 .I CheckSeg
544 ローカルポートとセグメントをチェックする。
545 このモードは CheckLocalPort モードと同じ機能を提供し、
546 更にポート間のネットワークセグメントをチェックする。
547 よって、このモードはネットワーク上に
548 スパニングツリープロトコル (Spanning Tree protocol) を
549 使うように設定されたギガビットイーサネットスイッチが
550 設置されている場合にのみ使用できる。
551
552 .br
553 .I DualNet
554 このモードでは、ポート A と B が別々のデバイスとして使用される。
555 2 ポートのアダプタを持っている場合、ポート A を
556 .I eth[x]
557 に、ポート B を
558 .I eth[x+1]
559 に設定することができる。
560 2 つのポートは別々の IP アドレスを付けて独立に使用することができる。
561 優先ポートの設定は使用されない。
562 RLMT は無効にされる。
563
564 RLMT モード
565 .I CheckLocalPort
566
567 .I CheckLinkState
568 は、1 つのアダプタ上のポート間でネットワーク経路があるような設定で
569 動作するように設計されている。
570 さらに、このモードはアダプタ同士が直結 (back-to-back) で
571 接続されている状態で動作するようには設計されていない。
572 .SH ファイル
573 .TP
574 .I /proc/net/sk98lin/eth[x]
575 .br
576 アダプタカードの特定のインタフェースの統計ファイル。
577 このファイルには、アダプタカードの一般的な情報と、
578 全ての送信・受信カウンタの詳細な一覧が含まれる。
579 .TP
580 .I /usr/src/linux/Documentation/networking/sk98lin.txt
581 .br
582 .I sk98lin
583 ドライバの
584 .I README
585 ファイルである。
586 これには詳細なインストール HOWTO が含まれており、
587 ドライバの全ての引き数が記述されている。
588 また一般的な問題とその解決法についても書かれている。
589 .SH バグ
590 バグは linux@syskonnect.de に報告してほしい。
591 .\" .SH 著者
592 .\" Ralph Roesler \(em rroesler@syskonnect.de
593 .\" .br
594 .\" Mirko Lindner \(em mlindner@syskonnect.de
595 .SH 関連項目
596 .BR insmod (8),
597 .BR ifconfig (8),
598 .BR modprobe (8)