csl_memprotopen.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_memprot
 *
 * @brief    File for functional layer of CSL API @a CSL_memprotOpen()
 *
 * @path $(CSLPATH)\\memprot\\src
 *
 *
 * Description
 *  - The @a CSL_memprotOpen() function definition & it's associated functions
 *
 *  Modification 1
 *    - Modified on: 7/16/2004
 *    - Reason: created the sources
 *
 *  @author Ruchika Kharwar.
 */

#include <csl_memprot.h>
/** ===========================================================================
 *   @n@b CSL_memprotOpen
 *
 *   @b Description
 *   @n This function populates the peripheral data object for the instance
 *      and returns a handle to the instance.
 *      The open call sets up the data structures for the particular instance
 *      of MEMPROT device.The device can be re-opened anytime after it has been
 *      normally closed if so required.MEMPROT Hardware setup will be performed
 *      at the end of the open call only if the HwSetup Pointer supplied was
 *      non- NULL. The handle returned by this call is input as an essential
 *      argument for rest of the APIs described for this module.
 *
 *   @b Arguments
 *   @verbatim 
              pMemprotObj     Pointer to the MEMPROT instance object
              
              memprotNum      Instance of the MEMPROT to be opened
              
              pMemprotParam   Pointer to module specific parameters
              
              pStatus         pointer for returning status of the function call
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_MemprotHandle
 *   @n                     Valid MEMPROT instance handle will be returned if 
                            status value is equal to CSL_SOK.
 *
 *   <b> Pre Condition </b>
 *  Memory protection must be successfully initialized via @a CSL_memprotInit()
 *  before calling this function. Memory for the @a CSL_MemoprotObj must be
 *  allocated outside this call. This object must be retained while usage of
 *  this module.Depending on the module opened some inherant constraints need
 *  to be kept in mind. When a handle for the Config block is opened the only
 *  operation  possible is a query for the fault Status. No other control
 *  command/ query/ setup must be used.
 *  When a handle for L1D/L1P is opened then too constraints wrt the number of
 *  Memory pages must be kept in mind.
 *
 *   <b> Post Condition </b>
 *   @n   1.    MEMPROT object structure is populated
 *   @n   2.    The status is returned in the status variable. If status
 *              returned is
 *   @li            CSL_SOK             Valid ata handle is returned
 *   @li            CSL_ESYS_FAIL       The ata instance is invalid
 *   @li            CSL_ESYS_INVPARAMS  Invalid parameter
 *
 *   @b Modifies
 *   @n    1. The status variable
 *   @n    2. MEMPROT object structure
 *
 *   @b Example
 *  @verbatim

            CSL_MemprotObj mpL2Obj;
            CSL_MemprotHandle hmpL2;
            CSL_Status status;
            // Initializing the module 
            CSL_memprotInit(NULL);
            
            // Opening the Handle for the L2 
            hmpL2 = CSL_memprotOpen(&mpL2Obj,
                                  CSL_MEMPROT_L2,
                                  NULL,
                                  &status);
   @endverbatim
 * ============================================================================
 */  

#pragma CODE_SECTION (CSL_memprotOpen, ".text:csl_section:memprot");
CSL_MemprotHandle CSL_memprotOpen (
    /**  Pointer to the object that holds reference to the instance of memory 
     *   protection unit requested after the call.
     */         
        CSL_MemprotObj *    pMemprotObj,   
    /** Instance of memory protection unit to which a handle is requested 
     */ 
        CSL_InstNum     memprotNum,     
    /** Module specific parameters; currently there are no module specific 
     *  parameters and the user should pass 'NULL'.
     */   
        CSL_MemprotParam *  pMemprotParam, 
    /** This returns the status (success/error)  of the call. The user may pass 
     *  'NULL', if status information is not required.
     */  
        CSL_Status *    pStatus
)
{
    CSL_Status              st;
    CSL_MemprotHandle       hMemprot;
    CSL_MemprotBaseAddress  baseAddress;
    
    st = CSL_memprotGetBaseAddress(memprotNum, pMemprotParam, &baseAddress); 
    if ( st == CSL_SOK) {
        pMemprotObj->regs = baseAddress.regs;
        pMemprotObj->modNum = (CSL_InstNum)memprotNum;
        hMemprot = (CSL_MemprotHandle)pMemprotObj;

        st = CSL_SOK;
    } else {
        pMemprotObj->regs = (CSL_MemprotRegsOvly)NULL;
        pMemprotObj->modNum = (CSL_InstNum)-1;
        hMemprot = (CSL_MemprotHandle)NULL;

        st = CSL_ESYS_FAIL;
    }

    if (pStatus) {
        *pStatus = st;
    }

    return hMemprot;
}