/[gentoo]/xml/htdocs/doc/en/usb-guide.xml
Gentoo

Diff of /xml/htdocs/doc/en/usb-guide.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.17 Revision 1.18
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/usb-guide.xml,v 1.17 2008/05/19 21:04:48 swift Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/usb-guide.xml,v 1.18 2008/06/22 01:13:02 nightmorph Exp $ -->
3
4<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
5 4
6<guide link="/doc/en/usb-guide.xml"> 5<guide link="/doc/en/usb-guide.xml">
7<title>Gentoo Linux USB Guide</title> 6<title>Gentoo Linux USB Guide</title>
8 7
17 16
18<!-- The content of this document is licensed under the CC-BY-SA license --> 17<!-- The content of this document is licensed under the CC-BY-SA license -->
19<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 18<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
20<license/> 19<license/>
21 20
22<version>1.13</version> 21<version>1.14</version>
23<date>2007-04-09</date> 22<date>2008-06-21</date>
24 23
25<chapter> 24<chapter>
26<title>Introduction</title> 25<title>Introduction</title>
27<section> 26<section>
28<title>What is USB?</title> 27<title>What is USB?</title>
146<title>Kernel Configuration</title> 145<title>Kernel Configuration</title>
147<section> 146<section>
148<title>Getting the kernel</title> 147<title>Getting the kernel</title>
149<body> 148<body>
150 149
151<note>
152Since the 2005.0 release, Gentoo Linux uses 2.6 as the default kernel. Unless
153you are specifically using the 2.4 profile, <c>gentoo-sources</c> will be a
1542.6 kernel on <e>most</e> architectures. Please check your kernel version and
155then proceed with the configuration accordingly.
156</note>
157
158<p> 150<p>
159First emerge the kernel sources of your choice. Here we'll use the 151First emerge the kernel sources of your choice. Here we'll use the
160<c>gentoo-sources</c>. For more information on the various kernel sources 152<c>gentoo-sources</c>. For more information on the various kernel sources
161available on Portage, please look up the <uri 153available on Portage, please look up the <uri
162link="/doc/en/gentoo-kernel.xml">Gentoo Linux Kernel Guide</uri>. 154link="/doc/en/gentoo-kernel.xml">Gentoo Linux Kernel Guide</uri>.
180the kernel sources you want to use. Please ensure the same before proceeding. 172the kernel sources you want to use. Please ensure the same before proceeding.
181</note> 173</note>
182 174
183</body> 175</body>
184</section> 176</section>
185<section id="newkernelconfig"> 177<section>
186<title>Config options for the 2.6.x kernel</title> 178<title>Config options for the kernel</title>
187<body> 179<body>
188 180
189<p> 181<p>
190Now we will look at some of the options we will have to enable in the 2.6 182Now we will look at some of the options we will have to enable in the kernel to
191kernel to ensure proper USB support for our devices. If you are using a 2.4 183ensure proper USB support for our devices.
192kernel, please proceed with <uri link="#oldkernelconfig">Config options for the
1932.4.x kernel</uri>.
194</p> 184</p>
195 185
196<note> 186<note>
197Examples in this document will show configuration options for basic USB 187Examples in this document will show configuration options for basic USB
198support as well as those needed commonly, for example a USB mass storage 188support as well as those needed commonly, for example a USB mass storage
203have the options compiled into the kernel. If you would like to have a modular 193have the options compiled into the kernel. If you would like to have a modular
204kernel, ensure that you note down the various modules and adjust your config 194kernel, ensure that you note down the various modules and adjust your config
205files accordingly. 195files accordingly.
206</note> 196</note>
207 197
208<pre caption="make menuconfig options for 2.6 kernels"> 198<pre caption="make menuconfig options">
209Device Drivers ---&gt; 199Device Drivers ---&gt;
210 SCSI device support ---&gt; 200 SCSI device support ---&gt;
211 201
212<comment>(Although SCSI will be enabled automatically when selecting USB Mass Storage, 202<comment>(Although SCSI will be enabled automatically when selecting USB Mass Storage,
213we need to enable disk support.)</comment> 203we need to enable disk support.)</comment>
234<comment>(Moving a little further down, we come to CDC and mass storage.)</comment> 224<comment>(Moving a little further down, we come to CDC and mass storage.)</comment>
235&lt; &gt; USB Modem (CDC ACM) support 225&lt; &gt; USB Modem (CDC ACM) support
236&lt;*&gt; USB Printer support 226&lt;*&gt; USB Printer support
237&lt;*&gt; USB Mass Storage support 227&lt;*&gt; USB Mass Storage support
238 228
239<comment>(Then the HID bits.
240You have to select HID input support if you have a USB keyboard,
241mouse, joystick or any other USB input device)</comment>
242--- USB Input Devices
243&lt;*&gt; USB Human Interface Device (full HID) support
244 [*] HID input layer support
245
246<comment>(If you have a USB Network Card like the RTL8150, you'll need this)</comment> 229<comment>(If you have a USB Network Card like the RTL8150, you'll need this)</comment>
247USB Network Adapters ---> 230USB Network Adapters --->
248 &lt;*&gt; USB RTL8150 based ethernet device support (EXPERIMENTAL) 231 &lt;*&gt; USB RTL8150 based ethernet device support (EXPERIMENTAL)
249 232
250<comment>(If you have a serial to USB converter like the Prolific 2303, you'll need this)</comment> 233<comment>(If you have a serial to USB converter like the Prolific 2303, you'll need this)</comment>
252 &lt;*&gt; USB Serial Converter support 235 &lt;*&gt; USB Serial Converter support
253 &lt;*&gt; USB Prolific 2303 Single Port Serial Driver (NEW) 236 &lt;*&gt; USB Prolific 2303 Single Port Serial Driver (NEW)
254</pre> 237</pre>
255 238
256<p> 239<p>
240If you have a USB keyboard, mouse, joystick, or any other input device, you need
241to enable HID support. Go back one level to "Device drivers" and enable HID
242support as shown:
243</p>
244
245<pre caption="Enabling HID support">
246Device Drivers ---&gt;
247 [*] HID Devices ---&gt;
248 &lt;*&gt; USB Human Interface Device (full HID) support
249</pre>
250
251<p>
257Now that your options are set, you can (re)compile the kernel and USB support 252Now that your options are set, you can (re)compile the kernel and USB support
258should be functional once you reboot into the new kernel. You can now proceed 253should be functional once you reboot into the new kernel. You can now proceed
259to <uri link="#postkern">Seeing USB at work</uri> and see if everything is 254to <uri link="#postkern">Seeing USB at work</uri> and see if everything is
260working as it should. 255working as it should.
261</p>
262
263</body>
264</section>
265<section id="oldkernelconfig">
266<title>Config options for the 2.4.x kernel</title>
267<body>
268
269<p>
270We will look at the options the we will have to enable in the 2.4 kernel to
271ensure proper USB support for our devices. If you are using a 2.6 kernel,
272please look at <uri link="#newkernelconfig">Config options for the 2.6.x
273kernel</uri>.
274</p>
275
276<note>
277Examples in this document will show configuration options for basic USB
278support as well as those needed commonly, for example a USB mass storage
279device (most cameras and USB pen drives). If you have a specific USB device
280that needs to be configured, please look up your device's manual or search
281online to see if that device has support built-in into the kernel or custom
282drivers that you can use. Please note that for the sake of ease, all examples
283have the options compiled into the kernel. If you would like to have a modular
284kernel, ensure that you note down the various modules and adjust your config
285files accordingly.
286</note>
287
288<pre caption="make menuconfig options for 2.4 kernels">
289<comment>(This immediate config is only for those who have USB input devices.
290Input core support is needed by USB HID later.)</comment>
291Input core support ---&gt;
292 &lt;*&gt; Input core support
293 &lt; &gt; Keyboard support
294 &lt; &gt; Mouse support
295 &lt; &gt; Event interface support
296
297USB support ---&gt;
298
299<comment>(This is the root hub and is required for USB support.
300If you'd like to compile this as a module, it will be called usbcore.o)</comment>
301&lt;*&gt; Support for USB
302
303<comment>(Enable this option to see your USB devices in /proc/bus/usb.
304This is recommended.)</comment>
305 [*] Preliminary USB device filesystem
306
307<comment>(Select at least one of the HCDs. If you are unsure, picking all is fine.)</comment>
308--- USB Host Controller Drivers
309&lt;*&gt; UHCI Alternate Driver (JE) support
310&lt; &gt; OHCI (Compaq, iMacs, OPTi, SiS, ALi, ...) support
311
312<comment>(This is the device section. Select only what you need.)</comment>
313--- USB Device Class drivers
314&lt; &gt; USB Audio support
315&lt;*&gt; USB Mass Storage support
316&lt; &gt; USB Modem (CDC ACM) support
317&lt;*&gt; USB Printer support
318
319<comment>(Followed by the HID section. This is needed if you have an USB based input device.)</comment>
320--- USB Human Interface Devices (HID)
321&lt;*&gt; USB Human Interface Device (full HID) support
322 [*] HID input layer support
323
324<comment>(If you have a serial to USB converter like the Prolific 2303, you'll need this)</comment>
325USB Serial Converter support --->
326 &lt;*&gt; USB Serial Converter support
327 &lt;*&gt; USB Prolific 2303 Single Port Serial Driver (NEW)
328</pre>
329
330<p>
331Now that the options are set, you can (re)compile the kernel and USB support
332should be functional once you reboot into the new kernel.
333</p> 256</p>
334 257
335</body> 258</body>
336</section> 259</section>
337</chapter> 260</chapter>

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.18

  ViewVC Help
Powered by ViewVC 1.1.20