Merge branch 'for-linus' of git://git.kernel.dk/data/git/linux-2.6-block

	- this file (info on CD-ROMs and Linux)

Makefile

	- only used to generate TeX output from the documentation.

aztcd

	- info on Aztech/Orchid/Okano/Wearnes/Conrad/CyCDROM driver.

cdrom-standard.tex

	- LaTeX document on standardizing the CD-ROM programming interface.

cdu31a

	- info on the Sony CDU31A/CDU33A CD-ROM driver.

cm206

	- info on the Philips/LMS cm206/cm260 CD-ROM driver.

gscd

	- info on the Goldstar R420 CD-ROM driver.

ide-cd

	- info on setting up and using ATAPI (aka IDE) CD-ROMs.

isp16

	- info on the CD-ROM interface on ISP16, MAD16 or Mozart sound card.

mcd

	- info on limitations of standard Mitsumi CD-ROM driver.

mcdx

	- info on improved Mitsumi CD-ROM driver.

optcd

	- info on the Optics Storage 8000 AT CD-ROM driver

packet-writing.txt

	- Info on the CDRW packet writing module

sbpcd

	- info on the SoundBlaster/Panasonic CD-ROM interface driver.

sjcd

	- info on the SANYO CDR-H94A CD-ROM interface driver.

sonycd535

	- info on the Sony CDU-535 (and 531) CD-ROM driver.

		CDU31A/CDU33A Driver Info

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

Information on the Sony CDU31A/CDU33A CDROM driver for the Linux

kernel.

   Corey Minyard (minyard@metronet.com)

   Colossians 3:17

Crude Table of Contents

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

  Setting Up the Hardware

  Configuring the Kernel

  Configuring as a Module

  Driver Special Features

This device driver handles Sony CDU31A/CDU33A CDROM drives and

provides a complete block-level interface as well as an ioctl()

interface as specified in include/linux/cdrom.h).  With this

interface, CDROMs can be accessed, standard audio CDs can be played

back normally, and CD audio information can be read off the drive.

Note that this will only work for CDU31A/CDU33A drives.  Some vendors

market their drives as CDU31A compatible.  They lie.  Their drives are

really CDU31A hardware interface compatible (they can plug into the

same card).  They are not software compatible.

Setting Up the Hardware

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

The CDU31A driver is unable to safely tell if an interface card is

present that it can use because the interface card does not announce

its presence in any way besides placing 4 I/O locations in memory.  It

used to just probe memory and attempt commands, but Linus wisely asked

me to remove that because it could really screw up other hardware in

the system.

Because of this, you must tell the kernel where the drive interface

is, what interrupts are used, and possibly if you are on a PAS-16

soundcard.

If you have the Sony CDU31A/CDU33A drive interface card, the following

diagram will help you set it up.  If you have another card, you are on

your own.  You need to make sure that the I/O address and interrupt is

not used by another card in the system.  You will need to know the I/O

address and interrupt you have set.  Note that use of interrupts is

highly recommended, if possible, it really cuts down on CPU used.

Unfortunately, most soundcards do not support interrupts for their

CDROM interfaces.  By default, the Sony interface card comes with

interrupts disabled.

        +----------+-----------------+----------------------+

        |  JP1     |  34 Pin Conn    |                      |

        |  JP2     +-----------------+                      |

        |  JP3                                              |

        |  JP4                                              |

        |                                                   +--+

        |                                                   |  +-+

        |                                                   |  | |  External

        |                                                   |  | |  Connector

        |                                                   |  | |

        |                                                   |  +-+

        |                                                   +--+

        |                                                   |

        |                                          +--------+

        |                                          |

        +------------------------------------------+

      JP1 sets the Base Address, using the following settings:

        Address         Pin 1           Pin 2

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

        0x320           Short           Short

        0x330           Short           Open

        0x340           Open            Short

        0x360           Open            Open

      JP2 and JP3 configure the DMA channel; they must be set the same.

        DMA             Pin 1           Pin 2           Pin 3

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

        1               On              Off             On

        2               Off             On              Off

        3               Off             Off             On

      JP4 Configures the IRQ:

        IRQ     Pin 1           Pin 2           Pin 3           Pin 4

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

        3       Off             Off             On              Off

        4       Off             Off*            Off             On

        5       On              Off             Off             Off

        6       Off             On              Off             Off

                  The documentation states to set this for interrupt

                  4, but I think that is a mistake.

Note that if you have another interface card, you will need to look at

the documentation to find the I/O base address.  This is specified to

the SLCD.SYS driver for DOS with the /B: parameter, so you can look at

you DOS driver setup to find the address, if necessary.

Configuring the Kernel

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

You must tell the kernel where the drive is at boot time.  This can be

done at the Linux boot prompt, by using LILO, or by using Bootlin.

Note that this is no substitute for HOWTOs and LILO documentation, if

you are confused please read those for info on bootline configuration

and LILO.

At the linux boot prompt, press the ALT key and add the following line

