/*

 * CmdBld.c

 *

 * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.      

 * All rights reserved.      

 * 

 * This program and the accompanying materials are made available under the 

 * terms of the Eclipse Public License v1.0 or BSD License which accompanies

 * this distribution. The Eclipse Public License is available at

 * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.                                   

 *                                                                       

 * 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 Texas Instruments 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  

 * OWNER 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.

 */

/** \file  CmdBld.c 

 *  \brief Command builder main

 *

 *  \see   CmdBld.h 

 */

#define __FILE_ID__  FILE_ID_90

#include "TWDriver.h"

#include "osApi.h"

#include "tidef.h"

#include "report.h"

#include "public_infoele.h"

#include "CmdBld.h"

#include "txResult_api.h"

#include "CmdBldCmdIE.h"

#include "CmdBldCfgIE.h"

#include "CmdBldItrIE.h"

#include "CmdQueue_api.h"

#include "eventMbox_api.h"

#include "TWDriverInternal.h"

#include "HwInit_api.h"

#define DEFAULT_TRACE_ENABLE                   0

#define DEFAULT_TRACE_OUT                      0

#define DEFAULT_PBCC_DYNAMIC_ENABLE_VAL        0

#define DEFAULT_PBCC_DYNAMIC_INTERVAL          500

#define DEFAULT_PBCC_DYNAMIC_IGNORE_MCAST      0

#define DEFAULT_HW_RADIO_CHANNEL               11

#define DEFAULT_CW_MIN                         15

#define DEFAULT_USE_DEVICE_ERROR_INTERRUPT     1

#define DEFAULT_UCAST_PRIORITY                 0

#define DEFAULT_NUM_STATIONS                   1

/* only for AP */

/*  8 increase number of BC frames */

#define DEFAULT_NUM_BCAST_TX_DESC              16  

#define DEFAULT_BCAST_PRIORITY                 0x81

/* hw access method*/

typedef enum

{

    HW_ACCESS_BUS_SLAVE_INDIRECT    = 0,

    HW_ACCESS_BUS_SLAVE_DIRECT      = 1,

    HW_ACCESS_BUS_MASTER            = 2

} EHwAccessMethod;

typedef int (*TConfigFwCb) (TI_HANDLE, TI_STATUS);

static TI_STATUS cmdBld_ConfigSeq               (TI_HANDLE hCmdBld);

static TI_STATUS cmdBld_GetCurrentAssociationId (TI_HANDLE hCmdBld, TI_UINT16 *pAidVal);

static TI_STATUS cmdBld_GetArpIpAddressesTable  (TI_HANDLE hCmdBld, TIpAddr *pIpAddr, TI_UINT8 *pEnabled , EIpVer *pIpVer);

static TI_STATUS cmdBld_JoinCmpltForReconfigCb  (TI_HANDLE hCmdBld);

static TI_STATUS cmdBld_DummyCb                 (TI_HANDLE hCmdBld);

TI_HANDLE cmdBld_Create (TI_HANDLE hOs)

