csl_emifclose.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_emifClose.c
 *
 *    @brief File for functional layer of CSL API @a CSL_emifClose()
 *
 *    Path: \\(CSLPATH)\\ipmodules\\emifs\\src
 *
 *  Description
 *    - The @a CSL_emifClose() function definition & it's associated functions
 *
 *  Modification 1
 *    - Created on: 10/6/2004
 *    - Reason: created the sources
 *
 *  @date 10th June, 2004
 *  @author Santosh Narayanan.
 *
 */
 
/* =============================================================================
 *  Revision History
 *  ===============
 *  30-Aug-2004  brn      Updated for the new CSL architecture
 *  11-Oct-2004  brn      Updated with the code review comments. 
 *                        
 * =============================================================================
 */
 

#include <csl_emif.h>


/** ===========================================================================
 *   @n@b csl_emifClose.c                                                       
 *                                                                             
 *   @b Description                                                            
 *   @n This function marks that CSL for the external memory interface instance is
 *      CSL for the external memory interface instance need to be reopened before 
 *      external memory interface CSL API.                                        
 *                                                                             
 *   @b Arguments                                                              
 *   @verbatim                                                                 
            hEmif         Handle to the external memory interface instance         
     @endverbatim                                                              
 *                                                                             
 *   <b> Return Value </b>  CSL_Status                                         
 *   @li                    CSL_SOK            - external memory interface is clos
 *                                               successfully                  
 *                                                                             al
 *   @li                    CSL_ESYS_BADHANDLE - The handle passed is invalid  
 *                                                                             
 *   <b> Pre Condition </b>                                                    
 *   @n  None                                                                  
 *                                                                             
 *   <b> Post Condition </b>                                                   
 *   @n  1. The external memory interface CSL APIs can not be called until the    
 *          external memory interface CSL is reopened again using CSL_emifOpen()   
 *                                                                             
 *   @b Modifies                                                               
 *   @n  None                                                                  
 *                                                                             
 *   @b Example                                                                
 *   @verbatim                                                                 
            CSL_EmifHandle   hEmif;                                              
                                                                               
            ...                                                                
                                                                               
            CSL_emifClose (hEmif);                                               
                                                                               
            ...                                                                
     @endverbatim                                                              
 * =========================================================================== 
 */                                                                                    
#pragma CODE_SECTION (CSL_emifClose, ".text:csl_section:emif");                  
CSL_Status  CSL_emifClose (                                                     
   CSL_EmifHandle    hEmif                                                       
)                                                                              
{      
    /* Changed the status variable from st according to review comment*/                                                                        
    CSL_Status  status;                                                            
                                                                               
    if (hEmif != NULL) {                                                        
        hEmif->regs    = (CSL_EmifRegsOvly)NULL;                                 
        hEmif->perNum  = (CSL_InstNum)-1;                                       
        status            = CSL_SOK;                                               
    }                                                                          
    else {                                                                     
        status = CSL_ESYS_BADHANDLE;                                               
    }                                                                          
                                                                               
    return status;                                                                 
}