includes: AROS_UFIxx -> AROS_INTxx change

[AROS.git] / rom / filesys / CDVDFS / src / cdrom.c

/* cdrom.c:
 *
 * Basic interaction with the CDROM drive.
 *
 * ----------------------------------------------------------------------
 * This code is (C) Copyright 1993,1994 by Frank Munkert.
 *              (C) Copyright 2002-2011 The AROS Development Team
 * All rights reserved.
 * This software may be freely distributed and redistributed for
 * non-commercial purposes, provided this notice is included.
 * ----------------------------------------------------------------------
 * History:
 *
 * 18-Dec-11 twilen  Added media change interrupt support.
 * 11-Aug-10 sonic   Fixed comparison warning in Has_Audio_Tracks()
 * 01-Mar-10 neil    Do not read past end of disc.
 * 12-Jun-09 neil    If drive returns incorrect TOC length, calculate it
 *                   based on the number of tracks.
 * 09-May-09 weissms   - Let Do_SCSI_Command result depend on DoIO result.
 *                     - Removed redundant checks of io_Error, some code reuse
 *                       (Clear_Sector_Buffers).
 * 20-Mar-09 sonic     - Removed usage of AROS-specific include
 * 08-Mar-09 error     - Corrected Test_Unit_Ready returning only NO_DISC state
 * 06-Mar-09 error     - Removed madness, fixed insanity. Cleanup started
 * 06-Jun-08 sonic     - Fixed to compile with gcc v2
 * 30-Mar-08 error     - Updated 'Find_Last_Session' with a generic command
 *                       mandatory for all MMC devices; corrected major flaw
 *                       with uninitialized variables
 * 12-Aug-07 sonic     - Added some debug output.
 * 09-Apr-07 sonic     - Disabled DirectSCSI on AROS.
 * 08-Apr-07 sonic     - Removed redundant TRACKDISK option.
 *                     - Added trackdisk64 support.
 *                     - Removed unneeded dealing with block length.
 * 07-Jul-02 sheutlin  various changes when porting to AROS
 *                     - global variables are now in a struct Globals *global
 * 02-Sep-94   fmu   Display READ TOC for Apple CD 150 drives.
 * 01-Sep-94   fmu   Workaround for bad NEC 3X READ TOC command in
 *                   Has_Audio_Tracks() and Data_Tracks().
 * 20-Aug-94   fmu   New function Find_Last_Session ().
 * 23-Jul-94   fmu   Last index modified from 99 to 1 in Start_Play_Audio().
 * 18-May-94   fmu   New drive model: MODEL_CDU_8002 (= Apple CD 150).
 * 17-May-94   fmu   Sense length 20 instead of 18 (needed by ALF controller).
 * 17-Feb-94   fmu   Added support for Toshiba 4101.
 * 06-Feb-94   dmb   - Fixed bug in Test_Unit_Ready() trackdisk support.
 *                   - Fixed bug in Open_CDROM (size of request)
 *                   - Added function Clear_Sector_Buffers().
 * 01-Jan-94   fmu   Added function Data_Tracks() for multisession support.
 * 11-Dec-93   fmu   - Memory type can now be chosen by the user.
 *                   - Addional parameter p_direction for Do_SCSI_Command().
 *                   - Start_Play_Audio() now plays all tracks.
 *                   - Mode_Select() instead of Select_XA_Mode().
 *                   - Support for CDROM drives with 512, 1024 or 2048 bytes
 *                     per block.
 * 06-Dec-93   fmu   New drive type DRIVE_SCSI_2.
 * 09-Nov-93   fmu   Added Select_XA_Mode.
 * 23-Oct-93   fmu   Open_CDROM now returns an error code that tell what
 *                   went wrong.
 * 09-Oct-93   fmu   SAS/C support added.
 * 03-Oct-93   fmu   New buffering algorithm.
 * 27-Sep-93   fmu   Added support for multi-LUN devices.
 * 24-Sep-93   fmu   - SCSI buffers may now reside in fast or chip memory.
 *                   - TD_CHANGESTATE instead of CMD_READ in Test_Unit_Ready
 */

