/*
 * Copyright (c) 2011 Atheros Communications Inc.
 * Copyright (c) 2011-2012 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.
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <linux/moduleparam.h>
#include <linux/errno.h>
#include <linux/export.h>
#include <linux/of.h>
#include <linux/mmc/sdio_func.h>
#include <linux/vmalloc.h>

#include "core.h"
#include "cfg80211.h"
#include "target.h"
#include "debug.h"
#include "hif-ops.h"
#include "htc-ops.h"

static const struct ath6kl_hw hw_list[] = {
        {
                .id                             = AR6003_HW_2_0_VERSION,
                .name                           = "ar6003 hw 2.0",
                .dataset_patch_addr             = 0x57e884,
                .app_load_addr                  = 0x543180,
                .board_ext_data_addr            = 0x57e500,
                .reserved_ram_size              = 6912,
                .refclk_hz                      = 26000000,
                .uarttx_pin                     = 8,
                .flags                          = ATH6KL_HW_SDIO_CRC_ERROR_WAR,

                /* hw2.0 needs override address hardcoded */
                .app_start_override_addr        = 0x944C00,

                .fw = {
                        .dir            = AR6003_HW_2_0_FW_DIR,
                        .otp            = AR6003_HW_2_0_OTP_FILE,
                        .fw             = AR6003_HW_2_0_FIRMWARE_FILE,
                        .tcmd           = AR6003_HW_2_0_TCMD_FIRMWARE_FILE,
                        .patch          = AR6003_HW_2_0_PATCH_FILE,
                },

                .fw_board               = AR6003_HW_2_0_BOARD_DATA_FILE,
                .fw_default_board       = AR6003_HW_2_0_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6003_HW_2_1_1_VERSION,
                .name                           = "ar6003 hw 2.1.1",
                .dataset_patch_addr             = 0x57ff74,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0x542330,
                .reserved_ram_size              = 512,
                .refclk_hz                      = 26000000,
                .uarttx_pin                     = 8,
                .testscript_addr                = 0x57ef74,
                .flags                          = ATH6KL_HW_SDIO_CRC_ERROR_WAR,

                .fw = {
                        .dir            = AR6003_HW_2_1_1_FW_DIR,
                        .otp            = AR6003_HW_2_1_1_OTP_FILE,
                        .fw             = AR6003_HW_2_1_1_FIRMWARE_FILE,
                        .tcmd           = AR6003_HW_2_1_1_TCMD_FIRMWARE_FILE,
                        .patch          = AR6003_HW_2_1_1_PATCH_FILE,
                        .utf            = AR6003_HW_2_1_1_UTF_FIRMWARE_FILE,
                        .testscript     = AR6003_HW_2_1_1_TESTSCRIPT_FILE,
                },

                .fw_board               = AR6003_HW_2_1_1_BOARD_DATA_FILE,
                .fw_default_board = AR6003_HW_2_1_1_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6004_HW_1_0_VERSION,
                .name                           = "ar6004 hw 1.0",
                .dataset_patch_addr             = 0x57e884,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0x437000,
                .reserved_ram_size              = 19456,
                .board_addr                     = 0x433900,
                .refclk_hz                      = 26000000,
                .uarttx_pin                     = 11,
                .flags                          = 0,

                .fw = {
                        .dir            = AR6004_HW_1_0_FW_DIR,
                        .fw             = AR6004_HW_1_0_FIRMWARE_FILE,
                },

                .fw_board               = AR6004_HW_1_0_BOARD_DATA_FILE,
                .fw_default_board       = AR6004_HW_1_0_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6004_HW_1_1_VERSION,
                .name                           = "ar6004 hw 1.1",
                .dataset_patch_addr             = 0x57e884,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0x437000,
                .reserved_ram_size              = 11264,
                .board_addr                     = 0x43d400,
                .refclk_hz                      = 40000000,
                .uarttx_pin                     = 11,
                .flags                          = 0,
                .fw = {
                        .dir            = AR6004_HW_1_1_FW_DIR,
                        .fw             = AR6004_HW_1_1_FIRMWARE_FILE,
                },

                .fw_board               = AR6004_HW_1_1_BOARD_DATA_FILE,
                .fw_default_board       = AR6004_HW_1_1_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6004_HW_1_2_VERSION,
                .name                           = "ar6004 hw 1.2",
                .dataset_patch_addr             = 0x436ecc,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0x437000,
                .reserved_ram_size              = 9216,
                .board_addr                     = 0x435c00,
                .refclk_hz                      = 40000000,
                .uarttx_pin                     = 11,
                .flags                          = 0,

                .fw = {
                        .dir            = AR6004_HW_1_2_FW_DIR,
                        .fw             = AR6004_HW_1_2_FIRMWARE_FILE,
                },
                .fw_board               = AR6004_HW_1_2_BOARD_DATA_FILE,
                .fw_default_board       = AR6004_HW_1_2_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6004_HW_1_3_VERSION,
                .name                           = "ar6004 hw 1.3",
                .dataset_patch_addr             = 0x437860,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0x437000,
                .reserved_ram_size              = 7168,
                .board_addr                     = 0x436400,
                .refclk_hz                      = 0,
                .uarttx_pin                     = 11,
                .flags                          = 0,

                .fw = {
                        .dir            = AR6004_HW_1_3_FW_DIR,
                        .fw             = AR6004_HW_1_3_FIRMWARE_FILE,
                        .tcmd           = AR6004_HW_1_3_TCMD_FIRMWARE_FILE,
                        .utf            = AR6004_HW_1_3_UTF_FIRMWARE_FILE,
                        .testscript     = AR6004_HW_1_3_TESTSCRIPT_FILE,
                },

                .fw_board               = AR6004_HW_1_3_BOARD_DATA_FILE,
                .fw_default_board       = AR6004_HW_1_3_DEFAULT_BOARD_DATA_FILE,
        },
        {
                .id                             = AR6004_HW_3_0_VERSION,
                .name                           = "ar6004 hw 3.0",
                .dataset_patch_addr             = 0,
                .app_load_addr                  = 0x1234,
                .board_ext_data_addr            = 0,
                .reserved_ram_size              = 7168,
                .board_addr                     = 0x436400,
                .testscript_addr                = 0,
                .uarttx_pin                     = 11,
                .flags                          = 0,

                .fw = {
                        .dir            = AR6004_HW_3_0_FW_DIR,
                        .fw             = AR6004_HW_3_0_FIRMWARE_FILE,
                        .tcmd           = AR6004_HW_3_0_TCMD_FIRMWARE_FILE,
                        .utf            = AR6004_HW_3_0_UTF_FIRMWARE_FILE,
                        .testscript     = AR6004_HW_3_0_TESTSCRIPT_FILE,
                },

                .fw_board               = AR6004_HW_3_0_BOARD_DATA_FILE,
                .fw_default_board       = AR6004_HW_3_0_DEFAULT_BOARD_DATA_FILE,
        },
};

/*
 * Include definitions here that can be used to tune the WLAN module
 * behavior. Different customers can tune the behavior as per their needs,
 * here.
 */

/*
 * This configuration item enable/disable keepalive support.
 * Keepalive support: In the absence of any data traffic to AP, null
 * frames will be sent to the AP at periodic interval, to keep the association
 * active. This configuration item defines the periodic interval.
 * Use value of zero to disable keepalive support
 * Default: 60 seconds
 */
#define WLAN_CONFIG_KEEP_ALIVE_INTERVAL 60

/*
 * This configuration item sets the value of disconnect timeout
 * Firmware delays sending the disconnect event to the host for this
 * timeout after is gets disconnected from the current AP.
 * If the firmware successly roams within the disconnect timeout
 * it sends a new connect event
 */
#define WLAN_CONFIG_DISCONNECT_TIMEOUT 10


#define ATH6KL_DATA_OFFSET    64
struct sk_buff *ath6kl_buf_alloc(int size)
{
        struct sk_buff *skb;
        u16 reserved;

        /* Add cacheline space at front and back of buffer */
        reserved = roundup((2 * L1_CACHE_BYTES) + ATH6KL_DATA_OFFSET +
                   sizeof(struct htc_packet) + ATH6KL_HTC_ALIGN_BYTES, 4);
        skb = dev_alloc_skb(size + reserved);

