csl_spiinit.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_spiInit.c
 *
 *  @brief    File for functional layer of CSL API @a CSL_spiInit()
 *
 *  Description
 *    - The @a CSL_spiInit() function definition & it's associated functions
 *
 *  Path: \\(CSLPATH)\\ipmodules\\spi\\src
 *
 *  Modification 1
 *    - modified on: 15/12/2003
 *    - reason: created the sources
 *
 *  Modification 2
 *    - modified on: 19/12/2003
 *    - reason: created better documentation
 *
 *  Modification 3
 *    - modified on: 01/03/2004
 *    - reason: modified according to review comments
 *
 *  Modification 4
 *    - modified on: 10/05/2004
 *    - reason: removed MIB from code & documentation
 *
 *  Date 15th Dec, 2003
 *  Author Sumant S. NaikKhanvte
 */

/* =============================================================================
 *  Revision History
 *  ===============
 *  11-oct-2004 Hs Updated code review comments
 *  10-sep-2004 Hs Updated the function and documentation for CSL_spiInit.
 * =============================================================================
 */

#include <csl_spi.h>

/** ============================================================================
 *   @n@b CSL_spiInit
 *
 *   @b Description
 *   @n This is the initialization function for the SPI CSL.
 *      The function must be called before calling any other API from this CSL.
 *      This function is idem-potent. Currently, the function just return
 *      status CSL_SOK, without doing anything.
 *
 *   @b Arguments
 *   @verbatim
        pContext    Pointer to module-context. As SPI doesn't
                    have any context based information user is expected to pass
                    NULL.
     @endverbatim
 *
 *   <b> Return Value </b>  CSL_Status
 *   @li                    CSL_SOK - Always returns
 *
 *   <b> Pre Condition </b>
 *   @n  None
 *
 *   <b> Post Condition </b>
 *   @n  The CSL for SPI is initialized
 *
 *   @b Modifies
 *   @n  None
 *
 *   @b Example
 *   @verbatim
            CSL_spiInit();
   @endverbatim
 * =============================================================================
 */
#pragma CODE_SECTION (CSL_spiInit, ".text:csl_section:spi");
CSL_Status CSL_spiInit (
    CSL_SpiContext       *pContext
)
{
    pContext = pContext;
    return CSL_SOK;
}