{

    TCmdBld        *pCmdBld;

    TI_UINT32          uNumOfStations;

    TI_UINT32      i;

    /* Allocate the command builder */

    pCmdBld = (TCmdBld *)os_memoryAlloc (hOs, sizeof(TCmdBld),MemoryNormal);

    if (pCmdBld == NULL)

    {

        WLAN_OS_REPORT(("cmdBld_Create: Error memory allocation\n"));

        return NULL;

    }

    os_memoryZero (hOs, (void *)pCmdBld, sizeof(TCmdBld));

    pCmdBld->hOs = hOs;

    /* Create the Params object */

    /* make this code flat, move it to configure */

    {

        TWlanParams     *pWlanParams    = &DB_WLAN(pCmdBld);

        TDmaParams      *pDmaParams     = &DB_DMA(pCmdBld);

        TBssInfoParams  *pBssInfoParams = &DB_BSS(pCmdBld);

        TGenCounters    *pGenCounters   = &DB_CNT(pCmdBld);

        /* General counters */

        pGenCounters->FcsErrCnt                     = 0;

        /* BSS info paramaters */

        pBssInfoParams->RadioChannel                = DEFAULT_HW_RADIO_CHANNEL;

        pBssInfoParams->Ctrl                        = 0;

        /*

         * Intilaize the ctrl field in the BSS join structure 

         * Only bit_7 in the ctrl field is vurrently in use.

         * If bit_7 is on => Doing Tx flash before joining new AP 

         */

        pBssInfoParams->Ctrl                        |= JOIN_CMD_CTRL_TX_FLUSH;

        /* WLAN parameters*/

        /* Init filters as station (start/join with BssType will overwrite the values) */

        cmdBld_SetRxFilter ((TI_HANDLE)pCmdBld, RX_CONFIG_OPTION_MY_DST_MY_BSS, RX_FILTER_OPTION_FILTER_ALL);

        pWlanParams->UseDeviceErrorInterrupt        = DEFAULT_USE_DEVICE_ERROR_INTERRUPT;

        /* Initialize the params object database fields */

        pWlanParams->hwAccessMethod = HW_ACCESS_BUS_SLAVE_INDIRECT;

        pWlanParams->maxSitesFragCollect = TWD_SITE_FRAG_COLLECT_DEF;

        pWlanParams->RtsThreshold = TWD_RTS_THRESHOLD_DEF; 

        pWlanParams->bJoin = TI_FALSE;

        /* Soft Gemini defaults */

        pWlanParams->SoftGeminiEnable = SG_DISABLE;

        /* Beacon filter defaults */

        pWlanParams->beaconFilterParams.desiredState    = TI_FALSE;

        pWlanParams->beaconFilterParams.numOfElements   = DEF_NUM_STORED_FILTERS;

        pWlanParams->beaconFilterIETable.numberOfIEs    = DEF_BEACON_FILTER_IE_TABLE_NUM;

        pWlanParams->beaconFilterIETable.IETableSize    = BEACON_FILTER_IE_TABLE_DEF_SIZE;

        /* Roaming  parameters */

        pWlanParams->roamTriggers.BssLossTimeout    = NO_BEACON_DEFAULT_TIMEOUT;

        pWlanParams->roamTriggers.TsfMissThreshold  = OUT_OF_SYNC_DEFAULT_THRESHOLD;

        /* CoexActivity table */

        pWlanParams->tWlanParamsCoexActivityTable.numOfElements = COEX_ACTIVITY_TABLE_DEF_NUM; 

        /* DMA parameters */

        /* Initialize the Params object database fields*/

        pDmaParams->NumStations                     = DEFAULT_NUM_STATIONS;

        uNumOfStations                              = (TI_UINT32)pDmaParams->NumStations;

        /* 

         * loop an all rssi_snr triggers and initialize only index number. 

         * Reason: 'index' not initialized --> 'index = 0' --> triggers 1..7 will overrun trigger '0' in cmdBld_ConfigSeq

         */

        for (i = 0; i < NUM_OF_RSSI_SNR_TRIGGERS ; i++) 

        {

           pWlanParams->tRssiSnrTrigger[i].index = i;

        }

    }

    pCmdBld->uLastElpCtrlMode = ELPCTRL_MODE_NORMAL;

    /* Create security objects */

    pCmdBld->tSecurity.eSecurityMode = TWD_CIPHER_NONE;

    pCmdBld->tSecurity.uNumOfStations = uNumOfStations;

    DB_KEYS(pCmdBld).pReconfKeys = (TSecurityKeys*)os_memoryAlloc (hOs, 

                                        sizeof(TSecurityKeys) * (uNumOfStations * NO_OF_RECONF_SECUR_KEYS_PER_STATION + NO_OF_EXTRA_RECONF_SECUR_KEYS),MemoryNormal);

    os_memoryZero (hOs, 

                   (void *)(DB_KEYS(pCmdBld).pReconfKeys), 

                   sizeof(TSecurityKeys) * (uNumOfStations * NO_OF_RECONF_SECUR_KEYS_PER_STATION + NO_OF_EXTRA_RECONF_SECUR_KEYS));

    WLAN_INIT_REPORT(("cmdBld_Create end %x\n",(TI_HANDLE)pCmdBld));

    return (TI_HANDLE)pCmdBld;

}

