From: Uwe Hermann Date: Fri, 30 Dec 2011 10:23:22 +0000 (+0100) Subject: Rename sub-project dirs to their correct name. X-Git-Tag: sigrok-cli-0.3.0~85 X-Git-Url: https://sigrok.org/gitweb/?p=sigrok-cli.git;a=commitdiff_plain;h=43e5747a59ed92243c217f7e36da2ac35bbcd80d Rename sub-project dirs to their correct name. --- 43e5747a59ed92243c217f7e36da2ac35bbcd80d diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7a05139 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +sigrok-cli diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..8ddf91f --- /dev/null +++ b/Makefile.am @@ -0,0 +1,25 @@ +## +## This file is part of the sigrok project. +## +## Copyright (C) 2010 Bert Vermeulen +## +## 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 . +## + +SUBDIRS = doc + +bin_PROGRAMS = sigrok-cli + +sigrok_cli_SOURCES = sigrok-cli.c sigrok-cli.h parsers.c anykey.c + diff --git a/anykey.c b/anykey.c new file mode 100644 index 0000000..be16ff1 --- /dev/null +++ b/anykey.c @@ -0,0 +1,85 @@ +/* + * This file is part of the sigrok project. + * + * Copyright (C) 2011 Bert Vermeulen + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#ifdef _WIN32 +#include +#else +#include +#endif +#include +#include +#include +#include +#include "sigrok-cli.h" + +#ifdef _WIN32 +HANDLE stdin_handle; +DWORD stdin_mode; +#else +struct termios term_orig; +#endif + +static int received_anykey(int fd, int revents, void *user_data) +{ + /* Avoid compiler warnings. */ + (void)fd; + (void)revents; + (void)user_data; + + sr_session_stop(); + + return TRUE; +} + +/* Turn off buffering on stdin. */ +void add_anykey(void) +{ +#ifdef _WIN32 + stdin_handle = GetStdHandle(STD_INPUT_HANDLE); + + if (!GetConsoleMode(stdin_handle, &stdin_mode)) { + /* TODO: Error handling. */ + } + + SetConsoleMode(stdin_handle, 0); +#else + struct termios term; + + tcgetattr(STDIN_FILENO, &term); + memcpy(&term_orig, &term, sizeof(struct termios)); + term.c_lflag &= ~(ECHO | ICANON | ISIG); + tcsetattr(STDIN_FILENO, TCSADRAIN, &term); +#endif + + sr_session_source_add(STDIN_FILENO, G_IO_IN, -1, received_anykey, NULL); + + printf("Press any key to stop acquisition.\n"); +} + +/* Restore stdin attributes. */ +void clear_anykey(void) +{ +#ifdef _WIN32 + SetConsoleMode(stdin_handle, stdin_mode); +#else + tcflush(STDIN_FILENO, TCIFLUSH); + tcsetattr(STDIN_FILENO, TCSANOW, &term_orig); +#endif +} diff --git a/autogen.sh b/autogen.sh new file mode 100755 index 0000000..0f4a777 --- /dev/null +++ b/autogen.sh @@ -0,0 +1,50 @@ +#!/bin/sh +## +## This file is part of the sigrok project. +## +## Copyright (C) 2010 Bert Vermeulen +## +## 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 . +## + +OS=`uname` + +LIBTOOLIZE=libtoolize +ACLOCAL_DIR= + +if [ "x$OS" = "xDarwin" ]; then + LIBTOOLIZE=glibtoolize + + if [ -d /sw/share/aclocal ]; then + # fink installs aclocal macros here + ACLOCAL_DIR="-I /sw/share/aclocal" + elif [ -d /opt/local/share/aclocal ]; then + # Macports installs aclocal macros here + ACLOCAL_DIR="-I /opt/local/share/aclocal" + elif [ -d /usr/share/aclocal ]; then + # Xcode installs aclocal macros here + ACLOCAL_DIR="-I /usr/share/aclocal" + fi + +elif [ "x$OS" = "xMINGW32_NT-5.1" ]; then + ACLOCAL_DIR="-I /usr/local/share/aclocal" +fi + +echo "Generating build system..." +${LIBTOOLIZE} --install --copy --quiet || exit 1 +aclocal ${ACLOCAL_DIR} || exit 1 +autoheader || exit 1 +automake --add-missing --copy --foreign || exit 1 +autoconf || exit 1 + diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..67347a4 --- /dev/null +++ b/configure.ac @@ -0,0 +1,88 @@ +## +## This file is part of the sigrok project. +## +## Copyright (C) 2010 Bert Vermeulen +## +## 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 . +## + +AC_PREREQ(2.61) + +AC_INIT([sigrok-cli], [0.1], [sigrok-devel@lists.sourceforge.net], + [sigrok-cli], [http://www.sigrok.org]) + +AC_CONFIG_SRCDIR([sigrok-cli.c]) + +AC_CONFIG_HEADERS([config.h]) +AC_CONFIG_MACRO_DIR([m4]) + +AM_INIT_AUTOMAKE([-Wall -Werror foreign std-options]) +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +AH_TOP([#ifndef SGIROK_CLI_CONFIG_H +#define SIGROK_CLI_CONFIG_H /* To stop multiple inclusions. */]) +AH_BOTTOM([#endif /* SIGROK_CLI_CONFIG_H */]) + +CFLAGS="-g -Wall -Wextra" + +# Checks for programs. +AC_PROG_CC +AC_PROG_CPP +AC_PROG_INSTALL +AC_PROG_LN_S + +# Initialize libtool. +LT_INIT + +# Initialize pkg-config. +# We require at least 0.22, as "Requires.private" behaviour changed there. +PKG_PROG_PKG_CONFIG([0.22]) + +# Checks for libraries. + +PKG_CHECK_MODULES([libsigrok], [libsigrok], + [CFLAGS="$CFLAGS $libsigrok_CFLAGS"; + LIBS="$LIBS $libsigrok_LIBS"]) + +PKG_CHECK_MODULES([libsigrokdecode], [libsigrokdecode], + [CFLAGS="$CFLAGS $libsigrokdecode_CFLAGS"; + LIBS="$LIBS $libsigrokdecode_LIBS"]) + +# Checks for header files. +# These are already checked: inttypes.h stdint.h stdlib.h string.h unistd.h. +AC_CHECK_HEADERS([sys/time.h termios.h]) + +# Checks for typedefs, structures, and compiler characteristics. +AC_C_INLINE +AC_TYPE_INT8_T +AC_TYPE_INT16_T +AC_TYPE_INT32_T +AC_TYPE_INT64_T +AC_TYPE_UINT8_T +AC_TYPE_UINT16_T +AC_TYPE_UINT32_T +AC_TYPE_UINT64_T +AC_TYPE_SIZE_T + +# Checks for library functions. +AC_CHECK_FUNCS([strcasecmp strchr strerror strstr strtol]) + +AC_SUBST(MAKEFLAGS, '--no-print-directory') +AC_SUBST(AM_LIBTOOLFLAGS, '--silent') + +AC_CONFIG_FILES([Makefile + doc/Makefile]) + +AC_OUTPUT + diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..a6c4d07 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,22 @@ +## +## This file is part of the sigrok project. +## +## Copyright (C) 2010 Uwe Hermann +## +## This program is free software; you can redistribute it and/or modify +## it under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 2 of the License, or +## (at your option) any later version. +## +## This program is distributed in the hope that it will be useful, +## but WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with this program; if not, write to the Free Software +## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA +## + +dist_man_MANS = sigrok-cli.1 + diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 new file mode 100644 index 0000000..ba2a8a3 --- /dev/null +++ b/doc/sigrok-cli.1 @@ -0,0 +1,223 @@ +.TH SIGROK\-CLI 1 "January 19, 2011" +.SH "NAME" +sigrok\-cli \- Command-line client for the sigrok logic analyzer software +.SH "SYNOPSIS" +.B sigrok\-cli \fR[\fB\-hVDiIodptwaf\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-triggers\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR sequence] [\fB\-f\fR|\fB\-\-format\fR format] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR] +.SH "DESCRIPTION" +.B sigrok\-cli +is a cross-platform command line utility for the +.B sigrok +logic analyzer software. +.PP +The command-line frontend for sigrok cannot display graphical output, but is +still sufficient to run through the whole process of hardware initialization, +acquisition, protocol analysis and saving the session. +.PP +It is useful for running on remote or embedded systems, netbooks, PDAs, +and for various other use-cases. It can display samples on standard output or +save them in various file formats. +.SH "OPTIONS" +.TP +.B "\-V, \-\-version" +Show version, driver and module information. +.TP +.B "\-h, \-\-help" +Show a help text and exit. +.TP +.B "\-D, \-\-list\-devices" +List all logic analyzer devices found on the system. +.TP +.BR "\-i, \-\-input\-file " +Load input from a file instead of a device. If the +.B \-\-input\-format +option is not supplied, sigrok-cli attempts to autodetect the file format of +the input file. +.TP +.BR "\-I, \-\-input\-format " +When loading an input file, assume it's in the specified format. If this +option is not supplied (in addition to +.BR \-\-input\-file ), +sigrok-cli attempts to autodetect the file format of the input file. +.TP +.BR "\-o, \-\-output\-file " +Save output to a file instead of writing it to stdout. The default format +used when saving is the sigrok session file format. This can be changed with +the +.B \-\-format +option, below. +.TP +.BR "\-d, \-\-device " +The device to use for acquisition. It can be specified by ID as reported by +.BR "\-\-list\-devices" , +or by the name of the driver as reported by +.BR \-\-version . +.sp +A device can optionally be followed by a colon-separated list of device +options, where each option takes the form +.BR key=value . +For example, to set the samplerate on the first device you might specify +.sp +.RB " $ " "sigrok\-cli \-d 0:samplerate=1m" +.sp +Samplerate is a option common to most devices. The argument specifies the +samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz. +The following are all equivalent: +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1000000" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m" +.sp +.RB " $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz"" +.TP +.BR "\-p, \-\-probes " +A comma-separated list of probes to be used in the session. +.sp +The default is to use all the probes available on a device. You can name +a probe like this: +.BR "1=CLK" . +A range of probes can also be given, in the form +.BR "1\-5" . +.sp +Example: +.sp + $ +.B "sigrok\-cli \-\-samples 100 \-\-probes 1=CLK,2\-4,7" +.br + CLK:11111111 11111111 11111111 11111111 [...] + 2:11111111 11111111 11111111 11111111 [...] + 3:11111111 11111111 11111111 11111111 [...] + 4:11111111 11111111 11111111 11111111 [...] + 7:11111111 11111111 11111111 11111111 [...] +.sp +The comma-separated list is processed from left to right, i.e. items farther +to the right override previous items. For example +.B "1=CS,1=MISO" +will set the name of probe 1 to +.BR "MISO" . +.sp +Also, while +.B "5=MOSI,6=MISO" +will only select probes 5 and 6, and set their names to MISO and MOSI, the +command line +.B "5=MOSI,6=MISO,1\-8" +will select probes 1\-8 (including 5 and 6, of course), but the names specified +for probes 5 and 6 will be reset to the defaults by the +.B "1\-8" +probe selection. +.TP +.BR "\-t, \-\-triggers " +A comma-separated list of triggers to use, of the form +.BR "=" . +You can use the name or number of the probe, and the trigger itself is a +series of characters: +.sp +.BR "0 or 1" : +A low or high value on the pin. +.br +.BR "r or f" : +A rising or falling value on the pin. An +.B r +effectively corresponds to +.BR 01 . +.br +.BR "c" : +Any kind of change on a pin. +.sp +Not every device supports all of these trigger types. Use the +.B "\-d " +argument (with no other arguments) to see which triggers your device supports. +.TP +.BR "\-w, \-\-wait-trigger" +Don't output any sample data (even if it's actually received from the logic +analyzer) before the trigger condition is met. In other words, do not output +any pre-trigger data. This option is useful if you don't care about the data +that came before the trigger (but the logic analyzer hardware delivers this +data to sigrok nonetheless). +.TP +.BR "\-f, \-\-format " +Set the output format to use. Use the +.B \-V +option to see a list of available output formats. The format name may +optionally be followed by a colon-separated list of options, where each +option takes the form +.BR "key=value" . +.sp +Supported formats currently include +.BR bits , +.BR hex , +.BR ascii , +.BR binary , +.BR vcd , +.BR ols , +.BR gnuplot ", and" +.BR analog . +.sp +The +.B bits +or +.B hex +formats, for an ASCII bit or ASCII hexadecimal display, can take a "width" option, specifying the number of samples (in bits) to display per line. Thus +.B hex:width=128 +will display 128 bits per line, in hexadecimal: +.sp + 1:ffff ffff ffff ffff ffff ffff ffff ffff + 2:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00 +.sp +The lines always start with the probe number (or name, if defined), followed by a colon. If no format is specified, it defaults to +.BR bits:width=64 , +like this: +.sp + 1:11111111 11111111 11111111 11111111 [...] + 2:11111111 00000000 11111111 00000000 [...] +.TP +.BR "\-\-time " +Sample for +.B +milliseconds, then quit. You can optionally follow the number by +.B s +to state the number of seconds to sample instead. For example, +.B "\-\-time 2s" +will sample for two seconds. +.TP +.BR "\-\-samples " +Acquire +.B +samples, then quit. +.TP +.BR "\-\-continuous" +Sample continuously until stopped. Not all devices support this. +.SH "EXAMPLES" +In order to get exactly 100 samples from the (only) detected logic analyzer +hardware, run the following command: +.TP +.B " sigrok\-cli \-\-samples 100" +.TP +If you want to sample data for 3 seconds, use: +.TP +.B " sigrok\-cli \-\-time 3000" +.TP +Alternatively, you can also use: +.TP +.B " sigrok\-cli \-\-time 3s" +.TP +To capture data from 4 probes lasting 100ms at 10 MHz starting at the trigger condition 1:high, 2:rising, 3:low, 4:high, use: +.TP +.B " sigrok\-cli \-f bits \-p 1\-4 \-\-time 100 \-o samplerate=10m \\\\" +.B " \-\-wait\-trigger \-\-triggers 1=1,2=r,3=0,4=1 " +.SH "EXIT STATUS" +.B sigrok\-cli +exits with 0 on success, 1 on most failures. +.SH "SEE ALSO" +\fBsigrok\-gui\fP(1) +.SH "BUGS" +Please report any bugs on the sigrok\-devel mailing list +.RB "(" sigrok\-devel@lists.souceforge.net ")." +.SH "LICENSE" +.B sigrok\-cli +is covered by the GNU General Public License (GPL). Some portions are +licensed under the "GPL v2 or later", some under "GPL v3 or later". +.SH "AUTHORS" +Please see the individual source code files. +.PP +This manual page was written by Uwe Hermann . +It is licensed under the terms of the GNU GPL (version 2 or later). diff --git a/parsers.c b/parsers.c new file mode 100644 index 0000000..b895825 --- /dev/null +++ b/parsers.c @@ -0,0 +1,184 @@ +/* + * This file is part of the sigrok project. + * + * Copyright (C) 2011 Bert Vermeulen + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include +#include +#include +#include "sigrok-cli.h" + +char **parse_probestring(int max_probes, const char *probestring) +{ + int tmp, b, e, i; + char **tokens, **range, **probelist, *name, str[8]; + gboolean error; + + error = FALSE; + range = NULL; + probelist = g_malloc0(max_probes * sizeof(char *)); + tokens = g_strsplit(probestring, ",", max_probes); + + for (i = 0; tokens[i]; i++) { + if (strchr(tokens[i], '-')) { + /* A range of probes in the form 1-5. */ + range = g_strsplit(tokens[i], "-", 2); + if (!range[0] || !range[1] || range[2]) { + /* Need exactly two arguments. */ + printf("Invalid probe syntax '%s'.\n", + tokens[i]); + error = TRUE; + break; + } + + b = strtol(range[0], NULL, 10); + e = strtol(range[1], NULL, 10); + if (b < 1 || e > max_probes || b >= e) { + printf("Invalid probe range '%s'.\n", + tokens[i]); + error = TRUE; + break; + } + + while (b <= e) { + snprintf(str, 7, "%d", b); + probelist[b - 1] = g_strdup(str); + b++; + } + } else { + tmp = strtol(tokens[i], NULL, 10); + if (tmp < 1 || tmp > max_probes) { + printf("Invalid probe %d.\n", tmp); + error = TRUE; + break; + } + + if ((name = strchr(tokens[i], '='))) { + probelist[tmp - 1] = g_strdup(++name); + if (strlen(probelist[tmp - 1]) > SR_MAX_PROBENAME_LEN) + probelist[tmp - 1][SR_MAX_PROBENAME_LEN] = 0; + } else { + snprintf(str, 7, "%d", tmp); + probelist[tmp - 1] = g_strdup(str); + } + } + } + + if (error) { + for (i = 0; i < max_probes; i++) + if (probelist[i]) + g_free(probelist[i]); + g_free(probelist); + probelist = NULL; + } + + g_strfreev(tokens); + if (range) + g_strfreev(range); + + return probelist; +} + +GHashTable *parse_generic_arg(const char *arg) +{ + GHashTable *hash; + int i; + char **elements, *e; + + if (!arg || !arg[0]) + return NULL; + + hash = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free); + elements = g_strsplit(arg, ":", 0); + g_hash_table_insert(hash, g_strdup("sigrok_key"), g_strdup(elements[0])); + for (i = 1; elements[i]; i++) { + e = strchr(elements[i], '='); + if (!e) + g_hash_table_insert(hash, g_strdup(elements[i]), NULL); + else { + *e++ = '\0'; + g_hash_table_insert(hash, g_strdup(elements[i]), g_strdup(e)); + } + } + g_strfreev(elements); + + return hash; +} + +struct sr_device *parse_devicestring(const char *devicestring) +{ + struct sr_device *device, *d; + struct sr_device_plugin *plugin; + GSList *devices, *plugins, *l, *p; + int num_devices, device_num, device_cnt; + char *tmp; + + if (!devicestring) + return NULL; + + device = NULL; + device_num = strtol(devicestring, &tmp, 10); + if (tmp != devicestring) { + /* argument is numeric, meaning a device ID. Make all driver + * plugins scan for devices. + */ + num_devices = num_real_devices(); + if (device_num < 0 || device_num >= num_devices) + return NULL; + + device_cnt = 0; + devices = sr_device_list(); + for (l = devices; l; l = l->next) { + d = l->data; + if (strstr(d->plugin->name, "demo")) + continue; + if (device_cnt == device_num) { + if (device_num == device_cnt) { + device = d; + break; + } + } + device_cnt++; + } + } else { + /* select device by driver -- only initialize that driver, + * no need to let them all scan + */ + device = NULL; + plugins = sr_list_hwplugins(); + for (p = plugins; p; p = p->next) { + plugin = p->data; + if (strcmp(plugin->name, devicestring)) + continue; + num_devices = sr_init_hwplugins(plugin); + if (num_devices == 1) { + devices = sr_device_list(); + device = devices->data; + } else if (num_devices > 1) { + printf("driver '%s' found %d devices, select by ID instead.\n", + devicestring, num_devices); + } + /* fall through: selected driver found no devices */ + break; + } + } + + return device; +} diff --git a/sigrok-cli.c b/sigrok-cli.c new file mode 100644 index 0000000..1ca2c09 --- /dev/null +++ b/sigrok-cli.c @@ -0,0 +1,995 @@ +/* + * This file is part of the sigrok project. + * + * Copyright (C) 2010 Bert Vermeulen + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include /* First, so we avoid a _POSIX_C_SOURCE warning. */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "sigrok-cli.h" +#include "config.h" + +#define DEFAULT_OUTPUT_FORMAT "bits:width=64" + +extern struct sr_hwcap_option sr_hwcap_options[]; + +gboolean debug = 0; +uint64_t limit_samples = 0; +struct sr_output_format *output_format = NULL; +int default_output_format = FALSE; +char *output_format_param = NULL; +char *input_format_param = NULL; + +static gboolean opt_version = FALSE; +static gint opt_loglevel = SR_LOG_WARN; /* Show errors+warnings per default. */ +static gboolean opt_list_devices = FALSE; +static gboolean opt_wait_trigger = FALSE; +static gchar *opt_input_file = NULL; +static gchar *opt_output_file = NULL; +static gchar *opt_device = NULL; +static gchar *opt_probes = NULL; +static gchar *opt_triggers = NULL; +static gchar *opt_pds = NULL; +static gchar *opt_input_format = NULL; +static gchar *opt_format = NULL; +static gchar *opt_time = NULL; +static gchar *opt_samples = NULL; +static gchar *opt_continuous = NULL; + +static GOptionEntry optargs[] = { + {"version", 'V', 0, G_OPTION_ARG_NONE, &opt_version, "Show version and support list", NULL}, + {"loglevel", 'l', 0, G_OPTION_ARG_INT, &opt_loglevel, "Select libsigrok loglevel", NULL}, + {"list-devices", 'D', 0, G_OPTION_ARG_NONE, &opt_list_devices, "List devices", NULL}, + {"input-file", 'i', 0, G_OPTION_ARG_FILENAME, &opt_input_file, "Load input from file", NULL}, + {"output-file", 'o', 0, G_OPTION_ARG_FILENAME, &opt_output_file, "Save output to file", NULL}, + {"device", 'd', 0, G_OPTION_ARG_STRING, &opt_device, "Use device ID", NULL}, + {"probes", 'p', 0, G_OPTION_ARG_STRING, &opt_probes, "Probes to use", NULL}, + {"triggers", 't', 0, G_OPTION_ARG_STRING, &opt_triggers, "Trigger configuration", NULL}, + {"wait-trigger", 'w', 0, G_OPTION_ARG_NONE, &opt_wait_trigger, "Wait for trigger", NULL}, + {"protocol-decoders", 'a', 0, G_OPTION_ARG_STRING, &opt_pds, "Protocol decoder sequence", NULL}, + {"input-format", 'I', 0, G_OPTION_ARG_STRING, &opt_input_format, "Input format", NULL}, + {"format", 'f', 0, G_OPTION_ARG_STRING, &opt_format, "Output format", NULL}, + {"time", 0, 0, G_OPTION_ARG_STRING, &opt_time, "How long to sample (ms)", NULL}, + {"samples", 0, 0, G_OPTION_ARG_STRING, &opt_samples, "Number of samples to acquire", NULL}, + {"continuous", 0, 0, G_OPTION_ARG_NONE, &opt_continuous, "Sample continuously", NULL}, + {NULL, 0, 0, 0, NULL, NULL, NULL} +}; + +static void show_version(void) +{ + GSList *plugins, *p, *l; + struct sr_device_plugin *plugin; + struct sr_input_format **inputs; + struct sr_output_format **outputs; + struct srd_decoder *dec; + int i; + + printf("sigrok-cli %s\n\n", VERSION); + printf("Supported hardware drivers:\n"); + plugins = sr_list_hwplugins(); + for (p = plugins; p; p = p->next) { + plugin = p->data; + printf(" %-20s %s\n", plugin->name, plugin->longname); + } + printf("\n"); + + printf("Supported input formats:\n"); + inputs = sr_input_list(); + for (i = 0; inputs[i]; i++) + printf(" %-20s %s\n", inputs[i]->id, inputs[i]->description); + printf("\n"); + + printf("Supported output formats:\n"); + outputs = sr_output_list(); + for (i = 0; outputs[i]; i++) + printf(" %-20s %s\n", outputs[i]->id, outputs[i]->description); + printf("\n"); + + /* TODO: Error handling. */ + srd_init(); + + printf("Supported protocol decoders:\n"); + for (l = srd_list_decoders(); l; l = l->next) { + dec = l->data; + printf(" %-20s %s\n", dec->id, dec->desc); + } + printf("\n"); + + srd_exit(); +} + +static void print_device_line(struct sr_device *device) +{ + struct sr_device_instance *sdi; + + sdi = device->plugin->get_device_info(device->plugin_index, SR_DI_INSTANCE); + + if (sdi->vendor && sdi->vendor[0]) + printf("%s ", sdi->vendor); + if (sdi->model && sdi->model[0]) + printf("%s ", sdi->model); + if (sdi->version && sdi->version[0]) + printf("%s ", sdi->version); + if (device->probes) + printf("with %d probes", g_slist_length(device->probes)); + printf("\n"); +} + +static void show_device_list(void) +{ + struct sr_device *device, *demo_device; + GSList *devices, *l; + int devcnt; + + devcnt = 0; + devices = sr_device_list(); + + if (g_slist_length(devices) == 0) + return; + + printf("The following devices were found:\nID Device\n"); + demo_device = NULL; + for (l = devices; l; l = l->next) { + device = l->data; + if (strstr(device->plugin->name, "demo")) { + demo_device = device; + continue; + } + printf("%-3d ", devcnt++); + print_device_line(device); + } + if (demo_device) { + printf("demo "); + print_device_line(demo_device); + } +} + +static void show_device_detail(void) +{ + struct sr_device *device; + struct sr_hwcap_option *hwo; + struct sr_samplerates *samplerates; + int cap, *capabilities, i; + char *s, *title, *charopts, **stropts; + + device = parse_devicestring(opt_device); + if (!device) { + printf("No such device. Use -D to list all devices.\n"); + return; + } + + print_device_line(device); + + if ((charopts = (char *)device->plugin->get_device_info( + device->plugin_index, SR_DI_TRIGGER_TYPES))) { + printf("Supported triggers: "); + while (*charopts) { + printf("%c ", *charopts); + charopts++; + } + printf("\n"); + } + + title = "Supported options:\n"; + capabilities = device->plugin->get_capabilities(); + for (cap = 0; capabilities[cap]; cap++) { + if (!(hwo = sr_find_hwcap_option(capabilities[cap]))) + continue; + + if (title) { + printf("%s", title); + title = NULL; + } + + if (hwo->capability == SR_HWCAP_PATTERN_MODE) { + printf(" %s", hwo->shortname); + stropts = (char **)device->plugin->get_device_info( + device->plugin_index, SR_DI_PATTERNMODES); + if (!stropts) { + printf("\n"); + continue; + } + printf(" - supported modes:\n"); + for (i = 0; stropts[i]; i++) + printf(" %s\n", stropts[i]); + } else if (hwo->capability == SR_HWCAP_SAMPLERATE) { + printf(" %s", hwo->shortname); + /* Supported samplerates */ + samplerates = device->plugin->get_device_info( + device->plugin_index, SR_DI_SAMPLERATES); + if (!samplerates) { + printf("\n"); + continue; + } + + if (samplerates->step) { + /* low */ + if (!(s = sr_samplerate_string(samplerates->low))) + continue; + printf(" (%s", s); + free(s); + /* high */ + if (!(s = sr_samplerate_string(samplerates->high))) + continue; + printf(" - %s", s); + free(s); + /* step */ + if (!(s = sr_samplerate_string(samplerates->step))) + continue; + printf(" in steps of %s)\n", s); + free(s); + } else { + printf(" - supported samplerates:\n"); + for (i = 0; samplerates->list[i]; i++) { + printf(" %7s\n", sr_samplerate_string(samplerates->list[i])); + } + } + } else { + printf(" %s\n", hwo->shortname); + } + } +} + +static void datafeed_in(struct sr_device *device, struct sr_datafeed_packet *packet) +{ + static struct sr_output *o = NULL; + static int probelist[65] = { 0 }; + static uint64_t received_samples = 0; + static int unitsize = 0; + static int triggered = 0; + static FILE *outfile = NULL; + struct sr_probe *probe; + struct sr_datafeed_header *header; + struct sr_datafeed_logic *logic; + int num_enabled_probes, sample_size, ret, i; + uint64_t output_len, filter_out_len; + char *output_buf, *filter_out; + + /* If the first packet to come in isn't a header, don't even try. */ + if (packet->type != SR_DF_HEADER && o == NULL) + return; + + sample_size = -1; + switch (packet->type) { + case SR_DF_HEADER: + g_message("cli: Received SR_DF_HEADER"); + /* Initialize the output module. */ + if (!(o = malloc(sizeof(struct sr_output)))) { + printf("Output module malloc failed.\n"); + exit(1); + } + o->format = output_format; + o->device = device; + o->param = output_format_param; + if (o->format->init) { + if (o->format->init(o) != SR_OK) { + printf("Output format initialization failed.\n"); + exit(1); + } + } + + header = packet->payload; + num_enabled_probes = 0; + for (i = 0; i < header->num_logic_probes; i++) { + probe = g_slist_nth_data(device->probes, i); + if (probe->enabled) + probelist[num_enabled_probes++] = probe->index; + } + /* How many bytes we need to store num_enabled_probes bits */ + unitsize = (num_enabled_probes + 7) / 8; + + outfile = stdout; + if (opt_output_file) { + if (default_output_format) { + /* output file is in session format, which means we'll + * dump everything in the datastore as it comes in, + * and save from there after the session. */ + outfile = NULL; + ret = sr_datastore_new(unitsize, &(device->datastore)); + if (ret != SR_OK) { + printf("Failed to create datastore.\n"); + exit(1); + } + } else { + /* saving to a file in whatever format was set + * with --format, so all we need is a filehandle */ + outfile = g_fopen(opt_output_file, "wb"); + } + } + if (opt_pds) + srd_session_start(device->plugin->name, unitsize, + time(NULL), header->samplerate); + break; + case SR_DF_END: + g_message("cli: Received SR_DF_END"); + if (!o) { + g_message("cli: double end!"); + break; + } + if (o->format->event) { + o->format->event(o, SR_DF_END, &output_buf, &output_len); + if (output_len) { + if (outfile) + fwrite(output_buf, 1, output_len, outfile); + free(output_buf); + output_len = 0; + } + } + if (limit_samples && received_samples < limit_samples) + printf("Device only sent %" PRIu64 " samples.\n", + received_samples); + if (opt_continuous) + printf("Device stopped after %" PRIu64 " samples.\n", + received_samples); + sr_session_halt(); + if (outfile && outfile != stdout) + fclose(outfile); + free(o); + o = NULL; + break; + case SR_DF_TRIGGER: + g_message("cli: received SR_DF_TRIGGER at %"PRIu64" ms", + packet->timeoffset / 1000000); + if (o->format->event) + o->format->event(o, SR_DF_TRIGGER, &output_buf, + &output_len); + triggered = 1; + break; + case SR_DF_LOGIC: + logic = packet->payload; + sample_size = logic->unitsize; + g_message("cli: received SR_DF_LOGIC at %f ms duration %f ms, %"PRIu64" bytes", + packet->timeoffset / 1000000.0, packet->duration / 1000000.0, + logic->length); + break; + case SR_DF_ANALOG: + break; + } + + /* not supporting anything but SR_DF_LOGIC for now */ + + if (sample_size == -1 || logic->length == 0) + return; + + /* Don't store any samples until triggered. */ + if (opt_wait_trigger && !triggered) + return; + + if (limit_samples && received_samples >= limit_samples) + return; + + /* TODO: filters only support SR_DF_LOGIC */ + ret = sr_filter_probes(sample_size, unitsize, probelist, + logic->data, logic->length, + &filter_out, &filter_out_len); + if (ret != SR_OK) + return; + + /* what comes out of the filter is guaranteed to be packed into the + * minimum size needed to support the number of samples at this sample + * size. however, the driver may have submitted too much -- cut off + * the buffer of the last packet according to the sample limit. + */ + if (limit_samples && (received_samples + logic->length / sample_size > + limit_samples * sample_size)) + filter_out_len = limit_samples * sample_size - received_samples; + + if (device->datastore) + sr_datastore_put(device->datastore, filter_out, + filter_out_len, sample_size, probelist); + + if (opt_output_file && default_output_format) + /* saving to a session file, don't need to do anything else + * to this data for now. */ + goto cleanup; + + if (opt_pds) { + if (srd_session_feed(packet->timeoffset, packet->duration, + (uint8_t*)filter_out, filter_out_len) != SRD_OK) + abort(); + } else { + output_len = 0; + if (o->format->data && packet->type == o->format->df_type) + o->format->data(o, filter_out, filter_out_len, &output_buf, &output_len); + if (output_len) { + fwrite(output_buf, 1, output_len, outfile); + free(output_buf); + } + } + +cleanup: + g_free(filter_out); + received_samples += logic->length / sample_size; + +} + +/* Register the given PDs for this session. */ +/* Accepts a string of the form: "spi:sck=3:sdata=4,spi:sck=3:sdata=5" + * That will instantiate two SPI decoders on the clock but different data + * lines. + */ +/* TODO: Support both serial PDs and nested PDs. Parallel PDs even? */ +/* TODO: Only register here, run in streaming fashion later/elsewhere. */ +static int register_pds(struct sr_device *device, const char *pdstring) +{ + char **pdtokens, **pdtok; + + /* Avoid compiler warnings. */ + (void)device; + + pdtokens = g_strsplit(pdstring, ",", -1); + + for (pdtok = pdtokens; *pdtok; pdtok++) { + struct srd_decoder_instance *di; + + /* Configure probes from command line */ + char **optokens, **optok; + optokens = g_strsplit(*pdtok, ":", -1); + di = srd_instance_new(optokens[0]); + if(!di) { + fprintf(stderr, "Failed to instantiate PD: %s\n", + optokens[0]); + g_strfreev(optokens); + g_strfreev(pdtokens); + return -1; + } + for (optok = optokens+1; *optok; optok++) { + char probe[strlen(*optok)]; + int num; + if(sscanf(*optok, "%[^=]=%d", probe, &num) == 2) + srd_instance_set_probe(di, probe, num); + /* TODO: else fail somehow */ + } + g_strfreev(optokens); + + /* TODO: Handle errors. */ + } + + g_strfreev(pdtokens); + + return 0; +} + +static int select_probes(struct sr_device *device) +{ + struct sr_probe *probe; + char **probelist; + int max_probes, i; + + if (!opt_probes) + return SR_OK; + + /* + * This only works because a device by default initializes + * and enables all its probes. + */ + max_probes = g_slist_length(device->probes); + probelist = parse_probestring(max_probes, opt_probes); + if (!probelist) { + return SR_ERR; + } + + for (i = 0; i < max_probes; i++) { + if (probelist[i]) { + sr_device_probe_name(device, i + 1, probelist[i]); + g_free(probelist[i]); + } else { + probe = sr_device_probe_find(device, i + 1); + probe->enabled = FALSE; + } + } + g_free(probelist); + + return SR_OK; +} + +/** + * Return the input file format which the CLI tool should use. + * + * If the user specified -I / --input-format, use that one. Otherwise, try to + * autodetect the format as good as possible. Failing that, return NULL. + * + * @param filename The filename of the input file. Must not be NULL. + * @param opt The -I / --input-file option the user specified (or NULL). + * + * @return A pointer to the 'struct sr_input_format' that should be used, + * or NULL if no input format was selected or auto-detected. + */ +static struct sr_input_format *determine_input_file_format( + const char *filename, const char *opt) +{ + int i; + struct sr_input_format **inputs; + + /* If there are no input formats, return NULL right away. */ + inputs = sr_input_list(); + if (!inputs) { + fprintf(stderr, "cli: %s: no supported input formats " + "available", __func__); + return NULL; + } + + /* If the user specified -I / --input-format, use that one. */ + if (opt) { + for (i = 0; inputs[i]; i++) { + if (strcasecmp(inputs[i]->id, opt_input_format)) + continue; + printf("Using user-specified input file format" + " '%s'.\n", inputs[i]->id); + return inputs[i]; + } + + /* The user specified an unknown input format, return NULL. */ + fprintf(stderr, "Error: Specified input file format '%s' is " + "unknown.\n", opt_input_format); + return NULL; + } + + /* Otherwise, try to find an input module that can handle this file. */ + for (i = 0; inputs[i]; i++) { + if (inputs[i]->format_match(filename)) + break; + } + + /* Return NULL if no input module wanted to touch this. */ + if (!inputs[i]) { + fprintf(stderr, "Error: No matching input module found.\n"); + return NULL; + } + + printf("Using input file format '%s'.\n", inputs[i]->id); + return inputs[i]; +} + +static void load_input_file_format(void) +{ + struct stat st; + struct sr_input *in; + struct sr_input_format *input_format; + + input_format = determine_input_file_format(opt_input_file, + opt_input_format); + if (!input_format) { + fprintf(stderr, "Error: Couldn't detect input file format.\n"); + return; + } + + if (stat(opt_input_file, &st) == -1) { + printf("Failed to load %s: %s\n", opt_input_file, + strerror(errno)); + exit(1); + } + + /* Initialize the input module. */ + if (!(in = malloc(sizeof(struct sr_input)))) { + printf("Failed to allocate input module.\n"); + exit(1); + } + in->format = input_format; + in->param = input_format_param; + if (in->format->init) { + if (in->format->init(in) != SR_OK) { + printf("Input format init failed.\n"); + exit(1); + } + } + + if (select_probes(in->vdevice) > 0) + return; + + sr_session_new(); + sr_session_datafeed_callback_add(datafeed_in); + if (sr_session_device_add(in->vdevice) != SR_OK) { + printf("Failed to use device.\n"); + sr_session_destroy(); + return; + } + + input_format->loadfile(in, opt_input_file); + if (opt_output_file && default_output_format) { + if (sr_session_save(opt_output_file) != SR_OK) + printf("Failed to save session.\n"); + } + sr_session_destroy(); + +} + +static void load_input_file(void) +{ + + if (sr_session_load(opt_input_file) == SR_OK) { + /* sigrok session file */ + sr_session_datafeed_callback_add(datafeed_in); + sr_session_start(); + sr_session_run(); + sr_session_stop(); + } + else { + /* fall back on input modules */ + load_input_file_format(); + } + +} + +int num_real_devices(void) +{ + struct sr_device *device; + GSList *devices, *l; + int num_devices; + + num_devices = 0; + devices = sr_device_list(); + for (l = devices; l; l = l->next) { + device = l->data; + if (!strstr(device->plugin->name, "demo")) + num_devices++; + } + + return num_devices; +} + +int set_device_options(struct sr_device *device, GHashTable *args) +{ + GHashTableIter iter; + gpointer key, value; + int ret, i; + uint64_t tmp_u64; + gboolean found; + gboolean tmp_bool; + + g_hash_table_iter_init(&iter, args); + while (g_hash_table_iter_next(&iter, &key, &value)) { + found = FALSE; + for (i = 0; sr_hwcap_options[i].capability; i++) { + if (strcmp(sr_hwcap_options[i].shortname, key)) + continue; + if ((value == NULL) && + (sr_hwcap_options[i].type != SR_T_BOOL)) { + printf("Option '%s' needs a value.\n", (char *)key); + return SR_ERR; + } + found = TRUE; + switch (sr_hwcap_options[i].type) { + case SR_T_UINT64: + ret = sr_parse_sizestring(value, &tmp_u64); + if (ret != SR_OK) + break; + ret = device->plugin-> set_configuration(device-> plugin_index, + sr_hwcap_options[i]. capability, &tmp_u64); + break; + case SR_T_CHAR: + ret = device->plugin-> set_configuration(device-> plugin_index, + sr_hwcap_options[i]. capability, value); + break; + case SR_T_BOOL: + if (!value) + tmp_bool = TRUE; + else + tmp_bool = sr_parse_boolstring(value); + ret = device->plugin-> set_configuration(device-> plugin_index, + sr_hwcap_options[i]. capability, + GINT_TO_POINTER(tmp_bool)); + break; + default: + ret = SR_ERR; + } + + if (ret != SR_OK) { + printf("Failed to set device option '%s'.\n", (char *)key); + return ret; + } + else + break; + } + if (!found) { + printf("Unknown device option '%s'.\n", (char *) key); + return SR_ERR; + } + } + + return SR_OK; +} + +static void run_session(void) +{ + struct sr_device *device; + GHashTable *devargs; + int num_devices, max_probes, *capabilities, i; + uint64_t tmp_u64, time_msec; + char **probelist, *devspec; + + devargs = NULL; + if (opt_device) { + devargs = parse_generic_arg(opt_device); + devspec = g_hash_table_lookup(devargs, "sigrok_key"); + device = parse_devicestring(devspec); + if (!device) { + g_warning("Device not found."); + return; + } + g_hash_table_remove(devargs, "sigrok_key"); + } else { + num_devices = num_real_devices(); + if (num_devices == 1) { + /* No device specified, but there is only one. */ + devargs = NULL; + device = parse_devicestring("0"); + } else if (num_devices == 0) { + printf("No devices found.\n"); + return; + } else { + printf("%d devices found, please select one.\n", num_devices); + return; + } + } + + sr_session_new(); + sr_session_datafeed_callback_add(datafeed_in); + + if (sr_session_device_add(device) != SR_OK) { + printf("Failed to use device.\n"); + sr_session_destroy(); + return; + } + + if (devargs) { + if (set_device_options(device, devargs) != SR_OK) { + sr_session_destroy(); + return; + } + g_hash_table_destroy(devargs); + } + + if (select_probes(device) != SR_OK) + return; + + if (opt_continuous) { + capabilities = device->plugin->get_capabilities(); + if (!sr_find_hwcap(capabilities, SR_HWCAP_CONTINUOUS)) { + printf("This device does not support continuous sampling."); + sr_session_destroy(); + return; + } + } + + if (opt_triggers) { + probelist = sr_parse_triggerstring(device, opt_triggers); + if (!probelist) { + sr_session_destroy(); + return; + } + + max_probes = g_slist_length(device->probes); + for (i = 0; i < max_probes; i++) { + if (probelist[i]) { + sr_device_trigger_set(device, i + 1, probelist[i]); + g_free(probelist[i]); + } + } + g_free(probelist); + } + + if (opt_time) { + time_msec = sr_parse_timestring(opt_time); + if (time_msec == 0) { + printf("Invalid time '%s'\n", opt_time); + sr_session_destroy(); + return; + } + + capabilities = device->plugin->get_capabilities(); + if (sr_find_hwcap(capabilities, SR_HWCAP_LIMIT_MSEC)) { + if (device->plugin->set_configuration(device->plugin_index, + SR_HWCAP_LIMIT_MSEC, &time_msec) != SR_OK) { + printf("Failed to configure time limit.\n"); + sr_session_destroy(); + return; + } + } + else { + /* time limit set, but device doesn't support this... + * convert to samples based on the samplerate. + */ + limit_samples = 0; + if (sr_device_has_hwcap(device, SR_HWCAP_SAMPLERATE)) { + tmp_u64 = *((uint64_t *) device->plugin->get_device_info( + device->plugin_index, SR_DI_CUR_SAMPLERATE)); + limit_samples = tmp_u64 * time_msec / (uint64_t) 1000; + } + if (limit_samples == 0) { + printf("Not enough time at this samplerate.\n"); + sr_session_destroy(); + return; + } + + if (device->plugin->set_configuration(device->plugin_index, + SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK) { + printf("Failed to configure time-based sample limit.\n"); + sr_session_destroy(); + return; + } + } + } + + if (opt_samples) { + if ((sr_parse_sizestring(opt_samples, &limit_samples) != SR_OK) + || (device->plugin->set_configuration(device->plugin_index, + SR_HWCAP_LIMIT_SAMPLES, &limit_samples) != SR_OK)) { + printf("Failed to configure sample limit.\n"); + sr_session_destroy(); + return; + } + } + + if (device->plugin->set_configuration(device->plugin_index, + SR_HWCAP_PROBECONFIG, (char *)device->probes) != SR_OK) { + printf("Failed to configure probes.\n"); + sr_session_destroy(); + return; + } + + if (sr_session_start() != SR_OK) { + printf("Failed to start session.\n"); + sr_session_destroy(); + return; + } + + if (opt_continuous) + add_anykey(); + + sr_session_run(); + + if (opt_continuous) + clear_anykey(); + + if (opt_output_file && default_output_format) { + if (sr_session_save(opt_output_file) != SR_OK) + printf("Failed to save session.\n"); + } + sr_session_destroy(); + +} + +static void logger(const gchar *log_domain, GLogLevelFlags log_level, + const gchar *message, gpointer user_data) +{ + /* Avoid compiler warnings. */ + (void)log_domain; + (void)user_data; + + /* + * All messages, warnings, errors etc. go to stderr (not stdout) in + * order to not mess up the CLI tool data output, e.g. VCD output. + */ + if (log_level & (G_LOG_LEVEL_ERROR | G_LOG_LEVEL_WARNING)) { + fprintf(stderr, "%s\n", message); + fflush(stderr); + } else { + if ((log_level & G_LOG_LEVEL_MESSAGE && debug == 1) + || debug == 2) { + printf("%s\n", message); + fflush(stderr); + } + } +} + +int main(int argc, char **argv) +{ + struct sr_output_format **outputs; + GOptionContext *context; + GError *error; + GHashTable *fmtargs; + GHashTableIter iter; + gpointer key, value; + int i; + char *fmtspec; + + g_log_set_default_handler(logger, NULL); + if (getenv("SIGROK_DEBUG")) + debug = strtol(getenv("SIGROK_DEBUG"), NULL, 10); + + error = NULL; + context = g_option_context_new(NULL); + g_option_context_add_main_entries(context, optargs, NULL); + + if (!g_option_context_parse(context, &argc, &argv, &error)) { + g_warning("%s", error->message); + return 1; + } + + /* Set the loglevel (amount of messages to output) for libsigrok. */ + if (sr_set_loglevel(opt_loglevel) != SR_OK) { + fprintf(stderr, "cli: %s: sr_set_loglevel(%d) failed\n", + __func__, opt_loglevel); + return 1; + } + + if (sr_init() != SR_OK) + return 1; + + if (opt_pds) { + /* TODO: Error handling. */ + srd_init(); + register_pds(NULL, opt_pds); + } + + if (!opt_format) { + opt_format = DEFAULT_OUTPUT_FORMAT; + /* we'll need to remember this, so when saving to an file + * later, sigrok session format will be used. + */ + default_output_format = TRUE; + } + fmtargs = parse_generic_arg(opt_format); + fmtspec = g_hash_table_lookup(fmtargs, "sigrok_key"); + if (!fmtspec) { + printf("Invalid output format.\n"); + return 1; + } + outputs = sr_output_list(); + for (i = 0; outputs[i]; i++) { + if (strcmp(outputs[i]->id, fmtspec)) + continue; + g_hash_table_remove(fmtargs, "sigrok_key"); + output_format = outputs[i]; + g_hash_table_iter_init(&iter, fmtargs); + while (g_hash_table_iter_next(&iter, &key, &value)) { + /* only supporting one parameter per output module + * for now, and only its value */ + output_format_param = g_strdup(value); + break; + } + break; + } + if (!output_format) { + printf("invalid output format %s\n", opt_format); + return 1; + } + + if (opt_version) + show_version(); + else if (opt_list_devices) + show_device_list(); + else if (opt_input_file) + load_input_file(); + else if (opt_samples || opt_time || opt_continuous) + run_session(); + else if (opt_device) + show_device_detail(); + else + printf("%s", g_option_context_get_help(context, TRUE, NULL)); + + if (opt_pds) + srd_exit(); + + g_option_context_free(context); + g_hash_table_destroy(fmtargs); + sr_exit(); + + return 0; +} diff --git a/sigrok-cli.h b/sigrok-cli.h new file mode 100644 index 0000000..0ba8cfe --- /dev/null +++ b/sigrok-cli.h @@ -0,0 +1,37 @@ +/* + * This file is part of the sigrok project. + * + * Copyright (C) 2011 Bert Vermeulen + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#ifndef SIGROK_SIGROK_CLI_H +#define SIGROK_SIGROK_CLI_H + +/* sigrok-cli.c */ +int num_real_devices(void); + +/* parsers.c */ +char **parse_probestring(int max_probes, const char *probestring); +char **sr_parse_triggerstring(struct sr_device *device, const char *triggerstring); +GHashTable *parse_generic_arg(const char *arg); +struct sr_device *parse_devicestring(const char *devicestring); +uint64_t sr_parse_timestring(const char *timestring); + +/* anykey.c */ +void add_anykey(void); +void clear_anykey(void); + +#endif