after the boot name (you can let the kernel boot, it will tell you the

default boot name while booting):

	cdu31a=<base address>,<interrupt>[,PAS]

The base address needs to have "0x" in front of it, since it is in

hex.  For instance, to configure a drive at address 320 on interrupt 5,

use the following:

	cdu31a=0x320,5

I use the following boot line:

	cdu31a=0x1f88,0,PAS

because I have a PAS-16 which does not support interrupt for the

CDU31A interface.

Adding this as an append line at the beginning of the /etc/lilo.conf

file will set it for lilo configurations.  I have the following as the

first line in my lilo.conf file:

	append="cdu31a=0x1f88,0"

I'm not sure how to set up Bootlin (I have never used it), if someone

would like to fill in this section please do.

Configuring as a Module

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

The driver supports loading as a module.  However, you must specify

the boot address and interrupt on the boot line to insmod.  You can't

use modprobe to load it, since modprobe doesn't support setting

variables.

Anyway, I use the following line to load my driver as a module

  /sbin/insmod /lib/modules/`uname -r`/misc/cdu31a.o cdu31a_port=0x1f88

You can set the following variables in the driver:

  cdu31a_port=<I/O address> - sets the base I/O.  If hex, put 0x in

			      front of it.  This must be specified.

  cdu31a_irq=<interrupt> - Sets the interrupt number.  Leaving this

			   off will turn interrupts off.

Driver Special Features

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

This section describes features beyond the normal audio and CD-ROM

functions of the drive.

2048 byte buffer mode

If a disk is mounted with -o block=2048, data is copied straight from

the drive data port to the buffer.  Otherwise, the readahead buffer

must be involved to hold the other 1K of data when a 1K block

operation is done.  Note that with 2048 byte blocks you cannot execute

files from the CD.

XA compatibility

The driver should support XA disks for both the CDU31A and CDU33A.  It

does this transparently, the using program doesn't need to set it.

Multi-Session

A multi-session disk looks just like a normal disk to the user.  Just

mount one normally, and all the data should be there.  A special

thanks to Koen for help with this!

Raw sector I/O

Using the CDROMREADAUDIO it is possible to read raw audio and data

tracks.  Both operations return 2352 bytes per sector.  On the data

tracks, the first 12 bytes is not returned by the drive and the value

of that data is indeterminate.

This is the readme file for the driver for the Philips/LMS cdrom drive

cm206 in combination with the cm260 host adapter card. 

				(c) 1995 David A. van Leeuwen

Changes since version 0.99

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

- Interfacing to the kernel is routed though an extra interface layer, 

  cdrom.c. This allows runtime-configurable `behavior' of the cdrom-drive, 

  independent of the driver. 

Features since version 0.33

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

- Full audio support, that is, both  workman, workbone and cdp work

  now reasonably. Reading TOC still takes some time. xmcd has been

  reported to run successfully. 

- Made auto-probe code a little better, I hope

Features since version 0.28

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

- Full speed transfer rate (300 kB/s).

- Minimum kernel memory usage for buffering (less than 3 kB).

- Multisession support.

- Tray locking.

- Statistics of driver accessible to the user.

- Module support.

- Auto-probing of adapter card's base port and irq line,

  also configurable at boot time or module load time.

Decide how you are going to use the driver. There are two

options:

   (a) installing the driver as a resident part of the kernel

   (b) compiling the driver as a loadable module

   Further, you must decide if you are going to specify the base port

   address and the interrupt request line of the adapter card cm260 as

   boot options for (a), module parameters for (b), use automatic

   probing of these values, or hard-wire your adaptor card's settings

   into the source code. If you don't care, you can choose 

   autoprobing, which is the default. In that case you can move on to

   the next step.

Compiling the kernel

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

1) move to /usr/src/linux and do a 

	make config

   If you have chosen option (a), answer yes to CONFIG_CM206 and

   CONFIG_ISO9660_FS.

   If you have chosen option (b), answer yes to CONFIG_MODVERSIONS

   and no (!) to CONFIG_CM206 and CONFIG_ISO9660_FS. 

2) then do a 

	make clean; make zImage; make modules

3) do the usual things to install a new image (backup the old one, run

   `rdev -R zImage 1', copy the new image in place, run lilo).  Might

   be `make zlilo'.

Using the driver as a module

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

If you will only occasionally use the cd-rom driver, you can choose

option (b), install as a loadable module. You may have to re-compile

the module when you upgrade the kernel to a new version. 

Since version 0.96, much of the functionality has been transferred to

a generic cdrom interface in the file cdrom.c. The module cm206.o

depends on cdrom.o. If the latter is not compiled into the kernel,

you must explicitly load it before cm206.o:

	 insmod /usr/src/linux/modules/cdrom.o

To install the module, you use the command, as root

	insmod /usr/src/linux/modules/cm206.o

You can specify the base address on the command line as well as the irq 

line to be used, e.g.

	insmod /usr/src/linux/modules/cm206.o cm206=0x300,11

The order of base port and irq line doesn't matter; if you specify only

one, the other will have the value of the compiled-in default.  You

may also have to install the file-system module `iso9660.o', if you

