//
// Copyright (c) Microsoft Corporation.  All rights reserved.
//
//
// Use of this source code is subject to the terms of the Microsoft end-user
// license agreement (EULA) under which you licensed this SOFTWARE PRODUCT.
// If you did not accept the terms of the EULA, you are not authorized to use
// this source code. For a copy of the EULA, please see the LICENSE.RTF on your
// install media.
//
/******************************************************************************
* Filename: ioutil.c
*
* SanDisk Host Developer's Toolkit
*
* Copyright (c) 1997 SanDisk Corporation
* All rights reserved.
* This code may not be redistributed in source or linkable object form
* without the consent of its author.
*
* Description:
*       Support routines.
*
******************************************************************************/


/*****************************************************************************/ 
/*********** Portable Peripheral Bus Interface Device driver Utility. ********/
/*****************************************************************************/

#include "sdconfig.h"

#if (USE_SPI || USE_SPI_EMULATION || USE_MMC || USE_MMC_EMULATION)
#include "sdmmc.h"
#endif

#if (USE_FILE_SYSTEM)
SDVOID drive_format_information(INT16 driveno, UINT16 *n_heads, UINT16 *sec_ptrack, UINT16 *n_cyls);
INT16 get_interface_error(INT16 driveno);
#endif  /* (USE_FILE_SYSTEM) */

#if (USE_INTERRUPTS)
INT16 get_irq_number(INT16 controller_no);
INT16 calculate_controllerno(SDVOID);
#endif  /* (USE_INTERRUPTS) */


SDLOCAL INT16 interface_error(INT16 driveno);

/*****************************************************************************/
/**********  Utility functions to support Peripheral Bus Interface ***********/
/*****************************************************************************/

#if (N_INTERFACES > 1)         /* For multiple controllers */

/*****************************************************************************
* Name: get_controller_number
*
* Description:
*       For a given logical drive number, the controller is calculated
*
* Input:
*
* Returns:
*       Controller Number or
*       Unknown controller  (-1)
*
****************************************************************************/
INT16 get_controller_number(INT16 driveno) /* __fn__ */
{
    INT16 cno;
    INT16 dd, ddd;

    if (driveno >= TOTAL_DRIVES)
        return (-1);

    dd = 0;
    for (cno = 0; cno < N_INTERFACES; cno++)
    {
        ddd = dd + drvs_per_controller[cno];
        /* Checking for range that driveno falls into */
        if (driveno >= dd && driveno < ddd)
            break;

        dd = ddd;
    }

    return(cno);
}



/*****************************************************************************
* Name: drno_to_controller_no 
*
* Description:  Logical drive to controller number.
*
*       NOTE:   This routine is called with the drive already locked so
*               in several cases there is no need for critical section
*               code handling
*
* Input:
*       INT16   driveno         Drive Number
*
* Returns:
*       Controller Number or
*       Unknown controller (-1)
*
******************************************************************************/
INT16 drno_to_controller_no(INT16 driveno) /* __fn__ */
{
    /* Get the controller number */
    return(get_controller_number(driveno));
}


/******************************************************************************
* Name: drno_to_controller
*
* Description:
*       Logical drive to controller structure.
*
* Input:
*       INT16   driveno         Drive Number
*
* Returns:
*       Pointer to the controller structure if successful.
*       NULL if failure.
*
******************************************************************************/
PDEVICE_CONTROLLER drno_to_controller(INT16 driveno) /* __fn__ */
{
    INT16   cno;

    if (driveno >= TOTAL_DRIVES)
        return(0);

    cno = get_controller_number(driveno);
    if (cno < 0)
        return(0);
        
    return(&controller_s[cno]);
}


#if 0
/******************************************************************************
* Name: controller_to_drvno
*
* Description:
*       controller number to logical drive number.
*
* Input:
*       INT16   driveno         Drive Number
*
* Returns:
*       Drive number if successful.
*       -1 if not found.
*
******************************************************************************/
INT16 controller_to_drvno(INT16 controllerno) /* __fn__ */
{
    PDEVICE_CONTROLLER pc;
    INT16 driveno, i;

    pc = &controller_s[controllerno];

    if (pc->drive_active & DRV_ACTIVE)
    {
        /* Get the logical drive number */
        driveno = (INT16)(pc->drive_active & 0x0F);

        for (i = 0; i < controllerno; i++)
            driveno += drvs_per_controller[i]; 
    
        return(driveno);
    }
    else
        return(-1);
}
#endif

/***************************************************************************** 
* Name: drno_to_phys
*
* Description:
*       Logical drive to physical drive for a selected controller. 
*
* Input:
*       INT16   driveno         Drive Number
*
* Returns:
*       Physical Drive Number
*
******************************************************************************/
INT16 drno_to_phys(INT16 driveno) /* __fn__ */
{
    INT16 cno, dd, ddd;

    dd = 0;
    for (cno = 0; cno < N_INTERFACES; cno++)
    {
        ddd = dd + drvs_per_controller[cno];
        /* Checking for range that driveno falls into */
        if (driveno >= dd && driveno < ddd)
            break;

        dd = ddd;
    }
    
    /* Convert drive number to physical drive number from
       the selected controller.
    */
    return(driveno - dd);
}
#endif  /* (N_INTERFACES > 1) */        /* For multiple controllers */


