diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f58ffc2 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ + +*.h linguist-language=C diff --git a/.vscode/c_cpp_properties.json b/.vscode/c_cpp_properties.json index 5867c1e..b9c0127 100644 --- a/.vscode/c_cpp_properties.json +++ b/.vscode/c_cpp_properties.json @@ -1,33 +1,23 @@ { - "env": { - "loaderDefaultIncludePaths": [ - "${workspaceFolder}/include", - "${workspaceFolder}/scripts/opt/cross/lib/gcc/arm-none-eabi/8.2.0/include", - "${workspaceFolder}/scripts/opt/cross/lib/gcc/aarch64-none-elf/8.2.0/include" - ], - "loaderDefaultBrowsePaths": [ - "${workspaceFolder}/src", - "${workspaceFolder}/include", - "${workspaceFolder}/scripts/opt/cross/lib/gcc/arm-none-eabi/8.2.0/include", - "${workspaceFolder}/scripts/opt/cross/lib/gcc/aarch64-none-elf/8.2.0/include" - ] - }, "configurations": [ { "name": "Mac", "includePath": [ - "${loaderDefaultIncludePaths}" + "${workspaceFolder}/include" ], "defines": [], "intelliSenseMode": "${default}", "browse": { "path": [ - "${loaderDefaultBrowsePaths}" + "${workspaceFolder}/src", + "${workspaceFolder}/include" ], "limitSymbolsToIncludedHeaders": true, "databaseFilename": "" }, - "macFrameworkPath": [], + "macFrameworkPath": [ + "/System/Library/Frameworks" + ], "forcedInclude": [ "${workspaceFolder}/build/include/config.h" ], @@ -36,35 +26,14 @@ { "name": "Linux", "includePath": [ - "${loaderDefaultIncludePaths}" + "${workspaceFolder}/include" ], "defines": [], "intelliSenseMode": "${default}", "browse": { "path": [ - "${loaderDefaultBrowsePaths}" - ], - "limitSymbolsToIncludedHeaders": true, - "databaseFilename": "" - }, - "forcedInclude": [ - "${workspaceFolder}/build/include/config.h" - ], - "cStandard": "c11" - }, - { - "name": "Win32", - "includePath": [ - "${loaderDefaultIncludePaths}" - ], - "defines": [ - "_DEBUG", - "UNICODE" - ], - "intelliSenseMode": "${default}", - "browse": { - "path": [ - "${loaderDefaultBrowsePaths}" + "${workspaceFolder}/src", + "${workspaceFolder}/include" ], "limitSymbolsToIncludedHeaders": true, "databaseFilename": "" diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..c5db741 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,3 @@ +Authors of bolthur-serial-communicator + +Christian Freitag cfreitag.cf@googlemail.com diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + 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 +. diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..3fb2332 --- /dev/null +++ b/ChangeLog @@ -0,0 +1 @@ +xxxx-xx-xx Christian Freitag diff --git a/m4/.gitkeep b/INSTALL similarity index 100% rename from m4/.gitkeep rename to INSTALL diff --git a/Makefile.am b/Makefile.am index dc07c72..7205eb3 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -ACLOCAL_AMFLAGS = -I m4 +ACLOCAL_AMFLAGS = -I build-aux/m4 SUBDIRS = src diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..a87c53d --- /dev/null +++ b/NEWS @@ -0,0 +1 @@ +NEWS - List of noteworthy changes between releases of bolthur-serial-communicator diff --git a/README b/README new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index a5a84ef..d61ddfc 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # bolthur serial communicator [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE) [![Code of Conduct](https://img.shields.io/badge/%E2%9D%A4-code%20of%20conduct-blue.svg?style=flat)](./.github/CODE_OF_CONDUCT.md) [![Contribution Guide](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](./.github/CONTRIBUTING.md) ![version](https://img.shields.io/badge/version-none-blue.svg?maxAge=2592000) bolthur serial communicator project. -_Copyright (C) 2019 bolthur project_ +_Copyright (C) 2019 - 2020 bolthur project_ ## About -Small tool waiting for response from serial bootloader to send kernel to device. +Small tool waiting for response from serial bootloader to send kernel and optional initrd to device. diff --git a/build-aux/m4/flag.m4 b/build-aux/m4/flag.m4 new file mode 100644 index 0000000..fcc58bc --- /dev/null +++ b/build-aux/m4/flag.m4 @@ -0,0 +1,5 @@ + +AC_DEFUN([BOLTHUR_SERIAL_COMMUNICATOR_SET_FLAG], [ + # compile flags + CFLAGS="${CFLAGS} -Wall -Wextra -Werror -Wpedantic -Wconversion -O2" +]) diff --git a/build-aux/m4/host.m4 b/build-aux/m4/host.m4 new file mode 100644 index 0000000..8f4316d --- /dev/null +++ b/build-aux/m4/host.m4 @@ -0,0 +1,42 @@ + +AC_DEFUN([BOLTHUR_SERIAL_COMMUNICATOR_SET_HOST], [ + # define templates + AH_TEMPLATE([LINUX], [Linux build define]) + AH_TEMPLATE([WINDOWS], [Windows build define]) + AH_TEMPLATE([OSX], [Mac build define]) + + # bunch of flags + build_linux=no + build_windows=no + build_mac=no + + # detect the target system + case "${host_os}" in + linux*) + CFLAGS="${CFLAGS} -std=c18" + build_linux=yes + ;; + darwin*) + CFLAGS="${CFLAGS} -std=c17" + build_mac=yes + ;; + cygwin*|mingw*) + CFLAGS="${CFLAGS} -std=c18" + build_windows=yes + ;; + *) + AC_MSG_ERROR(["OS $host_os is not supported"]) + ;; + esac + + # set host defines + if test "x$build_linux" = xyes; then + AC_DEFINE([LINUX], [1]) + fi + if test "x$build_windows" = xyes; then + AC_DEFINE([WINDOWS], [1]) + fi + if test "x$build_mac" = xyes; then + AC_DEFINE([OSX], [1]) + fi +]) diff --git a/configure.ac b/configure.ac index 43f8335..b4666e3 100644 --- a/configure.ac +++ b/configure.ac @@ -1,34 +1,21 @@ AC_PREREQ(2.57) AC_INIT([bolthur-serial-communicator], [0.1], [https://github.com/bolthur/serial-communicator/issues], [bolthur-serial-communicator], [https://github.com/bolthur/serial-communicator]) -AC_COPYRIGHT([Copyright (C) 2019 bolthur project]) +AC_COPYRIGHT([Copyright (C) 2019 - 2020 bolthur project]) -AC_CONFIG_AUX_DIR([config]) +AC_CONFIG_AUX_DIR([build-aux/config]) +AC_CONFIG_MACRO_DIR([build-aux/m4]) AC_CANONICAL_HOST AC_CONFIG_SRCDIR([src/main.c]) -AM_INIT_AUTOMAKE([foreign 1.7]) +AM_INIT_AUTOMAKE() AC_CONFIG_HEADERS([include/config.h]) -AM_SILENT_RULES([yes]) - AC_LANG([C]) -# compile flags -CFLAGS="${CFLAGS} -Wall -Wextra -Werror -Wpedantic -Wconversion -O2" - -# Detect the target system -case "${host_os}" in - linux*) - CFLAGS="${CFLAGS} -std=c18" - ;; - darwin*) - CFLAGS="${CFLAGS} -std=c17" - ;; - *) - AC_MSG_ERROR(["OS $host_os is not supported"]) - ;; -esac +# Set flag and host +BOLTHUR_SERIAL_COMMUNICATOR_SET_FLAG +BOLTHUR_SERIAL_COMMUNICATOR_SET_HOST # conftest AC_LANG_CONFTEST([AC_LANG_SOURCE([[const char hw[] = "Hello, World\r\n";]])]) diff --git a/include/endian_wrapper.h b/include/endian_wrapper.h index 7026242..52c0c6e 100644 --- a/include/endian_wrapper.h +++ b/include/endian_wrapper.h @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -20,7 +20,7 @@ #if !defined( ENDIAN_WRAPPER_H ) #define ENDIAN_WRAPPER_H - #if defined( __APPLE__ ) + #if defined( OSX ) #include #define htobe16(x) OSSwapHostToBigInt16(x) @@ -37,6 +37,23 @@ #define htole64(x) OSSwapHostToLittleInt64(x) #define be64toh(x) OSSwapBigToHostInt64(x) #define le64toh(x) OSSwapLittleToHostInt64(x) + #elif defined( WINDOWS ) + #include + + #define htobe16(x) __builtin_bswap16(x) + #define htole16(x) (x) + #define be16toh(x) __builtin_bswap16(x) + #define le16toh(x) (x) + + #define htobe32(x) __builtin_bswap32(x) + #define htole32(x) (x) + #define be32toh(x) __builtin_bswap32(x) + #define le32toh(x) (x) + + #define htobe64(x) __builtin_bswap64(x) + #define htole64(x) (x) + #define be64toh(x) __builtin_bswap64(x) + #define le64toh(x) (x) #else #define __USE_MISC #include diff --git a/include/initrd.h b/include/initrd.h new file mode 100644 index 0000000..1fc8d15 --- /dev/null +++ b/include/initrd.h @@ -0,0 +1,29 @@ + +/** + * Copyright (C) 2019 - 2020 bolthur project. + * + * This file is part of bolthur/serial-communicator. + * + * bolthur/serial-communicator 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. + * + * bolthur/serial-communicator 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 bolthur/serial-communicator. If not, see . + */ + +#if !defined( INITRD_H ) +#define INITRD_H + +#include + +extern void initrd_load( const char*, const char*, uint8_t**, uint32_t*, uint32_t* ); +extern void initrd_rpi_prepare( uint32_t*, uint32_t* ); + +#endif diff --git a/include/kernel.h b/include/kernel.h index d6ffff2..57553d3 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -23,7 +23,7 @@ #include -extern void kernel_load( const char*, const char*, uint8_t**, uint32_t* ); -extern void kernel_rpi_prepare( uint32_t* file_length ); +extern void kernel_load( const char*, const char*, uint8_t**, uint32_t*, uint32_t* ); +extern void kernel_rpi_prepare( uint32_t*, uint32_t* ); #endif diff --git a/include/serial.h b/include/serial.h index a5b2dda..e2c45e1 100644 --- a/include/serial.h +++ b/include/serial.h @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -25,8 +25,15 @@ #include #include -#define INVALID_HANDLE -1 -typedef int serial_handle_t; +#if defined( WINDOWS ) + #include + typedef HANDLE serial_handle_t; + #define INVALID_HANDLE INVALID_HANDLE_VALUE +#else + typedef int serial_handle_t; + #define INVALID_HANDLE -1 +#endif + serial_handle_t serial_open( const char* ); void serial_close( serial_handle_t ); diff --git a/include/type.h b/include/type.h new file mode 100644 index 0000000..f88a7ca --- /dev/null +++ b/include/type.h @@ -0,0 +1,27 @@ + +/** + * Copyright (C) 2019 - 2020 bolthur project. + * + * This file is part of bolthur/serial-communicator. + * + * bolthur/serial-communicator 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. + * + * bolthur/serial-communicator 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 bolthur/serial-communicator. If not, see . + */ + +#if !defined( TYPE_H ) +#define TYPE_H + +#define TYPE_KERNEL 1 +#define TYPE_INITRD 2 + +#endif diff --git a/src/Makefile.am b/src/Makefile.am index e1e34ec..f40081e 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -7,7 +7,9 @@ AM_CFLAGS = -imacros $(top_builddir)/include/config.h -I$(top_srcdir)/include bin_PROGRAMS = bolthur-communicator bolthur_communicator_SOURCES = \ - vendor/rpi/kernel.c \ + platform/rpi/initrd.c \ + platform/rpi/kernel.c \ + initrd.c \ kernel.c \ main.c \ serial.c diff --git a/src/initrd.c b/src/initrd.c new file mode 100644 index 0000000..f9060b4 --- /dev/null +++ b/src/initrd.c @@ -0,0 +1,136 @@ + +/** + * Copyright (C) 2019 - 2020 bolthur project. + * + * This file is part of bolthur/serial-communicator. + * + * bolthur/serial-communicator 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. + * + * bolthur/serial-communicator 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 bolthur/serial-communicator. If not, see . + */ + +#include +#include +#include +#include +#include +#include + +#include "initrd.h" +#include "type.h" + +const struct { + const char* name; + void ( *callback )( uint32_t*, uint32_t* ); +} initrd_lookup_table[] = { + { "initrd_initrd_prepare", &initrd_rpi_prepare }, +}; + +/** + * @brief Internal method calling platform specific prepare + * + * @param machine + * @param file_length + * @param type + */ +static void initrd_prepare( const char* machine, uint32_t* file_length, uint32_t* type ) { + char name[ 80 ]; + + // build prepare function name + strcpy( name, "initrd_" ); + strcat( name, machine ); + strcat( name, "_prepare" ); + + for ( + uint32_t i = 0; + i < ( sizeof( initrd_lookup_table ) / sizeof( initrd_lookup_table[ 0 ] ) ); + i++ + ) { + // skip non matching callbacks or entries without valid callback + if ( + 0 != strcmp( initrd_lookup_table[ i ].name, name ) + || ! initrd_lookup_table[ i ].callback + ) { + continue; + } + + // execute callback + initrd_lookup_table[ i ].callback( file_length, type ); + } +} + + +/** + * @brief Method for loading initial ramdisk + * + * @param machine + * @param path + * @param file_buffer + * @param file_length + * @param type + */ +void initrd_load( const char* machine, const char* path, uint8_t** file_buffer, uint32_t* file_length, uint32_t* type ) { + // variables + FILE *file; + int64_t length; + + // some output + printf( "Appending \"%s\" to kernel for transfer\r\n", path ); + + // open file + file = fopen( path, "rb" ); + // handle error + if ( NULL == file ) { + fprintf( stderr, "Unable to open file %s\r\n", path ); + return; + } + + // go to end of file + if ( 0 != fseek( file, 0, SEEK_END ) ) { + fprintf( stderr, "Unable to get to file end\r\n" ); + fclose( file ); + return; + } + // save length + length = ftell( file ); + if ( -1L == length ) { + fprintf( stderr, "Unable to get file length!\r\n" ); + fclose( file ); + return; + } + // go to start again + if ( 0 != fseek( file, 0, SEEK_SET ) ) { + fprintf( stderr, "Unable to set file pointer back to beginning!\r\n" ); + fclose( file ); + return; + } + + // allocate buffer + *file_buffer = ( uint8_t* )malloc( ( size_t )( length + 1 ) ); + if ( NULL == *file_buffer ) { + fprintf( stderr, "Unable to allocate file buffer!\r\n" ); + fclose( file ); + return; + } + + // read file into buffer + fread( *file_buffer, ( size_t )length, 1, file ); + + // close file + fclose( file ); + + // set length + *file_length = ( uint32_t )length; + *type = TYPE_INITRD; + + initrd_prepare( machine, file_length, type ); +} diff --git a/src/kernel.c b/src/kernel.c index 395882a..05885e7 100644 --- a/src/kernel.c +++ b/src/kernel.c @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -26,21 +26,23 @@ #include #include "kernel.h" +#include "type.h" const struct { const char* name; - void ( *callback )( uint32_t* ); + void ( *callback )( uint32_t*, uint32_t* ); } kernel_lookup_table[] = { { "kernel_rpi_prepare", &kernel_rpi_prepare }, }; /** - * @brief Internal method calling vendor specific prepare + * @brief Internal method calling platform specific prepare * * @param machine * @param file_length + * @param type */ -static void kernel_perpare( const char* machine, uint32_t* file_length ) { +static void kernel_perpare( const char* machine, uint32_t* file_length, uint32_t* type ) { char name[ 80 ]; // build prepare function name @@ -62,7 +64,7 @@ static void kernel_perpare( const char* machine, uint32_t* file_length ) { } // execute callback - kernel_lookup_table[ i ].callback( file_length ); + kernel_lookup_table[ i ].callback( file_length, type ); } } @@ -73,8 +75,9 @@ static void kernel_perpare( const char* machine, uint32_t* file_length ) { * @param path * @param file_buffer * @param file_length + * @param type */ -void kernel_load( const char* machine, const char* path, uint8_t** file_buffer, uint32_t* file_length ) { +void kernel_load( const char* machine, const char* path, uint8_t** file_buffer, uint32_t* file_length, uint32_t* type ) { // variables FILE *file; int64_t length; @@ -111,9 +114,7 @@ void kernel_load( const char* machine, const char* path, uint8_t** file_buffer, } // allocate buffer - *file_buffer = ( uint8_t* )malloc( - ( uint64_t )length + 1 - ); + *file_buffer = ( uint8_t* )malloc( ( size_t )length + 1 ); if ( NULL == *file_buffer ) { fprintf( stderr, "Unable to allocate file buffer!\r\n" ); fclose( file ); @@ -121,14 +122,15 @@ void kernel_load( const char* machine, const char* path, uint8_t** file_buffer, } // read file into buffer - fread( *file_buffer, ( uint64_t )length, 1, file ); + fread( *file_buffer, ( size_t )length, 1, file ); // close file fclose( file ); // set length *file_length = ( uint32_t )length; + *type = TYPE_KERNEL; // execute further prepare - kernel_perpare( machine, file_length ); + kernel_perpare( machine, file_length, type ); } diff --git a/src/main.c b/src/main.c index a3ea7a6..eb17ec2 100644 --- a/src/main.c +++ b/src/main.c @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -26,10 +26,21 @@ #include #include #include -#include +#include #include "serial.h" #include "kernel.h" +#include "initrd.h" + +typedef struct { + const char* name; + char* data; +} argument_data_t; + +#define INDEX_TARGET 0 +#define INDEX_DEVICE 1 +#define INDEX_KERNEL 2 +#define INDEX_INITRD 3 #define SEND_AMOUNT_ONCE 250 @@ -41,12 +52,32 @@ static serial_handle_t handle = 0; /** * @brief file buffer */ -static uint8_t* file_buffer = NULL; +static uint8_t* kernel_buffer = NULL; /** * @brief file length */ -static uint32_t file_length = 0; +static uint32_t kernel_length = 0; + +/** + * @brief file buffer + */ +static uint8_t* initrd_buffer = NULL; + +/** + * @brief file length + */ +static uint32_t initrd_length = 0; + +/** + * @brief argument data + */ +static argument_data_t argument[] = { + { "target", NULL }, + { "device", NULL }, + { "kernel", NULL }, + { "initrd", NULL } +}; /** * @brief Cleanup method on exit @@ -56,8 +87,11 @@ static void cleanup( void ) { serial_close( handle ); // free file buffer if set - if ( NULL != file_buffer ) { - free( file_buffer ); + if ( NULL != kernel_buffer ) { + free( kernel_buffer ); + } + if ( NULL != initrd_buffer ) { + free( initrd_buffer ); } } @@ -132,6 +166,24 @@ static void wait_for_response( void ) { } } +/** + * @brief Helper to print usage + * + * @param name program name + */ +static void print_usage( const char* name ) { + // print example and usage + printf( + "Usage: %s --target --device --kernel [--initrd ]\r\n", + name + ); + printf( + "Example: %s --target rpi --device /dev/ttyUSB0 --kernel kernel.img\r\n", + name + ); + exit( EXIT_FAILURE ); +} + /** * @brief Validate received parameter * @@ -139,14 +191,47 @@ static void wait_for_response( void ) { * @param argv */ static void validate_parameter( int argc, char** argv ) { - // handle not enough parameter - if ( 4 != argc ) { - // print example and usage - printf( "Usage: %s \r\n", argv[ 0 ] ); - printf( "Example: %s rpi /dev/ttyUSB0 kernel.img\r\n", argv[ 0 ] ); + struct option long_option[] = { + { "target", required_argument, 0, 't' }, + { "device", required_argument, 0, 'd' }, + { "kernel", required_argument, 0, 'k' }, + { "initrd", required_argument, 0, 'i' }, + { 0, 0, 0, 0 } + }; + + int opt, long_index, idx; + + while ( -1 != ( opt = getopt_long( argc, argv, "t:d:k:i:", long_option, &long_index ) ) ) { + switch ( opt ) { + case 't': + idx = INDEX_TARGET; + break; + case 'd': + idx = INDEX_DEVICE; + break; + case 'k': + idx = INDEX_KERNEL; + break; + case 'i': + idx = INDEX_INITRD; + break; + default: + printf( "%c", opt ); + print_usage( argv[ 0 ] ); + // idx = -1; + } - // exit with error - exit( EXIT_FAILURE ); + // push back option + argument[ idx ].data = optarg; + } + + // handle missing necessary data + if ( + NULL == argument[ INDEX_TARGET ].data + || NULL == argument[ INDEX_DEVICE ].data + || NULL == argument[ INDEX_KERNEL ].data + ) { + print_usage( argv[ 0 ] ); } } @@ -158,11 +243,12 @@ static void validate_parameter( int argc, char** argv ) { * @return int */ int main( int argc, char** argv ) { - char *device, *file, *target; + char *device, *kernel, *target, *initrd; bool finished = false; - ssize_t written, bytes_received, written_kernel_amount; + ssize_t written, bytes_received, written_kernel_amount, written_initrd_amount; uint8_t buffer; int32_t remaining_size; + uint32_t kernel_type, initrd_type; // initial print of name and version printf( "%s %s\r\n", PACKAGE_NAME, PACKAGE_VERSION ); @@ -172,17 +258,28 @@ int main( int argc, char** argv ) { atexit( cleanup ); // save device and file - target = argv[ 1 ]; - device = argv[ 2 ]; - file = argv[ 3 ]; + target = argument[ INDEX_TARGET ].data; + device = argument[ INDEX_DEVICE ].data; + kernel = argument[ INDEX_KERNEL ].data; + initrd = argument[ INDEX_INITRD ].data; // load file to transfer - kernel_load( target, file, &file_buffer, &file_length ); + kernel_load( target, kernel, &kernel_buffer, &kernel_length, &kernel_type ); // handle error - if ( NULL == file_buffer ) { + if ( NULL == kernel_buffer ) { exit( EXIT_FAILURE ); } + // handle initrd + if ( NULL != initrd ) { + // load initrd + initrd_load( target, initrd, &initrd_buffer, &initrd_length, &initrd_type ); + // handle error + if ( NULL == initrd_buffer ) { + exit( EXIT_FAILURE ); + } + } + while( ! finished ) { // open serial handle handle = serial_open( device ); @@ -202,20 +299,28 @@ int main( int argc, char** argv ) { // wait for breaks from device wait_for_break(); + // send type kernel + printf( "Sending type kernel (%d) to loader!\r\n", kernel_type ); + written = serial_write( handle, &kernel_type, 4 ); + + // wait for ok response from loader + wait_for_response(); + // send kernel size in bytes - printf( "Sending file size to loader!\r\n" ); - written = serial_write( handle, &file_length, 4 ); + printf( "Sending kernel file size ( %d ) to loader!\r\n", kernel_length ); + written = serial_write( handle, &kernel_length, 4 ); // wait for ok response from loader wait_for_response(); // send kernel - remaining_size = ( int32_t )file_length; + printf( "Sending kernel to loader!\r\n" ); + remaining_size = ( int32_t )kernel_length; written = 0; while( remaining_size > 0 ) { // write buffer written_kernel_amount = serial_write( - handle, &file_buffer[ written ], + handle, &kernel_buffer[ written ], SEND_AMOUNT_ONCE > remaining_size ? ( size_t )remaining_size : SEND_AMOUNT_ONCE @@ -235,6 +340,61 @@ int main( int argc, char** argv ) { wait_for_response(); } + // handle initrd + if ( NULL != initrd ) { + // send type initrd + printf( "Sending type initrd ( %d ) to loader!\r\n", initrd_type ); + written = serial_write( handle, &initrd_type, 4 ); + + // wait for ok response from loader + wait_for_response(); + + // send kernel size in bytes + printf( "Sending initrd file size to loader( %d )!\r\n", initrd_length ); + written = serial_write( handle, &initrd_length, 4 ); + + // wait for ok response from loader + wait_for_response(); + + // send initrd + printf( "Sending initrd to loader!\r\n" ); + remaining_size = ( int32_t )initrd_length; + written = 0; + while( remaining_size > 0 ) { + // write buffer + written_initrd_amount = serial_write( + handle, &initrd_buffer[ written ], + SEND_AMOUNT_ONCE > remaining_size + ? ( size_t )remaining_size + : SEND_AMOUNT_ONCE + ); + + // handle error + if ( -1 == written_initrd_amount ) { + printf( "Error while sending kernel to loader!" ); + exit( EXIT_FAILURE ); + } + + // decrement size and increment written + remaining_size -= ( int32_t )written_initrd_amount; + written += written_initrd_amount; + + // wait for ok response from loader + wait_for_response(); + } + } + + printf( "Sending go command to start booting!\r\n" ); + // send go + char go_command[ 2 ] = { "GO" }; + // send command + written = serial_write( handle, go_command, 2 ); + // handle error + if ( -1 == written ) { + printf( "Error while sending command \"go\" loader!" ); + exit( EXIT_FAILURE ); + } + // print serial device output while ( true ) { bytes_received = serial_read( handle, &buffer, 1 ); diff --git a/src/platform/rpi/initrd.c b/src/platform/rpi/initrd.c new file mode 100644 index 0000000..58a879f --- /dev/null +++ b/src/platform/rpi/initrd.c @@ -0,0 +1,33 @@ + +/** + * Copyright (C) 2019 - 2020 bolthur project. + * + * This file is part of bolthur/serial-communicator. + * + * bolthur/serial-communicator 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. + * + * bolthur/serial-communicator 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 bolthur/serial-communicator. If not, see . + */ + +#include +#include "endian_wrapper.h" + +/** + * @brief Method to prepare initrd for raspberry pi + * + * @param file_length + * @param type to prepare + */ +void initrd_rpi_prepare(uint32_t* file_length, uint32_t* type ) { + *file_length = htole32( *file_length ); + *type = htole32( *type ); +} diff --git a/src/vendor/rpi/kernel.c b/src/platform/rpi/kernel.c similarity index 85% rename from src/vendor/rpi/kernel.c rename to src/platform/rpi/kernel.c index cac3fe5..db1f57f 100644 --- a/src/vendor/rpi/kernel.c +++ b/src/platform/rpi/kernel.c @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -25,7 +25,9 @@ * @brief Method to prepare kernel size for raspberry pi * * @param file_length file length to transform + * @param type to prepare */ -void kernel_rpi_prepare( uint32_t* file_length ) { +void kernel_rpi_prepare( uint32_t* file_length, uint32_t* type ) { *file_length = htole32( *file_length ); + *type = htole32( *type ); } diff --git a/src/serial.c b/src/serial.c index 0c15f2b..2253e8d 100644 --- a/src/serial.c +++ b/src/serial.c @@ -1,6 +1,6 @@ /** - * Copyright (C) 2019 bolthur project. + * Copyright (C) 2019 - 2020 bolthur project. * * This file is part of bolthur/serial-communicator. * @@ -23,7 +23,12 @@ #include #include #include -#include + +#if defined( WINDOWS ) + #include +#else + #include +#endif #include "serial.h" @@ -34,65 +39,131 @@ * @return serial_handle_t handle of opened device or -1 on error */ serial_handle_t serial_open( const char* device ) { - // handle to be returned - serial_handle_t handle; - struct termios option; - - // output - printf( "Opening specified device \"%s\"\r\n", device ); - - // open device - handle = open( device, O_RDWR | O_NOCTTY | O_NDELAY ); - if ( -1 == handle ) { - fprintf( - stderr, "Unable to open device %s - %s\r\n", device, strerror( errno ) + #if defined( WINDOWS ) + // handle to be returned + serial_handle_t handle; + DCB configuration; + + // open device + handle = CreateFile( + device, + GENERIC_READ | GENERIC_WRITE, + 0, + NULL, + OPEN_EXISTING, + FILE_FLAG_NO_BUFFERING, + NULL ); - return INVALID_HANDLE; - } - - // check for tty - if ( ! isatty( handle ) ) { - fprintf( stderr, "%s is not a tty\r\n", device ); - close( handle ); - return INVALID_HANDLE; - } - - // get current option from port - if ( 0 > tcgetattr( handle, &option ) ) { - fprintf( stderr, "Unable to get attributes of device\r\n" ); - close( handle ); - return INVALID_HANDLE; - } - - // set polling - option.c_cc[ VTIME ] = 0; - option.c_cc[ VMIN ] = 0; - - // set mode and no input/output/line processing masks - option.c_cflag = CS8 | CREAD | CLOCAL; - option.c_iflag = 0; - option.c_lflag = 0; - option.c_oflag = 0; - - // set baud rate to 115200 - if ( - 0 > cfsetispeed( &option, B115200 ) - || 0 > cfsetospeed( &option, B115200 ) - ) { - fprintf( stderr, "Unable to set baud rate!\r\n" ); - close( handle ); - return INVALID_HANDLE; - } - - // set new option for port - if ( 0 > tcsetattr( handle, TCSANOW, &option ) ) { - fprintf( stderr, "Unable to write attributes!\r\n" ); - close( handle ); - return INVALID_HANDLE; - } - - // finally return handle - return handle; + if ( INVALID_HANDLE == handle ) { + fprintf( + stderr, "Unable to open device %s - %lx\r\n", device, GetLastError() + ); + return INVALID_HANDLE; + } + + // get configuration + if ( 0 == GetCommState( handle, &configuration ) ) { + fprintf( + stderr, "Unable to get configuration of device, %lx\r\n", GetLastError() + ); + CloseHandle( handle ); + return INVALID_HANDLE; + } + + // update configuration + configuration.BaudRate = 115200; + configuration.ByteSize = 8; + configuration.Parity = NOPARITY; + configuration.StopBits = ONESTOPBIT; + + // set configuration + if ( 0 == SetCommState( handle, &configuration ) ) { + fprintf( + stderr, "Unable to set configuration of device, %lx\r\n", GetLastError() + ); + CloseHandle( handle ); + return INVALID_HANDLE; + } + + // prepare timeout configuration + COMMTIMEOUTS timeout; + timeout.ReadIntervalTimeout = 1; + timeout.ReadTotalTimeoutMultiplier = 1; + timeout.ReadTotalTimeoutConstant = 1; + timeout.WriteTotalTimeoutMultiplier = 1; + timeout.WriteTotalTimeoutConstant = 1; + + // set timeout configuration + if ( 0 == SetCommTimeouts( handle, &timeout ) ) { + fprintf( + stderr, "Unable to set timeout of device, %lx\r\n", GetLastError() + ); + CloseHandle( handle ); + return INVALID_HANDLE; + } + + return handle; + #else + // handle to be returned + serial_handle_t handle; + struct termios option; + + // output + printf( "Opening specified device \"%s\"\r\n", device ); + + // open device + handle = open( device, O_RDWR | O_NOCTTY | O_NDELAY ); + if ( INVALID_HANDLE == handle ) { + fprintf( + stderr, "Unable to open device %s - %s\r\n", device, strerror( errno ) + ); + return INVALID_HANDLE; + } + + // check for tty + if ( ! isatty( handle ) ) { + fprintf( stderr, "%s is not a tty\r\n", device ); + close( handle ); + return INVALID_HANDLE; + } + + // get current option from port + if ( 0 > tcgetattr( handle, &option ) ) { + fprintf( stderr, "Unable to get attributes of device\r\n" ); + close( handle ); + return INVALID_HANDLE; + } + + // set polling + option.c_cc[ VTIME ] = 0; + option.c_cc[ VMIN ] = 0; + + // set mode and no input/output/line processing masks + option.c_cflag = CS8 | CREAD | CLOCAL; + option.c_iflag = 0; + option.c_lflag = 0; + option.c_oflag = 0; + + // set baud rate to 115200 + if ( + 0 > cfsetispeed( &option, B115200 ) + || 0 > cfsetospeed( &option, B115200 ) + ) { + fprintf( stderr, "Unable to set baud rate!\r\n" ); + close( handle ); + return INVALID_HANDLE; + } + + // set new option for port + if ( 0 > tcsetattr( handle, TCSANOW, &option ) ) { + fprintf( stderr, "Unable to write attributes!\r\n" ); + close( handle ); + return INVALID_HANDLE; + } + + // finally return handle + return handle; + #endif } /** @@ -102,12 +173,16 @@ serial_handle_t serial_open( const char* device ) { */ void serial_close( serial_handle_t handle ) { // check for invalid handle - if ( 0 >= handle ) { + if ( INVALID_HANDLE == handle ) { return; } // close serial port - close( handle ); + #if defined( WINDOWS ) + CloseHandle( handle ); + #else + close( handle ); + #endif } /** @@ -118,7 +193,21 @@ void serial_close( serial_handle_t handle ) { * @param count */ ssize_t serial_read( serial_handle_t handle, void* buffer, size_t count ) { - return read( handle, buffer, count ); + #if defined( WINDOWS ) + ssize_t val = 0; + // write to serial + int read_val = ReadFile( + handle, buffer, ( DWORD )count, ( LPDWORD )&val, NULL + ); + // handle error + if ( 0 == read_val ) { + fprintf( stderr, "Unable to read from serial: %lx\r\n", GetLastError() ); + } + // return value + return val; + #else + return read( handle, buffer, count ); + #endif } /** @@ -130,5 +219,19 @@ ssize_t serial_read( serial_handle_t handle, void* buffer, size_t count ) { * @return ssize_t */ ssize_t serial_write( serial_handle_t handle, void* buffer, size_t count ) { - return write( handle, buffer, count ); + #if defined( WINDOWS ) + ssize_t val = 0; + // write to serial + int write_val = WriteFile( + handle, buffer, ( DWORD )count, ( LPDWORD )&val, NULL + ); + // handle error + if ( 0 == write_val ) { + fprintf( stderr, "Unable to write to serial: %lx\r\n", GetLastError() ); + } + // return value + return val; + #else + return write( handle, buffer, count ); + #endif }