docs: m68k: convert docs to ReST and rename to *.rst

	LOOP	Loopback device support is enabled.

	M68k	M68k architecture is enabled.

			These options have more detailed description inside of

			Documentation/m68k/kernel-options.txt.

			Documentation/m68k/kernel-options.rst.

	MDA	MDA console support is enabled.

	MIPS	MIPS architecture is enabled.

	MOUSE	Appropriate mouse support is enabled.

:orphan:

=================

m68k Architecture

=================

.. toctree::

   :maxdepth: 2

   kernel-options

.. only::  subproject and html

   Indices

   =======

   * :ref:`genindex`

===================================

Command Line Options for Linux/m68k

===================================

Last Update: 2 May 1999

Linux/m68k version: 2.2.6

Author: Roman.Hodek@informatik.uni-erlangen.de (Roman Hodek)

Update: jds@kom.auc.dk (Jes Sorensen) and faq@linux-m68k.org (Chris Lawrence)

0) Introduction

2.1) root=

----------

Syntax: root=/dev/<device>

    or: root=<hex_number>

:Syntax: root=/dev/<device>

:or:     root=<hex_number>

This tells the kernel which device it should mount as the root

filesystem. The device must be a block device with a valid filesystem

isn't mounted yet... So the kernel parses the name itself, with some

hardcoded name to number mappings. The name must always be a

combination of two or three letters, followed by a decimal number.

Valid names are:

Valid names are::

  /dev/ram: -> 0x0100 (initial ramdisk)

  /dev/hda: -> 0x0300 (first IDE disk)

if partition 5 of the device has the UUID of

00112233-4455-6677-8899-AABBCCDDEEFF then partition 3 may be found as

follows:

  PARTUUID=00112233-4455-6677-8899-AABBCCDDEEFF/PARTNROFF=-2

Authoritative information can be found in

2.2) ro, rw

-----------

Syntax: ro

    or: rw

:Syntax: ro

:or:     rw

These two options tell the kernel whether it should mount the root

filesystem read-only or read-write. The default is read-only, except

2.3) debug

----------

Syntax: debug

:Syntax: debug

This raises the kernel log level to 10 (the default is 7). This is the

same level as set by the "dmesg" command, just that the maximum level

2.4) debug=

-----------

Syntax: debug=<device>

:Syntax: debug=<device>

This option causes certain kernel messages be printed to the selected

debugging device. This can aid debugging the kernel, since the

Devices possible for Amiga:

 - "ser": built-in serial port; parameters: 9600bps, 8N1

 - "mem": Save the messages to a reserved area in chip mem. After

 - "ser":

	  built-in serial port; parameters: 9600bps, 8N1

 - "mem":

	  Save the messages to a reserved area in chip mem. After

          rebooting, they can be read under AmigaOS with the tool

          'dmesg'.

Devices possible for Atari:

 - "ser1": ST-MFP serial port ("Modem1"); parameters: 9600bps, 8N1

 - "ser2": SCC channel B serial port ("Modem2"); parameters: 9600bps, 8N1

 - "ser" : default serial port

 - "ser1":

	   ST-MFP serial port ("Modem1"); parameters: 9600bps, 8N1

 - "ser2":

	   SCC channel B serial port ("Modem2"); parameters: 9600bps, 8N1

 - "ser" :

	   default serial port

           This is "ser2" for a Falcon, and "ser1" for any other machine

 - "midi": The MIDI port; parameters: 31250bps, 8N1

 - "par" : parallel port

 - "midi":

	   The MIDI port; parameters: 31250bps, 8N1

 - "par" :

	   parallel port

           The printing routine for this implements a timeout for the

           case there's no printer connected (else the kernel would

           lock up). The timeout is not exact, but usually a few

2.6) ramdisk_size=

-------------

------------------

Syntax: ramdisk_size=<size>

:Syntax: ramdisk_size=<size>

This option instructs the kernel to set up a ramdisk of the given

size in KBytes. Do not use this option if the ramdisk contents are

2.7) swap=

  I can't find any sign of this option in 2.2.6.

2.8) buff=

-----------

  I can't find any sign of these options in 2.2.6.

  I can't find any sign of this option in 2.2.6.

3) General Device Options (Amiga and Atari)

3.1) ether=

-----------

Syntax: ether=[<irq>[,<base_addr>[,<mem_start>[,<mem_end>]]]],<dev-name>

:Syntax: ether=[<irq>[,<base_addr>[,<mem_start>[,<mem_end>]]]],<dev-name>

<dev-name> is the name of a net driver, as specified in

