These changes are the raw update to linux-4.4.6-rt14. Kernel sources
[kvmfornfv.git] / kernel / drivers / staging / rtl8192e / rtl8192e / r8192E_firmware.c
index c465f87..9aaa855 100644 (file)
@@ -6,10 +6,6 @@
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  * more details.
  *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
- *
  * The full GNU General Public License is included in this distribution in the
  * file called LICENSE.
  *
 #include "r8192E_hw.h"
 #include "r8192E_hwimg.h"
 #include "r8192E_firmware.h"
+#include "r8192E_cmdpkt.h"
 #include <linux/firmware.h>
 
-void firmware_init_param(struct net_device *dev)
-{
-       struct r8192_priv *priv = rtllib_priv(dev);
-       struct rt_firmware *pfirmware = priv->pFirmware;
-
-       pfirmware->cmdpacket_frag_thresold = GET_COMMAND_PACKET_FRAG_THRESHOLD(
-                                            MAX_TRANSMIT_BUFFER_SIZE);
-}
-
-static bool fw_download_code(struct net_device *dev, u8 *code_virtual_address,
-                            u32 buffer_len)
+static bool _rtl92e_wait_for_fw(struct net_device *dev, u32 mask, u32 timeout)
 {
-       struct r8192_priv *priv = rtllib_priv(dev);
-       u16                 frag_threshold;
-       u16                 frag_length, frag_offset = 0;
-       int                 i;
-
-       struct rt_firmware *pfirmware = priv->pFirmware;
-       struct sk_buff      *skb;
-       unsigned char       *seg_ptr;
-       struct cb_desc *tcb_desc;
-       u8                  bLastIniPkt;
-
-       firmware_init_param(dev);
-       frag_threshold = pfirmware->cmdpacket_frag_thresold;
-       do {
-               if ((buffer_len - frag_offset) > frag_threshold) {
-                       frag_length = frag_threshold;
-                       bLastIniPkt = 0;
-
-               } else {
-                       frag_length = buffer_len - frag_offset;
-                       bLastIniPkt = 1;
-
-               }
-
-               skb  = dev_alloc_skb(frag_length + 4);
-               memcpy((unsigned char *)(skb->cb), &dev, sizeof(dev));
-               tcb_desc = (struct cb_desc *)(skb->cb + MAX_DEV_ADDR_SIZE);
-               tcb_desc->queue_index = TXCMD_QUEUE;
-               tcb_desc->bCmdOrInit = DESC_PACKET_TYPE_INIT;
-               tcb_desc->bLastIniPkt = bLastIniPkt;
-
-               seg_ptr = skb->data;
-               for (i = 0; i < frag_length; i += 4) {
-                       *seg_ptr++ = ((i+0) < frag_length) ?
-                                    code_virtual_address[i+3] : 0;
-                       *seg_ptr++ = ((i+1) < frag_length) ?
-                                    code_virtual_address[i+2] : 0;
-                       *seg_ptr++ = ((i+2) < frag_length) ?
-                                    code_virtual_address[i+1] : 0;
-                       *seg_ptr++ = ((i+3) < frag_length) ?
-                                    code_virtual_address[i+0] : 0;
-               }
-               tcb_desc->txbuf_size = (u16)i;
-               skb_put(skb, i);
-
-               if (!priv->rtllib->check_nic_enough_desc(dev, tcb_desc->queue_index) ||
-                   (!skb_queue_empty(&priv->rtllib->skb_waitQ[tcb_desc->queue_index])) ||
-                   (priv->rtllib->queue_stop)) {
-                       RT_TRACE(COMP_FIRMWARE,
-                                "===================> tx full!\n");
-                       skb_queue_tail(&priv->rtllib->skb_waitQ
-                                       [tcb_desc->queue_index], skb);
-               } else {
-               priv->rtllib->softmac_hard_start_xmit(skb, dev);
-               }
-
-               code_virtual_address += frag_length;
-               frag_offset += frag_length;
-
-       } while (frag_offset < buffer_len);
+       unsigned long deadline = jiffies + msecs_to_jiffies(timeout);
 
-       write_nic_byte(dev, TPPoll, TPPoll_CQ);
-
-       return true;
+       while (time_before(jiffies, deadline)) {
+               if (rtl92e_readl(dev, CPU_GEN) & mask)
+                       return true;
+               mdelay(2);
+       }
+       return false;
 }
 
