packages/ti/drv/dfe/src/dfefl/dfe_fl_Init.c

   1 /********************************************************************
   2 * Copyright (C) 2012-2013 Texas Instruments Incorporated.
   3  *
   4  *  Redistribution and use in source and binary forms, with or without
   5  *  modification, are permitted provided that the following conditions
   6  *  are met:
   7  *
   8  *    Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  *
  11  *    Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  *    Neither the name of Texas Instruments Incorporated nor the names of
  17  *    its contributors may be used to endorse or promote products derived
  18  *    from this software without specific prior written permission.
  19  *
  20  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32 */
  33 /** @file dfe_fl_Init.c
  34  *
  35  *  @path  $(CSLPATH)\src\ip\dfe
  36  *
  37  *  @brief File for functional layer of CSL API dfeFl_Init()
  38  *
  39  *
  40  */
  41
  42 #include <ti/drv/dfe/dfe_fl.h>
  43
  44 /** ============================================================================
  45  *   @n@b dfeFl_Init
  46  *
  47  *   @b Description
  48  *   @n This is the initialization function for the Dfe.
  49  *
  50  *   @b Arguments
  51  *   @verbatim
  52          pContext    Pointer to mudule-context structure
  53      @endverbatim
  54  *
  55  *   <b> Return Value </b>  DfeFl_Status
  56  *   @li                    DFE_FL_SOK - Always returns
  57  *
  58  *   <b> Pre Condition </b>
  59  *   @n  None
  60  *
  61  *   <b> Post Condition </b>
  62  *   @n  None
  63  *
  64  *   @b Reads
  65  *   @n  None
  66  *
  67  *   @b Writes
  68  *   @n  None
  69  *
  70  *   @b Example
  71  *   @verbatim
  72
  73          DfeFl_Context dfeCtx;
  74          // open DFE
  75          dfeFl_Init(&dfeCtx);
  76
  77      @endverbatim
  78  * ===========================================================================
  79  */
  80 DfeFl_Status dfeFl_Init (
  81     DfeFl_Context *pContext
  82 )
  83 {
  84     return DFE_FL_SOK;
  85 }