blob: fdc1f9920137443ccf90bf6c4ba7de97e73819d8 [file] [log] [blame]
/******************************************************************************
*
* This file is provided under a dual license. When you use or
* distribute this software, you may choose to be licensed under
* version 2 of the GNU General Public License ("GPLv2 License")
* or BSD License.
*
* GPLv2 License
*
* Copyright(C) 2016 MediaTek Inc.
*
* 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 http://www.gnu.org/licenses/gpl-2.0.html for more details.
*
* BSD LICENSE
*
* Copyright(C) 2016 MediaTek Inc. All rights reserved.
*
* 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 the copyright holder 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
* HOLDER 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.
*
*****************************************************************************/
/*
** Id: //Department/DaVinci/BRANCHES/MT6620_WIFI_DRIVER_V2_3/include/nic/hif_rx.h#1
*/
/*! \file "hif_rx.h"
* \brief Provide HIF RX Header Information between F/W and Driver
*
* N/A
*/
#ifndef _HIF_RX_H
#define _HIF_RX_H
/*******************************************************************************
* C O M P I L E R F L A G S
********************************************************************************
*/
/*******************************************************************************
* E X T E R N A L R E F E R E N C E S
********************************************************************************
*/
/*******************************************************************************
* C O N S T A N T S
********************************************************************************
*/
/*! HIF_RX_HEADER_T */
/* DW 0, Byte 1 */
#define HIF_RX_HDR_PACKET_TYPE_MASK BITS(0, 1)
/* DW 1, Byte 0 */
#define HIF_RX_HDR_HEADER_LEN BITS(2, 7)
#define HIF_RX_HDR_HEADER_LEN_OFFSET 2
#define HIF_RX_HDR_HEADER_OFFSET_MASK BITS(0, 1)
/* DW 1, Byte 1 */
#define HIF_RX_HDR_80211_HEADER_FORMAT BIT(0)
#define HIF_RX_HDR_DO_REORDER BIT(1)
#define HIF_RX_HDR_PAL BIT(2)
#define HIF_RX_HDR_TCL BIT(3)
#define HIF_RX_HDR_NETWORK_IDX_MASK BITS(4, 7)
#define HIF_RX_HDR_NETWORK_IDX_OFFSET 4
/* DW 1, Byte 2, 3 */
#define HIF_RX_HDR_SEQ_NO_MASK BITS(0, 11)
#define HIF_RX_HDR_TID_MASK BITS(12, 14)
#define HIF_RX_HDR_TID_OFFSET 12
#define HIF_RX_HDR_BAR_FRAME BIT(15)
#define HIF_RX_HDR_FLAG_AMP_WDS BIT(0)
#define HIF_RX_HDR_FLAG_802_11_FORMAT BIT(1)
#define HIF_RX_HDR_FLAG_BAR_FRAME BIT(2)
#define HIF_RX_HDR_FLAG_DO_REORDERING BIT(3)
#define HIF_RX_HDR_FLAG_CTRL_WARPPER_FRAME BIT(4)
#define HIF_RX_HW_APPENDED_LEN 4
/* For DW 2, Byte 3 - ucHwChannelNum */
#define HW_CHNL_NUM_MAX_2G4 14
#define HW_CHNL_NUM_MAX_4G_5G (255 - HW_CHNL_NUM_MAX_2G4)
/*******************************************************************************
* D A T A T Y P E S
********************************************************************************
*/
/*******************************************************************************
* P U B L I C D A T A
********************************************************************************
*/
/*******************************************************************************
* P R I V A T E D A T A
********************************************************************************
*/
/*******************************************************************************
* M A C R O S
********************************************************************************
*/
/*******************************************************************************
* F U N C T I O N D E C L A R A T I O N S
********************************************************************************
*/
static __KAL_INLINE__ VOID hifDataTypeCheck(VOID);
/*******************************************************************************
* F U N C T I O N S
********************************************************************************
*/
/* Kevin: we don't have to call following function to inspect the data structure.
* It will check automatically while at compile time.
* We'll need this for porting driver to different RTOS.
*/
static __KAL_INLINE__ VOID hifDataTypeCheck(VOID)
{
}
#endif