csl_msgetbaseaddress.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_msGetBaseAddress.c
 *
 *  Path: \\(CSLPATH)\\soc\\davinci\\arm9\\src
 *
 *  @brief  File for functional layer of CSL API @a CSL_msGetBaseAddress()
 *
 */

/*  ============================================================================
 *  Revision History
 *  ===============
 *  09-Oct-2004 kpn Added code to validate input arguments
 *                  Renamed variable 'st' to 'status'
 *  10-Sep-2004 Nsr File Created.
 *  ============================================================================
 */

#include <soc.h>
#include <csl_ms.h>

/** ============================================================================
 *   @n@b CSL_msGetBaseAddress
 *
 *   @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_msOpen()
 *       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
            msNum         Specifies the instance of the MS to be opened.

            pMsParam      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
 *   @n    2. Base address structure is modified.
 *
 *   @b Example
 *   @verbatim
        CSL_Status          status;
        CSL_MsBaseAddress  baseAddress;

        ...
        status = CSL_msGetBaseAddress(CSL_MS_PER_CNT, NULL, &baseAddress);
    @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_msGetBaseAddress, ".text:csl_section:ms");
CSL_Status CSL_msGetBaseAddress (
    CSL_InstNum                    msNum,
    CSL_MsParam                   *pMsParam,
    CSL_MsBaseAddress             *pBaseAddress
)
{
    CSL_Status status = CSL_SOK;

    if (pBaseAddress == NULL) {
        return CSL_ESYS_INVPARAMS;
    }

    switch (msNum) {
        case CSL_MS:
            pBaseAddress->regs = (CSL_MsRegsOvly)CSL_MS_1_REGS;
            break;

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

    return status;
}