#include <proto/alib.h>
#include <proto/exec.h>
#include <devices/trackdisk.h>

#ifndef TD_READ64
#include <devices/newstyle.h>
#define TD_READ64 NSCMD_TD_READ64
#endif

#include <limits.h>
#include <string.h>
#include <stdio.h>

#include "cdrom.h"
#include "debug.h"
#include "globals.h"

#include "clib_stuff.h"
#include <exec/interrupts.h>

AROS_INTH1(CDChangeHandler, struct CDVDBase *, global)
{ 
    AROS_INTFUNC_INIT

    Signal(&global->DosProc->pr_Task, global->g_changeint_sigbit);
    return 0;

    AROS_INTFUNC_EXIT
}

/*
 * i decided to change few things to make this code less insane.
 * biggest change is - i don't care any more if anyone reads one sector at a time
 * reading disc 1 sector at a time is totally insane.
 * presently our schema will read 16 sectors instead, that is, 32768bytes at a time
 * that should give us SIGNIFICANT speed improvement. unfortunately has some impact
 * on a cache, too, but that will change over time. currently, cache will eat
 * STD_BUFFERS * 16 * 2048 bytes
 */

CDROM *Open_CDROM
        (
                struct CDVDBase *global,
                char *p_device,
                int p_scsi_id,
                uint32_t p_memory_type,
                int p_std_buffers,
                int p_file_buffers
        )
{
    CDROM *cd;
    int i;
    int err = CDROMERR_OK;

    /*
     * fake try-catch
     */
    do
    {
        err = CDROMERR_NO_MEMORY;
        cd = AllocVec (sizeof (CDROM), MEMF_PUBLIC | MEMF_CLEAR | p_memory_type);

        if (NULL == cd)
            break;

        cd->global = global;
        cd->buffers_cnt  = p_std_buffers;

        /*
         * change: allocating 16 * SCSI_BUFSIZE * bufs; min access unit 32kB!
         */
        cd->buffer_data  = AllocVec (((SCSI_BUFSIZE * p_std_buffers) << 4) + 15, MEMF_PUBLIC | p_memory_type);
        if (NULL == cd->buffer_data)
            break;
        
        cd->buffer_io = AllocVec(SCSI_BUFSIZE, p_memory_type);
        if (NULL == cd->buffer_io)
            break;

        cd->buffers = AllocVec (sizeof (unsigned char *) * p_std_buffers, MEMF_PUBLIC);
        if (NULL == cd->buffers)
            break;

        cd->current_sectors = AllocVec (sizeof (long) * p_std_buffers, MEMF_PUBLIC);
        if (NULL == cd->current_sectors)
            break;

        cd->last_used = AllocVec (sizeof (uint32_t) * p_std_buffers, MEMF_PUBLIC | MEMF_CLEAR);
        if (NULL == cd->last_used)
            break;


        /* 
         * make the buffer quad-word aligned. This greatly helps
         * performance on '040-powered systems with DMA SCSI
         * controllers.
         */
        cd->buffers[0] = (UBYTE *)(((IPTR)cd->buffer_data + 15) & ~15);
        cd->current_sectors[0] = -1;

        for (i=1; i<cd->buffers_cnt; i++)
        {
            cd->current_sectors[i] = -1;
            cd->buffers[i] = cd->buffers[i-1] + (SCSI_BUFSIZE << 4);
        }

        err = CDROMERR_MSGPORT;
        cd->port = CreateMsgPort ();
        if (NULL == cd->port)
            break;

        err = CDROMERR_IOREQ;
        cd->scsireq = (struct IOStdReq *)CreateIORequest (cd->port, sizeof (struct IOExtTD));
        if (NULL == cd->scsireq)
            break;

        err = CDROMERR_DEVICE;
        if (OpenDevice ((UBYTE *) p_device, p_scsi_id, (struct IORequest *) cd->scsireq, 0))
            break;

        cd->device_open = TRUE;

        if (global->g_scan_interval < 0) {
            /* Add media change interrupts */
            cd->iochangeint = (struct IOStdReq *)AllocVec(sizeof (struct IOExtTD), MEMF_PUBLIC);
            if (NULL == cd->iochangeint)
                break;
            CopyMem(cd->scsireq, cd->iochangeint, sizeof (struct IOExtTD));
            cd->changeint.is_Node.ln_Type = NT_INTERRUPT;
            cd->changeint.is_Node.ln_Name = "CDFS ChangeInt";
            cd->changeint.is_Data = (APTR)global;
            cd->changeint.is_Code = (VOID_FUNC)CDChangeHandler;
            cd->iochangeint->io_Length  = sizeof(struct Interrupt);
            cd->iochangeint->io_Data    = &cd->changeint;
            cd->iochangeint->io_Command = TD_ADDCHANGEINT;
            SendIO((struct IORequest *)cd->iochangeint);
        }

        cd->scsireq->io_Command = CMD_CLEAR;
        DoIO ((struct IORequest *) cd->scsireq);

        cd->t_changeint = -1;
        cd->t_changeint2 = -2;

        /* The LUN is the 2nd digit of the SCSI id number: */
        cd->lun = (p_scsi_id / 10) % 10;

        /* 'tick' is incremented every time a sector is accessed. */
        cd->tick = 0;
        err = CDROMERR_OK;
    } while (0);

    if (CDROMERR_OK != err)
    {
        Cleanup_CDROM(cd);
        cd = NULL;
    }

    return cd;
}

