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

dm6437_hal_pci_dma.h

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

Generated on Fri Jul 16 14:34:01 2010 for DSP/BIOSLink by  doxygen 1.4.4