2 *************************************************************************
4 * 5F., No.36, Taiyuan St., Jhubei City,
8 * (c) Copyright 2002-2007, Ralink Technology, Inc.
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
15 * This program is distributed in the hope that it will be useful, *
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18 * GNU General Public License for more details. *
20 * You should have received a copy of the GNU General Public License *
21 * along with this program; if not, write to the *
22 * Free Software Foundation, Inc., *
23 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
25 *************************************************************************
31 Miniport generic portion header file
35 -------- ---------- ----------------------------------------------
38 #include "../rt_config.h"
39 #include "../firmware.h"
41 //#define BIN_IN_FILE /* use *.bin firmware */
44 // New 8k byte firmware size for RT3071/RT3072
45 #define FIRMWAREIMAGE_MAX_LENGTH 0x2000
46 #define FIRMWAREIMAGE_LENGTH (sizeof (FirmwareImage_3090) / sizeof(UCHAR))
47 #define FIRMWARE_MAJOR_VERSION 0
49 #define FIRMWAREIMAGEV1_LENGTH 0x1000
50 #define FIRMWAREIMAGEV2_LENGTH 0x1000
53 #define FIRMWARE_MINOR_VERSION 2
54 #endif // RTMP_MAC_PCI //
56 const unsigned short ccitt_16Table[] = {
57 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50A5, 0x60C6, 0x70E7,
58 0x8108, 0x9129, 0xA14A, 0xB16B, 0xC18C, 0xD1AD, 0xE1CE, 0xF1EF,
59 0x1231, 0x0210, 0x3273, 0x2252, 0x52B5, 0x4294, 0x72F7, 0x62D6,
60 0x9339, 0x8318, 0xB37B, 0xA35A, 0xD3BD, 0xC39C, 0xF3FF, 0xE3DE,
61 0x2462, 0x3443, 0x0420, 0x1401, 0x64E6, 0x74C7, 0x44A4, 0x5485,
62 0xA56A, 0xB54B, 0x8528, 0x9509, 0xE5EE, 0xF5CF, 0xC5AC, 0xD58D,
63 0x3653, 0x2672, 0x1611, 0x0630, 0x76D7, 0x66F6, 0x5695, 0x46B4,
64 0xB75B, 0xA77A, 0x9719, 0x8738, 0xF7DF, 0xE7FE, 0xD79D, 0xC7BC,
65 0x48C4, 0x58E5, 0x6886, 0x78A7, 0x0840, 0x1861, 0x2802, 0x3823,
66 0xC9CC, 0xD9ED, 0xE98E, 0xF9AF, 0x8948, 0x9969, 0xA90A, 0xB92B,
67 0x5AF5, 0x4AD4, 0x7AB7, 0x6A96, 0x1A71, 0x0A50, 0x3A33, 0x2A12,
68 0xDBFD, 0xCBDC, 0xFBBF, 0xEB9E, 0x9B79, 0x8B58, 0xBB3B, 0xAB1A,
69 0x6CA6, 0x7C87, 0x4CE4, 0x5CC5, 0x2C22, 0x3C03, 0x0C60, 0x1C41,
70 0xEDAE, 0xFD8F, 0xCDEC, 0xDDCD, 0xAD2A, 0xBD0B, 0x8D68, 0x9D49,
71 0x7E97, 0x6EB6, 0x5ED5, 0x4EF4, 0x3E13, 0x2E32, 0x1E51, 0x0E70,
72 0xFF9F, 0xEFBE, 0xDFDD, 0xCFFC, 0xBF1B, 0xAF3A, 0x9F59, 0x8F78,
73 0x9188, 0x81A9, 0xB1CA, 0xA1EB, 0xD10C, 0xC12D, 0xF14E, 0xE16F,
74 0x1080, 0x00A1, 0x30C2, 0x20E3, 0x5004, 0x4025, 0x7046, 0x6067,
75 0x83B9, 0x9398, 0xA3FB, 0xB3DA, 0xC33D, 0xD31C, 0xE37F, 0xF35E,
76 0x02B1, 0x1290, 0x22F3, 0x32D2, 0x4235, 0x5214, 0x6277, 0x7256,
77 0xB5EA, 0xA5CB, 0x95A8, 0x8589, 0xF56E, 0xE54F, 0xD52C, 0xC50D,
78 0x34E2, 0x24C3, 0x14A0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405,
79 0xA7DB, 0xB7FA, 0x8799, 0x97B8, 0xE75F, 0xF77E, 0xC71D, 0xD73C,
80 0x26D3, 0x36F2, 0x0691, 0x16B0, 0x6657, 0x7676, 0x4615, 0x5634,
81 0xD94C, 0xC96D, 0xF90E, 0xE92F, 0x99C8, 0x89E9, 0xB98A, 0xA9AB,
82 0x5844, 0x4865, 0x7806, 0x6827, 0x18C0, 0x08E1, 0x3882, 0x28A3,
83 0xCB7D, 0xDB5C, 0xEB3F, 0xFB1E, 0x8BF9, 0x9BD8, 0xABBB, 0xBB9A,
84 0x4A75, 0x5A54, 0x6A37, 0x7A16, 0x0AF1, 0x1AD0, 0x2AB3, 0x3A92,
85 0xFD2E, 0xED0F, 0xDD6C, 0xCD4D, 0xBDAA, 0xAD8B, 0x9DE8, 0x8DC9,
86 0x7C26, 0x6C07, 0x5C64, 0x4C45, 0x3CA2, 0x2C83, 0x1CE0, 0x0CC1,
87 0xEF1F, 0xFF3E, 0xCF5D, 0xDF7C, 0xAF9B, 0xBFBA, 0x8FD9, 0x9FF8,
88 0x6E17, 0x7E36, 0x4E55, 0x5E74, 0x2E93, 0x3EB2, 0x0ED1, 0x1EF0
90 #define ByteCRC16(v, crc) \
91 (unsigned short)((crc << 8) ^ ccitt_16Table[((crc >> 8) ^ (v)) & 255])
93 unsigned char BitReverse(unsigned char x)
99 if(x & 0x80) Temp |= 0x80;
109 ========================================================================
112 erase 8051 firmware image in MAC ASIC
115 Adapter Pointer to our adapter
119 ========================================================================
121 INT RtmpAsicEraseFirmware(
122 IN PRTMP_ADAPTER pAd)
126 for(i=0; i<MAX_FIRMWARE_IMAGE_SIZE; i+=4)
127 RTMP_IO_WRITE32(pAd, FIRMWARE_IMAGE_BASE + i, 0);
133 ========================================================================
136 Load 8051 firmware file into MAC ASIC
139 Adapter Pointer to our adapter
142 NDIS_STATUS_SUCCESS firmware image load ok
143 NDIS_STATUS_FAILURE image not found
147 ========================================================================
149 NDIS_STATUS RtmpAsicLoadFirmware(
150 IN PRTMP_ADAPTER pAd)
153 #define NICLF_DEFAULT_USE() \
154 flg_default_firm_use = TRUE; \
155 DBGPRINT(RT_DEBUG_OFF, ("%s - Use default firmware!\n", __FUNCTION__));
157 NDIS_STATUS Status = NDIS_STATUS_SUCCESS;
161 PUCHAR pFirmwareImage;
166 BOOLEAN flg_default_firm_use = FALSE;
167 RTMP_OS_FS_INFO osFSInfo;
169 DBGPRINT(RT_DEBUG_TRACE, ("===> %s\n", __FUNCTION__));
172 pFirmwareImage = NULL;
173 src = RTMP_FIRMWARE_FILE_NAME;
175 RtmpOSFSInfoChange(&osFSInfo, TRUE);
177 pAd->FirmwareVersion = (FIRMWARE_MAJOR_VERSION << 8) + \
178 FIRMWARE_MINOR_VERSION;
181 /* allocate firmware buffer */
182 pFirmwareImage = kmalloc(MAX_FIRMWARE_IMAGE_SIZE, MEM_ALLOC_FLAG);
183 if (pFirmwareImage == NULL)
185 /* allocate fail, use default firmware array in firmware.h */
186 DBGPRINT(RT_DEBUG_ERROR, ("%s - Allocate memory fail!\n", __FUNCTION__));
191 /* allocate ok! zero the firmware buffer */
192 memset(pFirmwareImage, 0x00, MAX_FIRMWARE_IMAGE_SIZE);
196 /* if ok, read firmware file from *.bin file */
197 if (flg_default_firm_use == FALSE)
201 /* open the bin file */
202 srcf = RtmpOSFileOpen(src, O_RDONLY, 0);
204 if (IS_FILE_OPEN_ERR(srcf))
206 DBGPRINT(RT_DEBUG_ERROR, ("%s - Error opening file %s\n", __FUNCTION__, src));
212 /* read the firmware from the file *.bin */
213 FileLength = RtmpOSFileRead(srcf, pFirmwareImage, MAX_FIRMWARE_IMAGE_SIZE);
214 if (FileLength != MAX_FIRMWARE_IMAGE_SIZE)
216 DBGPRINT(RT_DEBUG_ERROR, ("%s: error file length (=%d) in RT2860AP.BIN\n",
217 __FUNCTION__, FileLength));
223 PUCHAR ptr = pFirmwareImage;
227 /* calculate firmware CRC */
228 for(i=0; i<(MAX_FIRMWARE_IMAGE_SIZE-2); i++, ptr++)
229 crc = ByteCRC16(BitReverse(*ptr), crc);
232 if ((pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-2] != \
233 (UCHAR)BitReverse((UCHAR)(crc>>8))) ||
234 (pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-1] != \
235 (UCHAR)BitReverse((UCHAR)crc)))
238 DBGPRINT(RT_DEBUG_ERROR, ("%s: CRC = 0x%02x 0x%02x "
239 "error, should be 0x%02x 0x%02x\n",
241 pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-2],
242 pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-1],
243 (UCHAR)(crc>>8), (UCHAR)(crc)));
250 pAd->FirmwareVersion = \
251 (pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-4] << 8) +
252 pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-3];
254 /* check if firmware version of the file is too old */
255 if ((pAd->FirmwareVersion) < \
256 ((FIRMWARE_MAJOR_VERSION << 8) +
257 FIRMWARE_MINOR_VERSION))
259 DBGPRINT(RT_DEBUG_ERROR, ("%s: firmware version too old!\n", __FUNCTION__));
265 DBGPRINT(RT_DEBUG_TRACE,
266 ("NICLoadFirmware: CRC ok, ver=%d.%d\n",
267 pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-4],
268 pFirmwareImage[MAX_FIRMWARE_IMAGE_SIZE-3]));
269 } /* End of if (FileLength == MAX_FIRMWARE_IMAGE_SIZE) */
273 /* close firmware file */
274 if (IS_FILE_OPEN_ERR(srcf))
278 retval = RtmpOSFileClose(srcf);
281 DBGPRINT(RT_DEBUG_ERROR, ("--> Error %d closing %s\n", -retval, src));
287 /* write firmware to ASIC */
288 if (flg_default_firm_use == TRUE)
290 /* use default fimeware, free allocated buffer */
291 if (pFirmwareImage != NULL)
292 kfree(pFirmwareImage);
295 /* use default *.bin array */
296 pFirmwareImage = FirmwareImage;
297 FileLength = sizeof(FirmwareImage);
300 /* enable Host program ram write selection */
301 RTMP_IO_WRITE32(pAd, PBF_SYS_CTRL, 0x10000);
303 for(i=0; i<FileLength; i+=4)
305 firm = pFirmwareImage[i] +
306 (pFirmwareImage[i+3] << 24) +
307 (pFirmwareImage[i+2] << 16) +
308 (pFirmwareImage[i+1] << 8);
310 RTMP_IO_WRITE32(pAd, FIRMWARE_IMAGE_BASE + i, firm);
313 RTMP_IO_WRITE32(pAd, PBF_SYS_CTRL, 0x00000);
314 RTMP_IO_WRITE32(pAd, PBF_SYS_CTRL, 0x00001);
316 /* initialize BBP R/W access agent */
317 RTMP_IO_WRITE32(pAd, H2M_BBP_AGENT, 0);
318 RTMP_IO_WRITE32(pAd, H2M_MAILBOX_CSR, 0);
320 if (flg_default_firm_use == FALSE)
322 /* use file firmware, free allocated buffer */
323 if (pFirmwareImage != NULL)
324 kfree(pFirmwareImage);
328 RtmpOSFSInfoChange(&osFSInfo, FALSE);
331 NDIS_STATUS Status = NDIS_STATUS_SUCCESS;
332 PUCHAR pFirmwareImage;
333 ULONG FileLength, Index;
336 UINT32 Version = (pAd->MACVersion >> 16);
338 pFirmwareImage = FirmwareImage_3090;
339 FileLength = sizeof(*pFirmwareImage);
341 // New 8k byte firmware size for RT3071/RT3072
342 //DBGPRINT(RT_DEBUG_TRACE, ("Usb Chip\n"));
343 if (FIRMWAREIMAGE_LENGTH == FIRMWAREIMAGE_MAX_LENGTH)
344 //The firmware image consists of two parts. One is the origianl and the other is the new.
348 if ((Version == 0x2860) || IS_RT3090(pAd)||IS_RT3390(pAd))
350 pFirmwareImage = FirmwareImage_3090;
351 FileLength = FIRMWAREIMAGE_LENGTH;
353 #endif // RTMP_MAC_PCI //
357 DBGPRINT(RT_DEBUG_ERROR, ("KH: bin file should be 8KB.\n"));
358 Status = NDIS_STATUS_FAILURE;
362 RTMP_WRITE_FIRMWARE(pAd, pFirmwareImage, FileLength);
366 /* check if MCU is ready */
370 RTMP_IO_READ32(pAd, PBF_SYS_CTRL, &MacReg);
376 } while (Index++ < 1000);
380 DBGPRINT(RT_DEBUG_ERROR, ("NICLoadFirmware: MCU is not ready\n\n\n"));
381 Status = NDIS_STATUS_FAILURE;
384 DBGPRINT(RT_DEBUG_TRACE, ("<=== %s (status=%d)\n", __FUNCTION__, Status));
390 INT RtmpAsicSendCommandToMcu(
391 IN PRTMP_ADAPTER pAd,
397 HOST_CMD_CSR_STRUC H2MCmd;
398 H2M_MAILBOX_STRUC H2MMailbox;
403 #endif // RALINK_ATE //
404 #endif // RTMP_MAC_PCI //
405 #ifdef PCIE_PS_SUPPORT
406 #ifdef CONFIG_STA_SUPPORT
407 // 3090F power solution 3 has hw limitation that needs to ban all mcu command
408 // when firmware is in radio state. For other chip doesn't have this limitation.
409 if (((IS_RT3090(pAd) || IS_RT3572(pAd) || IS_RT3390(pAd)) && IS_VERSION_AFTER_F(pAd)) && IS_VERSION_AFTER_F(pAd)
410 && (pAd->StaCfg.PSControl.field.rt30xxPowerMode == 3)
411 && (pAd->StaCfg.PSControl.field.EnableNewPS == TRUE))
413 RTMP_SEM_LOCK(&pAd->McuCmdLock);
414 if ((pAd->brt30xxBanMcuCmd == TRUE)
415 && (Command != WAKE_MCU_CMD) && (Command != RFOFF_MCU_CMD))
417 RTMP_SEM_UNLOCK(&pAd->McuCmdLock);
418 DBGPRINT(RT_DEBUG_TRACE, (" Ban Mcu Cmd %x in sleep mode\n", Command));
421 else if ((Command == SLEEP_MCU_CMD)
422 ||(Command == RFOFF_MCU_CMD))
424 pAd->brt30xxBanMcuCmd = TRUE;
426 else if (Command != WAKE_MCU_CMD)
428 pAd->brt30xxBanMcuCmd = FALSE;
431 RTMP_SEM_UNLOCK(&pAd->McuCmdLock);
434 if (((IS_RT3090(pAd) || IS_RT3572(pAd) || IS_RT3390(pAd)) && IS_VERSION_AFTER_F(pAd)) && IS_VERSION_AFTER_F(pAd)
435 && (pAd->StaCfg.PSControl.field.rt30xxPowerMode == 3)
436 && (pAd->StaCfg.PSControl.field.EnableNewPS == TRUE)
437 && (Command == WAKE_MCU_CMD))
442 RTMP_IO_FORCE_READ32(pAd, H2M_MAILBOX_CSR, &H2MMailbox.word);
443 if (H2MMailbox.field.Owner == 0)
447 DBGPRINT(RT_DEBUG_INFO, ("AsicSendCommanToMcu::Mail box is busy\n"));
452 DBGPRINT_ERR(("H2M_MAILBOX still hold by MCU. command fail\n"));
456 H2MMailbox.field.Owner = 1; // pass ownership to MCU
457 H2MMailbox.field.CmdToken = Token;
458 H2MMailbox.field.HighByte = Arg1;
459 H2MMailbox.field.LowByte = Arg0;
460 RTMP_IO_FORCE_WRITE32(pAd, H2M_MAILBOX_CSR, H2MMailbox.word);
463 H2MCmd.field.HostCommand = Command;
464 RTMP_IO_FORCE_WRITE32(pAd, HOST_CMD_CSR, H2MCmd.word);
469 #endif // CONFIG_STA_SUPPORT //
470 #endif // PCIE_PS_SUPPORT //
474 RTMP_IO_READ32(pAd, H2M_MAILBOX_CSR, &H2MMailbox.word);
475 if (H2MMailbox.field.Owner == 0)
485 if (pAd->ate.bFWLoading == TRUE)
487 /* reloading firmware when received iwpriv cmd "ATE=ATESTOP" */
492 ATEDBGPRINT(RT_DEBUG_ERROR, ("#"));
496 ATEDBGPRINT(RT_DEBUG_ERROR, ("\n"));
502 ATEDBGPRINT(RT_DEBUG_ERROR, ("Loading firmware. Please wait for a moment...\n"));
507 #endif // RALINK_ATE //
508 #endif // RTMP_MAC_PCI //
510 DBGPRINT_ERR(("H2M_MAILBOX still hold by MCU. command fail\n"));
517 else if (pAd->ate.bFWLoading == TRUE)
519 /* reloading of firmware is completed */
520 pAd->ate.bFWLoading = FALSE;
521 ATEDBGPRINT(RT_DEBUG_ERROR, ("\n"));
524 #endif // RALINK_ATE //
525 #endif // RTMP_MAC_PCI //
527 H2MMailbox.field.Owner = 1; // pass ownership to MCU
528 H2MMailbox.field.CmdToken = Token;
529 H2MMailbox.field.HighByte = Arg1;
530 H2MMailbox.field.LowByte = Arg0;
531 RTMP_IO_WRITE32(pAd, H2M_MAILBOX_CSR, H2MMailbox.word);
534 H2MCmd.field.HostCommand = Command;
535 RTMP_IO_WRITE32(pAd, HOST_CMD_CSR, H2MCmd.word);
541 #ifdef PCIE_PS_SUPPORT
542 #ifdef CONFIG_STA_SUPPORT
543 // 3090 MCU Wakeup command needs more time to be stable.
544 // Before stable, don't issue other MCU command to prevent from firmware error.
545 if (((IS_RT3090(pAd) || IS_RT3572(pAd) || IS_RT3390(pAd)) && IS_VERSION_AFTER_F(pAd)) && IS_VERSION_AFTER_F(pAd)
546 && (pAd->StaCfg.PSControl.field.rt30xxPowerMode == 3)
547 && (pAd->StaCfg.PSControl.field.EnableNewPS == TRUE)
548 && (Command == WAKE_MCU_CMD))
551 //Put this is after RF programming.
552 //NdisAcquireSpinLock(&pAd->McuCmdLock);
553 //pAd->brt30xxBanMcuCmd = FALSE;
554 //NdisReleaseSpinLock(&pAd->McuCmdLock);
556 #endif // CONFIG_STA_SUPPORT //
557 #endif // PCIE_PS_SUPPORT //