int Do_SCSI_Command
        (
                CDROM *p_cd,
                unsigned char *p_buf,
                long p_buf_length,
                unsigned char *p_command,
                int p_length,
                int p_direction
        )
{
    p_cd->scsireq->io_Length   = sizeof (struct SCSICmd);
    p_cd->scsireq->io_Data     = (APTR) &p_cd->cmd;
    p_cd->scsireq->io_Command  = HD_SCSICMD;

    p_cd->cmd.scsi_Data        = (UWORD *) p_buf;
    p_cd->cmd.scsi_Length      = p_buf_length;
    p_cd->cmd.scsi_Flags       = SCSIF_AUTOSENSE | p_direction;
    p_cd->cmd.scsi_SenseData   = (UBYTE *) p_cd->sense;
    p_cd->cmd.scsi_SenseLength = 20;
    p_cd->cmd.scsi_SenseActual = 0;
    p_cd->cmd.scsi_Command     = (UBYTE *) p_command;
    p_cd->cmd.scsi_CmdLength   = p_length;

    p_command[1] |= p_cd->lun << 5;

    if (0 != DoIO((struct IORequest *) p_cd->scsireq) ||
        0 != p_cd->cmd.scsi_Status)
    {
        Clear_Sector_Buffers(p_cd);
        return 0;
    }
    else
        return 1;
}

int Read_From_Drive
        (
                CDROM *p_cd,
                unsigned char *p_buf,
                long p_buf_length,

                long p_sector,
                int p_number_of_sectors
        )
{
    p_cd->scsireq->io_Length   = 2048 * p_number_of_sectors;
    p_cd->scsireq->io_Data     = (APTR) p_buf;
    p_cd->scsireq->io_Offset   = (ULONG) p_sector << 11;
    p_cd->scsireq->io_Actual   = (ULONG) p_sector >> 21;
    p_cd->scsireq->io_Command  = p_cd->scsireq->io_Actual ? TD_READ64 : CMD_READ;

    D(bug("[CDVDFS]\tAccessing sectors %ld:%ld\n", (long)p_sector, (long)p_number_of_sectors));

    if (0 != DoIO((struct IORequest*) p_cd->scsireq))
    {
        D(bug("[CDVDFS]\tTransfer failed: %ld\n", (long)p_cd->scsireq->io_Error));
        Clear_Sector_Buffers(p_cd);
        return 0;
    }

    D(bug("[CDVDFS]\tTransfer successful.\n"));
    return 1;
}

/* 
 * USAGE NOTE >> VERY IMPORTANT <<
 * this procedure delivers you buffer that is 'valid' until the next 16-sector-boundary.
 * if you want to read from sec 14 till 34, then you have to do 3 calls (14-16, 16-32, 32-34)
 */