TI_STATUS cmdBld_Destroy (TI_HANDLE hCmdBld)

{

    TCmdBld      *pCmdBld = (TCmdBld *)hCmdBld;

    TDmaParams   *pDmaParams = NULL;

    TI_UINT32        uNumOfStations;

    if (pCmdBld == NULL)

    {

        return TI_OK;

    }

    pDmaParams = &DB_DMA(hCmdBld);

    uNumOfStations = (TI_UINT32)pDmaParams->NumStations;

    if (DB_KEYS(pCmdBld).pReconfKeys)

    {

        os_memoryFree (pCmdBld->hOs, 

                       DB_KEYS(pCmdBld).pReconfKeys, 

                       sizeof(TSecurityKeys) * (uNumOfStations * NO_OF_RECONF_SECUR_KEYS_PER_STATION + NO_OF_EXTRA_RECONF_SECUR_KEYS));

    }

    /* free the whalCtrl data structure */

    os_memoryFree (pCmdBld->hOs, pCmdBld, sizeof(TCmdBld));

    return TI_OK;

}

TI_STATUS cmdBld_Restart (TI_HANDLE hCmdBld)

{

    TCmdBld      *pCmdBld = (TCmdBld *)hCmdBld;

    /* This init is for recovery stage */

    pCmdBld->uLastElpCtrlMode = ELPCTRL_MODE_NORMAL;

    /* 

     * This call is to have the recovery process in AWAKE mode 

     * Prevent move to sleep mode between Hw_Init and Fw_Init

     */

	cmdBld_CfgIeSleepAuth (hCmdBld, DB_WLAN(hCmdBld).minPowerLevel, NULL, NULL);

    return TI_OK;

}

TI_STATUS cmdBld_Config (TI_HANDLE  hCmdBld, 

                         TI_HANDLE  hReport, 

                         void      *fFinalizeDownload, 

                         TI_HANDLE  hFinalizeDownload, 

                         TI_HANDLE  hEventMbox, 

                         TI_HANDLE  hCmdQueue,

                         TI_HANDLE  hTwIf)

{

    TCmdBld        *pCmdBld = (TCmdBld *)hCmdBld;

    TI_UINT32       index;

    pCmdBld->hReport = hReport;

    pCmdBld->fFinalizeDownload = fFinalizeDownload;

    pCmdBld->hFinalizeDownload = hFinalizeDownload;

    pCmdBld->hEventMbox = hEventMbox;

    pCmdBld->hCmdQueue = hCmdQueue;

    pCmdBld->hTwIf  = hTwIf;

    /* Reset all reconfig valid fields*/

    DB_KEYS(pCmdBld).bHwEncDecrEnableValid = TI_FALSE;

    DB_KEYS(pCmdBld).bDefaultKeyIdValid    = TI_FALSE;  

    for (index = 0; 

         index < pCmdBld->tSecurity.uNumOfStations * NO_OF_RECONF_SECUR_KEYS_PER_STATION + NO_OF_EXTRA_RECONF_SECUR_KEYS; 

         index++)

        (DB_KEYS(pCmdBld).pReconfKeys + index)->keyType = KEY_NULL;

    return TI_OK;

}

static void cmdBld_ConfigFwCb (TI_HANDLE hCmdBld, TI_STATUS status, void *pData)

