include/nic_init_cmd_event.h - manifest_repos/gen4-mt7663 - Git at Google

 /******************************************************************************
  *
  * 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_init_cmd_event.h#1
  */

 /*! \file   "nic_init_cmd_event.h"
  *    \brief This file contains the declairation file of the WLAN
  *    initialization routines for MediaTek Inc. 802.11 Wireless LAN Adapters.
  */

 #ifndef _NIC_INIT_CMD_EVENT_H
 #define _NIC_INIT_CMD_EVENT_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
  *******************************************************************************
  */

 #include "gl_typedef.h"

 /*******************************************************************************
  *                              C O N S T A N T S
  *******************************************************************************
  */
 #define INIT_CMD_STATUS_SUCCESS                 0
 #define INIT_CMD_STATUS_REJECTED_INVALID_PARAMS 1
 #define INIT_CMD_STATUS_REJECTED_CRC_ERROR      2
 #define INIT_CMD_STATUS_REJECTED_DECRYPT_FAIL   3
 #define INIT_CMD_STATUS_UNKNOWN                 4

 #define INIT_PKT_FT_CMD				0x2
 #define INIT_PKT_FT_PDA_FWDL		0x3

 #define INIT_CMD_PQ_ID              (0x8000)
 #define INIT_CMD_PACKET_TYPE_ID     (0xA0)

 #define INIT_CMD_PDA_PQ_ID          (0xF800)
 #define INIT_CMD_PDA_PACKET_TYPE_ID (0xA0)

 #if (CFG_UMAC_GENERATION >= 0x20)
 #define TXD_Q_IDX_MCU_RQ0   0
 #define TXD_Q_IDX_MCU_RQ1   1
 #define TXD_Q_IDX_MCU_RQ2   2
 #define TXD_Q_IDX_MCU_RQ3   3

 #define TXD_Q_IDX_PDA_FW_DL 0x1E

 /* DW0 Bit31 */
 #define TXD_P_IDX_LMAC  0
 #define TXD_P_IDX_MCU   1

 /* DW1 Bit 14:13 */
 #define TXD_HF_NON_80211_FRAME      0x0
 #define TXD_HF_CMD                  0x1
 #define TXD_HF_80211_NORMAL         0x2
 #define TXD_HF_80211_ENHANCEMENT    0x3

 /* DW1 Bit 15 */
 #define TXD_FT_OFFSET               15
 #define TXD_FT_SHORT_FORMAT         0x0
 #define TXD_FT_LONG_FORMAT          0x1

 /* DW1 Bit 16 */
 #define TXD_TXDLEN_OFFSET           16
 #define TXD_TXDLEN_1PAGE             0x0
 #define TXD_TXDLEN_2PAGE             0x1

 /* DW1 Bit 25:24 */
 #define TXD_PKT_FT_CUT_THROUGH      0x0
 #define TXD_PKT_FT_STORE_FORWARD    0X1
 #define TXD_PKT_FT_CMD              0X2
 #define TXD_PKT_FT_PDA_FW           0X3
 #endif

 enum ENUM_INIT_CMD_ID {
 	INIT_CMD_ID_DOWNLOAD_CONFIG = 1,
 	INIT_CMD_ID_WIFI_START,
 	INIT_CMD_ID_ACCESS_REG,
 	INIT_CMD_ID_QUERY_PENDING_ERROR,
 	INIT_CMD_ID_PATCH_START,
 	INIT_CMD_ID_PATCH_WRITE,
 	INIT_CMD_ID_PATCH_FINISH,
 	INIT_CMD_ID_PATCH_SEMAPHORE_CONTROL = 0x10,
 	INIT_CMD_ID_HIF_LOOPBACK = 0x20,
 #if CFG_SUPPORT_COMPRESSION_FW_OPTION
 	INIT_CMD_ID_DECOMPRESSED_WIFI_START = 0xFF,
 #endif
 	INIT_CMD_ID_NUM
 };

 enum ENUM_INIT_EVENT_ID {
 	INIT_EVENT_ID_CMD_RESULT = 1,
 	INIT_EVENT_ID_ACCESS_REG,
 	INIT_EVENT_ID_PENDING_ERROR,
 	INIT_EVENT_ID_PATCH_SEMA_CTRL
 };

 enum ENUM_INIT_PATCH_STATUS {
 	PATCH_STATUS_NO_SEMA_NEED_PATCH = 0,	/* no SEMA, need patch */
 	PATCH_STATUS_NO_NEED_TO_PATCH,	/* patch is DL & ready */
 	PATCH_STATUS_GET_SEMA_NEED_PATCH,	/* get SEMA, need patch */
 	PATCH_STATUS_RELEASE_SEMA	/* release SEMA */
 };

 /*******************************************************************************
  *                             D A T A   T Y P E S
  *******************************************************************************
  */

 /* commands */
 struct INIT_WIFI_CMD {
 	uint8_t ucCID;
 	uint8_t ucPktTypeID;	/* Must be 0xA0 (CMD Packet) */
 	uint8_t ucReserved;
 	uint8_t ucSeqNum;
 #if 1
 	/* padding fields, hw may auto modify this field */
 	uint8_t ucD2B0Rev;
 	uint8_t ucExtenCID;	/* Extend CID */
 	uint8_t ucS2DIndex;	/* Index for Src to Dst in CMD usage */
 	uint8_t ucExtCmdOption;	/* Extend CID option */

 	uint32_t au4D3toD7Rev[5];	/* padding fields */
 #endif
 	uint8_t aucBuffer[0];
 };

 struct INIT_HIF_TX_HEADER {
 	uint16_t u2TxByteCount;	/* Max value is over 2048 */
 	uint16_t u2PQ_ID;	/* Must be 0x8000 (Port1, Queue 0) */
 #if 1
 	uint8_t ucWlanIdx;
 	uint8_t ucHeaderFormat;
 	uint8_t ucHeaderPadding;
 	uint8_t ucPktFt: 2;
 	uint8_t ucOwnMAC: 6;
 	uint32_t au4D2toD7Rev[6];

 	uint16_t u2Length;
 	uint16_t u2PqId;
 #endif
 	struct INIT_WIFI_CMD rInitWifiCmd;
 };

 struct INIT_CMD_DOWNLOAD_CONFIG {
 	uint32_t u4Address;
 	uint32_t u4Length;
 	uint32_t u4DataMode;
 };

 #define START_OVERRIDE_START_ADDRESS    BIT(0)
 #define START_DELAY_CALIBRATION         BIT(1)
 #define START_WORKING_PDA_OPTION        BIT(2)
 #define START_CRC_CHECK                 BIT(3)
 #define CHANGE_DECOMPRESSION_TMP_ADDRESS    BIT(4)

 #if CFG_SUPPORT_COMPRESSION_FW_OPTION
 #define WIFI_FW_DECOMPRESSION_FAILED        0xFF
 struct INIT_CMD_WIFI_DECOMPRESSION_START {
 	uint32_t u4Override;
 	uint32_t u4Address;
 	uint32_t u4Region1length;
 	uint32_t u4Region2length;
 	uint32_t	u4Region1Address;
 	uint32_t	u4Region2Address;
 	uint32_t	u4BlockSize;
 	uint32_t u4Region1CRC;
 	uint32_t u4Region2CRC;
 	uint32_t	u4DecompressTmpAddress;
 };
 #endif

 struct INIT_CMD_WIFI_START {
 	uint32_t u4Override;
 	uint32_t u4Address;
 };

 #define PATCH_GET_SEMA_CONTROL		1
 #define PATCH_RELEASE_SEMA_CONTROL	0
 struct INIT_CMD_PATCH_SEMA_CONTROL {
 	uint8_t ucGetSemaphore;
 	uint8_t aucReserved[3];
 };

 struct INIT_CMD_PATCH_FINISH {
 	uint8_t ucCheckCrc;
 	uint8_t aucReserved[3];
 };

 struct INIT_CMD_ACCESS_REG {
 	uint8_t ucSetQuery;
 	uint8_t aucReserved[3];
 	uint32_t u4Address;
 	uint32_t u4Data;
 };

 /* Events */
 struct INIT_WIFI_EVENT {
 	uint16_t u2RxByteCount;
 	uint16_t u2PacketType;	/* Must be filled with 0xE000 (EVENT Packet) */
 	uint8_t ucEID;
 	uint8_t ucSeqNum;
 	uint8_t aucReserved[2];
 	uint8_t aucBuffer[0];
 };

 struct INIT_HIF_RX_HEADER {
 	struct INIT_WIFI_EVENT rInitWifiEvent;
 };

 struct INIT_EVENT_CMD_RESULT {
 	uint8_t ucStatus;	/* 0: success */
 	/* 1: rejected by invalid param */
 	/* 2: rejected by incorrect CRC */
 	/* 3: rejected by decryption failure */
 	/* 4: unknown CMD */
 	/* 5: timeout */
 	uint8_t aucReserved[3];
 };

 struct INIT_EVENT_ACCESS_REG {
 	uint32_t u4Address;
 	uint32_t u4Data;
 };

 /*******************************************************************************
  *                            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
  *******************************************************************************
  */

 /*******************************************************************************
  *                              F U N C T I O N S
  *******************************************************************************
  */

 #endif /* _NIC_INIT_CMD_EVENT_H */
	/******************************************************************************
	*
	* 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_init_cmd_event.h#1
	*/

	/*! \file "nic_init_cmd_event.h"
	* \brief This file contains the declairation file of the WLAN
	* initialization routines for MediaTek Inc. 802.11 Wireless LAN Adapters.
	*/

	#ifndef _NIC_INIT_CMD_EVENT_H
	#define _NIC_INIT_CMD_EVENT_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
	*******************************************************************************
	*/

	#include "gl_typedef.h"

	/*******************************************************************************
	* C O N S T A N T S
	*******************************************************************************
	*/
	#define INIT_CMD_STATUS_SUCCESS 0
	#define INIT_CMD_STATUS_REJECTED_INVALID_PARAMS 1
	#define INIT_CMD_STATUS_REJECTED_CRC_ERROR 2
	#define INIT_CMD_STATUS_REJECTED_DECRYPT_FAIL 3
	#define INIT_CMD_STATUS_UNKNOWN 4

	#define INIT_PKT_FT_CMD 0x2
	#define INIT_PKT_FT_PDA_FWDL 0x3

	#define INIT_CMD_PQ_ID (0x8000)
	#define INIT_CMD_PACKET_TYPE_ID (0xA0)

	#define INIT_CMD_PDA_PQ_ID (0xF800)
	#define INIT_CMD_PDA_PACKET_TYPE_ID (0xA0)

	#if (CFG_UMAC_GENERATION >= 0x20)
	#define TXD_Q_IDX_MCU_RQ0 0
	#define TXD_Q_IDX_MCU_RQ1 1
	#define TXD_Q_IDX_MCU_RQ2 2
	#define TXD_Q_IDX_MCU_RQ3 3

	#define TXD_Q_IDX_PDA_FW_DL 0x1E

	/* DW0 Bit31 */
	#define TXD_P_IDX_LMAC 0
	#define TXD_P_IDX_MCU 1

	/* DW1 Bit 14:13 */
	#define TXD_HF_NON_80211_FRAME 0x0
	#define TXD_HF_CMD 0x1
	#define TXD_HF_80211_NORMAL 0x2
	#define TXD_HF_80211_ENHANCEMENT 0x3

	/* DW1 Bit 15 */
	#define TXD_FT_OFFSET 15
	#define TXD_FT_SHORT_FORMAT 0x0
	#define TXD_FT_LONG_FORMAT 0x1

	/* DW1 Bit 16 */
	#define TXD_TXDLEN_OFFSET 16
	#define TXD_TXDLEN_1PAGE 0x0
	#define TXD_TXDLEN_2PAGE 0x1

	/* DW1 Bit 25:24 */
	#define TXD_PKT_FT_CUT_THROUGH 0x0
	#define TXD_PKT_FT_STORE_FORWARD 0X1
	#define TXD_PKT_FT_CMD 0X2
	#define TXD_PKT_FT_PDA_FW 0X3
	#endif

	enum ENUM_INIT_CMD_ID {
	INIT_CMD_ID_DOWNLOAD_CONFIG = 1,
	INIT_CMD_ID_WIFI_START,
	INIT_CMD_ID_ACCESS_REG,
	INIT_CMD_ID_QUERY_PENDING_ERROR,
	INIT_CMD_ID_PATCH_START,
	INIT_CMD_ID_PATCH_WRITE,
	INIT_CMD_ID_PATCH_FINISH,
	INIT_CMD_ID_PATCH_SEMAPHORE_CONTROL = 0x10,
	INIT_CMD_ID_HIF_LOOPBACK = 0x20,
	#if CFG_SUPPORT_COMPRESSION_FW_OPTION
	INIT_CMD_ID_DECOMPRESSED_WIFI_START = 0xFF,
	#endif
	INIT_CMD_ID_NUM
	};

	enum ENUM_INIT_EVENT_ID {
	INIT_EVENT_ID_CMD_RESULT = 1,
	INIT_EVENT_ID_ACCESS_REG,
	INIT_EVENT_ID_PENDING_ERROR,
	INIT_EVENT_ID_PATCH_SEMA_CTRL
	};

	enum ENUM_INIT_PATCH_STATUS {
	PATCH_STATUS_NO_SEMA_NEED_PATCH = 0, /* no SEMA, need patch */
	PATCH_STATUS_NO_NEED_TO_PATCH, /* patch is DL & ready */
	PATCH_STATUS_GET_SEMA_NEED_PATCH, /* get SEMA, need patch */
	PATCH_STATUS_RELEASE_SEMA /* release SEMA */
	};

	/*******************************************************************************
	* D A T A T Y P E S
	*******************************************************************************
	*/

	/* commands */
	struct INIT_WIFI_CMD {
	uint8_t ucCID;
	uint8_t ucPktTypeID; /* Must be 0xA0 (CMD Packet) */
	uint8_t ucReserved;
	uint8_t ucSeqNum;
	#if 1
	/* padding fields, hw may auto modify this field */
	uint8_t ucD2B0Rev;
	uint8_t ucExtenCID; /* Extend CID */
	uint8_t ucS2DIndex; /* Index for Src to Dst in CMD usage */
	uint8_t ucExtCmdOption; /* Extend CID option */

	uint32_t au4D3toD7Rev[5]; /* padding fields */
	#endif
	uint8_t aucBuffer[0];
	};

	struct INIT_HIF_TX_HEADER {
	uint16_t u2TxByteCount; /* Max value is over 2048 */
	uint16_t u2PQ_ID; /* Must be 0x8000 (Port1, Queue 0) */
	#if 1
	uint8_t ucWlanIdx;
	uint8_t ucHeaderFormat;
	uint8_t ucHeaderPadding;
	uint8_t ucPktFt: 2;
	uint8_t ucOwnMAC: 6;
	uint32_t au4D2toD7Rev[6];

	uint16_t u2Length;
	uint16_t u2PqId;
	#endif
	struct INIT_WIFI_CMD rInitWifiCmd;
	};

	struct INIT_CMD_DOWNLOAD_CONFIG {
	uint32_t u4Address;
	uint32_t u4Length;
	uint32_t u4DataMode;
	};

	#define START_OVERRIDE_START_ADDRESS BIT(0)
	#define START_DELAY_CALIBRATION BIT(1)
	#define START_WORKING_PDA_OPTION BIT(2)
	#define START_CRC_CHECK BIT(3)
	#define CHANGE_DECOMPRESSION_TMP_ADDRESS BIT(4)

	#if CFG_SUPPORT_COMPRESSION_FW_OPTION
	#define WIFI_FW_DECOMPRESSION_FAILED 0xFF
	struct INIT_CMD_WIFI_DECOMPRESSION_START {
	uint32_t u4Override;
	uint32_t u4Address;
	uint32_t u4Region1length;
	uint32_t u4Region2length;
	uint32_t u4Region1Address;
	uint32_t u4Region2Address;
	uint32_t u4BlockSize;
	uint32_t u4Region1CRC;
	uint32_t u4Region2CRC;
	uint32_t u4DecompressTmpAddress;
	};
	#endif

	struct INIT_CMD_WIFI_START {
	uint32_t u4Override;
	uint32_t u4Address;
	};

	#define PATCH_GET_SEMA_CONTROL 1
	#define PATCH_RELEASE_SEMA_CONTROL 0
	struct INIT_CMD_PATCH_SEMA_CONTROL {
	uint8_t ucGetSemaphore;
	uint8_t aucReserved[3];
	};

	struct INIT_CMD_PATCH_FINISH {
	uint8_t ucCheckCrc;
	uint8_t aucReserved[3];
	};

	struct INIT_CMD_ACCESS_REG {
	uint8_t ucSetQuery;
	uint8_t aucReserved[3];
	uint32_t u4Address;
	uint32_t u4Data;
	};

	/* Events */
	struct INIT_WIFI_EVENT {
	uint16_t u2RxByteCount;
	uint16_t u2PacketType; /* Must be filled with 0xE000 (EVENT Packet) */
	uint8_t ucEID;
	uint8_t ucSeqNum;
	uint8_t aucReserved[2];
	uint8_t aucBuffer[0];
	};

	struct INIT_HIF_RX_HEADER {
	struct INIT_WIFI_EVENT rInitWifiEvent;
	};

	struct INIT_EVENT_CMD_RESULT {
	uint8_t ucStatus; /* 0: success */
	/* 1: rejected by invalid param */
	/* 2: rejected by incorrect CRC */
	/* 3: rejected by decryption failure */
	/* 4: unknown CMD */
	/* 5: timeout */
	uint8_t aucReserved[3];
	};

	struct INIT_EVENT_ACCESS_REG {
	uint32_t u4Address;
	uint32_t u4Data;
	};

	/*******************************************************************************
	* 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
	*******************************************************************************
	*/

	/*******************************************************************************
	* F U N C T I O N S
	*******************************************************************************
	*/

	#endif /* _NIC_INIT_CMD_EVENT_H */