int Read_Chunk(CDROM *p_cd, long p_sector)
{
    struct CDVDBase *global = p_cd->global;
    int status;
    int i;
    int loc;
    long vol_size;
    long start;
    int count;

    D(bug("[CDVDFS]\tClient requested sector %ld\n", p_sector));

    for (i=0; i<p_cd->buffers_cnt; i++)
    {
        if ((p_sector & ~0xf) != p_cd->current_sectors[i])
            continue;

        /*
         * get buffer offset
         */
        D(bug("[CDVDFS]\tSector already cached\n"));
        p_cd->buffer = p_cd->buffers[i] + ((p_sector & 0xf) << 11);

        /*
         * try most frequently used
         */
        p_cd->last_used[i] += 2;
        for (i=0; i<p_cd->buffers_cnt; i++)
        {
            if (p_cd->last_used[i] > 0)
                p_cd->last_used[i] -= 1;
        }

        return 1;
    }

    /* 
     * find an empty buffer position:
     */
    for (loc=0; loc<p_cd->buffers_cnt; loc++)
        if (p_cd->current_sectors[loc] == -1)
            break;

    /*
     * no free buffer position; remove the buffer that is unused
     * for the longest time
     */
    if (loc==p_cd->buffers_cnt)
    {
        uint32_t oldest_tick = UINT_MAX;
        uint32_t tick;

        for (loc=0, i=0; i<p_cd->buffers_cnt; i++)
        {
            tick = p_cd->last_used[i];
            if (tick < oldest_tick)
                loc = i, oldest_tick = tick;
        }
    }

    /*
     * read **16** sectors
     * NOTE: all DVD discs require chunk size to be at least n*16 sectors
     * most of the CDs have enough padding (18 sectors) at the end
     * (but not all)
     */
    start = p_sector & ~0xf;
    count = 16;
    if (global->g_volume != NULL)
        vol_size = Volume_Size(global->g_volume);
    else
        vol_size = 0;
    if (vol_size != 0 && vol_size - start < count)
        count = vol_size - start;
    status =
        Read_From_Drive(p_cd, p_cd->buffers[loc], SCSI_BUFSIZE, start, count);

    if (status)
    {
        p_cd->current_sectors[loc] = p_sector & ~0xf;
        p_cd->buffer = p_cd->buffers[loc] + ((p_sector & 0xf) << 11);
        p_cd->last_used[loc] = 1000;
    }

    return status;
}

int Test_Unit_Ready(CDROM *p_cd) 
{
    p_cd->scsireq->io_Command = TD_CHANGENUM;

    if (0 != DoIO ((struct IORequest *) p_cd->scsireq))
        return FALSE;

    p_cd->t_changeint = p_cd->scsireq->io_Actual;

    p_cd->scsireq->io_Command = TD_CHANGESTATE;
    if ((0 != DoIO ((struct IORequest *) p_cd->scsireq)) || 
        (0 != p_cd->scsireq->io_Actual))
        return FALSE;

    return TRUE;
}

int Mode_Select
        (
                CDROM *p_cd,
                int p_mode,
                int p_block_length
        )
{
    uint8_t cmd[6] = { };
    unsigned char mode[12] = { };

    cmd[0] = 0x15;
    cmd[1] = 0x10;
    cmd[4] = 0x0a;

    mode[3] = 8;
    mode[4] = p_mode;
    mode[9] = p_block_length >> 16;
    mode[10] = (p_block_length >> 8) & 0xff;
    mode[11] = p_block_length & 0xff;

    CopyMem(mode, p_cd->buffer_io, sizeof (mode));
    return Do_SCSI_Command(p_cd, p_cd->buffer_io, sizeof(mode), cmd, 6, SCSIF_WRITE);
}

int Inquire (CDROM *p_cd, t_inquiry_data *p_data)
{
    uint8_t cmd[6] = { };
    cmd[0] = 0x12;
    cmd[4] = 96;

    if (!Do_SCSI_Command(p_cd,p_cd->buffer_io,96,cmd,6,SCSIF_READ))
        return FALSE;

    CopyMem(p_cd->buffer_io, p_data, sizeof (*p_data));
    return 1;
}


