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

dm6437_hal_pci_map.h

Go to the documentation of this file.
00001 /** ============================================================================
00002  *  @file   dm6437_hal_pci_map.h
00003  *
00004  *  @path   $(DSPLINK)/gpp/inc/sys/arch/DM6437/
00005  *
00006  *  @brief  Map 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_MAP_H)
00044 #define DM6437_HAL_PCI_MAP_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_halPciMapCtrl
00063  *
00064  *  @brief  Mapping controller.
00065  *
00066  *  @param halObject.
00067  *              HAL Object
00068  *  @param cmd.
00069  *              MAP Command.
00070  *  @param dspBufAddr.
00071  *              DSP address to be mapped.
00072  *  @param size.
00073  *              Size of area to be mapped.
00074  *  @param bufVirtPtr.
00075  *              virtual address of mapped area.
00076  *  @param bufPhysAddr.
00077  *              Physical address of mapped area in HOST address space.
00078  *  @param mappedSize.
00079  *              Size of memory region mapped.
00080  *
00081  *  @return DSP_SOK
00082  *              Operation successfully completed.
00083  *          DSP_ERANGE
00084  *              A parameter is specified outside its valid range.
00085  *          DSP_EINVALIDARG
00086  *              Unsupported interrupt control command.
00087  *
00088  *  @pre    None.
00089  *
00090  *  @post   None.
00091  *
00092  *  @see    None
00093  *  ============================================================================
00094  */
00095 NORMAL_API
00096 DSP_STATUS
00097 DM6437_halPciMapCtrl (IN      Pvoid          halObject,
00098                       IN      DSP_MapCtrlCmd  cmd,
00099                       IN      Uint32          dspBufAddr,
00100                       IN      Uint32          size,
00101                       OUT     Uint32 *        bufVirtPtr,
00102                       OUT     Uint32 *        bufPhysAddr,
00103                       OUT     Uint32 *        mappedSize) ;
00104 
00105 
00106 #if defined (__cplusplus)
00107 }
00108 #endif /* if defined (__cplusplus) */
00109 
00110 #endif /* !defined (DM6437_HAL_PCI_MAP_H) */

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