#if (USE_FILE_SYSTEM)
/***************************************************************************** 
* Name: drive_format_information
*
* Description:
*       Get the device's geometry information. 
*
* Input:
*       INT16   driveno         Drive Number
*       UINT16  *n_heads        Number of heads
*       UINT16  *sec_ptrack     Sectors per track
*       UINT16  *n_cyls         Number of cylinders
*
* Output:
*       Physical Drive's geometry
*
* Returns:
*       None
*
******************************************************************************/
SDVOID drive_format_information(INT16 driveno, UINT16 *n_heads,
                  UINT16 *sec_ptrack, UINT16 *n_cyls) /* __fn__ */
{
    PDEVICE_CONTROLLER pc;
    INT16 phys_drive;
    UINT16 ddTmp;

#if (N_INTERFACES > 1)
    pc = drno_to_controller(driveno);
    phys_drive = drno_to_phys(driveno);
#else
    pc = &controller_s[0];
    phys_drive = driveno;
#endif

    ddTmp = 0;

#if (USE_SD)
    /* Check for SD card */
    if (pc->drive[phys_drive].drv_type == SD_TYPE)
    {
 #if (USE_SECURITY)
        /* Is the request a security request? */
        if ( FINDSOURCEOFREQUEST(phys_drive) )
        {
            /* This is for security area */
            /* The security card's geometry */
            *n_heads = pc->drive[phys_drive].num_heads;
            *sec_ptrack = pc->drive[phys_drive].sec_p_track;
            ddTmp = (pc->drive[phys_drive].num_heads * pc->drive[phys_drive].sec_p_track);
                        *n_cyls = (UINT16)(pc->drive[phys_drive].securedAreaSize / ( 0xFFFFL & (UINT32)ddTmp));
            return;
        }
 #endif
    }

#endif

    /* The normal card's geometry */
    *n_heads =  (UINT16)pc->drive[phys_drive].num_heads;
    *sec_ptrack = (UINT16)pc->drive[phys_drive].sec_p_track;
    *n_cyls = (UINT16)pc->drive[phys_drive].num_cylinders;
}
#endif  /* (USE_FILE_SYSTEM) */


#if (USE_INTERRUPTS)
/***************************************************************************** 
* Name: get_irq_number
*
* Description:  Get an IRQ number defined by user in SDCONFIG.H
*
* Input:
*       INT16   controller_no   Controller Number
*
* Returns:
*       YES if successful
*       NO if failure
*
******************************************************************************/
INT16 get_irq_number(INT16 controller_no) /* __fn__ */
{
    return(dev_interrupts[controller_no]);
}



/***************************************************************************** 
* Name: calculate_controllerno
*
* Description:  Calculate the controller number based on drive activity flag
*
* Input:
*       None
*
* Returns:
*       the controller number
*
******************************************************************************/
INT16 calculate_controllerno (SDVOID) /* __fn__ */
{
    PDEVICE_CONTROLLER pc;
    INT16 cno;

    for (cno = 0; cno < N_INTERFACES; cno++)
    {
        pc = &controller_s[cno];
        if (pc->drive_active & DRV_ACTIVE)
            break;
    }
    return (cno);
}

#endif  /* (USE_INTERRUPTS) */


/*****************************************************************************
* Name: interface_error
*
* Description:
*       Get current error code in DEVICE_CONTROLLER structure.
*
* Input:
*       INT16   driveno     Drive Number
*
* Returns:
*       return  (pc->error_code)
*
******************************************************************************/
SDLOCAL INT16 interface_error(INT16 driveno) /* __fn__ */
{
    PDEVICE_CONTROLLER pc;

#if (N_INTERFACES > 1)
    pc = drno_to_controller(driveno);
#else
    driveno = driveno;
    pc = &controller_s[0];
#endif

    return(pc->error_code);
}

#if (USE_FILE_SYSTEM)
/*****************************************************************************
* Name: get_interface_error
*
* Description:
*       Get error code
*
* Input:
*       INT16   driveno     drive/socket number
*
* Returns:
*          0    No Error
*       Otherwise, one of the following error code in controller_s:
*           BUS_ERC_DIAG     1   Drive diagnostic failed in initialize
*           BUS_ERC_ARGS     2   User supplied invalid arguments
*           BUS_ERC_DRQ      3   DRQ should be asserted but it isn't
*                                  or driver and controller are out of phase
*           BUS_ERC_TIMEOUT  4   Timeout during some operation 
*           BUS_ERC_STATUS   5   Controller reported an error
*                                  look in the error register
*           BUS_ERC_ADDR_RANGE  6 LBA out of range
*           BUS_ERC_CNTRL_INIT  7 Fail to initialize controller_s structure
*           BUS_ERC_IDDRV       8 Identify drive info error
*           BUS_ERC_CMD_MULT    9 Read/Write Multiple Command attempts
*                                   to run before Set Multiple Command
*                                   has been executed
*           BUS_ERC_BASE_ADDR  10 Base Address not Available
*
******************************************************************************/
INT16 get_interface_error(INT16 driveno) /* __fn__ */
{
     return(interface_error(driveno));
}

#else /* (!USE_FILE_SYSTEM) */

INT16 get_interface_error(INT16 driveno) /* __fn__ */
{
     return(interface_error(driveno));
}

INT16 pc_get_error (INT16 driveno) /* __fn__ */
{
     return(interface_error(driveno));
}
#endif  /* (USE_FILE_SYSTEM) */