pax_global_header00006660000000000000000000000064147703565150014527gustar00rootroot0000000000000052 comment=39a6e6daaf029fb0a083777679a15ea2c18f72de qbootctl-0.2.2/000077500000000000000000000000001477035651500133575ustar00rootroot00000000000000qbootctl-0.2.2/.clang-format000066400000000000000000000073751477035651500157460ustar00rootroot00000000000000# SPDX-License-Identifier: GPL-2.0 # # clang-format configuration file. Intended for clang-format >= 4. # # For more information, see: # # Documentation/process/clang-format.rst # https://clang.llvm.org/docs/ClangFormat.html # https://clang.llvm.org/docs/ClangFormatStyleOptions.html # # Copied from Linux @ 5.18.0 --- AccessModifierOffset: -4 AlignAfterOpenBracket: Align AlignConsecutiveAssignments: false AlignConsecutiveDeclarations: false AlignConsecutiveMacros: AcrossEmptyLines #AlignEscapedNewlines: Left # Unknown to clang-format-4.0 AlignOperands: true AlignTrailingComments: false AllowAllParametersOfDeclarationOnNextLine: false AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: None AllowShortIfStatementsOnASingleLine: false AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: false BinPackArguments: true BinPackParameters: true BraceWrapping: AfterClass: false AfterControlStatement: false AfterEnum: false AfterFunction: true AfterNamespace: true AfterObjCDeclaration: false AfterStruct: false AfterUnion: false #AfterExternBlock: false # Unknown to clang-format-5.0 BeforeCatch: false BeforeElse: false IndentBraces: false #SplitEmptyFunction: true # Unknown to clang-format-4.0 #SplitEmptyRecord: true # Unknown to clang-format-4.0 #SplitEmptyNamespace: true # Unknown to clang-format-4.0 BreakBeforeBinaryOperators: None BreakBeforeBraces: Custom #BreakBeforeInheritanceComma: false # Unknown to clang-format-4.0 BreakBeforeTernaryOperators: false BreakConstructorInitializersBeforeComma: false #BreakConstructorInitializers: BeforeComma # Unknown to clang-format-4.0 BreakAfterJavaFieldAnnotations: false BreakStringLiterals: false ColumnLimit: 100 CommentPragmas: '^ IWYU pragma:' #CompactNamespaces: false # Unknown to clang-format-4.0 ConstructorInitializerAllOnOneLineOrOnePerLine: false ConstructorInitializerIndentWidth: 8 ContinuationIndentWidth: 8 Cpp11BracedListStyle: false DerivePointerAlignment: false DisableFormat: false ExperimentalAutoDetectBinPacking: false #FixNamespaceComments: false # Unknown to clang-format-4.0 IncludeBlocks: Preserve IncludeCategories: - Regex: '.*' Priority: 1 IncludeIsMainRegex: '(Test)?$' IndentCaseLabels: false #IndentPPDirectives: None # Unknown to clang-format-5.0 IndentWidth: 8 IndentWrappedFunctionNames: false JavaScriptQuotes: Leave JavaScriptWrapImports: true KeepEmptyLinesAtTheStartOfBlocks: false MacroBlockBegin: '' MacroBlockEnd: '' MaxEmptyLinesToKeep: 1 NamespaceIndentation: None #ObjCBinPackProtocolList: Auto # Unknown to clang-format-5.0 ObjCBlockIndentWidth: 8 ObjCSpaceAfterProperty: true ObjCSpaceBeforeProtocolList: true # Taken from git's rules #PenaltyBreakAssignment: 10 # Unknown to clang-format-4.0 PenaltyBreakBeforeFirstCallParameter: 50 PenaltyBreakComment: 10 PenaltyBreakFirstLessLess: 0 PenaltyBreakString: 10 PenaltyExcessCharacter: 30 PenaltyReturnTypeOnItsOwnLine: 60 PointerAlignment: Right ReflowComments: false SortIncludes: true #SortUsingDeclarations: false # Unknown to clang-format-4.0 SpaceAfterCStyleCast: false SpaceAfterTemplateKeyword: true SpaceBeforeAssignmentOperators: true #SpaceBeforeCtorInitializerColon: true # Unknown to clang-format-5.0 #SpaceBeforeInheritanceColon: true # Unknown to clang-format-5.0 SpaceBeforeParens: ControlStatements #SpaceBeforeRangeBasedForLoopColon: true # Unknown to clang-format-5.0 SpaceInEmptyParentheses: false SpacesBeforeTrailingComments: 1 SpacesInAngles: false SpacesInContainerLiterals: false SpacesInCStyleCastParentheses: false SpacesInParentheses: false SpacesInSquareBrackets: false Standard: Cpp11 TabWidth: 8 UseTab: Always ... qbootctl-0.2.2/.gitignore000066400000000000000000000000741477035651500153500ustar00rootroot00000000000000.vscode/ .push.settings.jsonc build/ compile_commands.json qbootctl-0.2.2/LICENSE000066400000000000000000001760071477035651500143770ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.qbootctl-0.2.2/README.md000066400000000000000000000025501477035651500146400ustar00rootroot00000000000000# Qualcomm bootctl HAL for Linux This HAL was pulled from AOSP source code and bastardised to build and run on a musl/glibc system. This may or may not render any hardware you run it on unusable, you have been warned. ## Dependencies * zlib-dev * meson * cmake * linux-headers ## Building qbootctl uses the meson build system ```sh meson build meson compile -C build ``` ## Usage ```text qbootctl: qcom bootctrl HAL port for Linux ------------------------------------------- qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT] dump slot info (default) -h this help text -c get the current slot -b SLOT check if SLOT is marked as bootable -n SLOT check if SLOT is marked as successful -x [SLOT] get the slot suffix for SLOT (default: current) -s SLOT set to active slot to SLOT -m [SLOT] mark a boot as successful (default: current) -u [SLOT] mark SLOT as unbootable (default: current) -i still write the GPT headers even if the UFS bLun can't be changed (default: false) ``` ## Debugging Set `DEBUG` to 1 in `utils.h` to enable debug logging. ## Documentation A more details explanation and a list of devices where qbootctl has been validated can be found [on the postmarketOS wiki](https://wiki.postmarketos.org/wiki/Android_AB_Slots): qbootctl-0.2.2/bootctrl.h000066400000000000000000000100371477035651500153610ustar00rootroot00000000000000/* * Copyright (C) 2016 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ /* * Copyright (C) 2023 Caleb Connolly * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #ifndef __BOOTCTRL_H__ #define __BOOTCTRL_H__ #include struct slot_info { bool active; bool bootable; bool successful; }; struct boot_control_module { /* * (*getCurrentSlot)() returns the value letting the system know * whether the current slot is A or B. The meaning of A and B is * left up to the implementer. It is assumed that if the current slot * is A, then the block devices underlying B can be accessed directly * without any risk of corruption. * The returned value is always guaranteed to be strictly less than the * value returned by getNumberSlots. Slots start at 0 and * finish at getNumberSlots() - 1 * Returns -ENOENT on devices with no slots. */ int (*getCurrentSlot)(); /* * (*markBootSuccessful)() marks the specified slot * as boot successful * * Returns 0 on success, -errno on error. */ int (*markBootSuccessful)(unsigned slot); /* * (*setActiveBootSlot)() marks the slot passed in parameter as * the active boot slot (see getCurrentSlot for an explanation * of the "slot" parameter). This overrides any previous call to * setSlotAsUnbootable. * Returns 0 on success, -errno on error. */ int (*setActiveBootSlot)(unsigned slot, bool ignore_missing_bsg); /* * (*setSlotAsUnbootable)() marks the slot passed in parameter as * an unbootable. This can be used while updating the contents of the slot's * partitions, so that the system will not attempt to boot a known bad set up. * Returns 0 on success, -errno on error. */ int (*setSlotAsUnbootable)(unsigned slot); /* * (*isSlotBootable)() returns if the slot passed in parameter is * bootable. Note that slots can be made unbootable by both the * bootloader and by the OS using setSlotAsUnbootable. * Returns 1 if the slot is bootable, 0 if it's not, and -errno on * error. */ int (*isSlotBootable)(unsigned slot); /* * (*getSuffix)() returns the string suffix used by partitions that * correspond to the slot number passed in parameter. The returned string * is expected to be statically allocated and not need to be freed. * Returns NULL if slot does not match an existing slot. */ const char *(*getSuffix)(unsigned slot); /* * (*isSlotMarkedSucessful)() returns if the slot passed in parameter has * been marked as successful using markBootSuccessful. * Returns 1 if the slot has been marked as successful, 0 if it's * not the case, and -errno on error. */ int (*isSlotMarkedSuccessful)(unsigned slot); /** * Returns the active slot to boot into on the next boot. If * setActiveBootSlot() has been called, the getter function should return * the same slot as the one provided in the last setActiveBootSlot() call. */ unsigned (*getActiveBootSlot)(); }; extern const struct boot_control_module bootctl; #endif // __BOOTCTRL_H__ qbootctl-0.2.2/bootctrl_impl.c000066400000000000000000000461231477035651500164020ustar00rootroot00000000000000/* * Copyright (c) 2016, The Linux Foundation. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /* * Copyright (C) 2021-2023 Caleb Connolly * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include #include #include #include #include #include #include "gpt-utils.h" #include "ufs-bsg.h" #include "utils.h" #include "bootctrl.h" #define BOOTDEV_DIR "/dev/disk/by-partlabel" #define BOOT_IMG_PTN_NAME "boot_" #define LUN_NAME_END_LOC 14 #define BOOT_SLOT_PROP "slot_suffix" #define MAX_CMDLINE_SIZE 4096 #define SLOT_ACTIVE 1 #define SLOT_INACTIVE 2 #define UPDATE_SLOT(pentry, guid, slot_state) \ ({ \ memcpy(pentry, guid, TYPE_GUID_SIZE); \ if (slot_state == SLOT_ACTIVE) \ *(pentry + AB_FLAG_OFFSET) = AB_SLOT_ACTIVE_VAL; \ else if (slot_state == SLOT_INACTIVE) \ *(pentry + AB_FLAG_OFFSET) = \ (*(pentry + AB_FLAG_OFFSET) & ~AB_PARTITION_ATTR_SLOT_ACTIVE); \ }) const char *slot_suffix_arr[] = { AB_SLOT_A_SUFFIX, AB_SLOT_B_SUFFIX, NULL }; enum part_attr_type { ATTR_SLOT_ACTIVE = 0, ATTR_BOOT_SUCCESSFUL, ATTR_UNBOOTABLE, ATTR_BOOTABLE, }; void get_kernel_cmdline_arg(const char *arg, char *buf, const char *def) { int fd; char pcmd[MAX_CMDLINE_SIZE]; char *val, *found, *ptr = buf; fd = open("/proc/cmdline", O_RDONLY); int rc = read(fd, pcmd, MAX_CMDLINE_SIZE); if (rc < 0) { fprintf(stderr, "Couldn't open /proc/cmdline: %d (%s)\n", rc, strerror(errno)); goto error; } close(fd); found = strstr(pcmd, arg); if (!found || !(val = strstr(found, "="))) { fprintf(stderr, "Couldn't find cmdline arg: '%s'\n", arg); goto error; } val++; // no this doesn't handle quotes lol while (*val != ' ') { *ptr++ = *val++; } return; error: strcpy(buf, def); } // Get the value of one of the attribute fields for a partition. static int get_partition_attribute(struct gpt_disk *disk, const char *partname, enum part_attr_type part_attr) { uint8_t *pentry = NULL; int retval = -1; uint8_t *attr = NULL; if (!partname) return -1; // Will initialise the disk if null, or reinitialise it if // it's for a partition on a different disk if (gpt_disk_get_disk_info(partname, disk) < 0) { fprintf(stderr, "%s: gpt_disk_get_disk_info failed\n", __func__); return -1; } pentry = gpt_disk_get_pentry(disk, partname, PRIMARY_GPT); if (!pentry) { fprintf(stderr, "%s: pentry does not exist in disk struct\n", __func__); return -1; } attr = pentry + AB_FLAG_OFFSET; LOGD("%s() partname = %s, attr = 0x%x\n", __func__, partname, *attr); switch (part_attr) { case ATTR_SLOT_ACTIVE: retval = !!(*attr & AB_PARTITION_ATTR_SLOT_ACTIVE); LOGD("ATTR_SLOT_ACTIVE, retval = %d\n", retval); break; case ATTR_BOOT_SUCCESSFUL: retval = !!(*attr & AB_PARTITION_ATTR_BOOT_SUCCESSFUL); LOGD("AB_PARTITION_ATTR_BOOT_SUCCESSFUL, retval = %d\n", retval); break; case ATTR_UNBOOTABLE: retval = !!(*attr & AB_PARTITION_ATTR_UNBOOTABLE); LOGD("AB_PARTITION_ATTR_UNBOOTABLE, retval = %d\n", retval); break; default: retval = -1; } return retval; } // Set a particular attribute for all the partitions in a // slot static int update_slot_attribute(struct gpt_disk *disk, unsigned slot, enum part_attr_type ab_attr) { unsigned int i = 0; char buf[GPT_PTN_PATH_MAX]; struct stat st; uint8_t *pentry = NULL; uint8_t *pentry_bak = NULL; int rc = -1; uint8_t *attr = NULL; uint8_t *attr_bak = NULL; const char *partName; char devpath[GPT_PTN_PATH_MAX] = { 0 }; for (i = 0; i < ARRAY_SIZE(g_all_ptns); i++) { memset(buf, '\0', sizeof(buf)); // Check if A/B versions of this ptn exist rc = snprintf(buf, sizeof(buf) - 1, "%s/%.72s", BOOT_DEV_DIR, g_all_ptns[i]); if (stat(buf, &st) < 0) { // partition does not have _a version continue; } buf[strlen(buf) - 1] = 'b'; if (stat(buf, &st) < 0) { // partition does not have _b version continue; } if (slot == 0) partName = g_all_ptns[i]; else partName = buf + strlen(BOOT_DEV_DIR) + 1; LOGD("%s: partName = '%s'\n", __func__, partName); // If the current partition is for a different disk (e.g. /dev/sde when the current disk is /dev/sda) // Then commit the current disk if (!partition_is_for_disk(disk, partName, devpath, sizeof(devpath))) { if (gpt_disk_commit(disk)) { fprintf(stderr, "%s: Failed to commit disk\n", __func__); return -1; } } rc = gpt_disk_get_disk_info(partName, disk); if (rc != 0) { fprintf(stderr, "%s: Failed to get disk info for %s\n", __func__, partName); return -1; } pentry = gpt_disk_get_pentry(disk, partName, PRIMARY_GPT); pentry_bak = gpt_disk_get_pentry(disk, partName, SECONDARY_GPT); if (!pentry || !pentry_bak) { fprintf(stderr, "%s: Failed to get pentry/pentry_bak for %s\n", __func__, partName); return -1; } attr = pentry + AB_FLAG_OFFSET; // LOGD("%s: got pentry for part '%s': 0x%lx (at flags: 0x%x)\n", __func__, partName, // *(uint64_t *)pentry, *attr); attr_bak = pentry_bak + AB_FLAG_OFFSET; switch (ab_attr) { case ATTR_BOOT_SUCCESSFUL: *attr = (*attr) | AB_PARTITION_ATTR_BOOT_SUCCESSFUL; *attr_bak = (*attr_bak) | AB_PARTITION_ATTR_BOOT_SUCCESSFUL; break; case ATTR_UNBOOTABLE: *attr = (*attr) | AB_PARTITION_ATTR_UNBOOTABLE; *attr_bak = (*attr_bak) | AB_PARTITION_ATTR_UNBOOTABLE; break; case ATTR_BOOTABLE: *attr = (*attr) ^ AB_PARTITION_ATTR_UNBOOTABLE; *attr_bak = (*attr_bak) ^ AB_PARTITION_ATTR_UNBOOTABLE; break; case ATTR_SLOT_ACTIVE: *attr = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; *attr_bak = (*attr) | AB_PARTITION_ATTR_SLOT_ACTIVE; break; default: fprintf(stderr, "%s: Unrecognized attr\n", __func__); return -1; } } if (gpt_disk_commit(disk)) { fprintf(stderr, "%s: Failed to commit disk %s\n", __func__, disk->devpath); return -1; } return 0; } /* * Returns 0 for no slots, or the number of slots found. * Fun semantic note: Having "1" slot (ie just a "boot" partition) * is the same as having "no slots". * * This function will never return 1. */ unsigned get_number_slots() { struct dirent *de = NULL; DIR *dir_bootdev = NULL; static int slot_count = 0; // If we've already counted the slots, return the cached value. // If there are no slots then we'll always rerun the search... if (slot_count > 0) return slot_count; assert(AB_SLOT_A_SUFFIX[0] == '_'); assert(AB_SLOT_B_SUFFIX[0] == '_'); dir_bootdev = opendir(BOOTDEV_DIR); // Shouldn't this be an assert? if (!dir_bootdev) { fprintf(stderr, "%s: Failed to open bootdev dir (%s)\n", __func__, strerror(errno)); return 0; } while ((de = readdir(dir_bootdev))) { if (de->d_name[0] == '.') continue; if (!strncmp(de->d_name, BOOT_IMG_PTN_NAME, strlen(BOOT_IMG_PTN_NAME)) && !!strncmp(de->d_name, "boot_aging\n", strlen("boot_aging"))) { slot_count++; } } if (slot_count < 0) slot_count = 0; closedir(dir_bootdev); return slot_count; } static int boot_control_check_slot_sanity(unsigned slot) { uint32_t num_slots = get_number_slots(); if ((num_slots < 1) || (slot > num_slots - 1)) { fprintf(stderr, "Invalid slot number %u\n", slot); return -1; } return 0; } int get_boot_attr(struct gpt_disk *disk, unsigned slot, enum part_attr_type attr) { char bootPartition[MAX_GPT_NAME_SIZE + 1] = { 0 }; if (boot_control_check_slot_sanity(slot) != 0) { fprintf(stderr, "%s: Argument check failed\n", __func__); return -1; } snprintf(bootPartition, sizeof(bootPartition) - 1, "boot%s", slot_suffix_arr[slot]); return get_partition_attribute(disk, bootPartition, attr); } unsigned get_active_boot_slot() { struct gpt_disk disk = { 0 }; uint32_t num_slots = get_number_slots(); if (num_slots <= 1) { // Slot 0 is the only slot around. return 0; } for (uint32_t i = 0; i < num_slots; i++) { if (get_boot_attr(&disk, i, ATTR_SLOT_ACTIVE)) { gpt_disk_free(&disk); return i; } } fprintf(stderr, "%s: Failed to find the active boot slot\n", __func__); gpt_disk_free(&disk); return 0; } /* * The current slot is usually made available via the kernel cmdline. If it isn't for some reason * (e.g. because we booted via a secondary bootloader that removes Android cmdline args) then we * assume that the active slot is the current slot */ static int get_current_or_active_slot() { uint32_t num_slots = 0; char bootSlotProp[MAX_CMDLINE_SIZE] = { '\0' }; unsigned i = 0; num_slots = get_number_slots(); if (num_slots == 0) return -ENOENT; if (num_slots == 1) { // Slot 0 is the only slot around. return 0; } get_kernel_cmdline_arg(BOOT_SLOT_PROP, bootSlotProp, "N/A"); if (!strncmp(bootSlotProp, "N/A\n", strlen("N/A"))) { fprintf(stderr, "%s: Unable to read boot slot property\n", __func__); return get_active_boot_slot(); } // Iterate through a list of partitons named as boot+suffix // and see which one is currently active. for (i = 0; slot_suffix_arr[i] != NULL; i++) { if (!strncmp(bootSlotProp, slot_suffix_arr[i], strlen(slot_suffix_arr[i]))) { // printf("%s current_slot = %d\n", __func__, i); return i; } } // The HAL spec requires that we return a number between // 0 to num_slots - 1. Since something went wrong here we // are just going to return the default slot. return 0; } int is_slot_bootable(unsigned slot) { int attr = 0; struct gpt_disk disk = { 0 }; attr = get_boot_attr(&disk, slot, ATTR_UNBOOTABLE); if (attr >= 0) return !attr; return -1; } int mark_boot_successful(unsigned slot) { struct gpt_disk disk = { 0 }; int successful = get_boot_attr(&disk, slot, ATTR_BOOT_SUCCESSFUL); int unbootable = get_boot_attr(&disk, slot, ATTR_UNBOOTABLE); int ret = 0; if (successful < 0 || unbootable < 0) { fprintf(stderr, "SLOT %s: Failed to read attributes\n", slot_suffix_arr[slot]); ret = -1; goto out; } if (unbootable) { printf("SLOT %s: was marked unbootable, fixing this" " (I hope you know what you're doing...)\n", slot_suffix_arr[slot]); update_slot_attribute(&disk, slot, ATTR_BOOTABLE); } if (successful) { fprintf(stderr, "SLOT %s: already marked successful\n", slot_suffix_arr[slot]); goto out; } if (update_slot_attribute(&disk, slot, ATTR_BOOT_SUCCESSFUL)) { fprintf(stderr, "SLOT %s: Failed to mark boot successful\n", slot_suffix_arr[slot]); ret = -1; goto out; } out: gpt_disk_free(&disk); return ret; } const char *get_suffix(unsigned slot) { if (boot_control_check_slot_sanity(slot) != 0) return ""; else return slot_suffix_arr[slot]; } // The argument here is a vector of partition names(including the slot suffix) // that lie on a single disk static int boot_ctl_set_active_slot_for_partitions(struct gpt_disk *disk, unsigned slot) { char buf[GPT_PTN_PATH_MAX] = { 0 }; const char *slotA; char slotB[MAX_GPT_NAME_SIZE] = { 0 }; char active_guid[TYPE_GUID_SIZE + 1] = { 0 }; char inactive_guid[TYPE_GUID_SIZE + 1] = { 0 }; int rc, i; // Pointer to the partition entry of current 'A' partition uint8_t *pentryA = NULL; uint8_t *pentryA_bak = NULL; // Pointer to partition entry of current 'B' partition uint8_t *pentryB = NULL; uint8_t *pentryB_bak = NULL; struct stat st; LOGD("Marking slot %s as active:\n", slot_suffix_arr[slot]); for (i = 0, slotA = g_all_ptns[0]; i < ARRAY_SIZE(g_all_ptns); slotA = g_all_ptns[++i]) { // Chop off the slot suffix from the partition name to // make the string easier to work with. LOGD("Part: %s\n", slotA); int n = strlen(slotA) - strlen(AB_SLOT_A_SUFFIX); if (n + 1 < 3 || n + 1 > MAX_GPT_NAME_SIZE) { fprintf(stderr, "Invalid partition name: %s\n", slotA); return -1; } memset(slotB, 0, sizeof(slotB)); strncat(slotB, slotA, MAX_GPT_NAME_SIZE - 1); slotB[strlen(slotB) - 1] = 'b'; rc = snprintf(buf, sizeof(buf) - 1, "%s", BOOT_DEV_DIR); snprintf(buf + rc, GPT_PTN_PATH_MAX - rc, "/%s", slotA); LOGD("Checking for partition %s\n", buf); if (stat(buf, &st)) { if (!strcmp(slotA, "boot_a") || !strcmp(slotA, "dtbo_a")) { fprintf(stderr, "Couldn't find required partition %s\n", slotA); return -1; } // Not every device has every partition continue; } buf[strlen(buf) - 1] = 'b'; if (stat(buf, &st)) { fprintf(stderr, "Partition %s does not exist\n", buf); return -1; } // Get the disk containing this partition. This only // actually re-initialises disk if this partition refers // to a different block device than the last one. if (gpt_disk_get_disk_info(slotA, disk) < 0) return -1; // Get partition entry for slot A & B from the primary // and backup tables. pentryA = gpt_disk_get_pentry(disk, slotA, PRIMARY_GPT); pentryA_bak = gpt_disk_get_pentry(disk, slotA, SECONDARY_GPT); pentryB = gpt_disk_get_pentry(disk, slotB, PRIMARY_GPT); pentryB_bak = gpt_disk_get_pentry(disk, slotB, SECONDARY_GPT); if (!pentryA || !pentryA_bak || !pentryB || !pentryB_bak) { // None of these should be NULL since we have already // checked for A & B versions earlier. fprintf(stderr, "Slot pentries for %s not found.\n", slotA); return -1; } LOGD("\tAB attr (A): 0x%x (backup: 0x%x)\n", *(uint16_t *)(pentryA + AB_FLAG_OFFSET), *(uint16_t *)(pentryA_bak + AB_FLAG_OFFSET)); LOGD("\tAB attr (B): 0x%x (backup: 0x%x)\n", *(uint16_t *)(pentryB + AB_FLAG_OFFSET), *(uint16_t *)(pentryB_bak + AB_FLAG_OFFSET)); memset(active_guid, '\0', sizeof(active_guid)); memset(inactive_guid, '\0', sizeof(inactive_guid)); if (get_partition_attribute(disk, slotA, ATTR_SLOT_ACTIVE) == 1) { // A is the current active slot memcpy((void *)active_guid, (const void *)pentryA, TYPE_GUID_SIZE); memcpy((void *)inactive_guid, (const void *)pentryB, TYPE_GUID_SIZE); } else if (get_partition_attribute(disk, slotB, ATTR_SLOT_ACTIVE) == 1) { // B is the current active slot memcpy((void *)active_guid, (const void *)pentryB, TYPE_GUID_SIZE); memcpy((void *)inactive_guid, (const void *)pentryA, TYPE_GUID_SIZE); } else { fprintf(stderr, "Both A & B are inactive..Aborting"); return -1; } int a_state = slot == 0 ? SLOT_ACTIVE : SLOT_INACTIVE; int b_state = slot == 1 ? SLOT_ACTIVE : SLOT_INACTIVE; // This check *Really* shouldn't be here... But I don't know this codebase // well enough to remove it. if (slot > 1) { fprintf(stderr, "%s: Unknown slot %d!\n", __func__, slot); return -1; } // Mark A as active in primary table UPDATE_SLOT(pentryA, active_guid, a_state); // Mark A as active in backup table UPDATE_SLOT(pentryA_bak, active_guid, a_state); // Mark B as inactive in primary table UPDATE_SLOT(pentryB, inactive_guid, b_state); // Mark B as inactive in backup table UPDATE_SLOT(pentryB_bak, inactive_guid, b_state); } // write updated content to disk if (gpt_disk_commit(disk)) { fprintf(stderr, "Failed to commit disk entry"); return -1; } return 0; } int set_active_boot_slot(unsigned slot, bool ignore_missing_bsg) { enum boot_chain chain = (enum boot_chain)slot; struct gpt_disk disk = { 0 }; int rc; bool ismmc; if (boot_control_check_slot_sanity(slot)) { fprintf(stderr, "%s: Bad arguments\n", __func__); return -1; } ismmc = gpt_utils_is_partition_backed_by_emmc(PTN_XBL AB_SLOT_A_SUFFIX); // Do this *before* updating all the slot attributes // to make sure we can if (!ismmc && !ignore_missing_bsg && ufs_bsg_dev_open() < 0) { return -1; } rc = boot_ctl_set_active_slot_for_partitions(&disk, slot); if (rc) { fprintf(stderr, "%s: Failed to set active slot for partitions \n", __func__); goto out; } // EMMC doesn't need attributes to be set. if (ismmc) goto out; if (chain > BACKUP_BOOT) { fprintf(stderr, "%s: Unknown slot %d!\n", __func__, slot); rc = -1; goto out; } rc = gpt_utils_set_xbl_boot_partition(chain); if (rc) { if (ignore_missing_bsg && rc == -ENODEV) rc = 0; else fprintf(stderr, "%s: Failed to switch xbl boot partition\n", __func__); } out: gpt_disk_free(&disk); return rc; } int set_slot_as_unbootable(unsigned slot) { struct gpt_disk disk = { 0 }; int ret; if (boot_control_check_slot_sanity(slot) != 0) return -1; ret = update_slot_attribute(&disk, slot, ATTR_UNBOOTABLE); gpt_disk_free(&disk); return ret; } int is_slot_marked_successful(unsigned slot) { int ret; struct gpt_disk disk = { 0 }; if (boot_control_check_slot_sanity(slot) != 0) return -1; ret = get_boot_attr(&disk, slot, ATTR_BOOT_SUCCESSFUL); gpt_disk_free(&disk); return ret; } const struct boot_control_module bootctl = { .getCurrentSlot = get_current_or_active_slot, .markBootSuccessful = mark_boot_successful, .setActiveBootSlot = set_active_boot_slot, .setSlotAsUnbootable = set_slot_as_unbootable, .isSlotBootable = is_slot_bootable, .getSuffix = get_suffix, .isSlotMarkedSuccessful = is_slot_marked_successful, .getActiveBootSlot = get_active_boot_slot, }; qbootctl-0.2.2/crc32.c000066400000000000000000000200231477035651500144340ustar00rootroot00000000000000/* * Dec 5, 2000 Matt Domsch * - Copied crc32.c from the linux/drivers/net/cipe directory. * - Now pass seed as an arg * - changed len to be an unsigned long * - changed crc32val to be a register * - License remains unchanged! It's still GPL-compatable! */ /* GPL-2 License This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* * Copied from efibootmgr 2023-06-23 */ /* ============================================================= */ /* COPYRIGHT (C) 1986 Gary S. Brown. You may use this program, or */ /* code or tables extracted from it, as desired without restriction. */ /* */ /* First, the polynomial itself and its table of feedback terms. The */ /* polynomial is */ /* X^32+X^26+X^23+X^22+X^16+X^12+X^11+X^10+X^8+X^7+X^5+X^4+X^2+X^1+X^0 */ /* */ /* Note that we take it "backwards" and put the highest-order term in */ /* the lowest-order bit. The X^32 term is "implied"; the LSB is the */ /* X^31 term, etc. The X^0 term (usually shown as "+1") results in */ /* the MSB being 1. */ /* */ /* Note that the usual hardware shift register implementation, which */ /* is what we're using (we're merely optimizing it by doing eight-bit */ /* chunks at a time) shifts bits into the lowest-order term. In our */ /* implementation, that means shifting towards the right. Why do we */ /* do it this way? Because the calculated CRC must be transmitted in */ /* order from highest-order term to lowest-order term. UARTs transmit */ /* characters in order from LSB to MSB. By storing the CRC this way, */ /* we hand it to the UART in the order low-byte to high-byte; the UART */ /* sends each low-bit to hight-bit; and the result is transmission bit */ /* by bit from highest- to lowest-order term without requiring any bit */ /* shuffling on our part. Reception works similarly. */ /* */ /* The feedback terms table consists of 256, 32-bit entries. Notes: */ /* */ /* The table can be generated at runtime if desired; code to do so */ /* is shown later. It might not be obvious, but the feedback */ /* terms simply represent the results of eight shift/xor opera- */ /* tions for all combinations of data and CRC register values. */ /* */ /* The values must be right-shifted by eight bits by the "updcrc" */ /* logic; the shift must be unsigned (bring in zeroes). On some */ /* hardware you could probably optimize the shift in assembler by */ /* using byte-swap instructions. */ /* polynomial $edb88320 */ /* */ /* -------------------------------------------------------------------- */ #include static uint32_t crc32_tab[] = { 0x00000000L, 0x77073096L, 0xee0e612cL, 0x990951baL, 0x076dc419L, 0x706af48fL, 0xe963a535L, 0x9e6495a3L, 0x0edb8832L, 0x79dcb8a4L, 0xe0d5e91eL, 0x97d2d988L, 0x09b64c2bL, 0x7eb17cbdL, 0xe7b82d07L, 0x90bf1d91L, 0x1db71064L, 0x6ab020f2L, 0xf3b97148L, 0x84be41deL, 0x1adad47dL, 0x6ddde4ebL, 0xf4d4b551L, 0x83d385c7L, 0x136c9856L, 0x646ba8c0L, 0xfd62f97aL, 0x8a65c9ecL, 0x14015c4fL, 0x63066cd9L, 0xfa0f3d63L, 0x8d080df5L, 0x3b6e20c8L, 0x4c69105eL, 0xd56041e4L, 0xa2677172L, 0x3c03e4d1L, 0x4b04d447L, 0xd20d85fdL, 0xa50ab56bL, 0x35b5a8faL, 0x42b2986cL, 0xdbbbc9d6L, 0xacbcf940L, 0x32d86ce3L, 0x45df5c75L, 0xdcd60dcfL, 0xabd13d59L, 0x26d930acL, 0x51de003aL, 0xc8d75180L, 0xbfd06116L, 0x21b4f4b5L, 0x56b3c423L, 0xcfba9599L, 0xb8bda50fL, 0x2802b89eL, 0x5f058808L, 0xc60cd9b2L, 0xb10be924L, 0x2f6f7c87L, 0x58684c11L, 0xc1611dabL, 0xb6662d3dL, 0x76dc4190L, 0x01db7106L, 0x98d220bcL, 0xefd5102aL, 0x71b18589L, 0x06b6b51fL, 0x9fbfe4a5L, 0xe8b8d433L, 0x7807c9a2L, 0x0f00f934L, 0x9609a88eL, 0xe10e9818L, 0x7f6a0dbbL, 0x086d3d2dL, 0x91646c97L, 0xe6635c01L, 0x6b6b51f4L, 0x1c6c6162L, 0x856530d8L, 0xf262004eL, 0x6c0695edL, 0x1b01a57bL, 0x8208f4c1L, 0xf50fc457L, 0x65b0d9c6L, 0x12b7e950L, 0x8bbeb8eaL, 0xfcb9887cL, 0x62dd1ddfL, 0x15da2d49L, 0x8cd37cf3L, 0xfbd44c65L, 0x4db26158L, 0x3ab551ceL, 0xa3bc0074L, 0xd4bb30e2L, 0x4adfa541L, 0x3dd895d7L, 0xa4d1c46dL, 0xd3d6f4fbL, 0x4369e96aL, 0x346ed9fcL, 0xad678846L, 0xda60b8d0L, 0x44042d73L, 0x33031de5L, 0xaa0a4c5fL, 0xdd0d7cc9L, 0x5005713cL, 0x270241aaL, 0xbe0b1010L, 0xc90c2086L, 0x5768b525L, 0x206f85b3L, 0xb966d409L, 0xce61e49fL, 0x5edef90eL, 0x29d9c998L, 0xb0d09822L, 0xc7d7a8b4L, 0x59b33d17L, 0x2eb40d81L, 0xb7bd5c3bL, 0xc0ba6cadL, 0xedb88320L, 0x9abfb3b6L, 0x03b6e20cL, 0x74b1d29aL, 0xead54739L, 0x9dd277afL, 0x04db2615L, 0x73dc1683L, 0xe3630b12L, 0x94643b84L, 0x0d6d6a3eL, 0x7a6a5aa8L, 0xe40ecf0bL, 0x9309ff9dL, 0x0a00ae27L, 0x7d079eb1L, 0xf00f9344L, 0x8708a3d2L, 0x1e01f268L, 0x6906c2feL, 0xf762575dL, 0x806567cbL, 0x196c3671L, 0x6e6b06e7L, 0xfed41b76L, 0x89d32be0L, 0x10da7a5aL, 0x67dd4accL, 0xf9b9df6fL, 0x8ebeeff9L, 0x17b7be43L, 0x60b08ed5L, 0xd6d6a3e8L, 0xa1d1937eL, 0x38d8c2c4L, 0x4fdff252L, 0xd1bb67f1L, 0xa6bc5767L, 0x3fb506ddL, 0x48b2364bL, 0xd80d2bdaL, 0xaf0a1b4cL, 0x36034af6L, 0x41047a60L, 0xdf60efc3L, 0xa867df55L, 0x316e8eefL, 0x4669be79L, 0xcb61b38cL, 0xbc66831aL, 0x256fd2a0L, 0x5268e236L, 0xcc0c7795L, 0xbb0b4703L, 0x220216b9L, 0x5505262fL, 0xc5ba3bbeL, 0xb2bd0b28L, 0x2bb45a92L, 0x5cb36a04L, 0xc2d7ffa7L, 0xb5d0cf31L, 0x2cd99e8bL, 0x5bdeae1dL, 0x9b64c2b0L, 0xec63f226L, 0x756aa39cL, 0x026d930aL, 0x9c0906a9L, 0xeb0e363fL, 0x72076785L, 0x05005713L, 0x95bf4a82L, 0xe2b87a14L, 0x7bb12baeL, 0x0cb61b38L, 0x92d28e9bL, 0xe5d5be0dL, 0x7cdcefb7L, 0x0bdbdf21L, 0x86d3d2d4L, 0xf1d4e242L, 0x68ddb3f8L, 0x1fda836eL, 0x81be16cdL, 0xf6b9265bL, 0x6fb077e1L, 0x18b74777L, 0x88085ae6L, 0xff0f6a70L, 0x66063bcaL, 0x11010b5cL, 0x8f659effL, 0xf862ae69L, 0x616bffd3L, 0x166ccf45L, 0xa00ae278L, 0xd70dd2eeL, 0x4e048354L, 0x3903b3c2L, 0xa7672661L, 0xd06016f7L, 0x4969474dL, 0x3e6e77dbL, 0xaed16a4aL, 0xd9d65adcL, 0x40df0b66L, 0x37d83bf0L, 0xa9bcae53L, 0xdebb9ec5L, 0x47b2cf7fL, 0x30b5ffe9L, 0xbdbdf21cL, 0xcabac28aL, 0x53b39330L, 0x24b4a3a6L, 0xbad03605L, 0xcdd70693L, 0x54de5729L, 0x23d967bfL, 0xb3667a2eL, 0xc4614ab8L, 0x5d681b02L, 0x2a6f2b94L, 0xb40bbe37L, 0xc30c8ea1L, 0x5a05df1bL, 0x2d02ef8dL }; /* Return a 32-bit CRC of the contents of the buffer. */ uint32_t efi_crc32(const void *buf, unsigned long len) { unsigned long i; register uint32_t crc32val; const unsigned char *s = buf; crc32val = ~0U; for (i = 0; i < len; i ++) { crc32val = crc32_tab[(crc32val ^ s[i]) & 0xff] ^ (crc32val >> 8); } return crc32val ^ ~0U; }qbootctl-0.2.2/crc32.h000066400000000000000000000022451477035651500144470ustar00rootroot00000000000000/* libparted - a library for manipulating disk partitions Copyright (C) 1998-2000 Free Software Foundation, Inc. crc32.h GPL-2 License This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ /* * Copied from efibootmgr 2023-06-23 */ #ifndef _CRC32_H #define _CRC32_H #include /* * This computes a 32 bit CRC of the data in the buffer, and returns the CRC. * The polynomial used is 0xedb88320. */ extern uint32_t efi_crc32 (const void *buf, unsigned long len); #endif /* _CRC32_H */ qbootctl-0.2.2/gpt-utils.c000066400000000000000000000614601477035651500154620ustar00rootroot00000000000000/* * Copyright (c) 2013, The Linux Foundation. All rights reserved. * Copyright (C) 2021-2022 Caleb Connolly * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #define _LARGEFILE64_SOURCE /* enable lseek64() */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "gpt-utils.h" #include "utils.h" #include "crc32.h" /* list the names of the backed-up partitions to be swapped */ /* extension used for the backup partitions - tzbak, abootbak, etc. */ #define BAK_PTN_NAME_EXT "bak" #define XBL_PRIMARY "/dev/disk/by-partlabel/xbl_a" // FIXME #define XBL_BACKUP "/dev/disk/by-partlabel/xblbak" #define XBL_AB_PRIMARY "/dev/disk/by-partlabel/xbl_a" #define XBL_AB_SECONDARY "/dev/disk/by-partlabel/xbl_b" /* GPT defines */ #define MAX_LUNS 26 // Size of the buffer that needs to be passed to the UFS ioctl #define UFS_ATTR_DATA_SIZE 32 // This will allow us to get the root lun path from the path to the partition. // i.e: from /dev/disk/sdaXXX get /dev/disk/sda. The assumption here is that // the boot critical luns lie between sda to sdz which is acceptable because // only user added external disks,etc would lie beyond that limit which do not // contain partitions that interest us here. #define PATH_TRUNCATE_LOC (sizeof("/dev/sda") - 1) // From /dev/disk/sda get just sda #define LUN_NAME_START_LOC (sizeof("/dev/") - 1) #define BOOT_LUN_A_ID 1 #define BOOT_LUN_B_ID 2 #define GET_4_BYTES(ptr) \ ((uint32_t) * ((uint8_t *)(ptr)) | ((uint32_t) * ((uint8_t *)(ptr) + 1) << 8) | \ ((uint32_t) * ((uint8_t *)(ptr) + 2) << 16) | ((uint32_t) * ((uint8_t *)(ptr) + 3) << 24)) #define GET_8_BYTES(ptr) \ ((uint64_t) * ((uint8_t *)(ptr)) | ((uint64_t) * ((uint8_t *)(ptr) + 1) << 8) | \ ((uint64_t) * ((uint8_t *)(ptr) + 2) << 16) | \ ((uint64_t) * ((uint8_t *)(ptr) + 3) << 24) | \ ((uint64_t) * ((uint8_t *)(ptr) + 4) << 32) | \ ((uint64_t) * ((uint8_t *)(ptr) + 5) << 40) | \ ((uint64_t) * ((uint8_t *)(ptr) + 6) << 48) | ((uint64_t) * ((uint8_t *)(ptr) + 7) << 56)) #define PUT_4_BYTES(ptr, y) \ *((uint8_t *)(ptr)) = (y)&0xff; \ *((uint8_t *)(ptr) + 1) = ((y) >> 8) & 0xff; \ *((uint8_t *)(ptr) + 2) = ((y) >> 16) & 0xff; \ *((uint8_t *)(ptr) + 3) = ((y) >> 24) & 0xff; enum gpt_state { GPT_OK = 0, GPT_BAD_SIGNATURE, GPT_BAD_CRC }; // List of LUN's containing boot critical images. // Required in the case of UFS devices struct update_data { char lun_list[MAX_LUNS][GPT_PTN_PATH_MAX]; uint32_t num_valid_entries; }; void DumpHex(const void *data, size_t size) { char ascii[17]; size_t i, j; ascii[16] = '\0'; for (i = 0; i < size; ++i) { printf("%02X ", ((unsigned char *)data)[i]); if (((unsigned char *)data)[i] >= ' ' && ((unsigned char *)data)[i] <= '~') { ascii[i % 16] = ((unsigned char *)data)[i]; } else { ascii[i % 16] = '.'; } if ((i + 1) % 8 == 0 || i + 1 == size) { printf(" "); if ((i + 1) % 16 == 0) { printf("| %s \n", ascii); } else if (i + 1 == size) { ascii[(i + 1) % 16] = '\0'; if ((i + 1) % 16 <= 8) { printf(" "); } for (j = (i + 1) % 16; j < 16; ++j) { printf(" "); } printf("| %s \n", ascii); } } } } /** * ========================================================================== * * \brief Read/Write len bytes from/to block dev * * \param [in] fd block dev file descriptor (returned from open) * \param [in] rw RW flag: 0 - read, != 0; - write * \param [in] offset block dev offset [bytes] - RW start position * \param [in] buf Pointer to the buffer containing the data * \param [in] len RW size in bytes. Buf must be at least that big * * \return 0 on success * * ========================================================================== */ static int blk_rw(int fd, int rw, uint64_t offset, uint8_t *buf, unsigned len) { int r; if (lseek64(fd, offset, SEEK_SET) < 0) { fprintf(stderr, "block dev lseek64 %" PRIu64 " failed: %s\n", offset, strerror(errno)); return -1; } if (rw) r = write(fd, buf, len); else r = read(fd, buf, len); if (r < 0) { fprintf(stderr, "block dev %s failed: %s\n", rw ? "write" : "read\n", strerror(errno)); } else { if (rw) { r = fsync(fd); if (r < 0) fprintf(stderr, "fsync failed: %s\n", strerror(errno)); } else { r = 0; } } return r; } /** * ========================================================================== * * \brief Search within GPT for partition entry with the given name * or it's backup twin (name-bak). * * \param [in] ptn_name Partition name to seek * \param [in] pentries_start Partition entries array start pointer * \param [in] pentries_end Partition entries array end pointer * \param [in] pentry_size Single partition entry size [bytes] * * \return First partition entry pointer that matches the name or null * * ========================================================================== */ static uint8_t *gpt_pentry_seek(const char *ptn_name, const uint8_t *pentries_start, const uint8_t *pentries_end, uint32_t pentry_size) { char *pentry_name; unsigned len = strlen(ptn_name); for (pentry_name = (char *)(pentries_start + PARTITION_NAME_OFFSET); pentry_name < (char *)pentries_end; pentry_name += pentry_size) { char name8[MAX_GPT_NAME_SIZE / 2]; unsigned i; /* Partition names in GPT are UTF-16 - ignoring UTF-16 2nd byte */ for (i = 0; i < sizeof(name8); i++) name8[i] = pentry_name[i * 2]; if (!strncmp(ptn_name, name8, len)) if (name8[len] == 0 || !strcmp(&name8[len], BAK_PTN_NAME_EXT)) return (uint8_t *)(pentry_name - PARTITION_NAME_OFFSET); } return NULL; } // Defined in ufs-bsg.cpp int32_t set_boot_lun(uint8_t lun_id); // Switch between using either the primary or the backup // boot LUN for boot. This is required since UFS boot partitions // cannot have a backup GPT which is what we use for failsafe // updates of the other 'critical' partitions. This function will // not be invoked for emmc targets and on UFS targets is only required // to be invoked for XBL. // // The algorithm to do this is as follows: //- Find the real block device(eg: /dev/disk/sdb) that corresponds // to the /dev/disk/bootdevice/by-name/xbl(bak) symlink // //- Once we have the block device 'node' name(sdb in the above example) // use this node to to locate the scsi generic device that represents // it by checking the file /sys/block/sdb/device/scsi_generic/sgY // //- Once we locate sgY we call the query ioctl on /dev/sgy to switch // the boot lun to either LUNA or LUNB int gpt_utils_set_xbl_boot_partition(enum boot_chain chain) { struct stat st; uint8_t boot_lun_id = 0; const char *boot_dev = NULL; int ret = -1; (void)st; (void)boot_dev; if (chain == BACKUP_BOOT) { boot_lun_id = BOOT_LUN_B_ID; if (!stat(XBL_BACKUP, &st)) boot_dev = XBL_BACKUP; else if (!stat(XBL_AB_SECONDARY, &st)) boot_dev = XBL_AB_SECONDARY; else { fprintf(stderr, "%s: Failed to locate secondary xbl\n", __func__); goto error; } } else if (chain == NORMAL_BOOT) { boot_lun_id = BOOT_LUN_A_ID; if (!stat(XBL_PRIMARY, &st)) boot_dev = XBL_PRIMARY; else if (!stat(XBL_AB_PRIMARY, &st)) boot_dev = XBL_AB_PRIMARY; else { fprintf(stderr, "%s: Failed to locate primary xbl\n", __func__); goto error; } } else { fprintf(stderr, "%s: Invalid boot chain id\n", __func__); goto error; } // We need either both xbl and xblbak or both xbl_a and xbl_b to exist at // the same time. If not the current configuration is invalid. if ((stat(XBL_PRIMARY, &st) || stat(XBL_BACKUP, &st)) && (stat(XBL_AB_PRIMARY, &st) || stat(XBL_AB_SECONDARY, &st))) { fprintf(stderr, "%s:primary/secondary XBL prt not found(%s)\n", __func__, strerror(errno)); goto error; } LOGD("%s: setting %s lun as boot lun\n", __func__, boot_dev); if (set_boot_lun(boot_lun_id)) { ret = -ENODEV; goto error; } return 0; error: return ret; } // Given a parttion name(eg: rpm) get the path to the block device that // represents the GPT disk the partition resides on. In the case of emmc it // would be the default emmc dev(/dev/mmcblk0). In the case of UFS we look // through the /dev/disk/bootdevice/by-name/ tree for partname, and resolve // the path to the LUN from there. static int get_dev_path_from_partition_name(const char *partname, char *buf, size_t buflen) { char path[GPT_PTN_PATH_MAX] = { 0 }; int i; if (!partname || !buf || buflen < ((PATH_TRUNCATE_LOC) + 1)) { fprintf(stderr, "%s: Invalid argument\n", __func__); return -1; } // Need to find the lun that holds partition partname snprintf(path, sizeof(path), "%s/%s", BOOT_DEV_DIR, partname); buf = realpath(path, buf); if (!buf) { return -1; } else { for (i = strlen(buf); i > 0; i--) if (!isdigit(buf[i - 1])) break; if (i >= 2 && buf[i - 1] == 'p' && isdigit(buf[i - 2])) i--; buf[i] = 0; } return 0; } // Get the block size of the disk represented by decsriptor fd static uint32_t gpt_get_block_size(int fd) { uint32_t block_size = 0; if (fd < 0) { fprintf(stderr, "%s: invalid descriptor\n", __func__); goto error; } if (ioctl(fd, BLKSSZGET, &block_size) != 0) { fprintf(stderr, "%s: Failed to get GPT dev block size : %s\n", __func__, strerror(errno)); goto error; } return block_size; error: return 0; } // Write the GPT header present in the passed in buffer back to the // disk represented by fd static int gpt_set_header(uint8_t *gpt_header, int fd, enum gpt_instance instance) { uint32_t block_size = 0; off_t gpt_header_offset = 0; if (!gpt_header || fd < 0) { fprintf(stderr, "%s: Invalid arguments\n", __func__); goto error; } block_size = gpt_get_block_size(fd); LOGD("%s: Block size is : %d\n", __func__, block_size); if (block_size == 0) { fprintf(stderr, "%s: Failed to get block size\n", __func__); goto error; } if (instance == PRIMARY_GPT) gpt_header_offset = block_size; else gpt_header_offset = lseek64(fd, 0, SEEK_END) - block_size; if (gpt_header_offset <= 0) { fprintf(stderr, "%s: Failed to get gpt header offset\n", __func__); goto error; } LOGD("%s: Writing back header to offset %ld\n", __func__, gpt_header_offset); if (blk_rw(fd, 1, gpt_header_offset, gpt_header, block_size)) { fprintf(stderr, "%s: Failed to write back GPT header\n", __func__); goto error; } return 0; error: return -1; } // Read out the GPT headers for the disk that contains the partition partname static int gpt_get_headers(const char *partname, uint8_t **primary, uint8_t **backup) { uint8_t *hdr = NULL; char devpath[GPT_PTN_PATH_MAX] = { 0 }; off_t hdr_offset = 0; uint32_t block_size = 0; int instance; int fd = -1; if (!partname) { fprintf(stderr, "%s: Invalid partition name\n", __func__); goto error; } if (get_dev_path_from_partition_name(partname, devpath, sizeof(devpath)) != 0) { fprintf(stderr, "%s: Failed to resolve path for %s\n", __func__, partname); goto error; } fd = open(devpath, O_RDONLY); if (fd < 0) { fprintf(stderr, "%s: Failed to open %s : %s\n", __func__, devpath, strerror(errno)); return -1; } block_size = gpt_get_block_size(fd); if (block_size == 0) { fprintf(stderr, "%s: Failed to get gpt block size for %s\n", __func__, partname); goto error; } for (instance = PRIMARY_GPT; instance <= SECONDARY_GPT; instance++) { hdr = (uint8_t *)calloc(block_size, 1); if (!hdr) { fprintf(stderr, "%s: Failed to allocate memory for gpt header\n", __func__); } if (instance == PRIMARY_GPT) hdr_offset = block_size; else { hdr_offset = lseek64(fd, 0, SEEK_END) - block_size; } if (hdr_offset < 0) { fprintf(stderr, "%s: Failed to get gpt header offset\n", __func__); goto error; } if (blk_rw(fd, 0, hdr_offset, hdr, block_size)) { fprintf(stderr, "%s: Failed to read GPT header from device\n", __func__); goto error; } if (instance == PRIMARY_GPT) *primary = hdr; else *backup = hdr; } close(fd); return 0; error: close(fd); if (hdr) free(hdr); return -1; } // Returns the partition entry array based on the // passed in buffer which contains the gpt header. // The fd here is the descriptor for the 'disk' which // holds the partition static uint8_t *gpt_get_pentry_arr(uint8_t *hdr, int fd) { uint64_t pentries_start = 0; uint32_t pentry_size = 0; uint32_t block_size = 0; uint32_t pentries_arr_size = 0; uint8_t *pentry_arr = NULL; int rc = 0; if (!hdr) { fprintf(stderr, "%s: Invalid header\n", __func__); goto error; } if (fd < 0) { fprintf(stderr, "%s: Invalid fd\n", __func__); goto error; } block_size = gpt_get_block_size(fd); if (!block_size) { fprintf(stderr, "%s: Failed to get gpt block size for\n", __func__); goto error; } pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); pentries_arr_size = GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; pentry_arr = (uint8_t *)calloc(1, pentries_arr_size); if (!pentry_arr) { fprintf(stderr, "%s: Failed to allocate memory for partition array\n", __func__); goto error; } rc = blk_rw(fd, 0, pentries_start, pentry_arr, pentries_arr_size); if (rc) { fprintf(stderr, "%s: Failed to read partition entry array\n", __func__); goto error; } return pentry_arr; error: if (pentry_arr) free(pentry_arr); return NULL; } static int gpt_set_pentry_arr(uint8_t *hdr, int fd, uint8_t *arr) { uint32_t block_size = 0; uint64_t pentries_start = 0; uint32_t pentry_size = 0; uint32_t pentries_arr_size = 0; int rc = 0; if (!hdr || fd < 0 || !arr) { fprintf(stderr, "%s: Invalid argument\n", __func__); goto error; } block_size = gpt_get_block_size(fd); if (!block_size) { fprintf(stderr, "%s: Failed to get gpt block size for\n", __func__); goto error; } LOGD("%s : Block size is %d\n", __func__, block_size); pentries_start = GET_8_BYTES(hdr + PENTRIES_OFFSET) * block_size; pentry_size = GET_4_BYTES(hdr + PENTRY_SIZE_OFFSET); pentries_arr_size = GET_4_BYTES(hdr + PARTITION_COUNT_OFFSET) * pentry_size; LOGD("%s: Writing partition entry array of size %d to offset %" PRIu64 "\n", __func__, pentries_arr_size, pentries_start); LOGD("pentries_start: %lu\n", pentries_start); rc = blk_rw(fd, 1, pentries_start, arr, pentries_arr_size); if (rc) { fprintf(stderr, "%s: Failed to read partition entry array\n", __func__); goto error; } return 0; error: return -1; } /* * Free previously allocated/initialized handle * This function is always safe and must be called * before discarding the handle. * it is called automatically by gpt_disk_get_disk_info() */ void gpt_disk_free(struct gpt_disk *disk) { if (!disk) return; if (disk->hdr) { free(disk->hdr); disk->hdr = NULL; } if (disk->hdr_bak) { free(disk->hdr_bak); disk->hdr_bak = NULL; } if (disk->pentry_arr) { free(disk->pentry_arr); disk->pentry_arr = NULL; } if (disk->pentry_arr_bak) { free(disk->pentry_arr_bak); disk->pentry_arr_bak = NULL; } disk->is_initialized = 0; return; } bool gpt_disk_is_valid(struct gpt_disk *disk) { return disk->is_initialized == GPT_DISK_INIT_MAGIC; } /* * Check if a partition by-path is for the disk we have info for * and populate the blockdev path. * e.g. for /dev/disk/by-partlabel/system_a blockdev would be /dev/sda */ int partition_is_for_disk(const struct gpt_disk *disk, const char *part, char *blockdev, int blockdev_len) { int ret; ret = get_dev_path_from_partition_name(part, blockdev, blockdev_len); if (ret) { fprintf(stderr, "%s: Failed to resolve path for %s\n", __func__, part); return -1; } if (!strcmp(blockdev, disk->devpath)) { return true; } return false; } /* * fills up the passed in gpt_disk struct with information about the * disk represented by path dev. Returns 0 on success and -1 on error. */ int gpt_disk_get_disk_info(const char *dev, struct gpt_disk *disk) { int fd = -1, rc; uint32_t gpt_header_size = 0; char devpath[GPT_PTN_PATH_MAX] = { 0 }; if (!disk || !dev) { fprintf(stderr, "%s: Invalid arguments\n", __func__); goto error; } rc = partition_is_for_disk(disk, dev, devpath, sizeof(devpath)); if (rc > 0) return 0; if (rc < 0) { fprintf(stderr, "%s: Failed to resolve path for %s\n", __func__, dev); return -1; } if (disk->is_initialized == GPT_DISK_INIT_MAGIC) { /* Commit any changes to the disk */ if (gpt_disk_commit(disk)) { fprintf(stderr, "Failed to commit disk entry"); return -1; } // We already have a valid disk handle. Free it. LOGD("%s: Freeing disk handle for %s... -> %s\n", __func__, disk->devpath, devpath); gpt_disk_free(disk); } LOGD("%s: Initializing disk handle for %s... -> %s\n", __func__, disk->devpath, devpath); // devpath popualted by partition_is_for_disk strncpy(disk->devpath, devpath, sizeof(disk->devpath)); if (gpt_get_headers(dev, &disk->hdr, &disk->hdr_bak)) { fprintf(stderr, "%s: Failed to get GPT headers\n", __func__); goto error; } assert(disk->hdr != NULL); assert(disk->hdr_bak != NULL); gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); // FIXME: pointer offsets crc bleh disk->hdr_crc = efi_crc32(disk->hdr, gpt_header_size); disk->hdr_bak_crc = efi_crc32(disk->hdr_bak, gpt_header_size); fd = open(disk->devpath, O_RDONLY); if (fd < 0) { fprintf(stderr, "%s: Failed to open %s: %s\n", __func__, disk->devpath, strerror(errno)); goto error; } assert(disk->pentry_arr == NULL); disk->pentry_arr = gpt_get_pentry_arr(disk->hdr, fd); if (!disk->pentry_arr) { fprintf(stderr, "%s: Failed to obtain partition entry array\n", __func__); goto error; } assert(disk->pentry_arr_bak == NULL); disk->pentry_arr_bak = gpt_get_pentry_arr(disk->hdr_bak, fd); if (!disk->pentry_arr_bak) { fprintf(stderr, "%s: Failed to obtain backup partition entry array\n", __func__); goto error; } disk->pentry_size = GET_4_BYTES(disk->hdr + PENTRY_SIZE_OFFSET); disk->pentry_arr_size = GET_4_BYTES(disk->hdr + PARTITION_COUNT_OFFSET) * disk->pentry_size; disk->pentry_arr_crc = GET_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET); disk->pentry_arr_bak_crc = GET_4_BYTES(disk->hdr_bak + PARTITION_CRC_OFFSET); disk->block_size = gpt_get_block_size(fd); close(fd); disk->is_initialized = GPT_DISK_INIT_MAGIC; return 0; error: if (fd >= 0) close(fd); return -1; } // Get pointer to partition entry from a allocated gpt_disk structure uint8_t *gpt_disk_get_pentry(struct gpt_disk *disk, const char *partname, enum gpt_instance instance) { uint8_t *ptn_arr = NULL; if (!disk || !partname || disk->is_initialized != GPT_DISK_INIT_MAGIC) { fprintf(stderr, "%s: disk handle not initialised\n", __func__); return NULL; } ptn_arr = (instance == PRIMARY_GPT) ? disk->pentry_arr : disk->pentry_arr_bak; return (gpt_pentry_seek(partname, ptn_arr, ptn_arr + disk->pentry_arr_size, disk->pentry_size)); } // Update CRC values for the various components of the gpt_disk // structure. This function should be called after any of the fields // have been updated before the structure contents are written back to // disk. static int gpt_disk_update_crc(struct gpt_disk *disk) { uint32_t gpt_header_size = 0; if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)) { fprintf(stderr, "%s: disk not initialised!\n", __func__); return -1; } #ifdef DEBUG uint32_t old_crc = disk->pentry_arr_crc; #endif // Recalculate the CRC of the primary partiton array disk->pentry_arr_crc = efi_crc32(disk->pentry_arr, disk->pentry_arr_size); LOGD("%s() disk %8s GPT pentry len %u crc: %08x -> %08x\n", __func__, disk->devpath, disk->pentry_arr_size, old_crc, disk->pentry_arr_crc); // DumpHex(disk->pentry_arr, disk->pentry_arr_size); // Recalculate the CRC of the backup partition array disk->pentry_arr_bak_crc = efi_crc32(disk->pentry_arr_bak, disk->pentry_arr_size); LOGD("%s() disk %8s GPT pentry_bak len %u crc: %08x -> %08x\n", __func__, disk->devpath, disk->pentry_arr_size, old_crc, disk->pentry_arr_crc); // Update the partition CRC value in the primary GPT header PUT_4_BYTES(disk->hdr + PARTITION_CRC_OFFSET, disk->pentry_arr_crc); // Update the partition CRC value in the backup GPT header PUT_4_BYTES(disk->hdr_bak + PARTITION_CRC_OFFSET, disk->pentry_arr_bak_crc); // Update the CRC value of the primary header gpt_header_size = GET_4_BYTES(disk->hdr + HEADER_SIZE_OFFSET); // Header CRC is calculated with its own CRC field set to 0 PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, 0); PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, 0); disk->hdr_crc = efi_crc32(disk->hdr, gpt_header_size); disk->hdr_bak_crc = efi_crc32(disk->hdr_bak, gpt_header_size); PUT_4_BYTES(disk->hdr + HEADER_CRC_OFFSET, disk->hdr_crc); PUT_4_BYTES(disk->hdr_bak + HEADER_CRC_OFFSET, disk->hdr_bak_crc); return 0; } // Write the contents of struct gpt_disk back to the actual disk int gpt_disk_commit(struct gpt_disk *disk) { int fd = -1; if (!disk || (disk->is_initialized != GPT_DISK_INIT_MAGIC)) { fprintf(stderr, "%s: Invalid args\n", __func__); goto error; } if (gpt_disk_update_crc(disk)) { fprintf(stderr, "%s: Failed to update CRC values\n", __func__); goto error; } fd = open(disk->devpath, O_RDWR); if (fd < 0) { fprintf(stderr, "%s: Failed to open %s: %s\n", __func__, disk->devpath, strerror(errno)); goto error; } LOGD("%s: Writing back primary GPT header\n", __func__); // Write the primary header if (gpt_set_header(disk->hdr, fd, PRIMARY_GPT) != 0) { fprintf(stderr, "%s: Failed to update primary GPT header\n", __func__); goto error; } LOGD("%s: Writing back primary partition array\n", __func__); // Write back the primary partition array if (gpt_set_pentry_arr(disk->hdr, fd, disk->pentry_arr)) { fprintf(stderr, "%s: Failed to write primary GPT partition arr\n", __func__); goto error; } // Write the backup header if (gpt_set_header(disk->hdr_bak, fd, SECONDARY_GPT) != 0) { fprintf(stderr, "%s: Failed to update backup GPT header\n", __func__); goto error; } LOGD("%s: Writing back backup partition array\n", __func__); // Write back the backup partition array if (gpt_set_pentry_arr(disk->hdr_bak, fd, disk->pentry_arr_bak)) { fprintf(stderr, "%s: Failed to write backup GPT partition arr\n", __func__); goto error; } LOGD("%s: Done\n", __func__); fsync(fd); close(fd); return 0; error: if (fd >= 0) close(fd); return -1; } // Determine whether to handle the given partition as eMMC or UFS, using the // name of the backing device. // // Note: In undefined cases (i.e. /dev/mmcblk1 and unresolvable), this function // will tend to prefer UFS behavior. If it incorrectly reports this, then the // program should exit (e.g. by failing) before making any changes. bool gpt_utils_is_partition_backed_by_emmc(const char *part) { char devpath[GPT_PTN_PATH_MAX] = { '\0' }; if (get_dev_path_from_partition_name(part, devpath, sizeof(devpath))) return false; return !strcmp(devpath, EMMC_DEVICE); } qbootctl-0.2.2/gpt-utils.h000066400000000000000000000143071477035651500154650ustar00rootroot00000000000000/* * Copyright (c) 2013, The Linux Foundation. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef __GPT_UTILS_H__ #define __GPT_UTILS_H__ #ifdef __cplusplus extern "C" { #endif #include #include #include #include #include #define GPT_SIGNATURE "EFI PART" #define HEADER_SIZE_OFFSET 12 #define HEADER_CRC_OFFSET 16 #define PRIMARY_HEADER_OFFSET 24 #define BACKUP_HEADER_OFFSET 32 #define FIRST_USABLE_LBA_OFFSET 40 #define LAST_USABLE_LBA_OFFSET 48 #define PENTRIES_OFFSET 72 #define PARTITION_COUNT_OFFSET 80 #define PENTRY_SIZE_OFFSET 84 #define PARTITION_CRC_OFFSET 88 #define TYPE_GUID_OFFSET 0 #define TYPE_GUID_SIZE 16 #define PTN_ENTRY_SIZE 128 #define UNIQUE_GUID_OFFSET 16 #define FIRST_LBA_OFFSET 32 #define LAST_LBA_OFFSET 40 #define ATTRIBUTE_FLAG_OFFSET 48 #define PARTITION_NAME_OFFSET 56 #define MAX_GPT_NAME_SIZE 72 // Bit 48 onwords in the attribute field are the ones where we are allowed to // store our AB attributes. #define AB_FLAG_OFFSET (ATTRIBUTE_FLAG_OFFSET + 6) #define GPT_DISK_INIT_MAGIC 0xABCD #define AB_PARTITION_ATTR_SLOT_ACTIVE (0x1 << 2) #define AB_PARTITION_ATTR_BOOT_SUCCESSFUL (0x1 << 6) #define AB_PARTITION_ATTR_UNBOOTABLE (0x1 << 7) #define AB_SLOT_ACTIVE_VAL 0xF #define AB_SLOT_INACTIVE_VAL 0x0 #define AB_SLOT_ACTIVE 1 #define AB_SLOT_INACTIVE 0 #define AB_SLOT_A_SUFFIX "_a" #define AB_SLOT_B_SUFFIX "_b" #define PTN_XBL "xbl" // XBL is not included because the slot attributes are meaningless there // *which* XBL partition is active is determined via the UFS bBootLunEn field // as it needs to be handled by PBL #define PTN_SWAP_LIST \ "abl_a", "aop_a", "apdp_a", "cmnlib_a", "cmnlib64_a", "devcfg_a", "dtbo_a", \ "hyp_a", "keymaster_a", "msadp_a", "qupfw_a", "storsec_a", "tz_a", \ "vbmeta_a", "vbmeta_system_a" static const char g_all_ptns[][MAX_GPT_NAME_SIZE + 1] = { PTN_SWAP_LIST, "boot_a", "system_a", "vendor_a", "modem_a", "system_ext_a", "product_a" }; // No more than /dev/sdk #define MAX_BLOCK_DEVICES 10 #define BOOT_DEV_DIR "/dev/disk/by-partlabel" #define GPT_PTN_PATH_MAX sizeof(BOOT_DEV_DIR) + MAX_GPT_NAME_SIZE + 2 #define EMMC_DEVICE "/dev/mmcblk0" #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) enum gpt_instance { PRIMARY_GPT = 0, SECONDARY_GPT }; enum boot_chain { NORMAL_BOOT = 0, BACKUP_BOOT }; struct gpt_disk { // GPT primary header uint8_t *hdr; // primary header crc uint32_t hdr_crc; // GPT backup header uint8_t *hdr_bak; // backup header crc uint32_t hdr_bak_crc; // Partition entries array uint8_t *pentry_arr; // Partition entries array for backup table uint8_t *pentry_arr_bak; // Size of the pentry array uint32_t pentry_arr_size; // Size of each element in the pentry array uint32_t pentry_size; // CRC of the partition entry array uint32_t pentry_arr_crc; // CRC of the backup partition entry array uint32_t pentry_arr_bak_crc; // Path to block dev representing the disk char devpath[PATH_MAX]; // Block size of disk uint32_t block_size; uint32_t is_initialized; }; // GPT disk methods bool gpt_disk_is_valid(struct gpt_disk *disk); // Free previously allocated gpt_disk struct void gpt_disk_free(struct gpt_disk *disk); // Get the details of the disk holding the partition whose name // is passed in via dev int gpt_disk_get_disk_info(const char *dev, struct gpt_disk *disk); int partition_is_for_disk(const struct gpt_disk *disk, const char *part, char *blockdev, int blockdev_len); // Get pointer to partition entry from a allocated gpt_disk structure uint8_t *gpt_disk_get_pentry(struct gpt_disk *disk, const char *partname, enum gpt_instance instance); // Write the contents of struct gpt_disk back to the actual disk int gpt_disk_commit(struct gpt_disk *disk); // Swtich betwieen using either the primary or the backup // boot LUN for boot. This is required since UFS boot partitions // cannot have a backup GPT which is what we use for failsafe // updates of the other 'critical' partitions. This function will // not be invoked for emmc targets and on UFS targets is only required // to be invoked for XBL. // // The algorithm to do this is as follows: // - Find the real block device(eg: /dev/block/sdb) that corresponds // to the /dev/block/bootdevice/by-name/xbl(bak) symlink // // - Once we have the block device 'node' name(sdb in the above example) // use this node to to locate the scsi generic device that represents // it by checking the file /sys/block/sdb/device/scsi_generic/sgY // // - Once we locate sgY we call the query ioctl on /dev/sgy to switch // the boot lun to either LUNA or LUNB int gpt_utils_set_xbl_boot_partition(enum boot_chain chain); bool gpt_utils_is_partition_backed_by_emmc(const char *part); #ifdef __cplusplus } #endif #endif /* __GPT_UTILS_H__ */ qbootctl-0.2.2/meson.build000066400000000000000000000007021477035651500155200ustar00rootroot00000000000000project('qbootctl', 'c', default_options : ['c_std=gnu11']) cc = meson.get_compiler('c') if not cc.has_header('linux/bsg.h') error('linux-headers not found') endif src = [ 'qbootctl.c', 'bootctrl_impl.c', 'gpt-utils.c', 'ufs-bsg.c', 'crc32.c', ] inc = [ include_directories('.'), ] executable('qbootctl', src, include_directories: inc, install: true, c_args: [], ) qbootctl-0.2.2/qbootctl.c000066400000000000000000000125761477035651500153650ustar00rootroot00000000000000/* * Copyright (C) 2023 Caleb Connolly * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include #include #include #include #include #include #include #include "bootctrl.h" const struct boot_control_module *impl = &bootctl; bool isslot(const char* str) { return strspn(str, "01abAB") == strlen(str); } bool isslotnum(const char* str) { return strspn(str, "01") == strlen(str); } unsigned parseSlot(const char* arg) { char *end; int slot; if (!isslot(arg)) { goto fail; } if (isslotnum(arg)) { slot = (int)strtol(arg, &end, 10); if (end == arg) goto fail; } else { switch (arg[0]) { case 'a': case 'A': slot = 0; break; case 'b': case 'B': slot = 1; break; default: goto fail; } } return (unsigned)slot; fail: fprintf(stderr, "Expected slot not '%s'\n", arg); exit(1); } int usage() { // clang-format off fprintf(stderr, "qbootctl: qcom bootctrl HAL port for Linux\n"); fprintf(stderr, "-------------------------------------------\n"); fprintf(stderr, "qbootctl [-c|-m|-s|-u|-b|-n|-x] [SLOT]\n\n"); fprintf(stderr, " dump slot info (default)\n"); fprintf(stderr, " -h this help text\n"); fprintf(stderr, " -c get the current slot\n"); fprintf(stderr, " -a get the active slot\n"); fprintf(stderr, " -b SLOT check if SLOT is marked as bootable\n"); fprintf(stderr, " -n SLOT check if SLOT is marked as successful\n"); fprintf(stderr, " -x [SLOT] get the slot suffix for SLOT (default: current)\n"); fprintf(stderr, " -s SLOT set to active slot to SLOT\n"); fprintf(stderr, " -m [SLOT] mark a boot as successful (default: current)\n"); fprintf(stderr, " -u [SLOT] mark SLOT as unbootable (default: current)\n"); fprintf(stderr, " -i still write the GPT headers even if the UFS bLun can't be changed (default: false)\n"); // clang-format on return 1; } int get_slot_info(struct slot_info *slots) { int rc; uint32_t active_slot = impl->getActiveBootSlot(); slots[active_slot].active = true; for (int i = 0; i < 2; i++) { rc = impl->isSlotMarkedSuccessful(i); if (rc < 0) return rc; slots[i].successful = rc; rc = impl->isSlotBootable(i); if (rc < 0) return rc; slots[i].bootable = rc; } return 0; } static void dump_info(int current_slot) { struct slot_info slots[2] = { { 0 } }; get_slot_info(slots); printf("Current slot: %s\n", current_slot >= 0 ? impl->getSuffix(current_slot) : "N/A"); for (int i = 0; i < 2; i++) { printf("SLOT %s:\n", impl->getSuffix(i)); printf("\tActive : %d\n", slots[i].active); printf("\tSuccessful : %d\n", slots[i].successful); printf("\tBootable : %d\n", slots[i].bootable); } } int main(int argc, char **argv) { int optflag; int slot = -1, current_slot; int rc; bool ignore_missing_bsg = false; if(geteuid() != 0) { fprintf(stderr, "This program must be run as root!\n"); return 1; } current_slot = impl->getCurrentSlot(); if (current_slot < 0) { fprintf(stderr, "No slots found, is this an A/B device?\n"); return 1; } switch (argc) { case 1: dump_info(current_slot); return 0; case 2: break; case 3: slot = parseSlot(argv[2]); break; default: return usage(); } optflag = getopt(argc, argv, "hcmas:ub:n:x"); if (slot < 0 || optflag == 'c') slot = current_slot; switch (optflag) { case 'c': printf("Current slot: %s\n", impl->getSuffix(slot)); return 0; case 'a': slot = impl->getActiveBootSlot(); printf("Active slot: %s\n", impl->getSuffix(slot)); return 0; case 'b': printf("SLOT %s: is %smarked bootable\n", impl->getSuffix(slot), impl->isSlotBootable(slot) == 1 ? "" : "not "); return 0; case 'n': printf("SLOT %s: is %smarked successful\n", impl->getSuffix(slot), impl->isSlotMarkedSuccessful(slot) == 1 ? "" : "not "); return 0; case 'x': printf("%s\n", impl->getSuffix(slot)); return 0; case 's': rc = impl->setActiveBootSlot(slot, ignore_missing_bsg); if (rc < 0) { fprintf(stderr, "SLOT %s: Failed to set active\n", impl->getSuffix(slot)); return 1; } printf("SLOT %d: Set as active slot\n", slot); return 0; case 'm': rc = impl->markBootSuccessful(slot); if (rc < 0) return 1; printf("SLOT %s: Marked boot successful\n", impl->getSuffix(slot)); return 0; case 'u': rc = impl->setSlotAsUnbootable(slot); if (rc < 0) { fprintf(stderr, "SLOT %s: Failed to set as unbootable\n", impl->getSuffix(slot)); return 1; } printf("SLOT %s: Set as unbootable\n", impl->getSuffix(slot)); return 0; case 'i': ignore_missing_bsg = true; break; case 'h': default: usage(); return 0; } return 0; } qbootctl-0.2.2/ufs-bsg.c000066400000000000000000000123551477035651500150770ustar00rootroot00000000000000/* * Copyright (c) 2020 The Linux Foundation. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include "utils.h" #include "ufs-bsg.h" /* UFS BSG device node */ static char ufs_bsg_dev[FNAME_SZ] = "/dev/bsg/ufs-bsg0"; static int fd_ufs_bsg = 0; int ufs_bsg_dev_open() { if (fd_ufs_bsg) return 0; fd_ufs_bsg = open(ufs_bsg_dev, O_RDWR); if (fd_ufs_bsg < 0) { fprintf(stderr, "Unable to open '%s': %s\n", ufs_bsg_dev, strerror(errno)); fprintf(stderr, "Is CONFIG_SCSI_UFS_BSG is enabled in your kernel?\n"); fd_ufs_bsg = 0; return -1; } return 0; } void ufs_bsg_dev_close() { if (fd_ufs_bsg) { close(fd_ufs_bsg); fd_ufs_bsg = 0; } } static int ufs_bsg_ioctl(int fd, struct ufs_bsg_request *req, struct ufs_bsg_reply *rsp, __u8 *buf, __u32 buf_len, enum bsg_ioctl_dir dir) { int ret; struct sg_io_v4 sg_io = { .guard = 'Q', .protocol = BSG_PROTOCOL_SCSI, .subprotocol = BSG_SUB_PROTOCOL_SCSI_TRANSPORT, .request_len = sizeof(*req), .request = (__u64)req, .response = (__u64)rsp, .max_response_len = sizeof(*rsp), }; if (dir == BSG_IOCTL_DIR_FROM_DEV) { sg_io.din_xfer_len = buf_len; sg_io.din_xferp = (__u64)(buf); } else { sg_io.dout_xfer_len = buf_len; sg_io.dout_xferp = (__u64)(buf); } ret = ioctl(fd, SG_IO, &sg_io); if (ret) fprintf(stderr, "%s: Error from sg_io ioctl (return value: %d, error no: %d, reply result from LLD: %d\n)", __func__, ret, errno, rsp->result); if (sg_io.info || rsp->result) { fprintf(stderr, "%s: Error from sg_io info (check sg info: device_status: 0x%x, transport_status: 0x%x, driver_status: 0x%x, reply result from LLD: %d\n)", __func__, sg_io.device_status, sg_io.transport_status, sg_io.driver_status, rsp->result); ret = -EAGAIN; } return ret; } static void compose_ufs_bsg_query_req(struct ufs_bsg_request *req, __u8 func, __u8 opcode, __u8 idn, __u8 index, __u8 sel, __u16 length) { struct utp_upiu_header *hdr = &req->upiu_req.header; struct utp_upiu_query *qr = &req->upiu_req.qr; req->msgcode = UTP_UPIU_QUERY_REQ; hdr->dword_0 = DWORD(UTP_UPIU_QUERY_REQ, 0, 0, 0); hdr->dword_1 = DWORD(0, func, 0, 0); hdr->dword_2 = DWORD(0, 0, length >> 8, (__u8)length); qr->opcode = opcode; qr->idn = idn; qr->index = index; qr->selector = sel; qr->length = htobe16(length); } static int ufs_query_attr(int fd, __u32 value, __u8 func, __u8 opcode, __u8 idn, __u8 index, __u8 sel) { struct ufs_bsg_request req = { 0 }; struct ufs_bsg_reply rsp = { 0 }; enum bsg_ioctl_dir dir = BSG_IOCTL_DIR_FROM_DEV; int ret = 0; if (opcode == QUERY_REQ_OP_WRITE_DESC || opcode == QUERY_REQ_OP_WRITE_ATTR) dir = BSG_IOCTL_DIR_TO_DEV; req.upiu_req.qr.value = htobe32(value); compose_ufs_bsg_query_req(&req, func, opcode, idn, index, sel, 0); ret = ufs_bsg_ioctl(fd, &req, &rsp, 0, 0, dir); if (ret) fprintf(stderr, "%s: Error from ufs_bsg_ioctl (return value: %d, error no: %d\n)", __func__, ret, errno); return ret; } int32_t set_boot_lun(__u8 lun_id) { int32_t ret; __u32 boot_lun_id = lun_id; LOGD("Using UFS bsg device: %s\n", ufs_bsg_dev); ret = ufs_bsg_dev_open(); if (ret) return ret; LOGD("Opened ufs bsg dev: %s\n", ufs_bsg_dev); ret = ufs_query_attr(fd_ufs_bsg, boot_lun_id, QUERY_REQ_FUNC_STD_WRITE, QUERY_REQ_OP_WRITE_ATTR, QUERY_ATTR_IDN_BOOT_LU_EN, 0, 0); if (ret) fprintf(stderr, "Error requesting ufs attr idn %d via query ioctl (return value: %d, error no: %d)", QUERY_ATTR_IDN_BOOT_LU_EN, ret, errno); ufs_bsg_dev_close(); return ret; } qbootctl-0.2.2/ufs-bsg.h000066400000000000000000000055221477035651500151020ustar00rootroot00000000000000#ifndef __RECOVERY_UFS_BSG_H__ #define __RECOVERY_UFS_BSG_H__ /* * Copyright (c) 2020 The Linux Foundation. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above * copyright notice, this list of conditions and the following * disclaimer in the documentation and/or other materials provided * with the distribution. * * Neither the name of The Linux Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #define FNAME_SZ 64 #define SG_IO 0x2285 #define DWORD(b3, b2, b1, b0) htobe32((b3 << 24) | (b2 << 16) | (b1 << 8) | b0) /* UPIU Transaction Codes */ enum { UTP_UPIU_NOP_OUT = 0x00, UTP_UPIU_COMMAND = 0x01, UTP_UPIU_DATA_OUT = 0x02, UTP_UPIU_TASK_REQ = 0x04, UTP_UPIU_QUERY_REQ = 0x16, }; /* UPIU Query Function field */ enum { QUERY_REQ_FUNC_STD_READ = 0x01, QUERY_REQ_FUNC_STD_WRITE = 0x81, }; enum query_req_opcode { QUERY_REQ_OP_READ_DESC = 0x1, QUERY_REQ_OP_WRITE_DESC = 0x2, QUERY_REQ_OP_READ_ATTR = 0x3, QUERY_REQ_OP_WRITE_ATTR = 0x4, QUERY_REQ_OP_READ_FLAG = 0x5, QUERY_REQ_OP_SET_FLAG = 0x6, QUERY_REQ_OP_CLEAR_FLAG = 0x7, QUERY_REQ_OP_TOGGLE_FLAG = 0x8, }; enum query_desc_idn { QUERY_DESC_IDN_DEVICE = 0x0, QUERY_DESC_IDN_UNIT = 0x2, QUERY_DESC_IDN_GEOMETRY = 0x7, }; enum query_desc_size { QUERY_DESC_SIZE_DEVICE = 0x40, QUERY_DESC_SIZE_GEOMETRY = 0x48, QUERY_DESC_SIZE_UNIT = 0x23, }; enum bsg_ioctl_dir { BSG_IOCTL_DIR_TO_DEV, BSG_IOCTL_DIR_FROM_DEV, }; enum query_attr_idn { QUERY_ATTR_IDN_BOOT_LU_EN = 0x00, QUERY_ATTR_IDN_RESERVED = 0x01, QUERY_ATTR_IDN_POWER_MODE = 0x02, QUERY_ATTR_IDN_ACTIVE_ICC_LVL = 0x03, }; int ufs_bsg_dev_open(); #endif /* __RECOVERY_UFS_BSG_H__ */ qbootctl-0.2.2/utils.h000066400000000000000000000003001477035651500146610ustar00rootroot00000000000000#ifndef __UTILS_H__ #define __UTILS_H__ // Enable debug logging // #define DEBUG 1 #ifdef DEBUG #define LOGD(fmt, ...) printf(fmt, ##__VA_ARGS__) #else #define LOGD(fmtn, ...) #endif #endif