├── .gitignore ├── COPYING.txt ├── Makefile ├── Notes.md ├── README.md ├── extract_fw.py ├── mediatek_external_wifi_firmware.ksy ├── mediatek_linkit_wifi_firmware.ksy ├── mediatek_linux_wifi_bt_patch.ksy ├── mediatek_soc_wifi_firmware.ksy └── mt7697.cfg /.gitignore: -------------------------------------------------------------------------------- 1 | mediatek_soc_wifi_firmware.py 2 | WIFI_RAM_CODE* 3 | -------------------------------------------------------------------------------- /COPYING.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: 0BSD 2 | 3 | # Copyright (C) 2018 by Forest Crossman 4 | # 5 | # Permission to use, copy, modify, and/or distribute this software for 6 | # any purpose with or without fee is hereby granted. 7 | # 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 9 | # WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 10 | # WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 11 | # AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 12 | # DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 13 | # PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 14 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 | # PERFORMANCE OF THIS SOFTWARE. 16 | 17 | 18 | all: mediatek_soc_wifi_firmware.py 19 | 20 | %.py: %.ksy 21 | kaitai-struct-compiler -t python $< 22 | -------------------------------------------------------------------------------- /Notes.md: -------------------------------------------------------------------------------- 1 | # Notes 2 | 3 | * Kernel code is in `drivers/misc/mediatek/connectivity/wlan`. 4 | * From there, interesting definitions are in 5 | `./gen2/include/wlan_lib.h` and `./gen3/include/wlan_lib.h`. 6 | * Firmware loading code is in `./gen2/common/wlan_lib.c` and 7 | `./gen3/common/wlan_lib.c`. 8 | * The kernel code for later SoCs generally accounts for more hardware 9 | variations than the code for earlier SoCs. 10 | * Code and data are loaded by segment into different memory regions. 11 | * The CPU architecture of the code portions is NDS32, which is 12 | consistent with other MediaTek WiFi chips. 13 | * Some code is obfuscated using what appears to be a simple cyclic XOR, 14 | but guessing the key hasn't garnered any useful results. 15 | * Deobfuscation doesn't seem to happen in the Linux kernel driver. 16 | * I doubt that the deobfuscation is happening in dedicated hardware. The 17 | state machine to check the header, verify the checksum, and load and 18 | deobfuscate each segment would be far too complicated. 19 | * Since this code is called `WIFI_RAM_CODE*`, maybe the NDS32 core has 20 | a boot ROM that does the deobfuscation? 21 | * Maybe the NDS32 boot ROM can be dumped from the AP? 22 | * The [MT76x7 Technical Reference Manual][trm] (found [here][docs]) 23 | lists a "Patch Decryption Accelerator" (PDA) in the N9 CPU memory map, 24 | so I'm probably partially correct in that the boot ROM performs the 25 | firmware image parsing but the decryption is performed by dedicated 26 | hardware. 27 | * That said, just because the hardware is called a "decryption" 28 | accelerator doesn't necessarily mean the decryption is actually 29 | cryptographically secure, especially since there is already a 30 | dedicated cryptography accelerator on the same bus and in this 31 | context it wouldn't make sense to include two pieces of hardware 32 | that have the same function. 33 | * Key bank is selectable. From the MT7697 TRM: 34 | * N9 has EFUSEs. 35 | * The crypto engine can have a key programmed into it from software 36 | (stored in AES/DES key registers), or it can use a key directly from 37 | one of two banks in the EFUSEs. 38 | * Maybe the PDA behaves similarly, selecting a decryption key from 39 | multiple key banks in the EFUSEs. 40 | * Maybe the keys are different for each chip? 41 | * ~~Need to determine if PDA of MT7697 can decrypt SoC WiFi 42 | firmware.~~ This doesn't work--see below. 43 | * Need to try to read the N9 EFUSEs. 44 | 45 | 46 | I did some experimenting with the [MT7697][mt7697] on the 47 | [LinkIt 7697][linkit]: 48 | 49 | * I couldn't get the PDA in the MT7697 to decrypt code for either the 50 | MT6735 or MT6797. 51 | * Maybe the keys that are selectable in the four keyslots are 52 | SoC-family-specific or even SoC-class specific (e.g., "IoT" vs. 53 | "smartphone/tablet"). 54 | * Maybe I messed up and tried decrypting the wrong data, resulting in 55 | the garbled decryption output. 56 | * I'll have to try this again with different input data, just to be 57 | sure. 58 | * Trying to configure the PDA to operate on any data that isn't a 59 | multiple of 16 bytes fails when done through the SDIO interface. 60 | * Reconfiguring the PDA through its register interface enables sending 61 | data in multiples of four bytes, but it still does its decryption 62 | operation on blocks of 16 bytes. 63 | 64 | 65 | Important values: 66 | 67 | * IoT firmware `E_K(zeros)`: `1af02af42f0fb9677bba9808d797ffce` 68 | * SoC firmware `E_K(zeros)`: `b48d136fe376127cc5f91fb483e9d660` 69 | * SoC firmware IV: `00000000000000000000000000000000` 70 | 71 | 72 | [trm]: https://web.archive.org/web/20201101093239if_/https://labs.mediatek.com/en/download/6OPabr6H 73 | [docs]: https://web.archive.org/web/20210510020710/https://docs.labs.mediatek.com/resource/mt7687-mt7697/en/documentation 74 | [mt7697]: https://web.archive.org/web/20210927020259/https://labs.mediatek.com/en/chipset/MT7697 75 | [linkit]: https://web.archive.org/web/20210927020259/https://labs.mediatek.com/en/chipset/MT7697#HDK 76 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MediaTek WiFi RE 2 | 3 | Notes and utilities for reverse engineering the firmware used in MediaTek's 4 | WiFi cores. This includes the cores used in PCIe/USB/SDIO-attached chips, 5 | standalone WiFi microcontrollers, and SoCs with built-in WiFi. 6 | 7 | 8 | ## Quick start 9 | 10 | 11 | ### Software dependencies 12 | 13 | * Python 3 14 | * [Kaitai Struct Compiler][ksc] 15 | * [Kaitai Struct Python Runtime][kspr] 16 | 17 | 18 | ### Procedure 19 | 20 | 1. Install dependencies. 21 | 2. Run `make` to generate the parser code used by `extract_fw.py`. 22 | 3. Obtain the `WIFI_RAM_CODE*` binaries you're interested in. You can 23 | find these on many MediaTek-based Android phones in the 24 | `/system/etc/firmware` directory, but if that doesn't work for you, 25 | you can also find these firmware files on the Internet--typically in 26 | the "vendor.zip" files posted by Android ROM developers. You can also 27 | find them, for example, using [this GitHub search query][firmware query], 28 | but you'll need to be logged in to GitHub in order for that to work. 29 | 4. Extract the code and data sections from each binary with 30 | `./extract_fw.py ...`, where `...` is the name of the 31 | `WIFI_RAM_CODE*` firmware binary. 32 | 33 | 34 | ## Reverse engineering notes 35 | 36 | See [Notes.md](./Notes.md). 37 | 38 | 39 | ## License 40 | 41 | Except where otherwise stated: 42 | 43 | * All software in this repository (e.g., tools for unpacking firmware, etc.) is 44 | made available under the 45 | [GNU General Public License, version 3 or later][gpl]. 46 | * All copyrightable content that is not software (e.g., reverse engineering 47 | notes, this README file, etc.) is licensed under the 48 | [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa]. 49 | 50 | 51 | [ksc]: https://github.com/kaitai-io/kaitai_struct_compiler 52 | [kspr]: https://github.com/kaitai-io/kaitai_struct_python_runtime 53 | [firmware query]: https://github.com/search?q=filename%3AWIFI_RAM_CODE* 54 | [gpl]: COPYING.txt 55 | [cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/ 56 | -------------------------------------------------------------------------------- /extract_fw.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # SPDX-License-Identifier: GPL-3.0-or-later 3 | 4 | # extract_fw.py - A tool to parse MediaTek WiFi firmware images. 5 | # Copyright (C) 2018-2021 Forest Crossman 6 | # 7 | # This program is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License as published by 9 | # the Free Software Foundation, either version 3 of the License, or 10 | # (at your option) any later version. 11 | # 12 | # This program is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with this program. If not, see . 19 | 20 | 21 | import argparse 22 | import binascii 23 | import struct 24 | import sys 25 | from zlib import crc32 26 | 27 | import mediatek_soc_wifi_firmware 28 | 29 | 30 | # https://stackoverflow.com/a/9831671 31 | ONE_BITS = bytes(bin(x).count("1") for x in range(256)) 32 | 33 | 34 | def xor(a, b): 35 | '''XOR two byte arrays of equal length.''' 36 | 37 | assert len(a) == len(b) 38 | 39 | size = len(a) 40 | q = bytearray(size) 41 | for i in range(size): 42 | q[i] = (a[i] ^ b[i]) & 0xff 43 | return bytes(q) 44 | 45 | def bit_similarity(xored): 46 | '''Calculate the similarity of two byte arrays based on the result of their XOR.''' 47 | 48 | xored = bytes(xored) 49 | bitlen = len(xored) * 8 50 | ones = 0 51 | for byte in xored: 52 | ones += ONE_BITS[byte] 53 | return (bitlen - ones)/bitlen 54 | 55 | def find_ek_zero_consec(obfs_chunks): 56 | '''Find the block most likely to be the encrypted zero block, by longest run of consecutive occurrences.''' 57 | 58 | block_size = len(obfs_chunks[0]) 59 | 60 | stats = {} 61 | prev_chunk = None 62 | prev_run = None 63 | for curr_chunk in obfs_chunks: 64 | if curr_chunk == prev_chunk: 65 | if curr_chunk not in stats.keys(): 66 | stats[curr_chunk] = [] 67 | if prev_run != curr_chunk: 68 | stats[curr_chunk].append(0) 69 | stats[curr_chunk][-1] += 1 70 | prev_run = curr_chunk 71 | prev_chunk = curr_chunk 72 | 73 | highest = 0 74 | highest_chunk = None 75 | for (chunk, run_counts) in stats.items(): 76 | max_count = max(run_counts) 77 | if max_count > highest: 78 | highest = max_count 79 | highest_chunk = chunk 80 | 81 | if highest_chunk is None: 82 | print("Error: Failed to find E_K(zeroes).") 83 | return None 84 | 85 | print("Found likeliest E_K(zeroes) \"{}\" with longest run {}.".format(highest_chunk.hex(), highest)) 86 | 87 | return highest_chunk 88 | 89 | def find_ek_zero_freq(obfs_chunks): 90 | '''Find the block most likely to be the encrypted zero block, by frequency.''' 91 | 92 | counts = {} 93 | for chunk in obfs_chunks: 94 | if chunk not in counts.keys(): 95 | counts[chunk] = 0 96 | counts[chunk] += 1 97 | 98 | highest = 0 99 | highest_chunk = None 100 | for (chunk, count) in counts.items(): 101 | if count > highest: 102 | highest = count 103 | highest_chunk = chunk 104 | 105 | print("Found likeliest E_K(zeroes) \"{}\" with frequency {}.".format(highest_chunk.hex(), highest)) 106 | 107 | return highest_chunk 108 | 109 | def deobfuscate(obfuscated, mode='consec'): 110 | obfuscated = bytes(obfuscated) 111 | block_size = 16 112 | obfs_chunks = [obfuscated[i:i+block_size] for i in range(0, len(obfuscated), block_size)] 113 | deobfs_chunks = obfs_chunks.copy() 114 | 115 | if mode == 'consec': 116 | ek_zero = find_ek_zero_consec(obfs_chunks) 117 | elif mode == 'freq': 118 | ek_zero = find_ek_zero_freq(obfs_chunks) 119 | else: 120 | print("Error: Unknown mode: {}".format(mode)) 121 | return None 122 | 123 | if not ek_zero: 124 | return None 125 | 126 | if ek_zero == bytes(bytearray(block_size)): 127 | print("Error: Likeliest E_K(zeroes) is all zeros. This is extremely improbable, so it's almost certain that this firmware is not obfuscated.") 128 | return obfuscated 129 | 130 | similarity = bit_similarity(xor(ek_zero, bytes(bytearray(block_size)))) 131 | if similarity > 0.80 or similarity < 0.20: 132 | print("Warning: Likeliest E_K(zeroes) doesn't appear random. Are you sure this firmware is obfuscated?") 133 | 134 | ci_equals_ek_pi = set() 135 | ek_pi_to_pi = {} 136 | chunk_count = len(obfs_chunks) 137 | for chunk_i in range(1, chunk_count): 138 | second_prev_chunk_i = chunk_i - 2 139 | prev_chunk_i = chunk_i - 1 140 | curr_chunk_i = chunk_i 141 | next_chunk_i = chunk_i + 1 142 | 143 | # Check if the current obfuscated chunk is equivalent to an encrypted 144 | # block of 16 null bytes. i.e., C_i == E_K(zeroes) 145 | if obfs_chunks[curr_chunk_i] == ek_zero: 146 | # It was, so that means that the plaintext of the current chunk is 147 | # all zeros. 148 | deobfs_chunks[curr_chunk_i] = bytes(bytearray(block_size)) 149 | 150 | # Beause a ciphertext block is equal to the XOR of its encrypted 151 | # plaintext and the plaintext of the block that precedes it, and we 152 | # know that the ciphertext of the current block ("C_i") is equal to 153 | # a known encrypted block ("E_K(zeroes)"), that means the plaintext 154 | # of the previous chunk is all zeros. i.e., 155 | # "C_i = E_K(P_i) XOR P_i_minus_1", and since for the current block 156 | # "C_i == E_K(P_i)", that means "C_i = C_i XOR P_i_minus_1", and 157 | # after XOR-ing each side by C_i, "zeroes = P_i_minus_1", or 158 | # "P_i_minus_1 = zeroes". 159 | deobfs_chunks[prev_chunk_i] = bytes(bytearray(block_size)) 160 | 161 | # As we've just established, the plaintext of the previous block is 162 | # all zeroes ("P_i_minus_1 == zeroes"), and because we know the 163 | # encrypted value of a plaintext block of zeroes 164 | # ("E_K(P_i_minus_1) == E_K(zeroes)", and "E_K(zeroes)" is known), 165 | # we can now solve the equation 166 | # "C_i_minus_1 = E_K(P_i_minus_1) XOR P_i_minus_2" for the plaintext 167 | # of the second previous block, "P_i_minus_2". To do this, we simply 168 | # need to substitute in "E_K(zeroes)" for "E_K(P_i_minus_1)" and 169 | # then XOR both sides by "E_K(zeroes)". So now we have 170 | # "C_i_minus_1 XOR E_K(zeroes) = P_i_minus_2", or 171 | # "P_i_minus_2 = C_i_minus_1 XOR E_K(zeroes)". In other words, the 172 | # plaintext of the second previous block is equal to the XOR of the 173 | # ciphertext of the previous block and the encrypted block of 16 174 | # null bytes. 175 | plaintext_i2 = xor(obfs_chunks[prev_chunk_i], ek_zero) 176 | if curr_chunk_i == 1: 177 | # If the current chunk is 1, the previous chunk is 0, and the 178 | # second previous chunk is -1. Chunk -1 doesn't exist in the 179 | # obfuscated firmware--rather, the plaintext we calculated for 180 | # chunk -1 is the IV that gets XORed with the 0th block of 181 | # encrypted data to create the 0th block of obfuscated data, and 182 | # it's the same for every firmware for that SoC. 183 | print("Found IV: {}".format(plaintext_i2.hex())) 184 | else: 185 | deobfs_chunks[second_prev_chunk_i] = plaintext_i2 186 | 187 | # Since we know the plaintext of the 2nd previous chunk, if we know 188 | # its ciphertext ("C_i") is equal to its encrypted plaintext 189 | # ("E_K(P_i)"), add the C_i/E_K(P_i):P_i mapping to a lookup table 190 | # so we can decrypt that E_K(P_i) if we ever see it again. 191 | if second_prev_chunk_i in ci_equals_ek_pi: 192 | ek_pi_to_pi[obfs_chunks[second_prev_chunk_i]] = plaintext_i2 193 | 194 | # Make sure we're not on the last chunk to avoid indexing errors. 195 | if next_chunk_i < chunk_count: 196 | # The plaintext of the current chunk is all zeroes 197 | # ("P_i == zeroes"), and since 198 | # "C_i_plus_1 = E_K(P_i_plus_1) XOR P_i", the next ciphertext 199 | # ("C_i_plus_1") is equal to its encrypted plaintext 200 | # ("E_K(P_i_plus_1)"), or "C_i_plus_1 == E_K(P_i_plus_1)". This 201 | # is useful to know, so we store the index of this chunk in a 202 | # set to use in later loop iterations. We skip blocks of 203 | # encrypted zeroes because we already handle them separately. 204 | if deobfs_chunks[next_chunk_i] != ek_zero: 205 | ci_equals_ek_pi.add(next_chunk_i) 206 | 207 | # Find other chunks with a known plaintext. 208 | if ek_pi_to_pi: 209 | print("Finding other known-plaintext blocks...") 210 | for chunk_i in range(1, chunk_count): 211 | second_prev_chunk_i = chunk_i - 2 212 | prev_chunk_i = chunk_i - 1 213 | curr_chunk_i = chunk_i 214 | next_chunk_i = chunk_i + 1 215 | 216 | if curr_chunk_i in ci_equals_ek_pi: 217 | # This chunk has been decrypted already, so skip it. 218 | continue 219 | 220 | known_plaintext = ek_pi_to_pi.get(obfs_chunks[curr_chunk_i]) 221 | if known_plaintext: 222 | print("Found one!") 223 | deobfs_chunks[curr_chunk_i] = known_plaintext 224 | 225 | chunks_deobfuscated_successfully = 0 226 | for chunk_i in range(chunk_count): 227 | if deobfs_chunks[chunk_i] != obfs_chunks[chunk_i]: 228 | chunks_deobfuscated_successfully += 1 229 | 230 | print("Deobfuscated {} of {} blocks ({:.2f}%).".format(chunks_deobfuscated_successfully, chunk_count, 231 | (100*chunks_deobfuscated_successfully)/chunk_count)) 232 | 233 | return b''.join(deobfs_chunks) 234 | 235 | 236 | if __name__ == "__main__": 237 | parser = argparse.ArgumentParser() 238 | parser.add_argument("input", type=str, help="Input file.") 239 | parser.add_argument("-d", "--deobfs", dest="deobfsuscate", action="store_true", help="Deobfuscate the firmware, if necessary.") 240 | parser.add_argument("-e", "--no-deobfs", dest="deobfsuscate", action="store_false", help="Don't deobfuscate the firmware, even if it's marked as obfuscated. (default behavior)") 241 | parser.set_defaults(deobfsuscate=False) 242 | #parser.add_argument("-o", "--output", type=str, help="Output file.") 243 | args = parser.parse_args() 244 | 245 | orig = args.input 246 | ext = "bin" 247 | basename = orig 248 | 249 | fw_bytes = open(orig, 'rb').read() 250 | fw = mediatek_soc_wifi_firmware.MediatekSocWifiFirmware.from_bytes(fw_bytes) 251 | if fw.signature not in ("MTKE", "MTKW"): 252 | print("Error: Unrecognized firmware signature \"{}\"".format(fw.signature), file=sys.stderr) 253 | sys.exit(1) 254 | firmware = fw.firmware 255 | calculated_crc = crc32(fw_bytes[8:]) 256 | if calculated_crc != firmware.crc: 257 | print("CRC BAD: Expected 0x{:08x}, got 0x{:08x}.".format(firmware.crc, calculated_crc)) 258 | else: 259 | print("CRC OK") 260 | if fw.signature == "MTKE": 261 | for i in range(len(firmware.fwdl_sections)): 262 | section = firmware.fwdl_sections[i] 263 | 264 | filename = "{}.file_idx_{}.dest_addr_{:02X}.{}".format(basename, i, section.dest_addr, ext) 265 | data = section.data 266 | open(filename, 'wb').write(data) 267 | 268 | if args.deobfsuscate: 269 | deobfuscated = None 270 | if section.enc == 1: 271 | print("Section {} key index: {}".format(i, section.k_idx)) 272 | deobfuscated = deobfuscate(section.data) 273 | else: 274 | print("Section {} is not encrypted.".format(i)) 275 | if deobfuscated: 276 | data = deobfuscated 277 | filename = "{}.file_idx_{}.dest_addr_{:02X}.deobfs.{}".format(basename, i, section.dest_addr, ext) 278 | open(filename, 'wb').write(data) 279 | 280 | elif fw.signature == "MTKW": 281 | for i in range(len(firmware.fwdl_sections)): 282 | section = firmware.fwdl_sections[i] 283 | filename = "{}.file_idx_{}.dest_addr_{:02X}.{}".format(basename, i, section.dest_addr, ext) 284 | data = section.data 285 | open(filename, 'wb').write(data) 286 | 287 | if args.deobfsuscate: 288 | # First, combine the data from each section into one big blob. 289 | data_blobs = [] 290 | for i in range(len(firmware.fwdl_sections)): 291 | section_data = firmware.fwdl_sections[i].data 292 | data_blobs.append(section_data) 293 | 294 | # Just to be safe, make sure the size is a multiple of the 295 | # block size. 296 | block_count = len(section_data) // 16 297 | assert len(section_data) == block_count * 16 298 | all_blobs = b''.join(data_blobs) 299 | 300 | # Now we deobfuscate all the blobs together and split them 301 | # afterwards. 302 | deobfuscated = deobfuscate(all_blobs) 303 | if deobfuscated: 304 | offset = 0 305 | for i in range(len(firmware.fwdl_sections)): 306 | section = firmware.fwdl_sections[i] 307 | section_len = len(section.data) 308 | data = deobfuscated[offset:offset+section_len] 309 | filename = "{}.file_idx_{}.dest_addr_{:02X}.deobfs.{}".format(basename, i, section.dest_addr, ext) 310 | open(filename, 'wb').write(data) 311 | offset += section_len 312 | assert offset == len(all_blobs) 313 | -------------------------------------------------------------------------------- /mediatek_external_wifi_firmware.ksy: -------------------------------------------------------------------------------- 1 | meta: 2 | id: mediatek_external_wifi_firmware 3 | endian: le 4 | title: MediaTek External WiFi Firmware 5 | license: CC0-1.0 6 | seq: 7 | - id: ilm 8 | size: fw_image_tailer.ilm_info.len + 4 9 | - id: dlm 10 | size: fw_image_tailer.dlm_info.len + 4 11 | instances: 12 | fw_image_tailer: 13 | pos: _io.size - 36 * 2 14 | type: fw_image_tailer 15 | types: 16 | fw_image_tailer: 17 | seq: 18 | - id: ilm_info 19 | type: info 20 | - id: dlm_info 21 | type: info 22 | types: 23 | info: 24 | seq: 25 | - id: addr 26 | type: u4 27 | - id: chip_info 28 | type: u1 29 | - id: feature_set 30 | type: feature_set 31 | - id: ram_version 32 | size: 10 33 | - id: ram_built_date 34 | size: 16 35 | - id: len 36 | type: u4 37 | types: 38 | feature_set: 39 | seq: 40 | - id: reserved 41 | type: b5 42 | - id: key_index 43 | type: b2 44 | - id: encrypt_mode 45 | type: b1 46 | -------------------------------------------------------------------------------- /mediatek_linkit_wifi_firmware.ksy: -------------------------------------------------------------------------------- 1 | meta: 2 | id: mediatek_linkit_wifi_firmware 3 | endian: le 4 | title: MediaTek LinkIt WiFi Firmware 5 | license: CC0-1.0 6 | seq: 7 | - id: image_size 8 | type: u4 9 | - id: image 10 | type: image 11 | size: image_size - 4 12 | - id: patch_size 13 | type: u4 14 | - id: patch 15 | type: patch 16 | size: patch_size - 4 17 | types: 18 | image: 19 | seq: 20 | - id: ilm_pda_packets 21 | type: pda_packets 22 | size: fw_image_tailer.ilm_info.len + 4 + 12 * 4 23 | doc: "ILM length + 4-byte CRC + one 12-byte header per packet." 24 | - id: dlm_pda_packets 25 | type: pda_packets 26 | size: fw_image_tailer.dlm_info.len + 4 + 12 * 1 27 | doc: "DLM length + 4-byte CRC + one 12-byte header per packet." 28 | instances: 29 | fw_image_tailer: 30 | pos: _io.size - 36 * 2 31 | type: fw_image_tailer 32 | pda_packets: 33 | seq: 34 | - id: pda_packets 35 | type: pda_packet 36 | repeat: eos 37 | pda_packet: 38 | seq: 39 | - id: pda_packet_header 40 | type: pda_packet_header 41 | - id: pda_packet_data 42 | size: pda_packet_header.len - 12 43 | pda_packet_header: 44 | seq: 45 | - id: len 46 | type: u4 47 | - id: unk 48 | size: 8 49 | patch: 50 | seq: 51 | - id: header 52 | type: patch_header 53 | - id: data 54 | size-eos: true 55 | type: patch_body 56 | patch_header: 57 | seq: 58 | - id: built_date 59 | size: 16 60 | type: str 61 | encoding: ASCII 62 | - id: platform 63 | size: 4 64 | - id: hw_ver 65 | type: u2be 66 | - id: sw_ver 67 | type: u2be 68 | - id: reserved 69 | size: 4 70 | - id: crc 71 | type: u2 72 | patch_body: 73 | seq: 74 | - id: enabled_patches 75 | size: 8 76 | doc: "Little-endian 64-bit bitfield of enabled patches." 77 | - id: patch_dst_list 78 | type: u4 79 | repeat: expr 80 | repeat-expr: 64 81 | - id: patch_src_list 82 | type: u4 83 | repeat: expr 84 | repeat-expr: 64 85 | - id: patch_data 86 | size-eos: true 87 | fw_image_tailer: 88 | seq: 89 | - id: ilm_info 90 | type: info 91 | size: 36 92 | - id: dlm_info 93 | type: info 94 | size: 36 95 | types: 96 | info: 97 | seq: 98 | - id: addr 99 | type: u4 100 | - id: chip_info 101 | type: u1 102 | - id: feature_set 103 | type: feature_set 104 | - id: ram_version 105 | size: 10 106 | - id: ram_built_date 107 | size: 16 108 | - id: len 109 | type: u4 110 | types: 111 | feature_set: 112 | seq: 113 | - id: reserved 114 | type: b5 115 | - id: key_index 116 | type: b2 117 | - id: encrypt_mode 118 | type: b1 119 | -------------------------------------------------------------------------------- /mediatek_linux_wifi_bt_patch.ksy: -------------------------------------------------------------------------------- 1 | meta: 2 | id: mediatek_linux_wifi_bt_patch 3 | endian: le 4 | title: MediaTek WiFi/BT Firmware Patch (Linux) 5 | license: CC0-1.0 6 | seq: 7 | - id: header 8 | size: 30 9 | type: header 10 | - id: body 11 | size-eos: true 12 | type: body 13 | types: 14 | header: 15 | # This is defined in the kernel as "mt7615_patch_hdr", but this format is 16 | # almost never followed correctly, so here we only parse the struct elements 17 | # that seem to be used consistently. The device never sees the header, 18 | # anyways, since the kernel always loads the firmware into the device 19 | # starting from byte 30 (0x1e). 20 | seq: 21 | - id: build_date 22 | size: 16 23 | type: str 24 | encoding: ASCII 25 | - id: platform 26 | size: 4 27 | type: str 28 | encoding: ASCII 29 | body: 30 | seq: 31 | - id: enabled_patches 32 | size: 8 33 | doc: "Little-endian 64-bit bitfield of enabled patches." 34 | - id: rom_addr_list 35 | type: u4 36 | repeat: expr 37 | repeat-expr: 64 38 | doc: "List of ROM addresses to patch with jump instructions." 39 | - id: jump_addr_list 40 | type: u4 41 | repeat: expr 42 | repeat-expr: 64 43 | doc: "List of jump destination addresses." 44 | - id: patch_data 45 | size-eos: true 46 | -------------------------------------------------------------------------------- /mediatek_soc_wifi_firmware.ksy: -------------------------------------------------------------------------------- 1 | meta: 2 | id: mediatek_soc_wifi_firmware 3 | endian: le 4 | title: MediaTek SoC WiFi Firmware 5 | license: CC0-1.0 6 | seq: 7 | - id: firmware 8 | type: 9 | switch-on: signature 10 | cases: 11 | '"MTKE"': firmware_divided_download_e 12 | '"MTKW"': firmware_divided_download_w 13 | instances: 14 | signature: 15 | pos: 0 16 | type: str 17 | size: 4 18 | encoding: ASCII 19 | types: 20 | firmware_divided_download_e: 21 | seq: 22 | - id: signature 23 | contents: 'MTKE' 24 | - id: crc 25 | type: u4 26 | doc: CRC calculated without first 8 bytes included. 27 | - id: num_of_entries 28 | type: u4 29 | - id: major_number 30 | type: u2 31 | - id: minor_number 32 | type: u2 33 | - id: chip_info 34 | type: u4 35 | - id: reserved 36 | type: u4 37 | - id: fwdl_sections 38 | type: fwdl_section 39 | repeat: expr 40 | repeat-expr: num_of_entries 41 | types: 42 | fwdl_section: 43 | seq: 44 | - id: offset 45 | type: u4 46 | - id: k_idx 47 | type: u1 48 | - id: enc 49 | type: u1 50 | - id: reserved 51 | type: u2 52 | - id: length 53 | type: u4 54 | - id: dest_addr 55 | type: u4 56 | instances: 57 | data: 58 | io: _root._io 59 | pos: offset 60 | size: length 61 | firmware_divided_download_w: 62 | seq: 63 | - id: signature 64 | contents: 'MTKW' 65 | - id: crc 66 | type: u4 67 | doc: CRC calculated without first 8 bytes included. 68 | - id: num_of_entries 69 | type: u4 70 | - id: reserved 71 | type: u4 72 | - id: fwdl_sections 73 | type: fwdl_section 74 | repeat: expr 75 | repeat-expr: num_of_entries 76 | types: 77 | fwdl_section: 78 | seq: 79 | - id: offset 80 | type: u4 81 | - id: reserved 82 | type: u4 83 | - id: length 84 | type: u4 85 | - id: dest_addr 86 | type: u4 87 | instances: 88 | data: 89 | io: _root._io 90 | pos: offset 91 | size: length 92 | -------------------------------------------------------------------------------- /mt7697.cfg: -------------------------------------------------------------------------------- 1 | # SPDX-License-Identifier: 0BSD 2 | 3 | # Copyright (C) 2020 by Forest Crossman 4 | # 5 | # Permission to use, copy, modify, and/or distribute this software for 6 | # any purpose with or without fee is hereby granted. 7 | # 8 | # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 9 | # WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 10 | # WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 11 | # AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 12 | # DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 13 | # PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 14 | # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 15 | # PERFORMANCE OF THIS SOFTWARE. 16 | 17 | 18 | source [find interface/jlink.cfg] 19 | 20 | transport select swd 21 | adapter_khz 5000 22 | 23 | source [find target/swj-dp.tcl] 24 | 25 | swj_newdap mt7697 cpu -irlen 4 -ircapture 0x1 -irmask 0xf -expected-id 0x2ba01477 26 | dap create mt7697.dap -chain-position mt7697.cpu 27 | 28 | target create mt7697.cpu cortex_m -endian little -dap mt7697.dap 29 | 30 | init 31 | 32 | # Write 0x76371688 to 0x8300F050 *exactly* three times to enable memory reads. 33 | mww 0x8300F050 0x76371688 34 | mww 0x8300F050 0x76371688 35 | mww 0x8300F050 0x76371688 36 | --------------------------------------------------------------------------------