        if (skb)
                skb_reserve(skb, reserved - L1_CACHE_BYTES);
        return skb;
}

void ath6kl_init_profile_info(struct ath6kl_vif *vif)
{
        vif->ssid_len = 0;
        memset(vif->ssid, 0, sizeof(vif->ssid));

        vif->dot11_auth_mode = OPEN_AUTH;
        vif->auth_mode = NONE_AUTH;
        vif->prwise_crypto = NONE_CRYPT;
        vif->prwise_crypto_len = 0;
        vif->grp_crypto = NONE_CRYPT;
        vif->grp_crypto_len = 0;
        memset(vif->wep_key_list, 0, sizeof(vif->wep_key_list));
        memset(vif->req_bssid, 0, sizeof(vif->req_bssid));
        memset(vif->bssid, 0, sizeof(vif->bssid));
        vif->bss_ch = 0;
}

static int ath6kl_set_host_app_area(struct ath6kl *ar)
{
        u32 address, data;
        struct host_app_area host_app_area;

        /* Fetch the address of the host_app_area_s
         * instance in the host interest area */
        address = ath6kl_get_hi_item_addr(ar, HI_ITEM(hi_app_host_interest));
        address = TARG_VTOP(ar->target_type, address);

        if (ath6kl_diag_read32(ar, address, &data))
                return -EIO;

        address = TARG_VTOP(ar->target_type, data);
        host_app_area.wmi_protocol_ver = cpu_to_le32(WMI_PROTOCOL_VERSION);
        if (ath6kl_diag_write(ar, address, (u8 *) &host_app_area,
                              sizeof(struct host_app_area)))
                return -EIO;

        return 0;
}

static inline void set_ac2_ep_map(struct ath6kl *ar,
                                  u8 ac,
                                  enum htc_endpoint_id ep)
{
        ar->ac2ep_map[ac] = ep;
        ar->ep2ac_map[ep] = ac;
}

/* connect to a service */
static int ath6kl_connectservice(struct ath6kl *ar,
                                 struct htc_service_connect_req  *con_req,
                                 char *desc)
{
        int status;
        struct htc_service_connect_resp response;

        memset(&response, 0, sizeof(response));

        status = ath6kl_htc_conn_service(ar->htc_target, con_req, &response);
        if (status) {
                ath6kl_err("failed to connect to %s service status:%d\n",
                           desc, status);
                return status;
        }

        switch (con_req->svc_id) {
        case WMI_CONTROL_SVC:
                if (test_bit(WMI_ENABLED, &ar->flag))
                        ath6kl_wmi_set_control_ep(ar->wmi, response.endpoint);
                ar->ctrl_ep = response.endpoint;
                break;
        case WMI_DATA_BE_SVC:
                set_ac2_ep_map(ar, WMM_AC_BE, response.endpoint);
                break;
        case WMI_DATA_BK_SVC:
                set_ac2_ep_map(ar, WMM_AC_BK, response.endpoint);
                break;
        case WMI_DATA_VI_SVC:
                set_ac2_ep_map(ar, WMM_AC_VI, response.endpoint);
                break;
        case WMI_DATA_VO_SVC:
                set_ac2_ep_map(ar, WMM_AC_VO, response.endpoint);
                break;
        default:
                ath6kl_err("service id is not mapped %d\n", con_req->svc_id);
                return -EINVAL;
        }

        return 0;
}

static int ath6kl_init_service_ep(struct ath6kl *ar)
{
        struct htc_service_connect_req connect;

        memset(&connect, 0, sizeof(connect));

        /* these fields are the same for all service endpoints */
        connect.ep_cb.tx_comp_multi = ath6kl_tx_complete;
        connect.ep_cb.rx = ath6kl_rx;
        connect.ep_cb.rx_refill = ath6kl_rx_refill;
        connect.ep_cb.tx_full = ath6kl_tx_queue_full;

        /*
         * Set the max queue depth so that our ath6kl_tx_queue_full handler
         * gets called.
        */
        connect.max_txq_depth = MAX_DEFAULT_SEND_QUEUE_DEPTH;
        connect.ep_cb.rx_refill_thresh = ATH6KL_MAX_RX_BUFFERS / 4;
        if (!connect.ep_cb.rx_refill_thresh)
                connect.ep_cb.rx_refill_thresh++;

        /* connect to control service */
        connect.svc_id = WMI_CONTROL_SVC;
        if (ath6kl_connectservice(ar, &connect, "WMI CONTROL"))
                return -EIO;

        connect.flags |= HTC_FLGS_TX_BNDL_PAD_EN;

        /*
         * Limit the HTC message size on the send path, although e can
         * receive A-MSDU frames of 4K, we will only send ethernet-sized
         * (802.3) frames on the send path.
         */
        connect.max_rxmsg_sz = WMI_MAX_TX_DATA_FRAME_LENGTH;

        /*
         * To reduce the amount of committed memory for larger A_MSDU
         * frames, use the recv-alloc threshold mechanism for larger
         * packets.
         */
        connect.ep_cb.rx_alloc_thresh = ATH6KL_BUFFER_SIZE;
        connect.ep_cb.rx_allocthresh = ath6kl_alloc_amsdu_rxbuf;

        /*
         * For the remaining data services set the connection flag to
         * reduce dribbling, if configured to do so.
         */
        connect.conn_flags |= HTC_CONN_FLGS_REDUCE_CRED_DRIB;
        connect.conn_flags &= ~HTC_CONN_FLGS_THRESH_MASK;
        connect.conn_flags |= HTC_CONN_FLGS_THRESH_LVL_HALF;

        connect.svc_id = WMI_DATA_BE_SVC;

        if (ath6kl_connectservice(ar, &connect, "WMI DATA BE"))
                return -EIO;

        /* connect to back-ground map this to WMI LOW_PRI */
        connect.svc_id = WMI_DATA_BK_SVC;
        if (ath6kl_connectservice(ar, &connect, "WMI DATA BK"))
                return -EIO;

        /* connect to Video service, map this to HI PRI */
        connect.svc_id = WMI_DATA_VI_SVC;
        if (ath6kl_connectservice(ar, &connect, "WMI DATA VI"))
                return -EIO;

        /*
         * Connect to VO service, this is currently not mapped to a WMI
         * priority stream due to historical reasons. WMI originally
         * defined 3 priorities over 3 mailboxes We can change this when
         * WMI is reworked so that priorities are not dependent on
         * mailboxes.
         */
        connect.svc_id = WMI_DATA_VO_SVC;
        if (ath6kl_connectservice(ar, &connect, "WMI DATA VO"))
                return -EIO;

        return 0;
}

void ath6kl_init_control_info(struct ath6kl_vif *vif)
{
        ath6kl_init_profile_info(vif);
        vif->def_txkey_index = 0;
        memset(vif->wep_key_list, 0, sizeof(vif->wep_key_list));
        vif->ch_hint = 0;
}

/*
 * Set HTC/Mbox operational parameters, this can only be called when the
 * target is in the BMI phase.
 */
static int ath6kl_set_htc_params(struct ath6kl *ar, u32 mbox_isr_yield_val,
                                 u8 htc_ctrl_buf)
{
        int status;
        u32 blk_size;

        blk_size = ar->mbox_info.block_size;

        if (htc_ctrl_buf)
                blk_size |=  ((u32)htc_ctrl_buf) << 16;

        /* set the host interest area for the block size */
        status = ath6kl_bmi_write_hi32(ar, hi_mbox_io_block_sz, blk_size);
        if (status) {
                ath6kl_err("bmi_write_memory for IO block size failed\n");
                goto out;
        }

        ath6kl_dbg(ATH6KL_DBG_TRC, "block size set: %d (target addr:0x%X)\n",
                   blk_size,
                   ath6kl_get_hi_item_addr(ar, HI_ITEM(hi_mbox_io_block_sz)));

        if (mbox_isr_yield_val) {
                /* set the host interest area for the mbox ISR yield limit */
                status = ath6kl_bmi_write_hi32(ar, hi_mbox_isr_yield_limit,
                                               mbox_isr_yield_val);
                if (status) {
                        ath6kl_err("bmi_write_memory for yield limit failed\n");
                        goto out;
                }
        }

out:
        return status;
}

