Data Structures | Typedefs

hal.h File Reference


Detailed Description

Defines interface exposed by HAL sub-component.

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

Path:
/gpp/inc/sys/arch/
Version:
1.65.02.09 ============================================================================
Copyright:
Copyright (C) 2002-2012, Texas Instruments Incorporated - https://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. ============================================================================

#include <dsplink.h>
#include <_dspdefs.h>
Include dependency graph for hal.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HAL_Interface_tag

Typedefs

typedef DSP_STATUS(* FnPhyInit )(IN void *halObject)
typedef DSP_STATUS(* FnPhyExit )(IN void *halObject)
typedef DSP_STATUS(* FnBootCtrl )(IN void *halObject, IN DSP_BootCtrlCmd cmd, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnIntCtrl )(IN void *halObject, IN DSP_IntCtrlCmd cmd, IN Uint32 intId, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnMmuCtrl )(IN void *halObject, IN DSP_MmuCtrlCmd cmd, IN LINKCFG_MemEntry *memTable, IN Uint32 memEntries, IN ProcMemMapInfo *mmuInfo)
typedef DSP_STATUS(* FnMapCtrl )(IN void *halObject, IN DSP_MapCtrlCmd cmd, IN Uint32 dspBufAddr, IN Uint32 size, OUT Uint32 *bufVirtPtr, OUT Uint32 *bufPhysAddr, OUT Uint32 *mappedSize)
typedef DSP_STATUS(* FnPwrCtrl )(IN void *halObject, IN DSP_PwrCtrlCmd cmd, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnRead )(IN void *halObject, IN Uint32 dspAddr, IN Uint32 cBytes, OUT Char8 *readBuffer)
typedef DSP_STATUS(* FnWrite )(IN void *halObject, IN Uint32 dspAddr, IN Uint32 cBytes, IN Char8 *writeBuffer)
typedef DSP_STATUS(* FnReadDMA )(IN void *halObject, IN Uint32 srcAddr, IN Uint32 dstAddr, IN Uint32 size)
typedef DSP_STATUS(* FnWriteDMA )(IN void *halObject, IN Uint32 srcAddr, IN Uint32 dstAddr, IN Uint32 size)
HAL_Interface

Interface functions exported by the DSP subcomponent.

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

Parameters:
phyInitFunction pointer to Initializes physical interface function for the DSP.
phyExitFunction pointer to Finalizes physical interface function for the DSP.
bootCtrlFunction pointer to boot control function for the DSP.
intCtrlFunction pointer to intterrupt control function for the DSP.
mapCtrlFunction pointer to map control function for the DSP.
pwrCtrlFunction pointer to power control function for the DSP.
readFunction pointer to read memory function for the DSP.
writeFunction pointer to write memory function for the DSP.
readDMAFunction pointer to read DMA function for the DSP.
writeDMAFunction pointer to write DMA function for the DSP. ============================================================================
typedef struct HAL_Interface_tag HAL_Interface

Typedef Documentation

typedef DSP_STATUS(* FnPhyInit)(IN void *halObject)
typedef DSP_STATUS(* FnPhyExit)(IN void *halObject)
typedef DSP_STATUS(* FnBootCtrl)(IN void *halObject, IN DSP_BootCtrlCmd cmd, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnIntCtrl)(IN void *halObject, IN DSP_IntCtrlCmd cmd, IN Uint32 intId, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnMmuCtrl)(IN void *halObject, IN DSP_MmuCtrlCmd cmd, IN LINKCFG_MemEntry *memTable, IN Uint32 memEntries, IN ProcMemMapInfo *mmuInfo)
typedef DSP_STATUS(* FnMapCtrl)(IN void *halObject, IN DSP_MapCtrlCmd cmd, IN Uint32 dspBufAddr, IN Uint32 size, OUT Uint32 *bufVirtPtr, OUT Uint32 *bufPhysAddr, OUT Uint32 *mappedSize)
typedef DSP_STATUS(* FnPwrCtrl)(IN void *halObject, IN DSP_PwrCtrlCmd cmd, IN OUT Pvoid arg)
typedef DSP_STATUS(* FnRead)(IN void *halObject, IN Uint32 dspAddr, IN Uint32 cBytes, OUT Char8 *readBuffer)
typedef DSP_STATUS(* FnWrite)(IN void *halObject, IN Uint32 dspAddr, IN Uint32 cBytes, IN Char8 *writeBuffer)
typedef DSP_STATUS(* FnReadDMA)(IN void *halObject, IN Uint32 srcAddr, IN Uint32 dstAddr, IN Uint32 size)
typedef DSP_STATUS(* FnWriteDMA)(IN void *halObject, IN Uint32 srcAddr, IN Uint32 dstAddr, IN Uint32 size)
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Copyright 2012, Texas Instruments Incorporated