Subversion Repositories or1k

/*

        linux/kernel/blk_drv/mcd.c - Mitsumi CDROM driver

        Copyright (C) 1992  Martin Harriss

        martin@bdsi.com (no longer valid - where are you now, Martin?)

        This program is free software; you can redistribute it and/or modify

        it under the terms of the GNU General Public License as published by

        the Free Software Foundation; either version 2, or (at your option)

        any later version.

        This program is distributed in the hope that it will be useful,

        but WITHOUT ANY WARRANTY; without even the implied warranty of

        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

        GNU General Public License for more details.

        You should have received a copy of the GNU General Public License

        along with this program; if not, write to the Free Software

        Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

        HISTORY

        0.1     First attempt - internal use only

        0.2     Cleaned up delays and use of timer - alpha release

        0.3     Audio support added

        0.3.1 Changes for mitsumi CRMC LU005S march version

                   (stud11@cc4.kuleuven.ac.be)

        0.3.2 bug fixes to the ioctls and merged with ALPHA0.99-pl12

                   (Jon Tombs <jon@robots.ox.ac.uk>)

        0.3.3 Added more #defines and mcd_setup()

                   (Jon Tombs <jon@gtex02.us.es>)

        October 1993 Bernd Huebner and Ruediger Helsch, Unifix Software GmbH,

        Braunschweig, Germany: rework to speed up data read operation.

        Also enabled definition of irq and address from bootstrap, using the

        environment.

        November 93 added code for FX001 S,D (single & double speed).

        February 94 added code for broken M 5/6 series of 16-bit single speed.

        0.4

        Added support for loadable MODULEs, so mcd can now also be loaded by

        insmod and removed by rmmod during runtime.

        Werner Zimmermann (zimmerma@rz.fht-esslingen.de), Mar. 26, 95

        0.5

        I added code for FX001 D to drop from double speed to single speed

        when encountering errors... this helps with some "problematic" CD's

        that are supposedly "OUT OF TOLERANCE" (but are really shitty presses!)

        severely scratched, or possibly slightly warped! I have noticed that

        the Mitsumi 2x/4x drives are just less tolerant and the firmware is

        not smart enough to drop speed, so let's just kludge it with software!

        ****** THE 4X SPEED MITSUMI DRIVES HAVE THE SAME PROBLEM!!!!!! ******

        Anyone want to "DONATE" one to me?! ;) I hear sometimes they are

        even WORSE! ;)

        ** HINT... HINT... TAKE NOTES MITSUMI This could save some hassles with

        certain "large" CD's that have data on the outside edge in your

        DOS DRIVERS .... Accuracy counts... speed is secondary ;)

        17 June 95 Modifications By Andrew J. Kroll <ag784@freenet.buffalo.edu>

        07 July 1995 Modifications by Andrew J. Kroll

        Bjorn Ekwall <bj0rn@blox.se> added unregister_blkdev to mcd_init()

        Michael K. Johnson <johnsonm@redhat.com> added retries on open

        for slow drives which take a while to recognize that they contain

        a CD.

*/

#include <linux/module.h>

#include <linux/errno.h>

#include <linux/signal.h>

#include <linux/sched.h>

#include <linux/mm.h>

#include <linux/timer.h>

#include <linux/fs.h>

#include <linux/kernel.h>

#include <linux/cdrom.h>

#include <linux/ioport.h>

#include <linux/string.h>

#include <linux/delay.h>

/* #define REALLY_SLOW_IO  */

#include <asm/system.h>

#include <asm/io.h>

#include <asm/segment.h>

#define MAJOR_NR MITSUMI_CDROM_MAJOR

#include <linux/blk.h>

#define mcd_port mcd    /* for compatible parameter passing with "insmod" */

#include <linux/mcd.h>

#if 0

static int mcd_sizes[] = { 0 };

#endif

static int mcd_blocksizes[1] = { 0, };

/* I know putting defines in this file is probably stupid, but it should be */

