diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000000..f288702d2fa --- /dev/null +++ b/LICENSE @@ -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/README.md b/README.md new file mode 100644 index 00000000000..35426a9e191 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# flipperzero-gpioreader + +![image info](./gpioreader.png) + +This is a fork of the `gpio` app built into the flipper, with added functionality to read GPIO inputs. + +Supports pulling high or low. + +Does not (yet) support analog reads. + +Installation instructions (Linux): + + - Clone the following repo: https://github.com/flipperdevices/flipperzero-firmware + - Clone this repo into flipperzero-firmware/applications_user + - Plug in your FlipperZero + - Run `./fbt launch_app APPSRC=flipperzero-gpioreader` from within the flipperzero-firmware folder diff --git a/application.fam b/application.fam new file mode 100644 index 00000000000..787bd60d5cd --- /dev/null +++ b/application.fam @@ -0,0 +1,12 @@ +App( + appid="gpioreader2", + name="[GPIO] Input Reader 2", + apptype=FlipperAppType.EXTERNAL, + entry_point="gpio_app", + requires=["gui"], + stack_size=1 * 1024, + order=50, + fap_category="GPIO", + fap_icon="icon.png", + fap_icon_assets="icons", +) diff --git a/gpio_app.c b/gpio_app.c new file mode 100644 index 00000000000..07a79cb8928 --- /dev/null +++ b/gpio_app.c @@ -0,0 +1,111 @@ +#include "gpio_app_i.h" + +#include +#include + +static bool gpio_app_custom_event_callback(void* context, uint32_t event) { + furi_assert(context); + GpioApp* app = context; + return scene_manager_handle_custom_event(app->scene_manager, event); +} + +static bool gpio_app_back_event_callback(void* context) { + furi_assert(context); + GpioApp* app = context; + return scene_manager_handle_back_event(app->scene_manager); +} + +static void gpio_app_tick_event_callback(void* context) { + furi_assert(context); + GpioApp* app = context; + scene_manager_handle_tick_event(app->scene_manager); +} + +GpioApp* gpio_app_alloc() { + GpioApp* app = malloc(sizeof(GpioApp)); + + app->gui = furi_record_open(RECORD_GUI); + + app->view_dispatcher = view_dispatcher_alloc(); + app->scene_manager = scene_manager_alloc(&gpio_scene_handlers, app); + view_dispatcher_enable_queue(app->view_dispatcher); + view_dispatcher_set_event_callback_context(app->view_dispatcher, app); + + view_dispatcher_set_custom_event_callback( + app->view_dispatcher, gpio_app_custom_event_callback); + view_dispatcher_set_navigation_event_callback( + app->view_dispatcher, gpio_app_back_event_callback); + view_dispatcher_set_tick_event_callback( + app->view_dispatcher, gpio_app_tick_event_callback, 100); + + view_dispatcher_attach_to_gui(app->view_dispatcher, app->gui, ViewDispatcherTypeFullscreen); + + app->notifications = furi_record_open(RECORD_NOTIFICATION); + + app->var_item_list = variable_item_list_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, + GpioAppViewVarItemList, + variable_item_list_get_view(app->var_item_list)); + app->gpio_test = gpio_test_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, GpioAppViewGpioTest, gpio_test_get_view(app->gpio_test)); + app->gpio_reader = gpio_reader_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, GpioAppViewGpioReader, gpio_reader_get_view(app->gpio_reader)); + + app->widget = widget_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, GpioAppViewUsbUartCloseRpc, widget_get_view(app->widget)); + + app->gpio_usb_uart = gpio_usb_uart_alloc(); + view_dispatcher_add_view( + app->view_dispatcher, GpioAppViewUsbUart, gpio_usb_uart_get_view(app->gpio_usb_uart)); + + view_dispatcher_add_view( + app->view_dispatcher, + GpioAppViewUsbUartCfg, + variable_item_list_get_view(app->var_item_list)); + + scene_manager_next_scene(app->scene_manager, GpioSceneStart); + + return app; +} + +void gpio_app_free(GpioApp* app) { + furi_assert(app); + + // Views + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewVarItemList); + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewGpioTest); + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewGpioReader); + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewUsbUart); + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewUsbUartCfg); + view_dispatcher_remove_view(app->view_dispatcher, GpioAppViewUsbUartCloseRpc); + variable_item_list_free(app->var_item_list); + widget_free(app->widget); + gpio_test_free(app->gpio_test); + gpio_reader_free(app->gpio_reader); + gpio_usb_uart_free(app->gpio_usb_uart); + + // View dispatcher + view_dispatcher_free(app->view_dispatcher); + scene_manager_free(app->scene_manager); + + // Close records + furi_record_close(RECORD_GUI); + furi_record_close(RECORD_NOTIFICATION); + + free(app); +} + +int32_t gpio_app(void* p) { + UNUSED(p); + GpioApp* gpio_app = gpio_app_alloc(); + + view_dispatcher_run(gpio_app->view_dispatcher); + + gpio_app_free(gpio_app); + + return 0; +} diff --git a/gpio_app.h b/gpio_app.h new file mode 100644 index 00000000000..156ddc9222d --- /dev/null +++ b/gpio_app.h @@ -0,0 +1,11 @@ +#pragma once + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct GpioApp GpioApp; + +#ifdef __cplusplus +} +#endif diff --git a/gpio_app_i.h b/gpio_app_i.h new file mode 100644 index 00000000000..0023d1e508d --- /dev/null +++ b/gpio_app_i.h @@ -0,0 +1,44 @@ +#pragma once + +#include "gpio_app.h" +#include "gpio_item.h" +#include "scenes/gpio_scene.h" +#include "gpio_custom_event.h" +#include "usb_uart_bridge.h" + +#include +#include +#include +#include +#include +#include +#include +#include "views/gpio_test.h" +#include "views/gpio_reader.h" +#include "views/gpio_usb_uart.h" +#include + +struct GpioApp { + Gui* gui; + NotificationApp* notifications; + ViewDispatcher* view_dispatcher; + SceneManager* scene_manager; + Widget* widget; + + VariableItemList* var_item_list; + VariableItem* var_item_flow; + GpioTest* gpio_test; + GpioReader* gpio_reader; + GpioUsbUart* gpio_usb_uart; + UsbUartBridge* usb_uart_bridge; + UsbUartConfig* usb_uart_cfg; +}; + +typedef enum { + GpioAppViewVarItemList, + GpioAppViewGpioTest, + GpioAppViewGpioReader, + GpioAppViewUsbUart, + GpioAppViewUsbUartCfg, + GpioAppViewUsbUartCloseRpc, +} GpioAppView; diff --git a/gpio_custom_event.h b/gpio_custom_event.h new file mode 100644 index 00000000000..f5648e10c1c --- /dev/null +++ b/gpio_custom_event.h @@ -0,0 +1,14 @@ +#pragma once + +typedef enum { + GpioStartEventOtgOff = 0, + GpioStartEventOtgOn, + GpioStartEventManualControl, + GpioStartEventReader, + GpioStartEventUsbUart, + + GpioCustomEventErrorBack, + + GpioUsbUartEventConfig, + GpioUsbUartEventConfigSet, +} GpioCustomEvent; diff --git a/gpio_item.c b/gpio_item.c new file mode 100644 index 00000000000..4d7f056ba2f --- /dev/null +++ b/gpio_item.c @@ -0,0 +1,60 @@ +#include "gpio_item.h" + +#include + +typedef struct { + const char* name; + const GpioPin* pin; +} GpioItem; + +static const GpioItem gpio_item[GPIO_ITEM_COUNT] = { + {"1.2: PA7", &gpio_ext_pa7}, + {"1.3: PA6", &gpio_ext_pa6}, + {"1.4: PA4", &gpio_ext_pa4}, + {"1.5: PB3", &gpio_ext_pb3}, + {"1.6: PB2", &gpio_ext_pb2}, + {"1.7: PC3", &gpio_ext_pc3}, + {"2.7: PC1", &gpio_ext_pc1}, + {"2.8: PC0", &gpio_ext_pc0}, +}; + +void gpio_item_configure_pin(uint8_t index, GpioMode mode, GpioPull pull) { + furi_assert(index < GPIO_ITEM_COUNT); + furi_hal_gpio_write(gpio_item[index].pin, false); + furi_hal_gpio_init(gpio_item[index].pin, mode, pull, GpioSpeedVeryHigh); +} + +void gpio_item_configure_all_pins(GpioMode mode) { + GpioPull pull = GpioPullNo; + if(mode == GpioModeInput) { + pull = GpioPullDown; + } + for(uint8_t i = 0; i < GPIO_ITEM_COUNT; i++) { + gpio_item_configure_pin(i, mode, pull); + } +} + +void gpio_item_set_pin(uint8_t index, bool level) { + furi_assert(index < GPIO_ITEM_COUNT); + furi_hal_gpio_write(gpio_item[index].pin, level); +} + +bool gpio_item_get_pin(uint8_t index) { + furi_assert(index < GPIO_ITEM_COUNT); + return furi_hal_gpio_read(gpio_item[index].pin); +} + +void gpio_item_set_all_pins(bool level) { + for(uint8_t i = 0; i < GPIO_ITEM_COUNT; i++) { + gpio_item_set_pin(i, level); + } +} + +const char* gpio_item_get_pin_name(uint8_t index) { + furi_assert(index < GPIO_ITEM_COUNT + 1); + if(index == GPIO_ITEM_COUNT) { + return "ALL"; + } else { + return gpio_item[index].name; + } +} diff --git a/gpio_item.h b/gpio_item.h new file mode 100644 index 00000000000..fe73e385122 --- /dev/null +++ b/gpio_item.h @@ -0,0 +1,17 @@ +#pragma once + +#include + +#define GPIO_ITEM_COUNT 8 + +void gpio_item_configure_pin(uint8_t index, GpioMode mode, GpioPull pull); + +void gpio_item_configure_all_pins(GpioMode mode); + +void gpio_item_set_pin(uint8_t index, bool level); + +void gpio_item_set_all_pins(bool level); + +const char* gpio_item_get_pin_name(uint8_t index); + +bool gpio_item_get_pin(uint8_t index); diff --git a/gpioreader.png b/gpioreader.png new file mode 100644 index 00000000000..218764e782d Binary files /dev/null and b/gpioreader.png differ diff --git a/icon.png b/icon.png new file mode 100644 index 00000000000..201d033e74e Binary files /dev/null and b/icon.png differ diff --git a/icons/ActiveConnection_50x64.png b/icons/ActiveConnection_50x64.png new file mode 100644 index 00000000000..1d7686dddf8 Binary files /dev/null and b/icons/ActiveConnection_50x64.png differ diff --git a/icons/ArrowUpEmpty_14x15.png b/icons/ArrowUpEmpty_14x15.png new file mode 100644 index 00000000000..261c6d89e3c Binary files /dev/null and b/icons/ArrowUpEmpty_14x15.png differ diff --git a/icons/ArrowUpFilled_14x15.png b/icons/ArrowUpFilled_14x15.png new file mode 100644 index 00000000000..fa35eb2f827 Binary files /dev/null and b/icons/ArrowUpFilled_14x15.png differ diff --git a/img/1.png b/img/1.png new file mode 100644 index 00000000000..31950f5a2f6 Binary files /dev/null and b/img/1.png differ diff --git a/img/2.png b/img/2.png new file mode 100644 index 00000000000..b6846aa0411 Binary files /dev/null and b/img/2.png differ diff --git a/scenes/gpio_scene.c b/scenes/gpio_scene.c new file mode 100644 index 00000000000..d5aa4cbe813 --- /dev/null +++ b/scenes/gpio_scene.c @@ -0,0 +1,30 @@ +#include "gpio_scene.h" + +// Generate scene on_enter handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_enter, +void (*const gpio_scene_on_enter_handlers[])(void*) = { +#include "gpio_scene_config.h" +}; +#undef ADD_SCENE + +// Generate scene on_event handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_event, +bool (*const gpio_scene_on_event_handlers[])(void* context, SceneManagerEvent event) = { +#include "gpio_scene_config.h" +}; +#undef ADD_SCENE + +// Generate scene on_exit handlers array +#define ADD_SCENE(prefix, name, id) prefix##_scene_##name##_on_exit, +void (*const gpio_scene_on_exit_handlers[])(void* context) = { +#include "gpio_scene_config.h" +}; +#undef ADD_SCENE + +// Initialize scene handlers configuration structure +const SceneManagerHandlers gpio_scene_handlers = { + .on_enter_handlers = gpio_scene_on_enter_handlers, + .on_event_handlers = gpio_scene_on_event_handlers, + .on_exit_handlers = gpio_scene_on_exit_handlers, + .scene_num = GpioSceneNum, +}; diff --git a/scenes/gpio_scene.h b/scenes/gpio_scene.h new file mode 100644 index 00000000000..15556c8d548 --- /dev/null +++ b/scenes/gpio_scene.h @@ -0,0 +1,29 @@ +#pragma once + +#include + +// Generate scene id and total number +#define ADD_SCENE(prefix, name, id) GpioScene##id, +typedef enum { +#include "gpio_scene_config.h" + GpioSceneNum, +} GpioScene; +#undef ADD_SCENE + +extern const SceneManagerHandlers gpio_scene_handlers; + +// Generate scene on_enter handlers declaration +#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_enter(void*); +#include "gpio_scene_config.h" +#undef ADD_SCENE + +// Generate scene on_event handlers declaration +#define ADD_SCENE(prefix, name, id) \ + bool prefix##_scene_##name##_on_event(void* context, SceneManagerEvent event); +#include "gpio_scene_config.h" +#undef ADD_SCENE + +// Generate scene on_exit handlers declaration +#define ADD_SCENE(prefix, name, id) void prefix##_scene_##name##_on_exit(void* context); +#include "gpio_scene_config.h" +#undef ADD_SCENE diff --git a/scenes/gpio_scene_config.h b/scenes/gpio_scene_config.h new file mode 100644 index 00000000000..269c32aaf1f --- /dev/null +++ b/scenes/gpio_scene_config.h @@ -0,0 +1,6 @@ +ADD_SCENE(gpio, start, Start) +ADD_SCENE(gpio, test, Test) +ADD_SCENE(gpio, reader, Reader) +ADD_SCENE(gpio, usb_uart, UsbUart) +ADD_SCENE(gpio, usb_uart_cfg, UsbUartCfg) +ADD_SCENE(gpio, usb_uart_close_rpc, UsbUartCloseRpc) diff --git a/scenes/gpio_scene_reader.c b/scenes/gpio_scene_reader.c new file mode 100644 index 00000000000..5995ff253c7 --- /dev/null +++ b/scenes/gpio_scene_reader.c @@ -0,0 +1,30 @@ +#include "../gpio_app_i.h" + +void gpio_scene_reader_ok_callback(InputType type, void* context) { + furi_assert(context); + GpioApp* app = context; + + if(type == InputTypePress) { + notification_message(app->notifications, &sequence_set_green_255); + } else if(type == InputTypeRelease) { + notification_message(app->notifications, &sequence_reset_green); + } +} + +void gpio_scene_reader_on_enter(void* context) { + GpioApp* app = context; + gpio_item_configure_all_pins(GpioModeInput); + gpio_reader_set_ok_callback(app->gpio_reader, gpio_scene_reader_ok_callback, app); + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewGpioReader); +} + +bool gpio_scene_reader_on_event(void* context, SceneManagerEvent event) { + UNUSED(context); + UNUSED(event); + return false; +} + +void gpio_scene_reader_on_exit(void* context) { + UNUSED(context); + gpio_item_configure_all_pins(GpioModeAnalog); +} diff --git a/scenes/gpio_scene_start.c b/scenes/gpio_scene_start.c new file mode 100644 index 00000000000..19d0173fa04 --- /dev/null +++ b/scenes/gpio_scene_start.c @@ -0,0 +1,114 @@ +#include "../gpio_app_i.h" +#include "furi_hal_power.h" +#include "furi_hal_usb.h" +#include + +enum GpioItem { + GpioItemUsbUart, + GpioItemTest, + GpioItemReader, + GpioItemOtg, +}; + +enum GpioOtg { + GpioOtgOff, + GpioOtgOn, + GpioOtgSettingsNum, +}; + +const char* const gpio_otg_text[GpioOtgSettingsNum] = { + "OFF", + "ON", +}; + +static void gpio_scene_start_var_list_enter_callback(void* context, uint32_t index) { + furi_assert(context); + GpioApp* app = context; + if(index == GpioItemTest) { + view_dispatcher_send_custom_event(app->view_dispatcher, GpioStartEventManualControl); + } else if(index == GpioItemUsbUart) { + view_dispatcher_send_custom_event(app->view_dispatcher, GpioStartEventUsbUart); + } else if(index == GpioItemReader) { + view_dispatcher_send_custom_event(app->view_dispatcher, GpioStartEventReader); + } +} + +static void gpio_scene_start_var_list_change_callback(VariableItem* item) { + GpioApp* app = variable_item_get_context(item); + uint8_t index = variable_item_get_current_value_index(item); + + variable_item_set_current_value_text(item, gpio_otg_text[index]); + if(index == GpioOtgOff) { + view_dispatcher_send_custom_event(app->view_dispatcher, GpioStartEventOtgOff); + } else if(index == GpioOtgOn) { + view_dispatcher_send_custom_event(app->view_dispatcher, GpioStartEventOtgOn); + } +} + +void gpio_scene_start_on_enter(void* context) { + GpioApp* app = context; + VariableItemList* var_item_list = app->var_item_list; + + VariableItem* item; + variable_item_list_set_enter_callback( + var_item_list, gpio_scene_start_var_list_enter_callback, app); + + variable_item_list_add(var_item_list, "USB-UART Bridge", 0, NULL, NULL); + + variable_item_list_add(var_item_list, "GPIO Manual Control", 0, NULL, NULL); + + variable_item_list_add(var_item_list, "GPIO Manual Read", 0, NULL, NULL); + + item = variable_item_list_add( + var_item_list, + "5V on GPIO", + GpioOtgSettingsNum, + gpio_scene_start_var_list_change_callback, + app); + if(furi_hal_power_is_otg_enabled()) { + variable_item_set_current_value_index(item, GpioOtgOn); + variable_item_set_current_value_text(item, gpio_otg_text[GpioOtgOn]); + } else { + variable_item_set_current_value_index(item, GpioOtgOff); + variable_item_set_current_value_text(item, gpio_otg_text[GpioOtgOff]); + } + + variable_item_list_set_selected_item( + var_item_list, scene_manager_get_scene_state(app->scene_manager, GpioSceneStart)); + + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewVarItemList); +} + +bool gpio_scene_start_on_event(void* context, SceneManagerEvent event) { + GpioApp* app = context; + bool consumed = false; + + if(event.type == SceneManagerEventTypeCustom) { + if(event.event == GpioStartEventOtgOn) { + furi_hal_power_enable_otg(); + } else if(event.event == GpioStartEventOtgOff) { + furi_hal_power_disable_otg(); + } else if(event.event == GpioStartEventManualControl) { + scene_manager_set_scene_state(app->scene_manager, GpioSceneStart, GpioItemTest); + scene_manager_next_scene(app->scene_manager, GpioSceneTest); + } else if(event.event == GpioStartEventReader) { + scene_manager_set_scene_state(app->scene_manager, GpioSceneStart, GpioItemReader); + scene_manager_next_scene(app->scene_manager, GpioSceneReader); + } else if(event.event == GpioStartEventUsbUart) { + scene_manager_set_scene_state(app->scene_manager, GpioSceneStart, GpioItemUsbUart); + if(!furi_hal_usb_is_locked()) { + dolphin_deed(DolphinDeedGpioUartBridge); + scene_manager_next_scene(app->scene_manager, GpioSceneUsbUart); + } else { + scene_manager_next_scene(app->scene_manager, GpioSceneUsbUartCloseRpc); + } + } + consumed = true; + } + return consumed; +} + +void gpio_scene_start_on_exit(void* context) { + GpioApp* app = context; + variable_item_list_reset(app->var_item_list); +} diff --git a/scenes/gpio_scene_test.c b/scenes/gpio_scene_test.c new file mode 100644 index 00000000000..b015d80902e --- /dev/null +++ b/scenes/gpio_scene_test.c @@ -0,0 +1,30 @@ +#include "../gpio_app_i.h" + +void gpio_scene_test_ok_callback(InputType type, void* context) { + furi_assert(context); + GpioApp* app = context; + + if(type == InputTypePress) { + notification_message(app->notifications, &sequence_set_green_255); + } else if(type == InputTypeRelease) { + notification_message(app->notifications, &sequence_reset_green); + } +} + +void gpio_scene_test_on_enter(void* context) { + GpioApp* app = context; + gpio_item_configure_all_pins(GpioModeOutputPushPull); + gpio_test_set_ok_callback(app->gpio_test, gpio_scene_test_ok_callback, app); + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewGpioTest); +} + +bool gpio_scene_test_on_event(void* context, SceneManagerEvent event) { + UNUSED(context); + UNUSED(event); + return false; +} + +void gpio_scene_test_on_exit(void* context) { + UNUSED(context); + gpio_item_configure_all_pins(GpioModeAnalog); +} diff --git a/scenes/gpio_scene_usb_uart.c b/scenes/gpio_scene_usb_uart.c new file mode 100644 index 00000000000..aa41aaf9878 --- /dev/null +++ b/scenes/gpio_scene_usb_uart.c @@ -0,0 +1,67 @@ +#include "../gpio_app_i.h" +#include "../usb_uart_bridge.h" + +typedef struct { + UsbUartConfig cfg; + UsbUartState state; +} SceneUsbUartBridge; + +static SceneUsbUartBridge* scene_usb_uart; + +void gpio_scene_usb_uart_callback(GpioCustomEvent event, void* context) { + furi_assert(context); + GpioApp* app = context; + view_dispatcher_send_custom_event(app->view_dispatcher, event); +} + +void gpio_scene_usb_uart_on_enter(void* context) { + GpioApp* app = context; + uint32_t prev_state = scene_manager_get_scene_state(app->scene_manager, GpioAppViewUsbUart); + if(prev_state == 0) { + scene_usb_uart = malloc(sizeof(SceneUsbUartBridge)); + scene_usb_uart->cfg.vcp_ch = 0; // TODO: settings load + scene_usb_uart->cfg.uart_ch = 0; + scene_usb_uart->cfg.flow_pins = 0; + scene_usb_uart->cfg.baudrate_mode = 0; + scene_usb_uart->cfg.baudrate = 0; + app->usb_uart_bridge = usb_uart_enable(&scene_usb_uart->cfg); + } + + usb_uart_get_config(app->usb_uart_bridge, &scene_usb_uart->cfg); + usb_uart_get_state(app->usb_uart_bridge, &scene_usb_uart->state); + + gpio_usb_uart_set_callback(app->gpio_usb_uart, gpio_scene_usb_uart_callback, app); + scene_manager_set_scene_state(app->scene_manager, GpioSceneUsbUart, 0); + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewUsbUart); + notification_message(app->notifications, &sequence_display_backlight_enforce_on); +} + +bool gpio_scene_usb_uart_on_event(void* context, SceneManagerEvent event) { + GpioApp* app = context; + if(event.type == SceneManagerEventTypeCustom) { + scene_manager_set_scene_state(app->scene_manager, GpioSceneUsbUart, 1); + scene_manager_next_scene(app->scene_manager, GpioSceneUsbUartCfg); + return true; + } else if(event.type == SceneManagerEventTypeTick) { + uint32_t tx_cnt_last = scene_usb_uart->state.tx_cnt; + uint32_t rx_cnt_last = scene_usb_uart->state.rx_cnt; + usb_uart_get_state(app->usb_uart_bridge, &scene_usb_uart->state); + gpio_usb_uart_update_state( + app->gpio_usb_uart, &scene_usb_uart->cfg, &scene_usb_uart->state); + if(tx_cnt_last != scene_usb_uart->state.tx_cnt) + notification_message(app->notifications, &sequence_blink_blue_10); + if(rx_cnt_last != scene_usb_uart->state.rx_cnt) + notification_message(app->notifications, &sequence_blink_green_10); + } + return false; +} + +void gpio_scene_usb_uart_on_exit(void* context) { + GpioApp* app = context; + uint32_t prev_state = scene_manager_get_scene_state(app->scene_manager, GpioSceneUsbUart); + if(prev_state == 0) { + usb_uart_disable(app->usb_uart_bridge); + free(scene_usb_uart); + } + notification_message(app->notifications, &sequence_display_backlight_enforce_auto); +} diff --git a/scenes/gpio_scene_usb_uart_close_rpc.c b/scenes/gpio_scene_usb_uart_close_rpc.c new file mode 100644 index 00000000000..2cb53cab248 --- /dev/null +++ b/scenes/gpio_scene_usb_uart_close_rpc.c @@ -0,0 +1,41 @@ +#include "../gpio_app_i.h" +#include "../gpio_custom_event.h" + +void gpio_scene_usb_uart_close_rpc_on_enter(void* context) { + GpioApp* app = context; + + widget_add_icon_element(app->widget, 78, 0, &I_ActiveConnection_50x64); + widget_add_string_multiline_element( + app->widget, 3, 2, AlignLeft, AlignTop, FontPrimary, "Connection\nis active!"); + widget_add_string_multiline_element( + app->widget, + 3, + 30, + AlignLeft, + AlignTop, + FontSecondary, + "Disconnect from\nPC or phone to\nuse this function."); + + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewUsbUartCloseRpc); +} + +bool gpio_scene_usb_uart_close_rpc_on_event(void* context, SceneManagerEvent event) { + GpioApp* app = context; + bool consumed = false; + + if(event.type == SceneManagerEventTypeCustom) { + if(event.event == GpioCustomEventErrorBack) { + if(!scene_manager_previous_scene(app->scene_manager)) { + scene_manager_stop(app->scene_manager); + view_dispatcher_stop(app->view_dispatcher); + } + consumed = true; + } + } + return consumed; +} + +void gpio_scene_usb_uart_close_rpc_on_exit(void* context) { + GpioApp* app = context; + widget_reset(app->widget); +} diff --git a/scenes/gpio_scene_usb_uart_config.c b/scenes/gpio_scene_usb_uart_config.c new file mode 100644 index 00000000000..55b04ed67fb --- /dev/null +++ b/scenes/gpio_scene_usb_uart_config.c @@ -0,0 +1,169 @@ +#include "../usb_uart_bridge.h" +#include "../gpio_app_i.h" +#include "furi_hal.h" + +typedef enum { + UsbUartLineIndexVcp, + UsbUartLineIndexBaudrate, + UsbUartLineIndexUart, + UsbUartLineIndexFlow, +} LineIndex; + +static const char* vcp_ch[] = {"0 (CLI)", "1"}; +static const char* uart_ch[] = {"13,14", "15,16"}; +static const char* flow_pins[] = {"None", "2,3", "6,7", "16,15"}; +static const char* baudrate_mode[] = {"Host"}; +static const uint32_t baudrate_list[] = { + 2400, + 9600, + 19200, + 38400, + 57600, + 115200, + 230400, + 460800, + 921600, +}; + +bool gpio_scene_usb_uart_cfg_on_event(void* context, SceneManagerEvent event) { + GpioApp* app = context; + furi_assert(app); + if(event.type == SceneManagerEventTypeCustom) { + if(event.event == GpioUsbUartEventConfigSet) { + usb_uart_set_config(app->usb_uart_bridge, app->usb_uart_cfg); + return true; + } + } + return false; +} + +void line_ensure_flow_invariant(GpioApp* app) { + // GPIO pins PC0, PC1 (16,15) are unavailable for RTS/DTR when LPUART is + // selected. This function enforces that invariant by resetting flow_pins + // to None if it is configured to 16,15 when LPUART is selected. + + uint8_t available_flow_pins = app->usb_uart_cfg->uart_ch == FuriHalUartIdLPUART1 ? 3 : 4; + VariableItem* item = app->var_item_flow; + variable_item_set_values_count(item, available_flow_pins); + + if(app->usb_uart_cfg->flow_pins >= available_flow_pins) { + app->usb_uart_cfg->flow_pins = 0; + + variable_item_set_current_value_index(item, app->usb_uart_cfg->flow_pins); + variable_item_set_current_value_text(item, flow_pins[app->usb_uart_cfg->flow_pins]); + } +} + +static void line_vcp_cb(VariableItem* item) { + GpioApp* app = variable_item_get_context(item); + furi_assert(app); + uint8_t index = variable_item_get_current_value_index(item); + + variable_item_set_current_value_text(item, vcp_ch[index]); + + app->usb_uart_cfg->vcp_ch = index; + view_dispatcher_send_custom_event(app->view_dispatcher, GpioUsbUartEventConfigSet); +} + +static void line_port_cb(VariableItem* item) { + GpioApp* app = variable_item_get_context(item); + furi_assert(app); + uint8_t index = variable_item_get_current_value_index(item); + + variable_item_set_current_value_text(item, uart_ch[index]); + + if(index == 0) + app->usb_uart_cfg->uart_ch = FuriHalUartIdUSART1; + else if(index == 1) + app->usb_uart_cfg->uart_ch = FuriHalUartIdLPUART1; + + line_ensure_flow_invariant(app); + view_dispatcher_send_custom_event(app->view_dispatcher, GpioUsbUartEventConfigSet); +} + +static void line_flow_cb(VariableItem* item) { + GpioApp* app = variable_item_get_context(item); + furi_assert(app); + uint8_t index = variable_item_get_current_value_index(item); + + variable_item_set_current_value_text(item, flow_pins[index]); + + app->usb_uart_cfg->flow_pins = index; + view_dispatcher_send_custom_event(app->view_dispatcher, GpioUsbUartEventConfigSet); +} + +static void line_baudrate_cb(VariableItem* item) { + GpioApp* app = variable_item_get_context(item); + furi_assert(app); + uint8_t index = variable_item_get_current_value_index(item); + + char br_text[8]; + + if(index > 0) { + snprintf(br_text, 7, "%lu", baudrate_list[index - 1]); + variable_item_set_current_value_text(item, br_text); + app->usb_uart_cfg->baudrate = baudrate_list[index - 1]; + } else { + variable_item_set_current_value_text(item, baudrate_mode[index]); + app->usb_uart_cfg->baudrate = 0; + } + app->usb_uart_cfg->baudrate_mode = index; + view_dispatcher_send_custom_event(app->view_dispatcher, GpioUsbUartEventConfigSet); +} + +void gpio_scene_usb_uart_cfg_on_enter(void* context) { + GpioApp* app = context; + furi_assert(app); + VariableItemList* var_item_list = app->var_item_list; + + app->usb_uart_cfg = malloc(sizeof(UsbUartConfig)); + usb_uart_get_config(app->usb_uart_bridge, app->usb_uart_cfg); + + VariableItem* item; + char br_text[8]; + + item = variable_item_list_add(var_item_list, "USB Channel", 2, line_vcp_cb, app); + variable_item_set_current_value_index(item, app->usb_uart_cfg->vcp_ch); + variable_item_set_current_value_text(item, vcp_ch[app->usb_uart_cfg->vcp_ch]); + + item = variable_item_list_add( + var_item_list, + "Baudrate", + sizeof(baudrate_list) / sizeof(baudrate_list[0]) + 1, + line_baudrate_cb, + app); + variable_item_set_current_value_index(item, app->usb_uart_cfg->baudrate_mode); + if(app->usb_uart_cfg->baudrate_mode > 0) { + snprintf(br_text, 7, "%lu", baudrate_list[app->usb_uart_cfg->baudrate_mode - 1]); + variable_item_set_current_value_text(item, br_text); + } else { + variable_item_set_current_value_text( + item, baudrate_mode[app->usb_uart_cfg->baudrate_mode]); + } + + item = variable_item_list_add(var_item_list, "UART Pins", 2, line_port_cb, app); + variable_item_set_current_value_index(item, app->usb_uart_cfg->uart_ch); + variable_item_set_current_value_text(item, uart_ch[app->usb_uart_cfg->uart_ch]); + + item = variable_item_list_add( + var_item_list, "RTS/DTR Pins", COUNT_OF(flow_pins), line_flow_cb, app); + variable_item_set_current_value_index(item, app->usb_uart_cfg->flow_pins); + variable_item_set_current_value_text(item, flow_pins[app->usb_uart_cfg->flow_pins]); + app->var_item_flow = item; + line_ensure_flow_invariant(app); + + variable_item_list_set_selected_item( + var_item_list, scene_manager_get_scene_state(app->scene_manager, GpioAppViewUsbUartCfg)); + + view_dispatcher_switch_to_view(app->view_dispatcher, GpioAppViewUsbUartCfg); +} + +void gpio_scene_usb_uart_cfg_on_exit(void* context) { + GpioApp* app = context; + scene_manager_set_scene_state( + app->scene_manager, + GpioAppViewUsbUartCfg, + variable_item_list_get_selected_item_index(app->var_item_list)); + variable_item_list_reset(app->var_item_list); + free(app->usb_uart_cfg); +} diff --git a/usb_uart_bridge.c b/usb_uart_bridge.c new file mode 100644 index 00000000000..1a82dbdc2e5 --- /dev/null +++ b/usb_uart_bridge.c @@ -0,0 +1,375 @@ +#include "usb_uart_bridge.h" +#include "furi_hal.h" +#include +#include "usb_cdc.h" +#include "cli/cli_vcp.h" +#include +#include "cli/cli.h" + +#define USB_CDC_PKT_LEN CDC_DATA_SZ +#define USB_UART_RX_BUF_SIZE (USB_CDC_PKT_LEN * 5) + +#define USB_CDC_BIT_DTR (1 << 0) +#define USB_CDC_BIT_RTS (1 << 1) + +static const GpioPin* flow_pins[][2] = { + {&gpio_ext_pa7, &gpio_ext_pa6}, // 2, 3 + {&gpio_ext_pb2, &gpio_ext_pc3}, // 6, 7 + {&gpio_ext_pc0, &gpio_ext_pc1}, // 16, 15 +}; + +typedef enum { + WorkerEvtStop = (1 << 0), + WorkerEvtRxDone = (1 << 1), + + WorkerEvtTxStop = (1 << 2), + WorkerEvtCdcRx = (1 << 3), + + WorkerEvtCfgChange = (1 << 4), + + WorkerEvtLineCfgSet = (1 << 5), + WorkerEvtCtrlLineSet = (1 << 6), + +} WorkerEvtFlags; + +#define WORKER_ALL_RX_EVENTS \ + (WorkerEvtStop | WorkerEvtRxDone | WorkerEvtCfgChange | WorkerEvtLineCfgSet | \ + WorkerEvtCtrlLineSet) +#define WORKER_ALL_TX_EVENTS (WorkerEvtTxStop | WorkerEvtCdcRx) + +struct UsbUartBridge { + UsbUartConfig cfg; + UsbUartConfig cfg_new; + + FuriThread* thread; + FuriThread* tx_thread; + + FuriStreamBuffer* rx_stream; + + FuriMutex* usb_mutex; + + FuriSemaphore* tx_sem; + + UsbUartState st; + + FuriApiLock cfg_lock; + + uint8_t rx_buf[USB_CDC_PKT_LEN]; +}; + +static void vcp_on_cdc_tx_complete(void* context); +static void vcp_on_cdc_rx(void* context); +static void vcp_state_callback(void* context, uint8_t state); +static void vcp_on_cdc_control_line(void* context, uint8_t state); +static void vcp_on_line_config(void* context, struct usb_cdc_line_coding* config); + +static const CdcCallbacks cdc_cb = { + vcp_on_cdc_tx_complete, + vcp_on_cdc_rx, + vcp_state_callback, + vcp_on_cdc_control_line, + vcp_on_line_config, +}; + +/* USB UART worker */ + +static int32_t usb_uart_tx_thread(void* context); + +static void usb_uart_on_irq_cb(UartIrqEvent ev, uint8_t data, void* context) { + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + + if(ev == UartIrqEventRXNE) { + furi_stream_buffer_send(usb_uart->rx_stream, &data, 1, 0); + furi_thread_flags_set(furi_thread_get_id(usb_uart->thread), WorkerEvtRxDone); + } +} + +static void usb_uart_vcp_init(UsbUartBridge* usb_uart, uint8_t vcp_ch) { + furi_hal_usb_unlock(); + if(vcp_ch == 0) { + Cli* cli = furi_record_open(RECORD_CLI); + cli_session_close(cli); + furi_record_close(RECORD_CLI); + furi_check(furi_hal_usb_set_config(&usb_cdc_single, NULL) == true); + } else { + furi_check(furi_hal_usb_set_config(&usb_cdc_dual, NULL) == true); + Cli* cli = furi_record_open(RECORD_CLI); + cli_session_open(cli, &cli_vcp); + furi_record_close(RECORD_CLI); + } + furi_hal_cdc_set_callbacks(vcp_ch, (CdcCallbacks*)&cdc_cb, usb_uart); +} + +static void usb_uart_vcp_deinit(UsbUartBridge* usb_uart, uint8_t vcp_ch) { + UNUSED(usb_uart); + furi_hal_cdc_set_callbacks(vcp_ch, NULL, NULL); + if(vcp_ch != 0) { + Cli* cli = furi_record_open(RECORD_CLI); + cli_session_close(cli); + furi_record_close(RECORD_CLI); + } +} + +static void usb_uart_serial_init(UsbUartBridge* usb_uart, uint8_t uart_ch) { + if(uart_ch == FuriHalUartIdUSART1) { + furi_hal_console_disable(); + } else if(uart_ch == FuriHalUartIdLPUART1) { + furi_hal_uart_init(uart_ch, 115200); + } + furi_hal_uart_set_irq_cb(uart_ch, usb_uart_on_irq_cb, usb_uart); +} + +static void usb_uart_serial_deinit(UsbUartBridge* usb_uart, uint8_t uart_ch) { + UNUSED(usb_uart); + furi_hal_uart_set_irq_cb(uart_ch, NULL, NULL); + if(uart_ch == FuriHalUartIdUSART1) + furi_hal_console_enable(); + else if(uart_ch == FuriHalUartIdLPUART1) + furi_hal_uart_deinit(uart_ch); +} + +static void usb_uart_set_baudrate(UsbUartBridge* usb_uart, uint32_t baudrate) { + if(baudrate != 0) { + furi_hal_uart_set_br(usb_uart->cfg.uart_ch, baudrate); + usb_uart->st.baudrate_cur = baudrate; + } else { + struct usb_cdc_line_coding* line_cfg = + furi_hal_cdc_get_port_settings(usb_uart->cfg.vcp_ch); + if(line_cfg->dwDTERate > 0) { + furi_hal_uart_set_br(usb_uart->cfg.uart_ch, line_cfg->dwDTERate); + usb_uart->st.baudrate_cur = line_cfg->dwDTERate; + } + } +} + +static void usb_uart_update_ctrl_lines(UsbUartBridge* usb_uart) { + if(usb_uart->cfg.flow_pins != 0) { + furi_assert((size_t)(usb_uart->cfg.flow_pins - 1) < COUNT_OF(flow_pins)); + uint8_t state = furi_hal_cdc_get_ctrl_line_state(usb_uart->cfg.vcp_ch); + + furi_hal_gpio_write(flow_pins[usb_uart->cfg.flow_pins - 1][0], !(state & USB_CDC_BIT_RTS)); + furi_hal_gpio_write(flow_pins[usb_uart->cfg.flow_pins - 1][1], !(state & USB_CDC_BIT_DTR)); + } +} + +static int32_t usb_uart_worker(void* context) { + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + + memcpy(&usb_uart->cfg, &usb_uart->cfg_new, sizeof(UsbUartConfig)); + + usb_uart->rx_stream = furi_stream_buffer_alloc(USB_UART_RX_BUF_SIZE, 1); + + usb_uart->tx_sem = furi_semaphore_alloc(1, 1); + usb_uart->usb_mutex = furi_mutex_alloc(FuriMutexTypeNormal); + + usb_uart->tx_thread = + furi_thread_alloc_ex("UsbUartTxWorker", 512, usb_uart_tx_thread, usb_uart); + + usb_uart_vcp_init(usb_uart, usb_uart->cfg.vcp_ch); + usb_uart_serial_init(usb_uart, usb_uart->cfg.uart_ch); + usb_uart_set_baudrate(usb_uart, usb_uart->cfg.baudrate); + if(usb_uart->cfg.flow_pins != 0) { + furi_assert((size_t)(usb_uart->cfg.flow_pins - 1) < COUNT_OF(flow_pins)); + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg.flow_pins - 1][0], GpioModeOutputPushPull); + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg.flow_pins - 1][1], GpioModeOutputPushPull); + usb_uart_update_ctrl_lines(usb_uart); + } + + furi_thread_flags_set(furi_thread_get_id(usb_uart->tx_thread), WorkerEvtCdcRx); + + furi_thread_start(usb_uart->tx_thread); + + while(1) { + uint32_t events = + furi_thread_flags_wait(WORKER_ALL_RX_EVENTS, FuriFlagWaitAny, FuriWaitForever); + furi_check(!(events & FuriFlagError)); + if(events & WorkerEvtStop) break; + if(events & WorkerEvtRxDone) { + size_t len = furi_stream_buffer_receive( + usb_uart->rx_stream, usb_uart->rx_buf, USB_CDC_PKT_LEN, 0); + if(len > 0) { + if(furi_semaphore_acquire(usb_uart->tx_sem, 100) == FuriStatusOk) { + usb_uart->st.rx_cnt += len; + furi_check( + furi_mutex_acquire(usb_uart->usb_mutex, FuriWaitForever) == FuriStatusOk); + furi_hal_cdc_send(usb_uart->cfg.vcp_ch, usb_uart->rx_buf, len); + furi_check(furi_mutex_release(usb_uart->usb_mutex) == FuriStatusOk); + } else { + furi_stream_buffer_reset(usb_uart->rx_stream); + } + } + } + if(events & WorkerEvtCfgChange) { + if(usb_uart->cfg.vcp_ch != usb_uart->cfg_new.vcp_ch) { + furi_thread_flags_set(furi_thread_get_id(usb_uart->tx_thread), WorkerEvtTxStop); + furi_thread_join(usb_uart->tx_thread); + + usb_uart_vcp_deinit(usb_uart, usb_uart->cfg.vcp_ch); + usb_uart_vcp_init(usb_uart, usb_uart->cfg_new.vcp_ch); + + usb_uart->cfg.vcp_ch = usb_uart->cfg_new.vcp_ch; + furi_thread_start(usb_uart->tx_thread); + events |= WorkerEvtCtrlLineSet; + events |= WorkerEvtLineCfgSet; + } + if(usb_uart->cfg.uart_ch != usb_uart->cfg_new.uart_ch) { + furi_thread_flags_set(furi_thread_get_id(usb_uart->tx_thread), WorkerEvtTxStop); + furi_thread_join(usb_uart->tx_thread); + + usb_uart_serial_deinit(usb_uart, usb_uart->cfg.uart_ch); + usb_uart_serial_init(usb_uart, usb_uart->cfg_new.uart_ch); + + usb_uart->cfg.uart_ch = usb_uart->cfg_new.uart_ch; + usb_uart_set_baudrate(usb_uart, usb_uart->cfg.baudrate); + + furi_thread_start(usb_uart->tx_thread); + } + if(usb_uart->cfg.baudrate != usb_uart->cfg_new.baudrate) { + usb_uart_set_baudrate(usb_uart, usb_uart->cfg_new.baudrate); + usb_uart->cfg.baudrate = usb_uart->cfg_new.baudrate; + } + if(usb_uart->cfg.flow_pins != usb_uart->cfg_new.flow_pins) { + if(usb_uart->cfg.flow_pins != 0) { + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg.flow_pins - 1][0], GpioModeAnalog); + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg.flow_pins - 1][1], GpioModeAnalog); + } + if(usb_uart->cfg_new.flow_pins != 0) { + furi_assert((size_t)(usb_uart->cfg_new.flow_pins - 1) < COUNT_OF(flow_pins)); + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg_new.flow_pins - 1][0], GpioModeOutputPushPull); + furi_hal_gpio_init_simple( + flow_pins[usb_uart->cfg_new.flow_pins - 1][1], GpioModeOutputPushPull); + } + usb_uart->cfg.flow_pins = usb_uart->cfg_new.flow_pins; + events |= WorkerEvtCtrlLineSet; + } + api_lock_unlock(usb_uart->cfg_lock); + } + if(events & WorkerEvtLineCfgSet) { + if(usb_uart->cfg.baudrate == 0) + usb_uart_set_baudrate(usb_uart, usb_uart->cfg.baudrate); + } + if(events & WorkerEvtCtrlLineSet) { + usb_uart_update_ctrl_lines(usb_uart); + } + } + usb_uart_vcp_deinit(usb_uart, usb_uart->cfg.vcp_ch); + usb_uart_serial_deinit(usb_uart, usb_uart->cfg.uart_ch); + + if(usb_uart->cfg.flow_pins != 0) { + furi_hal_gpio_init_simple(flow_pins[usb_uart->cfg.flow_pins - 1][0], GpioModeAnalog); + furi_hal_gpio_init_simple(flow_pins[usb_uart->cfg.flow_pins - 1][1], GpioModeAnalog); + } + + furi_thread_flags_set(furi_thread_get_id(usb_uart->tx_thread), WorkerEvtTxStop); + furi_thread_join(usb_uart->tx_thread); + furi_thread_free(usb_uart->tx_thread); + + furi_stream_buffer_free(usb_uart->rx_stream); + furi_mutex_free(usb_uart->usb_mutex); + furi_semaphore_free(usb_uart->tx_sem); + + furi_hal_usb_unlock(); + furi_check(furi_hal_usb_set_config(&usb_cdc_single, NULL) == true); + Cli* cli = furi_record_open(RECORD_CLI); + cli_session_open(cli, &cli_vcp); + furi_record_close(RECORD_CLI); + + return 0; +} + +static int32_t usb_uart_tx_thread(void* context) { + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + + uint8_t data[USB_CDC_PKT_LEN]; + while(1) { + uint32_t events = + furi_thread_flags_wait(WORKER_ALL_TX_EVENTS, FuriFlagWaitAny, FuriWaitForever); + furi_check(!(events & FuriFlagError)); + if(events & WorkerEvtTxStop) break; + if(events & WorkerEvtCdcRx) { + furi_check(furi_mutex_acquire(usb_uart->usb_mutex, FuriWaitForever) == FuriStatusOk); + size_t len = furi_hal_cdc_receive(usb_uart->cfg.vcp_ch, data, USB_CDC_PKT_LEN); + furi_check(furi_mutex_release(usb_uart->usb_mutex) == FuriStatusOk); + + if(len > 0) { + usb_uart->st.tx_cnt += len; + furi_hal_uart_tx(usb_uart->cfg.uart_ch, data, len); + } + } + } + return 0; +} + +/* VCP callbacks */ + +static void vcp_on_cdc_tx_complete(void* context) { + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + furi_semaphore_release(usb_uart->tx_sem); +} + +static void vcp_on_cdc_rx(void* context) { + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + furi_thread_flags_set(furi_thread_get_id(usb_uart->tx_thread), WorkerEvtCdcRx); +} + +static void vcp_state_callback(void* context, uint8_t state) { + UNUSED(context); + UNUSED(state); +} + +static void vcp_on_cdc_control_line(void* context, uint8_t state) { + UNUSED(state); + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + furi_thread_flags_set(furi_thread_get_id(usb_uart->thread), WorkerEvtCtrlLineSet); +} + +static void vcp_on_line_config(void* context, struct usb_cdc_line_coding* config) { + UNUSED(config); + UsbUartBridge* usb_uart = (UsbUartBridge*)context; + furi_thread_flags_set(furi_thread_get_id(usb_uart->thread), WorkerEvtLineCfgSet); +} + +UsbUartBridge* usb_uart_enable(UsbUartConfig* cfg) { + UsbUartBridge* usb_uart = malloc(sizeof(UsbUartBridge)); + + memcpy(&(usb_uart->cfg_new), cfg, sizeof(UsbUartConfig)); + + usb_uart->thread = furi_thread_alloc_ex("UsbUartWorker", 1024, usb_uart_worker, usb_uart); + + furi_thread_start(usb_uart->thread); + return usb_uart; +} + +void usb_uart_disable(UsbUartBridge* usb_uart) { + furi_assert(usb_uart); + furi_thread_flags_set(furi_thread_get_id(usb_uart->thread), WorkerEvtStop); + furi_thread_join(usb_uart->thread); + furi_thread_free(usb_uart->thread); + free(usb_uart); +} + +void usb_uart_set_config(UsbUartBridge* usb_uart, UsbUartConfig* cfg) { + furi_assert(usb_uart); + furi_assert(cfg); + usb_uart->cfg_lock = api_lock_alloc_locked(); + memcpy(&(usb_uart->cfg_new), cfg, sizeof(UsbUartConfig)); + furi_thread_flags_set(furi_thread_get_id(usb_uart->thread), WorkerEvtCfgChange); + api_lock_wait_unlock_and_free(usb_uart->cfg_lock); +} + +void usb_uart_get_config(UsbUartBridge* usb_uart, UsbUartConfig* cfg) { + furi_assert(usb_uart); + furi_assert(cfg); + memcpy(cfg, &(usb_uart->cfg_new), sizeof(UsbUartConfig)); +} + +void usb_uart_get_state(UsbUartBridge* usb_uart, UsbUartState* st) { + furi_assert(usb_uart); + furi_assert(st); + memcpy(st, &(usb_uart->st), sizeof(UsbUartState)); +} diff --git a/usb_uart_bridge.h b/usb_uart_bridge.h new file mode 100644 index 00000000000..b456c3cc4e5 --- /dev/null +++ b/usb_uart_bridge.h @@ -0,0 +1,30 @@ +#pragma once + +#include +#include + +typedef struct UsbUartBridge UsbUartBridge; + +typedef struct { + uint8_t vcp_ch; + uint8_t uart_ch; + uint8_t flow_pins; + uint8_t baudrate_mode; + uint32_t baudrate; +} UsbUartConfig; + +typedef struct { + uint32_t rx_cnt; + uint32_t tx_cnt; + uint32_t baudrate_cur; +} UsbUartState; + +UsbUartBridge* usb_uart_enable(UsbUartConfig* cfg); + +void usb_uart_disable(UsbUartBridge* usb_uart); + +void usb_uart_set_config(UsbUartBridge* usb_uart, UsbUartConfig* cfg); + +void usb_uart_get_config(UsbUartBridge* usb_uart, UsbUartConfig* cfg); + +void usb_uart_get_state(UsbUartBridge* usb_uart, UsbUartState* st); diff --git a/views/gpio_reader.c b/views/gpio_reader.c new file mode 100644 index 00000000000..4b3a18f8e41 --- /dev/null +++ b/views/gpio_reader.c @@ -0,0 +1,160 @@ +#include "gpio_reader.h" +#include "../gpio_item.h" + +#include +#include + +struct GpioReader { + View* view; + GpioReaderOkCallback callback; + void* context; +}; + +typedef struct { + uint8_t pin_idx; + bool pullUp[GPIO_ITEM_COUNT]; +} GpioReaderModel; + +static bool gpio_reader_process_ok(GpioReader* gpio_reader, InputEvent* event); +static bool gpio_reader_process_left(GpioReader* gpio_reader); +static bool gpio_reader_process_right(GpioReader* gpio_reader); + +static void gpio_reader_draw_callback(Canvas* canvas, void* _model) { + GpioReaderModel* model = _model; + canvas_set_font(canvas, FontPrimary); + elements_multiline_text_aligned(canvas, 64, 2, AlignCenter, AlignTop, "GPIO Reader"); + canvas_set_font(canvas, FontSecondary); + elements_multiline_text_aligned( + canvas, 64, 16, AlignCenter, AlignTop, "A7 A6 A4 B3 B2 C3 C1 C0"); + elements_multiline_text_aligned(canvas, 64, 40, AlignCenter, AlignTop, "Pull Up"); + int charOffset = 10; + for(uint8_t i = 0; i < GPIO_ITEM_COUNT; i++) { + bool high = gpio_item_get_pin(i); + if(high) { + elements_multiline_text_aligned(canvas, charOffset, 25, AlignCenter, AlignTop, "1"); + } else { + elements_multiline_text_aligned(canvas, charOffset, 25, AlignCenter, AlignTop, "0"); + } + + if(model->pullUp[i]) { + elements_multiline_text_aligned(canvas, charOffset, 50, AlignCenter, AlignTop, "1"); + } else { + elements_multiline_text_aligned(canvas, charOffset, 50, AlignCenter, AlignTop, "0"); + } + if(i == model->pin_idx) { + elements_multiline_text_aligned(canvas, charOffset, 53, AlignCenter, AlignTop, "_"); + } + + charOffset += 16; + } + //~ free(charOffset); +} + +static bool gpio_reader_input_callback(InputEvent* event, void* context) { + furi_assert(context); + GpioReader* gpio_reader = context; + bool consumed = false; + + if(event->type == InputTypeShort) { + if(event->key == InputKeyRight) { + consumed = gpio_reader_process_right(gpio_reader); + } else if(event->key == InputKeyLeft) { + consumed = gpio_reader_process_left(gpio_reader); + } + } else if(event->key == InputKeyOk) { + consumed = gpio_reader_process_ok(gpio_reader, event); + } + + return consumed; +} + +static bool gpio_reader_process_left(GpioReader* gpio_reader) { + with_view_model( + gpio_reader->view, + GpioReaderModel * model, + { + if(model->pin_idx) { + model->pin_idx--; + } + }, + true); + return true; +} + +static bool gpio_reader_process_right(GpioReader* gpio_reader) { + with_view_model( + gpio_reader->view, + GpioReaderModel * model, + { + if(model->pin_idx < GPIO_ITEM_COUNT - 1) { + model->pin_idx++; + } + }, + true); + return true; +} + +static bool gpio_reader_process_ok(GpioReader* gpio_reader, InputEvent* event) { + bool consumed = false; + + with_view_model( + gpio_reader->view, + GpioReaderModel * model, + { + if(event->type == InputTypePress) { + if(model->pullUp[model->pin_idx]) { + gpio_item_configure_pin(model->pin_idx, GpioModeInput, GpioPullDown); + model->pullUp[model->pin_idx] = 0; + consumed = true; + } else { + gpio_item_configure_pin(model->pin_idx, GpioModeInput, GpioPullUp); + model->pullUp[model->pin_idx] = 1; + consumed = true; + } + } + gpio_reader->callback(event->type, gpio_reader->context); + }, + true); + + return consumed; +} + +GpioReader* gpio_reader_alloc() { + GpioReader* gpio_reader = malloc(sizeof(GpioReader)); + + gpio_reader->view = view_alloc(); + view_allocate_model(gpio_reader->view, ViewModelTypeLocking, sizeof(GpioReaderModel)); + view_set_context(gpio_reader->view, gpio_reader); + view_set_draw_callback(gpio_reader->view, gpio_reader_draw_callback); + view_set_input_callback(gpio_reader->view, gpio_reader_input_callback); + + return gpio_reader; +} + +void gpio_reader_free(GpioReader* gpio_reader) { + furi_assert(gpio_reader); + view_free(gpio_reader->view); + free(gpio_reader); +} + +View* gpio_reader_get_view(GpioReader* gpio_reader) { + furi_assert(gpio_reader); + return gpio_reader->view; +} + +void gpio_reader_set_ok_callback( + GpioReader* gpio_reader, + GpioReaderOkCallback callback, + void* context) { + furi_assert(gpio_reader); + furi_assert(callback); + with_view_model( + gpio_reader->view, + GpioReaderModel * model, + { + UNUSED(model); + gpio_reader->callback = callback; + gpio_reader->context = context; + }, + false); +} diff --git a/views/gpio_reader.h b/views/gpio_reader.h new file mode 100644 index 00000000000..a59618d57ca --- /dev/null +++ b/views/gpio_reader.h @@ -0,0 +1,17 @@ +#pragma once + +#include + +typedef struct GpioReader GpioReader; +typedef void (*GpioReaderOkCallback)(InputType type, void* context); + +GpioReader* gpio_reader_alloc(); + +void gpio_reader_free(GpioReader* gpio_reader); + +View* gpio_reader_get_view(GpioReader* gpio_reader); + +void gpio_reader_set_ok_callback( + GpioReader* gpio_reader, + GpioReaderOkCallback callback, + void* context); diff --git a/views/gpio_test.c b/views/gpio_test.c new file mode 100644 index 00000000000..69dc0f67bfe --- /dev/null +++ b/views/gpio_test.c @@ -0,0 +1,139 @@ +#include "gpio_test.h" +#include "../gpio_item.h" + +#include + +struct GpioTest { + View* view; + GpioTestOkCallback callback; + void* context; +}; + +typedef struct { + uint8_t pin_idx; +} GpioTestModel; + +static bool gpio_test_process_left(GpioTest* gpio_test); +static bool gpio_test_process_right(GpioTest* gpio_test); +static bool gpio_test_process_ok(GpioTest* gpio_test, InputEvent* event); + +static void gpio_test_draw_callback(Canvas* canvas, void* _model) { + GpioTestModel* model = _model; + canvas_set_font(canvas, FontPrimary); + elements_multiline_text_aligned(canvas, 64, 2, AlignCenter, AlignTop, "GPIO Output Mode Test"); + canvas_set_font(canvas, FontSecondary); + elements_multiline_text_aligned( + canvas, 64, 16, AlignCenter, AlignTop, "Press < or > to change pin"); + elements_multiline_text_aligned( + canvas, 64, 32, AlignCenter, AlignTop, gpio_item_get_pin_name(model->pin_idx)); +} + +static bool gpio_test_input_callback(InputEvent* event, void* context) { + furi_assert(context); + GpioTest* gpio_test = context; + bool consumed = false; + + if(event->type == InputTypeShort) { + if(event->key == InputKeyRight) { + consumed = gpio_test_process_right(gpio_test); + } else if(event->key == InputKeyLeft) { + consumed = gpio_test_process_left(gpio_test); + } + } else if(event->key == InputKeyOk) { + consumed = gpio_test_process_ok(gpio_test, event); + } + + return consumed; +} + +static bool gpio_test_process_left(GpioTest* gpio_test) { + with_view_model( + gpio_test->view, + GpioTestModel * model, + { + if(model->pin_idx) { + model->pin_idx--; + } + }, + true); + return true; +} + +static bool gpio_test_process_right(GpioTest* gpio_test) { + with_view_model( + gpio_test->view, + GpioTestModel * model, + { + if(model->pin_idx < GPIO_ITEM_COUNT) { + model->pin_idx++; + } + }, + true); + return true; +} + +static bool gpio_test_process_ok(GpioTest* gpio_test, InputEvent* event) { + bool consumed = false; + + with_view_model( + gpio_test->view, + GpioTestModel * model, + { + if(event->type == InputTypePress) { + if(model->pin_idx < GPIO_ITEM_COUNT) { + gpio_item_set_pin(model->pin_idx, true); + } else { + gpio_item_set_all_pins(true); + } + consumed = true; + } else if(event->type == InputTypeRelease) { + if(model->pin_idx < GPIO_ITEM_COUNT) { + gpio_item_set_pin(model->pin_idx, false); + } else { + gpio_item_set_all_pins(false); + } + consumed = true; + } + gpio_test->callback(event->type, gpio_test->context); + }, + true); + + return consumed; +} + +GpioTest* gpio_test_alloc() { + GpioTest* gpio_test = malloc(sizeof(GpioTest)); + + gpio_test->view = view_alloc(); + view_allocate_model(gpio_test->view, ViewModelTypeLocking, sizeof(GpioTestModel)); + view_set_context(gpio_test->view, gpio_test); + view_set_draw_callback(gpio_test->view, gpio_test_draw_callback); + view_set_input_callback(gpio_test->view, gpio_test_input_callback); + + return gpio_test; +} + +void gpio_test_free(GpioTest* gpio_test) { + furi_assert(gpio_test); + view_free(gpio_test->view); + free(gpio_test); +} + +View* gpio_test_get_view(GpioTest* gpio_test) { + furi_assert(gpio_test); + return gpio_test->view; +} + +void gpio_test_set_ok_callback(GpioTest* gpio_test, GpioTestOkCallback callback, void* context) { + furi_assert(gpio_test); + furi_assert(callback); + with_view_model( + gpio_test->view, + GpioTestModel * model, + { + UNUSED(model); + gpio_test->callback = callback; + gpio_test->context = context; + }, + false); +} diff --git a/views/gpio_test.h b/views/gpio_test.h new file mode 100644 index 00000000000..5cbd11e82cf --- /dev/null +++ b/views/gpio_test.h @@ -0,0 +1,14 @@ +#pragma once + +#include + +typedef struct GpioTest GpioTest; +typedef void (*GpioTestOkCallback)(InputType type, void* context); + +GpioTest* gpio_test_alloc(); + +void gpio_test_free(GpioTest* gpio_test); + +View* gpio_test_get_view(GpioTest* gpio_test); + +void gpio_test_set_ok_callback(GpioTest* gpio_test, GpioTestOkCallback callback, void* context); diff --git a/views/gpio_usb_uart.c b/views/gpio_usb_uart.c new file mode 100644 index 00000000000..14f8c12fe9a --- /dev/null +++ b/views/gpio_usb_uart.c @@ -0,0 +1,161 @@ +#include "../usb_uart_bridge.h" +#include "../gpio_app_i.h" +#include "furi_hal.h" +#include + +struct GpioUsbUart { + View* view; + GpioUsbUartCallback callback; + void* context; +}; + +typedef struct { + uint32_t baudrate; + uint32_t tx_cnt; + uint32_t rx_cnt; + uint8_t vcp_port; + uint8_t tx_pin; + uint8_t rx_pin; + bool tx_active; + bool rx_active; +} GpioUsbUartModel; + +static void gpio_usb_uart_draw_callback(Canvas* canvas, void* _model) { + GpioUsbUartModel* model = _model; + char temp_str[18]; + elements_button_left(canvas, "Config"); + canvas_draw_line(canvas, 2, 10, 125, 10); + canvas_draw_line(canvas, 44, 52, 123, 52); + + canvas_set_font(canvas, FontPrimary); + canvas_draw_str(canvas, 2, 9, "USB Serial"); + canvas_draw_str(canvas, 3, 25, "TX:"); + canvas_draw_str(canvas, 3, 42, "RX:"); + + canvas_set_font(canvas, FontSecondary); + snprintf(temp_str, 18, "COM PORT:%u", model->vcp_port); + canvas_draw_str_aligned(canvas, 126, 8, AlignRight, AlignBottom, temp_str); + snprintf(temp_str, 18, "Pin %u", model->tx_pin); + canvas_draw_str(canvas, 22, 25, temp_str); + snprintf(temp_str, 18, "Pin %u", model->rx_pin); + canvas_draw_str(canvas, 22, 42, temp_str); + + if(model->baudrate == 0) + snprintf(temp_str, 18, "Baud: ????"); + else + snprintf(temp_str, 18, "Baud: %lu", model->baudrate); + canvas_draw_str(canvas, 45, 62, temp_str); + + if(model->tx_cnt < 100000000) { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_aligned(canvas, 127, 24, AlignRight, AlignBottom, "B."); + canvas_set_font(canvas, FontKeyboard); + snprintf(temp_str, 18, "%lu", model->tx_cnt); + canvas_draw_str_aligned(canvas, 116, 24, AlignRight, AlignBottom, temp_str); + } else { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_aligned(canvas, 127, 24, AlignRight, AlignBottom, "KiB."); + canvas_set_font(canvas, FontKeyboard); + snprintf(temp_str, 18, "%lu", model->tx_cnt / 1024); + canvas_draw_str_aligned(canvas, 111, 24, AlignRight, AlignBottom, temp_str); + } + + if(model->rx_cnt < 100000000) { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_aligned(canvas, 127, 41, AlignRight, AlignBottom, "B."); + canvas_set_font(canvas, FontKeyboard); + snprintf(temp_str, 18, "%lu", model->rx_cnt); + canvas_draw_str_aligned(canvas, 116, 41, AlignRight, AlignBottom, temp_str); + } else { + canvas_set_font(canvas, FontSecondary); + canvas_draw_str_aligned(canvas, 127, 41, AlignRight, AlignBottom, "KiB."); + canvas_set_font(canvas, FontKeyboard); + snprintf(temp_str, 18, "%lu", model->rx_cnt / 1024); + canvas_draw_str_aligned(canvas, 111, 41, AlignRight, AlignBottom, temp_str); + } + + if(model->tx_active) + canvas_draw_icon(canvas, 48, 14, &I_ArrowUpFilled_14x15); + else + canvas_draw_icon(canvas, 48, 14, &I_ArrowUpEmpty_14x15); + + if(model->rx_active) + canvas_draw_icon_ex(canvas, 48, 34, &I_ArrowUpFilled_14x15, IconRotation180); + else + canvas_draw_icon_ex(canvas, 48, 34, &I_ArrowUpEmpty_14x15, IconRotation180); +} + +static bool gpio_usb_uart_input_callback(InputEvent* event, void* context) { + furi_assert(context); + GpioUsbUart* usb_uart = context; + bool consumed = false; + + if(event->type == InputTypeShort) { + if(event->key == InputKeyLeft) { + consumed = true; + furi_assert(usb_uart->callback); + usb_uart->callback(GpioUsbUartEventConfig, usb_uart->context); + } + } + + return consumed; +} + +GpioUsbUart* gpio_usb_uart_alloc() { + GpioUsbUart* usb_uart = malloc(sizeof(GpioUsbUart)); + + usb_uart->view = view_alloc(); + view_allocate_model(usb_uart->view, ViewModelTypeLocking, sizeof(GpioUsbUartModel)); + view_set_context(usb_uart->view, usb_uart); + view_set_draw_callback(usb_uart->view, gpio_usb_uart_draw_callback); + view_set_input_callback(usb_uart->view, gpio_usb_uart_input_callback); + + return usb_uart; +} + +void gpio_usb_uart_free(GpioUsbUart* usb_uart) { + furi_assert(usb_uart); + view_free(usb_uart->view); + free(usb_uart); +} + +View* gpio_usb_uart_get_view(GpioUsbUart* usb_uart) { + furi_assert(usb_uart); + return usb_uart->view; +} + +void gpio_usb_uart_set_callback(GpioUsbUart* usb_uart, GpioUsbUartCallback callback, void* context) { + furi_assert(usb_uart); + furi_assert(callback); + + with_view_model( + usb_uart->view, + GpioUsbUartModel * model, + { + UNUSED(model); + usb_uart->callback = callback; + usb_uart->context = context; + }, + false); +} + +void gpio_usb_uart_update_state(GpioUsbUart* instance, UsbUartConfig* cfg, UsbUartState* st) { + furi_assert(instance); + furi_assert(cfg); + furi_assert(st); + + with_view_model( + instance->view, + GpioUsbUartModel * model, + { + model->baudrate = st->baudrate_cur; + model->vcp_port = cfg->vcp_ch; + model->tx_pin = (cfg->uart_ch == 0) ? (13) : (15); + model->rx_pin = (cfg->uart_ch == 0) ? (14) : (16); + model->tx_active = (model->tx_cnt != st->tx_cnt); + model->rx_active = (model->rx_cnt != st->rx_cnt); + model->tx_cnt = st->tx_cnt; + model->rx_cnt = st->rx_cnt; + }, + true); +} diff --git a/views/gpio_usb_uart.h b/views/gpio_usb_uart.h new file mode 100644 index 00000000000..854b51f8d7a --- /dev/null +++ b/views/gpio_usb_uart.h @@ -0,0 +1,18 @@ +#pragma once + +#include +#include "../gpio_custom_event.h" +#include "../usb_uart_bridge.h" + +typedef struct GpioUsbUart GpioUsbUart; +typedef void (*GpioUsbUartCallback)(GpioCustomEvent event, void* context); + +GpioUsbUart* gpio_usb_uart_alloc(); + +void gpio_usb_uart_free(GpioUsbUart* usb_uart); + +View* gpio_usb_uart_get_view(GpioUsbUart* usb_uart); + +void gpio_usb_uart_set_callback(GpioUsbUart* usb_uart, GpioUsbUartCallback callback, void* context); + +void gpio_usb_uart_update_state(GpioUsbUart* instance, UsbUartConfig* cfg, UsbUartState* st);