2 * iwmc3200top - Intel Wireless MultiCom 3200 Top Driver
3 * drivers/misc/iwmc3200top/fw-download.c
5 * Copyright (C) 2009 Intel Corporation. All rights reserved.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
22 * Author Name: Maxim Grabarnik <maxim.grabarnink@intel.com>
27 #include <linux/firmware.h>
28 #include <linux/mmc/sdio_func.h>
29 #include <asm/unaligned.h>
31 #include "iwmc3200top.h"
35 #define CHECKSUM_BYTES_NUM sizeof(u32)
38 init parser struct with file
40 static int iwmct_fw_parser_init(struct iwmct_priv *priv, const u8 *file,
41 size_t file_size, size_t block_size)
43 struct iwmct_parser *parser = &priv->parser;
44 struct iwmct_fw_hdr *fw_hdr = &parser->versions;
46 LOG_INFOEX(priv, INIT, "-->\n");
48 LOG_INFO(priv, FW_DOWNLOAD, "file_size=%zd\n", file_size);
51 parser->file_size = file_size;
53 parser->entry_point = 0;
54 parser->buf = kzalloc(block_size, GFP_KERNEL);
56 LOG_ERROR(priv, FW_DOWNLOAD, "kzalloc error\n");
59 parser->buf_size = block_size;
61 /* extract fw versions */
62 memcpy(fw_hdr, parser->file, sizeof(struct iwmct_fw_hdr));
63 LOG_INFO(priv, FW_DOWNLOAD, "fw versions are:\n"
64 "top %u.%u.%u gps %u.%u.%u bt %u.%u.%u tic %s\n",
65 fw_hdr->top_major, fw_hdr->top_minor, fw_hdr->top_revision,
66 fw_hdr->gps_major, fw_hdr->gps_minor, fw_hdr->gps_revision,
67 fw_hdr->bt_major, fw_hdr->bt_minor, fw_hdr->bt_revision,
70 parser->cur_pos += sizeof(struct iwmct_fw_hdr);
72 LOG_INFOEX(priv, INIT, "<--\n");
76 static bool iwmct_checksum(struct iwmct_priv *priv)
78 struct iwmct_parser *parser = &priv->parser;
79 __le32 *file = (__le32 *)parser->file;
83 u32 mask = 0xffffffff;
85 pad = (parser->file_size - CHECKSUM_BYTES_NUM) % 4;
86 steps = (parser->file_size - CHECKSUM_BYTES_NUM) / 4;
88 LOG_INFO(priv, FW_DOWNLOAD, "pad=%d steps=%d\n", pad, steps);
90 for (i = 0; i < steps; i++)
91 accum += le32_to_cpu(file[i]);
94 mask <<= 8 * (4 - pad);
95 accum += le32_to_cpu(file[steps]) & mask;
98 checksum = get_unaligned_le32((__le32 *)(parser->file +
99 parser->file_size - CHECKSUM_BYTES_NUM));
101 LOG_INFO(priv, FW_DOWNLOAD,
102 "compare checksum accum=0x%x to checksum=0x%x\n",
105 return checksum == accum;
108 static int iwmct_parse_next_section(struct iwmct_priv *priv, const u8 **p_sec,
109 size_t *sec_size, __le32 *sec_addr)
111 struct iwmct_parser *parser = &priv->parser;
112 struct iwmct_dbg *dbg = &priv->dbg;
113 struct iwmct_fw_sec_hdr *sec_hdr;
115 LOG_INFOEX(priv, INIT, "-->\n");
117 while (parser->cur_pos + sizeof(struct iwmct_fw_sec_hdr)
118 <= parser->file_size) {
120 sec_hdr = (struct iwmct_fw_sec_hdr *)
121 (parser->file + parser->cur_pos);
122 parser->cur_pos += sizeof(struct iwmct_fw_sec_hdr);
124 LOG_INFO(priv, FW_DOWNLOAD,
125 "sec hdr: type=%s addr=0x%x size=%d\n",
126 sec_hdr->type, sec_hdr->target_addr,
129 if (strcmp(sec_hdr->type, "ENT") == 0)
130 parser->entry_point = le32_to_cpu(sec_hdr->target_addr);
131 else if (strcmp(sec_hdr->type, "LBL") == 0)
132 strcpy(dbg->label_fw, parser->file + parser->cur_pos);
133 else if (((strcmp(sec_hdr->type, "TOP") == 0) &&
134 (priv->barker & BARKER_DNLOAD_TOP_MSK)) ||
135 ((strcmp(sec_hdr->type, "GPS") == 0) &&
136 (priv->barker & BARKER_DNLOAD_GPS_MSK)) ||
137 ((strcmp(sec_hdr->type, "BTH") == 0) &&
138 (priv->barker & BARKER_DNLOAD_BT_MSK))) {
139 *sec_addr = sec_hdr->target_addr;
140 *sec_size = le32_to_cpu(sec_hdr->data_size);
141 *p_sec = parser->file + parser->cur_pos;
142 parser->cur_pos += le32_to_cpu(sec_hdr->data_size);
144 } else if (strcmp(sec_hdr->type, "LOG") != 0)
145 LOG_WARNING(priv, FW_DOWNLOAD,
146 "skipping section type %s\n",
149 parser->cur_pos += le32_to_cpu(sec_hdr->data_size);
150 LOG_INFO(priv, FW_DOWNLOAD,
151 "finished with section cur_pos=%zd\n", parser->cur_pos);
154 LOG_INFOEX(priv, INIT, "<--\n");
158 static int iwmct_download_section(struct iwmct_priv *priv, const u8 *p_sec,
159 size_t sec_size, __le32 addr)
161 struct iwmct_parser *parser = &priv->parser;
162 struct iwmct_fw_load_hdr *hdr = (struct iwmct_fw_load_hdr *)parser->buf;
163 const u8 *cur_block = p_sec;
169 LOG_INFOEX(priv, INIT, "-->\n");
170 LOG_INFO(priv, FW_DOWNLOAD, "Download address 0x%x size 0x%zx\n",
173 while (sent < sec_size) {
176 u32 reset = atomic_read(&priv->reset);
178 u32 data_size = min(parser->buf_size - sizeof(*hdr),
180 /* Pad to block size */
181 u32 trans_size = (data_size + sizeof(*hdr) +
182 IWMC_SDIO_BLK_SIZE - 1) &
183 ~(IWMC_SDIO_BLK_SIZE - 1);
186 /* in case of reset, interrupt FW DOWNLAOD */
188 LOG_INFO(priv, FW_DOWNLOAD,
189 "Reset detected. Abort FW download!!!");
194 memset(parser->buf, 0, parser->buf_size);
195 cmd |= IWMC_OPCODE_WRITE << CMD_HDR_OPCODE_POS;
196 cmd |= IWMC_CMD_SIGNATURE << CMD_HDR_SIGNATURE_POS;
197 cmd |= (priv->dbg.direct ? 1 : 0) << CMD_HDR_DIRECT_ACCESS_POS;
198 cmd |= (priv->dbg.checksum ? 1 : 0) << CMD_HDR_USE_CHECKSUM_POS;
199 hdr->data_size = cpu_to_le32(data_size);
200 hdr->target_addr = addr;
202 /* checksum is allowed for sizes divisible by 4 */
204 cmd &= ~CMD_HDR_USE_CHECKSUM_MSK;
206 memcpy(hdr->data, cur_block, data_size);
209 if (cmd & CMD_HDR_USE_CHECKSUM_MSK) {
211 chksm = data_size + le32_to_cpu(addr) + cmd;
212 for (i = 0; i < data_size >> 2; i++)
213 chksm += ((u32 *)cur_block)[i];
215 hdr->block_chksm = cpu_to_le32(chksm);
216 LOG_INFO(priv, FW_DOWNLOAD, "Checksum = 0x%X\n",
220 LOG_INFO(priv, FW_DOWNLOAD, "trans#%d, len=%d, sent=%zd, "
221 "sec_size=%zd, startAddress 0x%X\n",
222 cnt, trans_size, sent, sec_size, addr);
225 LOG_HEXDUMP(FW_DOWNLOAD, parser->buf, trans_size);
228 hdr->cmd = cpu_to_le32(cmd);
230 /* TODO: add more proper sending and error checking */
231 ret = iwmct_tx(priv, 0, parser->buf, trans_size);
233 LOG_INFO(priv, FW_DOWNLOAD,
234 "iwmct_tx returned %d\n", ret);
238 addr = cpu_to_le32(le32_to_cpu(addr) + data_size);
240 cur_block = p_sec + sent;
242 if (priv->dbg.blocks && (cnt + 1) >= priv->dbg.blocks) {
243 LOG_INFO(priv, FW_DOWNLOAD,
244 "Block number limit is reached [%d]\n",
253 LOG_INFOEX(priv, INIT, "<--\n");
257 static int iwmct_kick_fw(struct iwmct_priv *priv, bool jump)
259 struct iwmct_parser *parser = &priv->parser;
260 struct iwmct_fw_load_hdr *hdr = (struct iwmct_fw_load_hdr *)parser->buf;
264 LOG_INFOEX(priv, INIT, "-->\n");
266 memset(parser->buf, 0, parser->buf_size);
267 cmd = IWMC_CMD_SIGNATURE << CMD_HDR_SIGNATURE_POS;
269 cmd |= IWMC_OPCODE_JUMP << CMD_HDR_OPCODE_POS;
270 hdr->target_addr = cpu_to_le32(parser->entry_point);
271 LOG_INFO(priv, FW_DOWNLOAD, "jump address 0x%x\n",
272 parser->entry_point);
274 cmd |= IWMC_OPCODE_LAST_COMMAND << CMD_HDR_OPCODE_POS;
275 LOG_INFO(priv, FW_DOWNLOAD, "last command\n");
278 hdr->cmd = cpu_to_le32(cmd);
280 LOG_HEXDUMP(FW_DOWNLOAD, parser->buf, sizeof(*hdr));
282 /* TODO: add more proper sending and error checking */
283 ret = iwmct_tx(priv, 0, parser->buf, IWMC_SDIO_BLK_SIZE);
285 LOG_INFO(priv, FW_DOWNLOAD, "iwmct_tx returned %d", ret);
287 LOG_INFOEX(priv, INIT, "<--\n");
291 int iwmct_fw_load(struct iwmct_priv *priv)
293 const u8 *fw_name = FW_NAME(FW_API_VER);
294 const struct firmware *raw;
301 /* get the firmware */
302 ret = request_firmware(&raw, fw_name, &priv->func->dev);
304 LOG_ERROR(priv, FW_DOWNLOAD, "%s request_firmware failed %d\n",
309 if (raw->size < sizeof(struct iwmct_fw_sec_hdr)) {
310 LOG_ERROR(priv, FW_DOWNLOAD, "%s smaller then (%zd) (%zd)\n",
311 fw_name, sizeof(struct iwmct_fw_sec_hdr), raw->size);
315 LOG_INFO(priv, FW_DOWNLOAD, "Read firmware '%s'\n", fw_name);
317 /* clear parser struct */
318 ret = iwmct_fw_parser_init(priv, raw->data, raw->size, priv->trans_len);
320 LOG_ERROR(priv, FW_DOWNLOAD,
321 "iwmct_parser_init failed: Reason %d\n", ret);
325 if (!iwmct_checksum(priv)) {
326 LOG_ERROR(priv, FW_DOWNLOAD, "checksum error\n");
331 /* download firmware to device */
332 while (iwmct_parse_next_section(priv, &pdata, &len, &addr)) {
333 ret = iwmct_download_section(priv, pdata, len, addr);
335 LOG_ERROR(priv, FW_DOWNLOAD,
336 "%s download section failed\n", fw_name);
341 ret = iwmct_kick_fw(priv, !!(priv->barker & BARKER_DNLOAD_JUMP_MSK));
344 kfree(priv->parser.buf);
345 release_firmware(raw);