/* the only place that they are really needed... I HOPE! :) */

/* How many sectors to read at 1x when an error at 2x speed occurs. */

/* You can change this to anything from 2 to 32767, but 30 seems to */

/* work best for me.  I have found that when the drive has problems */

/* reading one sector, it will have troubles reading the next few.  */

#define SINGLE_HOLD_SECTORS 30  

#define MCMD_2X_READ 0xC1       /* Double Speed Read DON'T TOUCH! */

/* I added A flag to drop to 1x speed if too many errors 0 = 1X ; 1 = 2X */

static int mcdDouble = 0;

/* How many sectors to hold at 1x speed counter */

static int mcd1xhold = 0;

/* Is the drive connected properly and responding?? */

static int mcdPresent = 0;

#if 0

#define TEST1 /* <int-..> */

#define TEST2 /* do_mcd_req */

#define TEST3 */ /* MCD_S_state */

#define TEST4 /* QUICK_LOOP-counter */

#define TEST5 */ /* port(1) state */

#endif

#if 1

#define QUICK_LOOP_DELAY udelay(45)  /* use udelay */

#define QUICK_LOOP_COUNT 20

#else

#define QUICK_LOOP_DELAY

#define QUICK_LOOP_COUNT 140 /* better wait constant time */

#endif

/* #define DOUBLE_QUICK_ONLY */

#define CURRENT_VALID \

(CURRENT && MAJOR(CURRENT -> rq_dev) == MAJOR_NR && CURRENT -> cmd == READ \

&& CURRENT -> sector != -1)

#define MFL_STATUSorDATA (MFL_STATUS | MFL_DATA)

#define MCD_BUF_SIZ 16

static volatile int mcd_transfer_is_active;

static char mcd_buf[2048*MCD_BUF_SIZ];  /* buffer for block size conversion */

static volatile int mcd_buf_bn[MCD_BUF_SIZ], mcd_next_bn;

static volatile int mcd_buf_in, mcd_buf_out = -1;

static volatile int mcd_error;

static int mcd_open_count;

enum mcd_state_e {

  MCD_S_IDLE,   /* 0 */

  MCD_S_START,  /* 1 */

  MCD_S_MODE, /* 2 */

  MCD_S_READ,   /* 3 */

  MCD_S_DATA,   /* 4 */

  MCD_S_STOP,   /* 5 */

  MCD_S_STOPPING /* 6 */

};

static volatile enum mcd_state_e mcd_state = MCD_S_IDLE;

static int mcd_mode = -1;

static int MCMD_DATA_READ= MCMD_PLAY_READ;

#define READ_TIMEOUT 3000

#define WORK_AROUND_MITSUMI_BUG_92

#define WORK_AROUND_MITSUMI_BUG_93

#ifdef WORK_AROUND_MITSUMI_BUG_93

int mitsumi_bug_93_wait = 0;

#endif /* WORK_AROUND_MITSUMI_BUG_93 */

static short mcd_port = MCD_BASE_ADDR; /* used as "mcd" by "insmod" */

static int   mcd_irq  = MCD_INTR_NR; /* must directly follow mcd_port */

static int McdTimeout, McdTries;

static struct wait_queue *mcd_waitq = NULL;

static struct mcd_DiskInfo DiskInfo;

static struct mcd_Toc Toc[MAX_TRACKS];

static struct mcd_Play_msf mcd_Play;

static int audioStatus;

static char mcdDiskChanged;

static char tocUpToDate;

static char mcdVersion;

static void mcd_transfer(void);

static void mcd_poll(void);

static void mcd_invalidate_buffers(void);

static void hsg2msf(long hsg, struct msf *msf);

static void bin2bcd(unsigned char *p);

static int bcd2bin(unsigned char bcd);

static int mcdStatus(void);

static void sendMcdCmd(int cmd, struct mcd_Play_msf *params);

static int getMcdStatus(int timeout);

static int GetQChannelInfo(struct mcd_Toc *qp);

static int updateToc(void);

