CORE/SME/inc/smeInternal.h

/*
 * Copyright (c) 2011-2018 The Linux Foundation. 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.
 */


#if !defined( __SMEINTERNAL_H )
#define __SMEINTERNAL_H


/**=========================================================================

  \file  smeInternal.h

  \brief prototype for SME internal structures and APIs used for SME and MAC

  ========================================================================*/

/* $Header$ */

/*--------------------------------------------------------------------------
  Include Files
  ------------------------------------------------------------------------*/
#include "vos_status.h"
#include "vos_lock.h"
#include "vos_trace.h"
#include "vos_memory.h"
#include "vos_types.h"
#include "vos_diag_core_event.h"
#include "csrLinkList.h"

/*--------------------------------------------------------------------------
  Type declarations
  ------------------------------------------------------------------------*/

// Mask can be only have one bit set
typedef enum eSmeCommandType
{
    eSmeNoCommand = 0,
    eSmeDropCommand,
    //CSR
    eSmeCsrCommandMask = 0x10000,   //this is not a command, it is to identify this is a CSR command
    eSmeCommandScan,
    eSmeCommandRoam,
    eSmeCommandWmStatusChange,
    eSmeCommandSetKey,
    eSmeCommandRemoveKey,
    eSmeCommandAddStaSession,
    eSmeCommandDelStaSession,
    eSmeCommandSetMaxTxPower,
    eSmeCommandSetMaxTxPowerPerBand,
#ifdef FEATURE_WLAN_TDLS
    //eSmeTdlsCommandMask = 0x80000,  //To identify TDLS commands <TODO>
    //These can be considered as csr commands.
    eSmeCommandTdlsSendMgmt,
    eSmeCommandTdlsAddPeer,
    eSmeCommandTdlsDelPeer,
    eSmeCommandTdlsLinkEstablish,
#endif
    //PMC
    eSmePmcCommandMask = 0x20000, //To identify PMC commands
    eSmeCommandEnterImps,
    eSmeCommandExitImps,
    eSmeCommandEnterBmps,
    eSmeCommandExitBmps,
    eSmeCommandEnterUapsd,
    eSmeCommandExitUapsd,
    eSmeCommandEnterWowl,
    eSmeCommandExitWowl,
    eSmeCommandEnterStandby,
    //QOS
    eSmeQosCommandMask = 0x40000,  //To identify Qos commands
    eSmeCommandAddTs,
    eSmeCommandDelTs,
#ifdef FEATURE_OEM_DATA_SUPPORT
    eSmeCommandOemDataReq = 0x80000, //To identify the oem data commands
#endif
    eSmeCommandRemainOnChannel,
    eSmeCommandNoAUpdate,
    eSmeCommandNdpInitiatorRequest,
    eSmeCommandNdpResponderRequest,
    eSmeCommandNdpDataEndInitiatorRequest,
} eSmeCommandType;


typedef enum eSmeState
{
    SME_STATE_STOP,
    SME_STATE_START,
    SME_STATE_READY,
} eSmeState;

#define SME_IS_START(pMac)  (SME_STATE_STOP != (pMac)->sme.state)
#define SME_IS_READY(pMac)  (SME_STATE_READY == (pMac)->sme.state)

/* HDD Callback function */
typedef void(*pIbssPeerInfoCb)(void *pUserData,
                               tSirPeerInfoRspParams *infoParam);

/* Peer info */
typedef struct tagSmePeerInfoHddCbkInfo
{
   void *pUserData;
   pIbssPeerInfoCb peerInfoCbk;
}tSmePeerInfoHddCbkInfo;


typedef struct sStatsExtEvent {
    tANI_U32 vdev_id;
    tANI_U32 event_data_len;
    tANI_U8 event_data[];
} tStatsExtEvent, *tpStatsExtEvent;

/**
 * struct stats_ext2_event - stats ext2 event
 * @hole_cnt: hole counter
 * @hole_info_array: hole informaton
 */
struct stats_ext2_event {
	uint32_t hole_cnt;
	uint32_t hole_info_array[];
};

#define MAX_ACTIVE_CMD_STATS    16

typedef struct sActiveCmdStats {
    eSmeCommandType command;
    tANI_U32 reason;
    tANI_U32 sessionId;
    v_U64_t timestamp;
} tActiveCmdStats;

typedef struct sSelfRecoveryStats {
    tActiveCmdStats activeCmdStats[MAX_ACTIVE_CMD_STATS];
    tANI_U8 cmdStatsIndx;
} tSelfRecoveryStats;

typedef void (*ocb_callback)(void *context, void *response);

