csl_pscgetbaseaddress.c

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

/*  ============================================================================
 *   Copyright (c) Texas Instruments Inc 2002, 2003, 2004
 *
 *   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_pscGetBaseAddress.c
 *
 *  @path $(CSLPATH)\ipmodules\psc\src
 *
 *  @brief File for functional layer of CSL API @a CSL_pscGetBaseAddress()
 *
 */
 
/* =============================================================================
 *  Revision History
 *  ===============
 *  10-Feb-2004 kpn File Created.
 * =============================================================================
 */

#include <soc.h>
#include <csl_psc.h>

/** ============================================================================
 *   @n@b CSL_pscGetBaseAddress
 *
 *   @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_pscOpen()
 *       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
            pscNum         Specifies the instance of the psc to be opened.

            pPscParam      Module specific parameters.

            pBaseAddress    Pointer to base address 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_PscBaseAddress     baseAddress;

         ...

         status = CSL_pscGetBaseAddress(CSL_PSC, NULL, &baseAddress);
         ...
    @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_pscGetBaseAddress, ".text:csl_section:psc");
CSL_Status CSL_pscGetBaseAddress (
    CSL_InstNum  		    pscNum,
    CSL_PscParam          *pPscParam,
    CSL_PscBaseAddress    *pBaseAddress
)
{
    CSL_Status status = CSL_SOK;

    if (pBaseAddress == NULL)
        return CSL_ESYS_INVPARAMS;

    switch (pscNum) {
        case 0:
            pBaseAddress->regs = (CSL_PscRegsOvly) CSL_PSC_1_REGS;
            break;
        default:
            pBaseAddress->regs = (CSL_PscRegsOvly)NULL;
            status = CSL_ESYS_FAIL;
            break;
    }

    return status;
}