static int GetDiskInfo(void);

static int GetToc(void);

static int getValue(unsigned char *result);

void mcd_setup(char *str, int *ints)

{

   if (ints[0] > 0)

      mcd_port = ints[1];

   if (ints[0] > 1)

      mcd_irq  = ints[2];

#ifdef WORK_AROUND_MITSUMI_BUG_93

   if (ints[0] > 2)

      mitsumi_bug_93_wait = ints[3];

#endif /* WORK_AROUND_MITSUMI_BUG_93 */

}

static int

check_mcd_change(kdev_t full_dev)

{

   int retval, target;

#if 1    /* the below is not reliable */

   return 0;

#endif  

   target = MINOR(full_dev);

   if (target > 0) {

      printk("mcd: Mitsumi CD-ROM request error: invalid device.\n");

      return 0;

   }

   retval = mcdDiskChanged;

   mcdDiskChanged = 0;

   return retval;

}

/*

 * Do a 'get status' command and get the result.  Only use from the top half

 * because it calls 'getMcdStatus' which sleeps.

 */

static int

statusCmd(void)

{

        int st, retry;

        for (retry = 0; retry < MCD_RETRY_ATTEMPTS; retry++)

        {

                outb(MCMD_GET_STATUS, MCDPORT(0));       /* send get-status cmd */

                st = getMcdStatus(MCD_STATUS_DELAY);

                if (st != -1)

                        break;

        }

        return st;

}

/*

 * Send a 'Play' command and get the status.  Use only from the top half.

 */

static int

mcdPlay(struct mcd_Play_msf *arg)

{

        int retry, st;

        for (retry = 0; retry < MCD_RETRY_ATTEMPTS; retry++)

        {

                sendMcdCmd(MCMD_PLAY_READ, arg);

                st = getMcdStatus(2 * MCD_STATUS_DELAY);

                if (st != -1)

                        break;

        }

        return st;

}

long

msf2hsg(struct msf *mp)

{

        return bcd2bin(mp -> frame)

                + bcd2bin(mp -> sec) * 75

                + bcd2bin(mp -> min) * 4500

                - 150;

}

static int

mcd_ioctl(struct inode *ip, struct file *fp, unsigned int cmd,

                                                unsigned long arg)

