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

dm6437_hal.h File Reference

Hardware Abstraction Layer for 64LC_PCI. Define the Platform specific HAL (Hardware Abstraction Layer) object. More...

#include <dsplink.h>
#include <hal.h>
#include <dm6437_hal_pci.h>
#include <dm6437_hal_vlynq.h>

Include dependency graph for dm6437_hal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  DM6437_HalObj_tag
struct  DM6437_InitParams_tag

DM6437_HalPciPhyObj

Forward declaration of PCI Physical Interface object. ============================================================================

============================================================================

typedef DM6437_HalPciPhyObj_tag DM6437_HalPciPhyObj

DM6437_HalVlynqPhyObj

Forward declaration of VLYNQ Physical Interface object. ============================================================================

============================================================================

typedef DM6437_HalVlynqPhyObj_tag DM6437_HalVlynqPhyObj

DM6437_HalObj

Hardware Abstraction object.

============================================================================

Parameters:
dspId Processor Identifier.
phyType Physical Interface type.
interface Function table for hal functions.
isMapActive tells whether user has mapped some area.
mapSize Size of the mapped area.
pci Structure containging members related to PCI Phy. Only on PCI platforms
lock Lock for using DMA resource.
vlynq Structure containging members related to VLYNQ Phy. Only on VLYNQ Platforms
shMemDspAddr Shared memory base address in DSP address space.
shMemVirtAddr Shared memory virtual base address .
shMemPhysAddr Shared memory physical base address . ============================================================================


typedef DM6437_HalObj_tag DM6437_HalObj

DM6437_InitParams

Initialize parameters for HAL init call.

============================================================================

Parameters:
dspId Processor Identifier.
phyType Physical Interface type.
shMemEntry Shared memory entry ID, this is mapped after initialzing the physical interface.
arg1 Argument 1.
arg2 Argument 2.
arg3 Argument 3.
arg4 Argument 4.
arg5 Argument 5.
arg5 Argument 6. ============================================================================


typedef DM6437_InitParams_tag DM6437_InitParams
NORMAL_API DSP_STATUS DM6437_halInit (IN Pvoid *halObject, IN Pvoid initParams)
 Initializes the HAL object and physical interface.
NORMAL_API DSP_STATUS DM6437_halExit (IN Pvoid *halObject)
 Finializes the HAL object and physical interface.

Defines

#define DM6437_HAL_H


Detailed Description

Hardware Abstraction Layer for 64LC_PCI. Define the Platform specific HAL (Hardware Abstraction Layer) object.

============================================================================

Path:
/db/swcoe_asp/DSPLINK_Build/dsplink_linux_1_65_00_03/dsplink/gpp/inc/sys/arch/DM6437/
Version:
1.65.00.03 ============================================================================
Copyright:
Copyright (C) 2002-2009, Texas Instruments Incorporated - http://www.ti.com/
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ============================================================================

Definition in file dm6437_hal.h.


Define Documentation

#define DM6437_HAL_H
 

Definition at line 46 of file dm6437_hal.h.


Typedef Documentation

typedef struct DM6437_HalObj_tag DM6437_HalObj
 

typedef struct DM6437_HalPciPhyObj_tag DM6437_HalPciPhyObj
 

Definition at line 71 of file dm6437_hal.h.

typedef struct DM6437_HalVlynqPhyObj_tag DM6437_HalVlynqPhyObj
 

Definition at line 82 of file dm6437_hal.h.

typedef struct DM6437_InitParams_tag DM6437_InitParams
 


Function Documentation

NORMAL_API DSP_STATUS DM6437_halExit IN Pvoid halObject  ) 
 

Finializes the HAL object and physical interface.

============================================================================

Function:
DM6437_halExit
Parameters:
halObject. HAL Object
Returns:
DSP_SOK Operation successfully completed. DSP_EFAIL All other error conditions.
Precondition:
None.
Postcondition:
None.
See also:
None ============================================================================

NORMAL_API DSP_STATUS DM6437_halInit IN Pvoid halObject,
IN Pvoid  initParams
 

Initializes the HAL object and physical interface.

============================================================================

Function:
DM6437_halInit
Parameters:
halObject. HAL Object
initParams. Parameters for initialization.
Returns:
DSP_SOK Operation successfully completed. DSP_EMEMORY Out of memory error. DSP_EINVALIDARG Invalid argument.
Precondition:
None.
Postcondition:
None.
See also:
None ============================================================================


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