-static bool CPUcheck_maincodeok_turnonCPU(struct net_device *dev)
+static bool _rtl92e_fw_boot_cpu(struct net_device *dev)
 {
-       bool            rt_status = true;
        u32             CPU_status = 0;
-       unsigned long   timeout;
 
-       timeout = jiffies + msecs_to_jiffies(200);
-       while (time_before(jiffies, timeout)) {
-               CPU_status = read_nic_dword(dev, CPU_GEN);
-               if (CPU_status & CPU_GEN_PUT_CODE_OK)
-                       break;
-               mdelay(2);
-       }
-
-       if (!(CPU_status&CPU_GEN_PUT_CODE_OK)) {
-               RT_TRACE(COMP_ERR, "Download Firmware: Put code fail!\n");
-               goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
-       } else {
-               RT_TRACE(COMP_FIRMWARE, "Download Firmware: Put code ok!\n");
+       if (!_rtl92e_wait_for_fw(dev, CPU_GEN_PUT_CODE_OK, 200)) {
+               netdev_err(dev, "Firmware download failed.\n");
+               return false;
        }
+       netdev_dbg(dev, "Download Firmware: Put code ok!\n");
 
-       CPU_status = read_nic_dword(dev, CPU_GEN);
-       write_nic_byte(dev, CPU_GEN,
-                      (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
+       CPU_status = rtl92e_readl(dev, CPU_GEN);
+       rtl92e_writeb(dev, CPU_GEN,
+                     (u8)((CPU_status|CPU_GEN_PWR_STB_CPU)&0xff));
        mdelay(1);
 
-       timeout = jiffies + msecs_to_jiffies(200);
-       while (time_before(jiffies, timeout)) {
-               CPU_status = read_nic_dword(dev, CPU_GEN);
-               if (CPU_status&CPU_GEN_BOOT_RDY)
-                       break;
-               mdelay(2);
-       }
-
-       if (!(CPU_status&CPU_GEN_BOOT_RDY))
-               goto CPUCheckMainCodeOKAndTurnOnCPU_Fail;
-       else
-               RT_TRACE(COMP_FIRMWARE, "Download Firmware: Boot ready!\n");
-
-       return rt_status;
-
-CPUCheckMainCodeOKAndTurnOnCPU_Fail:
-       RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
-       rt_status = false;
-       return rt_status;
-}
-
-static bool CPUcheck_firmware_ready(struct net_device *dev)
-{
-
-       bool    rt_status = true;
-       u32     CPU_status = 0;
-       unsigned long timeout;
-
-       timeout = jiffies + msecs_to_jiffies(20);
-       while (time_before(jiffies, timeout)) {
-               CPU_status = read_nic_dword(dev, CPU_GEN);
-               if (CPU_status&CPU_GEN_FIRM_RDY)
-                       break;
-               mdelay(2);
+       if (!_rtl92e_wait_for_fw(dev, CPU_GEN_BOOT_RDY, 200)) {
+               netdev_err(dev, "Firmware boot failed.\n");
+               return false;
        }
 
-       if (!(CPU_status&CPU_GEN_FIRM_RDY))
-               goto CPUCheckFirmwareReady_Fail;
-       else
-               RT_TRACE(COMP_FIRMWARE, "Download Firmware: Firmware ready!\n");
-
-       return rt_status;
-
-CPUCheckFirmwareReady_Fail:
-       RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
-       rt_status = false;
-       return rt_status;
+       netdev_dbg(dev, "Download Firmware: Boot ready!\n");
 
+       return true;
 }
 
-static bool firmware_check_ready(struct net_device *dev,
-                                       u8 load_fw_status)
+static bool _rtl92e_fw_check_ready(struct net_device *dev,
+                                  u8 load_fw_status)
 {
        struct r8192_priv *priv = rtllib_priv(dev);
        struct rt_firmware *pfirmware = priv->pFirmware;
@@ -186,63 +66,97 @@ static bool firmware_check_ready(struct net_device *dev,
 
        switch (load_fw_status) {
        case FW_INIT_STEP0_BOOT:
-               pfirmware->firmware_status = FW_STATUS_1_MOVE_BOOT_CODE;
+               pfirmware->status = FW_STATUS_1_MOVE_BOOT_CODE;
                break;
 
        case FW_INIT_STEP1_MAIN:
-               pfirmware->firmware_status = FW_STATUS_2_MOVE_MAIN_CODE;
+               pfirmware->status = FW_STATUS_2_MOVE_MAIN_CODE;
 
-               rt_status = CPUcheck_maincodeok_turnonCPU(dev);
+               rt_status = _rtl92e_fw_boot_cpu(dev);
                if (rt_status)
-                       pfirmware->firmware_status = FW_STATUS_3_TURNON_CPU;
+                       pfirmware->status = FW_STATUS_3_TURNON_CPU;
                else
-                       RT_TRACE(COMP_FIRMWARE,
-                                "CPUcheck_maincodeok_turnonCPU fail!\n");
+                       netdev_dbg(dev, "_rtl92e_fw_boot_cpu fail!\n");
 
                break;
 
        case FW_INIT_STEP2_DATA:
-               pfirmware->firmware_status = FW_STATUS_4_MOVE_DATA_CODE;
+               pfirmware->status = FW_STATUS_4_MOVE_DATA_CODE;
                mdelay(1);
 
-               rt_status = CPUcheck_firmware_ready(dev);
+               rt_status = _rtl92e_wait_for_fw(dev, CPU_GEN_FIRM_RDY, 20);
                if (rt_status)
-                       pfirmware->firmware_status = FW_STATUS_5_READY;
+                       pfirmware->status = FW_STATUS_5_READY;
                else
                        RT_TRACE(COMP_FIRMWARE,
-                                "CPUcheck_firmware_ready fail(%d)!\n",
+                                "_rtl92e_is_fw_ready fail(%d)!\n",
                                 rt_status);
-
                break;
        default:
                rt_status = false;
-               RT_TRACE(COMP_FIRMWARE, "Unknown firmware status");
+               netdev_dbg(dev, "Unknown firmware status");
                break;
        }
 
        return rt_status;
 }
 
-bool init_firmware(struct net_device *dev)
+static bool _rtl92e_fw_prepare(struct net_device *dev, struct rt_fw_blob *blob,
+                              const char *name, u8 padding)
+{
+       const struct firmware *fw;
+       int rc, i;
+       bool ret = true;
+
+       rc = request_firmware(&fw, name, &dev->dev);
+       if (rc < 0)
+               return false;
+
+       if (round_up(fw->size, 4) > MAX_FW_SIZE - padding) {
+               netdev_err(dev, "Firmware image %s too big for the device.\n",
+                          name);
+               ret = false;
+               goto out;
+       }
+
+       if (padding)
+               memset(blob->data, 0, padding);
+       if (fw->size % 4)
+               memset(blob->data + padding + fw->size, 0, 4);
+       memcpy(blob->data + padding, fw->data, fw->size);
+
+       blob->size = round_up(fw->size, 4) + padding;
+
+       /* Swap endian - firmware is packaged in invalid endiannes*/
+       for (i = padding; i < blob->size; i += 4) {
+               u32 *data = (u32 *)(blob->data + i);
+               *data = swab32p(data);
+       }
+out:
+       release_firmware(fw);
+       return ret;
+}
+
+bool rtl92e_init_fw(struct net_device *dev)
 {
        struct r8192_priv *priv = rtllib_priv(dev);
        bool                    rt_status = true;
 
        u32     file_length = 0;
        u8      *mapped_file = NULL;
-       u8      init_step = 0;
+       u8      i = 0;
        enum opt_rst_type rst_opt = OPT_SYSTEM_RESET;
        enum firmware_init_step starting_state = FW_INIT_STEP0_BOOT;
 
        struct rt_firmware *pfirmware = priv->pFirmware;
 
-       RT_TRACE(COMP_FIRMWARE, " PlatformInitFirmware()==>\n");
+       netdev_dbg(dev, " PlatformInitFirmware()==>\n");
 
-       if (pfirmware->firmware_status == FW_STATUS_0_INIT) {
+       if (pfirmware->status == FW_STATUS_0_INIT) {
                rst_opt = OPT_SYSTEM_RESET;
                starting_state = FW_INIT_STEP0_BOOT;
 
-       } else if (pfirmware->firmware_status == FW_STATUS_5_READY) {
+       } else if (pfirmware->status == FW_STATUS_5_READY) {
                rst_opt = OPT_FIRMWARE_RESET;
                starting_state = FW_INIT_STEP2_DATA;
        } else {
@@ -250,69 +164,44 @@ bool init_firmware(struct net_device *dev)
                         "PlatformInitFirmware: undefined firmware state\n");
        }
 
-       for (init_step = starting_state; init_step <= FW_INIT_STEP2_DATA;
-            init_step++) {
+       for (i = starting_state; i <= FW_INIT_STEP2_DATA; i++) {
                if (rst_opt == OPT_SYSTEM_RESET) {
-                       if (pfirmware->firmware_buf_size[init_step] == 0) {
+                       if (pfirmware->blobs[i].size == 0) {
                                const char *fw_name[3] = {
                                        RTL8192E_BOOT_IMG_FW,
                                        RTL8192E_MAIN_IMG_FW,
                                        RTL8192E_DATA_IMG_FW
                                };
-                               const struct firmware *fw_entry;
-                               int rc;
-
-                               rc = request_firmware(&fw_entry,
-                                                     fw_name[init_step],
-                                                     &priv->pdev->dev);
-                               if (rc < 0) {
-                                       RT_TRACE(COMP_FIRMWARE,
-                                                "request firmware fail!\n");
-                                       goto download_firmware_fail;
-                               }
-                               if (fw_entry->size >
-                                   sizeof(pfirmware->firmware_buf[init_step])) {
-                                       RT_TRACE(COMP_FIRMWARE,
-                                                "img file size exceed the container struct buffer fail!\n");
+                               int pad = 0;
+
+                               if (i == FW_INIT_STEP1_MAIN)
+                                       pad = 128;
+
+                               if (!_rtl92e_fw_prepare(dev,
+                                                       &pfirmware->blobs[i],
+                                                       fw_name[i],
+                                                       pad))
                                        goto download_firmware_fail;
-                               }
-
-                               if (init_step != FW_INIT_STEP1_MAIN) {
-                                       memcpy(pfirmware->firmware_buf[init_step],
-                                              fw_entry->data, fw_entry->size);
-                                       pfirmware->firmware_buf_size[init_step] =
-                                               fw_entry->size;
-
-                               } else {
-                                       memset(pfirmware->firmware_buf[init_step],
-                                              0, 128);
-                                       memcpy(&pfirmware->firmware_buf[init_step][128],
-                                              fw_entry->data, fw_entry->size);
-                                       pfirmware->firmware_buf_size[init_step] =
-                                               fw_entry->size + 128;
-                               }
-
-                               if (rst_opt == OPT_SYSTEM_RESET)
-                                       release_firmware(fw_entry);
                        }
                }
 
-               mapped_file = pfirmware->firmware_buf[init_step];
-               file_length = pfirmware->firmware_buf_size[init_step];
+               mapped_file = pfirmware->blobs[i].data;
+               file_length = pfirmware->blobs[i].size;
 
-               rt_status = fw_download_code(dev, mapped_file, file_length);
+               rt_status = rtl92e_send_cmd_pkt(dev, DESC_PACKET_TYPE_INIT,
+                                               mapped_file, file_length);
                if (!rt_status)
                        goto download_firmware_fail;
 
-               if (!firmware_check_ready(dev, init_step))
+               if (!_rtl92e_fw_check_ready(dev, i))
                        goto download_firmware_fail;
        }
 
-       RT_TRACE(COMP_FIRMWARE, "Firmware Download Success\n");
+       netdev_dbg(dev, "Firmware Download Success\n");
        return rt_status;
 
 download_firmware_fail:
-       RT_TRACE(COMP_ERR, "ERR in %s()\n", __func__);
+       netdev_err(dev, "%s: Failed to initialize firmware.\n", __func__);
        rt_status = false;
        return rt_status;