Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

dm6437_phy_vlynq.h

Go to the documentation of this file.
00001 /** ============================================================================
00002  *  @file   dm6437_phy_vlynq.h
00003  *
00004  *  @path   $(DSPLINK)/gpp/inc/sys/arch/DM6437/PrOS/
00005  *
00006  *  @brief  Hardware Abstraction Layer for DM6437.
00007  *          Define the Platform specific HAL (Hardware Abstraction Layer)
00008  *          object.
00009  *
00010  *  @ver    1.65.00.03
00011  *  ============================================================================
00012  *  @copyright Copyright (C) 2002-2009, Texas Instruments Incorporated -
00013  *  http://www.ti.com/
00014  *
00015  *  Redistribution and use in source and binary forms, with or without
00016  *  modification, are permitted provided that the following conditions
00017  *  are met:
00018  *  
00019  *  *  Redistributions of source code must retain the above copyright
00020  *     notice, this list of conditions and the following disclaimer.
00021  *  
00022  *  *  Redistributions in binary form must reproduce the above copyright
00023  *     notice, this list of conditions and the following disclaimer in the
00024  *     documentation and/or other materials provided with the distribution.
00025  *  
00026  *  *  Neither the name of Texas Instruments Incorporated nor the names of
00027  *     its contributors may be used to endorse or promote products derived
00028  *     from this software without specific prior written permission.
00029  *  
00030  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00031  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00032  *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00033  *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00034  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00035  *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00036  *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
00037  *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
00038  *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00039  *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00040  *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00041  *  ============================================================================
00042  */
00043 
00044 
00045 #if !defined (DM6437_PHY_VLYNQ_H)
00046 #define DM6437_PHY_VLYNQ_H
00047 
00048 
00049 /*  ----------------------------------- DSP/BIOS Link               */
00050 #include <dsplink.h>
00051 
00052 /*  ----------------------------------- Hardware Abstraction Layer  */
00053 #include <hal.h>
00054 #include <dm6437_hal.h>
00055 
00056 
00057 #if defined (__cplusplus)
00058 extern "C" {
00059 #endif
00060 
00061 
00062 /** ============================================================================
00063  *  @name   DM6437_vlynqInterface
00064  *
00065  *  @brief  Interface functions exported by the VLYNQ subcomponent.
00066  *  ============================================================================
00067  */
00068 extern HAL_Interface DM6437_vlynqInterface ;
00069 
00070 
00071 /* ============================================================================
00072  *  @func   DM6437_phyVlynqInit
00073  *
00074  *  @brief  Initializes VLYNQ device.
00075  *
00076  *  @param halObject.
00077  *              HAL object.
00078  *
00079  *  @return DSP_SOK
00080  *              Operation successfully completed.
00081  *          DSP_EFAIL
00082  *              All other error conditions.
00083  *
00084  *  @pre    None.
00085  *
00086  *  @post   None.
00087  *
00088  *  @see    None
00089  *  ============================================================================
00090  */
00091 NORMAL_API
00092 DSP_STATUS
00093 DM6437_phyVlynqInit (IN Pvoid halObject) ;
00094 
00095 
00096 /* ============================================================================
00097  *  @func   DM6437_phyVlynqExit
00098  *
00099  *  @brief  Finalizes VLYNQ device.
00100  *
00101  *  @param halObject.
00102  *              HAL object.
00103  *
00104  *  @return DSP_SOK
00105  *              Operation successfully completed.
00106  *          DSP_EFAIL
00107  *              All other error conditions.
00108  *
00109  *  @pre    None.
00110  *
00111  *  @post   None.
00112  *
00113  *  @see    None
00114  *  ============================================================================
00115  */
00116 NORMAL_API
00117 DSP_STATUS
00118 DM6437_phyVlynqExit (IN Pvoid halObject) ;
00119 
00120 
00121 #if defined (__cplusplus)
00122 }
00123 #endif
00124 
00125 
00126 #endif  /* !defined (DM6437_PHY_VLYNQ_H) */

Generated on Fri Jul 16 14:28:25 2010 for DSP/BIOSLink by  doxygen 1.4.4