csl_nandgetbaseaddress.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_nandGetBaseAddress.c
 *
 *    @brief File for functional layer of CSL API @a CSL_nandGetBaseAddress()
 *
 *  Description
 *    - The @a CSL_nandGetBaseAddress() function definition & it's associated 
 *      functions 
 *  Path: \\(CSLPATH)\\soc\\davinci\\arm9\\src
 *
 */


/*  ===========================================================================
 *  Revision History
 *  ===============
 *  11-Oct-2004 Nsr renamed the local variable "st" as "status" and added the
 *                  - code for validating the input parameters.
 *  31-aug-2004 Nsr File Created.
 *
 *  ===========================================================================
 */

#include <soc.h>
#include <csl_nand.h>

/** ===========================================================================
 *   @n@b CSL_nandGetBaseAddress
 *
 *   @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_nandOpen()
 *       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
            nandNum        Specifies the instance of the NAND to be opened.

            pNandParam     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.
 *
 *   <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_NandBaseAddress  baseAddress;

       ...
      status = CSL_nandGetBaseAddress(CSL_NAND_PER_CNT, NULL, &baseAddress);

    @endverbatim
 * ===========================================================================
 */
#pragma CODE_SECTION (CSL_nandGetBaseAddress, ".text:csl_section:nand");
CSL_Status
CSL_nandGetBaseAddress (
    CSL_InstNum             nandNum,
    CSL_NandParam *         pNandParam,
    CSL_NandBaseAddress *   pBaseAddress
)
{
    CSL_Status status = CSL_SOK;

    *pNandParam = *pNandParam;

    if (pBaseAddress == NULL)
        return CSL_ESYS_INVPARAMS;

    switch (nandNum) {
        case CSL_NAND:
            pBaseAddress->regs = (CSL_NandRegsOvly)CSL_NAND_1_REGS;
            break;

        default:
            pBaseAddress->regs = (CSL_NandRegsOvly)NULL;
            status = CSL_ESYS_FAIL;
            break;
    }

    return status;
}