home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 13 / CDA13.ISO / DOC / HOWTO / OTHER_FO / SGML / BOOTPROM.GZ / BootPrompt-HOWTO.sgml
Encoding:
SGML Document  |  1996-07-14  |  71.8 KB  |  2,009 lines

  1. <!--
  2.  
  3.     The SGML source of the BootPrompt-Howto
  4.     =====================================
  5.  
  6.     Maintained by Paul Gortmaker.
  7.  
  8.     Modification Date: July 1, 1996
  9.  
  10.     (Don't forget to update the reference to the current kernel version
  11.     in the Introduction section, and the date/version in the abstract!)
  12.  
  13.     The "==" are because two dashes together inside an SGML comment
  14.     will crash it.  :-(
  15.  
  16.     History:
  17.  
  18.     1) August 1995 == Still no comprehensive list of kernel arguments
  19.        for users to look up existence/usage info. So I hacked this up,
  20.        having experience with the linuxdoc-sgml stuff from the
  21.        Ethernet-HowTo. (Of course the most up-to-date list is the kernel
  22.        itself, but that does not lend itself well to beginners.)
  23.  
  24.     2) July 1996 == Update to the v2.0 kernel, and add in all the
  25.        things I left out in the 1st version, nearly a year(!) ago.
  26.        Make copying conditions GPL (it was before, as I swiped the
  27.        the copying conditions from the GNU Make manual, but it didn't
  28.        explicitly say GPL).
  29.  
  30. -->
  31.  
  32. <!doctype linuxdoc system>
  33.  
  34. <article>
  35.  
  36. <title>The Linux BootPrompt-HowTo
  37. <author>Paul Gortmaker, Editor.
  38. <date>v1.11, 1 July 1996
  39.  
  40. <abstract>
  41.     This is the BootPrompt-Howto, which is a compilation of all the
  42.     possible boot time arguments that can be passed to the Linux
  43.     kernel at boot time. This includes all kernel and device parameters.
  44.     A discussion of how the kernel sorts boot time arguments, along
  45.     with an overview of some of the popular software used to boot Linux
  46.     kernels is also included.
  47. </abstract>
  48.  
  49. <toc>
  50.  
  51. <sect>Introduction<label id="main-intro">
  52. <p>
  53.  
  54.     The kernel has a limited capability to accept information at
  55.     boot in the form of a `command line', similar to an argument
  56.     list you would give to a program. In general this is used to
  57.     supply the kernel with information about hardware parameters
  58.     that the kernel would not be able to determine on its own, or
  59.     to avoid/override the values that the kernel would otherwise
  60.     detect.
  61.  
  62.     However, if you just copy a kernel image directly to a floppy,
  63.     (e.g. <tt> cp zImage /dev/fd0</tt>) then
  64.     you are not given a chance to specify any arguments to that
  65.     kernel. So most Linux users will use software like <em/LILO/
  66.     or <em/loadlin/ that takes care of handing these arguments
  67.     to the kernel, and then booting it.
  68.  
  69.     This present revision covers kernels up to and including v2.0.
  70.     The BootPrompt-Howto is edited and maintained by:
  71. <quote>
  72.     Paul Gortmaker, <tt/gpg109@rsphy1.anu.edu.au/
  73. </quote>
  74.  
  75.     [Please note that boot prompt arguments that are specific
  76.     to the non-i386 ports and devices (esp. Atari/Amiga) are not
  77.     currently documented.]
  78.  
  79.  
  80. <sect1>Disclaimer and Copyright<label id="copyright">
  81. <p>
  82.  
  83.     This document is <em/not/ gospel. However, it is probably the most
  84.     up to date info that you will be able to find. Nobody is responsible
  85.     for what happens to your hardware but yourself. If your
  86.     hardware goes up in smoke (...nearly impossible!)
  87.     I take no responsibility. ie. THE AUTHOR IS NOT RESPONSIBLE
  88.     FOR ANY DAMAGES INCURRED DUE TO ACTIONS TAKEN BASED ON THE
  89.     INFORMATION INCLUDED IN THIS DOCUMENT.
  90.  
  91.     This document is Copyright (C) 1995,1996 by Paul Gortmaker.
  92.  
  93.     This document may be copied according to the conditions
  94.     of the GNU General Public License, version 2, included herein
  95.     by reference. See the file <tt>linux/COPYING</tt> that comes
  96.     with the Linux kernel for full details.
  97.  
  98.     If you are intending to incorporate this document into a
  99.     published work, please contact me, and I will make an effort
  100.     to ensure that you have the most up to date information
  101.     available. In the past, out of date versions of the Linux
  102.     howto documents have been published, which caused the developers
  103.     undue grief from being plagued with questions that were already
  104.     answered in the up to date versions.
  105.  
  106. <sect1>Related Documentation<label id="other_docs">
  107. <p>
  108.  
  109.     The most up-to-date documentation will always be the kernel
  110.     source itself. Hold on! Don't get scared. You don't need to
  111.     know any programming to read the comments in the source files.
  112.     For example, if you were looking for what arguments could be
  113.     passed to the AHA1542 SCSI driver, then you would go to the
  114.     <tt>linux/drivers/scsi</tt> directory, and look at the
  115.     file <tt/aha1542.c/ -- and within the first 100 lines, you
  116.     would find a plain english description of the boot time arguments
  117.     that the 1542 driver accepts.
  118.  
  119.     The next best thing will be any documentation files that are
  120.     distributed with the kernel itself. There are now quite a
  121.     few of these, and most of them can be found in the directory
  122.     <tt>linux/Documentation</tt> and subdirectories from there.
  123.     The <tt/linux/ directory is usually found in <tt>/usr/src/</tt>.
  124.     Sometimes there will be <tt/README.foo/ files that can be found
  125.     in the related driver directory (e.g. <tt>linux/drivers/XXX/</tt>,
  126.     where <tt/XXX/ will be <tt/scsi/, <tt/char/, or <tt/net/).
  127.  
  128.     If you have figured out what boot-args you intend to use, and
  129.     now want to know how to get that information to the kernel, then
  130.     look at the documentation that comes with the software that you
  131.     use to boot the kernel (e.g. LILO or loadlin). A brief overview
  132.     is given below, but it is no substitute for the documentation
  133.     that comes with the booting software.
  134.  
  135. <sect1>The Linux Newsgroups<label id="news">
  136. <p>
  137.  
  138.     If you have questions about passing boot arguments to the
  139.     kernel, please READ this document first. If this and the
  140.     related documentation mentioned above does not answer your
  141.     question(s) then you can try the Linux newsgroups.
  142.     Of course you should try reading the group before blindly
  143.     posting your question, as somebody else may have already
  144.     asked it, or it may even be a Frequently Asked Question (a FAQ).
  145.     A quick browse of the linux FAQ before posting is a <em/good/
  146.     idea. You should be able to find the FAQ somewhere close to
  147.     where you found this document.
  148.  
  149.     General questions on how to configure your system
  150.     should be directed to the comp.os.linux.setup newsgroup.
  151.     We ask that you <em/please/ respect this general guideline
  152.     for content, and don't cross-post your request to other groups.
  153.  
  154. <sect1>New Versions of this Document<label id="new-doc">
  155. <p>
  156.  
  157.     New versions of this document can be retrieved via anonymous
  158.     FTP from the site sunsite.unc.edu, in the directory
  159.     <tt>/pub/Linux/docs/HOWTO/</tt>. Note that <em/SunSITE/ is
  160.     usually heavily loaded, and you are better advised to get the
  161.     document from one of the Linux ftp mirror sites. Updates will be made
  162.     as new information and/or drivers becomes available. If this copy that
  163.     you are presently reading is more than a few months old, then
  164.     you should probably check to see if a newer copy exists.
  165.  
  166.     This document was produced by using a modified SGML system that was
  167.     specifically set up for the Linux Howto project, and there are
  168.     various output formats available, including, postscript, dvi,
  169.     ascii, html, and soon TeXinfo.
  170.     I would recommend viewing it in the html (via a WWW browser) or the
  171.     Postscript/dvi format. Both of these contain cross-references
  172.     that are lost in the ascii translation.
  173.  
  174.     If you want to get the official copy off sunsite, here is URL.
  175.  
  176.     <url url="http://sunsite.unc.edu/mdw/HOWTO/BootPrompt-HOWTO.html"
  177.         name="BootPrompt-HOWTO">
  178.  
  179. <sect>Overview of Boot Prompt Arguments<label id="oview">
  180. <p>
  181.     
  182.     This section gives some examples of software that can be used
  183.     to pass kernel boot-time arguments to the kernel itself.
  184.     It also gives you an idea of how the arguments are processed,
  185.     what limitations there are on the boot args, and how they filter
  186.     down to each appropriate device that they are intended for.
  187.  
  188.     It is <em/important/ to note that spaces should <em/not/ be
  189.     used in a boot argument, but only between separate arguments.
  190.     A list of values that are for a single argument are to be
  191.     separated with a comma between the values, and again without
  192.     any spaces. See the following examples below.
  193.  
  194. <code>
  195.     ether=9,0x300,0xd0000,0xd4000,eth0  vga=ask               *RIGHT*
  196.     ether = 9, 0x300, 0xd0000, 0xd4000, eth0  vga = ask       *WRONG*
  197. </code>
  198.  
  199. <sect1>LILO (LInux LOader)<label id="lilo">
  200. <p>
  201.  
  202.     The LILO program (LInux LOader) written by Werner Almesberger
  203.     is the most commonly used. It has the ability to boot
  204.     various kernels, and stores the configuration information
  205.     in a plain text file. Most distributions ship with LILO
  206.     as the default boot-loader. LILO can boot DOS, OS/2 Linux,
  207.     FreeBSD, etc. without any difficulties, and is quite flexible.
  208.  
  209.     A typical configuration will have LILO stop and print <tt/LILO:/
  210.     shortly after you turn on your computer. It will then wait for
  211.      a few seconds for any optional input from the user, and failing
  212.     that it will then boot the default system. Typical system labels
  213.     that people use in the LILO configuration files are <tt/linux/
  214.     and <tt/backup/ and <tt/msdos/. If you want to type in a boot
  215.     argument, you type it in here, after typing in the system label
  216.     that you want LILO to boot from, as shown in the example below.
  217.  
  218. <code>
  219.     LILO: linux vga=ask
  220. </code>
  221.  
  222.     LILO comes with excellent documentation, and for the purposes
  223.     of boot args discussed here, the LILO <tt/append=/ command
  224.     is of significant importance when one wants to add a boot time
  225.     argument as a permanent addition to the LILO config file.
  226.     You simply add something like <tt/append = "vga=ask"/ to the
  227.     <tt>/etc/lilo.conf</tt> file. It can either be added at the top
  228.     of the config file, making it apply to all sections, or to a
  229.     single system section by adding it inside an <tt/image=/ section.
  230.     Please see the LILO documentation for a more complete description.
  231.  
  232. <sect1>LoadLin<label id="loadlin">
  233. <p>
  234.  
  235.     The other commonly used Linux loader is `LoadLin' which is
  236.     a DOS program that has the capability to launch a Linux
  237.     kernel from the DOS prompt (with boot-args) assuming that
  238.     certain resources are available. This is good for people
  239.     that use DOS and want to launch into Linux from DOS.
  240.  
  241.     It is also very useful if you have certain hardware which relies
  242.     on the supplied DOS driver to put the hardware into a known
  243.     state. A common example is `SoundBlaster Compatible' sound
  244.     cards that require the DOS driver to twiddle a few mystical
  245.     registers to put the card into a SB compatible mode. Booting
  246.     DOS with the supplied driver, and then loading Linux from
  247.     the DOS prompt with loadlin avoids the reset of the card that
  248.     happens if one rebooted instead. Thus the card is left in a
  249.     Sb compatible mode and hence is useable under Linux.
  250.  
  251.     There are also other programs that can be used to boot Linux.
  252.     For a complete list, please look at the programs available
  253.     on your local Linux ftp mirror, under <tt>system/Linux-boot/</tt>.
  254.  
  255. <sect1>The ``rdev'' utility<label id="rdev">
  256. <p>
  257.  
  258.     There are a few of the kernel boot parameters that have their
  259.     default values stored in various bytes in the kernel image itself.
  260.     There is a utility called <tt/rdev/ that is installed on most
  261.     systems that knows where these values are, and how to change them.
  262.     It can also change things that have no kernel boot argument
  263.     equivalent, such as the default video mode used.
  264.  
  265.     The rdev utility is usually also aliased to swapdev, ramsize,
  266.     vidmode and rootflags. These are the five things that rdev
  267.     can change, those being the root device, the swap device,
  268.     the RAM disk size, the default video mode, and the     
  269.     readonly/readwrite setting of root device.
  270.  
  271.     More information on <tt/rdev/ can be found by typing
  272.     <tt/rdev -h/ or by reading the supplied man page (<tt/man rdev/).
  273.  
  274. <sect1>How the Kernel Sorts the Arguments
  275. <p>
  276.  
  277.     Most of the boot args take the form of:
  278. <code>
  279.     name[=value_1]&lsqb,value_2]...&lsqb,value_11&rsqb
  280. </code>
  281.  
  282.     where `name' is a unique keyword that is used to identify
  283.     what part of the kernel the associated values (if any) are to be
  284.     given to. Multiple boot args are just a space separated list
  285.     of the above format. Note the limit of 11 is real, as the
  286.     present code only handles 11 comma separated parameters per
  287.     keyword. (However, you can re-use the same keyword with
  288.     up to an additional 11 parameters in unusually complicated
  289.     situations, assuming the setup function supports it.)
  290.     Also note that the kernel splits the list into a maximum of
  291.     ten integer arguments, and a following string, so you
  292.     can't really supply 11 integers unless you convert the
  293.     11th arg from a string to an int in the driver itself.
  294.  
  295.     Most of the sorting goes on in <tt>linux/init/main.c</tt>.
  296.     First, the kernel checks to see if the argument is any of
  297.     the special arguments `root=', `ro', `rw', or `debug'.
  298.     The meaning of these special arguments is described further
  299.     on in the document.
  300.  
  301.     Then it walks a list of    setup functions (contained in the
  302.     <tt/bootsetups/ array) to see if the specified
  303.     argument string (such as `foo') has been associated with a
  304.     setup function (<tt/foo_setup()/) for a particular
  305.     device or part of the kernel. If you
  306.     passed the kernel the line <tt>foo=3,4,5,6,bar</tt> then the
  307.     kernel would search the <tt/bootsetups/ array to see if
  308.     `foo' was registered. If it was, then it would call the
  309.     setup function associated with `foo' (<tt/foo_setup()/)
  310.     and hand it the integer arguments
  311.     3, 4, 5 and 6 as given on the kernel command line, and
  312.     also hand it the string argument <tt/bar/.
  313.  
  314. <sect1>Setting Environment Variables.
  315. <p>
  316.  
  317.     Anything of the form `foo=bar' that is not accepted as a
  318.     setup function as described above is then interpreted as an
  319.     environment variable to be set. A (useless?) example would
  320.     be to use `TERM=vt100' as a boot argument.
  321.  
  322. <sect1>Passing Arguments to the `init' program
  323. <p>
  324.  
  325.     Any remaining arguments that were not picked up by the
  326.     kernel and were not interpreted as environment variables
  327.     are then passed onto process one, which is usually the
  328.     <tt/init/ program. The most common argument that is passed to
  329.     the <tt/init/ process is the word <em/single/ which instructs
  330.     <tt/init/ to boot the computer in single user mode, and not
  331.     launch all the usual daemons. Check the manual page for the
  332.     version of <tt/init/ installed on your system to see what
  333.     arguments it accepts.
  334.  
  335. <sect>General Non-Device Specific Boot Args<label id="general">
  336. <p>
  337.  
  338.     These are the boot arguments that are not related to any
  339.     specific device or peripheral. They are instead related to
  340.     certain internal kernel parameters, such as memory handling,
  341.     ramdisk handling, root file system handling and others.
  342.  
  343. <sect1> Root Filesystem options
  344. <p>
  345.  
  346.     The following options all pertain to how the kernel selects
  347.     and handles the root filesystem.
  348.  
  349. <sect2>The `root=' Argument
  350. <p>
  351.  
  352.     This argument tells the kernel what device is to be used as
  353.     the root filesystem while booting. The default of this setting
  354.     is the value of the root device of the system that
  355.     the kernel was built on.
  356.     For example, if the kernel in question was built on a system
  357.     that used `/dev/hda1' as the root partition, then the default
  358.     root device would be `/dev/hda1'.  To override this default
  359.     value, and select the second floppy drive as the root device,
  360.     one would use `root=/dev/fd1'.
  361.  
  362.     Valid root devices are any of the following devices:
  363.  
  364.     (1) /dev/hdaN to /dev/hddN, which is partition N on ST-506
  365.     compatible disk `a to d'.
  366.  
  367.     (2) /dev/sdaN to /dev/sdeN, which is partition N on SCSI
  368.     compatible disk `a to e'.
  369.  
  370.     (3) /dev/xdaN to /dev/xdbN, which is partition N on XT
  371.     compatible disk `a to b'.
  372.  
  373.     (4) /dev/fdN, which is floppy disk drive number N. Having
  374.     N=0 would be the DOS `A:' drive, and N=1 would be `B:'.
  375.  
  376.     (5) /dev/nfs, which is not really a device, but rather a
  377.     flag to tell the kernel to get the root fs via the network.
  378.  
  379.     The more awkward and less portable numeric specification
  380.     of the above possible disk devices in major/minor format is
  381.     also accepted. (e.g. /dev/sda3 is major 8, minor 3, so you
  382.     could use <tt/root=0x803/ as an alternative.)
  383.  
  384.     This is one of the few kernel boot arguments that has its
  385.     default stored in the kernel image, and which can thus
  386.     be altered with the <tt/rdev/ utility.
  387.     
  388.  
  389. <sect2>The `ro' Argument
  390. <p>
  391.  
  392.     When the kernel boots, it needs a root filesystem to read
  393.     basic things off of. This is the root filesystem that is
  394.     mounted at boot. However, if the root filesystem is mounted
  395.     with write access, you can not reliably check the filesystem
  396.     integrity with half-written files in progress. The `ro'
  397.     option tells the kernel to mount the root filesystem as
  398.     `readonly' so that any filesystem consistency check programs
  399.     (fsck) can safely assume that there are no half-written
  400.     files in progress while performing the check. No programs
  401.     or processes can write to files on the filesystem in
  402.     question until it is `remounted' as read/write capable.
  403.  
  404.     This is one of the few kernel boot arguments that has its
  405.     default stored in the kernel image, and which can thus
  406.     be altered with the <tt/rdev/ utility.
  407.     
  408. <sect2>The `rw' Argument
  409. <p>
  410.  
  411.     This is the exact opposite of the above, in that it tells the
  412.     kernel to mount the root filesystem as read/write. The default
  413.     is to mount the root filesystem as read/write anyway. Do not
  414.     run any `fsck' type programs on a filesystem that is mounted
  415.     read/write.
  416.  
  417.     The same value stored in the image file mentioned above is
  418.     also used for this parameter, accessible via <tt/rdev/.
  419.  
  420. <sect1>Options Relating to RAM Disk Management
  421. <p>
  422.  
  423.     The following options all relate to how the kernel handles
  424.     the RAM disk device, which is usually used for bootstrapping
  425.     machines during the install phase, or for machines with
  426.     modular drivers that need to be installed to access the
  427.     root filesystem.
  428.  
  429.  
  430. <sect2>The `ramdisk_start=' Argument
  431. <p>
  432.  
  433.     To allow a kernel image to reside on a floppy disk along with a
  434.     compressed ramdisk image, the `ramdisk_start=<offset>' command
  435.     was added. The kernel can't be included into the compressed ramdisk
  436.     filesystem image, because it needs to be stored starting at block
  437.     zero so that the BIOS can load the bootsector and then the kernel
  438.     can bootstrap itself to get going.
  439.  
  440.     Note: If you are using an uncompressed ramdisk image, then the kernel
  441.     can be a part of the filesystem image that is being loaded into the
  442.     ramdisk, and the floppy can be booted with LILO, or the two can be
  443.     separate as is done for the compressed images.
  444.  
  445.     If you are using a two-disk boot/root setup (kernel on disk 1,
  446.     ramdisk image on disk 2) then the ramdisk would start at block zero,
  447.     and an offset of zero would be used. Since this is the default value,
  448.     you would not need to actually use the command at all.
  449.  
  450. <sect2>The `load_ramdisk=' Argument
  451. <p>
  452.  
  453.     This parameter tells the kernel whether it is to try to load a
  454.     ramdisk image or not. Specifying `load_ramdisk=1' will tell the
  455.     kernel to load a floppy into the ramdisk. The default value is
  456.     zero, meaning that the kernel should not try to load a ramdisk.
  457.  
  458.     Please see the file <tt>linux/Documentation/ramdisk.txt</tt>
  459.     for a complete description of the new boot time arguments, and
  460.     how to use them. A description of how this parameter can be set
  461.     and stored in the kernel image via `rdev' is also described.
  462.  
  463. <sect2>The `prompt_ramdisk=' Argument
  464. <p>
  465.  
  466.     This parameter tells the kernel whether or not to give you a prompt
  467.     asking you to insert the floppy containing the ramdisk image. In
  468.     a single floppy configuration the ramdisk image is on the same floppy
  469.     as the kernel that just finished loading/booting and so a prompt
  470.     is not needed. In this case one can use `prompt_ramdisk=0'. In a
  471.     two floppy configuration, you will need the chance to switch disks,
  472.     and thus `prompt_ramdisk=1' can be used. Since this is the default
  473.     value, it doesn't really need to be specified. (
  474.     (Historical note: Sneaky people used to use the `vga=ask' boot arg.
  475.     to temporarily pause the boot process and allow a chance to switch
  476.     from boot to root floppy.)
  477.  
  478.     Please see the file <tt>linux/Documentation/ramdisk.txt</tt>
  479.     for a complete description of the new boot time arguments, and
  480.     how to use them. A description of how this parameter can be set
  481.     and stored in the kernel image via `rdev' is also described.
  482.  
  483. <sect2>The `ramdisk_size=' Argument
  484. <p>
  485.  
  486.     While it is true that the ramdisk grows dynamically as required,
  487.     there is an upper bound on its size so that it doesn't consume
  488.     all available RAM and leave you in a mess. The default is 4096
  489.     (i.e. 4MB) which should be large enough for most needs. You
  490.     can override the default to a bigger or smaller size with this
  491.     boot argument.
  492.  
  493.     Please see the file <tt>linux/Documentation/ramdisk.txt</tt>
  494.     for a complete description of the new boot time arguments, and
  495.     how to use them. A description of how this parameter can be set
  496.     and stored in the kernel image via `rdev' is also described.
  497.  
  498. <sect2>The `ramdisk=' Argument (obsolete)
  499. <p>
  500.  
  501.     (NOTE: This argument is obsolete, and should not be used except
  502.     on kernels v1.3.47 and older. The commands that should be used
  503.     for the ramdisk device are documented above.)
  504.  
  505.     This specifies the size in kB of the RAM disk device.
  506.     For example, if one wished to have a root filesystem on a 1.44MB
  507.     floppy loaded into the RAM disk device, they would use:
  508.  
  509. <code>
  510.     ramdisk=1440
  511. </code>
  512.  
  513.     This is one of the few kernel boot arguments that has its
  514.     default stored in the kernel image, and which can thus
  515.     be altered with the <tt/rdev/ utility.
  516.  
  517.  
  518. <sect2>The `noinitrd' (initial RAM disk) Argument
  519. <p>
  520.  
  521.     The v2.x and newer kernels have a feature where the root filesystem
  522.     is initially a RAM disk, and the kernel executes <tt>/linuxrc</tt>
  523.     on that RAM image. This feature is typically used to allow loading
  524.     of modules needed to mount the real root filesystem (e.g. load
  525.     the SCSI driver modules stored in the RAM disk image, and then
  526.     mount the real root filesystem on a SCSI disk.)
  527.  
  528.     The actual `noinitrd' argument determines what happens to the
  529.     initrd data after the kernel has booted.  When
  530.     specified, instead of converting it to a RAM disk, it
  531.     is accessible via <tt>/dev/initrd</tt>, which can be read once
  532.     before the RAM is released back to the system. For full details
  533.     on using the initial RAM disk, please consult
  534.     <tt>linux/Documentation/initrd.txt</tt>. In addition, the most
  535.     recent versions of <tt/LILO/ and <tt/LOADLIN/ should have additional
  536.     useful information.
  537.  
  538. <sect1>Boot Arguments Related to Memory Handling
  539. <p>
  540.  
  541.     The following arguments alter how linux detects or handles
  542.     the physical and virtual memory of your system.
  543.  
  544. <sect2>The `mem=' Argument
  545. <p>
  546.  
  547.     This argument has two purposes: The original purpose was to
  548.     specify the amount of installed memory (or a value less than
  549.     that if you wanted to limit the amount of memory available to
  550.     linux). The second (and hardly used) purpose is to specify
  551.     <tt/mem=nopentium/ which tells the linux kernel to not use
  552.     the 4MB page table performance feature.
  553.  
  554.     The original BIOS call defined in the PC specification  that
  555.     returns the amount of installed memory was only designed to
  556.     be able to report up to 64MB. (Yes, another lack of foresight,
  557.     just like the 1024 cylinder disks... sigh.) Linux uses this
  558.     BIOS call at boot to determine how much memory is installed.
  559.     If you have more than 64MB of RAM installed, you can use this
  560.     boot arg to tell Linux how much memory you have.
  561.     Here is a quote from Linus on usage of the `mem=' parameter.
  562.  
  563.     ``The kernel will accept any `mem=xx' parameter you give it, and if
  564.     it turns out that you lied to it, it will crash horribly sooner or
  565.     later.  The parameter indicates the highest addressable RAM address,
  566.     so `mem=0x1000000' means you have 16MB of memory, for example.  For
  567.     a 96MB machine this would be `mem=0x6000000'.
  568.  
  569.     NOTE NOTE NOTE: some machines might use the top of memory for BIOS
  570.     cacheing or whatever, so you might not actually have up to the full
  571.     96MB addressable.  The reverse is also true: some chipsets will map
  572.     the physical memory that is covered by the BIOS area into the area
  573.     just past the top of memory, so the top-of-mem might actually be
  574.     96MB + 384kB for example.  If you tell linux that it has more memory
  575.     than it actually does have, bad things will happen: maybe not at
  576.     once, but surely eventually.''
  577.  
  578.     Note that the argument does not have to be in hex, and the
  579.     suffixes `k' and `M' (case insensitive) can be used to specify
  580.     kilobytes and Megabytes, respectively. (A `k' will cause a 10 bit
  581.     shift on your value, and a `M' will cause a 20 bit shift.)
  582.     The above warning still holds, in that a 96MB machine may
  583.     work with <tt/mem=97920k/ but fail with either <tt/mem=98304k/ or
  584.     <tt/mem=96M/.
  585.  
  586. <sect2>The `swap=' Argument
  587. <p>
  588.  
  589.     This allows the user to tune some of the virtual memory (VM)
  590.     parameters that are related to swapping to disk. It accepts
  591.     the following eight parameters:
  592.  
  593. <code>
  594.     MAX_PAGE_AGE
  595.     PAGE_ADVANCE
  596.     PAGE_DECLINE
  597.     PAGE_INITIAL_AGE
  598.     AGE_CLUSTER_FRACT
  599.     AGE_CLUSTER_MIN
  600.     PAGEOUT_WEIGHT
  601.     BUFFEROUT_WEIGHT
  602. </code>
  603.  
  604.     Interested hackers are advised to have a read of 
  605.     <tt>linux/mm/swap.c</tt> and also make note of the goodies in 
  606.     <tt>/proc/sys/vm</tt>.
  607.  
  608. <sect2>The `buff=' Argument
  609. <p>
  610.  
  611.     Similar to the `swap=' argument, this allows the user to
  612.     tune some of the parameters related to buffer memory management.
  613.     It accepts the following six parameters:
  614.  
  615. <code>
  616.     MAX_BUFF_AGE
  617.     BUFF_ADVANCE
  618.     BUFF_DECLINE
  619.     BUFF_INITIAL_AGE
  620.     BUFFEROUT_WEIGHT
  621.     BUFFERMEM_GRACE
  622. </code>
  623.  
  624.     Interested hackers are advised to have a read of 
  625.     <tt>linux/mm/swap.c</tt> and also make note of the goodies
  626.     in <tt>/proc/sys/vm</tt>.
  627.  
  628. <sect1>Boot Arguments for NFS Root Filesystem
  629. <p>
  630.  
  631.     Linux supports systems such as diskless workstations via
  632.     having their root filesystem as NFS (Network FileSystem).
  633.     These arguments are used to tell the diskless workstation
  634.     which machine it is to get its system from. Also note that
  635.     the argument <tt>root=/dev/nfs</tt> is required. Detailed
  636.     information on using an NFS root fs is in the file
  637.     <tt>linux/Documentation/nfsroot.txt</tt>. You should read
  638.     that file, as the following is only a quick summary taken
  639.     directly from that file.
  640.  
  641. <sect2>The `nfsroot=' Argument
  642. <p>
  643.  
  644.     This argument tells the kernel which machine, what directory
  645.     and what NFS options to use for the root filesystem. The form
  646.     of the argument is as follows:
  647.  
  648. <code>
  649.     nfsroot=[<server-ip>:]<root-dir>[,<nfs-options>]
  650. </code>
  651.  
  652.   If the nfsroot parameter is not given on the command line, the default
  653.   `/tftpboot/%s' will be used. The other options are as follows:
  654.  
  655.     <server-ip> --
  656.         Specifies the IP address of the NFS server. If this field
  657.         is not given, the default address as determined by the
  658.         nfsaddrs variable (see below) is used. One use of this
  659.         parameter is for example to allow using different servers
  660.         for RARP and NFS. Usually you can leave this blank.
  661.  
  662.     <root-dir> --
  663.         Name of the directory on the server to mount as root. If
  664.         there is a `%s' token in the string, the token will be
  665.         replaced by the ASCII-representation of the client's IP
  666.         address.
  667.  
  668.     <nfs-options> --
  669.         Standard NFS options. All options are separated by commas.
  670.         If the options field is not given, the following defaults
  671.         will be used:
  672.  
  673. <verb>
  674.         port            = as given by server portmap daemon
  675.         rsize           = 1024
  676.         wsize           = 1024
  677.         timeo           = 7
  678.         retrans         = 3
  679.         acregmin        = 3
  680.         acregmax        = 60
  681.         acdirmin        = 30
  682.         acdirmax        = 60
  683.         flags           = hard, nointr, noposix, cto, ac
  684. </verb>
  685.  
  686. <sect2>The `nfsaddrs=' Argument
  687. <p>
  688.  
  689.     This boot argument sets up the various network interface addresses
  690.     that are required to communicate over the network. If this argument
  691.     is not given, then the kernel tries to use RARP and/or BOOTP to
  692.     figure out these parameters. The form is as follows:
  693.  
  694. <code>
  695.     nfsaddrs=<my-ip>:<serv-ip>:<gw-ip>:<netmask>:<name>:<dev>:<auto>
  696. </code>
  697.  
  698.     <my-ip> --
  699.         IP address of the client. If empty, the address will either
  700.                 be determined by RARP or BOOTP. What protocol is used de-
  701.                 pends on what has been enabled during kernel configuration
  702.                 and on the <auto> parameter. If this parameter is not
  703.                 empty, neither RARP nor BOOTP will be used.
  704.  
  705.     <serv-ip> --
  706.         IP address of the NFS server. If RARP is used to determine
  707.         the client address and this parameter is NOT empty only
  708.         replies from the specified server are accepted. To use
  709.         different RARP and NFS server, specify your RARP server
  710.         here (or leave it blank), and specify your NFS server in
  711.         the nfsroot parameter (see above). If this entry is blank
  712.         the address of the server is used which answered the RARP
  713.         or BOOTP request.
  714.  
  715.     <gw-ip> --
  716.         IP address of a gateway if the server in on a different
  717.         subnet. If this entry is empty no gateway is used and the
  718.         server is assumed to be on the local network, unless a
  719.         value has been received by BOOTP.
  720.  
  721.     <netmask> --
  722.         Netmask for local network interface. If this is empty,
  723.         the netmask is derived from the client IP address,
  724.         unless a value has been received by BOOTP.
  725.  
  726.     <name> --
  727.         Name of the client. If empty, the client IP address is
  728.         used in ASCII-notation, or the value received by BOOTP.
  729.  
  730.     <dev> --
  731.         Name of network device to use. If this is empty, all
  732.         devices are used for RARP requests, and the first one
  733.         found for BOOTP. For NFS the device is used on which
  734.         either RARP or BOOTP replies have been received. If
  735.         you only have one device you can safely leave this blank.
  736.  
  737.     <auto> --
  738.         Method to use for autoconfiguration. If this is either
  739.         `rarp' or `bootp' the specified protocol is being used.
  740.         If the value is `both' or empty, both protocols are used
  741.         so far as they have been enabled during kernel configuration
  742.         Using 'none' means no autoconfiguration. In this case you
  743.         have to specify all necessary values in the fields before.
  744.  
  745.     The <auto> parameter can appear alone as the value to the
  746.     nfsaddrs parameter (without all the `:' characters before) in which
  747.     case autoconfiguration is used. However, the `none' value is not
  748.     available in that case.
  749.     
  750. <sect1>Other Misc. Kernel Boot Arguments
  751. <p>
  752.  
  753.     These various boot arguments let the user tune certain
  754.     internal kernel parameters.
  755.  
  756. <sect2>The `debug' Argument
  757. <p>
  758.  
  759.     The kernel communicates important (and not-so important)
  760.     messages to the operator via the <tt/printk()/ function.
  761.     If the message is considered important, the <tt/printk()/
  762.     function will put a copy on the present console as well
  763.     as handing it off to the <tt/klogd()/ facility so that it
  764.     gets logged to disk. The reason for printing important
  765.     messages to the console as well as logging them to disk is
  766.     because under unfortunate circumstances (e.g. a disk failure)
  767.     the message won't make it to disk and will be lost.
  768.  
  769.     The threshold for what is and what isn't considered important
  770.     is set by the <tt/console_loglevel/ variable. The default is
  771.     to log anything more important than <tt/DEBUG/ (level 7) to
  772.     the console. (These levels are defined in the include file
  773.     <tt/kernel.h/) Specifying <tt/debug/ as a boot argument will
  774.     set the console loglevel to 10, so that <em/all/ kernel
  775.     messages appear on the console.
  776.  
  777.     The console loglevel can usually also be set at run time via
  778.     an option to the <tt/klogd()/ program. Check the man page
  779.     for the version installed on your system to see how to do this.
  780.  
  781. <sect2>The `init=' Argument
  782. <p>
  783.  
  784.     The kernel defaults to starting the `init' program at boot,
  785.     which then takes care of setting up the computer for users
  786.     via launching getty programs, running `rc' scripts and the like.
  787.     The kernel first looks for <tt>/sbin/init</tt>, then
  788.     <tt>/etc/init</tt> (depreciated), and as a last resort, it
  789.     will try to use <tt>/bin/sh</tt> (possibly on <tt>/etc/rc</tt>).
  790.     If for example, your init program got corrupted and thus stopped
  791.     you from being able to boot, you could simply use the boot prompt
  792.     <tt>init=/bin/sh</tt> which would drop you directly into a
  793.     shell at boot, allowing you to replace the corrupted program.
  794.  
  795. <sect2>The `no387' Argument
  796. <p>
  797.  
  798.     Some i387 coprocessor chips have bugs that show up when
  799.     used in 32 bit protected mode. For example, some of the
  800.     early ULSI-387 chips would cause solid lockups while
  801.     performing floating point calculations, apparently due to
  802.     a bug in the FRSAV/FRRESTOR instructions.  Using the `no387'
  803.     boot arg causes Linux to ignore the math coprocessor
  804.     even if you have one. Of course you must then have your
  805.     kernel compiled with math emulation support! This may also
  806.     be useful if you have one of those <em/really/ old 386 machines
  807.     that could use an 80287 FPU, as linux can't use an 80287.
  808.  
  809. <sect2>The `no-hlt' Argument
  810. <p>
  811.  
  812.     The i386 (and successors thereof) family of CPUs have a
  813.     `hlt' instruction which tells the CPU that nothing is
  814.     going to happen until an external device (keyboard, modem,
  815.     disk, etc.) calls upon the CPU to do a task. This allows the
  816.     CPU to enter a `low-power' mode where it sits like a zombie
  817.     until an external device wakes it up (usually via an interrupt).
  818.     Some of the early i486DX-100 chips had a problem  with the
  819.     `hlt' instruction, in that they couldn't reliably return to
  820.     operating mode after this instruction was used. Using the
  821.     `no-hlt' instruction tells Linux to just run an infinite loop
  822.     when there is nothing else to do, and to <em/not/ halt your
  823.     CPU when there is no activity. This allows people with these
  824.     broken chips to use Linux, although they would be well advised
  825.     to seek a replacement through a warranty where possible.
  826.  
  827. <sect2>The `no-scroll' Argument
  828. <p>
  829.  
  830.     Using this argument at boot disables scrolling features that
  831.     make it difficult to use Braille terminals.
  832.  
  833. <sect2>The `panic=' Argument
  834. <p>
  835.  
  836.     In the unlikely event of a kernel panic (i.e. an internal error
  837.     that has been detected by the kernel, and which the kernel decides
  838.     is serious enough to moan loudly and then halt everything), the
  839.     default behaviour is to just sit there until someone comes along
  840.     and notices the panic message on the screen and reboots the machine.
  841.     However if a machine is running unattended in an isolated location
  842.     it may be desirable for it to automatically reset itself so that
  843.     the machine comes back on line. For example, using `panic=30' at
  844.     boot would cause the kernel to try and reboot itself 30 seconds
  845.     after the kernel panic happened. A value of zero gives the default
  846.     behaviour, which is to wait forever.
  847.  
  848.     Note that this timeout value can also be read and set via the
  849.     <tt>/proc/sys/kernel/panic</tt> sysctl interface.
  850.  
  851. <sect2>The `profile=' Argument
  852. <p>
  853.  
  854.     Kernel developers can enable an option that allows them to
  855.     profile how and where the kernel is spending its CPU cycles
  856.     in an effort to maximize efficiency and performance. This
  857.     option lets you set the profile shift count at boot. Typically
  858.     it is set to two. Of course you have to compile your kernel
  859.     with profiling enabled, and get a tool such as <tt/readprofile.c/
  860.     that can make use of <tt>/proc/profile</tt>.
  861.  
  862. <sect2>The `reserve=' Argument
  863. <p>
  864.  
  865.     This is used to <em/protect/ I/O port regions from probes.
  866.     The form of the command is:
  867.  
  868. <tscreen>
  869.     reserve=iobase,extent[,iobase,extent]...
  870. </tscreen>
  871.  
  872.     In some machines it may be necessary to prevent device drivers from
  873.     checking for devices (auto-probing) in a specific region. This may be
  874.     because of poorly designed hardware that causes the boot to <em/freeze/
  875.     (such as some ethercards), hardware that is mistakenly identified,
  876.     hardware whose state is changed by an earlier probe, or merely
  877.     hardware you don't want the kernel to initialize.
  878.  
  879.     The <tt/reserve/ boot-time argument addresses this problem by specifying
  880.     an I/O port region that shouldn't be probed. That region is reserved
  881.     in the kernel's port registration table as if a device has already
  882.     been found in that region. Note that this mechanism shouldn't be
  883.     necessary on most machines. Only when there is a problem or special
  884.     case would it be necessary to use this.
  885.  
  886.     The I/O ports in the specified region are protected against
  887.     device probes. This was put in to be used when some driver was
  888.     hanging on a NE2000, or misidentifying some other device
  889.     as its own.  A correct device driver shouldn't probe a reserved
  890.     region, unless another boot argument explicitly specifies that
  891.     it do so.  This implies that <tt/reserve/ will most often be used
  892.     with some other boot argument. Hence if you specify a <tt/reserve/
  893.     region to protect a specific device, you must generally specify
  894.     an explicit probe for that device. Most drivers ignore the port
  895.     registration table if they are given an explicit address.
  896.  
  897.     For example, the boot line
  898.  
  899. <code>
  900.     reserve=0x300,32  blah=0x300
  901. </code>
  902.  
  903.     keeps all device drivers except the driver for `blah' from
  904.     probing 0x300-0x31f.
  905.  
  906.     As usual with boot-time specifiers there is an 11 parameter limit,
  907.     thus you can only specify 5 reserved regions per <tt/reserve/ keyword.
  908.     Multiple <tt/reserve/ specifiers will work if you have an unusually
  909.     complicated request.
  910.  
  911.  
  912. <sect2> The `vga=' Argument
  913. <p>
  914.  
  915.     This allows the setup code to use the video BIOS to change
  916.     the default display mode before actually booting the Linux
  917.     kernel. Typical modes are 80x50, 132x44 and so on. The best
  918.     way to use this option is to start with <tt/vga=ask/ which
  919.     will prompt you with a list of various modes that you can use
  920.     with your video adapter before booting the kernel. Once you
  921.     have the number from the above list that you want to use, you
  922.     can later put it in place of the `ask'. For more information,
  923.     please see the file <tt>linux/Documentation/svga.txt</tt>
  924.     that comes with all recent kernel versions.
  925.  
  926. <sect>Boot Arguments for SCSI Peripherals.
  927. <p>
  928.  
  929.     This section contains the descriptions of the boot args that
  930.     are used for passing information about the installed SCSI
  931.     host adapters, and SCSI devices.
  932.  
  933. <sect1>Arguments for Mid-level Drivers
  934. <p>
  935.  
  936.     The mid level drivers handle things like disks, CD-ROMs and
  937.     tapes without getting into host adapter specifics.
  938.  
  939. <sect2>Maximum Probed LUNs (`max_scsi_luns=')
  940. <p>
  941.  
  942.     Each SCSI device can have a number of `sub-devices' contained
  943.     within itself. The most common example is one of the new
  944.     SCSI CD-ROMs that handle more than one disk at a time.
  945.     Each CD is addressed as a `Logical Unit Number' (LUN) of
  946.     that particular device. But most devices, such as hard disks,
  947.     tape drives and such are only one device, and will be
  948.     assigned to LUN zero.
  949.  
  950.     The problem arises with single LUN devices with bad firmware.
  951.     Some poorly designed SCSI devices (old and unfortunately new)
  952.     can not handle being probed for LUNs not equal to zero. They
  953.     will respond by locking up, and possibly taking the whole
  954.     SCSI bus down with them.
  955.  
  956.     Newer kernels have the configuration option that allows you
  957.     to set the maximum number of probed LUNs. The default is to
  958.     only probe LUN zero, to avoid the problem described above.
  959.  
  960.     To specify the number of probed LUNs at boot, one enters
  961.     `max_scsi_luns=n' as a boot arg, where n is a number between
  962.     one and eight. To avoid problems as described above, one would
  963.     use n=1 to avoid upsetting such broken devices
  964.  
  965. <sect2>Parameters for the SCSI Tape Driver (`st=')
  966. <p>
  967.     Some boot time configuration of the SCSI tape driver can
  968.     be achieved by using the following:
  969.  
  970. <code>
  971.     st=buf_size[,write_threshold[,max_bufs]]
  972. </code>
  973.  
  974.     The first two numbers are specified in units of kB.
  975.     The default <tt/buf_size/ is 32kB, and the maximum size
  976.     that can be specified is a ridiculous 16384kB.
  977.     The <tt/write_threshold/ is the value at which the buffer is
  978.     committed to tape, with a default value of 30kB.
  979.     The maximum number of buffers varies with the number of drives
  980.     detected, and has a default of two. An example usage would be:
  981.  
  982. <code>
  983.     st=32,30,2
  984. </code>
  985.  
  986.     Full details can be found in the <tt/README.st/ file that is
  987.     in the <tt/scsi/ directory of the kernel source tree.
  988.  
  989. <sect1>Arguments for SCSI Host Adapters
  990. <p>
  991.  
  992.     General notation for this section:
  993.  
  994.     <tt/iobase/ -- the first I/O port that the SCSI host occupies.
  995.     These are specified in hexidecimal notation, and usually lie
  996.     in the range from <tt/0x200/ to <tt/0x3ff/.
  997.  
  998.     <tt/irq/ -- the hardware interrupt that the card is configured
  999.     to use. Valid values will be dependent on the card in question,
  1000.     but will usually be 5, 7, 9, 10, 11, 12, and 15. The other
  1001.     values are usually used for common peripherals like IDE hard
  1002.     disks, floppies, serial ports, etc.
  1003.  
  1004.     <tt/scsi-id/ -- the ID that the host adapter uses to identify
  1005.     itself on the SCSI bus. Only some host adapters allow you to
  1006.     change this value, as most have it permanently specified
  1007.     internally. The usual default value is seven, but the Seagate
  1008.     and Future Domain TMC-950 boards use six.
  1009.  
  1010.     <tt/parity/ -- whether the SCSI host adapter expects the attached
  1011.     devices to supply a parity value with all information exchanges.
  1012.     Specifying a one indicates parity checking is enabled, and a
  1013.     zero disables parity checking. Again, not all adapters will
  1014.     support selection of parity behaviour as a boot argument.
  1015.  
  1016. <sect2>Adaptec aha151x, aha152x, aic6260, aic6360, SB16-SCSI (`aha152x=')
  1017. <p>
  1018.  
  1019.     The aha numbers refer to cards and the aic numbers refer to
  1020.     the actual SCSI chip on these type of cards, including the
  1021.     Soundblaster-16 SCSI.
  1022.  
  1023.     The probe code for these SCSI hosts looks for an installed BIOS,
  1024.     and if none is present, the probe will not find your card. Then
  1025.     you will have to use a boot arg of the form:
  1026.  
  1027. <code>
  1028.      aha152x=iobase[,irq[,scsi-id[,reconnect[,parity]]]]
  1029. </code>
  1030.  
  1031.     Note that if the driver was compiled with debugging enabled,
  1032.     a sixth value can be specified to set the debug level.
  1033.  
  1034.     All the parameters are as described at the top of this section,
  1035.     and the <tt/reconnect/ value will allow device disconnect/reconnect
  1036.     if a non-zero value is used. An example usage is as follows:
  1037.  
  1038. <code>
  1039.     aha152x=0x340,11,7,1
  1040. </code>
  1041.  
  1042.     Note that the parameters must be specified in order, meaning that
  1043.     if you want to specify a parity setting, then you will have to
  1044.     specify an iobase, irq, scsi-id and reconnect value as well.
  1045.  
  1046. <sect2>Adaptec aha154x (`aha1542=')
  1047. <p>
  1048.  
  1049.     These are the aha154x series cards. The aha1542 series cards
  1050.     have an i82077 floppy controller onboard, while the aha1540
  1051.     series cards do not. These are busmastering cards, and have
  1052.     parameters to set the ``fairness'' that is used to share the
  1053.     bus with other devices. The boot arg looks like the following.
  1054.  
  1055. <code>
  1056.     aha1542=iobase[,buson,busoff[,dmaspeed]]
  1057. </code>
  1058.  
  1059.     Valid <tt/iobase/ values are usually one of:
  1060.     <tt/0x130, 0x134, 0x230, 0x234, 0x330, 0x334/.
  1061.     Clone cards may permit other values.
  1062.  
  1063.     The <tt/buson, busoff/ values refer to the number of microseconds
  1064.     that the card dominates the ISA bus. The defaults are 11us on, and
  1065.     4us off, so that other cards (such as an ISA LANCE Ethernet card)
  1066.     have a chance to get access to the ISA bus.
  1067.  
  1068.     The <tt/dmaspeed/ value refers to the rate (in MB/s) at which the
  1069.     DMA (Direct Memory Access) transfers proceed at. The default is
  1070.     5MB/s. Newer revision cards allow you to select this value as part
  1071.     of the soft-configuration, older cards use jumpers. You can use
  1072.     values up to 10MB/s assuming that your motherboard is capable of
  1073.     handling it. Experiment with caution if using values over 5MB/s.
  1074.  
  1075. <sect2>Adaptec aha274x, aha284x, aic7xxx (`aic7xxx=')
  1076. <p>
  1077.  
  1078.     These boards can accept an argument of the form:
  1079.  
  1080. <code>
  1081.     aic7xxx=extended,no_reset
  1082. </code>
  1083.  
  1084.     The <tt/extended/ value, if non-zero, indicates that extended
  1085.     translation for large disks is enabled. The <tt/no_reset/
  1086.     value, if non-zero, tells the driver not to reset the SCSI bus
  1087.     when setting up the host adaptor at boot.
  1088.  
  1089. <sect2>AdvanSys SCSI Host Adaptors (`advansys=')
  1090. <p>
  1091.  
  1092.     The AdvanSys driver can accept up to four i/o addresses that
  1093.     will be probed for an AdvanSys SCSI card. Note that these
  1094.     values (if used) do not effect EISA or PCI probing in any way.
  1095.     They are only used for probing ISA and VLB cards.
  1096.     In addition, if the driver has been compiled with debugging
  1097.     enabled, the level of debugging output can be set by
  1098.     adding an <tt/0xdeb[0-f]/ parameter. The <tt/0-f/
  1099.     allows setting the level of the debugging messages to any
  1100.     of 16 levels of verbosity.
  1101.  
  1102. <sect2>Always IN2000 Host Adaptor (`in2000=')
  1103. <p>
  1104.  
  1105.     Unlike other SCSI host boot arguments, the IN2000 driver uses
  1106.     ASCII string prefixes for most of its integer arguments. Here
  1107.     is a list of the supported arguments:
  1108.  
  1109.     ioport:addr --
  1110.         Where addr is IO address of a (usually ROM-less) card.
  1111.  
  1112.     noreset --
  1113.         No optional args. Prevents SCSI bus reset at boot time.
  1114.  
  1115.     nosync:x --
  1116.         x is a bitmask where the 1st 7 bits correspond with
  1117.         the 7 possible SCSI devices (bit 0 for device #0, etc).
  1118.         Set a bit to PREVENT sync negotiation on that device.
  1119.         The driver default is sync DISABLED on all devices.
  1120.  
  1121.     period:ns --
  1122.         ns is the minimum # of nanoseconds in a SCSI data transfer
  1123.         period. Default is 500; acceptable values are 250 to 1000.
  1124.  
  1125.     disconnect:x --
  1126.         x = 0 to never allow disconnects, 2 to always allow them.
  1127.         x = 1 does 'adaptive' disconnects, which is the default
  1128.         and generally the best choice.
  1129.  
  1130.     debug:x
  1131.         If `DEBUGGING_ON' is defined, x is a bitmask that causes
  1132.         various types of debug output to printed - see the DB_xxx
  1133.         defines in in2000.h
  1134.  
  1135.     proc:x --
  1136.         If `PROC_INTERFACE' is defined, x is a bitmask that
  1137.         determines how the /proc interface works and what it
  1138.         does - see the PR_xxx defines in in2000.h
  1139.  
  1140.  
  1141.     Some example usages are listed below:
  1142.  
  1143. <code>
  1144.     in2000=ioport:0x220,noreset
  1145.     in2000=period:250,disconnect:2,nosync:0x03
  1146.     in2000=debug:0x1e
  1147.     in2000=proc:3
  1148. </code>
  1149.  
  1150.  
  1151. <sect2>AMD AM53C974 based hardware (`AM53C974=')
  1152. <p>
  1153.  
  1154.     Unlike other drivers, this one does not use boot parameters
  1155.     to communicate i/o, IRQ or DMA channels. (Since the AM53C974
  1156.     is a PCI device, there shouldn't be a need to do so.)
  1157.     Instead, the parameters are used to communicate the transfer
  1158.     modes and rates that are to be used between the host and
  1159.     the target device. This is best described with an example:
  1160.  
  1161. <code>
  1162.     AM53C974=7,2,8,15
  1163. </code>
  1164.  
  1165.     This would be interpreted as follows: `For communication between
  1166.     the controller with SCSI-ID 7 and the device with SCSI-ID 2, a
  1167.     transfer rate of 8MHz in synchronous mode with max. 15 bytes
  1168.     offset should be negotiated.' More details can be found in
  1169.     the file <tt>linux/drivers/scsi/README.AM53C974</tt>
  1170.     
  1171. <sect2>BusLogic SCSI Hosts with v1.2 kernels (`buslogic=')
  1172. <p>
  1173.  
  1174.     In older kernels, the buslogic driver accepts only one parameter,
  1175.     that being the I/O base. It expects that to be one of the
  1176.     following valid values:
  1177.     <tt/0x130, 0x134, 0x230, 0x234, 0x330, 0x334/.
  1178.  
  1179. <sect2>BusLogic SCSI Hosts with v2.x kernels (`BusLogic=')
  1180. <p>
  1181.  
  1182.     With v2.x kernels, the BusLogic driver accepts many parameters.
  1183.     (Note the case in the above; upper case B and L!!!).
  1184.     The following detailed description is taken directly from
  1185.     Leonard N. Zubkoff's driver as included in the v2.0 kernel.
  1186.  
  1187.  
  1188.     For the BusLogic driver, a Kernel command line entry
  1189.     comprises the driver identifier "BusLogic=" optionally
  1190.     followed by a comma-separated sequence of integers and then
  1191.     optionally followed by a comma-separated sequence of
  1192.     strings.  Each command line entry applies to one BusLogic
  1193.     Host Adapter.  Multiple command line entries may be used in
  1194.     systems which contain multiple BusLogic Host Adapters.
  1195.     
  1196.     The first integer specified is the I/O Address at which
  1197.     the Host Adapter is located.  If unspecified, it defaults
  1198.     to 0 which means to apply this entry to the first BusLogic
  1199.     Host Adapter found during the default probe sequence.  If
  1200.     any I/O Address parameters are provided on the command
  1201.     line, then the default probe sequence is omitted.
  1202.     
  1203.     The second integer specified is the Tagged Queue Depth to
  1204.     use for Target Devices that support Tagged Queuing.  The
  1205.     Queue Depth is the number of SCSI commands that are allowed
  1206.     to be concurrently presented for execution.  If
  1207.     unspecified, it defaults to 0 which means to use a value
  1208.     determined automatically based on the Host Adapter's Total
  1209.     Queue Depth and the number, type, speed, and capabilities
  1210.     of the detected Target Devices.  For Host Adapters that
  1211.     require ISA Bounce Buffers, the Tagged Queue Depth is
  1212.     automatically set to BusLogic_TaggedQueueDepth_BB to avoid
  1213.     excessive preallocation of DMA Bounce Buffer memory.
  1214.     Target Devices that do not support Tagged Queuing use a
  1215.     Queue Depth of BusLogic_UntaggedQueueDepth.
  1216.     
  1217.     The third integer specified is the Bus Settle Time in
  1218.     seconds.  This is the amount of time to wait between a Host
  1219.     Adapter Hard Reset which initiates a SCSI Bus Reset and
  1220.     issuing any SCSI Commands.  If unspecified, it defaults to
  1221.     0 which means to use the value of
  1222.     BusLogic_DefaultBusSettleTime.
  1223.     
  1224.     The fourth integer specified is the Local Options.  If
  1225.     unspecified, it defaults to 0.  Note that Local Options are
  1226.     only applied to a specific Host Adapter.
  1227.     
  1228.     The fifth integer specified is the Global Options.  If
  1229.     unspecified, it defaults to 0.  Note that Global Options
  1230.     are applied across all Host Adapters.
  1231.     
  1232.     The string options are used to provide control over
  1233.     Tagged Queuing, Error Recovery, and Host Adapter Probing.
  1234.     
  1235.     The Tagged Queuing specification begins with "TQ:" and
  1236.     allows for explicitly specifying whether Tagged Queuing is
  1237.     permitted on Target Devices that support it.  The following
  1238.     specification options are available:
  1239.  
  1240.     TQ:Default --
  1241.             Tagged Queuing will be permitted based on the firmware
  1242.             version of the BusLogic Host Adapter and based on
  1243.             whether the Tagged Queue Depth value allows queuing
  1244.             multiple commands.
  1245.  
  1246.     TQ:Enable --
  1247.             Tagged Queuing will be enabled for all Target Devices
  1248.             on this Host Adapter overriding any limitation that
  1249.             would otherwise be imposed based on the Host Adapter
  1250.             firmware version.
  1251.  
  1252.     TQ:Disable --
  1253.             Tagged Queuing will be disabled for all Target Devices
  1254.             on this Host Adapter.
  1255.  
  1256.     TQ:<Per-Target-Spec> --
  1257.             Tagged Queuing will be controlled individually for each
  1258.             Target Device. <Per-Target-Spec> is a sequence of "Y",
  1259.             "N", and "X" characters.  "Y" enabled Tagged Queuing,
  1260.             "N" disables Tagged Queuing, and "X" accepts the
  1261.             default based on the firmware version.  The first
  1262.             character refers to Target Device 0, the second to
  1263.             Target Device 1, and so on; if the sequence of "Y",
  1264.             "N", and "X" characters does not cover all the Target
  1265.             Devices, unspecified characters are assumed to be "X".
  1266.  
  1267.     Note that explicitly requesting Tagged Queuing may lead to problems;
  1268.     this facility is provided primarily to allow disabling Tagged
  1269.     Queuing on Target Devices that do not implement it correctly.
  1270.  
  1271.     The Error Recovery Strategy specification begins with "ER:" and
  1272.     allows for explicitly specifying the Error Recovery action to be
  1273.     performed when ResetCommand is called due to a SCSI Command failing
  1274.     to complete successfully.  The following specification options
  1275.     are available:
  1276.  
  1277.     ER:Default --
  1278.             Error Recovery will select between the Hard Reset and
  1279.             Bus Device Reset options based on the recommendation
  1280.             of the SCSI Subsystem.
  1281.  
  1282.     ER:HardReset --
  1283.             Error Recovery will initiate a Host Adapter Hard Reset
  1284.             which also causes a SCSI Bus Reset.
  1285.  
  1286.     ER:BusDeviceReset --
  1287.             Error Recovery will send a Bus Device Reset message to
  1288.             the individual Target Device causing the error.  If
  1289.             Error Recovery is again initiated for this Target
  1290.             Device and no SCSI Command to this Target Device has
  1291.             completed successfully since the Bus Device Reset
  1292.             message was sent, then a Hard Reset will be attempted.
  1293.  
  1294.     ER:None --
  1295.             Error Recovery will be suppressed.  This option should
  1296.             only be selected if a SCSI Bus Reset or Bus Device
  1297.             Reset will cause the Target Device to fail completely
  1298.             and unrecoverably.
  1299.  
  1300.     ER:<Per-Target-Spec> --
  1301.             Error Recovery will be controlled individually for each
  1302.             Target Device. <Per-Target-Spec> is a sequence of "D",
  1303.             "H", "B", and "N" characters.  "D" selects Default, "H"
  1304.             selects Hard Reset, "B" selects Bus Device Reset, and
  1305.             "N" selects None.  The first character refers to Target
  1306.             Device 0, the second to Target Device 1, and so on; if
  1307.             the sequence of "D", "H", "B", and "N" characters does
  1308.             not cover all the possible Target Devices, unspecified
  1309.             characters are assumed to be "D".
  1310.  
  1311.     The Host Adapter Probing specification comprises the following strings:
  1312.  
  1313.     NoProbe --
  1314.             No probing of any kind is to be performed, and hence
  1315.             no BusLogic Host Adapters will be detected.
  1316.  
  1317.     NoProbeISA --
  1318.             No probing of the standard ISA I/O Addresses will
  1319.             be done, and hence only PCI Host Adapters will be
  1320.             detected.
  1321.  
  1322.     NoSortPCI --
  1323.             PCI Host Adapters will be enumerated in the order
  1324.             provided by the PCI BIOS, ignoring any setting of
  1325.             the AutoSCSI "Use Bus And Device # For PCI Scanning
  1326.             Seq." option.
  1327.  
  1328. <sect2>Future Domain TMC-8xx, TMC-950 (`tmc8xx=')
  1329. <p>
  1330.  
  1331.     The probe code for these SCSI hosts looks for an installed BIOS,
  1332.     and if none is present, the probe will not find your card. Or,
  1333.     if the signature string of your BIOS is not recognized then it
  1334.     will also not be found. In either case, you will then have to use a
  1335.     boot arg of the form:
  1336.  
  1337. <code>
  1338.     tmc8xx=mem_base,irq
  1339. </code>
  1340.  
  1341.     The <tt/mem_base/ value is the value of the memory mapped
  1342.     I/O region that the card uses. This will usually be one of
  1343.     the following values:
  1344.         <tt/0xc8000, 0xca000, 0xcc000, 0xce000, 0xdc000, 0xde000/.
  1345.  
  1346. <sect2>IOMEGA Parallel Port / ZIP drive (`ppa=')
  1347. <p>
  1348.  
  1349.     This driver is for the IOMEGA Parallel Port SCSI adapter
  1350.     which is embedded into the IOMEGA ZIP drives. It may also
  1351.     work with the original IOMEGA PPA3 device. The boot argument
  1352.     for this driver is of the form:
  1353.  
  1354. <code>
  1355.     ppa=iobase,speed_high,speed_low,nybble
  1356. </code>
  1357.  
  1358.     with all but iobase being optionally specified values. If you
  1359.     wish to alter any of the three optional parameters, you
  1360.     are advised to read <tt>linux/drivers/scsi/README.ppa</tt>
  1361.     for details of what they control.
  1362.  
  1363. <sect2>NCR5380 based controllers (`ncr5380=')
  1364. <p>
  1365.  
  1366.     Depending on your board, the 5380 can be either i/o mapped
  1367.     or memory mapped. (An address below 0x400 usually implies
  1368.     i/o mapping, but PCI and EISA hardware use i/o addresses
  1369.     above 0x3ff.) In either case, you specify the address, the
  1370.     IRQ value and the DMA channel value. An example for an i/o
  1371.     mapped card would be: <tt/ncr5380=0x350,5,3/. If the card
  1372.     doesn't use interrupts, then an IRQ value of 255 (<tt/0xff/)
  1373.     will disable interrupts. An IRQ value of 254 means to
  1374.     autoprobe. More details can be found in the file
  1375.     <tt>linux/drivers/scsi/README.g_NCR5380</tt>
  1376.  
  1377. <sect2>NCR53c400 based controllers (`ncr53c400=')
  1378. <p>
  1379.  
  1380.     The generic 53c400 support is done with the same driver as
  1381.     the generic 5380 support mentioned above. The boot argument is
  1382.     identical to the above with the exception that no DMA channel
  1383.     is used by the 53c400.
  1384.  
  1385. <sect2>NCR53c406a based controllers (`ncr53c406a=')
  1386. <p>
  1387.  
  1388.     This driver uses a boot argument of the form:
  1389.  
  1390. <code>
  1391.     ncr53c406a=PORTBASE,IRQ,FASTPIO
  1392. </code>
  1393.  
  1394.     where the IRQ and FASTPIO parameters are optional. An interrupt
  1395.     value of zero disables the use of interrupts. Using a value of
  1396.     one for the FASTPIO parameter enables the use of <tt/insl/ and
  1397.     <tt/outsl/ instructions instead of the single-byte <tt/inb/
  1398.     and <tt/outb/ instructions. The driver can also use DMA as
  1399.     a compile-time option.
  1400.  
  1401. <sect2>Pro Audio Spectrum (`pas16=')
  1402. <p>
  1403.  
  1404.     The PAS16 uses a NCR5380 SCSI chip, and newer models support
  1405.     jumper-less configuration. The boot arg is of the form:
  1406.  
  1407. <code>
  1408.     pas16=iobase,irq
  1409. </code>
  1410.  
  1411.     The only difference is that you can specify an IRQ value of
  1412.     255, which will tell the driver to work without using interrupts,
  1413.     albeit at a performance loss. The <tt/iobase/ is usually <tt/0x388/.
  1414.  
  1415. <sect2>Seagate ST-0x (`st0x=')
  1416. <p>
  1417.  
  1418.     The probe code for these SCSI hosts looks for an installed BIOS,
  1419.     and if none is present, the probe will not find your card. Or,
  1420.     if the signature string of your BIOS is not recognized then it
  1421.     will also not be found. In either case, you will then have to use a
  1422.     boot arg of the form:
  1423.  
  1424. <code>
  1425.     st0x=mem_base,irq
  1426. </code>
  1427.  
  1428.     The <tt/mem_base/ value is the value of the memory mapped
  1429.     I/O region that the card uses. This will usually be one of
  1430.     the following values:
  1431.         <tt/0xc8000, 0xca000, 0xcc000, 0xce000, 0xdc000, 0xde000/.
  1432.  
  1433. <sect2>Trantor T128 (`t128=')
  1434. <p>
  1435.  
  1436.     These cards are also based on the NCR5380 chip, and accept
  1437.     the following options:
  1438.  
  1439. <code>
  1440.     t128=mem_base,irq
  1441. </code>
  1442.  
  1443.     The valid values for <tt/mem_base/ are as follows:
  1444.     <tt/0xcc000, 0xc8000, 0xdc000, 0xd8000/.
  1445.  
  1446. <sect1>SCSI Host Adapters that don't Accept Boot Args
  1447. <p>
  1448.  
  1449.     At present, the following SCSI cards do not make use of any
  1450.     boot-time parameters. In some cases, you can <em/hard-wire/
  1451.     values by directly editing the driver itself, if required.
  1452.  
  1453. <verb>
  1454.     Adaptec aha1740,
  1455.     EATA-DMA, EATA-PIO,
  1456.     Future Domain 16xx,
  1457.     NCR53c7xx to NCR53c8xx,
  1458.     Qlogic,
  1459.     Ultrastor (incl. u?4f),
  1460.     Western Digital wd7000,
  1461. </verb>
  1462.  
  1463. <sect>Hard Disks
  1464. <p>
  1465.  
  1466.     This section lists all the boot args associated with standard
  1467.     MFM/RLL, ST-506, XT, and IDE disk drive devices.
  1468.     Note that both the IDE and the generic ST-506 HD driver
  1469.     both accept the `hd=' option.
  1470.  
  1471. <sect1>IDE Disk/CD-ROM Driver Parameters
  1472. <p>
  1473.  
  1474.     The IDE driver accepts a number of parameters, which range
  1475.     from disk geometry specifications, to support for advanced or
  1476.     broken controller chips. The following is a summary of
  1477.     all the possible boot arguments. For full details, you
  1478.     <em/really/ should consult the file <tt/ide.txt/ in the
  1479.     <tt>linux/Documentation</tt> directory.
  1480.  
  1481. <code>
  1482.  
  1483.  "hdx="  is recognized for all "x" from "a" to "h", such as "hdc".
  1484.  "idex=" is recognized for all "x" from "0" to "3", such as "ide1".
  1485.  
  1486.  "hdx=noprobe"        : drive may be present, but do not probe for it
  1487.  "hdx=none"        : drive is NOT present, ignore cmos and do not probe
  1488.  "hdx=nowerr"        : ignore the WRERR_STAT bit on this drive
  1489.  "hdx=cdrom"        : drive is present, and is a cdrom drive
  1490.  "hdx=cyl,head,sect"    : disk drive is present, with specified geometry
  1491.  "hdx=autotune"        : driver will attempt to tune interface speed
  1492.                 to the fastest PIO mode supported,
  1493.                 if possible for this drive only.
  1494.                 Not fully supported by all chipset types,
  1495.                 and quite likely to cause trouble with
  1496.                 older/odd IDE drives.
  1497.  
  1498.  "idex=noprobe"        : do not attempt to access/use this interface
  1499.  "idex=base"        : probe for an interface at the addr specified,
  1500.                 where "base" is usually 0x1f0 or 0x170
  1501.                 and "ctl" is assumed to be "base"+0x206
  1502.  "idex=base,ctl"    : specify both base and ctl
  1503.  "idex=base,ctl,irq"    : specify base, ctl, and irq number
  1504.  "idex=autotune"    : driver will attempt to tune interface speed
  1505.                 to the fastest PIO mode supported,
  1506.                 for all drives on this interface.
  1507.                 Not fully supported by all chipset types,
  1508.                 and quite likely to cause trouble with
  1509.                 older/odd IDE drives.
  1510.  "idex=noautotune"    : driver will NOT attempt to tune interface speed
  1511.                 This is the default for most chipsets,
  1512.                 except the cmd640.
  1513.  "idex=serialize"    : do not overlap operations on idex and ide(x^1)
  1514.  
  1515. </code>
  1516.  
  1517.     The following are valid ONLY on ide0,
  1518.     and the defaults for the base,ctl ports must not be altered.
  1519.  
  1520. <code>
  1521.  
  1522.  "ide0=dtc2278"        : probe/support DTC2278 interface
  1523.  "ide0=ht6560b"        : probe/support HT6560B interface
  1524.  "ide0=cmd640_vlb"    : *REQUIRED* for VLB cards with the CMD640 chip
  1525.               (not for PCI -- automatically detected)
  1526.  "ide0=qd6580"        : probe/support qd6580 interface
  1527.  "ide0=ali14xx"        : probe/support ali14xx chipsets (ALI M1439/M1445)
  1528.  "ide0=umc8672"        : probe/support umc8672 chipsets
  1529.  
  1530. </code>
  1531.  
  1532.     Everything else is rejected with a "BAD OPTION" message.
  1533.  
  1534. <sect1>Standard ST-506 Disk Driver Options (`hd=')
  1535. <p>
  1536.  
  1537.     The standard disk driver can accept geometry arguments for
  1538.     the disks similar to the IDE driver. Note however that it
  1539.     only expects three values (C/H/S) -- any more or any less
  1540.     and it will silently ignore you. Also, it only accepts
  1541.     `hd=' as an argument, i.e. `hda=', `hdb=' and so on are
  1542.     not valid here. The format is as follows:
  1543.  
  1544. <code>
  1545.     hd=cyls,heads,sects
  1546. </code>
  1547.  
  1548.     If there are two disks installed, the above is repeated
  1549.     with the geometry parameters of the second disk.
  1550.  
  1551. <sect1>XT Disk Driver Options (`xd=')
  1552. <p>
  1553.  
  1554.     If you are unfortunate enough to be using one of these old
  1555.     8 bit cards that move data at a whopping 125kB/s then here
  1556.     is the scoop.  The probe code for these cards looks for an installed
  1557.     BIOS, and if none is present, the probe will not find your card. Or,
  1558.     if the signature string of your BIOS is not recognized then it
  1559.     will also not be found. In either case, you will then have to use a
  1560.     boot arg of the form:
  1561.  
  1562. <code>
  1563.     xd=type,irq,iobase,dma_chan
  1564. </code>
  1565.  
  1566.     The <tt/type/ value specifies the particular manufacturer of the
  1567.     card, and are as follows: 0=generic; 1=DTC; 2,3,4=Western Digital,
  1568.     5,6,7=Seagate; 8=OMTI. The only difference between multiple types
  1569.     from the same manufacturer is the BIOS string used for detection,
  1570.     which is not used if the type is specified.
  1571.  
  1572.     The <tt/xd_setup()/ function does no checking on the values, and
  1573.     assumes that you entered all four values. Don't disappoint it.
  1574.     Here is an example usage for a WD1002 controller with the BIOS
  1575.     disabled/removed, using the `default' XT controller parameters:
  1576.  
  1577. <code>
  1578.     xd=2,5,0x320,3
  1579. </code>
  1580.  
  1581. <sect>CD-ROMs (Non-SCSI/ATAPI/IDE)
  1582. <p>
  1583.  
  1584.     This section lists all the possible boot args pertaining to
  1585.     CD-ROM devices. Note that this does not include SCSI or
  1586.     IDE/ATAPI CD-ROMs. See the appropriate section(s) for those
  1587.     types of CD-ROMs.
  1588.  
  1589.     Note that most of these CD-ROMs have documentation files that you
  1590.     <em/should/ read, and they are all in one handy place:
  1591.     <tt>linux/Documentation/cdrom</tt>.
  1592.  
  1593. <sect1>The Aztech Interface (`aztcd=')
  1594. <p>
  1595.  
  1596.     The syntax for this type of card is:
  1597.  
  1598. <code>
  1599.     aztcd=iobase[,magic_number]
  1600. </code>
  1601.  
  1602.     If you set the <tt/magic_number/ to <tt/0x79/ then the driver
  1603.     will try and run anyway in the event of an unknown firmware
  1604.     version. All other values are ignored.
  1605.  
  1606. <sect1>The CDU-31A and CDU-33A Sony Interface (`cdu31a=')
  1607. <p>
  1608.  
  1609.     This CD-ROM interface is found on some of the Pro Audio
  1610.     Spectrum sound cards, and other Sony supplied interface cards.
  1611.     The syntax is as follows:
  1612.  
  1613. <code>
  1614.     cdu31a=iobase,[irq[,is_pas_card]]
  1615. </code>
  1616.  
  1617.     Specifying an IRQ value of zero tells the driver that hardware
  1618.     interrupts aren't supported (as on some PAS cards). If your
  1619.     card supports interrupts, you should use them as it cuts down
  1620.     on the CPU usage of the driver.
  1621.  
  1622.     The `is_pas_card' should be entered as `PAS' if using a
  1623.     Pro Audio Spectrum card, and otherwise it should not be
  1624.     specified at all.
  1625.  
  1626. <sect1>The CDU-535 Sony Interface (`sonycd535=')
  1627. <p>
  1628.  
  1629.     The syntax for this CD-ROM interface is:
  1630.  
  1631. <code>
  1632.     sonycd535=iobase[,irq]
  1633. </code>
  1634.  
  1635.     A zero can be used for the I/O base as a `placeholder'
  1636.     if one wishes to specify an IRQ value.
  1637.  
  1638. <sect1>The GoldStar Interface (`gscd=')
  1639. <p>
  1640.  
  1641.     The syntax for this CD-ROM interface is:
  1642.  
  1643. <code>
  1644.     gscd=iobase
  1645. </code>
  1646.  
  1647. <sect1>The ISP16 Interface (`isp16=')
  1648. <p>
  1649.  
  1650.  
  1651.     The syntax for this CD-ROM interface is:
  1652.  
  1653. <code>
  1654.     isp16=[port[,irq[,dma]]][[,]drive_type]
  1655. </code>
  1656.  
  1657.     Using a zero for <tt/irq/ or <tt/dma/ means that they are not
  1658.     used. The allowable values for <tt/drive_type/ are
  1659.     <tt/noisp16, Sanyo, Panasonic, Sony,/ and <tt/Mitsumi/.
  1660.     Using <tt/noisp16/ disables the driver altogether.
  1661.  
  1662. <sect1>The Mitsumi Standard Interface (`mcd=')
  1663. <p>
  1664.  
  1665.     The syntax for this CD-ROM interface is:
  1666.  
  1667. <code>
  1668.     mcd=iobase,[irq[,wait_value]]
  1669. </code>
  1670.  
  1671.     The <tt/wait_value/ is used as an internal timeout value
  1672.     for people who are having problems with their drive, and
  1673.     may or may not be implemented depending on a compile time
  1674.     <tt/DEFINE/.
  1675.  
  1676. <sect1>The Mitsumi XA/MultiSession Interface (`mcdx=')
  1677. <p>
  1678.  
  1679.     At present this `experimental' driver has a setup function,
  1680.     but no parameters are implemented yet (as of 1.3.15).
  1681.     This is for the same hardware as above, but the driver
  1682.     has extended features.
  1683.  
  1684. <sect1>The Optics Storage Interface (`optcd=')
  1685. <p>
  1686.  
  1687.     The syntax for this type of card is:
  1688.  
  1689. <code>
  1690.     optcd=iobase
  1691. </code>
  1692.  
  1693. <sect1>The Phillips CM206 Interface (`cm206=')
  1694. <p>
  1695.  
  1696.     The syntax for this type of card is:
  1697.  
  1698. <code>
  1699.     cm206=[iobase][,irq]
  1700. </code>
  1701.  
  1702.     The driver assumes numbers between 3 and 11 are IRQ values,
  1703.     and numbers between <tt/0x300/ and <tt/0x370/ are I/O ports,
  1704.     so you can specify one, or both numbers, in any order.
  1705.     It also accepts `cm206=auto' to enable autoprobing.
  1706.     
  1707. <sect1>The Sanyo Interface (`sjcd=')
  1708. <p>
  1709.  
  1710.     The syntax for this type of card is:
  1711.  
  1712. <code>
  1713.     sjcd=iobase[,irq[,dma_channel]]
  1714. </code>
  1715.  
  1716. <sect1>The SoundBlaster Pro Interface (`sbpcd=')
  1717. <p>
  1718.  
  1719.     The syntax for this type of card is:
  1720.  
  1721. <code>
  1722.     sbpcd=iobase,type
  1723. </code>
  1724.  
  1725.     where <tt/type/ is one of the following (case sensitive)
  1726.     strings: `SoundBlaster', `LaserMate', or `SPEA'.
  1727.     The I/O base is that of the CD-ROM interface, and <em/not/
  1728.     that of the sound portion of the card.
  1729.  
  1730. <sect>Other Hardware Devices
  1731. <p>
  1732.  
  1733.     Any other devices that didn't fit into any of the above categories
  1734.     got lumped together here.
  1735.  
  1736. <sect1>Ethernet Devices (`ether=')
  1737. <p>
  1738.     Different drivers make use of different parameters, but they all
  1739.     at least share having an IRQ, an I/O port base value, and
  1740.     a name. In its most generic form, it looks something like this:
  1741.  
  1742. <code>
  1743.     ether=irq,iobase[,param_1[,param_2,...param_8]]],name
  1744. </code>
  1745.     
  1746.     The first non-numeric argument is taken as the name.
  1747.     The <tt/param_n/ values (if applicable) usually have
  1748.     different meanings for each different card/driver.
  1749.     Typical <tt/param_n/ values are used to specify things
  1750.     like shared memory address, interface selection, DMA
  1751.     channel and the like.
  1752.  
  1753.     The most common use of this parameter is to force probing
  1754.     for a second ethercard, as the default is to only probe
  1755.     for one. This can be accomplished with a simple:
  1756.  
  1757. <code>
  1758.     ether=0,0,eth1
  1759. </code>
  1760.  
  1761.     Note that the values of zero for the IRQ and I/O base in the
  1762.     above example tell the driver(s) to autoprobe.
  1763.  
  1764.     Note that the Ethernet-HowTo has complete and extensive
  1765.     documentation on using multiple cards and on the card/driver
  1766.     specific implementation of the <tt/param_n/ values
  1767.     where used. Interested readers should refer to the section
  1768.     in that document on their particular card for more complete
  1769.     information.
  1770.  
  1771. <sect1>The Floppy Disk Driver (`floppy=')
  1772. <p>
  1773.  
  1774.     There are many floppy driver options, and they are all listed in
  1775.     <tt/README.fd/ in <tt>linux/drivers/block</tt>. This information
  1776.     is taken directly from that file.
  1777.     
  1778.  
  1779.     floppy=mask,allowed_drive_mask
  1780.  
  1781.     Sets the bitmask of allowed drives to <tt/mask/. By default, only units
  1782.     0 and 1 of each floppy controller are allowed. This is done because
  1783.     certain non-standard hardware (ASUS PCI motherboards) mess up the
  1784.     keyboard when accessing units 2 or 3. This option is somewhat
  1785.     obsoleted by the cmos option.
  1786.  
  1787.     floppy=all_drives
  1788.  
  1789.     Sets the bitmask of allowed drives to all drives. Use this if you have
  1790.     more than two drives connected to a floppy controller.
  1791.  
  1792.     floppy=asus_pci
  1793.  
  1794.     Sets the bitmask to allow only units 0 and 1. (The default)
  1795.  
  1796.     floppy=daring
  1797.  
  1798.     Tells the floppy driver that you have a well behaved floppy controller.
  1799.     This allows more efficient and smoother operation, but may fail on
  1800.     certain controllers. This may speed up certain operations.
  1801.  
  1802.     floppy=0,daring
  1803.  
  1804.     Tells the floppy driver that your floppy controller should be used
  1805.     with caution.
  1806.  
  1807.     floppy=one_fdc
  1808.  
  1809.     Tells the floppy driver that you have only floppy controller (default)
  1810.  
  1811.     floppy=two_fdc <em/or/ floppy=address,two_fdc
  1812.  
  1813.     Tells the floppy driver that you have two floppy controllers. The
  1814.     second floppy controller is assumed to be at address. If address
  1815.     is not given, 0x370 is assumed.
  1816.  
  1817.     floppy=thinkpad
  1818.  
  1819.     Tells the floppy driver that you have a Thinkpad. Thinkpads use an
  1820.     inverted convention for the disk change line.
  1821.  
  1822.     floppy=0,thinkpad
  1823.  
  1824.     Tells the floppy driver that you don't have a Thinkpad.
  1825.  
  1826.     floppy=drive,type,cmos
  1827.  
  1828.     Sets the cmos type of <tt/drive/ to <tt/type/.
  1829.     Additionally, this drive is
  1830.     allowed in the bitmask. This is useful if you have more than two
  1831.     floppy drives (only two can be described in the physical cmos), or if
  1832.     your BIOS uses non-standard CMOS types.
  1833.     Setting the CMOS to 0 for the first two drives (default) makes the
  1834.     floppy driver read the physical cmos for those drives.
  1835.  
  1836.     floppy=unexpected_interrupts
  1837.  
  1838.     Print a warning message when an unexpected interrupt is received
  1839.     (default behaviour)
  1840.  
  1841.     floppy=no_unexpected_interrupts <em/or/ floppy=L40SX
  1842.  
  1843.     Don't print a message when an unexpected interrupt is received. This
  1844.     is needed on IBM L40SX laptops in certain video modes. (There seems
  1845.     to be an interaction between video and floppy. The unexpected interrupts
  1846.     only affect performance, and can safely be ignored.)
  1847.  
  1848.  
  1849. <sect1>The Sound Driver (`sound=')
  1850. <p>
  1851.  
  1852.     The sound driver can also accept boot args to override the
  1853.     compiled in values. This is not recommended, as it is
  1854.     rather complex. It is described in the <tt/Readme.Linux/
  1855.     file, in <tt>linux/drivers/sound</tt>. It accepts a boot arg
  1856.     of the form:
  1857.  
  1858. <code>
  1859.     sound=device1[,device2[,device3...[,device11]]]
  1860. </code>
  1861.  
  1862.     where each <tt/deviceN/ value is of the following format
  1863.     <tt/0xTaaaId/ and the bytes are used as follows:
  1864.  
  1865.     T - device type: 1=FM, 2=SB, 3=PAS, 4=GUS, 5=MPU401, 6=SB16, 7=SB16-MPU401
  1866.  
  1867.     aaa - I/O address in hex.
  1868.  
  1869.     I - interrupt line in hex (i.e 10=a, 11=b, ...)
  1870.  
  1871.     d - DMA channel.
  1872.  
  1873.     As you can see it gets pretty messy, and you are better off to
  1874.     compile in your own personal values as recommended. Using a boot
  1875.     arg of `sound=0' will disable the sound driver entirely.
  1876.  
  1877. <sect1>The Bus Mouse Driver (`bmouse=')
  1878. <p>
  1879.  
  1880.     The busmouse driver only accepts one parameter, that being
  1881.     the hardware IRQ value to be used.
  1882.  
  1883. <sect1>The MS Bus Mouse Driver (`msmouse=')
  1884. <p>
  1885.  
  1886.     The MS mouse driver only accepts one parameter, that being
  1887.     the hardware IRQ value to be used.
  1888.  
  1889. <sect1>The Printer Driver (`lp=')
  1890. <p>
  1891.  
  1892.     As of kernels newer than 1.3.75, you can tell the printer driver
  1893.     what ports to use and what ports <em/not/ to use. The latter comes
  1894.     in handy if you don't want the printer driver to claim all available
  1895.     parallel ports, so that other drivers (e.g. PLIP, PPA) can use
  1896.     them instead.
  1897.  
  1898.     The format of the argument is multiple i/o, IRQ pairs. For example,
  1899.     <tt/lp=0x3bc,0,0x378,7/ would use the port at 0x3bc in IRQ-less
  1900.     (polling) mode, and use IRQ 7 for the port at 0x378. The port
  1901.     at 0x278 (if any) would not be probed, since autoprobing only
  1902.     takes place in the absence of a `lp=' argument. To disable the
  1903.     printer driver entirely, one can use <tt/lp=0/.
  1904.  
  1905. <sect1>The ICN ISDN driver (`icn=')
  1906. <p>
  1907.  
  1908.     This ISDN driver expects a boot argument of the form:
  1909.  
  1910. <code>
  1911.     icn=iobase,membase,icn_id1,icn_id2
  1912. </code>
  1913.  
  1914.     where <tt/iobase/ is the i/o port address of the card, <tt/membase/
  1915.     is the shared memory base address of the card, and the two
  1916.     <tt/icn_id/ are unique ASCII string identifiers.
  1917.  
  1918. <sect1>The PCBIT ISDN driver (`pcbit=')
  1919. <p>
  1920.  
  1921.     This boot argument takes integer pair arguments of the form:
  1922.  
  1923. <code>
  1924.     pcbit=membase1,irq1[,membase2,irq2]
  1925. </code>
  1926.  
  1927.     where <tt/membaseN/ is the shared memory base of the N'th card,
  1928.     and <tt/irqN/ is the interrupt setting of the N'th card. The
  1929.     default is IRQ 5 and membase <tt/0xD0000/.
  1930.  
  1931. <sect1>The Teles ISDN driver (`teles=')
  1932. <p>
  1933.  
  1934.     This ISDN driver expects a boot argument of the form:
  1935.  
  1936. <code>
  1937.     teles=iobase,irq,membase,protocol,teles_id
  1938. </code>
  1939.  
  1940.     where <tt/iobase/ is the i/o port address of the card, <tt/membase/
  1941.     is the shared memory base address of the card, <tt/irq/ is the
  1942.     interrupt channel the card uses, and <tt/teles_id/ is the
  1943.     unique ASCII string identifier.
  1944.  
  1945. <sect1>The DigiBoard Driver (`digi=')
  1946. <p>
  1947.  
  1948.     The DigiBoard driver accepts a string of six comma separated
  1949.     identifiers or integers.  The 6 values in order are:
  1950.  
  1951. <verb>
  1952.     Enable/Disable this card
  1953.     Type of card: PC/Xi(0), PC/Xe(1), PC/Xeve(2), PC/Xem(3)
  1954.     Enable/Disable alternate pin arrangement
  1955.     Number of ports on this card
  1956.     I/O Port where card is configured (in HEX if using string identifiers)
  1957.     Base of memory window (in HEX if using string identifiers)
  1958. </verb>
  1959.  
  1960.     An example of a correct boot prompt argument (in both
  1961.     identifier and integer form) is:
  1962.  
  1963. <code>
  1964.     digi=E,PC/Xi,D,16,200,D0000
  1965.     digi=1,0,0,16,512,851968
  1966. </code>
  1967.  
  1968.     Note that the driver defaults to an i/o of <tt/0x200/ and 
  1969.     a shared memory base of <tt/0xD0000/
  1970.     in the absence of a <tt/digi=/ boot argument.  There is no
  1971.     autoprobing performed. More details can be found in the file
  1972.     <tt>linux/Documentation/digiboard.txt</tt>.
  1973.  
  1974. <sect1>The RISCom/8 Multiport Serial Driver (`riscom8=')
  1975. <p>
  1976.  
  1977.     Up to four boards can be supported by supplying four
  1978.     unique i/o port values for each individual board installed.
  1979.     Other details can be found in the file
  1980.     <tt>linux/Documentation/riscom8.txt</tt>.
  1981.  
  1982. <sect1>The Baycom Serial/Parallel Radio Modem (`baycom=')
  1983. <p>
  1984.  
  1985.     The format of the boot argument for these devices is:
  1986.  
  1987. <code>
  1988.     baycom=modem,io,irq,options[,modem,io,irq,options]
  1989. </code>
  1990.  
  1991.     Using modem=1 means you have the ser12 device, modem=2 means
  1992.     you have the par96 device. Using options=0 means use hardware DCD,
  1993.     and options=1 means use software DCD. The <tt/io/ and <tt/irq/
  1994.     are the i/o port base and interrupt settings as usual.
  1995.     There is more details in the file <tt/README.baycom/ which
  1996.     is currently in the <tt>/linux/drivers/char/</tt> directory.
  1997.  
  1998. <sect>Closing
  1999. <p>
  2000.  
  2001.     If you have found any glaring typos, or outdated info in this
  2002.     document, please let me know. It is easy to overlook stuff.
  2003.  
  2004.     Thanks,
  2005.  
  2006.     Paul Gortmaker, <tt/gpg109@rsphy1.anu.edu.au/
  2007.  
  2008. </article>
  2009.