csl_mmcsdgetbaseaddress.c

TI达芬奇dm644x各硬件模块测试代码

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004, 2005                 
 *                                                                              
 *   Use of this software is controlled by the terms and conditions found in the
 *   license agreement under which this software has been supplied.             
 *   ===========================================================================
 */

/** ============================================================================
 *   @file  csl_mmcsdGetBaseAddress.c
 *
 *   @brief  File for functional layer of CSL API @a CSL_mmcsdGetBaseAddress()
 *
 *  Path: \\(CSLPATH)\\soc\\davinci\\arm9\\src
 */
 
/*  ============================================================================
 *  Revision History
 *  ===============
 *  12-Oct-2004 Hs Added code to validate input parameters
 *                 Updated according to review comments
 *  01-sep-2004 Hs File Created.
 *  ============================================================================
 */

#include <csl_mmcsd.h>

/** ============================================================================
 *   @n@b CSL_mmcsdGetBaseAddress
 *
 *   @b Description
 *   @n  Function to get the base address of the peripheral instance.
 *       This function is used for getting the base address of the peripheral
 *       instance. This function will be called inside the CSL_mmcsdOpen()
 *       function call. This function is open for re-implementing if the user
 *       wants to modify the base address of the peripheral object to point to
 *       a different location and there by allow CSL initiated write/reads into
 *       peripheral. MMR's go to an alternate location.
 *
 *   @b Arguments
 *   @verbatim
            mmcsdNum        Specifies the instance of the MMCSD to be opened.

            pMmcsdParam     Module specific parameters.

            pBaseAddress    Pointer to baseaddress structure containing base
                            address details.

     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_OK             Open call is successful
 *   @li                    CSL_ESYS_FAIL      The instance number is invalid.
 *   @li                    CSL_ESYS_INVPARAMS Invalid parameter
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  Base Address structure is populated
 *
 *   @b Modifies
 *   @n    1. The status variable
 *
 *         2. Base address structure is modified.
 *
 *   @b Example
 *   @verbatim
        CSL_Status          status;
        CSL_MmcsdBaseAddress  baseAddress;

       ...
      status = CSL_mmcsdGetBaseAddress(CSL_MMCSD_PER_CNT, NULL, &baseAddress);

    @endverbatim
 * ===========================================================================
 */
#pragma CODE_SECTION (CSL_mmcsdGetBaseAddress, ".text:csl_section:mmcsd");
CSL_Status CSL_mmcsdGetBaseAddress (
    CSL_InstNum              mmcsdNum,
    CSL_MmcsdParam *         pMmcsdParam,
    CSL_MmcsdBaseAddress *   pBaseAddress
)
{
    CSL_Status status = CSL_SOK;
    
    if (pBaseAddress == NULL)
        return CSL_ESYS_INVPARAMS;

    switch (mmcsdNum) {
        case CSL_MMCSD:
            pBaseAddress->regs = (CSL_MmcsdRegsOvly)CSL_MMCSD_1_REGS;
            break;
        default:
            pBaseAddress->regs = NULL;
            status = CSL_ESYS_FAIL;
    }

    return status;
}