drivers/net/Space.c in the Linux source. Most prominent are eth0, ...

3.2) hd=

--------

Syntax: hd=<cylinders>,<heads>,<sectors>

:Syntax: hd=<cylinders>,<heads>,<sectors>

This option sets the disk geometry of an IDE disk. The first hd=

option is for the first IDE disk, the second for the second one.

3.3) max_scsi_luns=

-------------------

Syntax: max_scsi_luns=<n>

:Syntax: max_scsi_luns=<n>

Sets the maximum number of LUNs (logical units) of SCSI devices to

be scanned. Valid values for <n> are between 1 and 8. Default is 8 if

3.4) st=

--------

Syntax: st=<buffer_size>,[<write_thres>,[<max_buffers>]]

:Syntax: st=<buffer_size>,[<write_thres>,[<max_buffers>]]

Sets several parameters of the SCSI tape driver. <buffer_size> is

the number of 512-byte buffers reserved for tape operations for each

3.5) dmasound=

--------------

Syntax: dmasound=[<buffers>,<buffer-size>[,<catch-radius>]]

:Syntax: dmasound=[<buffers>,<buffer-size>[,<catch-radius>]]

This option controls some configurations of the Linux/m68k DMA sound

driver (Amiga and Atari): <buffers> is the number of buffers you want

4.1) video=

-----------

Syntax: video=<fbname>:<sub-options...>

:Syntax: video=<fbname>:<sub-options...>

The <fbname> parameter specifies the name of the frame buffer,

eg. most atari users will want to specify `atafb' here. The

eg. most atari users will want to specify `atafb` here. The

<sub-options> is a comma-separated list of the sub-options listed

below.

NB: Please notice that this option was renamed from `atavideo' to

    `video' during the development of the 1.3.x kernels, thus you

NB:

    Please notice that this option was renamed from `atavideo` to

    `video` during the development of the 1.3.x kernels, thus you

    might need to update your boot-scripts if upgrading to 2.x from

    an 1.2.x kernel.

NBB: The behavior of video= was changed in 2.1.57 so the recommended

NBB:

    The behavior of video= was changed in 2.1.57 so the recommended

    option is to specify the name of the frame buffer.

4.1.1) Video Mode

4.1.3) font

-----------

Syntax: font:<fontname>

:Syntax: font:<fontname>

Specify the font to use in text modes. Currently you can choose only

between `VGA8x8', `VGA8x16' and `PEARL8x8'. `VGA8x8' is default, if the

between `VGA8x8`, `VGA8x16` and `PEARL8x8`. `VGA8x8` is default, if the

vertical size of the display is less than 400 pixel rows. Otherwise, the