{

    TCmdBld        *pCmdBld = (TCmdBld *)hCmdBld;

    MemoryMap_t    *pMemMap = &pCmdBld->tMemMap;

    TDmaParams     *pDmaParams = &DB_DMA(hCmdBld);

    /* Arrived from callback */

    if (pData)

    {

        TI_UINT32         *pSwap, i, uMemMapNumFields;

        /* Solve endian problem (all fields are 32 bit) */

        uMemMapNumFields = (sizeof(MemoryMap_t) - sizeof(EleHdrStruct)) % 4;

        pSwap = (TI_UINT32* )&(pMemMap->codeStart);

        for (i = 0; i < uMemMapNumFields; i++)

        {

            pSwap[i] = ENDIAN_HANDLE_LONG(pSwap[i]);

        }

    }

    /* Save number of TX blocks */

    pDmaParams->NumTxBlocks = pMemMap->numTxMemBlks;

    /* Firmware Control block is internally pointing to TxResultInterface structure */

    pDmaParams->fwTxResultInterface = pMemMap->trqBlock.controlBlock; 

    pDmaParams->fwRxCBufPtr =           pMemMap->rxCBufPtr;

    pDmaParams->fwTxCBufPtr =           pMemMap->txCBufPtr;

    pDmaParams->fwRxControlPtr =        pMemMap->rxControlPtr;

    pDmaParams->fwTxControlPtr =        pMemMap->txControlPtr;

    pDmaParams->PacketMemoryPoolStart = (TI_UINT32)pMemMap->packetMemoryPoolStart;

    /* Call the upper layer callback */

    (*((TConfigFwCb)pCmdBld->fConfigFwCb)) (pCmdBld->hConfigFwCb, TI_OK);

}

/****************************************************************************

 *                      cmdBld_ConfigFw()

 ****************************************************************************

 * DESCRIPTION: Configure the WLAN firmware

 * 

 * INPUTS: None 

 * 

 * OUTPUT: None

 * 

 * RETURNS: TI_OK or TI_NOK

 ****************************************************************************/

TI_STATUS cmdBld_ConfigFw (TI_HANDLE hCmdBld, void *fConfigFwCb, TI_HANDLE hConfigFwCb)

{

    TCmdBld        *pCmdBld = (TCmdBld *)hCmdBld;

    pCmdBld->fConfigFwCb = fConfigFwCb;

    pCmdBld->hConfigFwCb = hConfigFwCb; 

    pCmdBld->uIniSeq = 0;

    /* should be re-initialized for recovery,   pCmdBld->uLastElpCtrlMode = ELPCTRL_MODE_KEEP_AWAKE; */

    /* Start configuration sequence */

    return cmdBld_ConfigSeq (hCmdBld);

}

typedef TI_STATUS (*TCmdCfgFunc) (TI_HANDLE);

static TI_STATUS __cmd_probe_req (TI_HANDLE hCmdBld)

{

    TI_STATUS   tStatus = TI_OK;

    /* keep space for 2.4 GHz probe request */

    tStatus = cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                                  NULL, 

                                                  DB_WLAN(hCmdBld).probeRequestTemplateSize,

                                                  CFG_TEMPLATE_PROBE_REQ_2_4,

                                                  0,

                                                  NULL,

                                                  NULL);

    if (TI_OK != tStatus)

    {

        return tStatus;

    }

    /* keep space for 5.0 GHz probe request */

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                               NULL, 

                                               DB_WLAN(hCmdBld).probeRequestTemplateSize,

                                               CFG_TEMPLATE_PROBE_REQ_5,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_null_data (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).nullTemplateSize,

                                               TEMPLATE_NULL_DATA,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_burst_mode_enable (TI_HANDLE hCmdBld)

{

	return cmdBld_CfgIeBurstMode (hCmdBld, 

							  DB_AC(hCmdBld).isBurstModeEnabled, 

							  (void *)cmdBld_ConfigSeq, 

							  hCmdBld);

}