typedef struct tagSmeStruct
{
    eSmeState state;
    vos_lock_t lkSmeGlobalLock;
    tANI_U32 totalSmeCmd;
    /* following pointer contains array of pointers for tSmeCmd* */
    void **pSmeCmdBufAddr;
    tDblLinkList smeCmdActiveList;
    tDblLinkList smeCmdPendingList;
    tDblLinkList smeCmdFreeList;   //preallocated roam cmd list
    void (*pTxPerHitCallback) (void *pCallbackContext); /* callback for Tx PER hit to HDD */
    void *pTxPerHitCbContext;
    tVOS_CON_MODE currDeviceMode;
#ifdef FEATURE_WLAN_LPHB
    void (*pLphbIndCb) (void *pHddCtx, tSirLPHBInd *indParam);
#endif /* FEATURE_WLAN_LPHB */
    //pending scan command list
    tDblLinkList smeScanCmdPendingList;
    //active scan command list
    tDblLinkList smeScanCmdActiveList;
    tSmePeerInfoHddCbkInfo peerInfoParams;
#ifdef FEATURE_WLAN_DIAG_SUPPORT_CSR
    vos_event_wlan_status_payload_type eventPayload;
#endif
#ifdef FEATURE_WLAN_CH_AVOID
    void (*pChAvoidNotificationCb) (void *hdd_context, void *indi_param);
#endif /* FEATURE_WLAN_CH_AVOID */
#ifdef WLAN_FEATURE_LINK_LAYER_STATS
    void(*pLinkLayerStatsIndCallback)(void *callbackContext,
                                        int indType, void *pRsp);
    void (*link_layer_stats_ext_cb)(tSirLLStatsResults *rsp);
#endif /* WLAN_FEATURE_LINK_LAYER_STATS */

#ifdef WLAN_POWER_DEBUGFS
    void *power_debug_stats_context;
    void(*power_stats_resp_callback)(struct power_stats_response *rsp,
				    void *callback_context);
#endif
#ifdef FEATURE_WLAN_AUTO_SHUTDOWN
    void (*pAutoShutdownNotificationCb) (void);
#endif
    /* Maximum interfaces allowed by the host */
    tANI_U8 max_intf_count;
    void (* StatsExtCallback) (void *, tStatsExtEvent *);
    /* link speed callback */
    void (*pLinkSpeedIndCb) (tSirLinkSpeedInfo *indParam, void *pDevContext);
    void *pLinkSpeedCbContext;
    /* get peer info callback */
    void (*pget_peer_info_ind_cb) (struct sir_peer_info_resp *param,
		    void *pcontext);
    void *pget_peer_info_cb_context;
    /* get extended peer info callback */
    void (*pget_peer_info_ext_ind_cb) (struct sir_peer_info_ext_resp *param,
		    void *pcontext);
    void *pget_peer_info_ext_cb_context;
    /* get isolation callback */
    void (*get_isolation) (struct sir_isolation_resp *param, void *context);
    void *get_isolation_cb_context;
#ifdef FEATURE_WLAN_EXTSCAN
    void (*pExtScanIndCb) (void *, const tANI_U16, void *);
#endif /* FEATURE_WLAN_EXTSCAN */
    void  (*pchain_rssi_ind_cb)(void *, void *);
#ifdef WLAN_FEATURE_NAN
    void (*nanCallback) (void*, tSirNanEvent*);
#endif

    int (*get_tsf_cb)(void *pcb_cxt, struct stsf *ptsf);
    void *get_tsf_cxt;

    v_BOOL_t enableSelfRecovery;
    tCsrLinkStatusCallback linkStatusCallback;
    void *linkStatusContext;
    tcsr_fw_state_callback fw_state_callback;
    void *fw_state_context;
    /* get temperature event context and callback */
    void *pTemperatureCbContext;
    void (*pGetTemperatureCb)(int temperature, void *context);
    uint8_t miracast_value;

    /* OCB callbacks */
    void *ocb_set_config_context;
    ocb_callback ocb_set_config_callback;
    void *ocb_get_tsf_timer_context;
    ocb_callback ocb_get_tsf_timer_callback;
    void *dcc_get_stats_context;
    ocb_callback dcc_get_stats_callback;
    void *dcc_update_ndl_context;
    ocb_callback dcc_update_ndl_callback;
    void *dcc_stats_event_context;
    ocb_callback dcc_stats_event_callback;
    void *radio_chan_stats_context;
    ocb_callback radio_chan_stats_callback;
    void (*set_thermal_level_cb)(void *hdd_context, uint8_t level);
#ifdef FEATURE_WLAN_THERMAL_SHUTDOWN
    void (*thermal_temp_ind_cb)(void *pContext, uint32_t degree_c);
#endif
    void (*rssi_threshold_breached_cb)(void *, struct rssi_breach_event *);
    void (*lost_link_info_cb)(void *context,
			      struct sir_lost_link_info *lost_link_info);
    void (*smps_force_mode_cb)(void *context,
			struct sir_smps_force_mode_event *smps_force_mode_info);
    void (*pbpf_get_offload_cb)(void *context, struct sir_bpf_get_offload *);
    void *mib_stats_context;
    void (*csr_mib_stats_callback) (struct mib_stats_metrics*, void*);
    void (*stats_ext2_cb)(void *, struct stats_ext2_event *);
    void (*chip_power_save_fail_cb)(void *,
			struct chip_pwr_save_fail_detected_params *);
} tSmeStruct, *tpSmeStruct;


#endif //#if !defined( __SMEINTERNAL_H )