t_toc_data *Read_TOC
        (
                CDROM *p_cd,
                t_toc_header *p_toc_header
        )
{
    uint8_t cmd[10] = { };
    uint32_t toc_len = 0;
    uint8_t *buf = p_cd->buffer_io;

    /*
     * check toc len
     */
    cmd[0] = 0x43;
    cmd[7] = 0;
    cmd[8] = 4;
    if (0 == Do_SCSI_Command(p_cd, buf, 4, cmd, 10, SCSIF_READ))
        return NULL;

    /*
     * toc len = len field + field contents
     * Some drives don't return the full TOC length when the buffer is too
     * small for the whole TOC: in this case, calculate it based on the
     * number of tracks
     */
    toc_len = 2 + ((buf[0] << 8) | (buf[1]));
    if (toc_len < 12)
        toc_len = 4 + (buf[3] - buf[2] + 2) * 8;

    /*
     * make sure it never happens (shouldn't)
     */
    if (toc_len > SCSI_BUFSIZE)
        return NULL;

    /*
     * read complete TOC
     */
    cmd[7] = toc_len >> 8;
    cmd[8] = toc_len & 0xff;
    if (0 == Do_SCSI_Command(p_cd, buf, toc_len, cmd, 10, SCSIF_READ))
        return NULL;

    /*
     * that's a bit stupid (4 bytes and CopyMem) but still..
     */
    CopyMem(buf, p_toc_header, sizeof (*p_toc_header));
    return (t_toc_data *) (buf + 4);
}

int Has_Audio_Tracks(CDROM *p_cd) 
{
    t_toc_header hdr;
    t_toc_data *toc;
    int i, len;

    toc = Read_TOC (p_cd, &hdr);
    if (!toc)
        return FALSE;

    /*
     * calc num TOC entries
     * last entry is usually LEADOUT (0xAA)
     */
    len = hdr.length >> 3;

    /*
     * traverse all tracks, check for audio?
     */
    for (i=0; i<len; i++)
    {
        if ((99 >= toc[i].track_number) && 
            (0  == (toc[i].flags & 4)))
            return toc[i].track_number;
    }
    return FALSE;
}

/*
 * Create a buffer containing the start addresses of all data tracks
 * on the disk.
 *
 * Returns:
 *  number of tracks or -1 on error.
 */

int Data_Tracks(CDROM *p_cd, uint32_t** p_buf) 
{
    int cnt=0;
    t_toc_header hdr;
    t_toc_data *toc;
    int i, j, len;

    /*
     * collect TOC
     */
    toc = Read_TOC(p_cd, &hdr);
    if (!toc)
        return -1;

    /*
     * calc TOC entries count
     */
    len = hdr.length >> 3;

    /* 
     * count number of data tracks:
     */
    for (i=0; i<len; i++)
    {
        if ((99 >= toc[i].track_number) && 
            (0  != (toc[i].flags & 4)))
            cnt++;
    }

    if (cnt == 0)
        return 0;

    /* 
     * allocate memory for output buffer:
     */
    *p_buf = (uint32_t*) AllocVec (cnt * sizeof (uint32_t*), MEMF_PUBLIC);
    if (!*p_buf)
        return -1;

    /* 
     * fill output buffer:
     */
    for (i=0, j=0; i<len; i++)
    {
        if ((99 >= toc[i].track_number) && 
            (0  != (toc[i].flags & 4)))
            (*p_buf)[j++] = toc[i].address;
    }

    return cnt;
}

inline void block2msf (uint32_t blk, unsigned char *msf)
{
    blk = (blk+150) & 0xffffff;
    msf[0] = blk / 4500;        /* 4500 = 60 seconds * 75 frames */
    blk %= 4500;
    msf[1] = blk / 75;
    msf[2] = blk % 75;
}