static int ath6kl_target_config_wlan_params(struct ath6kl *ar, int idx)
{
        int ret;

        /*
         * Configure the device for rx dot11 header rules. "0,0" are the
         * default values. Required if checksum offload is needed. Set
         * RxMetaVersion to 2.
         */
        ret = ath6kl_wmi_set_rx_frame_format_cmd(ar->wmi, idx,
                                                 ar->rx_meta_ver, 0, 0);
        if (ret) {
                ath6kl_err("unable to set the rx frame format: %d\n", ret);
                return ret;
        }

        if (ar->conf_flags & ATH6KL_CONF_IGNORE_PS_FAIL_EVT_IN_SCAN) {
                ret = ath6kl_wmi_pmparams_cmd(ar->wmi, idx, 0, 1, 0, 0, 1,
                                              IGNORE_PS_FAIL_DURING_SCAN);
                if (ret) {
                        ath6kl_err("unable to set power save fail event policy: %d\n",
                                   ret);
                        return ret;
                }
        }

        if (!(ar->conf_flags & ATH6KL_CONF_IGNORE_ERP_BARKER)) {
                ret = ath6kl_wmi_set_lpreamble_cmd(ar->wmi, idx, 0,
                                                   WMI_FOLLOW_BARKER_IN_ERP);
                if (ret) {
                        ath6kl_err("unable to set barker preamble policy: %d\n",
                                   ret);
                        return ret;
                }
        }

        ret = ath6kl_wmi_set_keepalive_cmd(ar->wmi, idx,
                                           WLAN_CONFIG_KEEP_ALIVE_INTERVAL);
        if (ret) {
                ath6kl_err("unable to set keep alive interval: %d\n", ret);
                return ret;
        }

        ret = ath6kl_wmi_disctimeout_cmd(ar->wmi, idx,
                                         WLAN_CONFIG_DISCONNECT_TIMEOUT);
        if (ret) {
                ath6kl_err("unable to set disconnect timeout: %d\n", ret);
                return ret;
        }

        if (!(ar->conf_flags & ATH6KL_CONF_ENABLE_TX_BURST)) {
                ret = ath6kl_wmi_set_wmm_txop(ar->wmi, idx, WMI_TXOP_DISABLED);
                if (ret) {
                        ath6kl_err("unable to set txop bursting: %d\n", ret);
                        return ret;
                }
        }

        if (ar->p2p && (ar->vif_max == 1 || idx)) {
                ret = ath6kl_wmi_info_req_cmd(ar->wmi, idx,
                                              P2P_FLAG_CAPABILITIES_REQ |
                                              P2P_FLAG_MACADDR_REQ |
                                              P2P_FLAG_HMODEL_REQ);
                if (ret) {
                        ath6kl_dbg(ATH6KL_DBG_TRC,
                                   "failed to request P2P capabilities (%d) - assuming P2P not supported\n",
                                   ret);
                        ar->p2p = false;
                }
        }

        if (ar->p2p && (ar->vif_max == 1 || idx)) {
                /* Enable Probe Request reporting for P2P */
                ret = ath6kl_wmi_probe_report_req_cmd(ar->wmi, idx, true);
                if (ret) {
                        ath6kl_dbg(ATH6KL_DBG_TRC,
                                   "failed to enable Probe Request reporting (%d)\n",
                                   ret);
                }
        }

        return ret;
}

int ath6kl_configure_target(struct ath6kl *ar)
{
        u32 param, ram_reserved_size;
        u8 fw_iftype, fw_mode = 0, fw_submode = 0;
        int i, status;

        param = !!(ar->conf_flags & ATH6KL_CONF_UART_DEBUG);
        if (ath6kl_bmi_write_hi32(ar, hi_serial_enable, param)) {
                ath6kl_err("bmi_write_memory for uart debug failed\n");
                return -EIO;
        }

        /*
         * Note: Even though the firmware interface type is
         * chosen as BSS_STA for all three interfaces, can
         * be configured to IBSS/AP as long as the fw submode
         * remains normal mode (0 - AP, STA and IBSS). But
         * due to an target assert in firmware only one interface is
         * configured for now.
         */
        fw_iftype = HI_OPTION_FW_MODE_BSS_STA;

        for (i = 0; i < ar->vif_max; i++)
                fw_mode |= fw_iftype << (i * HI_OPTION_FW_MODE_BITS);

        /*
         * Submodes when fw does not support dynamic interface
         * switching:
         *              vif[0] - AP/STA/IBSS
         *              vif[1] - "P2P dev"/"P2P GO"/"P2P Client"
         *              vif[2] - "P2P dev"/"P2P GO"/"P2P Client"
         * Otherwise, All the interface are initialized to p2p dev.
         */

        if (test_bit(ATH6KL_FW_CAPABILITY_STA_P2PDEV_DUPLEX,
                     ar->fw_capabilities)) {
                for (i = 0; i < ar->vif_max; i++)
                        fw_submode |= HI_OPTION_FW_SUBMODE_P2PDEV <<
                                (i * HI_OPTION_FW_SUBMODE_BITS);
        } else {
                for (i = 0; i < ar->max_norm_iface; i++)
                        fw_submode |= HI_OPTION_FW_SUBMODE_NONE <<
                                (i * HI_OPTION_FW_SUBMODE_BITS);

                for (i = ar->max_norm_iface; i < ar->vif_max; i++)
                        fw_submode |= HI_OPTION_FW_SUBMODE_P2PDEV <<
                                (i * HI_OPTION_FW_SUBMODE_BITS);

                if (ar->p2p && ar->vif_max == 1)
                        fw_submode = HI_OPTION_FW_SUBMODE_P2PDEV;
        }

        if (ath6kl_bmi_write_hi32(ar, hi_app_host_interest,
                                  HTC_PROTOCOL_VERSION) != 0) {
                ath6kl_err("bmi_write_memory for htc version failed\n");
                return -EIO;
        }

        /* set the firmware mode to STA/IBSS/AP */
        param = 0;

        if (ath6kl_bmi_read_hi32(ar, hi_option_flag, &param) != 0) {
                ath6kl_err("bmi_read_memory for setting fwmode failed\n");
                return -EIO;
        }

        param |= (ar->vif_max << HI_OPTION_NUM_DEV_SHIFT);
        param |= fw_mode << HI_OPTION_FW_MODE_SHIFT;
        param |= fw_submode << HI_OPTION_FW_SUBMODE_SHIFT;

        param |= (0 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
        param |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);

        if (ath6kl_bmi_write_hi32(ar, hi_option_flag, param) != 0) {
                ath6kl_err("bmi_write_memory for setting fwmode failed\n");
                return -EIO;
        }

        ath6kl_dbg(ATH6KL_DBG_TRC, "firmware mode set\n");

        /*
         * Hardcode the address use for the extended board data
         * Ideally this should be pre-allocate by the OS at boot time
         * But since it is a new feature and board data is loaded
         * at init time, we have to workaround this from host.
         * It is difficult to patch the firmware boot code,
         * but possible in theory.
         */

        if ((ar->target_type == TARGET_TYPE_AR6003) ||
            (ar->version.target_ver == AR6004_HW_1_3_VERSION) ||
            (ar->version.target_ver == AR6004_HW_3_0_VERSION)) {
                param = ar->hw.board_ext_data_addr;
                ram_reserved_size = ar->hw.reserved_ram_size;

                if (ath6kl_bmi_write_hi32(ar, hi_board_ext_data, param) != 0) {
                        ath6kl_err("bmi_write_memory for hi_board_ext_data failed\n");
                        return -EIO;
                }

                if (ath6kl_bmi_write_hi32(ar, hi_end_ram_reserve_sz,
                                          ram_reserved_size) != 0) {
                        ath6kl_err("bmi_write_memory for hi_end_ram_reserve_sz failed\n");
                        return -EIO;
                }
        }

        /* set the block size for the target */
        if (ath6kl_set_htc_params(ar, MBOX_YIELD_LIMIT, 0))
                /* use default number of control buffers */
                return -EIO;

        /* Configure GPIO AR600x UART */
        status = ath6kl_bmi_write_hi32(ar, hi_dbg_uart_txpin,
                                       ar->hw.uarttx_pin);
        if (status)
                return status;

        /* Only set the baud rate if we're actually doing debug */
        if (ar->conf_flags & ATH6KL_CONF_UART_DEBUG) {
                status = ath6kl_bmi_write_hi32(ar, hi_desired_baud_rate,
                                               ar->hw.uarttx_rate);
                if (status)
                        return status;
        }

        /* Configure target refclk_hz */
        if (ar->hw.refclk_hz != 0) {
                status = ath6kl_bmi_write_hi32(ar, hi_refclk_hz,
                                               ar->hw.refclk_hz);
                if (status)
                        return status;
        }

        return 0;
}