didn't compile that into the kernel. 

Using the driver as part of the kernel

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

If you have chosen option (a), you can specify the base-port

address and irq on the lilo boot command line, e.g.:

	LILO: linux cm206=0x340,11

This assumes that your linux kernel image keyword is `linux'. 

If you specify either IRQ (3--11) or base port (0x300--0x370),

auto probing is turned off for both settings, thus setting the 

other value to the compiled-in default.

Note that you can also put these parameters in the lilo configuration file:

# linux config

image = /vmlinuz

   root = /dev/hda1

   label = Linux

   append = "cm206=0x340,11"

   read-only

If module parameters and LILO config options don't work

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

If autoprobing does not work, you can hard-wire the default values

of the base port address (CM206_BASE) and interrupt request line

(CM206_IRQ) into the file /usr/src/linux/drivers/cdrom/cm206.h. Change

the defines of CM206_IRQ and CM206_BASE.

Mounting the cdrom

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

1) Make sure that the right device is installed in /dev.

  	mknod /dev/cm206cd b 32 0

2) Make sure there is a mount point, e.g., /cdrom 

	mkdir /cdrom

3) mount using a command like this (run as root):

	mount -rt iso9660 /dev/cm206cd /cdrom

4) For user-mounts, add a line in /etc/fstab

	/dev/cm206cd      /cdrom     iso9660 	ro,noauto,user

   This will allow users to give the commands

	mount /cdrom

	umount /cdrom

If things don't work

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

- Try to do a `dmesg' to find out if the driver said anything about

  what is going wrong during the initialization.

- Try to do a `dd if=/dev/cm206cd | od -tc | less' to read from the

  CD.

- Look in the /proc directory to see if `cm206' shows up under one of

  `interrupts', `ioports', `devices' or `modules' (if applicable).

DISCLAIMER 

---------- 

I cannot guarantee that this driver works, or that the hardware will

not be harmed, although I consider it most unlikely. 

I hope that you'll find this driver in some way useful. 

					David van Leeuwen

					david@tm.tno.nl

Note for Linux CDROM vendors

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

You are encouraged to include this driver on your Linux CDROM. If

you do, you might consider sending me a free copy of that cd-rom.

You can contact me through my e-mail address, david@tm.tno.nl. 

If this driver is compiled into a kernel to boot off a cdrom, 

you should actually send me a free copy of that cd-rom. 

Copyright

---------

The copyright of the cm206 driver for Linux is 

    (c) 1995 David A. van Leeuwen

The driver is released under the conditions of the GNU general public

license, which can be found in the file COPYING in the root of this

source tree.

	Goldstar R420 CD-Rom device driver README

For all kind of other information about the GoldStar R420 CDROM

and this Linux device driver see the WWW page:

        http://linux.rz.fh-hannover.de/~raupach        

      If you are the editor of a Linux CD, you should

      enable gscd.c within your boot floppy kernel. Please,

      send me one of your CDs for free.

This current driver version 0.4a only supports reading data from the disk.

Currently we have no audio and no multisession or XA support.

The polling interface is used, no DMA.

Sometimes the GoldStar R420 is sold in a 'Reveal Multimedia Kit'. This kit's

drive interface is compatible, too.

Installation

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

Change to '/usr/src/linux/drivers/cdrom' and edit the file 'gscd.h'. Insert

the i/o address of your interface card.

The default base address is 0x340. This will work for most applications. 

Address selection is accomplished by jumpers PN801-1 to PN801-4 on the 

GoldStar Interface Card.

Appropriate settings are: 0x300, 0x310, 0x320, 0x330, 0x340, 0x350, 0x360

0x370, 0x380, 0x390, 0x3A0, 0x3B0, 0x3C0, 0x3D0, 0x3E0, 0x3F0             

Then go back to '/usr/src/linux/' and 'make config' to build the new

configuration for your kernel. If you want to use the GoldStar driver

like a module, don't select 'GoldStar CDROM support'. By the way, you

have to include the iso9660 filesystem.

Now start compiling the kernel with 'make zImage'.

If you want to use the driver as a module, you have to do 'make modules' 

and 'make modules_install', additionally.

Install your new kernel as usual - maybe you do it with 'make zlilo'.

Before you can use the driver, you have to

   mknod /dev/gscd0 b 16 0

to create the appropriate device file (you only need to do this once).

If you use modules, you can try to insert the driver.

Say: 'insmod /usr/src/linux/modules/gscd.o'

or:  'insmod /usr/src/linux/modules/gscd.o gscd=<address>'

The driver should report its results.

That's it! Mount a disk, i.e. 'mount -rt iso9660 /dev/gscd0 /cdrom'

Feel free to report errors and suggestions to the following address.

Be sure, I'm very happy to receive your comments!

        Oliver Raupach                                Hannover, Juni 1995

(raupach@nwfs1.rz.fh-hannover.de)