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

da8xxgem_hal.h File Reference

Hardware Abstraction Layer for Power Controller (PWR) module in Primus. Declares necessary functions for PSC request handling. More...

#include <dsplink.h>
#include <_dsplink.h>
#include <_trace.h>
#include <hal.h>

Include dependency graph for da8xxgem_hal.h:

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

Go to the source code of this file.

Data Structures

struct  DA8XXGEM_HalObj_tag
struct  DA8XXGEM_InitParams_tag

DA8XXGEM_HalObj

Hardware Abstraction object.

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

Parameters:
interface Pointer to HAL interface table.
baseCfgBus base address of the configuration bus peripherals memory range.
offsetSysModule Offset of the system module from CFG base.
offsetPsc0 Offset of the PSC0 from CFG base. ============================================================================


typedef DA8XXGEM_HalObj_tag DA8XXGEM_HalObj

DA8XX_InitParams

Initialize parameters for HAL init call.

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

Parameters:
dspId Processor Identifier. ============================================================================


typedef DA8XXGEM_InitParams_tag DA8XXGEM_InitParams
NORMAL_API DSP_STATUS DA8XXGEM_halInit (IN Pvoid *halObj, IN Pvoid initParams)
 Initializes the HAL object.
NORMAL_API DSP_STATUS DA8XXGEM_halExit (IN Pvoid *halObj)
 Finalizes the HAL object.

Defines

#define DA8XXGEM_HAL_H
#define REG(x)   *((volatile Uint32 *) (x))
#define OFFSET_KICK0   0x038u
#define OFFSET_KICK1   0x03Cu
#define KICK0_UNLOCKVAL   0x83E70B13u
#define KICK1_UNLOCKVAL   0x95A4F1E0u


Detailed Description

Hardware Abstraction Layer for Power Controller (PWR) module in Primus. Declares necessary functions for PSC request handling.

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

Path:
/db/swcoe_asp/DSPLINK_Build/dsplink_linux_1_65_00_03/dsplink/gpp/inc/sys/arch/DA8XXGEM/
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 da8xxgem_hal.h.


Define Documentation

#define DA8XXGEM_HAL_H
 

Definition at line 46 of file da8xxgem_hal.h.

#define KICK0_UNLOCKVAL   0x83E70B13u
 

Definition at line 95 of file da8xxgem_hal.h.

#define KICK1_UNLOCKVAL   0x95A4F1E0u
 

Definition at line 103 of file da8xxgem_hal.h.

#define OFFSET_KICK0   0x038u
 

Definition at line 79 of file da8xxgem_hal.h.

#define OFFSET_KICK1   0x03Cu
 

Definition at line 87 of file da8xxgem_hal.h.

#define REG  )     *((volatile Uint32 *) (x))
 

Definition at line 71 of file da8xxgem_hal.h.


Typedef Documentation

typedef struct DA8XXGEM_HalObj_tag DA8XXGEM_HalObj
 

typedef struct DA8XXGEM_InitParams_tag DA8XXGEM_InitParams
 


Function Documentation

NORMAL_API DSP_STATUS DA8XXGEM_halExit IN Pvoid halObj  ) 
 

Finalizes the HAL object.

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

Function:
DA8XXGEM_halExit
Parameters:
halObj. Pointer to 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 DA8XXGEM_halInit IN Pvoid halObj,
IN Pvoid  initParams
 

Initializes the HAL object.

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

Function:
DA8XXGEM_halInitialize
Parameters:
halObj. Pointer to HAL object.
initParams. Parameters for initialize (optional).
Returns:
DSP_SOK Operation successfully completed. DSP_EMEMORY A memory allocation failure occurred. DSP_EINVALIDARG An invalid argument was specified.
Precondition:
None.
Postcondition:
None.
See also:
None ============================================================================


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