/* firmware upload */
static int ath6kl_get_fw(struct ath6kl *ar, const char *filename,
                         u8 **fw, size_t *fw_len)
{
        const struct firmware *fw_entry;
        int ret;

        ret = request_firmware(&fw_entry, filename, ar->dev);
        if (ret)
                return ret;

        *fw_len = fw_entry->size;
        *fw = kmemdup(fw_entry->data, fw_entry->size, GFP_KERNEL);

        if (*fw == NULL)
                ret = -ENOMEM;

        release_firmware(fw_entry);

        return ret;
}

#ifdef CONFIG_OF
/*
 * Check the device tree for a board-id and use it to construct
 * the pathname to the firmware file.  Used (for now) to find a
 * fallback to the "bdata.bin" file--typically a symlink to the
 * appropriate board-specific file.
 */
static bool check_device_tree(struct ath6kl *ar)
{
        static const char *board_id_prop = "atheros,board-id";
        struct device_node *node;
        char board_filename[64];
        const char *board_id;
        int ret;

        for_each_compatible_node(node, NULL, "atheros,ath6kl") {
                board_id = of_get_property(node, board_id_prop, NULL);
                if (board_id == NULL) {
                        ath6kl_warn("No \"%s\" property on %pOFn node.\n",
                                    board_id_prop, node);
                        continue;
                }
                snprintf(board_filename, sizeof(board_filename),
                         "%s/bdata.%s.bin", ar->hw.fw.dir, board_id);

                ret = ath6kl_get_fw(ar, board_filename, &ar->fw_board,
                                    &ar->fw_board_len);
                if (ret) {
                        ath6kl_err("Failed to get DT board file %s: %d\n",
                                   board_filename, ret);
                        continue;
                }
                of_node_put(node);
                return true;
        }
        return false;
}
#else
static bool check_device_tree(struct ath6kl *ar)
{
        return false;
}
#endif /* CONFIG_OF */

static int ath6kl_fetch_board_file(struct ath6kl *ar)
{
        const char *filename;
        int ret;

        if (ar->fw_board != NULL)
                return 0;

        if (WARN_ON(ar->hw.fw_board == NULL))
                return -EINVAL;

        filename = ar->hw.fw_board;

        ret = ath6kl_get_fw(ar, filename, &ar->fw_board,
                            &ar->fw_board_len);
        if (ret == 0) {
                /* managed to get proper board file */
                return 0;
        }

        if (check_device_tree(ar)) {
                /* got board file from device tree */
                return 0;
        }

        /* there was no proper board file, try to use default instead */
        ath6kl_warn("Failed to get board file %s (%d), trying to find default board file.\n",
                    filename, ret);

        filename = ar->hw.fw_default_board;

        ret = ath6kl_get_fw(ar, filename, &ar->fw_board,
                            &ar->fw_board_len);
        if (ret) {
                ath6kl_err("Failed to get default board file %s: %d\n",
                           filename, ret);
                return ret;
        }

        ath6kl_warn("WARNING! No proper board file was not found, instead using a default board file.\n");
        ath6kl_warn("Most likely your hardware won't work as specified. Install correct board file!\n");

        return 0;
}

static int ath6kl_fetch_otp_file(struct ath6kl *ar)
{
        char filename[100];
        int ret;

        if (ar->fw_otp != NULL)
                return 0;

        if (ar->hw.fw.otp == NULL) {
                ath6kl_dbg(ATH6KL_DBG_BOOT,
                           "no OTP file configured for this hw\n");
                return 0;
        }

        snprintf(filename, sizeof(filename), "%s/%s",
                 ar->hw.fw.dir, ar->hw.fw.otp);

        ret = ath6kl_get_fw(ar, filename, &ar->fw_otp,
                            &ar->fw_otp_len);
        if (ret) {
                ath6kl_err("Failed to get OTP file %s: %d\n",
                           filename, ret);
                return ret;
        }

        return 0;
}

static int ath6kl_fetch_testmode_file(struct ath6kl *ar)
{
        char filename[100];
        int ret;

        if (ar->testmode == 0)
                return 0;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "testmode %d\n", ar->testmode);

        if (ar->testmode == 2) {
                if (ar->hw.fw.utf == NULL) {
                        ath6kl_warn("testmode 2 not supported\n");
                        return -EOPNOTSUPP;
                }

                snprintf(filename, sizeof(filename), "%s/%s",
                         ar->hw.fw.dir, ar->hw.fw.utf);
        } else {
                if (ar->hw.fw.tcmd == NULL) {
                        ath6kl_warn("testmode 1 not supported\n");
                        return -EOPNOTSUPP;
                }

                snprintf(filename, sizeof(filename), "%s/%s",
                         ar->hw.fw.dir, ar->hw.fw.tcmd);
        }

        set_bit(TESTMODE, &ar->flag);

        ret = ath6kl_get_fw(ar, filename, &ar->fw, &ar->fw_len);
        if (ret) {
                ath6kl_err("Failed to get testmode %d firmware file %s: %d\n",
                           ar->testmode, filename, ret);
                return ret;
        }

        return 0;
}

static int ath6kl_fetch_fw_file(struct ath6kl *ar)
{
        char filename[100];
        int ret;

        if (ar->fw != NULL)
                return 0;

        /* FIXME: remove WARN_ON() as we won't support FW API 1 for long */
        if (WARN_ON(ar->hw.fw.fw == NULL))
                return -EINVAL;

        snprintf(filename, sizeof(filename), "%s/%s",
                 ar->hw.fw.dir, ar->hw.fw.fw);

        ret = ath6kl_get_fw(ar, filename, &ar->fw, &ar->fw_len);
        if (ret) {
                ath6kl_err("Failed to get firmware file %s: %d\n",
                           filename, ret);
                return ret;
        }

        return 0;
}

static int ath6kl_fetch_patch_file(struct ath6kl *ar)
{
        char filename[100];
        int ret;

        if (ar->fw_patch != NULL)
                return 0;

        if (ar->hw.fw.patch == NULL)
                return 0;

        snprintf(filename, sizeof(filename), "%s/%s",
                 ar->hw.fw.dir, ar->hw.fw.patch);

        ret = ath6kl_get_fw(ar, filename, &ar->fw_patch,
                            &ar->fw_patch_len);
        if (ret) {
                ath6kl_err("Failed to get patch file %s: %d\n",
                           filename, ret);
                return ret;
        }

        return 0;
}

static int ath6kl_fetch_testscript_file(struct ath6kl *ar)
{
        char filename[100];
        int ret;

        if (ar->testmode != 2)
                return 0;

        if (ar->fw_testscript != NULL)
                return 0;

        if (ar->hw.fw.testscript == NULL)
                return 0;

        snprintf(filename, sizeof(filename), "%s/%s",
                 ar->hw.fw.dir, ar->hw.fw.testscript);

        ret = ath6kl_get_fw(ar, filename, &ar->fw_testscript,
                                &ar->fw_testscript_len);
        if (ret) {
                ath6kl_err("Failed to get testscript file %s: %d\n",
                           filename, ret);
                return ret;
        }

        return 0;
}

