├── .gitignore ├── LICENSE ├── README.md ├── psptrace ├── __init__.py └── psptrace.py ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Object files 5 | *.o 6 | *.ko 7 | *.obj 8 | *.elf 9 | 10 | # Linker output 11 | *.ilk 12 | *.map 13 | *.exp 14 | 15 | # Precompiled Headers 16 | *.gch 17 | *.pch 18 | 19 | # Libraries 20 | *.lib 21 | *.a 22 | *.la 23 | *.lo 24 | 25 | # Shared objects (inc. Windows DLLs) 26 | *.dll 27 | *.so 28 | *.so.* 29 | *.dylib 30 | 31 | # Executables 32 | *.exe 33 | *.app 34 | *.i*86 35 | *.x86_64 36 | *.hex 37 | 38 | # Debug files 39 | *.dSYM/ 40 | *.su 41 | *.pdb 42 | 43 | # Kernel Module Compile Results 44 | *.mod* 45 | *.cmd 46 | .tmp_versions/ 47 | modules.order 48 | Module.symvers 49 | Mkfile.old 50 | dkms.conf 51 | 52 | .DS_Store 53 | *.id0 54 | *.id1 55 | *.nam 56 | *.til 57 | .idea 58 | *.pyc 59 | 60 | #GDB History 61 | .gdb_history 62 | *.pickle 63 | 64 | # SPI traces 65 | *.logicdata 66 | *.sr 67 | 68 | # Debian packages 69 | *.deb 70 | 71 | # Kernel build files 72 | *.changes 73 | *.buildinfo 74 | 75 | # Parsed pagetables 76 | tools/pagetables/parsed 77 | tools/pagetables/parsed_agesa_1009 78 | 79 | # Coreboot repo 80 | coreboot/* 81 | 82 | # Kernel repo 83 | kernel/linux 84 | 85 | # Sqlite Databases from IDA Diphora plugin 86 | *.sqlite 87 | 88 | # Fletcher binary 89 | tools/fletcher/fletcher 90 | 91 | # Test binaries 92 | psptool/test/binaries 93 | psptool/test/selected_binaries/ 94 | psptool/test/latest-ryzen-june-2019 95 | 96 | build 97 | dist 98 | *.egg-info 99 | 100 | *.swp 101 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | 676 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PSPTrace 2 | 3 | PSPTrace can be used to **correlate an SPI capture** of an **AMD boot procedure** recorded with a Saleae Logic analyzer to the **PSP firmware** of a UEFI image. 4 | 5 | SPI captures must be exported from the Saleae Logic software via *Analyzers > SPI > Export as text/csv file*. Please make sure you sampled with an appropriate sample rate and the SPI analyzer is set to `Hex`. 6 | 7 | PSPTrace requires [PSPTool](https://github.com/PSPReverse/PSPTool) to be installed. 8 | 9 | ``` 10 | $ python3 psptrace.py 11 | Error: the following arguments are required: csvfile, romfile 12 | usage: psptrace.py [-h] [-o] [-n] [-c] [-t] [-l LIMIT_ROWS] [-v] csvfile romfile 13 | 14 | Read in an SPI capture created by a Saleae Logic Analyzer and a ROM file resembling the flash contents and display an access 15 | chronology. On first load, psptrace needs to parse a lot of raw data which will be saved on disk. All other loads will then be 16 | much faster. 17 | 18 | positional arguments: 19 | csvfile CSV file of SPI capture 20 | romfile ROM file of SPI contents 21 | 22 | optional arguments: 23 | -h, --help show this help message and exit 24 | -o, --overview-mode aggregate accesses to the same firmware entry 25 | -n, --no-duplicates hide duplicate accesses (e.g. caused by multiple PSPs) 26 | -c, --collapse collapse consecutive reads to the same PSP entry type (denoted by [c] and sometimes by ~ if collapsing 27 | was fuzzy) 28 | -t, --normalize-timestamps 29 | normalize all timestamps 30 | -l LIMIT_ROWS, --limit-rows LIMIT_ROWS 31 | limit the processed rows to a maximum of n 32 | -v, --verbose increase output verbosity 33 | ``` 34 | 35 | ## Example usage 36 | 37 | After recording the boot procedure of a Supermicro server system with an AMD Epyc CPU, PSPTrace outputs the following boot in overview mode (`-o`): 38 | 39 | ``` 40 | $ psptrace -o spi_trace.txt flash.bin 41 | 42 | Info: Creating database in spi_trace.txt.pickle ... 43 | Info: Parsed and stored a database of 14028942 rows. 44 | +---------+---------------+----------+-----------------------------+------+ 45 | | No. | Lowest access | Range | Type | Info | 46 | +---------+---------------+----------+-----------------------------+------+ 47 | | 0 | 0x820000 | 0x780007 | Unknown area | | 48 | | 22 | 0x020000 | 0x00001c | Firmware Entry Table | | 49 | | 33 | 0x077000 | 0x00012a | Directory: $PSP | | 50 | | 70 | 0x077000 | 0x000100 | Directory: $PSP | CCP | 51 | | 107 | 0x077400 | 0x000240 | AMD_PUBLIC_KEY | CCP | 52 | | 177 | 0x149400 | 0x00d780 | PSP_FW_BOOT_LOADER | CCP | 53 | | | | | | | 54 | | | | | ~ 3410 µs delay ~ | | 55 | | | | | | | 56 | | 7084 | 0x149000 | 0x000180 | Directory: $PL2 | CCP | 57 | | 7090 | 0x000000 | 0x020046 | Unknown area | | 58 | | 7091 | 0x020000 | 0x000024 | Firmware Entry Table | | 59 | | | | | | | 60 | | | | | ~ 66 µs delay ~ | | 61 | | | | | | | 62 | | 7095 | 0x117000 | 0x000160 | Directory: $BHD | | 63 | | 7096 | 0x149000 | 0x000152 | Directory: $PL2 | | 64 | | 7554 | 0x000000 | 0x117280 | Unknown area | | 65 | | 7581 | 0x020000 | 0x000022 | Firmware Entry Table | | 66 | | 7859 | 0x249000 | 0x0001c0 | Directory: $BL2 | CCP | 67 | | 7880 | 0x1170c0 | 0x000080 | Directory: $BHD | CCP | 68 | | 7909 | 0x2491c0 | 0x000240 | Unknown area | CCP | 69 | | 8017 | 0x249010 | 0x00019a | Directory: $BL2 | | 70 | | 8560 | 0x17c100 | 0x001932 | DEBUG_UNLOCK | | 71 | | 8939 | 0x17c200 | 0x001800 | DEBUG_UNLOCK | CCP | 72 | | 10144 | 0x177a00 | 0x0001c0 | SEC_DBG_PUBLIC_KEY | | 73 | | 10576 | 0x177bc0 | 0x000180 | SEC_DBG_PUBLIC_KEY | CCP | 74 | | | | | | | 75 | | | | | ~ 178 µs delay ~ | | 76 | | | | | | | 77 | | 10582 | 0x17e000 | 0x000080 | TOKEN_UNLOCK | CCP | 78 | 79 | [...] 80 | ``` 81 | 82 | -------------------------------------------------------------------------------- /psptrace/__init__.py: -------------------------------------------------------------------------------- 1 | from .psptrace import PSPTrace 2 | 3 | import pkg_resources 4 | __version__ = pkg_resources.get_distribution("psptrace").version 5 | -------------------------------------------------------------------------------- /psptrace/psptrace.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | # PSPTrace - Correlate SPI captures created by a Saleae Logic Analyzer with PSP firmware from UEFI images 4 | # Copyright (C) 2019 Christian Werling 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | 19 | import os 20 | import pickle 21 | import csv 22 | import sys 23 | import argparse 24 | import pkg_resources 25 | 26 | from signal import signal, SIGPIPE, SIG_DFL 27 | from collections import deque 28 | 29 | from prettytable import PrettyTable 30 | 31 | from psptool import PSPTool 32 | from psptool.entry import Entry 33 | 34 | # from http://www.winbond.com.tw/resource-files/w25q128jv%20spi%20revb%2011082016.pdf 35 | WINBOND_INSTRUCTIONS = { 36 | 0x06: { 37 | 'name': 'Write Enable', 38 | 'size': 1, 39 | 'expects_data': False 40 | }, 41 | 0x50: { 42 | 'name': 'Volatile SR Write Enable', 43 | 'size': 1, 44 | 'expects_data': False 45 | }, 46 | 0x04: { 47 | 'name': 'Write Disable', 48 | 'size': 1, 49 | 'expects_data': False 50 | }, 51 | 0xAB: { 52 | 'name': 'Release Power-down / ID', 53 | 'size': 4, 54 | 'expects_data': True 55 | }, 56 | 0x90: { 57 | 'name': 'Manufacturer/Device ID', 58 | 'size': 4, 59 | 'expects_data': True 60 | }, 61 | 0x9F: { 62 | 'name': 'JEDEC ID', 63 | 'size': 1, 64 | 'expects_data': True 65 | }, 66 | 0x4B: { 67 | 'name': 'Manufacturer/Device ID', 68 | 'size': 5, 69 | 'expects_data': True 70 | }, 71 | 0x03: { 72 | 'name': 'Read Data', 73 | 'size': 4, 74 | 'expects_data': True 75 | }, 76 | 0x0B: { 77 | 'name': 'Fast Read', 78 | 'size': 5, 79 | 'expects_data': True 80 | }, 81 | 0x02: { 82 | 'name': 'Page Program', 83 | 'size': 6, 84 | 'expects_data': False 85 | }, 86 | 0x20: { 87 | 'name': 'Sector Erase (4KB)', 88 | 'size': 4, 89 | 'expects_data': False 90 | }, 91 | 0x52: { 92 | 'name': 'Block Erase (32KB)', 93 | 'size': 4, 94 | 'expects_data': False 95 | }, 96 | 0xD8: { 97 | 'name': 'Block Erase (64KB)', 98 | 'size': 4, 99 | 'expects_data': False 100 | }, 101 | 0xC7: { 102 | 'name': 'Chip Erase (0xC7)', 103 | 'size': 1, 104 | 'expects_data': False 105 | }, 106 | 0x60: { 107 | 'name': 'Chip Erase (0x60)', 108 | 'size': 1, 109 | 'expects_data': False 110 | }, 111 | 0x05: { 112 | 'name': 'Read Status Register-1 (0x05)', 113 | 'size': 1, 114 | 'expects_data': True 115 | }, 116 | 0x01: { 117 | 'name': 'Read Status Register-1 (0x01)', 118 | 'size': 1, 119 | 'expects_data': True 120 | }, 121 | 0x35: { 122 | 'name': 'Read Status Register-2 (0x35)', 123 | 'size': 1, 124 | 'expects_data': True 125 | }, 126 | 0x31: { 127 | 'name': 'Read Status Register-2 (0x31)', 128 | 'size': 1, 129 | 'expects_data': True 130 | }, 131 | 0x15: { 132 | 'name': 'Read Status Register-3 (0x15)', 133 | 'size': 1, 134 | 'expects_data': True 135 | }, 136 | 0x11: { 137 | 'name': 'Read Status Register-3 (0x11', 138 | 'size': 1, 139 | 'expects_data': True 140 | }, 141 | 0x5A: { 142 | 'name': 'Read SFDP Register', 143 | 'size': 5, 144 | 'expects_data': True 145 | }, 146 | 0x44: { 147 | 'name': 'Erase Security Register', 148 | 'size': 4, 149 | 'expects_data': False 150 | }, 151 | 0x42: { 152 | 'name': 'Program Security Register', 153 | 'size': 6, 154 | 'expects_data': False 155 | }, 156 | 0x48: { 157 | 'name': 'Read Security Register', 158 | 'size': 5, 159 | 'expects_data': True 160 | }, 161 | 0x7E: { 162 | 'name': 'Global Block Lock', 163 | 'size': 1, 164 | 'expects_data': False 165 | }, 166 | 0x98: { 167 | 'name': 'Global Block Unlock', 168 | 'size': 1, 169 | 'expects_data': False 170 | }, 171 | 0x3D: { 172 | 'name': 'Read Block Lock', 173 | 'size': 4, 174 | 'expects_data': True 175 | }, 176 | 0x36: { 177 | 'name': 'Individual Block Lock', 178 | 'size': 4, 179 | 'expects_data': False 180 | }, 181 | 0x39: { 182 | 'name': 'Individual Block Unlock', 183 | 'size': 4, 184 | 'expects_data': False 185 | }, 186 | 0x75: { 187 | 'name': 'Erase / Program Suspend', 188 | 'size': 1, 189 | 'expects_data': False 190 | }, 191 | 0x7A: { 192 | 'name': 'Erase / Program Resume', 193 | 'size': 1, 194 | 'expects_data': False 195 | }, 196 | 0xB9: { 197 | 'name': 'Power-down', 198 | 'size': 1, 199 | 'expects_data': False 200 | }, 201 | 0x66: { 202 | 'name': 'Enable Reset', 203 | 'size': 1, 204 | 'expects_data': False 205 | }, 206 | 0x99: { 207 | 'name': 'Reset Device', 208 | 'size': 1, 209 | 'expects_data': False 210 | }, 211 | 0xEB: { 212 | 'name': 'Fast Read Quad I/O', 213 | 'size': 4, 214 | 'expects_data': True 215 | }, 216 | 0xE7: { 217 | 'name': 'Word Read Quad I/O', 218 | 'size': 4, 219 | 'expects_data': True 220 | }, 221 | 0xE3: { 222 | 'name': 'Octal Word Read Quad I/O', 223 | 'size': 4, 224 | 'expects_data': True 225 | }, 226 | 0x94: { 227 | 'name': 'Mftr./Device ID Quad I/O', 228 | 'size': 4, 229 | 'expects_data': True 230 | }, 231 | } 232 | 233 | 234 | class ObligingArgumentParser(argparse.ArgumentParser): 235 | """ Display the full help message whenever there is something wrong with the arguments. 236 | (from https://groups.google.com/d/msg/argparse-users/LazV_tEQvQw/xJhBOm1qS5IJ) """ 237 | def error(self, message): 238 | sys.stderr.write('Error: %s\n' % message) 239 | self.print_help() 240 | sys.exit(2) 241 | 242 | 243 | # from https://stackoverflow.com/a/39358140 244 | class RangeDict(dict): 245 | def __getitem__(self, item): 246 | if type(item) != range: 247 | for key in self: 248 | if item in key: 249 | return self[key] 250 | else: 251 | return super().__getitem__(item) 252 | 253 | 254 | def count_data_bytes(base_addr, s): 255 | """ Count bytes until the next instruction byte pops up, because that's the number of s bytes sent back on the 256 | (to us invisible) MISO channel. This is a necessary heuristic as we also do not have Chip Select (CS) data in the 257 | csv yet. """ 258 | 259 | data_bytes = 1 260 | try: 261 | while (s[base_addr + data_bytes] 262 | not in WINBOND_INSTRUCTIONS.keys()): 263 | data_bytes += 1 264 | except IndexError: 265 | pass 266 | 267 | return data_bytes 268 | 269 | 270 | def get_database(csvfile, psptool): 271 | database_file = csvfile + '.pickle' 272 | 273 | if os.path.exists(database_file): 274 | print('Info: Found existing database in %s.' % database_file) 275 | print('Info: Loading database ...') 276 | 277 | with open(database_file, 'rb') as f: 278 | data = pickle.load(f) 279 | 280 | # (imperfect) check if this database is complete and up to date 281 | if 'raw' in data and 'read_accesses' in data: 282 | print('Info: Loaded a capture of %d rows.' % len(data['raw']['time'])) 283 | return data 284 | else: 285 | print('Info: Loaded database is incomplete or outdated!') 286 | 287 | print('Info: Creating database in %s ...' % database_file) 288 | 289 | with open(csvfile, newline='') as csvfile: 290 | reader = csv.DictReader(csvfile, delimiter=',') 291 | 292 | # Case 1: This CSV export comes from the standard Saleae SPI analyzer 293 | if reader.fieldnames == ['Time [s]', 'Packet ID' , 'MOSI' , 'MISO'] or \ 294 | reader.fieldnames == ['Time [s]', 'Packet ID' , 'MOSI']: 295 | 296 | data = { 297 | 'raw': { 298 | 'time': [], 299 | 'packet_id': [], 300 | 'mosi': [] 301 | }, 302 | 'read_accesses': None, 303 | } 304 | 305 | for row in reader: 306 | try: 307 | data['raw']['time'].append(float(row['Time [s]'])) 308 | data['raw']['packet_id'].append(int(row['Packet ID'])) 309 | data['raw']['mosi'].append(int(row['MOSI'], 16)) 310 | #data['raw']['miso'].append(int(row['MISO'], 16)) 311 | except ValueError: 312 | pass 313 | 314 | # Case 2: This CSV export comes from the Quad SPI analyzer at https://github.com/dedicatedcomputing/saleae_qspi 315 | elif reader.fieldnames == ['Time [s]', 'Value']: 316 | data = { 317 | 'raw': { 318 | 'time': [], 319 | 'value': [] 320 | }, 321 | 'read_accesses': None, 322 | } 323 | 324 | for row in reader: 325 | try: 326 | data['raw']['time'].append(float(row['Time [s]'])) 327 | data['raw']['value'].append(int(row['Value'], 16)) 328 | except ValueError: 329 | pass 330 | 331 | # convert timestamp from s to ns 332 | data['raw']['time'] = [int(t * 10 ** 9) for t in data['raw']['time']] 333 | 334 | # parse read accesses from the raw data 335 | data['read_accesses'] = find_read_accesses(data['raw'], psptool) 336 | 337 | with open(database_file, 'wb') as f: 338 | pickle.dump(data, f) 339 | 340 | print('Info: Parsed and stored a database of %d rows.' % len(data['raw']['time'])) 341 | 342 | return data 343 | 344 | 345 | def find_read_accesses(data, psptool): 346 | """ Build up data structure containing all (fast) read accesses """ 347 | 348 | read_accesses = {} 349 | 350 | # use psptool to correlate addresses to firmware directory entries 351 | directories = [directory for rom in psptool.blob.roms for directory in rom.directories] 352 | directory_entries = [directory.entries for directory in directories] 353 | 354 | # flatten list of lists 355 | all_entries = [entry for sublist in directory_entries for entry in sublist] 356 | 357 | # add directory headers as entries, too 358 | # all_entries += [{ 359 | # 'address': directory.get_address(), 360 | # 'size': directory.buffer_size, 361 | # 'type': 'Header: ' + str(directory.magic, 'ascii') 362 | # } for directory in directories] 363 | 364 | # create RangeDict in order to find entry types for addresses 365 | type_at_address_range = RangeDict({ 366 | ** { 367 | range(entry.get_address(), entry.get_address() + entry.buffer_size): # key is start and end address of the entry 368 | entry.type 369 | for entry in all_entries if entry.buffer_size != 0xffffffff # value is its type 370 | }, ** { 371 | range(directory.get_address(), directory.get_address() + len(directory)): 372 | 'Directory: ' + str(directory.magic, 'ascii') 373 | for directory in directories 374 | }, range(0x20000, 0x20040): 'Firmware Entry Table' 375 | }) 376 | 377 | last_start_time = 0 378 | last_end_time = 0 379 | unparsable_instructions = { 380 | instr['name']: 0 for instr in WINBOND_INSTRUCTIONS.values() 381 | } 382 | invalid_instructions = {} 383 | index = 0 384 | last_index = 0 385 | instr_index = 0 386 | end_time = data['time'][index] 387 | 388 | # Case 1: This CSV export comes from the standard Saleae SPI analyzer 389 | if 'mosi' in data: 390 | while index < len(data['mosi']): 391 | instr = data['mosi'][index] 392 | 393 | if instr == 0x03 or instr == 0x0b: # i.e. instruction 'Read data' or 'Fast Read' 394 | instr_size = WINBOND_INSTRUCTIONS[instr]['size'] 395 | data_bytes = count_data_bytes(index + instr_size, data['mosi']) 396 | 397 | start_time = data['time'][index] 398 | end_time = data['time'][index + data_bytes] 399 | duration = end_time - start_time 400 | latency = start_time - last_end_time 401 | 402 | address = int.from_bytes(bytes(data['mosi'][index + 1:index + 4]), byteorder='big') 403 | size = data_bytes 404 | type_ = type_at_address_range[address] 405 | 406 | read_accesses[start_time] = { 407 | 'instr_index': instr_index, 408 | 'start_time': start_time, 409 | 'end_time': end_time, 410 | 'duration': duration, 411 | 'latency': latency, 412 | 'address': address, 413 | 'size': size, 414 | 'type': type_, 415 | 'info': [] 416 | } 417 | 418 | # skip forward 419 | last_end_time = end_time 420 | index += WINBOND_INSTRUCTIONS[instr]['size'] + data_bytes 421 | instr_index += 1 422 | 423 | elif instr in WINBOND_INSTRUCTIONS: # i.e. unparsable instructions 424 | unparsable_instructions[WINBOND_INSTRUCTIONS[instr]['name']] += 1 425 | 426 | data_bytes = 0 427 | if WINBOND_INSTRUCTIONS[instr]['expects_data']: 428 | instr_size = WINBOND_INSTRUCTIONS[instr]['size'] 429 | data_bytes = count_data_bytes(index + instr_size, data['mosi']) 430 | 431 | last_end_time = end_time 432 | index += WINBOND_INSTRUCTIONS[instr]['size'] + data_bytes 433 | instr_index += 1 434 | 435 | else: # i.e. unknown/invalid instructions 436 | if instr in invalid_instructions: 437 | invalid_instructions[instr] += 1 438 | else: 439 | invalid_instructions[instr] = 0 440 | 441 | index += 1 # we assume an instr_size of 1 and no return data 442 | instr_index += 1 443 | 444 | # Case 2: This CSV export comes from the Quad SPI analyzer at https://github.com/dedicatedcomputing/saleae_qspi 445 | elif 'value' in data: 446 | while index < len(data['value']) - 1: 447 | value = data['value'][index] 448 | next_value = data['value'][index + 1] 449 | 450 | if value in [0x03, 0x0B, 0xEB, 0xE7, 0xE3, 0xEC] and next_value > 0xFF: # normal and Quad IO Read commands 451 | address = next_value 452 | 453 | start_time = data['time'][index] 454 | 455 | type_ = type_at_address_range[address] 456 | 457 | if instr_index > 0: 458 | # set the read size of the previous read access based on the number of non-instruction values 459 | # before and deduct the instruction and address packets 460 | read_accesses[last_start_time]['size'] = index - last_index - 2 461 | # todo: identify dummy cycles 462 | previous_start_time = read_accesses[last_start_time]['start_time'] 463 | previous_last_end_time = read_accesses[last_start_time]['last_end_time'] 464 | 465 | previous_end_time = data['time'][index - 1] 466 | previous_duration = previous_end_time - previous_start_time 467 | previous_latency = previous_start_time - previous_last_end_time 468 | 469 | read_accesses[last_start_time]['end_time'] = previous_end_time 470 | read_accesses[last_start_time]['duration'] = previous_duration 471 | read_accesses[last_start_time]['latency'] = previous_latency 472 | 473 | read_accesses[start_time] = { 474 | 'instr_index': instr_index, 475 | 'start_time': start_time, 476 | 'last_end_time': last_end_time, 477 | 'address': address, 478 | 'type': type_, 479 | 'info': ['QSPI'] if value in [0xEB, 0xE7, 0xE3] else [] 480 | } 481 | 482 | # skip forward 483 | last_start_time = start_time 484 | last_end_time = previous_end_time if instr_index > 0 else 0 485 | last_index = index 486 | index += 2 # one address packet and at least one dummy packet (it seems) 487 | instr_index += 1 488 | else: 489 | index += 1 490 | 491 | # set the read size of the previous read access based on the number of non-instruction values 492 | # before and deduct the instruction and address packets 493 | read_accesses[last_start_time]['size'] = index - last_index - 2 494 | # todo: identify dummy cycles 495 | previous_start_time = read_accesses[last_start_time]['start_time'] 496 | previous_last_end_time = read_accesses[last_start_time]['last_end_time'] 497 | 498 | previous_end_time = data['time'][index - 1] 499 | previous_duration = previous_end_time - previous_start_time 500 | previous_latency = previous_start_time - previous_last_end_time 501 | 502 | read_accesses[last_start_time]['end_time'] = previous_end_time 503 | read_accesses[last_start_time]['duration'] = previous_duration 504 | read_accesses[last_start_time]['latency'] = previous_latency 505 | 506 | return read_accesses 507 | 508 | 509 | """ 510 | Data post-processing functions 511 | """ 512 | 513 | 514 | MAXIMUM_AGGREGATION_COUNT = 8 # todo: this comes from the number of PSPs – parametrize this somehow 515 | TIME_BLOCK_LATENCY_THRESHOLD = 50 # microseconds 516 | 517 | 518 | def aggregate_duplicates(read_accesses): 519 | """ Aggregate read accesses if they have the same address and size. In most cases, this comes from the fact that 520 | a multiprocessor or multicore system has more than one PSP (more precisely: no. of CCX PSPs) accessing the SPI 521 | simultaneously. """ 522 | 523 | aggregated_accesses = read_accesses.copy() 524 | 525 | # Buffer recent addresses and the time of first occurrence 526 | # todo: find out if maxlen is reasonable 527 | recent_addresses = deque([], maxlen=200) 528 | recent_originals = deque([], maxlen=200) 529 | 530 | for time, values in sorted(read_accesses.items()): 531 | address = values['address'] 532 | 533 | if address not in recent_addresses: 534 | aggregated_accesses[time].update({ 535 | 'duplicate_count': 1 536 | }) 537 | 538 | recent_addresses.append(address) 539 | recent_originals.append(time) 540 | 541 | else: # if address in recent_addresses 542 | index = recent_addresses.index(address) 543 | original_access_time = recent_originals[index] 544 | 545 | if aggregated_accesses[original_access_time]['duplicate_count'] < MAXIMUM_AGGREGATION_COUNT: 546 | aggregated_accesses[original_access_time]['duplicate_count'] += 1 547 | else: 548 | del recent_addresses[index] 549 | del recent_originals[index] 550 | 551 | # aggregated_accesses[original_access_time]['size'] += max( 552 | # values['size'], aggregated_accesses[original_access_time]['size'] 553 | # ) 554 | 555 | del aggregated_accesses[time] 556 | 557 | for time, values in aggregated_accesses.items(): 558 | # add a note about its aggregation 559 | # todo: extract this to a display function 560 | aggregated_accesses[time]['info'].append('x%d' % aggregated_accesses[time]['duplicate_count']) 561 | 562 | return aggregated_accesses 563 | 564 | 565 | def collapse_entry_types(read_accesses): 566 | """ Aggregate ("collapse") consecutive read accesses to the same firmware entry (i.e. psptool's type). """ 567 | 568 | # get a sorted list of dicts by key (i.e. start_time) 569 | read_accesses = sorted(read_accesses.items()) 570 | collapsed_read_accesses = [] 571 | 572 | last_access = { 573 | 'type': None, 574 | 'address': None, 575 | 'size': None, 576 | 'duplicate_count': None 577 | } 578 | 579 | for time, values in read_accesses: 580 | if (last_access['address'] is not None 581 | # only collapse accesses of the same type (e.g. PSP_FW_BOOT_LOADER) 582 | and values['type'] == last_access['type'] 583 | # sometimes consecutive reads fetch a few bytes too much, so we also accept "overreads" (thus <=) 584 | and values['address'] <= last_access['address'] + last_access['size']): 585 | 586 | prev_values = collapsed_read_accesses[-1] 587 | collapsed_read_accesses[-1] = { 588 | 'instr_index': prev_values['instr_index'], 589 | 'start_time': prev_values['start_time'], 590 | 'end_time': values['end_time'], 591 | 'duration': prev_values['duration'] + values['duration'], 592 | 'latency': prev_values['latency'], 593 | 'address': prev_values['address'], 594 | 'size': prev_values['size'] + values['size'], 595 | 'type': prev_values['type'], 596 | 'info': prev_values['info'] 597 | } 598 | 599 | if '[c]' not in collapsed_read_accesses[-1]['info']: 600 | collapsed_read_accesses[-1]['info'].append('[c]') 601 | 602 | # we don't require the same multiplicity (e.g. x8) of the collapsed rows, so append a warning if necessary 603 | if (values.get('duplicate_count') != last_access['duplicate_count'] 604 | and '~' not in collapsed_read_accesses[-1]['info']): 605 | 606 | collapsed_read_accesses[-1]['info'].append('~') 607 | 608 | else: 609 | collapsed_read_accesses.append(values) 610 | 611 | last_access = { 612 | 'type': values['type'], 613 | 'address': values['address'], 614 | 'size': values['size'], 615 | 'duplicate_count': values.get('duplicate_count') # this may be missing (=> None) 616 | } 617 | 618 | # convert the list of dicts back to a dict 619 | return {values['start_time']: values for values in collapsed_read_accesses} 620 | 621 | 622 | def do_normalize_timestamps(read_accesses): 623 | normalized_read_accesses = {} 624 | min_time = min((v['start_time'] for v in read_accesses.values())) 625 | 626 | for k, v in read_accesses.items(): 627 | v['start_time'] -= min_time 628 | v['end_time'] -= min_time 629 | normalized_read_accesses[k] = v 630 | 631 | return normalized_read_accesses 632 | 633 | 634 | """ 635 | IO functions 636 | """ 637 | 638 | 639 | def get_overview_read_accesses(read_accesses): 640 | entry_types = Entry.DIRECTORY_ENTRY_TYPES 641 | overview_read_accesses = {} 642 | known_types = {} # dict of (type, is_ccp) and original_access_time 643 | 644 | # step 1: take read_accesses chronologically and reduce them into overview_read_accesses 645 | for start_time, values in sorted(read_accesses.items()): 646 | latency_in_us = values['latency'] // 1000 647 | is_ccp = True if 'CCP' in values['info'] else False 648 | 649 | # reset known types when we are in a new time block 650 | if latency_in_us > TIME_BLOCK_LATENCY_THRESHOLD: 651 | known_types = {} 652 | 653 | if (values['type'], is_ccp) not in known_types: 654 | known_types[(values['type'], is_ccp)] = start_time 655 | 656 | overview_read_accesses[start_time] = { 657 | **values, 658 | 'lowest_access': values['address'], 659 | 'highest_access': values['address'] + values['size'] 660 | } 661 | else: 662 | original_access_time = known_types[(values['type'], is_ccp)] 663 | 664 | lowest_access = overview_read_accesses[original_access_time]['lowest_access'] 665 | overview_read_accesses[original_access_time]['lowest_access'] = min(lowest_access, values['address']) 666 | 667 | highest_access = overview_read_accesses[original_access_time]['highest_access'] 668 | overview_read_accesses[original_access_time]['highest_access'] = max(highest_access, 669 | values['address'] + values['size']) 670 | return overview_read_accesses 671 | 672 | 673 | class PSPTrace: 674 | def __init__(self, csvfile, romfile, limit_rows=None): 675 | self.psptool = PSPTool.from_file(romfile) 676 | 677 | data = get_database(csvfile, self.psptool) 678 | self.read_accesses = data['read_accesses'] 679 | 680 | if limit_rows: 681 | self.read_accesses = {k: v for k, v in sorted(self.read_accesses.items())[:limit_rows]} 682 | 683 | # annotate reads of size 0x40 with 'CCP' (heuristic!) 684 | for k, v in self.read_accesses.items(): 685 | if v['size'] == 0x40: 686 | v['info'].append('CCP') 687 | 688 | def display_overview(self, verbose=False): 689 | entry_types = Entry.DIRECTORY_ENTRY_TYPES 690 | basic_fields = ['No.', 'Lowest access', 'Range', 'Type', 'Info'] 691 | verbose_fields = ['Start [ns]', 'Highest access'] 692 | all_fields = basic_fields + verbose_fields 693 | 694 | t = PrettyTable(all_fields) 695 | overview_read_accesses = get_overview_read_accesses(self.read_accesses) 696 | 697 | for k, v in sorted(overview_read_accesses.items()): 698 | size = v['highest_access'] - v['lowest_access'] 699 | 700 | # Improve output of type # todo: remove code duplicate 701 | if v['type'] is None: 702 | v['type'] = 'Unknown area' 703 | elif v['type'] in entry_types: 704 | v['type'] = entry_types[v['type']] 705 | elif type(v['type']) == int: 706 | v['type'] = hex(v['type']) 707 | 708 | # todo: remove duplicate code here 709 | 710 | # Display significant latencies 711 | latency_in_us = v['latency'] // 1000 712 | 713 | if latency_in_us > TIME_BLOCK_LATENCY_THRESHOLD: 714 | t.add_row([''] * 7) 715 | t.add_row([''] * 3 + ['~ %d µs delay ~' % latency_in_us] + [''] * 3) 716 | t.add_row([''] * 7) 717 | 718 | v['info'] = ' '.join(v['info']) 719 | basic_values = [v['instr_index'], '0x%.6x' % v['lowest_access'], '0x%.6x' % size, v['type'], v['info']] 720 | verbose_values = [v['start_time'], '0x%.6x' % v['highest_access']] 721 | 722 | t.add_row(basic_values + verbose_values) 723 | 724 | fields = basic_fields 725 | 726 | if verbose: 727 | fields += verbose_fields 728 | 729 | print(t.get_string(fields=fields)) 730 | 731 | def display_all(self, no_duplicates=False, collapse=False, normalize_timestamps=False, verbose=False): 732 | read_accesses = self.read_accesses 733 | if no_duplicates: 734 | read_accesses = aggregate_duplicates(read_accesses) 735 | if collapse: 736 | read_accesses = collapse_entry_types(read_accesses) 737 | if normalize_timestamps: 738 | read_accesses = do_normalize_timestamps(read_accesses) 739 | 740 | # display results 741 | basic_fields = ['No.', 'Address', 'Size', 'Type', 'Info'] 742 | verbose_fields = ['Start [ns]', 'End [ns]', 'Duration [ns]', 'Latency [ns]'] 743 | all_fields = basic_fields + verbose_fields 744 | all_keys = ['instr_index', 'address', 'size', 'type', 'info', 'start_time', 'end_time', 'duration', 'latency'] 745 | 746 | t = PrettyTable(all_fields) 747 | t.align['Info'] = 'l' 748 | t.align['Start [ns]'] = 'r' 749 | t.align['End [ns]'] = 'r' 750 | t.align['Duration [ns]'] = 'r' 751 | t.align['Latency [ns]'] = 'r' 752 | 753 | entry_types = Entry.DIRECTORY_ENTRY_TYPES 754 | 755 | for start_time, values in sorted(read_accesses.items()): 756 | # Improve output of type 757 | if values['type'] is None: 758 | values['type'] = 'Unknown area' 759 | elif values['type'] in entry_types: 760 | values['type'] = entry_types[values['type']] 761 | elif type(values['type']) == int: 762 | values['type'] = hex(values['type']) 763 | 764 | values['info'] = ' '.join(values['info']) 765 | latency_in_us = values['latency'] // 1000 766 | 767 | # Display significant latencies 768 | if latency_in_us > TIME_BLOCK_LATENCY_THRESHOLD: 769 | t.add_row([''] * 9) 770 | t.add_row([''] * 3 + ['~ %d µs delay ~' % latency_in_us] + [''] * 5) 771 | t.add_row([''] * 9) 772 | 773 | values['size'] = '0x%.2x' % values['size'] 774 | values['address'] = '0x%.6x' % values['address'] 775 | 776 | t.add_row([values.get(key) for key in all_keys]) 777 | 778 | # See which fields are actually demanded (depending on -v) 779 | fields = basic_fields 780 | 781 | if verbose: 782 | fields += verbose_fields 783 | 784 | print(t.get_string(fields=fields)) 785 | 786 | 787 | def main(): 788 | # Ignore SIG_PIPE and don't throw exceptions on it 789 | # http://docs.python.org/library/signal.html 790 | signal(SIGPIPE, SIG_DFL) 791 | 792 | parser = ObligingArgumentParser(description='Read in an SPI capture created by a Saleae Logic Analyzer and a ROM ' 793 | 'file resembling the flash contents and display an access chronology. ' 794 | 'On first load, psptrace needs to parse a lot of raw data which will ' 795 | 'be saved on disk. All other loads will then be much faster.') 796 | parser.add_argument('csvfile', help='CSV file of SPI capture', nargs='?') 797 | parser.add_argument('romfile', help='ROM file of SPI contents', nargs='?') 798 | parser.add_argument('-o', '--overview-mode', help='aggregate accesses to the same firmware entry', 799 | action='store_true') 800 | parser.add_argument('-n', '--no-duplicates', help='hide duplicate accesses (e.g. caused by multiple PSPs)', 801 | action='store_true') 802 | parser.add_argument('-c', '--collapse', help='collapse consecutive reads to the same PSP entry type (denoted by ' 803 | '[c] and sometimes by ~ if collapsing was fuzzy)', 804 | action='store_true') 805 | parser.add_argument('-t', '--normalize-timestamps', help='normalize all timestamps', action='store_true') 806 | parser.add_argument('-l', '--limit-rows', help='limit the processed rows to a maximum of n', type=int) 807 | parser.add_argument('-v', '--verbose', help='increase output verbosity', action='store_true') 808 | parser.add_argument('-V', '--version', action='store_true') 809 | 810 | args = parser.parse_args() 811 | 812 | if args.version: 813 | print(pkg_resources.get_distribution("psptrace").version) 814 | sys.exit(0) 815 | elif not args.csvfile or not args.romfile: 816 | parser.print_help(sys.stderr) 817 | sys.exit(0) 818 | 819 | psptrace = PSPTrace(args.csvfile, args.romfile, limit_rows=args.limit_rows) 820 | 821 | if args.overview_mode: 822 | psptrace.display_overview(verbose=args.verbose) 823 | else: 824 | psptrace.display_all(no_duplicates=args.no_duplicates, collapse=args.collapse, 825 | normalize_timestamps=args.normalize_timestamps, verbose=args.verbose) 826 | 827 | 828 | if __name__ == '__main__': 829 | main() 830 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = psptrace 3 | version = 0.4 4 | author = Christian Werling 5 | author_email = cwerling@posteo.de 6 | url = https://github.com/PSPReverse/PSPTrace 7 | description = PSPTrace can correlate an SPI capture of an AMD boot procedure to the PSP firmware components 8 | 9 | classifiers= Development Status :: 4 - Beta 10 | Intended Audience :: Science/Research 11 | Topic :: Security 12 | License :: OSI Approved :: GNU General Public License v3 (GPLv3) 13 | Programming Language :: Python :: 3.8 14 | 15 | [options] 16 | packages = psptrace 17 | python_requires = >=3.8 18 | install_requires = psptool>=2.4 19 | prettytable 20 | 21 | [options.entry_points] 22 | console_scripts = psptrace = psptrace.psptrace:main 23 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from setuptools import setup 4 | 5 | with open('README.md') as f: 6 | long_description = f.read() 7 | 8 | setup( 9 | long_description=long_description, 10 | long_description_content_type='text/markdown', 11 | use_scm_version=True, 12 | setup_requires=['setuptools_scm'], 13 | ) 14 | --------------------------------------------------------------------------------