int Start_Play_Audio(CDROM *p_cd) 
{
    uint8_t cmd[10] = { };
    uint32_t start = 0xffffffff,end;
    t_toc_header hdr;
    t_toc_data *toc;
    int i, len;

    cmd[0] = 0x47;

    /*
     * read TOC
     */
    toc = Read_TOC (p_cd, &hdr);
    if (!toc)
        return FALSE;

    /*
     * calc len
     */
    len = hdr.length >> 3;

    /*
     * find beginning of audio track
     */
    for (i=0; i<len; i++)
    {
        if ((99 >= toc[i].track_number) && 
            (0  == (toc[i].flags & 4)))
        {
            start=toc[i].address;
            break;
        }
    }

    /*
     * no audio - leave.
     */
    if (0xffffffff == start)
        return FALSE;

    /*
     * find end of audio track
     */
    for (; i<len; i++)
    {
        if (((99 < toc[i].track_number) && (toc[i].track_number > 99)) || 
            (0  != (toc[i].flags & 4)))
            break;
    }
    end=toc[i].address;

    /*
     * fill up request and send
     */
    block2msf(start, &cmd[3]);
    block2msf(end-1, &cmd[6]);

    return Do_SCSI_Command(p_cd, 0, 0, cmd, 10, SCSIF_READ);
}

int Stop_Play_Audio(CDROM *p_cd) 
{
    uint8_t cmd[6] = { };
    cmd[0] = 0x1b;
    return Do_SCSI_Command(p_cd, 0, 0, cmd, 6, SCSIF_READ);
}

void Cleanup_CDROM (CDROM *p_cd) 
{
    if (p_cd->iochangeint) {
        p_cd->iochangeint->io_Length  = sizeof(struct Interrupt);
        p_cd->iochangeint->io_Data    = &p_cd->changeint;
        p_cd->iochangeint->io_Command = TD_REMCHANGEINT;
        DoIO((struct IORequest *)p_cd->iochangeint);
        FreeVec(p_cd->iochangeint);
    }
    if (p_cd->device_open)
        CloseDevice ((struct IORequest *) p_cd->scsireq);
    if (p_cd->scsireq)
        DeleteIORequest((struct IORequest *)p_cd->scsireq);
    if (p_cd->port)
        DeleteMsgPort (p_cd->port);
    if (p_cd->last_used)
        FreeVec (p_cd->last_used);
    if (p_cd->current_sectors)
        FreeVec (p_cd->current_sectors);
    if (p_cd->buffers)
        FreeVec (p_cd->buffers);
    if (p_cd->buffer_io)
        FreeVec (p_cd->buffer_io);
    if (p_cd->buffer_data)
        FreeVec (p_cd->buffer_data);
    FreeVec (p_cd);
}

void Clear_Sector_Buffers (CDROM *p_cd)
{
    int i;

    for (i=0; i<p_cd->buffers_cnt; i++)
        p_cd->current_sectors[i] = -1;
}

/* Finds offset of last session. (Not supported by all CDROM drives)
 *
 * Returns: - FALSE if there is no special SCSI command to determine the
 *            offset of the last session.
 *          - TRUE if the offset of the last session has been determined.
 */

int Find_Last_Session(CDROM *p_cd, uint32_t *p_result)
{
    uint8_t cmd[10] = { };
    uint8_t *data = p_cd->buffer_io;

    cmd[0] = 0x43;
    cmd[2] = 0x01;

    /*
     * first: READTOC IS MANDATORY
     * drives not conforming to MMC2 died in 1995.
     */
    *p_result = 0;

    /* 
     * Ask the scsi device for the length of this TOC 
     */
    cmd[7] = 0;
    cmd[8] = 12;
    if (!Do_SCSI_Command(p_cd, data, 12, cmd, sizeof(cmd), SCSIF_READ))
        return FALSE;

    /*
     * check if we are dealing with a DATA track here.
     * nobody would like to spend an hour trying to get his mixed mode cd read
     */
    D(bug("[CDVDFS]\tFirst track in last session has type %lx\n", data[5]));
    if ((data[5] & 0xfc) != 0x14)
    {
       D(bug("[CDVDFS]\tThis track is not a DATA track. Will default to track 1.\n"));

       /*
        * this indeed sets the address of first track in first session, but we have no idea if this really is a data track.
        * we don't care anyways. it will be detected by higher layer
        */
       return TRUE;
    }

    /*
     * the ReadTOC has MSF field set to 0 so we treat obtained values as logical block address
     */

    *p_result = (data[8] << 24) | (data[9] << 16) | (data[10] << 8) | (data[11]);
    return TRUE;
}