static int ath6kl_fetch_fw_api1(struct ath6kl *ar)
{
        int ret;

        ret = ath6kl_fetch_otp_file(ar);
        if (ret)
                return ret;

        ret = ath6kl_fetch_fw_file(ar);
        if (ret)
                return ret;

        ret = ath6kl_fetch_patch_file(ar);
        if (ret)
                return ret;

        ret = ath6kl_fetch_testscript_file(ar);
        if (ret)
                return ret;

        return 0;
}

static int ath6kl_fetch_fw_apin(struct ath6kl *ar, const char *name)
{
        size_t magic_len, len, ie_len;
        const struct firmware *fw;
        struct ath6kl_fw_ie *hdr;
        char filename[100];
        const u8 *data;
        int ret, ie_id, i, index, bit;
        __le32 *val;

        snprintf(filename, sizeof(filename), "%s/%s", ar->hw.fw.dir, name);

        ret = request_firmware(&fw, filename, ar->dev);
        if (ret) {
                ath6kl_err("Failed request firmware, rv: %d\n", ret);
                return ret;
        }

        data = fw->data;
        len = fw->size;

        /* magic also includes the null byte, check that as well */
        magic_len = strlen(ATH6KL_FIRMWARE_MAGIC) + 1;

        if (len < magic_len) {
                ath6kl_err("Magic length is invalid, len: %zd  magic_len: %zd\n",
                           len, magic_len);
                ret = -EINVAL;
                goto out;
        }

        if (memcmp(data, ATH6KL_FIRMWARE_MAGIC, magic_len) != 0) {
                ath6kl_err("Magic is invalid, magic_len: %zd\n",
                           magic_len);
                ret = -EINVAL;
                goto out;
        }

        len -= magic_len;
        data += magic_len;

        /* loop elements */
        while (len > sizeof(struct ath6kl_fw_ie)) {
                /* hdr is unaligned! */
                hdr = (struct ath6kl_fw_ie *) data;

                ie_id = le32_to_cpup(&hdr->id);
                ie_len = le32_to_cpup(&hdr->len);

                len -= sizeof(*hdr);
                data += sizeof(*hdr);

                ath6kl_dbg(ATH6KL_DBG_BOOT, "ie-id: %d  len: %zd (0x%zx)\n",
                           ie_id, ie_len, ie_len);

                if (len < ie_len) {
                        ath6kl_err("IE len is invalid, len: %zd  ie_len: %zd  ie-id: %d\n",
                                   len, ie_len, ie_id);
                        ret = -EINVAL;
                        goto out;
                }

                switch (ie_id) {
                case ATH6KL_FW_IE_FW_VERSION:
                        strscpy(ar->wiphy->fw_version, data,
                                min(sizeof(ar->wiphy->fw_version), ie_len+1));

                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found fw version %s\n",
                                    ar->wiphy->fw_version);
                        break;
                case ATH6KL_FW_IE_OTP_IMAGE:
                        ath6kl_dbg(ATH6KL_DBG_BOOT, "found otp image ie (%zd B)\n",
                                   ie_len);

                        ar->fw_otp = kmemdup(data, ie_len, GFP_KERNEL);

                        if (ar->fw_otp == NULL) {
                                ath6kl_err("fw_otp cannot be allocated\n");
                                ret = -ENOMEM;
                                goto out;
                        }

                        ar->fw_otp_len = ie_len;
                        break;
                case ATH6KL_FW_IE_FW_IMAGE:
                        ath6kl_dbg(ATH6KL_DBG_BOOT, "found fw image ie (%zd B)\n",
                                   ie_len);

                        /* in testmode we already might have a fw file */
                        if (ar->fw != NULL)
                                break;

                        ar->fw = vmalloc(ie_len);

                        if (ar->fw == NULL) {
                                ath6kl_err("fw storage cannot be allocated, len: %zd\n", ie_len);
                                ret = -ENOMEM;
                                goto out;
                        }

                        memcpy(ar->fw, data, ie_len);
                        ar->fw_len = ie_len;
                        break;
                case ATH6KL_FW_IE_PATCH_IMAGE:
                        ath6kl_dbg(ATH6KL_DBG_BOOT, "found patch image ie (%zd B)\n",
                                   ie_len);

                        ar->fw_patch = kmemdup(data, ie_len, GFP_KERNEL);

                        if (ar->fw_patch == NULL) {
                                ath6kl_err("fw_patch storage cannot be allocated, len: %zd\n", ie_len);
                                ret = -ENOMEM;
                                goto out;
                        }

                        ar->fw_patch_len = ie_len;
                        break;
                case ATH6KL_FW_IE_RESERVED_RAM_SIZE:
                        val = (__le32 *) data;
                        ar->hw.reserved_ram_size = le32_to_cpup(val);

                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found reserved ram size ie %d\n",
                                   ar->hw.reserved_ram_size);
                        break;
                case ATH6KL_FW_IE_CAPABILITIES:
                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found firmware capabilities ie (%zd B)\n",
                                   ie_len);

                        for (i = 0; i < ATH6KL_FW_CAPABILITY_MAX; i++) {
                                index = i / 8;
                                bit = i % 8;

                                if (index == ie_len)
                                        break;

                                if (data[index] & (1 << bit))
                                        __set_bit(i, ar->fw_capabilities);
                        }

                        ath6kl_dbg_dump(ATH6KL_DBG_BOOT, "capabilities", "",
                                        ar->fw_capabilities,
                                        sizeof(ar->fw_capabilities));
                        break;
                case ATH6KL_FW_IE_PATCH_ADDR:
                        if (ie_len != sizeof(*val))
                                break;

                        val = (__le32 *) data;
                        ar->hw.dataset_patch_addr = le32_to_cpup(val);

                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found patch address ie 0x%x\n",
                                   ar->hw.dataset_patch_addr);
                        break;
                case ATH6KL_FW_IE_BOARD_ADDR:
                        if (ie_len != sizeof(*val))
                                break;

                        val = (__le32 *) data;
                        ar->hw.board_addr = le32_to_cpup(val);

                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found board address ie 0x%x\n",
                                   ar->hw.board_addr);
                        break;
                case ATH6KL_FW_IE_VIF_MAX:
                        if (ie_len != sizeof(*val))
                                break;

                        val = (__le32 *) data;
                        ar->vif_max = min_t(unsigned int, le32_to_cpup(val),
                                            ATH6KL_VIF_MAX);

                        if (ar->vif_max > 1 && !ar->p2p)
                                ar->max_norm_iface = 2;

                        ath6kl_dbg(ATH6KL_DBG_BOOT,
                                   "found vif max ie %d\n", ar->vif_max);
                        break;
                default:
                        ath6kl_dbg(ATH6KL_DBG_BOOT, "Unknown fw ie: %u\n",
                                   le32_to_cpup(&hdr->id));
                        break;
                }

                len -= ie_len;
                data += ie_len;
        }

        ret = 0;
out:
        release_firmware(fw);

        return ret;
}

int ath6kl_init_fetch_firmwares(struct ath6kl *ar)
{
        int ret;

        ret = ath6kl_fetch_board_file(ar);
        if (ret)
                return ret;

        ret = ath6kl_fetch_testmode_file(ar);
        if (ret)
                return ret;

        ret = ath6kl_fetch_fw_apin(ar, ATH6KL_FW_API5_FILE);
        if (ret == 0) {
                ar->fw_api = 5;
                goto out;
        }

        ret = ath6kl_fetch_fw_apin(ar, ATH6KL_FW_API4_FILE);
        if (ret == 0) {
                ar->fw_api = 4;
                goto out;
        }

        ret = ath6kl_fetch_fw_apin(ar, ATH6KL_FW_API3_FILE);
        if (ret == 0) {
                ar->fw_api = 3;
                goto out;
        }

        ret = ath6kl_fetch_fw_apin(ar, ATH6KL_FW_API2_FILE);
        if (ret == 0) {
                ar->fw_api = 2;
                goto out;
        }

        ret = ath6kl_fetch_fw_api1(ar);
        if (ret)
                return ret;

        ar->fw_api = 1;

out:
        ath6kl_dbg(ATH6KL_DBG_BOOT, "using fw api %d\n", ar->fw_api);

        return 0;
}