/*

static TI_STATUS __cmd_smart_reflex_debug (TI_HANDLE hCmdBld)

{

    return cmdBld_CfgIeSRDebug (hCmdBld, 

							   &(DB_SR(hCmdBld).tSmartReflexDebugParams),

							   (void *)cmdBld_ConfigSeq, 

							   hCmdBld);

}

static TI_STATUS __cmd_smart_reflex_state (TI_HANDLE hCmdBld)

{

	return cmdBld_CfgIeSRState (hCmdBld, 

							   (uint8) DB_SR(hCmdBld).tSmartReflexState.enable, 

							   (void *)cmdBld_ConfigSeq, 

							   hCmdBld);

}

*/

static TI_STATUS __cmd_disconn (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).disconnTemplateSize,

                                             TEMPLATE_DISCONNECT,

                                             0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_ps_poll (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).PsPollTemplateSize,

                                               TEMPLATE_PS_POLL,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_qos_null_data (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).qosNullDataTemplateSize,

                                               TEMPLATE_QOS_NULL_DATA,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_probe_resp (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).probeResponseTemplateSize,

                                               TEMPLATE_PROBE_RESPONSE,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_beacon (TI_HANDLE hCmdBld)

{

    return cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                             NULL, 

                                             DB_WLAN(hCmdBld).beaconTemplateSize,

                                               TEMPLATE_BEACON,

                                               0,

                                             (void *)cmdBld_ConfigSeq,

                                             hCmdBld); 

}

static TI_STATUS __cmd_keep_alive_tmpl (TI_HANDLE hCmdBld)

{

    TI_UINT32   index;

    TI_STATUS   status = TI_NOK;

    /* 

     * config templates 

     * fisr configure all indexes but the last one with no CB, and than configure the last one 

     * with a CB to continue configuration.

     */

    for (index = 0; index < KLV_MAX_TMPL_NUM - 1; index++)

    {

        status =  cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                                      NULL, 

                                                      MAX_TEMPLATES_SIZE,

                                                      TEMPLATE_KLV,

                                                      index,

                                                      NULL,

                                                      NULL);

        if (TI_OK != status)

        {

            return status;

        }

    }

    status =  cmdBld_CmdIeConfigureTemplateFrame (hCmdBld, 

                                                  NULL, 

                                                  MAX_TEMPLATES_SIZE,

                                                  TEMPLATE_KLV,

                                                  index,

                                                  (void *)cmdBld_ConfigSeq,

                                                  hCmdBld);

    return status;

}

static TI_STATUS __cfg_mem (TI_HANDLE hCmdBld)

{

    /* Configure the weight among the different hardware queues */

    return cmdBld_CfgIeConfigMemory (hCmdBld, &DB_DMA(hCmdBld), (void *)cmdBld_ConfigSeq, hCmdBld);

}

static TI_STATUS __cfg_rx_msdu_life_time (TI_HANDLE hCmdBld)

{    

    /* Configure the Rx Msdu Life Time (expiry time of de-fragmentation in FW) */

    return cmdBld_CfgIeRxMsduLifeTime (hCmdBld, 

                                       DB_WLAN(hCmdBld).MaxRxMsduLifetime, 

                                       (void *)cmdBld_ConfigSeq, 

                                       hCmdBld);

}

static TI_STATUS __cfg_rx (TI_HANDLE hCmdBld)

{    

    return cmdBld_CfgIeRx (hCmdBld, 

                           DB_WLAN(hCmdBld).RxConfigOption, 

                           DB_WLAN(hCmdBld).RxFilterOption, 

                           (void *)cmdBld_ConfigSeq, 

                           hCmdBld);

}

static TI_STATUS __cfg_ac_params_0 (TI_HANDLE hCmdBld)

{

    /*

     * NOTE: Set following parameter only if configured.

     *       Otherwise, is contains garbage.