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

dm648_hal_pci_rdwr.h

Go to the documentation of this file.
00001 /** ============================================================================
00002  *  @file   dm648_hal_pci_rdwr.h
00003  *
00004  *  @path   $(DSPLINK)/gpp/inc/sys/arch/DM648/
00005  *
00006  *  @brief  Read Write 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 (DM648_HAL_PCI_RDWR_H)
00044 #define DM648_HAL_PCI_RDWR_H
00045 
00046 
00047 /*  ----------------------------------- DSP/BIOS Link               */
00048 #include <dsplink.h>
00049 #include <_dsplink.h>
00050 
00051 /*  ----------------------------------- OSAL Headers                */
00052 #include <dm648_hal.h>
00053 #include <dm648_hal_pci.h>
00054 
00055 
00056 #if defined (__cplusplus)
00057 extern "C" {
00058 #endif /* if defined (__cplusplus) */
00059 
00060 
00061 /* ============================================================================
00062  *  @func   DM648_halPciRead
00063  *
00064  *  @brief  Reads a buffer from dsp memory .
00065  *
00066  *  @param halObject.
00067  *                  HAL Object
00068  *  @param dspAddr.
00069  *                  DSP Address to be used as read address.
00070  *  @param cBytes.
00071  *                  Number of bytes to transfer.
00072  *  @param readBuffer.
00073  *                  Destination buffer.
00074  *
00075  *  @return DSP_SOK
00076  *              Operation successfully completed.
00077  *          DSP_EFAIL
00078  *              All other error conditions.
00079  *
00080  *  @pre    None.
00081  *
00082  *  @post   None.
00083  *
00084  *  @see    None
00085  *  ============================================================================
00086  */
00087 NORMAL_API
00088 DSP_STATUS
00089 DM648_halPciRead (IN  Pvoid          halObject,
00090                   IN  Uint32         dspAddr,
00091                   IN  Uint32         cBytes,
00092                   OUT Char8 *        readBuffer) ;
00093 
00094 /* ============================================================================
00095  *  @func   DM648_halPciWrite
00096  *
00097  *  @brief  Write a buffer to dsp memory .
00098  *
00099  *  @param halObject.
00100  *                  HAL Object
00101  *  @param dspAddr.
00102  *                  DSP Address to be used as read address.
00103  *  @param cBytes.
00104  *                  Number of bytes to transfer.
00105  *  @param writeBuffer.
00106  *                  Source buffer.
00107  *
00108  *  @return DSP_SOK
00109  *              Operation successfully completed.
00110  *          DSP_EFAIL
00111  *              All other error conditions.
00112  *
00113  *  @pre    None.
00114  *
00115  *  @post   None.
00116  *
00117  *  @see    None
00118  *  ============================================================================
00119  */
00120 NORMAL_API
00121 DSP_STATUS
00122 DM648_halPciWrite (IN  Pvoid          halObject,
00123                    IN  Uint32         dspAddr,
00124                    IN  Uint32         cBytes,
00125                    IN  Char8 *        writeBuffer) ;
00126 
00127 
00128 #if defined (__cplusplus)
00129 }
00130 #endif /* if defined (__cplusplus) */
00131 
00132 #endif /* !defined (DM648_HAL_PCI_RDWR_H) */

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