static int ath6kl_upload_board_file(struct ath6kl *ar)
{
        u32 board_address, board_ext_address, param;
        u32 board_data_size, board_ext_data_size;
        int ret;

        if (WARN_ON(ar->fw_board == NULL))
                return -ENOENT;

        /*
         * Determine where in Target RAM to write Board Data.
         * For AR6004, host determine Target RAM address for
         * writing board data.
         */
        if (ar->hw.board_addr != 0) {
                board_address = ar->hw.board_addr;
                ath6kl_bmi_write_hi32(ar, hi_board_data,
                                      board_address);
        } else {
                ret = ath6kl_bmi_read_hi32(ar, hi_board_data, &board_address);
                if (ret) {
                        ath6kl_err("Failed to get board file target address.\n");
                        return ret;
                }
        }

        /* determine where in target ram to write extended board data */
        ret = ath6kl_bmi_read_hi32(ar, hi_board_ext_data, &board_ext_address);
        if (ret) {
                ath6kl_err("Failed to get extended board file target address.\n");
                return ret;
        }

        if (ar->target_type == TARGET_TYPE_AR6003 &&
            board_ext_address == 0) {
                ath6kl_err("Failed to get board file target address.\n");
                return -EINVAL;
        }

        switch (ar->target_type) {
        case TARGET_TYPE_AR6003:
                board_data_size = AR6003_BOARD_DATA_SZ;
                board_ext_data_size = AR6003_BOARD_EXT_DATA_SZ;
                if (ar->fw_board_len > (board_data_size + board_ext_data_size))
                        board_ext_data_size = AR6003_BOARD_EXT_DATA_SZ_V2;
                break;
        case TARGET_TYPE_AR6004:
                board_data_size = AR6004_BOARD_DATA_SZ;
                board_ext_data_size = AR6004_BOARD_EXT_DATA_SZ;
                break;
        default:
                WARN_ON(1);
                return -EINVAL;
        }

        if (board_ext_address &&
            ar->fw_board_len == (board_data_size + board_ext_data_size)) {
                /* write extended board data */
                ath6kl_dbg(ATH6KL_DBG_BOOT,
                           "writing extended board data to 0x%x (%d B)\n",
                           board_ext_address, board_ext_data_size);

                ret = ath6kl_bmi_write(ar, board_ext_address,
                                       ar->fw_board + board_data_size,
                                       board_ext_data_size);
                if (ret) {
                        ath6kl_err("Failed to write extended board data: %d\n",
                                   ret);
                        return ret;
                }

                /* record that extended board data is initialized */
                param = (board_ext_data_size << 16) | 1;

                ath6kl_bmi_write_hi32(ar, hi_board_ext_data_config, param);
        }

        if (ar->fw_board_len < board_data_size) {
                ath6kl_err("Too small board file: %zu\n", ar->fw_board_len);
                ret = -EINVAL;
                return ret;
        }

        ath6kl_dbg(ATH6KL_DBG_BOOT, "writing board file to 0x%x (%d B)\n",
                   board_address, board_data_size);

        ret = ath6kl_bmi_write(ar, board_address, ar->fw_board,
                               board_data_size);

        if (ret) {
                ath6kl_err("Board file bmi write failed: %d\n", ret);
                return ret;
        }

        /* record the fact that Board Data IS initialized */
        if ((ar->version.target_ver == AR6004_HW_1_3_VERSION) ||
            (ar->version.target_ver == AR6004_HW_3_0_VERSION))
                param = board_data_size;
        else
                param = 1;

        ath6kl_bmi_write_hi32(ar, hi_board_data_initialized, param);

        return ret;
}

static int ath6kl_upload_otp(struct ath6kl *ar)
{
        u32 address, param;
        bool from_hw = false;
        int ret;

        if (ar->fw_otp == NULL)
                return 0;

        address = ar->hw.app_load_addr;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "writing otp to 0x%x (%zd B)\n", address,
                   ar->fw_otp_len);

        ret = ath6kl_bmi_fast_download(ar, address, ar->fw_otp,
                                       ar->fw_otp_len);
        if (ret) {
                ath6kl_err("Failed to upload OTP file: %d\n", ret);
                return ret;
        }

        /* read firmware start address */
        ret = ath6kl_bmi_read_hi32(ar, hi_app_start, &address);

        if (ret) {
                ath6kl_err("Failed to read hi_app_start: %d\n", ret);
                return ret;
        }

        if (ar->hw.app_start_override_addr == 0) {
                ar->hw.app_start_override_addr = address;
                from_hw = true;
        }

        ath6kl_dbg(ATH6KL_DBG_BOOT, "app_start_override_addr%s 0x%x\n",
                   from_hw ? " (from hw)" : "",
                   ar->hw.app_start_override_addr);

        /* execute the OTP code */
        ath6kl_dbg(ATH6KL_DBG_BOOT, "executing OTP at 0x%x\n",
                   ar->hw.app_start_override_addr);
        param = 0;
        ath6kl_bmi_execute(ar, ar->hw.app_start_override_addr, &param);

        return ret;
}

static int ath6kl_upload_firmware(struct ath6kl *ar)
{
        u32 address;
        int ret;

        if (WARN_ON(ar->fw == NULL))
                return 0;

        address = ar->hw.app_load_addr;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "writing firmware to 0x%x (%zd B)\n",
                   address, ar->fw_len);

        ret = ath6kl_bmi_fast_download(ar, address, ar->fw, ar->fw_len);

        if (ret) {
                ath6kl_err("Failed to write firmware: %d\n", ret);
                return ret;
        }

        /*
         * Set starting address for firmware
         * Don't need to setup app_start override addr on AR6004
         */
        if (ar->target_type != TARGET_TYPE_AR6004) {
                address = ar->hw.app_start_override_addr;
                ath6kl_bmi_set_app_start(ar, address);
        }
        return ret;
}

static int ath6kl_upload_patch(struct ath6kl *ar)
{
        u32 address;
        int ret;

        if (ar->fw_patch == NULL)
                return 0;

        address = ar->hw.dataset_patch_addr;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "writing patch to 0x%x (%zd B)\n",
                   address, ar->fw_patch_len);

        ret = ath6kl_bmi_write(ar, address, ar->fw_patch, ar->fw_patch_len);
        if (ret) {
                ath6kl_err("Failed to write patch file: %d\n", ret);
                return ret;
        }

        ath6kl_bmi_write_hi32(ar, hi_dset_list_head, address);

        return 0;
}

static int ath6kl_upload_testscript(struct ath6kl *ar)
{
        u32 address;
        int ret;

        if (ar->testmode != 2)
                return 0;

        if (ar->fw_testscript == NULL)
                return 0;

        address = ar->hw.testscript_addr;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "writing testscript to 0x%x (%zd B)\n",
                   address, ar->fw_testscript_len);

        ret = ath6kl_bmi_write(ar, address, ar->fw_testscript,
                ar->fw_testscript_len);
        if (ret) {
                ath6kl_err("Failed to write testscript file: %d\n", ret);
                return ret;
        }

        ath6kl_bmi_write_hi32(ar, hi_ota_testscript, address);

        if ((ar->version.target_ver != AR6004_HW_1_3_VERSION) &&
            (ar->version.target_ver != AR6004_HW_3_0_VERSION))
                ath6kl_bmi_write_hi32(ar, hi_end_ram_reserve_sz, 4096);

        ath6kl_bmi_write_hi32(ar, hi_test_apps_related, 1);

        return 0;
}