`VGA8x16' font is the default.

`VGA8x16` font is the default.

4.1.4) hwscroll_

----------------

4.1.4) `hwscroll_`

------------------

Syntax: hwscroll_<n>

:Syntax: `hwscroll_<n>`

The number of additional lines of video memory to reserve for

speeding up the scrolling ("hardware scrolling"). Hardware scrolling

4.1.5) internal:

----------------

Syntax: internal:<xres>;<yres>[;<xres_max>;<yres_max>;<offset>]

:Syntax: internal:<xres>;<yres>[;<xres_max>;<yres_max>;<offset>]

This option specifies the capabilities of some extended internal video

hardware, like e.g. OverScan. <xres> and <yres> give the (extended)

4.1.6) external:

----------------

Syntax:

  external:<xres>;<yres>;<depth>;<org>;<scrmem>[;<scrlen>[;<vgabase>\

:Syntax:

  external:<xres>;<yres>;<depth>;<org>;<scrmem>[;<scrlen>[;<vgabase>

  [;<colw>[;<coltype>[;<xres_virtual>]]]]]

[I had to break this line...]

.. I had to break this line...

This is probably the most complicated parameter... It specifies that

you have some external video hardware (a graphics board), and how to

You have to tell the kernel furthermore how the video memory is

organized. This is done by a letter as <org> parameter:

 'n': "normal planes", i.e. one whole plane after another

 'i': "interleaved planes", i.e. 16 bit of the first plane, than 16 bit

 'n':

      "normal planes", i.e. one whole plane after another

 'i':

      "interleaved planes", i.e. 16 bit of the first plane, than 16 bit

      of the next, and so on... This mode is used only with the

      built-in Atari video modes, I think there is no card that

      supports this mode.

 'p': "packed pixels", i.e. <depth> consecutive bits stand for all

 'p':

      "packed pixels", i.e. <depth> consecutive bits stand for all

      planes of one pixel; this is the most common mode for 8 planes

      (256 colors) on graphic cards

 't': "true color" (more or less packed pixels, but without a color

 't':

      "true color" (more or less packed pixels, but without a color

      lookup table); usually depth is 24

For monochrome modes (i.e., <depth> is 1), the <org> letter has a

different meaning:

 'n': normal colors, i.e. 0=white, 1=black

 'i': inverted colors, i.e. 0=black, 1=white

 'n':

      normal colors, i.e. 0=white, 1=black

 'i':

      inverted colors, i.e. 0=black, 1=white

The next important information about the video hardware is the base

address of the video memory. That is given in the <scrmem> parameter,

4.1.8) monitorcap:

-------------------

Syntax: monitorcap:<vmin>;<vmax>;<hmin>;<hmax>

:Syntax: monitorcap:<vmin>;<vmax>;<hmin>;<hmax>

This describes the capabilities of a multisync monitor. Don't use it

with a fixed-frequency monitor! For now, only the Falcon frame buffer

4.2) atamouse=

--------------

Syntax: atamouse=<x-threshold>,[<y-threshold>]

:Syntax: atamouse=<x-threshold>,[<y-threshold>]

With this option, you can set the mouse movement reporting threshold.

This is the number of pixels of mouse movement that have to accumulate

4.3) ataflop=

-------------

Syntax: ataflop=<drive type>[,<trackbuffering>[,<steprateA>[,<steprateB>]]]

:Syntax: ataflop=<drive type>[,<trackbuffering>[,<steprateA>[,<steprateB>]]]

   The drive type may be 0, 1, or 2, for DD, HD, and ED, resp. This

   setting affects how many buffers are reserved and which formats are

4.4) atascsi=

-------------

Syntax: atascsi=<can_queue>[,<cmd_per_lun>[,<scat-gat>[,<host-id>[,<tagged>]]]]

:Syntax: atascsi=<can_queue>[,<cmd_per_lun>[,<scat-gat>[,<host-id>[,<tagged>]]]]

This option sets some parameters for the Atari native SCSI driver.

Generally, any number of arguments can be omitted from the end. And

    The <cmd_per_lun> value at a great part determines the amount of

    memory SCSI reserves for itself. The formula is rather

    complicated, but I can give you some hints:

      no scatter-gather  : cmd_per_lun * 232 bytes

      full scatter-gather: cmd_per_lun * approx. 17 Kbytes

      no scatter-gather:

	cmd_per_lun * 232 bytes

      full scatter-gather:

	cmd_per_lun * approx. 17 Kbytes

  <scat-gat>:

    Size of the scatter-gather table, i.e. the number of requests

4.5 switches=

-------------

Syntax: switches=<list of switches>

:Syntax: switches=<list of switches>

With this option you can switch some hardware lines that are often

used to enable/disable certain hardware extensions. Examples are

The <list of switches> is a comma-separated list of the following

items:

  ikbd: set RTS of the keyboard ACIA high

  midi: set RTS of the MIDI ACIA high

  snd6: set bit 6 of the PSG port A

  snd7: set bit 6 of the PSG port A

  ikbd:

	set RTS of the keyboard ACIA high

  midi:

	set RTS of the MIDI ACIA high

  snd6:

	set bit 6 of the PSG port A

  snd7:

	set bit 6 of the PSG port A

It doesn't make sense to mention a switch more than once (no

difference to only once), but you can give as many switches as you

as possible during kernel initialization (even before determining the

present hardware.)

  All of the items can also be prefixed with "ov_", i.e. "ov_ikbd",

"ov_midi", ... These options are meant for switching on an OverScan

All of the items can also be prefixed with `ov_`, i.e. `ov_ikbd`,

`ov_midi`, ... These options are meant for switching on an OverScan

video extension. The difference to the bare option is that the

switch-on is done after video initialization, and somehow synchronized

to the HBLANK. A speciality is that ov_ikbd and ov_midi are switched

off before rebooting, so that OverScan is disabled and TOS boots

correctly.

  If you give an option both, with and without the "ov_" prefix, the

earlier initialization ("ov_"-less) takes precedence. But the

If you give an option both, with and without the `ov_` prefix, the

earlier initialization (`ov_`-less) takes precedence. But the

switching-off on reset still happens in this case.

5) Options for Amiga Only:

5.1) video=

-----------

Syntax: video=<fbname>:<sub-options...>

:Syntax: video=<fbname>:<sub-options...>

The <fbname> parameter specifies the name of the frame buffer, valid

options are `amifb', `cyber', 'virge', `retz3' and `clgen', provided

