9af1257ebb
wlanfw_cmn: fix spelling errors in code comments Fix spelling errors in code comments within the .h files that define the host/target interface. Change-Id: I98c7b607238adacf7b8615b60ffb3bcef482815a CRs-Fixed: 2262693
182 lines
5.6 KiB
C
182 lines
5.6 KiB
C
/*
|
|
* Copyright (c) 2012-2016, 2020 The Linux Foundation. All rights reserved.
|
|
* Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
|
|
*
|
|
* Previously licensed under the ISC license by Qualcomm Atheros, Inc.
|
|
*
|
|
*
|
|
* Permission to use, copy, modify, and/or distribute this software for
|
|
* any purpose with or without fee is hereby granted, provided that the
|
|
* above copyright notice and this permission notice appear in all
|
|
* copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
|
|
* WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
|
|
* AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
|
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
|
|
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
|
|
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
|
|
/*
|
|
* This file was originally distributed by Qualcomm Atheros, Inc.
|
|
* under proprietary terms before Copyright ownership was assigned
|
|
* to the Linux Foundation.
|
|
*/
|
|
|
|
/**
|
|
* @file htt_common.h
|
|
*
|
|
* @details the public header file of HTT layer shared between host and firmware
|
|
*/
|
|
|
|
#ifndef _HTT_COMMON_H_
|
|
#define _HTT_COMMON_H_
|
|
|
|
#include <htt_deps.h> /* A_UINT32 */
|
|
|
|
enum htt_sec_type {
|
|
htt_sec_type_none,
|
|
htt_sec_type_wep128,
|
|
htt_sec_type_wep104,
|
|
htt_sec_type_wep40,
|
|
htt_sec_type_tkip,
|
|
htt_sec_type_tkip_nomic,
|
|
htt_sec_type_aes_ccmp,
|
|
htt_sec_type_wapi,
|
|
htt_sec_type_aes_ccmp_256,
|
|
htt_sec_type_aes_gcmp,
|
|
htt_sec_type_aes_gcmp_256,
|
|
|
|
/* keep this last! */
|
|
htt_num_sec_types
|
|
};
|
|
|
|
enum htt_rx_ind_mpdu_status {
|
|
HTT_RX_IND_MPDU_STATUS_UNKNOWN = 0x0,
|
|
HTT_RX_IND_MPDU_STATUS_OK,
|
|
HTT_RX_IND_MPDU_STATUS_ERR_FCS,
|
|
HTT_RX_IND_MPDU_STATUS_ERR_DUP,
|
|
HTT_RX_IND_MPDU_STATUS_ERR_REPLAY,
|
|
HTT_RX_IND_MPDU_STATUS_ERR_INV_PEER,
|
|
HTT_RX_IND_MPDU_STATUS_UNAUTH_PEER, /* only accept EAPOL frames */
|
|
HTT_RX_IND_MPDU_STATUS_OUT_OF_SYNC,
|
|
HTT_RX_IND_MPDU_STATUS_MGMT_CTRL, /* Non-data in promiscuous mode */
|
|
HTT_RX_IND_MPDU_STATUS_TKIP_MIC_ERR,
|
|
HTT_RX_IND_MPDU_STATUS_DECRYPT_ERR,
|
|
HTT_RX_IND_MPDU_STATUS_MPDU_LENGTH_ERR,
|
|
HTT_RX_IND_MPDU_STATUS_ENCRYPT_REQUIRED_ERR,
|
|
HTT_RX_IND_MPDU_STATUS_PRIVACY_ERR,
|
|
|
|
/*
|
|
* MISC: discard for unspecified reasons.
|
|
* Leave this enum value last.
|
|
*/
|
|
HTT_RX_IND_MPDU_STATUS_ERR_MISC = 0xFF
|
|
};
|
|
|
|
#define HTT_INVALID_PEER 0xffff
|
|
#define HTT_INVALID_VDEV 0xff
|
|
|
|
#define HTT_NON_QOS_TID 16
|
|
#define HTT_INVALID_TID 31
|
|
|
|
#define HTT_TX_EXT_TID_DEFAULT 0
|
|
#define HTT_TX_EXT_TID_NON_QOS_MCAST_BCAST HTT_NON_QOS_TID
|
|
#define HTT_TX_EXT_TID_MGMT 17
|
|
#define HTT_TX_EXT_TID_INVALID HTT_INVALID_TID
|
|
#define HTT_TX_EXT_TID_NONPAUSE 19
|
|
|
|
|
|
|
|
#define HTT_TX_L3_CKSUM_OFFLOAD 1
|
|
#define HTT_TX_L4_CKSUM_OFFLOAD 2
|
|
|
|
|
|
/**
|
|
* @brief General specification of the tx frame contents
|
|
*
|
|
* @details
|
|
* For efficiency, the HTT packet type values correspond
|
|
* to the bit positions of the WAL packet type values, so the
|
|
* translation is a simple shift operation.
|
|
* The exception is the "mgmt" type, which specifies frame payload
|
|
* type rather than L2 header type.
|
|
*/
|
|
enum htt_pkt_type {
|
|
htt_pkt_type_raw = 0,
|
|
htt_pkt_type_native_wifi = 1,
|
|
htt_pkt_type_ethernet = 2,
|
|
htt_pkt_type_mgmt = 3,
|
|
htt_pkt_type_eth2 = 4,
|
|
|
|
/* keep this last */
|
|
htt_pkt_num_types
|
|
};
|
|
|
|
/*
|
|
* TX MSDU ID partition -
|
|
* FW supports bigger MSDU ID partition which is defined as
|
|
* HTT_TX_IPA_NEW_MSDU_ID_SPACE_BEGIN
|
|
* When both host and FW support new partition, FW uses
|
|
* HTT_TX_IPA_NEW_MSDU_ID_SPACE_BEGIN
|
|
* If host doesn't support, FW falls back to HTT_TX_IPA_MSDU_ID_SPACE_BEGIN
|
|
* Handshaking is done through WMI_READY and WMI_INIT
|
|
*/
|
|
#define HTT_TX_HOST_MSDU_ID_SPACE_BEGIN 0
|
|
#define HTT_TX_IPA_MSDU_ID_SPACE_BEGIN 3000
|
|
#define TGT_RX2TX_MSDU_ID_SPACE_BEGIN 6000
|
|
#define HTT_TX_IPA_NEW_MSDU_ID_SPACE_BEGIN 8192 /* = 0x2000 = b10,0000,0000,0000 */
|
|
#define TGT_RX2TX_NEW_MSDU_ID_SPACE_BEGIN 12288 /* = 0x3000 = b11,0000,0000,0000 */
|
|
|
|
/* HTT Access Category values */
|
|
enum HTT_AC_WMM {
|
|
/* WMM Access Categories */
|
|
HTT_AC_WMM_BE = 0x0,
|
|
HTT_AC_WMM_BK = 0x1,
|
|
HTT_AC_WMM_VI = 0x2,
|
|
HTT_AC_WMM_VO = 0x3,
|
|
|
|
HTT_NUM_AC_WMM = 0x4,
|
|
|
|
/* extension Access Categories */
|
|
HTT_AC_EXT_NON_QOS = 0x4,
|
|
HTT_AC_EXT_UCAST_MGMT = 0x5,
|
|
HTT_AC_EXT_MCAST_DATA = 0x6,
|
|
HTT_AC_EXT_MCAST_MGMT = 0x7,
|
|
};
|
|
|
|
enum HTT_AC_WMM_MASK {
|
|
/* WMM Access Categories */
|
|
HTT_AC_WMM_BE_MASK = (1 << HTT_AC_WMM_BE),
|
|
HTT_AC_WMM_BK_MASK = (1 << HTT_AC_WMM_BK),
|
|
HTT_AC_WMM_VI_MASK = (1 << HTT_AC_WMM_VI),
|
|
HTT_AC_WMM_VO_MASK = (1 << HTT_AC_WMM_VO),
|
|
/* extension Access Categories */
|
|
HTT_AC_EXT_NON_QOS_MASK = (1 << HTT_AC_EXT_NON_QOS),
|
|
HTT_AC_EXT_UCAST_MGMT_MASK = (1 << HTT_AC_EXT_UCAST_MGMT),
|
|
HTT_AC_EXT_MCAST_DATA_MASK = (1 << HTT_AC_EXT_MCAST_DATA),
|
|
HTT_AC_EXT_MCAST_MGMT_MASK = (1 << HTT_AC_EXT_MCAST_MGMT),
|
|
};
|
|
#define HTT_AC_MASK_WMM \
|
|
(HTT_AC_WMM_BE_MASK | HTT_AC_WMM_BK_MASK | \
|
|
HTT_AC_WMM_VI_MASK | HTT_AC_WMM_VO_MASK)
|
|
#define HTT_AC_MASK_EXT \
|
|
(HTT_AC_EXT_NON_QOS_MASK | HTT_AC_EXT_UCAST_MGMT_MASK | \
|
|
HTT_AC_EXT_MCAST_DATA_MASK | HTT_AC_EXT_MCAST_MGMT_MASK)
|
|
#define HTT_AC_MASK_ALL (HTT_AC_MASK_WMM | HTT_AC_MASK_EXT)
|
|
|
|
/** 2 word representation of MAC addr */
|
|
typedef struct {
|
|
/** upper 4 bytes of MAC address */
|
|
A_UINT32 mac_addr31to0;
|
|
/** lower 2 bytes of MAC address */
|
|
A_UINT32 mac_addr47to32;
|
|
} htt_mac_addr;
|
|
|
|
#define HTT_STATS_MAX_CHAINS 8
|
|
|
|
#endif /* _HTT_COMMON_H_ */
|