static int ath6kl_init_upload(struct ath6kl *ar)
{
        u32 param, options, sleep, address;
        int status = 0;

        if (ar->target_type != TARGET_TYPE_AR6003 &&
            ar->target_type != TARGET_TYPE_AR6004)
                return -EINVAL;

        /* temporarily disable system sleep */
        address = MBOX_BASE_ADDRESS + LOCAL_SCRATCH_ADDRESS;
        status = ath6kl_bmi_reg_read(ar, address, &param);
        if (status)
                return status;

        options = param;

        param |= ATH6KL_OPTION_SLEEP_DISABLE;
        status = ath6kl_bmi_reg_write(ar, address, param);
        if (status)
                return status;

        address = RTC_BASE_ADDRESS + SYSTEM_SLEEP_ADDRESS;
        status = ath6kl_bmi_reg_read(ar, address, &param);
        if (status)
                return status;

        sleep = param;

        param |= SM(SYSTEM_SLEEP_DISABLE, 1);
        status = ath6kl_bmi_reg_write(ar, address, param);
        if (status)
                return status;

        ath6kl_dbg(ATH6KL_DBG_TRC, "old options: %d, old sleep: %d\n",
                   options, sleep);

        /* program analog PLL register */
        /* no need to control 40/44MHz clock on AR6004 */
        if (ar->target_type != TARGET_TYPE_AR6004) {
                status = ath6kl_bmi_reg_write(ar, ATH6KL_ANALOG_PLL_REGISTER,
                                              0xF9104001);

                if (status)
                        return status;

                /* Run at 80/88MHz by default */
                param = SM(CPU_CLOCK_STANDARD, 1);

                address = RTC_BASE_ADDRESS + CPU_CLOCK_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;
        }

        param = 0;
        address = RTC_BASE_ADDRESS + LPO_CAL_ADDRESS;
        param = SM(LPO_CAL_ENABLE, 1);
        status = ath6kl_bmi_reg_write(ar, address, param);
        if (status)
                return status;

        /* WAR to avoid SDIO CRC err */
        if (ar->hw.flags & ATH6KL_HW_SDIO_CRC_ERROR_WAR) {
                ath6kl_err("temporary war to avoid sdio crc error\n");

                param = 0x28;
                address = GPIO_BASE_ADDRESS + GPIO_PIN9_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;

                param = 0x20;

                address = GPIO_BASE_ADDRESS + GPIO_PIN10_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;

                address = GPIO_BASE_ADDRESS + GPIO_PIN11_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;

                address = GPIO_BASE_ADDRESS + GPIO_PIN12_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;

                address = GPIO_BASE_ADDRESS + GPIO_PIN13_ADDRESS;
                status = ath6kl_bmi_reg_write(ar, address, param);
                if (status)
                        return status;
        }

        /* write EEPROM data to Target RAM */
        status = ath6kl_upload_board_file(ar);
        if (status)
                return status;

        /* transfer One time Programmable data */
        status = ath6kl_upload_otp(ar);
        if (status)
                return status;

        /* Download Target firmware */
        status = ath6kl_upload_firmware(ar);
        if (status)
                return status;

        status = ath6kl_upload_patch(ar);
        if (status)
                return status;

        /* Download the test script */
        status = ath6kl_upload_testscript(ar);
        if (status)
                return status;

        /* Restore system sleep */
        address = RTC_BASE_ADDRESS + SYSTEM_SLEEP_ADDRESS;
        status = ath6kl_bmi_reg_write(ar, address, sleep);
        if (status)
                return status;

        address = MBOX_BASE_ADDRESS + LOCAL_SCRATCH_ADDRESS;
        param = options | 0x20;
        status = ath6kl_bmi_reg_write(ar, address, param);
        if (status)
                return status;

        return status;
}

int ath6kl_init_hw_params(struct ath6kl *ar)
{
        const struct ath6kl_hw *hw;
        int i;

        for (i = 0; i < ARRAY_SIZE(hw_list); i++) {
                hw = &hw_list[i];

                if (hw->id == ar->version.target_ver)
                        break;
        }

        if (i == ARRAY_SIZE(hw_list)) {
                ath6kl_err("Unsupported hardware version: 0x%x\n",
                           ar->version.target_ver);
                return -EINVAL;
        }

        ar->hw = *hw;

        ath6kl_dbg(ATH6KL_DBG_BOOT,
                   "target_ver 0x%x target_type 0x%x dataset_patch 0x%x app_load_addr 0x%x\n",
                   ar->version.target_ver, ar->target_type,
                   ar->hw.dataset_patch_addr, ar->hw.app_load_addr);
        ath6kl_dbg(ATH6KL_DBG_BOOT,
                   "app_start_override_addr 0x%x board_ext_data_addr 0x%x reserved_ram_size 0x%x",
                   ar->hw.app_start_override_addr, ar->hw.board_ext_data_addr,
                   ar->hw.reserved_ram_size);
        ath6kl_dbg(ATH6KL_DBG_BOOT,
                   "refclk_hz %d uarttx_pin %d",
                   ar->hw.refclk_hz, ar->hw.uarttx_pin);

        return 0;
}

static const char *ath6kl_init_get_hif_name(enum ath6kl_hif_type type)
{
        switch (type) {
        case ATH6KL_HIF_TYPE_SDIO:
                return "sdio";
        case ATH6KL_HIF_TYPE_USB:
                return "usb";
        }

        return NULL;
}


static const struct fw_capa_str_map {
        int id;
        const char *name;
} fw_capa_map[] = {
        { ATH6KL_FW_CAPABILITY_HOST_P2P, "host-p2p" },
        { ATH6KL_FW_CAPABILITY_SCHED_SCAN, "sched-scan" },
        { ATH6KL_FW_CAPABILITY_STA_P2PDEV_DUPLEX, "sta-p2pdev-duplex" },
        { ATH6KL_FW_CAPABILITY_INACTIVITY_TIMEOUT, "inactivity-timeout" },
        { ATH6KL_FW_CAPABILITY_RSN_CAP_OVERRIDE, "rsn-cap-override" },
        { ATH6KL_FW_CAPABILITY_WOW_MULTICAST_FILTER, "wow-mc-filter" },
        { ATH6KL_FW_CAPABILITY_BMISS_ENHANCE, "bmiss-enhance" },
        { ATH6KL_FW_CAPABILITY_SCHED_SCAN_MATCH_LIST, "sscan-match-list" },
        { ATH6KL_FW_CAPABILITY_RSSI_SCAN_THOLD, "rssi-scan-thold" },
        { ATH6KL_FW_CAPABILITY_CUSTOM_MAC_ADDR, "custom-mac-addr" },
        { ATH6KL_FW_CAPABILITY_TX_ERR_NOTIFY, "tx-err-notify" },
        { ATH6KL_FW_CAPABILITY_REGDOMAIN, "regdomain" },
        { ATH6KL_FW_CAPABILITY_SCHED_SCAN_V2, "sched-scan-v2" },
        { ATH6KL_FW_CAPABILITY_HEART_BEAT_POLL, "hb-poll" },
        { ATH6KL_FW_CAPABILITY_64BIT_RATES, "64bit-rates" },
        { ATH6KL_FW_CAPABILITY_AP_INACTIVITY_MINS, "ap-inactivity-mins" },
        { ATH6KL_FW_CAPABILITY_MAP_LP_ENDPOINT, "map-lp-endpoint" },
        { ATH6KL_FW_CAPABILITY_RATETABLE_MCS15, "ratetable-mcs15" },
        { ATH6KL_FW_CAPABILITY_NO_IP_CHECKSUM, "no-ip-checksum" },
};

static const char *ath6kl_init_get_fw_capa_name(unsigned int id)
{
        int i;

        for (i = 0; i < ARRAY_SIZE(fw_capa_map); i++) {
                if (fw_capa_map[i].id == id)
                        return fw_capa_map[i].name;
        }

        return "<unknown>";
}

static void ath6kl_init_get_fwcaps(struct ath6kl *ar, char *buf, size_t buf_len)
{
        u8 *data = (u8 *) ar->fw_capabilities;
        size_t trunc_len, len = 0;
        int i, index, bit;
        char *trunc = "...";

        for (i = 0; i < ATH6KL_FW_CAPABILITY_MAX; i++) {
                index = i / 8;
                bit = i % 8;

                if (index >= sizeof(ar->fw_capabilities) * 4)
                        break;

                if (buf_len - len < 4) {
                        ath6kl_warn("firmware capability buffer too small!\n");

                        /* add "..." to the end of string */
                        trunc_len = strlen(trunc) + 1;
                        memcpy(buf + buf_len - trunc_len, trunc, trunc_len);

                        return;
                }

                if (data[index] & (1 << bit)) {
                        len += scnprintf(buf + len, buf_len - len, "%s,",
                                            ath6kl_init_get_fw_capa_name(i));
                }
        }

        /* overwrite the last comma */
        if (len > 0)
                len--;

        buf[len] = '\0';
}

