hallow.h

mx27 f14v2 源代码。包括ADS板上诸多驱动的源码。

//---------------------------------------------------------------------------
//Copyright (C) 2006, Freescale Semiconductor, Inc. All Rights Reserved.
// THIS SOURCE CODE, AND ITS USE AND DISTRIBUTION, IS SUBJECT TO THE TERMS
// AND CONDITIONS OF THE APPLICABLE LICENSE AGREEMENT 
//--------------------------------------------------------------------------
//
// File:  hallow.h
// Header file for platform specific SDIO WLAN functions
//------------------------------------------------------------------------------
#ifndef CFSD_NDHALLOW_H
#define CFSD_NDHALLOW_H


//------------------------------------------------------------------------------
//               Included Headers                                      
//------------------------------------------------------------------------------

#include "precomp.h"


//------------------------------------------------------------------------------
//               Public Constant Defintions                       
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//               Public Macro Definitions                              
//------------------------------------------------------------------------------


//------------------------------------------------------------------------------
//               Public Type Definitions                               
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//               Public Variable Declarations                         
//------------------------------------------------------------------------------


//------------------------------------------------------------------------------
//               Public Function Prototypes                            
//------------------------------------------------------------------------------
//-----------------------------------------------------------------------------
//
// NAME         vHALwriteRegister
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				    ulOffset	Offset of control register.
//              ulValue		The value to be written.
//
// RETURNS      na
//
// DESCRIPTION  Write control register.
//
//-----------------------------------------------------------------------------
VOID vHALwriteRegister( IN PHAL_CONTEXT psHAL, IN ULONG ulOffset, IN ULONG ulValue );

//-----------------------------------------------------------------------------
//
// NAME         vHALreadRegister
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulOffset	Offset of control register.
//              pulValue	Pointer to the value.
//
// RETURNS      na
//
// DESCRIPTION  Read control register.
//
//-----------------------------------------------------------------------------
VOID vHALreadRegister( IN PHAL_CONTEXT psHAL, IN ULONG ulOffset, OUT PULONG pulValue );

//-----------------------------------------------------------------------------
//
// NAME         vHALwriteIMem
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulAddress	Offset in IMEM (0-0x1FFF).
//              pulSource	Pointer to the host memory.
//              ulLength	The number of bytes to write.
//
// RETURNS      na
//
// DESCRIPTION  This function is used to transfer blocks of memory from the
//              host to the card IMEM using the HAL.
//
//-----------------------------------------------------------------------------
VOID vHALwriteIMem(IN PHAL_CONTEXT psHAL,IN ULONG ulAddress, IN PULONG pulSource, IN ULONG ulLength );

//-----------------------------------------------------------------------------
//
// NAME         vHALreadIMem
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulAddress	Offset in IMEM (0-0x1FFF).
//              pulDest		Pointer to the host memory.
//              ulLength	The number of bytes to read.
//
// RETURNS      na
//
// DESCRIPTION  This function is used to transfer blocks of memory from the
//              the card IMEM to host using the HAL.
//
//-----------------------------------------------------------------------------
VOID vHALreadIMem(IN PHAL_CONTEXT psHAL, IN ULONG ulAddress, OUT PULONG pulDest, IN ULONG ulLength );

//-----------------------------------------------------------------------------
//
// NAME         vHALwriteMailbox
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulAddress	Offset in Mailbox (0x2000-0x27FF).
//              pulSource	Pointer to the host memory.
//              ulLength    The number of bytes to write.
//
// RETURNS      na
//
// DESCRIPTION  This function is used to transfer blocks of memory from the
//              host to the card Mailbox using the HAL.
//
//-----------------------------------------------------------------------------
VOID vHALwriteMailbox( IN PHAL_CONTEXT psHAL,    IN ULONG ulAddress, IN PULONG pulSource, IN ULONG ulLength );

//-----------------------------------------------------------------------------
//
// NAME         vHALreadMailbox
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulAddress	Offset in Mailbox (0x2000-0x27FF).
//              pulDest		Pointer to the host memory.
//              ulLength	The number of bytes to read.
//
// RETURNS      na
//
// DESCRIPTION  This function is used to transfer blocks of memory from the
//              card Mailbox to host using the HAL.
//
//-----------------------------------------------------------------------------
VOID vHALreadMailbox(IN PHAL_CONTEXT psHAL, IN ULONG ulAddress, OUT PULONG pulDest, IN ULONG ulLength );

//-----------------------------------------------------------------------------
//
// NAME         boHALacquireSemaphore
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulSemaphore	Index of semaphore.
//
// RETURNS      TRUE if successfully acquire semaphore, FALSE otherwise.
//
// DESCRIPTION  This function is used to acquire semaphore.
//
//-----------------------------------------------------------------------------
BOOLEAN boHALacquireSemaphore( IN PHAL_CONTEXT psHAL, IN ULONG ulSemaphore );

//-----------------------------------------------------------------------------
//
// NAME         vHALreleaseSemaphore
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//				ulSemaphore	Index of semaphore.
//
// RETURNS      na
//
// DESCRIPTION  This function is used to release semaphore.
//
//-----------------------------------------------------------------------------
VOID vHALreleaseSemaphore( IN PHAL_CONTEXT psHAL, IN ULONG ulSemaphore );

//-----------------------------------------------------------------------------
//
// NAME         vHALsoftReset
// 
// PARAMETERS   psHAL		Pointer to HAL context.
//
// RETURNS      na
//
// DESCRIPTION  Write configuration register to reset the device.
//
//-----------------------------------------------------------------------------

VOID vHALsoftReset( IN PHAL_CONTEXT psHAL );

//-----------------------------------------------------------------------------
//
// NAME     vHALinterruptDevice
// 
// PARAMETERS  psHAL    Pointer to HAL context.
//    ulIntMask   Interrupt bit mask.
//          ulIntOffset Interrupt bit offset.
//
// RETURNS  na
//
// DESCRIPTION Generate interrupt to device.
//
//-----------------------------------------------------------------------------
VOID vHALinterruptDevice( IN PHAL_CONTEXT psHAL, IN ULONG ulIntMask, IN ULONG ulIntOffset );

//-----------------------------------------------------------------------------
//
// NAME     vHALenableInterrupt
// 
// PARAMETERS  psHAL    Pointer to HAL context.
//
// RETURNS  na
//
// DESCRIPTION Enable device interrupt.
//
//-----------------------------------------------------------------------------
VOID vHALenableInterrupt( IN PHAL_CONTEXT psHAL );

//-----------------------------------------------------------------------------
//
// NAME     vHALdisableInterrupt
// 
// PARAMETERS  psHAL    Pointer to HAL context.
//
// RETURNS  na
//
// DESCRIPTION Disable device interrupt.
//
//-----------------------------------------------------------------------------
VOID vHALdisableInterrupt( IN PHAL_CONTEXT psHAL );



#endif /* CFSD_NDHALLOW_H */