/*
 * Copyright (c) 2011-2019, 2021 The Linux Foundation. All rights reserved.
 * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved.
 *
 * 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 ani_system_defs.h contains definitions used by
 * various ANI entities
 * Author:    Chandra Modumudi
 * Date:      09/18/2002
 * History:-
 * Date       Modified by    Modification Information
 * --------------------------------------------------------------------
 */

#ifndef __ANI_SYSTEM_DEFS_H
#define __ANI_SYSTEM_DEFS_H

#include "sir_types.h"
#include "sir_mac_prot_def.h"
#include "wlan_crypto_global_def.h"

/* This is to force compiler to use the maximum of an int for enum */
#define SIR_MAX_ENUM_SIZE    0x7FFFFFFF

#ifndef false
#undef false
#define false   0
#endif
#ifndef true
#undef true
#define true    1
#endif

/* / Authentication type enum used with peer */
typedef enum eAniAuthType {
	eSIR_OPEN_SYSTEM,
	eSIR_SHARED_KEY,
	eSIR_FT_AUTH,
	eSIR_AUTH_TYPE_SAE = 3,
#if defined FEATURE_WLAN_ESE
	eSIR_LEAP_AUTH = 0x80,
#endif
	SIR_FILS_SK_WITHOUT_PFS = 4,
	SIR_FILS_SK_WITH_PFS = 5,
	SIR_FILS_PK_AUTH = 6,
	eSIR_AUTH_TYPE_PASN = 7,
	eSIR_AUTH_TYPE_OWE,
	eSIR_AUTO_SWITCH,
	eSIR_DONOT_USE_AUTH_TYPE = SIR_MAX_ENUM_SIZE
} tAniAuthType;

enum ani_akm_type {
	ANI_AKM_TYPE_NONE,
	ANI_AKM_TYPE_RSN,
	ANI_AKM_TYPE_RSN_PSK,
	ANI_AKM_TYPE_FT_RSN,
	ANI_AKM_TYPE_FT_RSN_PSK,
	ANI_AKM_TYPE_RSN_PSK_SHA256,
	ANI_AKM_TYPE_RSN_8021X_SHA256,
	ANI_AKM_TYPE_SAE,
	ANI_AKM_TYPE_FT_SAE,
	ANI_AKM_TYPE_SUITEB_EAP_SHA256,
	ANI_AKM_TYPE_SUITEB_EAP_SHA384,
	ANI_AKM_TYPE_FT_SUITEB_EAP_SHA384,
	ANI_AKM_TYPE_FILS_SHA256,
	ANI_AKM_TYPE_FILS_SHA384,
	ANI_AKM_TYPE_FT_FILS_SHA256,
	ANI_AKM_TYPE_FT_FILS_SHA384,
	ANI_AKM_TYPE_OWE,
	ANI_AKM_TYPE_CCKM,
	ANI_AKM_TYPE_OSEN,
	ANI_AKM_TYPE_DPP_RSN,
	ANI_AKM_TYPE_WPA,
	ANI_AKM_TYPE_WPA_PSK,
	ANI_AKM_TYPE_SAE_EXT_KEY,
	ANI_AKM_TYPE_FT_SAE_EXT_KEY,
	ANI_NUM_OF_SUPPORT_AKM_TYPE,
	ANI_AKM_TYPE_UNKNOWN = 0xff,
};

/* / Encryption type enum used with peer */
typedef enum eAniEdType {
	eSIR_ED_NONE,
	eSIR_ED_WEP40,
	eSIR_ED_WEP104,
	eSIR_ED_TKIP,
	eSIR_ED_CCMP,
#if defined(FEATURE_WLAN_WAPI)
	eSIR_ED_WPI,
#endif
	/*DPU HW treats encryption mode 4 plus RMF bit set in TX BD as BIP.
	   Thus while setting BIP encryption mode in corresponding DPU Desc
	   eSIR_ED_AES_128_CMAC should be set to eSIR_ED_CCMP */
	eSIR_ED_AES_128_CMAC,
	/* Firmware uses key length to find GCMP 128 or 256 */
	eSIR_ED_GCMP,
	eSIR_ED_GCMP_256,
	eSIR_ED_AES_GMAC_128,
	eSIR_ED_AES_GMAC_256,
	eSIR_ED_NOT_IMPLEMENTED = SIR_MAX_ENUM_SIZE
} tAniEdType;

typedef struct sAniSSID {
	uint8_t length;
	uint8_t ssId[WLAN_SSID_MAX_LEN];
} tAniSSID, *tpAniSSID;

/* / RSN IE information */
typedef struct sSirRSNie {
	uint16_t length;
	uint8_t rsnIEdata[WLAN_MAX_IE_LEN + 2];
} tSirRSNie, *tpSirRSNie;

typedef struct sSirWAPIie {
	uint16_t length;
	uint8_t wapiIEdata[WLAN_MAX_IE_LEN + 2];
} tSirWAPIie, *tpSirWAPIie;
/* / Additional IE information : */
/* / This can include WSC IE, P2P IE, and/or FTIE from upper layer. */
/* / MAC layer transparently convey these IE info between peer STA and upper layer, */
/* / but never requires to parse it. */
typedef struct sSirAddie {
	uint16_t length;
	uint8_t addIEdata[SIR_MAC_MAX_ADD_IE_LENGTH + 2];
} tSirAddie, *tpSirAddie;

#define SIR_CIPHER_SEQ_CTR_SIZE 6
/* / Definition for MIC failure indication */
typedef struct sSirMicFailureInfo {
	tSirMacAddr srcMacAddr; /* address used to compute MIC */
	tSirMacAddr taMacAddr;  /* transmitter address */
	tSirMacAddr dstMacAddr;
	bool multicast;
	uint8_t IV1;            /* first byte of IV */
	uint8_t keyId;          /* second byte of IV */
	uint8_t TSC[SIR_CIPHER_SEQ_CTR_SIZE];   /* sequence number */
	tSirMacAddr rxMacAddr;  /* receive address */

} tSirMicFailureInfo, *tpSirMicFailureInfo;

typedef struct sTrafStrmMetrics {
	uint8_t RoamingCount;
	uint16_t RoamingDly;
} qdf_packed tTrafStrmMetrics, *tpTrafStrmMetrics;

typedef struct sBcnReportFields {
	uint8_t ChanNum;
	uint8_t Spare;
	uint16_t MeasDuration;
	uint8_t PhyType;
	uint8_t RecvSigPower;
	tSirMacAddr Bssid;
	uint32_t ParentTsf;
	uint32_t TargetTsf[2];
	uint16_t BcnInterval;
	uint16_t CapabilityInfo;
} qdf_packed tBcnReportFields, *tpBcnReportFields;

#endif /* __ANI_SYSTEM_DEFS_H */