static int ath6kl_init_hw_reset(struct ath6kl *ar)
{
        ath6kl_dbg(ATH6KL_DBG_BOOT, "cold resetting the device");

        return ath6kl_diag_write32(ar, RESET_CONTROL_ADDRESS,
                                   cpu_to_le32(RESET_CONTROL_COLD_RST));
}

static int __ath6kl_init_hw_start(struct ath6kl *ar)
{
        long timeleft;
        int ret, i;
        char buf[200];

        ath6kl_dbg(ATH6KL_DBG_BOOT, "hw start\n");

        ret = ath6kl_hif_power_on(ar);
        if (ret)
                return ret;

        ret = ath6kl_configure_target(ar);
        if (ret)
                goto err_power_off;

        ret = ath6kl_init_upload(ar);
        if (ret)
                goto err_power_off;

        /* Do we need to finish the BMI phase */
        ret = ath6kl_bmi_done(ar);
        if (ret)
                goto err_power_off;

        /*
         * The reason we have to wait for the target here is that the
         * driver layer has to init BMI in order to set the host block
         * size.
         */
        ret = ath6kl_htc_wait_target(ar->htc_target);

        if (ret == -ETIMEDOUT) {
                /*
                 * Most likely USB target is in odd state after reboot and
                 * needs a reset. A cold reset makes the whole device
                 * disappear from USB bus and initialisation starts from
                 * beginning.
                 */
                ath6kl_warn("htc wait target timed out, resetting device\n");
                ath6kl_init_hw_reset(ar);
                goto err_power_off;
        } else if (ret) {
                ath6kl_err("htc wait target failed: %d\n", ret);
                goto err_power_off;
        }

        ret = ath6kl_init_service_ep(ar);
        if (ret) {
                ath6kl_err("Endpoint service initialization failed: %d\n", ret);
                goto err_cleanup_scatter;
        }

        /* setup credit distribution */
        ath6kl_htc_credit_setup(ar->htc_target, &ar->credit_state_info);

        /* start HTC */
        ret = ath6kl_htc_start(ar->htc_target);
        if (ret) {
                /* FIXME: call this */
                ath6kl_cookie_cleanup(ar);
                goto err_cleanup_scatter;
        }

        /* Wait for Wmi event to be ready */
        timeleft = wait_event_interruptible_timeout(ar->event_wq,
                                                    test_bit(WMI_READY,
                                                             &ar->flag),
                                                    WMI_TIMEOUT);
        if (timeleft <= 0) {
                clear_bit(WMI_READY, &ar->flag);
                ath6kl_err("wmi is not ready or wait was interrupted: %ld\n",
                           timeleft);
                ret = -EIO;
                goto err_htc_stop;
        }

        ath6kl_dbg(ATH6KL_DBG_BOOT, "firmware booted\n");

        if (test_and_clear_bit(FIRST_BOOT, &ar->flag)) {
                ath6kl_info("%s %s fw %s api %d%s\n",
                            ar->hw.name,
                            ath6kl_init_get_hif_name(ar->hif_type),
                            ar->wiphy->fw_version,
                            ar->fw_api,
                            test_bit(TESTMODE, &ar->flag) ? " testmode" : "");
                ath6kl_init_get_fwcaps(ar, buf, sizeof(buf));
                ath6kl_info("firmware supports: %s\n", buf);
        }

        if (ar->version.abi_ver != ATH6KL_ABI_VERSION) {
                ath6kl_err("abi version mismatch: host(0x%x), target(0x%x)\n",
                           ATH6KL_ABI_VERSION, ar->version.abi_ver);
                ret = -EIO;
                goto err_htc_stop;
        }

        ath6kl_dbg(ATH6KL_DBG_TRC, "%s: wmi is ready\n", __func__);

        /* communicate the wmi protocol verision to the target */
        /* FIXME: return error */
        if ((ath6kl_set_host_app_area(ar)) != 0)
                ath6kl_err("unable to set the host app area\n");

        for (i = 0; i < ar->vif_max; i++) {
                ret = ath6kl_target_config_wlan_params(ar, i);
                if (ret)
                        goto err_htc_stop;
        }

        return 0;

err_htc_stop:
        ath6kl_htc_stop(ar->htc_target);
err_cleanup_scatter:
        ath6kl_hif_cleanup_scatter(ar);
err_power_off:
        ath6kl_hif_power_off(ar);

        return ret;
}

int ath6kl_init_hw_start(struct ath6kl *ar)
{
        int err;

        err = __ath6kl_init_hw_start(ar);
        if (err)
                return err;
        ar->state = ATH6KL_STATE_ON;
        return 0;
}

static int __ath6kl_init_hw_stop(struct ath6kl *ar)
{
        int ret;

        ath6kl_dbg(ATH6KL_DBG_BOOT, "hw stop\n");

        ath6kl_htc_stop(ar->htc_target);

        ath6kl_hif_stop(ar);

        ath6kl_bmi_reset(ar);

        ret = ath6kl_hif_power_off(ar);
        if (ret)
                ath6kl_warn("failed to power off hif: %d\n", ret);

        return 0;
}

int ath6kl_init_hw_stop(struct ath6kl *ar)
{
        int err;

        err = __ath6kl_init_hw_stop(ar);
        if (err)
                return err;
        ar->state = ATH6KL_STATE_OFF;
        return 0;
}

void ath6kl_init_hw_restart(struct ath6kl *ar)
{
        clear_bit(WMI_READY, &ar->flag);

        ath6kl_cfg80211_stop_all(ar);

        if (__ath6kl_init_hw_stop(ar)) {
                ath6kl_dbg(ATH6KL_DBG_RECOVERY, "Failed to stop during fw error recovery\n");
                return;
        }

        if (__ath6kl_init_hw_start(ar)) {
                ath6kl_dbg(ATH6KL_DBG_RECOVERY, "Failed to restart during fw error recovery\n");
                return;
        }
}

void ath6kl_stop_txrx(struct ath6kl *ar)
{
        struct ath6kl_vif *vif, *tmp_vif;
        int i;

        set_bit(DESTROY_IN_PROGRESS, &ar->flag);

        if (down_interruptible(&ar->sem)) {
                ath6kl_err("down_interruptible failed\n");
                return;
        }

        for (i = 0; i < AP_MAX_NUM_STA; i++)
                aggr_reset_state(ar->sta_list[i].aggr_conn);

        spin_lock_bh(&ar->list_lock);
        list_for_each_entry_safe(vif, tmp_vif, &ar->vif_list, list) {
                list_del(&vif->list);
                spin_unlock_bh(&ar->list_lock);
                ath6kl_cfg80211_vif_stop(vif, test_bit(WMI_READY, &ar->flag));
                rtnl_lock();
                wiphy_lock(ar->wiphy);
                ath6kl_cfg80211_vif_cleanup(vif);
                wiphy_unlock(ar->wiphy);
                rtnl_unlock();
                spin_lock_bh(&ar->list_lock);
        }
        spin_unlock_bh(&ar->list_lock);

        clear_bit(WMI_READY, &ar->flag);

        if (ar->fw_recovery.enable)
                timer_delete_sync(&ar->fw_recovery.hb_timer);

        /*
         * After wmi_shudown all WMI events will be dropped. We
         * need to cleanup the buffers allocated in AP mode and
         * give disconnect notification to stack, which usually
         * happens in the disconnect_event. Simulate the disconnect
         * event by calling the function directly. Sometimes
         * disconnect_event will be received when the debug logs
         * are collected.
         */
        ath6kl_wmi_shutdown(ar->wmi);

        clear_bit(WMI_ENABLED, &ar->flag);
        if (ar->htc_target) {
                ath6kl_dbg(ATH6KL_DBG_TRC, "%s: shut down htc\n", __func__);
                ath6kl_htc_stop(ar->htc_target);
        }

        /*
         * Try to reset the device if we can. The driver may have been
         * configure NOT to reset the target during a debug session.
         */
        ath6kl_init_hw_reset(ar);

        up(&ar->sem);
}
EXPORT_SYMBOL(ath6kl_stop_txrx);