{

        int i, st;

        struct mcd_Toc qInfo;

        struct cdrom_ti ti;

        struct cdrom_tochdr tocHdr;

        struct cdrom_msf msf;

        struct cdrom_tocentry entry;

        struct mcd_Toc *tocPtr;

        struct cdrom_subchnl subchnl;

        struct cdrom_volctrl volctrl;

        if (!ip)

                return -EINVAL;

        st = statusCmd();

        if (st < 0)

                return -EIO;

        if (!tocUpToDate)

        {

                i = updateToc();

                if (i < 0)

                        /* Hermann.Lauer@IWR.Uni-Heidelberg.De:

                        We _can_ open the door even without a CD */

                        if (cmd != CDROMEJECT)

                                return i;       /* error reading TOC */

        }

        switch (cmd)

        {

        case CDROMSTART:     /* Spin up the drive */

                /* Don't think we can do this.  Even if we could,

                 * I think the drive times out and stops after a while

                 * anyway.  For now, ignore it.

                 */

                return 0;

        case CDROMSTOP:      /* Spin down the drive */

                outb(MCMD_STOP, MCDPORT(0));

                i = getMcdStatus(MCD_STATUS_DELAY);

                /* should we do anything if it fails? */

                audioStatus = CDROM_AUDIO_NO_STATUS;

                return 0;

        case CDROMPAUSE:     /* Pause the drive */

                if (audioStatus != CDROM_AUDIO_PLAY)

                        return -EINVAL;

                outb(MCMD_STOP, MCDPORT(0));

                i = getMcdStatus(MCD_STATUS_DELAY);

                if (GetQChannelInfo(&qInfo) < 0)

                {

                        /* didn't get q channel info */

                        audioStatus = CDROM_AUDIO_NO_STATUS;

                        return 0;

                }

                mcd_Play.start = qInfo.diskTime;        /* remember restart point */

                audioStatus = CDROM_AUDIO_PAUSED;

                return 0;

        case CDROMRESUME:    /* Play it again, Sam */

                if (audioStatus != CDROM_AUDIO_PAUSED)

                        return -EINVAL;

                /* restart the drive at the saved position. */

                i = mcdPlay(&mcd_Play);

                if (i < 0)

                {

                        audioStatus = CDROM_AUDIO_ERROR;

                        return -EIO;

                }

                audioStatus = CDROM_AUDIO_PLAY;

                return 0;

        case CDROMPLAYTRKIND:     /* Play a track.  This currently ignores index. */

                st = verify_area(VERIFY_READ, (void *) arg, sizeof ti);

                if (st)

                        return st;

                memcpy_fromfs(&ti, (void *) arg, sizeof ti);

                if (ti.cdti_trk0 < DiskInfo.first

                        || ti.cdti_trk0 > DiskInfo.last

                        || ti.cdti_trk1 < ti.cdti_trk0)

                {

                        return -EINVAL;

                }

                if (ti.cdti_trk1 > DiskInfo.last)

                        ti. cdti_trk1 = DiskInfo.last;

                mcd_Play.start = Toc[ti.cdti_trk0].diskTime;

                mcd_Play.end = Toc[ti.cdti_trk1 + 1].diskTime;

#ifdef MCD_DEBUG

printk("play: %02x:%02x.%02x to %02x:%02x.%02x\n",

        mcd_Play.start.min, mcd_Play.start.sec, mcd_Play.start.frame,

        mcd_Play.end.min, mcd_Play.end.sec, mcd_Play.end.frame);

#endif

                i = mcdPlay(&mcd_Play);

                if (i < 0)

                {

                        audioStatus = CDROM_AUDIO_ERROR;

                        return -EIO;

                }

                audioStatus = CDROM_AUDIO_PLAY;

                return 0;

        case CDROMPLAYMSF:   /* Play starting at the given MSF address. */

                if (audioStatus == CDROM_AUDIO_PLAY) {

                  outb(MCMD_STOP, MCDPORT(0));

                  i = getMcdStatus(MCD_STATUS_DELAY);

                  audioStatus = CDROM_AUDIO_NO_STATUS;

                }

                st = verify_area(VERIFY_READ, (void *) arg, sizeof msf);

                if (st)

                        return st;

                memcpy_fromfs(&msf, (void *) arg, sizeof msf);

                /* convert to bcd */

                bin2bcd(&msf.cdmsf_min0);

                bin2bcd(&msf.cdmsf_sec0);

                bin2bcd(&msf.cdmsf_frame0);

                bin2bcd(&msf.cdmsf_min1);

                bin2bcd(&msf.cdmsf_sec1);

                bin2bcd(&msf.cdmsf_frame1);

                mcd_Play.start.min = msf.cdmsf_min0;

                mcd_Play.start.sec = msf.cdmsf_sec0;

                mcd_Play.start.frame = msf.cdmsf_frame0;

                mcd_Play.end.min = msf.cdmsf_min1;

                mcd_Play.end.sec = msf.cdmsf_sec1;

                mcd_Play.end.frame = msf.cdmsf_frame1;

#ifdef MCD_DEBUG

printk("play: %02x:%02x.%02x to %02x:%02x.%02x\n",

mcd_Play.start.min, mcd_Play.start.sec, mcd_Play.start.frame,

mcd_Play.end.min, mcd_Play.end.sec, mcd_Play.end.frame);

#endif

                i = mcdPlay(&mcd_Play);

                if (i < 0)

                {

                        audioStatus = CDROM_AUDIO_ERROR;

                        return -EIO;

                }

                audioStatus = CDROM_AUDIO_PLAY;

                return 0;

        case CDROMREADTOCHDR:        /* Read the table of contents header */

                st = verify_area(VERIFY_WRITE, (void *) arg, sizeof tocHdr);

                if (st)

                        return st;

                tocHdr.cdth_trk0 = DiskInfo.first;

                tocHdr.cdth_trk1 = DiskInfo.last;

                memcpy_tofs((void *) arg, &tocHdr, sizeof tocHdr);

                return 0;

        case CDROMREADTOCENTRY:      /* Read an entry in the table of contents */

                st = verify_area(VERIFY_WRITE, (void *) arg, sizeof entry);

                if (st)

                        return st;

                memcpy_fromfs(&entry, (void *) arg, sizeof entry);

                if (entry.cdte_track == CDROM_LEADOUT)

                        /* XXX */

                        tocPtr = &Toc[DiskInfo.last + 1];

                else if (entry.cdte_track > DiskInfo.last

                                || entry.cdte_track < DiskInfo.first)

                        return -EINVAL;

                else

                        tocPtr = &Toc[entry.cdte_track];

                entry.cdte_adr = tocPtr -> ctrl_addr;

                entry.cdte_ctrl = tocPtr -> ctrl_addr >> 4;

                if (entry.cdte_format == CDROM_LBA)

                        entry.cdte_addr.lba = msf2hsg(&tocPtr -> diskTime);

                else if (entry.cdte_format == CDROM_MSF)

                {

                        entry.cdte_addr.msf.minute = bcd2bin(tocPtr -> diskTime.min);

                        entry.cdte_addr.msf.second = bcd2bin(tocPtr -> diskTime.sec);

                        entry.cdte_addr.msf.frame = bcd2bin(tocPtr -> diskTime.frame);

                }

                else

                        return -EINVAL;

                memcpy_tofs((void *) arg, &entry, sizeof entry);

                return 0;

        case CDROMSUBCHNL:   /* Get subchannel info */

                st = verify_area(VERIFY_WRITE, (void *) arg, sizeof subchnl);

                if (st)

                        return st;

                memcpy_fromfs(&subchnl, (void *) arg, sizeof subchnl);

                if (GetQChannelInfo(&qInfo) < 0)

                        return -EIO;

                subchnl.cdsc_audiostatus = audioStatus;

                subchnl.cdsc_adr = qInfo.ctrl_addr;

                subchnl.cdsc_ctrl = qInfo.ctrl_addr >> 4;

                subchnl.cdsc_trk = bcd2bin(qInfo.track);

                subchnl.cdsc_ind = bcd2bin(qInfo.pointIndex);

                if (subchnl.cdsc_format == CDROM_LBA)

                {

                        subchnl.cdsc_absaddr.lba = msf2hsg(&qInfo.diskTime);

                        subchnl.cdsc_reladdr.lba = msf2hsg(&qInfo.trackTime);

                }

                else if (subchnl.cdsc_format == CDROM_MSF)

                {

                        subchnl.cdsc_absaddr.msf.minute = bcd2bin(qInfo.diskTime.min);

                        subchnl.cdsc_absaddr.msf.second = bcd2bin(qInfo.diskTime.sec);

                        subchnl.cdsc_absaddr.msf.frame = bcd2bin(qInfo.diskTime.frame);

                        subchnl.cdsc_reladdr.msf.minute = bcd2bin(qInfo.trackTime.min);

                        subchnl.cdsc_reladdr.msf.second = bcd2bin(qInfo.trackTime.sec);

                        subchnl.cdsc_reladdr.msf.frame = bcd2bin(qInfo.trackTime.frame);

                }

                else

                        return -EINVAL;

                memcpy_tofs((void *) arg, &subchnl, sizeof subchnl);

                return 0;

        case CDROMVOLCTRL:   /* Volume control */

                st = verify_area(VERIFY_READ, (void *) arg, sizeof(volctrl));

                if (st)

                        return st;

                memcpy_fromfs(&volctrl, (char *) arg, sizeof(volctrl));

                outb(MCMD_SET_VOLUME, MCDPORT(0));

                outb(volctrl.channel0, MCDPORT(0));

                outb(255, MCDPORT(0));

                outb(volctrl.channel1, MCDPORT(0));

                outb(255, MCDPORT(0));

                i = getMcdStatus(MCD_STATUS_DELAY);

                if (i < 0)

                        return -EIO;

                {

                        char a, b, c, d;

                        getValue(&a);

                        getValue(&b);

                        getValue(&c);

                        getValue(&d);

                }

                return 0;

        case CDROMEJECT:

               /* all drives can at least stop! */

                if (audioStatus == CDROM_AUDIO_PLAY) {

                  outb(MCMD_STOP, MCDPORT(0));

                  i = getMcdStatus(MCD_STATUS_DELAY);

                }

                audioStatus = CDROM_AUDIO_NO_STATUS;

                outb(MCMD_EJECT, MCDPORT(0));

                /*

                 * the status (i) shows failure on all but the FX drives.

                 * But nothing we can do about that in software!

                 * So just read the status and forget it. - Jon.

                 */

                i = getMcdStatus(MCD_STATUS_DELAY);

                return 0;

        default:

                return -EINVAL;

        }

}

