csl_uartclose.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_uartClose.c
 *  
 *  @brief File for functional layer of CSL API @a CSL_uartClose()
 *
 *  Path: \\(CSLPATH)\\ipmodules\\uart\\src
 *
 *  Description
 *    - The @a CSL_uartClose() function definition & it's associated functions
 *
 *  @date 23rd Jan, 2004
 *  @author Ruchika Kharwar
 */

#include <csl_uart.h>

/** ============================================================================
 *   @n@b csl_uartClose.c
 *
 *   @b Description
 *   @n This function marks that CSL for the UART instance is closed. 
 *      CSL for the UART instance need to be reopened before using any
 *      UART CSL API.
 *      
 *   @b Arguments
 *   @verbatim
            hUart         Handle to the UART instance 
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK            - UART is closed
 *                                               successfully
 *
 *   @li                    CSL_ESYS_BADHANDLE - The handle passed is invalid
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  1. The UART CSL APIs can not be called until the UART
 *          CSL is reopened again using CSL_uartOpen() 
 *
 *   @b Modifies
 *   @n  None
 *            
 *   @b Example
 *   @verbatim
            CSL_uartHandle   hUart;
            
            ...
            
            CSL_uartClose (hUart);
            
            ...
     @endverbatim
 * ===========================================================================
 */
#pragma CODE_SECTION (CSL_uartClose, ".text:csl_section:uart");
CSL_Status  CSL_uartClose (
    CSL_UartHandle    hUart
)
{
    CSL_Status  status;
    
    if (hUart != NULL) {
        hUart->regs    = (CSL_UartRegsOvly)NULL;
        hUart->perNum  = (CSL_InstNum)-1;
        status = CSL_SOK;
    } 
    else {
        status = CSL_ESYS_BADHANDLE;
    }

    return status;
}