options are `amifb`, `cyber`, 'virge', `retz3` and `clgen`, provided

that the respective frame buffer devices have been compiled into the

kernel (or compiled as loadable modules). The behavior of the <fbname>

option was changed in 2.1.57 so it is now recommended to specify this

NTSC modes:

 - ntsc            : 640x200, 15 kHz, 60 Hz

 - ntsc-lace       : 640x400, 15 kHz, 60 Hz interlaced

PAL modes:

 - pal             : 640x256, 15 kHz, 50 Hz

 - pal-lace        : 640x512, 15 kHz, 50 Hz interlaced

ECS modes:

 - multiscan       : 640x480, 29 kHz, 57 Hz

 - multiscan-lace  : 640x960, 29 kHz, 57 Hz interlaced

 - dblpal-lace     : 640x1024, 27 kHz, 47 Hz interlaced

 - dblntsc         : 640x200, 27 kHz, 57 Hz doublescan

 - dblpal          : 640x256, 27 kHz, 47 Hz doublescan

VGA modes:

 - vga             : 640x480, 31 kHz, 60 Hz

 - vga70           : 640x400, 31 kHz, 70 Hz

5.1.2) depth

------------

Syntax: depth:<nr. of bit-planes>

:Syntax: depth:<nr. of bit-planes>

Specify the number of bit-planes for the selected video-mode.

5.1.4) font

-----------

Syntax: font:<fontname>

:Syntax: font:<fontname>

Specify the font to use in text modes. Functionally the same as the

"font" sub-option for the Atari, except that `PEARL8x8' is used instead

of `VGA8x8' if the vertical size of the display is less than 400 pixel

"font" sub-option for the Atari, except that `PEARL8x8` is used instead

of `VGA8x8` if the vertical size of the display is less than 400 pixel

rows.

5.1.5) monitorcap:

-------------------

Syntax: monitorcap:<vmin>;<vmax>;<hmin>;<hmax>

:Syntax: monitorcap:<vmin>;<vmax>;<hmin>;<hmax>

This describes the capabilities of a multisync monitor. For now, only

the color frame buffer uses the settings of "monitorcap:".

5.2) fd_def_df0=

----------------

Syntax: fd_def_df0=<value>

:Syntax: fd_def_df0=<value>

Sets the df0 value for "silent" floppy drives. The value should be in

hexadecimal with "0x" prefix.

5.3) wd33c93=

-------------

Syntax: wd33c93=<sub-options...>

:Syntax: wd33c93=<sub-options...>

These options affect the A590/A2091, A3000 and GVP Series II SCSI

controllers.

5.3.1) nosync

-------------

Syntax: nosync:bitmask

:Syntax: nosync:bitmask

bitmask is a byte where the 1st 7 bits correspond with the 7

possible SCSI devices. Set a bit to prevent sync negotiation on that

5.3.2) period

-------------

Syntax: period:ns

:Syntax: period:ns

  `ns' is the minimum # of nanoseconds in a SCSI data transfer

`ns` is the minimum # of nanoseconds in a SCSI data transfer

period. Default is 500; acceptable values are 250 - 1000.

5.3.3) disconnect

-----------------

Syntax: disconnect:x

:Syntax: disconnect:x

Specify x = 0 to never allow disconnects, 2 to always allow them.

x = 1 does 'adaptive' disconnects, which is the default and generally

5.3.4) debug

------------

Syntax: debug:x

:Syntax: debug:x

  If `DEBUGGING_ON' is defined, x is a bit mask that causes various

If `DEBUGGING_ON` is defined, x is a bit mask that causes various

types of debug output to printed - see the DB_xxx defines in

wd33c93.h.

5.3.5) clock

------------

Syntax: clock:x

:Syntax: clock:x

x = clock input in MHz for WD33c93 chip. Normal values would be from

8 through 20. The default value depends on your hostadapter(s),

5.3.7) nodma

------------

Syntax: nodma:x

:Syntax: nodma:x

If x is 1 (or if the option is just written as "nodma"), the WD33c93

controller will not use DMA (= direct memory access) to access the

5.4) gvp11=

-----------

Syntax: gvp11=<addr-mask>

:Syntax: gvp11=<addr-mask>

The earlier versions of the GVP driver did not handle DMA

address-mask settings correctly which made it necessary for some

32 bit address range for DMA. The correct setting depends on your

controller and should be autodetected by the driver. An example is the

24 bit region which is specified by a mask of 0x00fffffe.

/* Local Variables: */

/* mode: text       */

/* End:             */