/*

 * Take care of the different block sizes between cdrom and Linux.

 * When Linux gets variable block sizes this will probably go away.

 */

static void

mcd_transfer(void)

{

  if (CURRENT_VALID) {

    while (CURRENT -> nr_sectors) {

      int bn = CURRENT -> sector / 4;

      int i;

      for (i = 0; i < MCD_BUF_SIZ && mcd_buf_bn[i] != bn; ++i)

        ;

      if (i < MCD_BUF_SIZ) {

        int offs = (i * 4 + (CURRENT -> sector & 3)) * 512;

        int nr_sectors = 4 - (CURRENT -> sector & 3);

        if (mcd_buf_out != i) {

          mcd_buf_out = i;

          if (mcd_buf_bn[i] != bn) {

            mcd_buf_out = -1;

            continue;

          }

        }

        if (nr_sectors > CURRENT -> nr_sectors)

          nr_sectors = CURRENT -> nr_sectors;

        memcpy(CURRENT -> buffer, mcd_buf + offs, nr_sectors * 512);

        CURRENT -> nr_sectors -= nr_sectors;

        CURRENT -> sector += nr_sectors;

        CURRENT -> buffer += nr_sectors * 512;

      } else {

        mcd_buf_out = -1;

        break;

      }

    }

  }

}

