rtl8188eu/hal/odm_interface.h
Larry Finger 592c85f4e2 rtl8188eu: Convert C90 comments
Signed-off-by: Larry Finger <Larry.Finger@lwfinger.net>
2015-02-19 18:51:33 -06:00

321 lines
6.1 KiB
C
Executable file

/******************************************************************************
*
* Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of version 2 of the GNU General Public License as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
* more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
*
*
******************************************************************************/
#ifndef __ODM_INTERFACE_H__
#define __ODM_INTERFACE_H__
/* */
/* =========== Constant/Structure/Enum/... Define */
/* */
/* */
/* =========== Macro Define */
/* */
#define _reg_all(_name) ODM_##_name
#define _reg_ic(_name, _ic) ODM_##_name##_ic
#define _bit_all(_name) BIT_##_name
#define _bit_ic(_name, _ic) BIT_##_name##_ic
/*===================================
#define ODM_REG_DIG_11N 0xC50
#define ODM_REG_DIG_11AC 0xDDD
ODM_REG(DIG,_pDM_Odm)
=====================================*/
#define _reg_11N(_name) ODM_REG_##_name##_11N
#define _reg_11AC(_name) ODM_REG_##_name##_11AC
#define _bit_11N(_name) ODM_BIT_##_name##_11N
#define _bit_11AC(_name) ODM_BIT_##_name##_11AC
#define _cat(_name, _ic_type, _func) \
( \
((_ic_type) & ODM_IC_11N_SERIES)? _func##_11N(_name): \
_func##_11AC(_name) \
)
/* _name: name of register or bit. */
/* Example: "ODM_REG(R_A_AGC_CORE1, pDM_Odm)" */
/* gets "ODM_R_A_AGC_CORE1" or "ODM_R_A_AGC_CORE1_8192C", depends on SupportICType. */
#define ODM_REG(_name, _pDM_Odm) _cat(_name, _pDM_Odm->SupportICType, _reg)
#define ODM_BIT(_name, _pDM_Odm) _cat(_name, _pDM_Odm->SupportICType, _bit)
typedef enum _ODM_H2C_CMD
{
ODM_H2C_RSSI_REPORT = 0,
ODM_H2C_PSD_RESULT=1,
ODM_H2C_PathDiv = 2,
ODM_MAX_H2CCMD
}ODM_H2C_CMD;
/* */
/* 2012/02/17 MH For non-MP compile pass only. Linux does not support workitem. */
/* Suggest HW team to use thread instead of workitem. Windows also support the feature. */
/* */
typedef void *PRT_WORK_ITEM ;
typedef void RT_WORKITEM_HANDLE,*PRT_WORKITEM_HANDLE;
typedef void (*RT_WORKITEM_CALL_BACK)(void * pContext);
/* */
/* =========== Extern Variable ??? It should be forbidden. */
/* */
/* */
/* =========== EXtern Function Prototype */
/* */
u8
ODM_Read1Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr
);
u16
ODM_Read2Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr
);
u32
ODM_Read4Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr
);
void
ODM_Write1Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u8 Data
);
void
ODM_Write2Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u16 Data
);
void
ODM_Write4Byte(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u32 Data
);
void
ODM_SetMACReg(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u32 BitMask,
IN u32 Data
);
u32
ODM_GetMACReg(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u32 BitMask
);
void
ODM_SetBBReg(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u32 BitMask,
IN u32 Data
);
u32
ODM_GetBBReg(
IN PDM_ODM_T pDM_Odm,
IN u32 RegAddr,
IN u32 BitMask
);
void
ODM_SetRFReg(
IN PDM_ODM_T pDM_Odm,
IN ODM_RF_RADIO_PATH_E eRFPath,
IN u32 RegAddr,
IN u32 BitMask,
IN u32 Data
);
u32
ODM_GetRFReg(
IN PDM_ODM_T pDM_Odm,
IN ODM_RF_RADIO_PATH_E eRFPath,
IN u32 RegAddr,
IN u32 BitMask
);
/* */
/* Memory Relative Function. */
/* */
void
ODM_AllocateMemory(
IN PDM_ODM_T pDM_Odm,
OUT void * *pPtr,
IN u32 length
);
void
ODM_FreeMemory(
IN PDM_ODM_T pDM_Odm,
OUT void * pPtr,
IN u32 length
);
s32 ODM_CompareMemory(
IN PDM_ODM_T pDM_Odm,
IN void * pBuf1,
IN void * pBuf2,
IN u32 length
);
/* */
/* ODM MISC-spin lock relative API. */
/* */
void
ODM_AcquireSpinLock(
IN PDM_ODM_T pDM_Odm,
IN RT_SPINLOCK_TYPE type
);
void
ODM_ReleaseSpinLock(
IN PDM_ODM_T pDM_Odm,
IN RT_SPINLOCK_TYPE type
);
/* */
/* ODM MISC-workitem relative API. */
/* */
void
ODM_InitializeWorkItem(
IN PDM_ODM_T pDM_Odm,
IN PRT_WORK_ITEM pRtWorkItem,
IN RT_WORKITEM_CALL_BACK RtWorkItemCallback,
IN void * pContext,
IN const char* szID
);
void
ODM_StartWorkItem(
IN PRT_WORK_ITEM pRtWorkItem
);
void
ODM_StopWorkItem(
IN PRT_WORK_ITEM pRtWorkItem
);
void
ODM_FreeWorkItem(
IN PRT_WORK_ITEM pRtWorkItem
);
void
ODM_ScheduleWorkItem(
IN PRT_WORK_ITEM pRtWorkItem
);
void
ODM_IsWorkItemScheduled(
IN PRT_WORK_ITEM pRtWorkItem
);
/* */
/* ODM Timer relative API. */
/* */
void
ODM_StallExecution(
IN u32 usDelay
);
void
ODM_delay_ms(IN u32 ms);
void
ODM_delay_us(IN u32 us);
void
ODM_sleep_ms(IN u32 ms);
void
ODM_sleep_us(IN u32 us);
void
ODM_SetTimer(
IN PDM_ODM_T pDM_Odm,
IN PRT_TIMER pTimer,
IN u32 msDelay
);
void
ODM_InitializeTimer(
IN PDM_ODM_T pDM_Odm,
IN PRT_TIMER pTimer,
IN RT_TIMER_CALL_BACK CallBackFunc,
IN void * pContext,
IN const char* szID
);
void
ODM_CancelTimer(
IN PDM_ODM_T pDM_Odm,
IN PRT_TIMER pTimer
);
void
ODM_ReleaseTimer(
IN PDM_ODM_T pDM_Odm,
IN PRT_TIMER pTimer
);
/* */
/* ODM FW relative API. */
/* */
u32
ODM_FillH2CCmd(
IN u8 * pH2CBuffer,
IN u32 H2CBufferLen,
IN u32 CmdNum,
IN u32 * pElementID,
IN u32 * pCmdLen,
IN u8 ** pCmbBuffer,
IN u8 * CmdStartSeq
);
#endif /* __ODM_INTERFACE_H__ */