1 /* from src/prism2/download/prism2dl.c
3 * utility for downloading prism2 images moved into kernelspace
5 * Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved.
6 * --------------------------------------------------------------------
10 * The contents of this file are subject to the Mozilla Public
11 * License Version 1.1 (the "License"); you may not use this file
12 * except in compliance with the License. You may obtain a copy of
13 * the License at http://www.mozilla.org/MPL/
15 * Software distributed under the License is distributed on an "AS
16 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
17 * implied. See the License for the specific language governing
18 * rights and limitations under the License.
20 * Alternatively, the contents of this file may be used under the
21 * terms of the GNU Public License version 2 (the "GPL"), in which
22 * case the provisions of the GPL are applicable instead of the
23 * above. If you wish to allow the use of your version of this file
24 * only under the terms of the GPL and not to allow others to use
25 * your version of this file under the MPL, indicate your decision
26 * by deleting the provisions above and replace them with the notice
27 * and other provisions required by the GPL. If you do not delete
28 * the provisions above, a recipient may use your version of this
29 * file under either the MPL or the GPL.
31 * --------------------------------------------------------------------
33 * Inquiries regarding the linux-wlan Open Source project can be
36 * AbsoluteValue Systems Inc.
38 * http://www.linux-wlan.com
40 * --------------------------------------------------------------------
42 * Portions of the development of this software were funded by
43 * Intersil Corporation as part of PRISM(R) chipset product development.
45 * --------------------------------------------------------------------
48 /*================================================================*/
50 #include <linux/ihex.h>
51 #include <linux/slab.h>
53 /*================================================================*/
56 #define PRISM2_USB_FWFILE "prism2_ru.fw"
57 MODULE_FIRMWARE(PRISM2_USB_FWFILE
);
59 #define S3DATA_MAX 5000
60 #define S3PLUG_MAX 200
64 #define S3ADDR_PLUG (0xff000000UL)
65 #define S3ADDR_CRC (0xff100000UL)
66 #define S3ADDR_INFO (0xff200000UL)
67 #define S3ADDR_START (0xff400000UL)
69 #define CHUNKS_MAX 100
71 #define WRITESIZE_MAX 4096
73 /*================================================================*/
99 hfa384x_compident_t version
;
100 hfa384x_caplevel_t compat
;
102 hfa384x_compident_t platform
;
107 u8 buf
[HFA384x_PDA_LEN_MAX
];
108 hfa384x_pdrec_t
*rec
[HFA384x_PDA_RECS_MAX
];
113 u32 addr
; /* start address */
114 u32 len
; /* in bytes */
115 u16 crc
; /* CRC value (if it falls at a chunk boundary) */
119 /*================================================================*/
120 /* Local Static Definitions */
122 /*----------------------------------------------------------------*/
123 /* s-record image processing */
126 static unsigned int ns3data
;
127 static struct s3datarec s3data
[S3DATA_MAX
];
130 static unsigned int ns3plug
;
131 static struct s3plugrec s3plug
[S3PLUG_MAX
];
134 static unsigned int ns3crc
;
135 static struct s3crcrec s3crc
[S3CRC_MAX
];
138 static unsigned int ns3info
;
139 static struct s3inforec s3info
[S3INFO_MAX
];
141 /* S7 record (there _better_ be only one) */
142 static u32 startaddr
;
144 /* Load image chunks */
145 static unsigned int nfchunks
;
146 static struct imgchunk fchunk
[CHUNKS_MAX
];
148 /* Note that for the following pdrec_t arrays, the len and code */
149 /* fields are stored in HOST byte order. The mkpdrlist() function */
150 /* does the conversion. */
151 /*----------------------------------------------------------------*/
152 /* PDA, built from [card|newfile]+[addfile1+addfile2...] */
154 static struct pda pda
;
155 static hfa384x_compident_t nicid
;
156 static hfa384x_caplevel_t rfid
;
157 static hfa384x_caplevel_t macid
;
158 static hfa384x_caplevel_t priid
;
160 /*================================================================*/
161 /* Local Function Declarations */
163 static int prism2_fwapply(const struct ihex_binrec
*rfptr
,
164 wlandevice_t
*wlandev
);
166 static int read_fwfile(const struct ihex_binrec
*rfptr
);
168 static int mkimage(struct imgchunk
*clist
, unsigned int *ccnt
);
170 static int read_cardpda(struct pda
*pda
, wlandevice_t
*wlandev
);
172 static int mkpdrlist(struct pda
*pda
);
174 static int plugimage(struct imgchunk
*fchunk
, unsigned int nfchunks
,
175 struct s3plugrec
*s3plug
, unsigned int ns3plug
, struct pda
*pda
);
177 static int crcimage(struct imgchunk
*fchunk
, unsigned int nfchunks
,
178 struct s3crcrec
*s3crc
, unsigned int ns3crc
);
180 static int writeimage(wlandevice_t
*wlandev
, struct imgchunk
*fchunk
,
181 unsigned int nfchunks
);
182 static void free_chunks(struct imgchunk
*fchunk
, unsigned int *nfchunks
);
184 static void free_srecs(void);
186 static int validate_identity(void);
188 /*================================================================*/
189 /* Function Definitions */
191 /*----------------------------------------------------------------
194 * Try and get firmware into memory
197 * udev usb device structure
198 * wlandev wlan device structure
203 ----------------------------------------------------------------*/
204 static int prism2_fwtry(struct usb_device
*udev
, wlandevice_t
*wlandev
)
206 const struct firmware
*fw_entry
= NULL
;
208 netdev_info(wlandev
->netdev
, "prism2_usb: Checking for firmware %s\n",
210 if (request_ihex_firmware(&fw_entry
,
211 PRISM2_USB_FWFILE
, &udev
->dev
) != 0) {
212 netdev_info(wlandev
->netdev
,
213 "prism2_usb: Firmware not available, but not essential\n");
214 netdev_info(wlandev
->netdev
,
215 "prism2_usb: can continue to use card anyway.\n");
219 netdev_info(wlandev
->netdev
,
220 "prism2_usb: %s will be processed, size %zu\n",
221 PRISM2_USB_FWFILE
, fw_entry
->size
);
222 prism2_fwapply((const struct ihex_binrec
*)fw_entry
->data
, wlandev
);
224 release_firmware(fw_entry
);
228 /*----------------------------------------------------------------
231 * Apply the firmware loaded into memory
234 * rfptr firmware image in kernel memory
240 ----------------------------------------------------------------*/
241 static int prism2_fwapply(const struct ihex_binrec
*rfptr
,
242 wlandevice_t
*wlandev
)
244 signed int result
= 0;
245 struct p80211msg_dot11req_mibget getmsg
;
249 /* Initialize the data structures */
251 memset(s3data
, 0, sizeof(s3data
));
253 memset(s3plug
, 0, sizeof(s3plug
));
255 memset(s3crc
, 0, sizeof(s3crc
));
257 memset(s3info
, 0, sizeof(s3info
));
261 memset(fchunk
, 0, sizeof(fchunk
));
262 memset(&nicid
, 0, sizeof(nicid
));
263 memset(&rfid
, 0, sizeof(rfid
));
264 memset(&macid
, 0, sizeof(macid
));
265 memset(&priid
, 0, sizeof(priid
));
267 /* clear the pda and add an initial END record */
268 memset(&pda
, 0, sizeof(pda
));
269 pda
.rec
[0] = (hfa384x_pdrec_t
*) pda
.buf
;
270 pda
.rec
[0]->len
= cpu_to_le16(2); /* len in words */
271 pda
.rec
[0]->code
= cpu_to_le16(HFA384x_PDR_END_OF_PDA
);
274 /*-----------------------------------------------------*/
275 /* Put card into fwload state */
276 prism2sta_ifstate(wlandev
, P80211ENUM_ifstate_fwload
);
278 /* Build the PDA we're going to use. */
279 if (read_cardpda(&pda
, wlandev
)) {
280 netdev_err(wlandev
->netdev
, "load_cardpda failed, exiting.\n");
284 /* read the card's PRI-SUP */
285 memset(&getmsg
, 0, sizeof(getmsg
));
286 getmsg
.msgcode
= DIDmsg_dot11req_mibget
;
287 getmsg
.msglen
= sizeof(getmsg
);
288 strcpy(getmsg
.devname
, wlandev
->name
);
290 getmsg
.mibattribute
.did
= DIDmsg_dot11req_mibget_mibattribute
;
291 getmsg
.mibattribute
.status
= P80211ENUM_msgitem_status_data_ok
;
292 getmsg
.resultcode
.did
= DIDmsg_dot11req_mibget_resultcode
;
293 getmsg
.resultcode
.status
= P80211ENUM_msgitem_status_no_value
;
295 item
= (p80211itemd_t
*) getmsg
.mibattribute
.data
;
296 item
->did
= DIDmib_p2_p2NIC_p2PRISupRange
;
297 item
->status
= P80211ENUM_msgitem_status_no_value
;
299 data
= (u32
*) item
->data
;
301 /* DIDmsg_dot11req_mibget */
302 prism2mgmt_mibset_mibget(wlandev
, &getmsg
);
303 if (getmsg
.resultcode
.data
!= P80211ENUM_resultcode_success
)
304 netdev_err(wlandev
->netdev
, "Couldn't fetch PRI-SUP info\n");
306 /* Already in host order */
307 priid
.role
= *data
++;
309 priid
.variant
= *data
++;
310 priid
.bottom
= *data
++;
313 /* Read the S3 file */
314 result
= read_fwfile(rfptr
);
316 netdev_err(wlandev
->netdev
,
317 "Failed to read the data exiting.\n");
321 result
= validate_identity();
324 netdev_err(wlandev
->netdev
, "Incompatible firmware image.\n");
328 if (startaddr
== 0x00000000) {
329 netdev_err(wlandev
->netdev
,
330 "Can't RAM download a Flash image!\n");
334 /* Make the image chunks */
335 result
= mkimage(fchunk
, &nfchunks
);
337 /* Do any plugging */
338 result
= plugimage(fchunk
, nfchunks
, s3plug
, ns3plug
, &pda
);
340 netdev_err(wlandev
->netdev
, "Failed to plug data.\n");
344 /* Insert any CRCs */
345 if (crcimage(fchunk
, nfchunks
, s3crc
, ns3crc
)) {
346 netdev_err(wlandev
->netdev
, "Failed to insert all CRCs\n");
350 /* Write the image */
351 result
= writeimage(wlandev
, fchunk
, nfchunks
);
353 netdev_err(wlandev
->netdev
, "Failed to ramwrite image data.\n");
357 /* clear any allocated memory */
358 free_chunks(fchunk
, &nfchunks
);
361 netdev_info(wlandev
->netdev
, "prism2_usb: firmware loading finished.\n");
366 /*----------------------------------------------------------------
369 * Adds a CRC16 in the two bytes prior to each block identified by
370 * an S3 CRC record. Currently, we don't actually do a CRC we just
371 * insert the value 0xC0DE in hfa384x order.
374 * fchunk Array of image chunks
375 * nfchunks Number of image chunks
376 * s3crc Array of crc records
377 * ns3crc Number of crc records
382 ----------------------------------------------------------------*/
383 static int crcimage(struct imgchunk
*fchunk
, unsigned int nfchunks
,
384 struct s3crcrec
*s3crc
, unsigned int ns3crc
)
396 for (i
= 0; i
< ns3crc
; i
++) {
397 if (!s3crc
[i
].dowrite
)
399 crcstart
= s3crc
[i
].addr
;
400 crcend
= s3crc
[i
].addr
+ s3crc
[i
].len
;
402 for (c
= 0; c
< nfchunks
; c
++) {
403 cstart
= fchunk
[c
].addr
;
404 cend
= fchunk
[c
].addr
+ fchunk
[c
].len
;
405 /* the line below does an address & len match search */
406 /* unfortunately, I've found that the len fields of */
407 /* some crc records don't match with the length of */
408 /* the actual data, so we're not checking right now */
409 /* if (crcstart-2 >= cstart && crcend <= cend) break; */
411 /* note the -2 below, it's to make sure the chunk has */
412 /* space for the CRC value */
413 if (crcstart
- 2 >= cstart
&& crcstart
< cend
)
417 pr_err("Failed to find chunk for crcrec[%d], addr=0x%06x len=%d , aborting crc.\n",
418 i
, s3crc
[i
].addr
, s3crc
[i
].len
);
423 pr_debug("Adding crc @ 0x%06x\n", s3crc
[i
].addr
- 2);
424 chunkoff
= crcstart
- cstart
- 2;
425 dest
= fchunk
[c
].data
+ chunkoff
;
433 /*----------------------------------------------------------------
436 * Clears the chunklist data structures in preparation for a new file.
443 ----------------------------------------------------------------*/
444 static void free_chunks(struct imgchunk
*fchunk
, unsigned int *nfchunks
)
448 for (i
= 0; i
< *nfchunks
; i
++)
449 kfree(fchunk
[i
].data
);
452 memset(fchunk
, 0, sizeof(*fchunk
));
456 /*----------------------------------------------------------------
459 * Clears the srec data structures in preparation for a new file.
466 ----------------------------------------------------------------*/
467 static void free_srecs(void)
470 memset(s3data
, 0, sizeof(s3data
));
472 memset(s3plug
, 0, sizeof(s3plug
));
474 memset(s3crc
, 0, sizeof(s3crc
));
476 memset(s3info
, 0, sizeof(s3info
));
480 /*----------------------------------------------------------------
483 * Scans the currently loaded set of S records for data residing
484 * in contiguous memory regions. Each contiguous region is then
485 * made into a 'chunk'. This function assumes that we're building
486 * a new chunk list. Assumes the s3data items are in sorted order.
492 * ~0 - failure (probably an errno)
493 ----------------------------------------------------------------*/
494 static int mkimage(struct imgchunk
*clist
, unsigned int *ccnt
)
507 /* There may already be data in the chunklist */
510 /* Establish the location and size of each chunk */
511 for (i
= 0; i
< ns3data
; i
++) {
512 if (s3data
[i
].addr
== nextaddr
) {
513 /* existing chunk, grow it */
514 clist
[currchunk
].len
+= s3data
[i
].len
;
515 nextaddr
+= s3data
[i
].len
;
519 currchunk
= *ccnt
- 1;
520 clist
[currchunk
].addr
= s3data
[i
].addr
;
521 clist
[currchunk
].len
= s3data
[i
].len
;
522 nextaddr
= s3data
[i
].addr
+ s3data
[i
].len
;
523 /* Expand the chunk if there is a CRC record at */
524 /* their beginning bound */
525 for (j
= 0; j
< ns3crc
; j
++) {
526 if (s3crc
[j
].dowrite
&&
527 s3crc
[j
].addr
== clist
[currchunk
].addr
) {
528 clist
[currchunk
].addr
-= 2;
529 clist
[currchunk
].len
+= 2;
535 /* We're currently assuming there aren't any overlapping chunks */
536 /* if this proves false, we'll need to add code to coalesce. */
538 /* Allocate buffer space for chunks */
539 for (i
= 0; i
< *ccnt
; i
++) {
540 clist
[i
].data
= kzalloc(clist
[i
].len
, GFP_KERNEL
);
541 if (clist
[i
].data
== NULL
) {
542 pr_err("failed to allocate image space, exitting.\n");
545 pr_debug("chunk[%d]: addr=0x%06x len=%d\n",
546 i
, clist
[i
].addr
, clist
[i
].len
);
549 /* Copy srec data to chunks */
550 for (i
= 0; i
< ns3data
; i
++) {
551 s3start
= s3data
[i
].addr
;
552 s3end
= s3start
+ s3data
[i
].len
- 1;
553 for (j
= 0; j
< *ccnt
; j
++) {
554 cstart
= clist
[j
].addr
;
555 cend
= cstart
+ clist
[j
].len
- 1;
556 if (s3start
>= cstart
&& s3end
<= cend
)
559 if (((unsigned int)j
) >= (*ccnt
)) {
560 pr_err("s3rec(a=0x%06x,l=%d), no chunk match, exiting.\n",
561 s3start
, s3data
[i
].len
);
564 coffset
= s3start
- cstart
;
565 memcpy(clist
[j
].data
+ coffset
, s3data
[i
].data
, s3data
[i
].len
);
571 /*----------------------------------------------------------------
574 * Reads a raw PDA and builds an array of pdrec_t structures.
577 * pda buffer containing raw PDA bytes
578 * pdrec ptr to an array of pdrec_t's. Will be filled on exit.
579 * nrec ptr to a variable that will contain the count of PDRs
583 * ~0 - failure (probably an errno)
584 ----------------------------------------------------------------*/
585 static int mkpdrlist(struct pda
*pda
)
587 u16
*pda16
= (u16
*) pda
->buf
;
588 int curroff
; /* in 'words' */
592 while (curroff
< (HFA384x_PDA_LEN_MAX
/ 2 - 1) &&
593 le16_to_cpu(pda16
[curroff
+ 1]) != HFA384x_PDR_END_OF_PDA
) {
594 pda
->rec
[pda
->nrec
] = (hfa384x_pdrec_t
*) &(pda16
[curroff
]);
596 if (le16_to_cpu(pda
->rec
[pda
->nrec
]->code
) ==
598 memcpy(&nicid
, &pda
->rec
[pda
->nrec
]->data
.nicid
,
600 nicid
.id
= le16_to_cpu(nicid
.id
);
601 nicid
.variant
= le16_to_cpu(nicid
.variant
);
602 nicid
.major
= le16_to_cpu(nicid
.major
);
603 nicid
.minor
= le16_to_cpu(nicid
.minor
);
605 if (le16_to_cpu(pda
->rec
[pda
->nrec
]->code
) ==
606 HFA384x_PDR_MFISUPRANGE
) {
607 memcpy(&rfid
, &pda
->rec
[pda
->nrec
]->data
.mfisuprange
,
609 rfid
.id
= le16_to_cpu(rfid
.id
);
610 rfid
.variant
= le16_to_cpu(rfid
.variant
);
611 rfid
.bottom
= le16_to_cpu(rfid
.bottom
);
612 rfid
.top
= le16_to_cpu(rfid
.top
);
614 if (le16_to_cpu(pda
->rec
[pda
->nrec
]->code
) ==
615 HFA384x_PDR_CFISUPRANGE
) {
616 memcpy(&macid
, &pda
->rec
[pda
->nrec
]->data
.cfisuprange
,
618 macid
.id
= le16_to_cpu(macid
.id
);
619 macid
.variant
= le16_to_cpu(macid
.variant
);
620 macid
.bottom
= le16_to_cpu(macid
.bottom
);
621 macid
.top
= le16_to_cpu(macid
.top
);
625 curroff
+= le16_to_cpu(pda16
[curroff
]) + 1;
628 if (curroff
>= (HFA384x_PDA_LEN_MAX
/ 2 - 1)) {
629 pr_err("no end record found or invalid lengths in PDR data, exiting. %x %d\n",
633 pda
->rec
[pda
->nrec
] = (hfa384x_pdrec_t
*) &(pda16
[curroff
]);
638 /*----------------------------------------------------------------
641 * Plugs the given image using the given plug records from the given
645 * fchunk Array of image chunks
646 * nfchunks Number of image chunks
647 * s3plug Array of plug records
648 * ns3plug Number of plug records
649 * pda Current pda data
654 ----------------------------------------------------------------*/
655 static int plugimage(struct imgchunk
*fchunk
, unsigned int nfchunks
,
656 struct s3plugrec
*s3plug
, unsigned int ns3plug
, struct pda
*pda
)
659 int i
; /* plug index */
660 int j
; /* index of PDR or -1 if fname plug */
661 int c
; /* chunk index */
669 /* for each plug record */
670 for (i
= 0; i
< ns3plug
; i
++) {
671 pstart
= s3plug
[i
].addr
;
672 pend
= s3plug
[i
].addr
+ s3plug
[i
].len
;
673 /* find the matching PDR (or filename) */
674 if (s3plug
[i
].itemcode
!= 0xffffffffUL
) { /* not filename */
675 for (j
= 0; j
< pda
->nrec
; j
++) {
676 if (s3plug
[i
].itemcode
==
677 le16_to_cpu(pda
->rec
[j
]->code
))
683 if (j
>= pda
->nrec
&& j
!= -1) { /* if no matching PDR, fail */
684 pr_warn("warning: Failed to find PDR for plugrec 0x%04x.\n",
686 continue; /* and move on to the next PDR */
688 /* MSM: They swear that unless it's the MAC address,
689 * the serial number, or the TX calibration records,
690 * then there's reasonable defaults in the f/w
691 * image. Therefore, missing PDRs in the card
692 * should only be a warning, not fatal.
693 * TODO: add fatals for the PDRs mentioned above.
700 /* Validate plug len against PDR len */
701 if (j
!= -1 && s3plug
[i
].len
< le16_to_cpu(pda
->rec
[j
]->len
)) {
702 pr_err("error: Plug vs. PDR len mismatch for plugrec 0x%04x, abort plugging.\n",
709 * Validate plug address against
710 * chunk data and identify chunk
712 for (c
= 0; c
< nfchunks
; c
++) {
713 cstart
= fchunk
[c
].addr
;
714 cend
= fchunk
[c
].addr
+ fchunk
[c
].len
;
715 if (pstart
>= cstart
&& pend
<= cend
)
719 pr_err("error: Failed to find image chunk for plugrec 0x%04x.\n",
726 chunkoff
= pstart
- cstart
;
727 dest
= fchunk
[c
].data
+ chunkoff
;
728 pr_debug("Plugging item 0x%04x @ 0x%06x, len=%d, cnum=%d coff=0x%06x\n",
729 s3plug
[i
].itemcode
, pstart
, s3plug
[i
].len
,
732 if (j
== -1) { /* plug the filename */
733 memset(dest
, 0, s3plug
[i
].len
);
734 strncpy(dest
, PRISM2_USB_FWFILE
, s3plug
[i
].len
- 1);
735 } else { /* plug a PDR */
736 memcpy(dest
, &(pda
->rec
[j
]->data
), s3plug
[i
].len
);
743 /*----------------------------------------------------------------
746 * Sends the command for the driver to read the pda from the card
747 * named in the device variable. Upon success, the card pda is
748 * stored in the "cardpda" variables. Note that the pda structure
749 * is considered 'well formed' after this function. That means
750 * that the nrecs is valid, the rec array has been set up, and there's
751 * a valid PDAEND record in the raw PDA data.
759 * ~0 - failure (probably an errno)
760 ----------------------------------------------------------------*/
761 static int read_cardpda(struct pda
*pda
, wlandevice_t
*wlandev
)
764 struct p80211msg_p2req_readpda
*msg
;
766 msg
= kzalloc(sizeof(*msg
), GFP_KERNEL
);
771 msg
->msgcode
= DIDmsg_p2req_readpda
;
772 msg
->msglen
= sizeof(msg
);
773 strcpy(msg
->devname
, wlandev
->name
);
774 msg
->pda
.did
= DIDmsg_p2req_readpda_pda
;
775 msg
->pda
.len
= HFA384x_PDA_LEN_MAX
;
776 msg
->pda
.status
= P80211ENUM_msgitem_status_no_value
;
777 msg
->resultcode
.did
= DIDmsg_p2req_readpda_resultcode
;
778 msg
->resultcode
.len
= sizeof(u32
);
779 msg
->resultcode
.status
= P80211ENUM_msgitem_status_no_value
;
781 if (prism2mgmt_readpda(wlandev
, msg
) != 0) {
782 /* prism2mgmt_readpda prints an errno if appropriate */
784 } else if (msg
->resultcode
.data
== P80211ENUM_resultcode_success
) {
785 memcpy(pda
->buf
, msg
->pda
.data
, HFA384x_PDA_LEN_MAX
);
786 result
= mkpdrlist(pda
);
788 /* resultcode must've been something other than success */
796 /*----------------------------------------------------------------
799 * Reads the given fw file which should have been compiled from an srec
800 * file. Each record in the fw file will either be a plain data record,
801 * a start address record, or other records used for plugging.
803 * Note that data records are expected to be sorted into
804 * ascending address order in the fw file.
806 * Note also that the start address record, originally an S7 record in
807 * the srec file, is expected in the fw file to be like a data record but
808 * with a certain address to make it identifiable.
810 * Here's the SREC format that the fw should have come from:
811 * S[37]nnaaaaaaaaddd...dddcc
813 * nn - number of bytes starting with the address field
814 * aaaaaaaa - address in readable (or big endian) format
815 * dd....dd - 0-245 data bytes (two chars per byte)
818 * The S7 record's (there should be only one) address value gets
819 * converted to an S3 record with address of 0xff400000, with the
820 * start address being stored as a 4 byte data word. That address is
821 * the start execution address used for RAM downloads.
823 * The S3 records have a collection of subformats indicated by the
825 * 0xff000000 - Plug record, data field format:
826 * xxxxxxxxaaaaaaaassssssss
827 * x - PDR code number (little endian)
828 * a - Address in load image to plug (little endian)
829 * s - Length of plug data area (little endian)
831 * 0xff100000 - CRC16 generation record, data field format:
832 * aaaaaaaassssssssbbbbbbbb
833 * a - Start address for CRC calculation (little endian)
834 * s - Length of data to calculate over (little endian)
835 * b - Boolean, true=write crc, false=don't write
837 * 0xff200000 - Info record, data field format:
839 * s - Size in words (little endian)
840 * t - Info type (little endian), see #defines and
841 * struct s3inforec for details about types.
842 * d - (s - 1) little endian words giving the contents of
843 * the given info type.
845 * 0xff400000 - Start address record, data field format:
847 * a - Address in load image to plug (little endian)
850 * record firmware image (ihex record structure) in kernel memory
854 * ~0 - failure (probably an errno)
855 ----------------------------------------------------------------*/
856 static int read_fwfile(const struct ihex_binrec
*record
)
862 u32
*ptr32
, len
, addr
;
864 pr_debug("Reading fw file ...\n");
870 len
= be16_to_cpu(record
->len
);
871 addr
= be32_to_cpu(record
->addr
);
873 /* Point into data for different word lengths */
874 ptr32
= (u32
*) record
->data
;
875 ptr16
= (u16
*) record
->data
;
877 /* parse what was an S3 srec and put it in the right array */
881 pr_debug(" S7 start addr, record=%d addr=0x%08x\n",
886 s3plug
[ns3plug
].itemcode
= *ptr32
;
887 s3plug
[ns3plug
].addr
= *(ptr32
+ 1);
888 s3plug
[ns3plug
].len
= *(ptr32
+ 2);
890 pr_debug(" S3 plugrec, record=%d itemcode=0x%08x addr=0x%08x len=%d\n",
892 s3plug
[ns3plug
].itemcode
,
893 s3plug
[ns3plug
].addr
,
894 s3plug
[ns3plug
].len
);
897 if (ns3plug
== S3PLUG_MAX
) {
898 pr_err("S3 plugrec limit reached - aborting\n");
903 s3crc
[ns3crc
].addr
= *ptr32
;
904 s3crc
[ns3crc
].len
= *(ptr32
+ 1);
905 s3crc
[ns3crc
].dowrite
= *(ptr32
+ 2);
907 pr_debug(" S3 crcrec, record=%d addr=0x%08x len=%d write=0x%08x\n",
911 s3crc
[ns3crc
].dowrite
);
913 if (ns3crc
== S3CRC_MAX
) {
914 pr_err("S3 crcrec limit reached - aborting\n");
919 s3info
[ns3info
].len
= *ptr16
;
920 s3info
[ns3info
].type
= *(ptr16
+ 1);
922 pr_debug(" S3 inforec, record=%d len=0x%04x type=0x%04x\n",
925 s3info
[ns3info
].type
);
926 if (((s3info
[ns3info
].len
- 1) * sizeof(u16
)) >
927 sizeof(s3info
[ns3info
].info
)) {
928 pr_err("S3 inforec length too long - aborting\n");
932 tmpinfo
= (u16
*)&(s3info
[ns3info
].info
.version
);
934 for (i
= 0; i
< s3info
[ns3info
].len
- 1; i
++) {
935 tmpinfo
[i
] = *(ptr16
+ 2 + i
);
936 pr_debug("%04x ", tmpinfo
[i
]);
941 if (ns3info
== S3INFO_MAX
) {
942 pr_err("S3 inforec limit reached - aborting\n");
946 default: /* Data record */
947 s3data
[ns3data
].addr
= addr
;
948 s3data
[ns3data
].len
= len
;
949 s3data
[ns3data
].data
= (uint8_t *) record
->data
;
951 if (ns3data
== S3DATA_MAX
) {
952 pr_err("S3 datarec limit reached - aborting\n");
957 record
= ihex_next_binrec(record
);
962 /*----------------------------------------------------------------
965 * Takes the chunks, builds p80211 messages and sends them down
966 * to the driver for writing to the card.
970 * fchunk Array of image chunks
971 * nfchunks Number of image chunks
976 ----------------------------------------------------------------*/
977 static int writeimage(wlandevice_t
*wlandev
, struct imgchunk
*fchunk
,
978 unsigned int nfchunks
)
981 struct p80211msg_p2req_ramdl_state
*rstmsg
;
982 struct p80211msg_p2req_ramdl_write
*rwrmsg
;
986 unsigned int nwrites
;
991 rstmsg
= kzalloc(sizeof(*rstmsg
), GFP_KERNEL
);
992 rwrmsg
= kzalloc(sizeof(*rwrmsg
), GFP_KERNEL
);
993 if (!rstmsg
|| !rwrmsg
) {
996 netdev_err(wlandev
->netdev
,
997 "writeimage: no memory for firmware download, aborting download\n");
1001 /* Initialize the messages */
1002 strcpy(rstmsg
->devname
, wlandev
->name
);
1003 rstmsg
->msgcode
= DIDmsg_p2req_ramdl_state
;
1004 rstmsg
->msglen
= sizeof(*rstmsg
);
1005 rstmsg
->enable
.did
= DIDmsg_p2req_ramdl_state_enable
;
1006 rstmsg
->exeaddr
.did
= DIDmsg_p2req_ramdl_state_exeaddr
;
1007 rstmsg
->resultcode
.did
= DIDmsg_p2req_ramdl_state_resultcode
;
1008 rstmsg
->enable
.status
= P80211ENUM_msgitem_status_data_ok
;
1009 rstmsg
->exeaddr
.status
= P80211ENUM_msgitem_status_data_ok
;
1010 rstmsg
->resultcode
.status
= P80211ENUM_msgitem_status_no_value
;
1011 rstmsg
->enable
.len
= sizeof(u32
);
1012 rstmsg
->exeaddr
.len
= sizeof(u32
);
1013 rstmsg
->resultcode
.len
= sizeof(u32
);
1015 strcpy(rwrmsg
->devname
, wlandev
->name
);
1016 rwrmsg
->msgcode
= DIDmsg_p2req_ramdl_write
;
1017 rwrmsg
->msglen
= sizeof(*rwrmsg
);
1018 rwrmsg
->addr
.did
= DIDmsg_p2req_ramdl_write_addr
;
1019 rwrmsg
->len
.did
= DIDmsg_p2req_ramdl_write_len
;
1020 rwrmsg
->data
.did
= DIDmsg_p2req_ramdl_write_data
;
1021 rwrmsg
->resultcode
.did
= DIDmsg_p2req_ramdl_write_resultcode
;
1022 rwrmsg
->addr
.status
= P80211ENUM_msgitem_status_data_ok
;
1023 rwrmsg
->len
.status
= P80211ENUM_msgitem_status_data_ok
;
1024 rwrmsg
->data
.status
= P80211ENUM_msgitem_status_data_ok
;
1025 rwrmsg
->resultcode
.status
= P80211ENUM_msgitem_status_no_value
;
1026 rwrmsg
->addr
.len
= sizeof(u32
);
1027 rwrmsg
->len
.len
= sizeof(u32
);
1028 rwrmsg
->data
.len
= WRITESIZE_MAX
;
1029 rwrmsg
->resultcode
.len
= sizeof(u32
);
1031 /* Send xxx_state(enable) */
1032 pr_debug("Sending dl_state(enable) message.\n");
1033 rstmsg
->enable
.data
= P80211ENUM_truth_true
;
1034 rstmsg
->exeaddr
.data
= startaddr
;
1036 result
= prism2mgmt_ramdl_state(wlandev
, rstmsg
);
1038 netdev_err(wlandev
->netdev
,
1039 "writeimage state enable failed w/ result=%d, aborting download\n",
1043 resultcode
= rstmsg
->resultcode
.data
;
1044 if (resultcode
!= P80211ENUM_resultcode_success
) {
1045 netdev_err(wlandev
->netdev
,
1046 "writeimage()->xxxdl_state msg indicates failure, w/ resultcode=%d, aborting download.\n",
1052 /* Now, loop through the data chunks and send WRITESIZE_MAX data */
1053 for (i
= 0; i
< nfchunks
; i
++) {
1054 nwrites
= fchunk
[i
].len
/ WRITESIZE_MAX
;
1055 nwrites
+= (fchunk
[i
].len
% WRITESIZE_MAX
) ? 1 : 0;
1057 for (j
= 0; j
< nwrites
; j
++) {
1058 /* TODO Move this to a separate function */
1059 int lenleft
= fchunk
[i
].len
- (WRITESIZE_MAX
* j
);
1061 if (fchunk
[i
].len
> WRITESIZE_MAX
)
1062 currlen
= WRITESIZE_MAX
;
1065 curroff
= j
* WRITESIZE_MAX
;
1066 currdaddr
= fchunk
[i
].addr
+ curroff
;
1067 /* Setup the message */
1068 rwrmsg
->addr
.data
= currdaddr
;
1069 rwrmsg
->len
.data
= currlen
;
1070 memcpy(rwrmsg
->data
.data
,
1071 fchunk
[i
].data
+ curroff
, currlen
);
1073 /* Send flashdl_write(pda) */
1075 ("Sending xxxdl_write message addr=%06x len=%d.\n",
1076 currdaddr
, currlen
);
1078 result
= prism2mgmt_ramdl_write(wlandev
, rwrmsg
);
1080 /* Check the results */
1082 netdev_err(wlandev
->netdev
,
1083 "writeimage chunk write failed w/ result=%d, aborting download\n",
1087 resultcode
= rstmsg
->resultcode
.data
;
1088 if (resultcode
!= P80211ENUM_resultcode_success
) {
1089 pr_err("writeimage()->xxxdl_write msg indicates failure, w/ resultcode=%d, aborting download.\n",
1098 /* Send xxx_state(disable) */
1099 pr_debug("Sending dl_state(disable) message.\n");
1100 rstmsg
->enable
.data
= P80211ENUM_truth_false
;
1101 rstmsg
->exeaddr
.data
= 0;
1103 result
= prism2mgmt_ramdl_state(wlandev
, rstmsg
);
1105 netdev_err(wlandev
->netdev
,
1106 "writeimage state disable failed w/ result=%d, aborting download\n",
1110 resultcode
= rstmsg
->resultcode
.data
;
1111 if (resultcode
!= P80211ENUM_resultcode_success
) {
1112 netdev_err(wlandev
->netdev
,
1113 "writeimage()->xxxdl_state msg indicates failure, w/ resultcode=%d, aborting download.\n",
1125 static int validate_identity(void)
1131 pr_debug("NIC ID: %#x v%d.%d.%d\n",
1132 nicid
.id
, nicid
.major
, nicid
.minor
, nicid
.variant
);
1133 pr_debug("MFI ID: %#x v%d %d->%d\n",
1134 rfid
.id
, rfid
.variant
, rfid
.bottom
, rfid
.top
);
1135 pr_debug("CFI ID: %#x v%d %d->%d\n",
1136 macid
.id
, macid
.variant
, macid
.bottom
, macid
.top
);
1137 pr_debug("PRI ID: %#x v%d %d->%d\n",
1138 priid
.id
, priid
.variant
, priid
.bottom
, priid
.top
);
1140 for (i
= 0; i
< ns3info
; i
++) {
1141 switch (s3info
[i
].type
) {
1143 pr_debug("Version: ID %#x %d.%d.%d\n",
1144 s3info
[i
].info
.version
.id
,
1145 s3info
[i
].info
.version
.major
,
1146 s3info
[i
].info
.version
.minor
,
1147 s3info
[i
].info
.version
.variant
);
1150 pr_debug("Compat: Role %#x Id %#x v%d %d->%d\n",
1151 s3info
[i
].info
.compat
.role
,
1152 s3info
[i
].info
.compat
.id
,
1153 s3info
[i
].info
.compat
.variant
,
1154 s3info
[i
].info
.compat
.bottom
,
1155 s3info
[i
].info
.compat
.top
);
1157 /* MAC compat range */
1158 if ((s3info
[i
].info
.compat
.role
== 1) &&
1159 (s3info
[i
].info
.compat
.id
== 2)) {
1160 if (s3info
[i
].info
.compat
.variant
!=
1166 /* PRI compat range */
1167 if ((s3info
[i
].info
.compat
.role
== 1) &&
1168 (s3info
[i
].info
.compat
.id
== 3)) {
1169 if ((s3info
[i
].info
.compat
.bottom
> priid
.top
)
1170 || (s3info
[i
].info
.compat
.top
<
1175 /* SEC compat range */
1176 if ((s3info
[i
].info
.compat
.role
== 1) &&
1177 (s3info
[i
].info
.compat
.id
== 4)) {
1178 /* FIXME: isn't something missing here? */
1183 pr_debug("Seq: %#x\n", s3info
[i
].info
.buildseq
);
1187 pr_debug("Platform: ID %#x %d.%d.%d\n",
1188 s3info
[i
].info
.version
.id
,
1189 s3info
[i
].info
.version
.major
,
1190 s3info
[i
].info
.version
.minor
,
1191 s3info
[i
].info
.version
.variant
);
1193 if (nicid
.id
!= s3info
[i
].info
.version
.id
)
1195 if (nicid
.major
!= s3info
[i
].info
.version
.major
)
1197 if (nicid
.minor
!= s3info
[i
].info
.version
.minor
)
1199 if ((nicid
.variant
!= s3info
[i
].info
.version
.variant
) &&
1200 (nicid
.id
!= 0x8008))
1206 pr_debug("name inforec len %d\n", s3info
[i
].len
);
1210 pr_debug("Unknown inforec type %d\n", s3info
[i
].type
);
1215 if (trump
&& (result
!= 2))