/*

 * We only seem to get interrupts after an error.

 * Just take the interrupt and clear out the status reg.

 */

static void

mcd_interrupt(int irq, void *dev_id, struct pt_regs * regs)

{

        int st;

        st = inb(MCDPORT(1)) & 0xFF;

#ifdef TEST1

                printk("<int1-%02X>", st);

#endif

        if (!(st & MFL_STATUS))

        {

                st = inb(MCDPORT(0)) & 0xFF;

#ifdef TEST1

                printk("<int0-%02X>", st);

#endif

                if ((st & 0xFF) != 0xFF)

                  mcd_error = st ? st & 0xFF : -1;

        }

}

static void

do_mcd_request(void)

{

#ifdef TEST2

  printk(" do_mcd_request(%ld+%ld)\n", CURRENT -> sector, CURRENT -> nr_sectors);

#endif

  mcd_transfer_is_active = 1;

  while (CURRENT_VALID) {

    if (CURRENT->bh) {

      if (!buffer_locked(CURRENT->bh))

        panic(DEVICE_NAME ": block not locked");

    }

    mcd_transfer();

    if (CURRENT -> nr_sectors == 0) {

      end_request(1);

    } else {

      mcd_buf_out = -1;         /* Want to read a block not in buffer */

      if (mcd_state == MCD_S_IDLE) {

        if (!tocUpToDate) {

          if (updateToc() < 0) {

            while (CURRENT_VALID)

              end_request(0);

            break;

          }

        }