From 92d8f859b86e773ae1104116659c7dbeab88d636 Mon Sep 17 00:00:00 2001 From: Andreas Eversberg Date: Fri, 18 Mar 2022 16:14:20 +0100 Subject: [PATCH] Implementation of UK0 interface via sound card This is work in progress. --- .gitignore | 43 ++ LICENSE | 674 +++++++++++++++++ Makefile.am | 5 + configure.ac | 95 +++ git-version-gen | 151 ++++ m4/.keep | 0 src/Makefile.am | 18 + src/uk0/Makefile.am | 30 + src/uk0/hdlc.c | 380 ++++++++++ src/uk0/hdlc.h | 42 ++ src/uk0/main.c | 442 +++++++++++ src/uk0/ph_socket.c | 295 ++++++++ src/uk0/ph_socket.h | 102 +++ src/uk0/uk0.c | 1694 +++++++++++++++++++++++++++++++++++++++++++ src/uk0/uk0.h | 137 ++++ 15 files changed, 4108 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile.am create mode 100644 configure.ac create mode 100755 git-version-gen create mode 100644 m4/.keep create mode 100644 src/Makefile.am create mode 100644 src/uk0/Makefile.am create mode 100644 src/uk0/hdlc.c create mode 100644 src/uk0/hdlc.h create mode 100644 src/uk0/main.c create mode 100644 src/uk0/ph_socket.c create mode 100644 src/uk0/ph_socket.h create mode 100644 src/uk0/uk0.c create mode 100644 src/uk0/uk0.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a180252 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +Makefile +Makefile.in +.deps +.libs +*.o +*.lo +*.la +*.pc +aclocal.m4 +acinclude.m4 +aminclude.am +m4/*.m4 +autom4te.cache +compile +config.h* +config.sub +config.log +config.status +config.guess +configure +depcomp +missing +ltmain.sh +install-sh +stamp-h1 +libtool + +.tarball-version +.version +.dirstamp + +Doxyfile + +.*.sw? + +src/libdebug/libdebug.a +src/liboptions/liboptions.a +src/libsample/libsample.a +src/libfilter/libfilter.a +src/libwave/libwave.a +src/libdisplay/libdisplay.a +src/libsound/libsound.a +src/uk0/uk0-soundcard diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /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/Makefile.am b/Makefile.am new file mode 100644 index 0000000..689d568 --- /dev/null +++ b/Makefile.am @@ -0,0 +1,5 @@ +AUTOMAKE_OPTIONS = foreign dist-bzip2 1.6 +ACLOCAL_AMFLAGS = -I m4 + +SUBDIRS = src + diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..90d266e --- /dev/null +++ b/configure.ac @@ -0,0 +1,95 @@ +AC_INIT([uk0-souncard], + m4_esyscmd([./git-version-gen .tarball-version]), + [jolly@eversberg.eu]) + +dnl *This* is the root dir, even if an install-sh exists in ../ or ../../ +AC_CONFIG_AUX_DIR([.]) + +AM_INIT_AUTOMAKE([subdir-objects dist-bzip2]) +AC_CONFIG_TESTDIR(tests) + +dnl kernel style compile messages +m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) + +dnl include release helper +RELMAKE='-include osmo-release.mk' +AC_SUBST([RELMAKE]) + +dnl checks for programs +AC_PROG_MAKE_SET +AC_PROG_CC +AC_PROG_INSTALL +AC_PROG_RANLIB + +AC_CONFIG_MACRO_DIR([m4]) + +AC_ARG_ENABLE(sanitize, + [AS_HELP_STRING( + [--enable-sanitize], + [Compile with address sanitizer enabled], + )], + [sanitize=$enableval], [sanitize="no"]) +if test x"$sanitize" = x"yes" +then + CFLAGS="$CFLAGS -fsanitize=address -fsanitize=undefined" + CPPFLAGS="$CPPFLAGS -fsanitize=address -fsanitize=undefined" +fi + +AC_ARG_ENABLE(werror, + [AS_HELP_STRING( + [--enable-werror], + [Turn all compiler warnings into errors, with exceptions: + a) deprecation (allow upstream to mark deprecation without breaking builds); + b) "#warning" pragmas (allow to remind ourselves of errors without breaking builds) + ] + )], + [werror=$enableval], [werror="no"]) +if test x"$werror" = x"yes" +then + WERROR_FLAGS="-Werror" + WERROR_FLAGS+=" -Wno-error=deprecated -Wno-error=deprecated-declarations" + WERROR_FLAGS+=" -Wno-error=cpp" # "#warning" + CFLAGS="$CFLAGS $WERROR_FLAGS" + CPPFLAGS="$CPPFLAGS $WERROR_FLAGS" +fi + +CFLAGS="$CFLAGS -Wall" +CPPFLAGS="$CPPFLAGS -Wall" + +dnl checks for header files +AC_HEADER_STDC +AC_CHECK_HEADERS(execinfo.h sys/select.h sys/socket.h syslog.h ctype.h) + +# The following test is taken from WebKit's webkit.m4 +saved_CFLAGS="$CFLAGS" +CFLAGS="$CFLAGS -fvisibility=hidden " +AC_MSG_CHECKING([if ${CC} supports -fvisibility=hidden]) +AC_COMPILE_IFELSE([AC_LANG_SOURCE([char foo;])], + [ AC_MSG_RESULT([yes]) + SYMBOL_VISIBILITY="-fvisibility=hidden"], + AC_MSG_RESULT([no])) +CFLAGS="$saved_CFLAGS" +AC_SUBST(SYMBOL_VISIBILITY) + +dnl Generate the output +AM_CONFIG_HEADER(config.h) + +AC_CHECK_LIB([m], [main]) + +AC_ARG_WITH([alsa], [AS_HELP_STRING([--with-alsa], [compile with Alsa driver @<:@default=check@:>@]) ], [], [with_alsa="check"]) +AS_IF([test "x$with_alsa" != xno], [PKG_CHECK_MODULES(ALSA, alsa >= 1.0, with_alsa=yes, with_alsa=no)]) +AM_CONDITIONAL(HAVE_ALSA, test "x$with_alsa" == "xyes" ) +AS_IF([test "x$with_alsa" == "xyes"],[AC_MSG_NOTICE( Compiling with Alsa support )], [AC_MSG_NOTICE( Alsa sound card not supported. Consider adjusting the PKG_CONFIG_PATH environment variable if you installed software in a non-standard prefix. )]) +AM_CONDITIONAL(HAVE_SDR, false ) + +AC_OUTPUT( + src/liboptions/Makefile + src/libdebug/Makefile + src/libsample/Makefile + src/libfilter/Makefile + src/libwave/Makefile + src/libdisplay/Makefile + src/libsound/Makefile + src/uk0/Makefile + src/Makefile + Makefile) diff --git a/git-version-gen b/git-version-gen new file mode 100755 index 0000000..42cf3d2 --- /dev/null +++ b/git-version-gen @@ -0,0 +1,151 @@ +#!/bin/sh +# Print a version string. +scriptversion=2010-01-28.01 + +# Copyright (C) 2007-2010 Free Software Foundation, Inc. +# +# 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 . + +# This script is derived from GIT-VERSION-GEN from GIT: http://git.or.cz/. +# It may be run two ways: +# - from a git repository in which the "git describe" command below +# produces useful output (thus requiring at least one signed tag) +# - from a non-git-repo directory containing a .tarball-version file, which +# presumes this script is invoked like "./git-version-gen .tarball-version". + +# In order to use intra-version strings in your project, you will need two +# separate generated version string files: +# +# .tarball-version - present only in a distribution tarball, and not in +# a checked-out repository. Created with contents that were learned at +# the last time autoconf was run, and used by git-version-gen. Must not +# be present in either $(srcdir) or $(builddir) for git-version-gen to +# give accurate answers during normal development with a checked out tree, +# but must be present in a tarball when there is no version control system. +# Therefore, it cannot be used in any dependencies. GNUmakefile has +# hooks to force a reconfigure at distribution time to get the value +# correct, without penalizing normal development with extra reconfigures. +# +# .version - present in a checked-out repository and in a distribution +# tarball. Usable in dependencies, particularly for files that don't +# want to depend on config.h but do want to track version changes. +# Delete this file prior to any autoconf run where you want to rebuild +# files to pick up a version string change; and leave it stale to +# minimize rebuild time after unrelated changes to configure sources. +# +# It is probably wise to add these two files to .gitignore, so that you +# don't accidentally commit either generated file. +# +# Use the following line in your configure.ac, so that $(VERSION) will +# automatically be up-to-date each time configure is run (and note that +# since configure.ac no longer includes a version string, Makefile rules +# should not depend on configure.ac for version updates). +# +# AC_INIT([GNU project], +# m4_esyscmd([build-aux/git-version-gen .tarball-version]), +# [bug-project@example]) +# +# Then use the following lines in your Makefile.am, so that .version +# will be present for dependencies, and so that .tarball-version will +# exist in distribution tarballs. +# +# BUILT_SOURCES = $(top_srcdir)/.version +# $(top_srcdir)/.version: +# echo $(VERSION) > $@-t && mv $@-t $@ +# dist-hook: +# echo $(VERSION) > $(distdir)/.tarball-version + +case $# in + 1) ;; + *) echo 1>&2 "Usage: $0 \$srcdir/.tarball-version"; exit 1;; +esac + +tarball_version_file=$1 +nl=' +' + +# First see if there is a tarball-only version file. +# then try "git describe", then default. +if test -f $tarball_version_file +then + v=`cat $tarball_version_file` || exit 1 + case $v in + *$nl*) v= ;; # reject multi-line output + [0-9]*) ;; + *) v= ;; + esac + test -z "$v" \ + && echo "$0: WARNING: $tarball_version_file seems to be damaged" 1>&2 +fi + +if test -n "$v" +then + : # use $v +elif + v=`git describe --abbrev=4 --match='v*' HEAD 2>/dev/null \ + || git describe --abbrev=4 HEAD 2>/dev/null` \ + && case $v in + [0-9]*) ;; + v[0-9]*) ;; + *) (exit 1) ;; + esac +then + # Is this a new git that lists number of commits since the last + # tag or the previous older version that did not? + # Newer: v6.10-77-g0f8faeb + # Older: v6.10-g0f8faeb + case $v in + *-*-*) : git describe is okay three part flavor ;; + *-*) + : git describe is older two part flavor + # Recreate the number of commits and rewrite such that the + # result is the same as if we were using the newer version + # of git describe. + vtag=`echo "$v" | sed 's/-.*//'` + numcommits=`git rev-list "$vtag"..HEAD | wc -l` + v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`; + ;; + esac + + # Change the first '-' to a '.', so version-comparing tools work properly. + # Remove the "g" in git describe's output string, to save a byte. + v=`echo "$v" | sed 's/-/./;s/\(.*\)-g/\1-/'`; +else + v=UNKNOWN +fi + +v=`echo "$v" |sed 's/^v//'` + +# Don't declare a version "dirty" merely because a time stamp has changed. +git status > /dev/null 2>&1 + +dirty=`sh -c 'git diff-index --name-only HEAD' 2>/dev/null` || dirty= +case "$dirty" in + '') ;; + *) # Append the suffix only if there isn't one already. + case $v in + *-dirty) ;; + *) v="$v-dirty" ;; + esac ;; +esac + +# Omit the trailing newline, so that m4_esyscmd can use the result directly. +echo "$v" | tr -d '\012' + +# Local variables: +# eval: (add-hook 'write-file-hooks 'time-stamp) +# time-stamp-start: "scriptversion=" +# time-stamp-format: "%:y-%02m-%02d.%02H" +# time-stamp-end: "$" +# End: diff --git a/m4/.keep b/m4/.keep new file mode 100644 index 0000000..e69de29 diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..497c1a0 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,18 @@ +AUTOMAKE_OPTIONS = foreign + +SUBDIRS = \ + liboptions \ + libdebug \ + libsample \ + libfilter \ + libwave \ + libdisplay + +if HAVE_ALSA +SUBDIRS += \ + libsound +endif + +SUBDIRS += \ + uk0 + diff --git a/src/uk0/Makefile.am b/src/uk0/Makefile.am new file mode 100644 index 0000000..0f371ed --- /dev/null +++ b/src/uk0/Makefile.am @@ -0,0 +1,30 @@ +AM_CPPFLAGS = -Wall -Wextra -g $(all_includes) + +bin_PROGRAMS = \ + uk0-soundcard + +uk0_soundcard_SOURCES = \ + uk0.c \ + hdlc.c \ + ph_socket.c \ + main.c + +uk0_soundcard_LDADD = \ + $(COMMON_LA) \ + ../libdebug/libdebug.a \ + ../liboptions/liboptions.a \ + ../libsample/libsample.a \ + ../libfilter/libfilter.a \ + ../libdisplay/libdisplay.a \ + ../libwave/libwave.a + +if HAVE_ALSA +uk0_soundcard_LDADD += \ + ../libsound/libsound.a \ + $(ALSA_LIBS) +endif + +if HAVE_ALSA +AM_CPPFLAGS += -DHAVE_ALSA +endif + diff --git a/src/uk0/hdlc.c b/src/uk0/hdlc.c new file mode 100644 index 0000000..71e9c68 --- /dev/null +++ b/src/uk0/hdlc.c @@ -0,0 +1,380 @@ +/* HDLC + * + * (C) 2022 by Andreas Eversberg + * All Rights Reserved + * + * 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 "../libdebug/debug.h" +#include "uk0.h" + +//#define DEBUG_HDLC + +/* calculate CRC from the bits of label and data and 16 zeroes. + * the result is the remainder of the polynomial division and + * conforms to HDLC/X25/ISDN standard. + */ +static uint16_t crc16(uint8_t *data, int length) +{ + uint16_t generator = 0x8408; + uint16_t crc = 0xffff; /* init crc register with 1 */ + int i, j; + + for (i = 0; i < length; i++) { + for (j = 0; j < 8; j++) { + if (((data[i]>>j) & 1) != (crc & 1)) { + crc = crc >> 1; + crc = crc ^ generator; + } else + crc = crc >> 1; + } + } + + return crc ^ 0xffff; +} + +/* + * TX + */ + +void hdlc_tx_init(hdlc_tx_t *tx, struct uk0 *uk0, int channel, enum hdlc_mode mode) +{ + memset(tx, 0, sizeof(*tx)); + tx->uk0 = uk0; + tx->channel = channel; + tx->mode = mode; +} + +static inline int tx_bit(hdlc_tx_t *tx, uint8_t *bit) +{ + int subsequent = 0; + + if (tx->state == HDLC_STATE_IDLE) { + /* when index is set, we just had a frame, so we can use end flag as start flag */ + if (tx->index) + subsequent = 1; + tx->length = uk0_tx_dequeue(tx->uk0, tx->channel, tx->buffer, sizeof(tx->buffer)); + tx->index = 0; + if (!tx->length) + return -1; /* no more data */ + tx->crc = crc16(tx->buffer, tx->length); + if (subsequent) { + tx->state = HDLC_STATE_TX_DATA; +#ifdef DEBUG_HDLC + printf("subsequent frame, continue with data.\n"); +#endif + } + else { + tx->state = HDLC_STATE_TX_START_FLAG; +#ifdef DEBUG_HDLC + printf("new frame after pause, continue with flag.\n"); +#endif + } + tx->bits = 0; + tx->frame = 0x00; + } + + switch (tx->state) { + case HDLC_STATE_TX_START_FLAG: + *bit = (0x7e >> tx->bits) & 1; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + if (++tx->bits == 8) { + tx->bits = 0; +#ifdef DEBUG_HDLC + printf("flag sent, continue with data.\n"); +#endif + tx->state = HDLC_STATE_TX_DATA; + } + break; + case HDLC_STATE_TX_DATA: + if ((tx->frame & 0x1f) == 0x1f) { +#ifdef DEBUG_HDLC + printf("insert stuffing bit.\n"); +#endif + *bit = 0; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + tx->frame <<= 1; + break; + } + *bit = (tx->buffer[tx->index] >> tx->bits) & 1; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + tx->frame <<= 1; + tx->frame |= *bit; + if (++tx->bits == 8) { + tx->bits = 0; + if (++tx->index == tx->length) { +#ifdef DEBUG_HDLC + printf("data complete, continue with crc.\n"); +#endif + tx->state = HDLC_STATE_TX_CRC; + } + } + break; + case HDLC_STATE_TX_CRC: + if ((tx->frame & 0x1f) == 0x1f) { +#ifdef DEBUG_HDLC + printf("insert stuffing bit.\n"); +#endif + *bit = 0; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + tx->frame <<= 1; + break; + } + *bit = (tx->crc >> tx->bits) & 1; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + tx->frame <<= 1; + tx->frame |= *bit; + if (++tx->bits == 16) { + tx->bits = 0; +#ifdef DEBUG_HDLC + printf("data complete, continue with end flag.\n"); +#endif + tx->state = HDLC_STATE_TX_END_FLAG; + } + break; + case HDLC_STATE_TX_END_FLAG: + *bit = (0x7e >> tx->bits) & 1; +#ifdef DEBUG_HDLC + printf("transmit bit: %d\n", *bit); +#endif + if (++tx->bits == 8) { +#ifdef DEBUG_HDLC + printf("end flag complete, enter idle state for next frame.\n"); +#endif + tx->state = HDLC_STATE_IDLE; + } + break; + default: + return -1; /* should never happen */ + } + + return 0; +} + +/* data requested from uk0 coming from tx_queue */ +void uk0_send(uk0_t *uk0, int ch, uint8_t *data, int length) +{ + hdlc_tx_t *tx; + int i, j, rc; + uint8_t bit; + + if (ch < 1 || ch > 3) { + fprintf(stderr, "%s: illegal channel number %d!\n", __func__, ch); + return; + } + tx = &uk0->hdlc_tx[ch - 1]; + + /* disabled -> transparent */ + switch (tx->mode) { + case HDLC_MODE_OFF: + memset(data, 0xff, length); + break; + case HDLC_MODE_TRANS: + while (length) { + if (tx->index == tx->length) { + tx->length = uk0_tx_dequeue(tx->uk0, tx->channel, tx->buffer, sizeof(tx->buffer)); + tx->index = 0; + } + if (!tx->length) { + memset(data, 0xff, length); + break; + } + while (length && tx->index < tx->length) { + *data++ = tx->buffer[tx->index]; + tx->index++; + length--; + } + } + break; + case HDLC_MODE_HDLC: + for (i = 0; i < length; i++) { + for (j = 0; j < 8; j++) { + rc = tx_bit(tx, &bit); + /* rc is set, if no more HDLC frames */ + if (rc) + break; + data[i] = (data[i] >> 1) | (bit << 7); + } + /* fill up byte, if no more HDLC frames */ + if (j < 8) { + data[i] = (data[i] >> (8 - j)) | (0xff << j); + i++; + break; + } + } + /* fill up remaining data with 0xff, if no more HDLC frames */ + if (i < length) + memset(data + i , 0xff, length - i); + break; + } +} + +/* + * RX + */ + +void hdlc_rx_init(hdlc_rx_t *rx, struct uk0 *uk0, int channel, enum hdlc_mode mode) +{ + memset(rx, 0, sizeof(*rx)); + rx->uk0 = uk0; + rx->channel = channel; + rx->mode = mode; +} + +static inline void rx_frame(hdlc_rx_t *rx, uint8_t *data, int length) +{ + uint16_t crc; + +#ifdef DEBUG_HDLC + int i; + printf("frame:"); + for (i = 0; i < length; i++) { + printf(" %02x", data[i]); + } +#endif + crc = crc16(data, length - 2); + if (data[length - 2] == (crc & 0xff) && data[length - 1] == (crc >> 8)) { +#ifdef DEBUG_HDLC + printf(" crc ok.\n"); +#endif + ph_socket_tx_msg(&rx->uk0->ph_socket, rx->channel, PH_PRIM_DATA_IND, data, length - 2); + } else { +#ifdef DEBUG_HDLC + printf(" crc error!\n"); +#endif + } +} + +static inline void rx_bit(hdlc_rx_t *rx, uint8_t bit) +{ + rx->frame <<= 1; + rx->frame |= bit; + + switch (rx->state) { + case HDLC_STATE_IDLE: + if (rx->frame == 0x7e) { +#ifdef DEBUG_HDLC + printf("received start flag.\n"); +#endif + rx->state = HDLC_STATE_RX_FRAME; + rx->index = 0; + rx->bits = 0; + } + break; + case HDLC_STATE_RX_FRAME: +#ifdef DEBUG_HDLC + printf("received bit: %d\n", bit); +#endif + /* remove stuffed 0-bit after 5 1-bits */ + if ((rx->frame & 0x7f) == 0x3e) { +#ifdef DEBUG_HDLC + printf("omit stuffed 0-bit.\n"); +#endif + break; + } + if ((rx->frame & 0x7f) == 0x7f) { +#ifdef DEBUG_HDLC + printf("received frame abort!\n"); +#endif + rx->state = HDLC_STATE_IDLE; + break; + } + if ((rx->frame & 0x7f) == 0x3f) { +#ifdef DEBUG_HDLC + printf("received 6 1-bits.\n"); +#endif + } + rx->buffer[rx->index] >>= 1; + rx->buffer[rx->index] |= (bit << 7); + if (++rx->bits == 8) { + rx->bits = 0; + rx->index++; + if (rx->index == sizeof(rx->buffer)) { +#ifdef DEBUG_HDLC + printf("HDLC overflow!\n"); +#endif + rx->state = HDLC_STATE_IDLE; + break; + } + } + if (rx->frame == 0x7e) { +#ifdef DEBUG_HDLC + printf("received end flag.\n"); +#endif + if (rx->bits == 0) { + /* remove flag from buffer by substracting 1 from index */ + if (rx->index > 3) + rx_frame(rx, rx->buffer, rx->index - 1); + } else { +#ifdef DEBUG_HDLC + printf("received frame does not end on byte boundary!\n"); +#endif + } + rx->index = 0; + rx->bits = 0; + } + break; + default: + break; /* should never happen */ + } +} + +/* data from interface going through HDLC to socket */ +void uk0_receive(uk0_t *uk0, int ch, uint8_t *data, int length) +{ + hdlc_rx_t *rx; + int i, j; + uint8_t bit; + + if (ch < 1 || ch > 3) { + fprintf(stderr, "%s: illegal channel number %d!\n", __func__, ch); + return; + } + rx = &uk0->hdlc_rx[ch - 1]; + + /* disabled -> transparent */ + switch (rx->mode) { + case HDLC_MODE_OFF: + break; + case HDLC_MODE_TRANS: + ph_socket_tx_msg(&rx->uk0->ph_socket, rx->channel, PH_PRIM_DATA_IND, data, length); + break; + case HDLC_MODE_HDLC: + for (i = 0; i < length; i++) { + for (j = 0; j < 8; j++) { + bit = (data[i] >> j) & 1; + rx_bit(rx, bit); + } + } + break; + } +} + diff --git a/src/uk0/hdlc.h b/src/uk0/hdlc.h new file mode 100644 index 0000000..b5fd67b --- /dev/null +++ b/src/uk0/hdlc.h @@ -0,0 +1,42 @@ + +enum hdlc_mode { + HDLC_MODE_OFF = 0, + HDLC_MODE_TRANS, + HDLC_MODE_HDLC, +}; + +enum hdlc_state { + HDLC_STATE_IDLE = 0, /* wait for flag / no data */ + HDLC_STATE_RX_FRAME, /* receive frame */ + HDLC_STATE_TX_START_FLAG,/* transmit flag */ + HDLC_STATE_TX_DATA, /* transmit data */ + HDLC_STATE_TX_CRC, /* transmit crc */ + HDLC_STATE_TX_END_FLAG, /* transmit flag */ +}; + +struct uk0; + +typedef struct hdlc_tx { + struct uk0 *uk0; + int channel; + enum hdlc_mode mode; + enum hdlc_state state; /* current frame state */ + uint8_t frame; /* shit register to detect framing and stuffing */ + uint8_t buffer[65536]; + uint16_t crc; + int length, index, bits; +} hdlc_tx_t; + +typedef struct hdlc_rx { + struct uk0 *uk0; + int channel; + enum hdlc_mode mode; + enum hdlc_state state; /* current frame state */ + uint8_t frame; /* shit register to detect framing and stuffing */ + uint8_t buffer[65537]; /* one more, because it contains end flag */ + int index, bits; +} hdlc_rx_t; + +void hdlc_tx_init(hdlc_tx_t *tx, struct uk0 *uk0, int channel, enum hdlc_mode mode); +void hdlc_rx_init(hdlc_rx_t *rx, struct uk0 *uk0, int channel, enum hdlc_mode mode); + diff --git a/src/uk0/main.c b/src/uk0/main.c new file mode 100644 index 0000000..fa3b766 --- /dev/null +++ b/src/uk0/main.c @@ -0,0 +1,442 @@ +/* UK0 via sound card (main) + * + * (C) 2022 by Andreas Eversberg + * All Rights Reserved + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "../libdebug/debug.h" +#include "../liboptions/options.h" +#include "../libsample/sample.h" +#include "../libsound/sound.h" +#include "uk0.h" + +uk0_t *uk0[2] = { NULL, NULL }; +int num_kanal = 1; + +void *soundif = NULL; +const char *dsp_device = ""; +int dsp_samplerate = 192000; +int dsp_buffer = 50; +const char *uk0_socket[2] = { "/tmp/uk0", NULL }; +int num_uk0_socket = 0; +static int keyboard_control = 0; +static int dsp_interval = 1; /* ms */ + +static void print_usage(const char *app) +{ + printf("Usage: %s [-a hw:0,0] []\n", app); +} + +static void print_help() +{ + /* - - */ + printf(" -h --help\n"); + printf(" This help\n"); + printf(" --config [~/]\n"); + printf(" Give a config file to use. If it starts with '~/', path is at home dir.\n"); + printf(" Each line in config file is one option, '-' or '--' must not be given!\n"); + debug_print_help(); + printf(" -a --audio-device hw:,\n"); + printf(" Sound card and device number (default = '%s')\n", dsp_device); + printf(" -s --samplerate \n"); + printf(" Sample rate of sound device (default = '%d')\n", dsp_samplerate); + printf(" -b --buffer \n"); + printf(" How many milliseconds are processed in advance (default = '%d')\n", dsp_buffer); + printf(" A buffer below 10 ms requires low interval like 0.1 ms.\n"); + printf(" -U --uk0-socket \n"); + printf(" Name to socket file. Allows an application to connect to layer 1.\n"); + printf(" (default = '%s')\n", uk0_socket[0]); + printf(" To provide two interfaces with stereo audio, give two UK0 sockets:\n"); + printf(" -U -U \n"); + printf(" -C --control\n"); + printf(" Use keyboard to control activation/deactivation/loopback for testing.\n"); + printf("\n"); + printf("Press 'w' key to toggle display of RX wave form.\n"); + printf("Press 'm' key to toggle display of measurement values.\n"); +} + +static void add_options(void) +{ + option_add('h', "help", 0); + option_add('v', "verbose", 1); + option_add('a', "audio-device", 1); + option_add('s', "samplerate", 1); + option_add('b', "buffer", 1); + option_add('U', "uk0-socket", 1); + option_add('C', "control", 0); +} + +static int handle_options(int short_option, int argi, char **argv) +{ + int rc; + + switch (short_option) { + case 'h': + print_usage(argv[0]); + print_help(); + return 0; + case 'v': + if (!strcasecmp(argv[argi], "list")) { + debug_list_cat(); + return 0; + } + rc = parse_debug_opt(argv[argi]); + if (rc < 0) { + fprintf(stderr, "Failed to parse debug option, please use -h for help.\n"); + return rc; + } + break; + case 'a': + dsp_device = options_strdup(argv[argi]); + break; + case 's': + dsp_samplerate = atoi(argv[argi]); + break; + case 'b': + dsp_buffer = atoi(argv[argi]); + break; + case 'U': + if (num_uk0_socket == 2) { + fprintf(stderr, "Cannot provide more than two interfaces. Stereo audio allows just two interfaces.\n"); + return -EINVAL; + } + uk0_socket[num_uk0_socket++] = options_strdup(argv[argi]); + num_kanal = num_uk0_socket; + break; + case 'C': + keyboard_control = 1; + break; + default: + return -EINVAL; + } + return 1; +} + +static int quit = 0; +static void sighandler(int sigset) +{ + if (sigset == SIGHUP || sigset == SIGPIPE) + return; + + fprintf(stderr, "\nSignal %d received.\n", sigset); + + quit = 1; +} + +static int get_char() +{ + struct timeval tv = {0, 0}; + fd_set fds; + char c = 0; + int __attribute__((__unused__)) rc; + + FD_ZERO(&fds); + FD_SET(0, &fds); + select(0+1, &fds, NULL, NULL, &tv); + if (FD_ISSET(0, &fds)) { + rc = read(0, &c, 1); + return c; + } else + return -1; +} + +/* not static, in case we add libtimer some day, then compiler hits an error */ +double get_time(void) +{ + static struct timespec tv; + + clock_gettime(CLOCK_REALTIME, &tv); + + return (double)tv.tv_sec + (double)tv.tv_nsec / 1000000000.0; +} + +static void help_keyboard(void) +{ + printf("Use keyboard to control interface:\n"); + printf(" 'e' = enable interface (do this first!)\n"); + printf(" 'd' = disable interface\n"); + printf(" '1' = activate interface (LT side activation)\n"); + printf(" '0' = deactivate interface\n"); + printf(" 'l' = toggle loopback 2 mode\n"); +} + +static void process_keyboard(uk0_t *uk0, char c) +{ + switch (c) { + case 'e': + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard enables interface.\n"); + if (uk0->state != UK0_STATE_NULL) { + PDEBUG(DUK0, DEBUG_NOTICE, "Interface is already enabled!\n"); + break; + } + uk0_handle_event(uk0, UK0_EVENT_ENABLE); + break; + case 'd': + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard disables interface.\n"); + if (uk0->state == UK0_STATE_NULL) { + PDEBUG(DUK0, DEBUG_NOTICE, "Interface is already disabled!\n"); + break; + } + uk0_handle_event(uk0, UK0_EVENT_DISABLE); + break; + case '1': + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard activates interface.\n"); + if (uk0->state == UK0_STATE_NULL) { + PDEBUG(DUK0, DEBUG_NOTICE, "Cannot activate interface, enable first!\n"); + break; + } + uk0_handle_event(uk0, UK0_EVENT_ACTIVATE); + break; + case '0': + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard deactivates interface.\n"); + if (uk0->state == UK0_STATE_NULL) { + PDEBUG(DUK0, DEBUG_NOTICE, "Cannot deactivate interface, it is disabled!\n"); + break; + } + uk0_handle_event(uk0, UK0_EVENT_DEACTIVATE); + break; + case 'l': + uk0->loopback2 ^= 1; + if (uk0->loopback2) + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard activates loopback 2.\n"); + else + PDEBUG(DUK0, DEBUG_NOTICE, "Keyboard deactivates loopback 2.\n"); + + break; + } +} + +int soundif_open(const char *audiodev, int samplerate, int buffer_size) +{ + if (!audiodev || !audiodev[0]) { + PDEBUG(DUK0, DEBUG_ERROR, "No audio device given!\n"); + return -EINVAL; + } + + /* open audiodev */ +#ifdef HAVE_ALSA + soundif = sound_open(audiodev, NULL, NULL, NULL, num_kanal, 0.0, samplerate, buffer_size, 1.0, 1.0, 0.0, 2.0); + if (!soundif) { + PDEBUG(DUK0, DEBUG_ERROR, "Failed to open sound device!\n"); + return -EIO; + } +#else + PDEBUG(DUK0, DEBUG_ERROR, "No audio device is compiled in! Cannot use UK0 interface.\n"); + return -EINVAL; +#endif + + return 0; +} + +void soundif_start(void) +{ +#ifdef HAVE_ALSA + sound_start(soundif); + PDEBUG(DUK0, DEBUG_DEBUG, "Starting audio stream!\n"); +#endif +} + +void soundif_close(void) +{ +#ifdef HAVE_ALSA + /* close audiodev */ + if (soundif) { + sound_close(soundif); + soundif = NULL; + } +#endif +} + +void soundif_work(int buffer_size) +{ +#ifdef HAVE_ALSA + int count, i; + sample_t buff[num_kanal][buffer_size], *samples[num_kanal]; + double rf_level_db[num_kanal]; + for (i = 0; i < num_kanal; i++) + samples[i] = buff[i]; + int rc; + + /* encode */ + count = sound_get_tosend(soundif, buffer_size); + if (count < 0) { + PDEBUG(DUK0, DEBUG_ERROR, "Failed to get number of samples in buffer (rc = %d)!\n", count); + return; + } + if (count) { + for (i = 0; i < num_kanal; i++) + uk0_encode_mms43(uk0[i], samples[i], count); + rc = sound_write(soundif, samples, NULL, count, NULL, NULL, num_kanal); + if (rc < 0) { + PDEBUG(DUK0, DEBUG_ERROR, "Failed to write TX data to audio device (rc = %d)\n", rc); + return; + } + } + + /* decode */ + count = sound_read(soundif, samples, buffer_size, num_kanal, rf_level_db); + if (count < 0) { + PDEBUG(DUK0, DEBUG_ERROR, "Failed to read from audio device (rc = %d)!\n", count); + return; + } + for (i = 0; i < num_kanal; i++) + uk0_decode_mms43(uk0[i], samples[i], count); +#endif +} + +int main(int argc, char *argv[]) +{ + int argi, rc; + int buffer_size; + struct termios term, term_orig; + double begin_time, now, sleep; + int i, j; + char c; + + + uk0_init(); + + /* handle options / config file */ + add_options(); + rc = options_config_file(argc, argv, "~/.osmocom/uk0/uk0.conf", handle_options); + if (rc < 0) + return 0; + argi = options_command_line(argc, argv, handle_options); + if (argi <= 0) + return argi; + + if (keyboard_control && num_kanal != 1) { + PDEBUG(DUK0, DEBUG_ERROR, "Keyboard control works only, if a single UK0 interface was selected.\n"); + return 0; + } + + /* size of dsp buffer in samples */ + buffer_size = dsp_samplerate * dsp_buffer / 1000; + + rc = soundif_open(dsp_device, dsp_samplerate, buffer_size); + if (rc < 0) { + printf("Failed to open UK0 device, use '-h' for help.\n"); + goto error; + } + + /* create and init UK0 instances */ + for (i = 0; i < num_kanal; i++) { + uk0[i] = uk0_create(uk0_socket[i], dsp_samplerate, buffer_size); + if (!uk0[i]) + goto error; + for (j = 0; j < 3; j++) { + hdlc_tx_init(&uk0[i]->hdlc_tx[j], uk0[i], j + 1, HDLC_MODE_OFF); + hdlc_rx_init(&uk0[i]->hdlc_rx[j], uk0[i], j + 1, HDLC_MODE_OFF); + } + ph_socket_init(&uk0[i]->ph_socket, uk0[i], uk0_socket[i], 1); + } + + if (keyboard_control) + help_keyboard(); + + /* prepare terminal */ + tcgetattr(0, &term_orig); + term = term_orig; + term.c_lflag &= ~(ISIG|ICANON|ECHO); + term.c_cc[VMIN]=1; + term.c_cc[VTIME]=2; + tcsetattr(0, TCSANOW, &term); + + signal(SIGINT, sighandler); + signal(SIGHUP, sighandler); + signal(SIGTERM, sighandler); + signal(SIGPIPE, sighandler); + + soundif_start(); + + while (!quit) { + int w; + + begin_time = get_time(); + + soundif_work(buffer_size); + for (i = 0; i < num_kanal; i++) { + do { + w = 0; + w |= ph_socket_work(&uk0[i]->ph_socket); + } while (w); + } + + c = get_char(); + switch (c) { + case 3: + printf("CTRL+c received, quitting!\n"); + quit = 1; + break; + case 'w': + /* toggle wave display */ + display_measurements_on(0); + display_wave_on(-1); + break; + case 'm': + /* toggle measurements display */ + display_wave_on(0); + display_measurements_on(-1); + break; + default: + if (keyboard_control) + process_keyboard(uk0[0], c); + } + + display_measurements(dsp_interval / 1000.0); + + now = get_time(); + + /* sleep interval */ + sleep = ((double)dsp_interval / 1000.0) - (now - begin_time); + if (sleep > 0) + usleep(sleep * 1000000.0); + } + + signal(SIGINT, SIG_DFL); + signal(SIGTSTP, SIG_DFL); + signal(SIGHUP, SIG_DFL); + signal(SIGTERM, SIG_DFL); + signal(SIGPIPE, SIG_DFL); + + /* reset terminal */ + tcsetattr(0, TCSANOW, &term_orig); + +error: + /* destroy UK0 instances */ + for (i = 0; i < num_kanal; i++) { + if (uk0[i]) { + ph_socket_exit(&uk0[i]->ph_socket); + uk0_destroy(uk0[i]); + } + } + + soundif_close(); + + options_free(); + + return 0; +} + diff --git a/src/uk0/ph_socket.c b/src/uk0/ph_socket.c new file mode 100644 index 0000000..dacb65f --- /dev/null +++ b/src/uk0/ph_socket.c @@ -0,0 +1,295 @@ +/* PH-socket, a lightweight ISDN physical layer interface + * + * (C) 2022 by Andreas Eversberg + * All Rights Reserved + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "../libdebug/debug.h" +#include "ph_socket.h" + +#define CHAN s->name + +int ph_socket_init(ph_socket_t *s, void *priv, const char *socket_name, int server) +{ + int rc, flags; + + memset(s, 0, sizeof(*s)); + s->name = socket_name; + s->priv = priv; + s->tx_list_tail = &s->tx_list; + + memset(&s->sock_address, 0, sizeof(s->sock_address)); + s->sock_address.sun_family = AF_UNIX; + strncpy(s->sock_address.sun_path, socket_name, sizeof(s->sock_address.sun_path) - 1); + + if (server) { + unlink(socket_name); + + rc = socket(PF_UNIX, SOCK_STREAM, 0); + if (rc < 0) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Failed to create UNIX socket.\n"); + return rc; + } + s->listen = rc; + + rc = bind(s->listen, (struct sockaddr *)(&s->sock_address), SUN_LEN(&s->sock_address)); + if (rc < 0) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Failed to bind UNIX socket with path '%s' (errno = %d (%s)).\n", socket_name, errno, strerror(errno)); + return rc; + } + + rc = listen(s->listen, 1); + if (rc < 0) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Failed to listen to UNIX socket with path '%s' (errno = %d (%s)).\n", socket_name, errno, strerror(errno)); + return rc; + } + + /* set nonblocking io */ + flags = fcntl(s->listen, F_GETFL); + flags |= O_NONBLOCK; + fcntl(s->listen, F_SETFL, flags); + } + + PDEBUG_CHAN(DPH, DEBUG_INFO, "Created PH-socket at '%s'.\n", socket_name); + + return 0; +} + +static void close_connection(ph_socket_t *s) +{ + struct socket_msg_list *ml; + uint8_t disable = PH_CTRL_DISABLE; + + if (s->connect <= 0) + return; + + PDEBUG_CHAN(DPH, DEBUG_INFO, "Connection from PH-socket closed.\n"); + + /* indicate loss of socket connection */ + ph_socket_rx_msg(s, 0, (s->listen > 0) ? PH_PRIM_CTRL_REQ : PH_PRIM_CTRL_IND, &disable, 1); + + close(s->connect); + s->connect = 0; + + while ((ml = s->tx_list)) { + s->tx_list = ml->next; + free(ml); + } + s->tx_list_tail = &s->tx_list; + if (s->rx_msg) { + free(s->rx_msg); + s->rx_msg = NULL; + } + + /* set timer, so that retry is delayed */ + static struct timespec tv; + clock_gettime(CLOCK_REALTIME, &tv); + double now = (double)tv.tv_sec + (double)tv.tv_nsec / 1000000000.0; + s->connect_timer = now + SOCKET_RETRY_TIMER; +} + +void ph_socket_exit(ph_socket_t *s) +{ + PDEBUG_CHAN(DPH, DEBUG_INFO, "Destroyed PH-socket.\n"); + + close_connection(s); + if (s->listen > 0) { + close(s->listen); + s->listen = 0; + } +} + +int ph_socket_work(ph_socket_t *s) +{ + uint8_t enable = PH_CTRL_ENABLE; + int rc, flags; + int work = 0; + + if (s->listen > 0) { + struct sockaddr_un sock_address; + socklen_t sock_len = sizeof(sock_address); + /* see if there is an incoming connection */ + rc = accept(s->listen, (struct sockaddr *)&sock_address, &sock_len); + if (rc > 0) { + if (s->connect > 0) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Rejecting incoming connection, because we already have a client connected!\n"); + close(rc); + } else { + PDEBUG_CHAN(DPH, DEBUG_INFO, "Connection from PH-socket client.\n"); + s->connect = rc; + /* set nonblocking io */ + flags = fcntl(s->connect, F_GETFL); + flags |= O_NONBLOCK; + fcntl(s->connect, F_SETFL, flags); + /* reset rx buffer */ + s->rx_header_index = 0; + s->rx_data_index = 0; + /* indicate established socket connection */ + ph_socket_rx_msg(s, 0, PH_PRIM_CTRL_REQ, &enable, 1); + } + work = 1; + } + } else { + /* open connection, if closed */ + if (s->connect <= 0) { + static struct timespec tv; + clock_gettime(CLOCK_REALTIME, &tv); + double now = (double)tv.tv_sec + (double)tv.tv_nsec / 1000000000.0; + if (s->connect_timer < now) { + PDEBUG_CHAN(DPH, DEBUG_DEBUG, "Trying to connect to PH-socket server.\n"); + rc = socket(PF_UNIX, SOCK_STREAM, 0); + if (rc < 0) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Failed to create UNIX socket.\n"); + s->connect_timer = now + SOCKET_RETRY_TIMER; + return 0; + } + s->connect = rc; + /* connect */ + rc = connect(s->connect, (struct sockaddr *)&s->sock_address, SUN_LEN(&s->sock_address)); + if (rc < 0 && errno != EAGAIN) { + PDEBUG_CHAN(DPH, DEBUG_NOTICE, "Failed to connect UNIX socket.\n"); + close(s->connect); + s->connect = 0; + s->connect_timer = now + SOCKET_RETRY_TIMER; + return 0; + } + PDEBUG_CHAN(DPH, DEBUG_INFO, "Connection to PH-socket server.\n"); + /* set nonblocking io */ + flags = fcntl(s->connect, F_GETFL); + flags |= O_NONBLOCK; + fcntl(s->connect, F_SETFL, flags); + /* reset rx buffer */ + s->rx_header_index = 0; + s->rx_data_index = 0; + /* indicate established socket connection */ + ph_socket_rx_msg(s, 0, PH_PRIM_CTRL_IND, &enable, 1); + } + } + } + + /* handle connection, if any */ + if (s->connect > 0) { + if (!s->rx_msg) + s->rx_msg = calloc(1, sizeof(*s->rx_msg)); +rx_again: + if (s->rx_header_index < (int)sizeof(s->rx_msg->msg.header)) { + /* read header until complete */ + rc = recv(s->connect, ((uint8_t *)&s->rx_msg->msg.header) + s->rx_header_index, sizeof(s->rx_msg->msg.header) - s->rx_header_index, 0); + if (rc > 0) { + s->rx_header_index += rc; + work = 1; + goto rx_again; + } else if (rc == 0 || errno != EAGAIN) { + close_connection(s); + work = 1; + } + } else if (s->rx_data_index < s->rx_msg->msg.header.length) { + /* read data until complete */ + rc = recv(s->connect, s->rx_msg->msg.data + s->rx_data_index, s->rx_msg->msg.header.length - s->rx_data_index, 0); + if (rc > 0) { + s->rx_data_index += rc; + work = 1; + goto rx_again; + } else if (rc == 0 || errno != EAGAIN) { + close_connection(s); + work = 1; + } + } else { + /* process and free message */ + if (s->rx_msg->msg.header.prim != PH_PRIM_DATA_REQ + && s->rx_msg->msg.header.prim != PH_PRIM_DATA_IND) { + PDEBUG_CHAN(DPH, DEBUG_DEBUG, "message 0x%02x channel %d from socket\n", s->rx_msg->msg.header.prim, s->rx_msg->msg.header.channel); + if (s->rx_msg->msg.header.length) + PDEBUG_CHAN(DPH, DEBUG_DEBUG, " -> data:%s\n", debug_hex(s->rx_msg->msg.data, s->rx_msg->msg.header.length)); + } + ph_socket_rx_msg(s, s->rx_msg->msg.header.channel, s->rx_msg->msg.header.prim, s->rx_msg->msg.data, s->rx_msg->msg.header.length); + free(s->rx_msg); + s->rx_msg = NULL; + /* reset rx buffer */ + s->rx_header_index = 0; + s->rx_data_index = 0; + } + +tx_again: + if (s->tx_list) { + /* some frame in tx list, so try sending it */ + rc = send(s->connect, ((uint8_t *)&s->tx_list->msg.header), sizeof(s->tx_list->msg.header) + s->tx_list->msg.header.length, 0); + if (rc > 0) { + struct socket_msg_list *ml; + if (rc != (int)sizeof(s->tx_list->msg.header) + s->tx_list->msg.header.length) { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Short write, please fix handling!\n"); + } + /* remove list entry */ + ml = s->tx_list; + s->tx_list = ml->next; + if (s->tx_list == NULL) + s->tx_list_tail = &s->tx_list; + free(ml); + work = 1; + goto tx_again; + } else if (rc == 0 || errno != EAGAIN) { + close_connection(s); + work = 1; + } + } + } + + return work; +} + +void ph_socket_tx_msg(ph_socket_t *s, int channel, uint8_t prim, uint8_t *data, int length) +{ + struct socket_msg_list *tx_msg; + + if (prim != PH_PRIM_DATA_REQ + && prim != PH_PRIM_DATA_IND) { + PDEBUG_CHAN(DPH, DEBUG_DEBUG, "message 0x%02x channel %d to socket\n", prim, channel); + if (length) + PDEBUG_CHAN(DPH, DEBUG_DEBUG, " -> data:%s\n", debug_hex(data, length)); + } + + if (length > (int)sizeof(tx_msg->msg.data)) { + PDEBUG_CHAN(DPH, DEBUG_NOTICE, "Frame from HDLC process too large for socket, dropping!\n"); + return; + } + + if (s->connect <= 0) { + PDEBUG_CHAN(DPH, DEBUG_NOTICE, "Dropping message for socket, socket is closed!\n"); + return; + } + + tx_msg = calloc(1, sizeof(*tx_msg)); + tx_msg->msg.header.channel = channel; + tx_msg->msg.header.prim = prim; + if (length) { + tx_msg->msg.header.length = length; + memcpy(tx_msg->msg.data, data, length); + } + /* move message to list */ + *s->tx_list_tail = tx_msg; + s->tx_list_tail = &tx_msg->next; +} + diff --git a/src/uk0/ph_socket.h b/src/uk0/ph_socket.h new file mode 100644 index 0000000..ce69120 --- /dev/null +++ b/src/uk0/ph_socket.h @@ -0,0 +1,102 @@ + +#include + +/* + * Procedure: + * + * If socket connection is establised, a PH_PRIM_CTRL_REQ message with + * PH_CTRL_ENABLE information is received by the socket server user. + * If the socket connection is lost, a PH_PRIM_CTRL_REQ message with + * PH_CTRL_DISABLE information is received by the user. + * + * If socket connection is establised, a PH_PRIM_CTRL_IND message with + * PH_CTRL_ENABLE information is received by the socket client user. + * If the socket connection is lost, a PH_PRIM_CTRL_IND message with + * PH_CTRL_DISABLE information is received by the user. + * + * The socket server should activate or deactivate interface depending + * on the PH_CTRL_ENABEL / PH_CTRL_DISABLE information. + * + * The socket client user shall keep track of last PH_PRIM_ACT_IND / + * PH_PRIM_DEACT_IND message and treat a PH_PRIM_CTRL_IND message with + * PH_CTRL_DISABLE information as a deactivation of all channels that + * were activated. Also it shall reject every PH_RIM_ACT_REQ with a + * PH_PRIM_DACT_IND, if the socket is currently unavailable. + * + * PH_PRIM_CTRL_REQ and PH_PRIM_CTRL_IND messages with PH_CTRL_ENABLE + * and PH_CTRL_DISABLE informations are not assoicated with a channel + * number. The socket sender shall set it to 0, the receiver shall + * ignore it. + * + * A missing MODE in PH_PRIM_ACT_REQ is interepreted as default: + * HDLC on D-channel, TRANS on B-channel. + * + * Each packet on the socket shall have the follwoing header: + * uint8_t channel; + * uint8_t prim; + * uint16_t length; + * + * The length shall be in host's endian on UN sockets and in network + * endian on TCP sockets and not being transmitted on UDP sockets. + * + * 0 to 65535 bytes shall follow the header, depending on the length + * information field. + */ + +/* all primitives */ +#define PH_PRIM_DATA_REQ 0x00 /* any data sent to channel from upper layer */ +#define PH_PRIM_DATA_IND 0x01 /* any data received from channel to upper layer */ + +#define PH_PRIM_CTRL_REQ 0x04 /* implementation specific requests towards interface */ +#define PH_PRIM_CTRL_IND 0x05 /* implementation specific indications from interface */ + +#define PH_PRIM_ACT_REQ 0x08 /* activation request of channel, mode is given as payload */ +#define PH_PRIM_ACT_IND 0x09 /* activation indication that the channel is now active */ + +#define PH_PRIM_DACT_REQ 0x0c /* deactivation request of channel */ +#define PH_PRIM_DACT_IND 0x0d /* deactivation indication that the channel is now inactive */ + +/* one byte sent activation request */ +#define PH_MODE_TRANS 0x00 /* raw data is sent via B-channel */ +#define PH_MODE_HDLC 0x01 /* HDLC transcoding is performed via B-channel */ + +/* one byte sent with control messages */ +#define PH_CTRL_DISABLE 0x00 /* disable (block) interface, when socket is disconnected */ +#define PH_CTRL_ENABLE 0x01 /* enable (unblock) interface, when socket is connected */ + +struct socket_msg { + struct { + uint8_t channel; + uint8_t prim; + uint16_t length; + } header; + uint8_t data[65536]; +} __attribute__((packed)); + +struct socket_msg_list { + struct socket_msg_list *next; + struct socket_msg msg; +}; + +#define SOCKET_RETRY_TIMER 2.0 + +typedef struct ph_socket { + const char *name; + void *priv; + struct sockaddr_un sock_address; + int listen; /* socket to listen to incoming connections */ + int connect; /* socket of incoming connection */ + double connect_timer; /* time when to connect again */ + struct socket_msg_list *tx_list, **tx_list_tail; + struct socket_msg_list *rx_msg; + int rx_header_index; + int rx_data_index; +} ph_socket_t; + +int ph_socket_init(ph_socket_t *s, void *priv, const char *socket_name, int server); +void ph_socket_exit(ph_socket_t *s); +void ph_socket_tx_msg(ph_socket_t *s, int channel, uint8_t prim, uint8_t *data, int length); +void ph_socket_rx_msg(ph_socket_t *s, int channel, uint8_t prim, uint8_t *data, int length); +int ph_socket_work(ph_socket_t *s); + + diff --git a/src/uk0/uk0.c b/src/uk0/uk0.c new file mode 100644 index 0000000..2389f10 --- /dev/null +++ b/src/uk0/uk0.c @@ -0,0 +1,1694 @@ +/* implementation of UK0 Bus + * + * (C) 2022 by Andreas Eversberg + * All Rights Reserved + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#include +#include +#include +#include +#include +#include +#include +#include "../libdebug/debug.h" +#include "../libsample/sample.h" +#include "uk0.h" + +#define CHAN uk0->name + +#define SYMBOL_RATE 120000.0 +#define FRAME_RATE 1000 +#define TX_LEVEL 0.85 /* level must be below 1, so that filters inside sound card will not overdrive signal */ +#define RX_SINC_WINDOW 20 +#define RX_OVERSAMPLING 10 +//#define RX_CLOCK_FILTER (SYMBOL_RATE * 0.0001) /* 100 ppm */ +#define RX_CLOCK_FILTER 1000.0 + +#define MIN_LEVEL 0.2 + +#define SYNC_MASK 0x3fffff +#define SYNC_LT_POSITIVE 0x269a95 +#define SYNC_LT_NEGATIVE 0x19656a +#define SYNC_NT_POSITIVE 0x15a9a6 +#define SYNC_NT_NEGATIVE 0x2a5659 + +#define WAKEUP 0x5555aaaa5555aaaa + +#define LOS_CRITERION (120 * 2) /* between 1 and 2 ms */ + +#define SYNC_RECOVER 2 /* if subsequent syncs are not received when expected, hut for a new one */ + +/* uncomment this to debug 4B3T */ +//#define DEBUG_TABLE + +/* uncomment to debug rx sound */ +//#define DEBUG_RECORD_RX + +/* uncomment to use upsampled signal when debugging rx sound */ +//#define DEBUG_RECORD_UPSAMPLE + +/* uncomment this to debug frame decoding and encoding */ +//#define DEBUG_FRAME + +/* uncomment this to debug scrambler and descrambler */ +//#define DEBUG_SCRAMBLER + +/* uncomment this to loop HDLC back to upper layer */ +//#define HDLC_LOOPBACK + +/* + * tables for transcoding + */ + +struct mms43_def { + const char *bits; + struct { + const char *symbols; + int next; + } column[4]; +} mms43_def[16] = { + { "0001", { { "0-+", 1 }, { "0-+", 2 }, { "0-+", 3 }, { "0-+", 4 } } }, + { "0111", { { "-0+", 1 }, { "-0+", 2 }, { "-0+", 3 }, { "-0+", 4 } } }, + { "0100", { { "-+0", 1 }, { "-+0", 2 }, { "-+0", 3 }, { "-+0", 4 } } }, + { "0010", { { "+-0", 1 }, { "+-0", 2 }, { "+-0", 3 }, { "+-0", 4 } } }, + { "1011", { { "+0-", 1 }, { "+0-", 2 }, { "+0-", 3 }, { "+0-", 4 } } }, + { "1110", { { "0+-", 1 }, { "0+-", 2 }, { "0+-", 3 }, { "0+-", 4 } } }, + { "1001", { { "+-+", 2 }, { "+-+", 3 }, { "+-+", 4 }, { "---", 1 } } }, + { "0011", { { "00+", 2 }, { "00+", 3 }, { "00+", 4 }, { "--0", 2 } } }, + { "1101", { { "0+0", 2 }, { "0+0", 3 }, { "0+0", 4 }, { "-0-", 2 } } }, + { "1000", { { "+00", 2 }, { "+00", 3 }, { "+00", 4 }, { "0--", 2 } } }, + { "0110", { { "-++", 2 }, { "-++", 3 }, { "--+", 2 }, { "--+", 3 } } }, + { "1010", { { "++-", 2 }, { "++-", 3 }, { "+--", 2 }, { "+--", 3 } } }, + { "1111", { { "++0", 3 }, { "00-", 1 }, { "00-", 2 }, { "00-", 3 } } }, + { "0000", { { "+0+", 3 }, { "0-0", 1 }, { "0-0", 2 }, { "0-0", 3 } } }, + { "0101", { { "0++", 3 }, { "-00", 1 }, { "-00", 2 }, { "-00", 3 } } }, + { "1100", { { "+++", 4 }, { "-+-", 1 }, { "-+-", 2 }, { "-+-", 3 } } }, +}; + +/* encoding table: the 6 lower bits define three symbols (0 = 0, + = 1, - = 2), the 2 upper bits define next column */ +uint8_t mms43_encode[16][4]; + +/* decoding table: the 3 symbols result in 4 bits */ +uint8_t mms43_decode[64]; + +static void generate_mms43_code(void) +{ + uint8_t bits, symbols; + uint16_t used_bits = 0; + int i, j, k; + + /* encoding table */ + for (i = 0; i < 16; i++) { + bits = mms43_def[i].bits[0] - '0'; + bits |= (mms43_def[i].bits[1] - '0') << 1; + bits |= (mms43_def[i].bits[2] - '0') << 2; + bits |= (mms43_def[i].bits[3] - '0') << 3; + used_bits |= 1 << bits; + for (j = 0; j < 4; j++) { + symbols = (mms43_def[i].column[j].next - 1) << 6; + for (k = 0; k < 3; k++) { + switch (mms43_def[i].column[j].symbols[k]) { + case '0': + break; + case '+': + symbols |= 1 << (k * 2); + break; + case '-': + symbols |= 2 << (k * 2); + break; + default: + PDEBUG(DUK0, DEBUG_ERROR, "Illegal symbol, please fix!\n"); + abort(); + } + } + mms43_encode[bits][j] = symbols; + } + } + if (used_bits != 0xffff) { + PDEBUG(DUK0, DEBUG_ERROR, "Not all 16 different bit combinations are defined, please fix!\n"); + abort(); + } + + /* decoding table */ +#ifdef DEBUG_TABLE + printf("encoding:\n"); +#endif + memset(mms43_decode, 0xff, 64); + for (i = 0; i < 16; i++) { +#ifdef DEBUG_TABLE + printf("%d%d%d%d: ", i & 1, (i >> 1) & 1, (i >> 2) & 1, (i >> 3) & 1); +#endif + for (j = 0; j < 4; j++) { + mms43_decode[mms43_encode[i][j] & 0x3f] = i; + for (k = 0; k < 3; k++) { + switch((mms43_encode[i][j] >> (k * 2)) & 3) { + case 1: +#ifdef DEBUG_TABLE + printf("+"); +#endif + break; + case 2: +#ifdef DEBUG_TABLE + printf("-"); +#endif + break; + case 0: +#ifdef DEBUG_TABLE + printf("0"); +#endif + break; + default: +#ifdef DEBUG_TABLE + printf("?"); +#endif + ; + } + } +#ifdef DEBUG_TABLE + printf(" %d ", ((mms43_encode[i][j] >> (k * 2)) & 3) + 1); +#endif + } +#ifdef DEBUG_TABLE + printf("\n"); +#endif + } + mms43_decode[0] = 0; /* special case T(000)->B(0000) */ + +#ifdef DEBUG_TABLE + printf("decoding:\n"); +#endif + for (i = 0; i < 16; i++) { +#ifdef DEBUG_TABLE + printf("%d%d%d%d: ", i & 1, (i >> 1) & 1, (i >> 2) & 1, (i >> 3) & 1); +#endif + for (j = 0; j < 64; j++) { + if (mms43_decode[j] == i) { + for (k = 0; k < 3; k++) { + switch((j >> (k * 2)) & 3) { + case 1: +#ifdef DEBUG_TABLE + printf("+"); +#endif + break; + case 2: +#ifdef DEBUG_TABLE + printf("-"); +#endif + break; + case 0: +#ifdef DEBUG_TABLE + printf("0"); +#endif + break; + default: +#ifdef DEBUG_TABLE + printf("?"); +#endif + ; + } + } +#ifdef DEBUG_TABLE + printf(" "); +#endif + } + } +#ifdef DEBUG_TABLE + printf("\n"); +#endif + } +#ifdef DEBUG_TABLE + exit(0); +#endif +} + +/* + * instance creation and destruction + */ + +/* init globals */ +void uk0_init(void) +{ + generate_mms43_code(); +} + +/* open UK0 Interface */ +uk0_t *uk0_create(const char *name, int samplerate, int buffer_size) +{ + uk0_t *uk0; + uk0_tx_t *tx; + uk0_rx_t *rx; + double x, l; + int i; + + uk0 = calloc(1, sizeof(*uk0)); + if (!uk0) + return NULL; + tx = &uk0->tx; + rx = &uk0->rx; + + uk0->name = name; + + /* delay that is greater than sound card loop (in milliseconds), also there must be some frames to wait until we receive framing */ + uk0->ti1 = buffer_size * 1000 / samplerate + 32; /* sound card delay + 32 frames */ + + /* one ms ti2 */ + uk0->ti2 = 1; + + /* prepare TX queue */ + for (i = 0; i < 3; i++) + uk0->tx_queue_tail[i] = &uk0->tx_queue[i]; + + /* prepare TX */ + tx->phase_step = SYMBOL_RATE / (double)samplerate; + + tx->scramble = ~0; + tx->mms43_column = 0; + + /* prepare RX */ + rx->window_length = RX_SINC_WINDOW * RX_OVERSAMPLING; + rx->sinc = calloc(rx->window_length, sizeof(*rx->sinc)); + if (!rx->sinc) + return NULL; + rx->window = calloc(rx->window_length, sizeof(*rx->window)); + if (!rx->window) + return NULL; + + for (i = 0; i < rx->window_length; i++) { + x = M_PI * (double)(i - (rx->window_length >> 1)) / (double)RX_OVERSAMPLING; + if (fabs(x) < 0.000001) + l = 1; + else + l = sin(x)/x; + l *= 0.54 - 0.46 * cos(2.0 * M_PI * (double)i / (double)rx->window_length); + rx->sinc[i] = l; +// puts(debug_amplitude(rx->sinc[i])); + } + + rx->phase_step = 2.0 * M_PI * SYMBOL_RATE / ((double)samplerate * (double)RX_OVERSAMPLING); + rx->ms_per_sample = 1000.0 / ((double)samplerate * (double)RX_OVERSAMPLING); + /* use fourth order (2 iter) filter, since it is as fast as second order (1 iter) filter */ + /* symbol rate divided by 10000 equals 100 ppm tolerance */ + iir_lowpass_init(&rx->lp[0], RX_CLOCK_FILTER, samplerate * RX_OVERSAMPLING, 2); + iir_lowpass_init(&rx->lp[1], RX_CLOCK_FILTER, samplerate * RX_OVERSAMPLING, 2); + + rx->descramble = 0; + + /* recording for debugging */ +#ifdef DEBUG_RECORD_RX +#ifdef DEBUG_RECORD_UPSAMPLE + wave_create_record(&rx->rec, "uk0.wav", samplerate * RX_OVERSAMPLING, 1, 1.0); +#else + wave_create_record(&rx->rec, "uk0.wav", samplerate, 1, 1.0); +#endif +#endif + + /* measurement */ + display_wave_init(&uk0->dispwav, samplerate, uk0->name); + uk0->measure_level_interval = (int)(SYMBOL_RATE / 30.0); + uk0->measure_frame_interval = FRAME_RATE / 10; + display_measurements_init(&uk0->dispmeas, samplerate, uk0->name); + uk0->dmp_level = display_measurements_add(&uk0->dispmeas, "RX Level", "%.0f %%", DISPLAY_MEAS_PEAK, DISPLAY_MEAS_LEFT, 0.0, 100.0, 100.0); + uk0->dmp_level_error = display_measurements_add(&uk0->dispmeas, "RX Level Error", "%.0f %%", DISPLAY_MEAS_LAST, DISPLAY_MEAS_LEFT, 0.0, 100.0, 100.0); + + PDEBUG_CHAN(DUK0, DEBUG_INFO, "UK0 has been created.\n"); + + return uk0; +} + +/* close UK0 Interface */ +void uk0_destroy(uk0_t *uk0) +{ + uk0_rx_t *rx = &uk0->rx; + int i; + + PDEBUG_CHAN(DUK0, DEBUG_INFO, "UK0 is beeing destroyed!\n"); + + if (rx->sinc) { + free(rx->sinc); + rx->sinc = NULL; + } + if (rx->window) { + free(rx->window); + rx->window = NULL; + } + + for (i = 0; i < 3; i++) + uk0_tx_flush(uk0, i + 1); + +#ifdef DEBUG_RECORD_RX + wave_destroy_record(&rx->rec); +#endif + + free(uk0); +} + +/* + * queue and dejitter + */ + +void uk0_tx_flush(uk0_t *uk0, int channel) +{ + struct tx_queue *msg; + int i; + + if (channel < 1 || channel > 3) + return; + i = channel - 1; + + while (uk0->tx_queue[i]) { + msg = uk0->tx_queue[i]; + uk0->tx_queue[i] = msg->next; + free(msg); + } + uk0->tx_queue_tail[i] = &uk0->tx_queue[i]; + uk0->tx_queue_size[i] = 0; +} + +void uk0_tx_enqueue(uk0_t *uk0, int channel, uint8_t *data, int length) +{ + struct tx_queue *msg; + int i; + + if (length < 1) + return; + + if (channel < 1 || channel > 3) + return; + i = channel - 1; + + if (uk0->tx_queue_size[i] > 800) { + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Dropping data on channel %d, due to overfilled transmit buffer.\n", channel); + return; + } + + msg = calloc(1, sizeof(*msg) + length); + memcpy(msg->data, data, length); + msg->length = length; + *uk0->tx_queue_tail[i] = msg; + uk0->tx_queue_tail[i] = &msg->next; + uk0->tx_queue_size[i] += length; +} + +int uk0_tx_dequeue(uk0_t *uk0, int channel, uint8_t *data, int size) +{ + struct tx_queue *msg; + int i, length; + + if (channel < 1 || channel > 3) + return 0; + i = channel - 1; + + if (!uk0->tx_queue[i]) + return 0; + + msg = uk0->tx_queue[i]; + if (msg->length <= size) { + memcpy(data, msg->data, msg->length); + length = msg->length; + } else { + length = 0; + } + uk0->tx_queue_size[i] -= msg->length; + uk0->tx_queue[i] = msg->next; + free(msg); + if (!uk0->tx_queue[i]) + uk0->tx_queue_tail[i] = &uk0->tx_queue[i]; + + return length; +} + +/* + * channel multiplexing + */ + +/* inject B+B+D channels from frame */ +static void mux_frame(uk0_t *uk0, uint8_t *data) +{ + uk0_tx_t *tx = &uk0->tx; + uint8_t *B1 = tx->B1 + tx->b_count; + uint8_t *B2 = tx->B2 + tx->b_count; + uint8_t *D = tx->D + tx->d_count; + + if (tx->b_count == 0) { + uk0_send(uk0, 1, tx->B1, TX_NUM_B); + uk0_send(uk0, 2, tx->B2, TX_NUM_B); +#ifdef HDLC_LOOPBACK + uk0_receive(uk0, 1, tx->B1, TX_NUM_B); + uk0_receive(uk0, 2, tx->B2, TX_NUM_B); +#endif + } + if (tx->d_count == 0) { + uk0_send(uk0, 3, tx->D, TX_NUM_D); +#ifdef HDLC_LOOPBACK + printf("hdlc encoded data: %s\n", debug_hex(tx->D, TX_NUM_D)); + uk0_receive(uk0, 3, tx->D, TX_NUM_D); +#endif + } + + /* B1(1..8) B2(1..8) D(1..2) */ + data[0] = B1[0]; + data[1] = B2[0]; + data[2] = D[0] & 0x03; + + /* B1(1..8) B2(1..8) D(3..4) */ + data[2] |= B1[1] << 2; + data[3] = B1[1] >> 6; + data[3] |= B2[1] << 2; + data[4] = B2[1] >> 6; + data[4] |= D[0] & 0x0c; + + /* B1(1..8) B2(1..8) D(5..6) */ + data[4] |= B1[2] << 4; + data[5] = B1[2] >> 4; + data[5] |= B2[2] << 4; + data[6] = B2[2] >> 4; + data[6] |= D[0] & 0x30; + + /* B1(1..8) B2(1..8) D(7..8) */ + data[6] |= B1[3] << 6; + data[7] = B1[3] >> 2; + data[7] |= B2[3] << 6; + data[8] = B2[3] >> 2; + data[8] |= D[0] & 0xc0; + + /* B1(1..8) B2(1..8) D(1..2) */ + data[9] = B1[4]; + data[10] = B2[4]; + data[11] = D[1] & 0x03; + + /* B1(1..8) B2(1..8) D(3..4) */ + data[11] |= B1[5] << 2; + data[12] = B1[5] >> 6; + data[12] |= B2[5] << 2; + data[13] = B2[5] >> 6; + data[13] |= D[1] & 0x0c; + + /* B1(1..8) B2(1..8) D(5..6) */ + data[13] |= B1[6] << 4; + data[14] = B1[6] >> 4; + data[14] |= B2[6] << 4; + data[15] = B2[6] >> 4; + data[15] |= D[1] & 0x30; + + /* B1(1..8) B2(1..8) D(7..8) */ + data[15] |= B1[7] << 6; + data[16] = B1[7] >> 2; + data[16] |= B2[7] << 6; + data[17] = B2[7] >> 2; + data[17] |= D[1] & 0xc0; + + tx->b_count += 8; + tx->d_count += 2; + if (tx->b_count == TX_NUM_B) + tx->b_count = 0; + if (tx->d_count == TX_NUM_D) + tx->d_count = 0; +} + +/* extract B+B+D channels from frame */ +static void demux_frame(uk0_t *uk0, uint8_t *data) +{ + uk0_rx_t *rx = &uk0->rx; + uint8_t *B1 = rx->B1 + rx->b_count; + uint8_t *B2 = rx->B2 + rx->b_count; + uint8_t *D = rx->D + rx->d_count; + + /* B1(1..8) B2(1..8) D(1..2) */ + B1[0] = data[0]; + B2[0] = data[1]; + D[0] = data[2] & 0x03; + + /* B1(1..8) B2(1..8) D(3..4) */ + B1[1] = data[2] >> 2; + B1[1] |= data[3] << 6; + B2[1] = data[3] >> 2; + B2[1] |= data[4] << 6; + D[0] |= data[4] & 0x0c; + + /* B1(1..8) B2(1..8) D(5..6) */ + B1[2] = data[4] >> 4; + B1[2] |= data[5] << 4; + B2[2] = data[5] >> 4; + B2[2] |= data[6] << 4; + D[0] |= data[6] & 0x30; + + /* B1(1..8) B2(1..8) D(7..8) */ + B1[3] = data[6] >> 6; + B1[3] |= data[7] << 2; + B2[3] = data[7] >> 6; + B2[3] |= data[8] << 2; + D[0] |= data[8] & 0xc0; + + /* B1(1..8) B2(1..8) D(1..2) */ + B1[4] = data[9]; + B2[4] = data[10]; + D[1] = data[11] & 0x03; + + /* B1(1..8) B2(1..8) D(3..4) */ + B1[5] = data[11] >> 2; + B1[5] |= data[12] << 6; + B2[5] = data[12] >> 2; + B2[5] |= data[13] << 6; + D[1] |= data[13] & 0x0c; + + /* B1(1..8) B2(1..8) D(5..6) */ + B1[6] = data[13] >> 4; + B1[6] |= data[14] << 4; + B2[6] = data[14] >> 4; + B2[6] |= data[15] << 4; + D[1] |= data[15] & 0x30; + + /* B1(1..8) B2(1..8) D(7..8) */ + B1[7] = data[15] >> 6; + B1[7] |= data[16] << 2; + B2[7] = data[16] >> 6; + B2[7] |= data[17] << 2; + D[1] |= data[17] & 0xc0; + + rx->b_count += 8; + rx->d_count += 2; + if (rx->b_count == RX_NUM_B) { + rx->b_count = 0; +#ifndef HDLC_LOOPBACK + uk0_receive(uk0, 1, rx->B1, RX_NUM_B); + uk0_receive(uk0, 2, rx->B2, RX_NUM_B); +#endif + } + if (rx->d_count == RX_NUM_D) { + rx->d_count = 0; +#ifndef HDLC_LOOPBACK + uk0_receive(uk0, 3, rx->D, RX_NUM_D); +#endif + } +} + +/* + * LT state machine + */ + +static const char *uk0_state_names[] = { + "NULL", + "LT 1.1", + "LT 1.2", + "LT 1.3", + "LT 1.4", + "LT 1.5", + "LT 1.6", + "LT 1.7", + "LT 1.8", +}; + +static const char *uk0_event_names[] = { + "DISABLE", + "ENABLE", + "DEACTIVATE", + "ACTIVATE", + "TIMEOUT", + "U0", + "U1W", + "U1A", + "U1", + "U3", + "U5", + "SP", + "ANY", +}; + +/* sub function to change state */ +static void uk0_new_state(uk0_t *uk0, enum uk0_state new_state) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Changing call state from %s to %s.\n", uk0_state_names[uk0->state], uk0_state_names[new_state]); + uk0->state = new_state; +} + +/* enable interface */ +void uk0_enable(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Enable interface.\n"); + hdlc_tx_init(&uk0->hdlc_tx[2], uk0, 3, HDLC_MODE_HDLC); + hdlc_rx_init(&uk0->hdlc_rx[2], uk0, 3, HDLC_MODE_HDLC); + uk0_new_state(uk0, UK0_STATE_LT_1_1); +} + +/* completely disable interface */ +void uk0_disable(uk0_t *uk0) +{ + int i; + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Disable interface.\n"); + for (i = 0; i < 3; i++) { + hdlc_tx_init(&uk0->hdlc_tx[i], uk0, i + 1, HDLC_MODE_OFF); + hdlc_rx_init(&uk0->hdlc_rx[i], uk0, i + 1, HDLC_MODE_OFF); + uk0_tx_flush(uk0, i + 1); + } + uk0_new_state(uk0, UK0_STATE_NULL); +} + +/* sub function to activate from upper layer */ +void uk0_activate(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Activation request by LT, sending U2W to wake up NT.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_3); + /* start timer for resending U1W */ + uk0->timer = uk0->ti1; +} + +/* sub function to activate from remote NT */ +void uk0_u1w_indication(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Receive U1W activation request by NT, sending U2W to NT to acknowledge.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_2); + uk0->timer = uk0->ti1; + /* we don't wait for TI1 (7ms), because we have more delay + * we send U1W, then send U0 for 7ms, then send U2 until timeout + * then we transit to LT 1.4 + */ +} + +/* sub function to handle TI1 timeout */ +void uk0_timeout_ti1(uk0_t *uk0) +{ + /* after sending LT U2W, transit to LT 1.4 */ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Done sending U2W, wait for framing or wake up signal again.\n"); + uk0->timer = uk0->ti1; + uk0_new_state(uk0, UK0_STATE_LT_1_1); +} + +/* sub function to transit to LT 1.4 */ +void uk0_got_framing(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "We got some framing now.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_4); +} + +/* sub function to handle U1 */ +void uk0_u1(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Got U1 from NT.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_5); +} + +/* sub function to handle U3 */ +void uk0_u3(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Got U3 from NT, send U4H.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_6); + uk0->timer = uk0->ti2; /* one ms */ +} + +/* sub function to handle TI2 timeout */ +void uk0_timeout_ti2(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Done sending U4H, activation complete.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_7); + ph_socket_tx_msg(&uk0->ph_socket, 3, PH_PRIM_ACT_IND, NULL, 0); +} + +/* sub function to handle deactivation from NT */ +void uk0_u0(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Received U0 from NT, send U0.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_1); + ph_socket_tx_msg(&uk0->ph_socket, 3, PH_PRIM_DACT_IND, NULL, 0); +} + +/* sub function to handle deactivation from upper layer */ +void uk0_deactivate(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "We deactivate, send U0.\n"); + if (uk0->state == UK0_STATE_LT_1_4 + || uk0->state == UK0_STATE_LT_1_5 + || uk0->state == UK0_STATE_LT_1_6 + || uk0->state == UK0_STATE_LT_1_7) + uk0_new_state(uk0, UK0_STATE_LT_1_8); + else + uk0_new_state(uk0, UK0_STATE_LT_1_1); +} + +/* sub function to handle deactivation confirm from NT */ +void uk0_deactivated(uk0_t *uk0) +{ + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Deactivation complete.\n"); + uk0_new_state(uk0, UK0_STATE_LT_1_1); + ph_socket_tx_msg(&uk0->ph_socket, 3, PH_PRIM_DACT_IND, NULL, 0); +} + +/* we confirm activation, if already */ +void uk0_already_activated(uk0_t *uk0) +{ + ph_socket_tx_msg(&uk0->ph_socket, 3, PH_PRIM_ACT_IND, NULL, 0); +} + +#define SBIT(a) (1 << a) +#define ALL_STATES (~0) + +/* UK0 state machine */ +static struct statemachine { + uint32_t states; + enum uk0_event event; + void (*action)(uk0_t *uk0); +} statemachine_list[] = { + /* enable und disable */ + {SBIT(UK0_STATE_NULL), + UK0_EVENT_ENABLE, uk0_enable}, + {SBIT(UK0_STATE_NULL), + UK0_EVENT_ANY, NULL}, + {ALL_STATES, + UK0_EVENT_DISABLE, uk0_disable}, + + /* deactivation */ + {ALL_STATES, + UK0_EVENT_DEACTIVATE, uk0_deactivate}, + {SBIT(UK0_STATE_LT_1_8), + UK0_EVENT_U0, uk0_deactivated}, + {SBIT(UK0_STATE_LT_1_8), + UK0_EVENT_ANY, NULL}, + + /* activate from upper layer */ + {SBIT(UK0_STATE_LT_1_1), + UK0_EVENT_ACTIVATE, uk0_activate}, + {SBIT(UK0_STATE_LT_1_7), + UK0_EVENT_ACTIVATE, uk0_already_activated}, + {SBIT(UK0_STATE_LT_1_3), + UK0_EVENT_TIMEOUT, uk0_activate}, + + /* activate from NT */ + {SBIT(UK0_STATE_LT_1_1), + UK0_EVENT_U1W, uk0_u1w_indication}, + {SBIT(UK0_STATE_LT_1_2), + UK0_EVENT_TIMEOUT, uk0_timeout_ti1}, + + /* when we got framing we go to LT 1.4 */ + {SBIT(UK0_STATE_LT_1_2) | SBIT(UK0_STATE_LT_1_3), + UK0_EVENT_U1A, uk0_got_framing}, + {SBIT(UK0_STATE_LT_1_2) | SBIT(UK0_STATE_LT_1_3), + UK0_EVENT_U1, uk0_got_framing}, + {SBIT(UK0_STATE_LT_1_2) | SBIT(UK0_STATE_LT_1_3), + UK0_EVENT_U3, uk0_got_framing}, + {SBIT(UK0_STATE_LT_1_2) | SBIT(UK0_STATE_LT_1_3), + UK0_EVENT_ANY, NULL}, + + /* ignore any other signal in idle state */ + {SBIT(UK0_STATE_LT_1_1), + UK0_EVENT_ANY, NULL}, + + /* wait for sync or fall back on wake up */ + {SBIT(UK0_STATE_LT_1_4), + UK0_EVENT_U0, uk0_activate}, + {SBIT(UK0_STATE_LT_1_4), + UK0_EVENT_U1W, uk0_u1w_indication}, + {SBIT(UK0_STATE_LT_1_4), + UK0_EVENT_U1A, NULL}, + + /* we complete framing */ + {SBIT(UK0_STATE_LT_1_4), + UK0_EVENT_U1, uk0_u1}, + {SBIT(UK0_STATE_LT_1_4), + UK0_EVENT_U3, uk0_u3}, + {SBIT(UK0_STATE_LT_1_5), + UK0_EVENT_U0, uk0_u0}, + {SBIT(UK0_STATE_LT_1_5), + UK0_EVENT_U3, uk0_u3}, + {SBIT(UK0_STATE_LT_1_5), + UK0_EVENT_ANY, NULL}, + {SBIT(UK0_STATE_LT_1_6), + UK0_EVENT_U0, uk0_u0}, + {SBIT(UK0_STATE_LT_1_6), + UK0_EVENT_TIMEOUT, uk0_timeout_ti2}, + {SBIT(UK0_STATE_LT_1_6), + UK0_EVENT_ANY, NULL}, + + /* framing complete */ + {SBIT(UK0_STATE_LT_1_7), + UK0_EVENT_U0, uk0_u0}, + {SBIT(UK0_STATE_LT_1_7), + UK0_EVENT_ANY, NULL}, +}; + +#define STATEMACHINE_LEN \ + (sizeof(statemachine_list) / sizeof(struct statemachine)) + +/* handle event on state machine */ +void uk0_handle_event(uk0_t *uk0, enum uk0_event event) +{ + int i; + + /* find action for event in current state */ + for (i = 0; i < (int)STATEMACHINE_LEN; i++) { + if ((event == statemachine_list[i].event + || statemachine_list[i].event == UK0_EVENT_ANY) + && ((1 << uk0->state) & statemachine_list[i].states)) { + break; + } + } + if (i == STATEMACHINE_LEN) { + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Event %s unhandled at state %s\n", + uk0_event_names[event], uk0_state_names[uk0->state]); + return; + } + + if (statemachine_list[i].action) { + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Event message %s at state %s\n", + uk0_event_names[event], uk0_state_names[uk0->state]); + statemachine_list[i].action(uk0); + } +} + +void ph_socket_rx_msg(ph_socket_t *s, int channel, uint8_t prim, uint8_t *data, int length) +{ + uk0_t *uk0 = (uk0_t *)s->priv; + hdlc_tx_t *hdlc_tx = NULL; + hdlc_rx_t *hdlc_rx = NULL; + int hdlc = 0; + + /* no channel specific messages */ + switch (prim) { + case PH_PRIM_CTRL_REQ: + if (length >= 1) { + switch (data[0]) { + case PH_CTRL_ENABLE: + uk0_handle_event(uk0, UK0_EVENT_ENABLE); + return; + case PH_CTRL_DISABLE: + uk0_handle_event(uk0, UK0_EVENT_DISABLE); + return; + } + } + break; + } + + if (channel >= 1 && channel <= 3) { + hdlc_tx = &uk0->hdlc_tx[channel - 1]; + hdlc_rx = &uk0->hdlc_rx[channel - 1]; + } else { + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Rejecting message 0x%02x for unsupported channel %d!\n", prim, channel); + return; + } + + switch (prim) { + case PH_PRIM_DATA_REQ: + uk0_tx_enqueue(uk0, channel, data, length); + break; + case PH_PRIM_ACT_REQ: + if (length >= 1 && data[0] == PH_MODE_HDLC) + hdlc = 1; + if (channel == 3) { + /* reset transmitter to clean up residual data FIXME: somewhere else? */ + hdlc_tx_init(hdlc_tx, uk0, channel, HDLC_MODE_HDLC); + uk0_handle_event(uk0, UK0_EVENT_ACTIVATE); + break; + } + hdlc_tx_init(hdlc_tx, uk0, channel, (hdlc) ? HDLC_MODE_HDLC : HDLC_MODE_TRANS); + hdlc_rx_init(hdlc_rx, uk0, channel, (hdlc) ? HDLC_MODE_HDLC : HDLC_MODE_TRANS); + /* confirm */ + ph_socket_tx_msg(&uk0->ph_socket, channel, PH_PRIM_ACT_IND, NULL, 0); + break; + case PH_PRIM_DACT_REQ: + uk0_tx_flush(uk0, channel); + if (channel == 3) { + uk0_handle_event(uk0, UK0_EVENT_DEACTIVATE); + break; + } + hdlc_tx_init(hdlc_tx, uk0, channel, HDLC_MODE_OFF); + hdlc_rx_init(hdlc_rx, uk0, channel, HDLC_MODE_OFF); + /* confirm */ + ph_socket_tx_msg(&uk0->ph_socket, channel, PH_PRIM_DACT_IND, NULL, 0); + break; + default: + PDEBUG_CHAN(DPH, DEBUG_ERROR, "Rejecting unknown message 0x%02x!\n", prim); + } +} + +/* + * UK0 frame transcoding + */ + +static int encode_frame(uk0_tx_t *tx, uint64_t *buffer, uint8_t *data, uint32_t sync, uint8_t m) +{ + int i, j; + uint8_t bin1, bin2, in, out = 0; + uint64_t code; + uint8_t column = tx->mms43_column; + + /* scramble */ +#ifdef DEBUG_SCRAMBLER + printf("TX scramble "); +#endif + for (i = 0; i < 18; i++) { + if (m) + in = 0xff; + else + in = data[i]; +#ifdef DEBUG_SCRAMBLER + printf(" %02x", in); +#endif + for (j = 0; j < 8; j++) { + out >>= 1; + out |= ((tx->scramble >> 23) ^ (tx->scramble >> 5) ^ in) << 7; + tx->scramble |= out >> 7; + tx->scramble <<= 1; + in >>= 1; + } + data[i] = out; + } +#ifdef DEBUG_SCRAMBLER + printf("\n"); +#endif + + /* convert binary to symbols in correct order */ + bin1 = data[0] & 0xf; bin2 = data[0] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] = code & 63; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[0] |= (code & 63) << 6; + bin1 = data[1] & 0xf; bin2 = data[1] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] |= (code & 63) << 12; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[0] |= (code & 63) << 18; + bin1 = data[2] & 0xf; bin2 = data[2] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] |= (code & 63) << 24; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[0] |= (code & 63) << 30; + bin1 = data[3] & 0xf; bin2 = data[3] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] |= (code & 63) << 36; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[0] |= (code & 63) << 42; + bin1 = data[4] & 0xf; bin2 = data[4] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] |= (code & 63) << 48; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[0] |= (code & 63) << 54; + bin1 = data[5] & 0xf; bin2 = data[5] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[0] |= (code & 63) << 60; + buffer[1] = (code & 63) >> 4; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 2; + bin1 = data[6] & 0xf; bin2 = data[6] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[1] |= (code & 63) << 8; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 14; + bin1 = data[7] & 0xf; bin2 = data[7] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[1] |= (code & 63) << 20; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 26; + bin1 = data[8] & 0xf; bin2 = data[8] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[1] |= (code & 63) << 32; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 38; + bin1 = data[9] & 0xf; bin2 = data[9] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[1] |= (code & 63) << 44; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 50; + bin1 = data[10] & 0xf; bin2 = data[10] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[1] |= (code & 63) << 56; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[1] |= (code & 63) << 62; + buffer[2] = (code & 63) >> 2; + bin1 = data[11] & 0xf; bin2 = data[11] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[2] |= (code & 63) << 4; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[2] |= (code & 63) << 10; + bin1 = data[12] & 0xf; bin2 = data[12] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[2] |= (code & 63) << 16; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[2] |= (code & 63) << 22; + bin1 = data[13] & 0xf; bin2 = data[13] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[2] |= (code & 63) << 28; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[2] |= (code & 63) << 34; + buffer[2] |= (uint64_t)(m & 1) << 40; + bin1 = data[14] & 0xf; bin2 = data[14] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[2] |= (code & 63) << 42; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[2] |= (code & 63) << 48; + bin1 = data[15] & 0xf; bin2 = data[15] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[2] |= (code & 63) << 54; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[2] |= (code & 63) << 60; + buffer[3] = (code & 63) >> 4; + bin1 = data[16] & 0xf; bin2 = data[16] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[3] |= (code & 63) << 2; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[3] |= (code & 63) << 8; + bin1 = data[17] & 0xf; bin2 = data[17] >> 4; + code = mms43_encode[bin1][column]; column = code >> 6; + buffer[3] |= (code & 63) << 14; + code = mms43_encode[bin2][column]; column = code >> 6; + buffer[3] |= (code & 63) << 20; + buffer[3] |= (uint64_t)(sync & SYNC_MASK) << 26; + +#ifdef DEBUG_FRAME + int tern, s; + printf("TX frame: "); + for (s = 0; s < 120; s++) { + tern = (buffer[s >> 5] >> (2*(s&31))) & 3; + switch (tern) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + } + printf("\n"); + printf("sync: "); + for (s = 0; s < 11; s++) { + switch ((sync) >> (s*2) & 3) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + } + printf(" M: "); + switch ((m)) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + printf(" data:"); + for (i = 0; i < 18; i++) { + printf(" %x %x", data[i] & 0xf, data[i] >> 4); + } + printf("\n"); +#endif + + return 120; +} + +static int decode_frame(uk0_rx_t *rx, uint64_t *buffer, uint64_t polarity, uint8_t *data, uint32_t *sync, uint8_t *m) +{ + uint64_t buf0, buf1, buf2, buf3; + int violation = 0, i, j; + uint8_t bin1, bin2, in, out = 0; + + /* correct polarity */ + buf0 = buffer[0] ^= polarity; + buf1 = buffer[1] ^= polarity; + buf2 = buffer[2] ^= polarity; + buf3 = buffer[3] ^= polarity; + +#ifdef DEBUG_FRAME + printf("RX frame: "); + for (int s = 0; s < 120; s++) { + uint8_t tern = (buffer[s >> 5] >> (2*(s&31))) & 3; + switch (tern) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + } + printf("\n"); +#endif + + /* reorder symbols and convert to binary */ + bin1 = mms43_decode[(buf0 >> 0) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf0 >> 6) & 63]; + if (bin2 == 0xff) violation++; + data[0] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf0 >> 12) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf0 >> 18) & 63]; + if (bin2 == 0xff) violation++; + data[1] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf0 >> 24) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf0 >> 30) & 63]; + if (bin2 == 0xff) violation++; + data[2] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf0 >> 36) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf0 >> 42) & 63]; + if (bin2 == 0xff) violation++; + data[3] = bin1 | (bin2 << 4); + *m = (buf0 >> 48) & 3; + bin1 = mms43_decode[(buf0 >> 50) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf0 >> 56) & 63]; + if (bin2 == 0xff) violation++; + data[4] = bin1 | (bin2 << 4); + bin1 = mms43_decode[((buf0 >> 62) | (buf1 << 2)) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf1 >> 4) & 63]; + if (bin2 == 0xff) violation++; + data[5] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf1 >> 10) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf1 >> 16) & 63]; + if (bin2 == 0xff) violation++; + data[6] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf1 >> 22) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf1 >> 28) & 63]; + if (bin2 == 0xff) violation++; + data[7] = bin1 | (bin2 << 4); + *sync = (buf1 >> 34) & SYNC_MASK; + bin1 = mms43_decode[(buf1 >> 56) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[((buf1 >> 62) | (buf2 << 2)) & 63]; + if (bin2 == 0xff) violation++; + data[8] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf2 >> 4) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf2 >> 10) & 63]; + if (bin2 == 0xff) violation++; + data[9] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf2 >> 16) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf2 >> 22) & 63]; + if (bin2 == 0xff) violation++; + data[10] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf2 >> 28) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf2 >> 34) & 63]; + if (bin2 == 0xff) violation++; + data[11] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf2 >> 40) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf2 >> 46) & 63]; + if (bin2 == 0xff) violation++; + data[12] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf2 >> 52) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf2 >> 58) & 63]; + if (bin2 == 0xff) violation++; + data[13] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf3 >> 0) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf3 >> 6) & 63]; + if (bin2 == 0xff) violation++; + data[14] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf3 >> 12) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf3 >> 18) & 63]; + if (bin2 == 0xff) violation++; + data[15] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf3 >> 24) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf3 >> 30) & 63]; + if (bin2 == 0xff) violation++; + data[16] = bin1 | (bin2 << 4); + bin1 = mms43_decode[(buf3 >> 36) & 63]; + if (bin1 == 0xff) violation++; + bin2 = mms43_decode[(buf3 >> 42) & 63]; + if (bin2 == 0xff) violation++; + data[17] = bin1 | (bin2 << 4); + +#ifdef DEBUG_FRAME + printf("sync: "); + for (int s = 0; s < 11; s++) { + switch ((*sync) >> (s*2) & 3) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + } + printf(" M: "); + switch ((*m)) { + case 1: printf("+"); break; + case 2: printf("-"); break; + case 0: printf("0"); break; + case 3: printf("?"); break; + } + printf(" data:"); + for (i = 0; i < 18; i++) { + printf(" %x %x", data[i] & 0xf, data[i] >> 4); + } + printf(" Violation: %d\n", violation); +#endif + + /* descramble */ +#ifdef DEBUG_SCRAMBLER + printf("RX descram "); +#endif + for (i = 0; i < 18; i++) { + in = data[i]; + for (j = 0; j < 8; j++) { + out >>= 1; + out |= ((rx->descramble >> 23) ^ (rx->descramble >> 18) ^ in) << 7; + rx->descramble |= in & 1; + rx->descramble <<= 1; + in >>= 1; + } + data[i] = out; +#ifdef DEBUG_SCRAMBLER + printf(" %02x", out); +#endif + } +#ifdef DEBUG_SCRAMBLER + printf("\n"); +#endif + + return violation; +} + +/* + * modulation and demodulation + */ + +static inline uint8_t tx_symbol(uk0_t *uk0, uk0_tx_t *tx) +{ + uint8_t data[18]; + + if (tx->frame_index == tx->frame_length) { +#ifdef HDLC_LOOPBACK + switch (UK0_STATE_LT_1_7) { +#else + switch (uk0->state) { +#endif + /* in states where no data is sent */ + case UK0_STATE_NULL: + case UK0_STATE_LT_1_1: + case UK0_STATE_LT_1_8: + /* transmit zero level (transmitter off) */ + memset(tx->buffer, 0, sizeof(tx->buffer)); + tx->frame_length = 256; + break; + /* sending U2W and waiting for framing (or U1W) */ + case UK0_STATE_LT_1_2: + case UK0_STATE_LT_1_3: + if (uk0->timer == uk0->ti1) { + /* on entering 1.2, send U2W */ + tx->buffer[0] = WAKEUP; + tx->buffer[1] = WAKEUP; + tx->buffer[2] = WAKEUP; + tx->buffer[3] = WAKEUP; + tx->buffer[4] = WAKEUP; + tx->buffer[5] = WAKEUP; + tx->buffer[6] = WAKEUP; + tx->buffer[7] = WAKEUP; + tx->frame_length = 256; + } else if (uk0->timer >= uk0->ti1 - 7) { + /* then send U0 for 7ms */ + memset(tx->buffer, 0, sizeof(tx->buffer)); + tx->frame_length = 120; + } else { + /* afterwards send U2 */ + memset(data, 0x00, 18); + tx->frame_length = encode_frame(tx, tx->buffer, data, SYNC_LT_POSITIVE, 0); + } + if (--uk0->timer == 0) { + uk0_handle_event(uk0, UK0_EVENT_TIMEOUT); + } + break; + case UK0_STATE_LT_1_4: + case UK0_STATE_LT_1_5: + /* send U2 */ + memset(data, 0x00, 18); + tx->frame_length = encode_frame(tx, tx->buffer, data, SYNC_LT_POSITIVE, 0); + break; + case UK0_STATE_LT_1_6: + /* send U4H */ + memset(data, 0xff, 18); + tx->frame_length = encode_frame(tx, tx->buffer, data, SYNC_LT_POSITIVE, 0); + if (--uk0->timer == 0) { + uk0_handle_event(uk0, UK0_EVENT_TIMEOUT); + } + break; + /* send U4 */ + case UK0_STATE_LT_1_7: + mux_frame(uk0, data); + /* send all 0xff on loopback test, so we can detect if it is not received that way */ + if (uk0->loopback2) + memset(data, 0xff, sizeof(data)); + tx->frame_length = encode_frame(tx, tx->buffer, data, SYNC_LT_POSITIVE, uk0->loopback2); + break; + } + tx->frame_index = 0; + } +//printf("%c\n", tx->frame_data[tx->frame_index]); + return (tx->buffer[tx->frame_index >> 5] >> ((tx->frame_index & 31) * 2)) & 3; +} + +void uk0_encode_mms43(uk0_t *uk0, sample_t *samples, int length) +{ + uk0_tx_t *tx = &uk0->tx; + int i; + uint8_t symbol; + + /* for all samples */ + for (i = 0; i < length; i++) { + tx->phase += tx->phase_step; + if (tx->phase >= 1.0) { + /* symbol has changed */ + tx->phase -= 1.0; + tx->index++; + tx->last_level = tx->level; + symbol = tx_symbol(uk0, tx); + if (symbol == 1) + tx->level = 1.0; + else if (symbol == 2) + tx->level = -1.0; + else + tx->level = 0.0; + tx->frame_index++; + } + *samples++ = ((cos(tx->phase * M_PI) / 2.0 - 0.5) * (tx->last_level - tx->level) + tx->last_level) * TX_LEVEL; + } +} + +//#define DEBUG_RX_FRAME + +static inline void rx_symbol(uk0_t *uk0, uk0_rx_t *rx, double level_error) +{ + uint8_t data[18]; + uint32_t sync; + uint8_t m; + int i, not0, not1; + + /* process level measurement */ + if (uk0->measure_level_interval) { + uk0->measure_level_error += level_error; + if (++uk0->measure_level_index == uk0->measure_level_interval) { + level_error = uk0->measure_level_error / uk0->measure_level_index; + uk0->measure_level_index = 0; + uk0->measure_level_error = 0.0; + display_measurements_update(uk0->dmp_level, rx->rx_level * 100.0, 0.0); + if (uk0->state >= UK0_STATE_LT_1_4) + display_measurements_update(uk0->dmp_level_error, level_error * 100.0, 0.0); + } + } + + /* lost framing */ + if (rx->buffer[0] == 0 && rx->u0_detect) { + if (--rx->u0_detect == 0) { +#ifdef DEBUG_RX_FRAME + puts("lost frame"); +#endif + /* only send if we are not already in idle state */ + if (uk0->state != UK0_STATE_LT_1_1) { + uk0_handle_event(uk0, UK0_EVENT_U0); + } + return; + } + } + + /* detect wakeup, but wait 256 symbols to cease */ + if (rx->u1w_count) { + rx->u1w_count--; + } else { + if (rx->buffer[0] == WAKEUP && rx->buffer[1] == WAKEUP) { + rx->u1w_count = 256; +#ifdef DEBUG_RX_FRAME + puts("wakeup signal"); +#endif + uk0_handle_event(uk0, UK0_EVENT_U1W); + return; + } + } + + /* various sync detection */ + sync = (rx->buffer[1] >> 34) & SYNC_MASK; + if (rx->u1a_count) { + rx->u1a_count--; + if (rx->u1a_count == 0) { + if (sync == 0 && rx->buffer[0] != 0 && rx->buffer[1] != 0 && rx->buffer[2] != 0 && rx->buffer[3] != 0) { + rx->u1a_count = 120; + if (rx->u1a_detect < 4) { + rx->u1a_detect++; + } else { + rx->u0_detect = LOS_CRITERION; +#ifdef DEBUG_RX_FRAME + puts("frame sync=0"); +#endif + uk0_handle_event(uk0, UK0_EVENT_U1A); + return; + } + } else { + rx->u1a_detect = 0; + } + } + } else { + if (sync == 0 && rx->buffer[0] != 0 && rx->buffer[1] != 0 && rx->buffer[2] != 0 && rx->buffer[3] != 0) { + rx->u1a_count = 120; + } + } + + if (rx->sync_count) { + /* when 'in sync', we count until we expect next sync sequence */ + if (--rx->sync_symbols > 0) + return; + /* when we actually got a sync sequence, we reset sync counter, else we let it count to 0 */ + rx->sync_count--; + rx->sync_symbols = 120; + if (sync == rx->sync_last) + rx->sync_count = SYNC_RECOVER; + rx->u0_detect = LOS_CRITERION; + if (rx->sync_count == 0) + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Lost sync\n"); + if (rx->sync_last == SYNC_NT_POSITIVE) + decode_frame(rx, rx->buffer, 0x0000000000000000, data, &sync, &m); + else if (rx->sync_last == SYNC_NT_NEGATIVE) + decode_frame(rx, rx->buffer, 0xffffffffffffffff, data, &sync, &m); + else + return; + } else { + /* when we are not in sync, we take whatever sync sequence we receive and become 'in sync' */ + if (sync == SYNC_NT_POSITIVE) { + PDEBUG_CHAN(DUK0, DEBUG_INFO, "Sync detected\n"); + rx->sync_last = sync; + rx->sync_count = SYNC_RECOVER; + rx->sync_symbols = 120; + rx->u0_detect = LOS_CRITERION; + decode_frame(rx, rx->buffer, 0x0000000000000000, data, &sync, &m); + } else if (sync == SYNC_NT_NEGATIVE) { + PDEBUG_CHAN(DUK0, DEBUG_DEBUG, "Sync detected\n"); + rx->sync_last = sync; + rx->sync_count = SYNC_RECOVER; + rx->sync_symbols = 120; + rx->u0_detect = LOS_CRITERION; + decode_frame(rx, rx->buffer, 0xffffffffffffffff, data, &sync, &m); + } else + return; + } + + /* loopback frame error reporting */ + if (uk0->state == UK0_STATE_LT_1_7 && uk0->loopback2) { + not1 = 0; + for (i = 0; i < 18; i++) { + if (data[i] != 0xff) + not1 = 1; + } + if (not1) { + uk0->measure_frame_error++; +#ifdef DEBUG_RX_FRAME + puts("frame error in loopback mode"); +#endif + } + if (++uk0->measure_frame_index == uk0->measure_frame_interval) { + if (uk0->measure_frame_error) + PDEBUG_CHAN(DUK0, DEBUG_NOTICE, "Loopback 2 test: %d frame error%s received!\n", uk0->measure_frame_error, (uk0->measure_frame_error != 1) ? "s" : ""); + uk0->measure_frame_index = 0; + uk0->measure_frame_error = 0; + } + } else + uk0->measure_frame_error = 0; + + /* receive valid frame */ + if (uk0->state == UK0_STATE_LT_1_7) { + demux_frame(uk0, data); + return; + } + + /* U1 and U3 detection */ + not0 = not1 = 0; + for (i = 0; i < 18; i++) { + if (data[i] != 0x00) + not0 = 1; + if (data[i] != 0xff) + not1 = 1; + } + /* all data is 0 */ + if (!not0) { +#ifdef DEBUG_RX_FRAME + puts("frame sync=1 data=0"); +#endif + uk0_handle_event(uk0, UK0_EVENT_U1); + return; + } + /* all data is 1 */ + if (!not1) { +#ifdef DEBUG_RX_FRAME + puts("frame sync=1 data=1"); +#endif + uk0_handle_event(uk0, UK0_EVENT_U3); + return; + } +} + +void uk0_decode_mms43(uk0_t *uk0, sample_t *samples, int length) +{ + uk0_rx_t *rx = &uk0->rx; + int i, ii, ll = length * RX_OVERSAMPLING, j; + sample_t upsample[ll], I[ll], Q[ll]; + double spl; + double phase; + double slope; + double offset, sample_phase, error; + char __attribute__((unused)) symbol; + double level_error; + + display_wave(&uk0->dispwav, samples, length, 1.0); + + /* upsample received signal, using SINC */ + for (i = 0, ii = 0; i < length; i++) { + /* get upsampled portion from window */ + for (j = 0; j < RX_OVERSAMPLING; j++) { + upsample[ii++] = rx->window[j]; +// puts(debug_amplitude(rx->window[j])); + } + /* shift window */ + for (j = 0; j < rx->window_length - RX_OVERSAMPLING; j++) + rx->window[j] = rx->window[j + RX_OVERSAMPLING]; + /* insert zeroes at the end of window */ + for (; j < rx->window_length; j++) + rx->window[j] = 0.0; + /* add sample as SINC curve to window */ + spl = samples[i]; + for (j = 0; j < rx->window_length; j++) + rx->window[j] += rx->sinc[j] * spl; + } + + /* recover clock from symbol change, using slope of signal */ + phase = rx->phase; + for (ii = 0; ii < ll; ii++) { + /* slope of signal */ + slope = fabs(upsample[ii] - rx->last_level); +// printf("%03d %.3f %s\n", (int)(rx->phase / M_PI * 180.0), slope, debug_amplitude(slope * 10)); + rx->last_level = upsample[ii]; + /* modulate with bit clock */ + I[ii] = cos(phase) * slope; + Q[ii] = sin(phase) * slope; + phase += rx->phase_step; + if (phase >= 2.0 * M_PI) + phase -= 2.0 * M_PI; + } + /* filter clock */ + iir_process(&rx->lp[0], I, ll); + iir_process(&rx->lp[1], Q, ll); + + for (ii = 0; ii < ll; ii++) { + /* calculate min and max */ + if (upsample[ii] < rx->min) + rx->min = upsample[ii]; + if (upsample[ii] > rx->max) + rx->max = upsample[ii]; + /* every ms restart min/max calculation and correct sample phase */ + rx->count_ms += rx->ms_per_sample; + if (rx->count_ms >= 1.0) { + rx->count_ms -= 1.0; + /* calculate level thresholds */ + rx->zero = (rx->max + rx->min) / 2.0; + if ((rx->max - rx->min) / 2.0 > MIN_LEVEL) { + rx->high = rx->max; + rx->low = rx->min; + rx->high_threshold = (rx->max + rx->zero) / 2.0; + rx->low_threshold = (rx->min + rx->zero) / 2.0; + } else { + rx->high = rx->zero + MIN_LEVEL; + rx->low = rx->zero - MIN_LEVEL; + rx->high_threshold = rx->zero + MIN_LEVEL / 2.0; + rx->low_threshold = rx->zero - MIN_LEVEL / 2.0; + } + rx->rx_level = (rx->max - rx->min) / 2.0; +// printf("min=%.2f max=%.2f ", rx->min, rx->max); +#if 0 + if ((rx->max - rx->min) > MIN_LEVEL) + rx->has_signal = 1; + else + rx->has_signal = 0; +#endif + /* reset min/max */ + rx->min = rx->max = upsample[ii]; + /* calculate phase offset */ + offset = atan2(Q[0], I[0]); +// printf("offset=%03d ", (int)(offset / M_PI * 180.0)); + /* calculate sample phase */ + sample_phase = fmod(rx->phase + 3.0 * M_PI - offset, 2.0 * M_PI); + /* calculate error */ + error = fmod(sample_phase + 2.0 * M_PI - rx->sample_phase, 2.0 * M_PI); + if (error > M_PI) + error -= 2.0 * M_PI; +// printf("error=%.8f\n", error); + /* correct using error */ + rx->sample_phase += error; + } + /* discriminate symbols from signal amplitude using clock and level range */ +// printf("%03d %.3f %s\n", (int)(rx->sample_phase / M_PI * 180.0), upsample[ii], debug_amplitude(upsample[ii])); + rx->sample_phase += rx->phase_step; + if (rx->sample_phase >= 2.0 * M_PI) { + rx->sample_phase -= 2.0 * M_PI; +// puts("ping!"); + /* shift rx buffer */ + rx->buffer[0] >>= 2; + rx->buffer[0] |= rx->buffer[1] << 62; + rx->buffer[1] >>= 2; + rx->buffer[1] |= rx->buffer[2] << 62; + rx->buffer[2] >>= 2; + rx->buffer[2] |= rx->buffer[3] << 62; + rx->buffer[3] >>= 2; + if (upsample[ii] > rx->high_threshold) { + symbol = '+'; + rx->buffer[3] |= 1LL << 46; + if (uk0->measure_level_interval) + level_error = fabs((upsample[ii] - rx->high) / (rx->rx_level / 2.0)); + } else if (upsample[ii] < rx->low_threshold) { + symbol = '-'; + rx->buffer[3] |= 2LL << 46; + if (uk0->measure_level_interval) + level_error = fabs((upsample[ii] - rx->low) / (rx->rx_level / 2.0)); + } else { + symbol = '0'; + if (uk0->measure_level_interval) + level_error = fabs((upsample[ii] - rx->zero) / (rx->rx_level / 2.0)); + } +// printf("%.2f ", level_error); +// printf("%c", symbol); + rx_symbol(uk0, rx, level_error); + } + /* forward clock phase */ + rx->phase += rx->phase_step; + } + +#ifdef DEBUG_RECORD_RX +#ifdef DEBUG_RECORD_UPSAMPLE + sample_t *record[1] = { upsample }; + wave_write(&rx->rec, record, ll); +#else + sample_t *record[1] = { samples }; + wave_write(&rx->rec, record, length); +#endif +#endif +} + diff --git a/src/uk0/uk0.h b/src/uk0/uk0.h new file mode 100644 index 0000000..ac6af3f --- /dev/null +++ b/src/uk0/uk0.h @@ -0,0 +1,137 @@ + +#include "../libsample/sample.h" +#include "../libfilter/iir_filter.h" +#include "../libwave/wave.h" +#include "../libdisplay/display.h" +#include "hdlc.h" +#include "ph_socket.h" + +#define TX_NUM_B 64 /* must be a multiple of 8 (one frame) */ +#define TX_NUM_D 16 /* must be a multiple of 2 (one frame) */ + +typedef struct uk0_tx { + double phase, phase_step; + int index; + double level, last_level; + uint64_t buffer[8]; /* 256 symbols */ + int frame_length; + int frame_index; + uint8_t mms43_column; + uint32_t scramble; + uint8_t B1[TX_NUM_B], B2[TX_NUM_B], D[TX_NUM_D]; + int b_count, d_count; +} uk0_tx_t; + +#define RX_NUM_B 64 /* must be a multiple of 8 (one frame) */ +#define RX_NUM_D 16 /* must be a multiple of 2 (one frame) */ + +typedef struct uk0_rx { + wave_rec_t rec; + double *sinc; + double *window; + int window_length; + double last_level; + double phase, phase_step; /* uncorrected phase */ + double sample_phase; /* corrected phase for sample point */ + iir_filter_t lp[2]; /* filters received IQ signal */ + double count_ms, ms_per_sample; /* counter when to correct phase */ + double min, max; + double zero, low, high, low_threshold, high_threshold, rx_level; + uint64_t buffer[4]; + int u0_detect; /* counter to detect LOS */ + int u1w_count; /* counter to detect cease of U1W */ + int u1a_count, u1a_detect; /* counters to detect U1A */ + int sync_count, sync_symbols; + uint64_t sync_last; + uint32_t descramble; + uint8_t B1[RX_NUM_B], B2[RX_NUM_B], D[RX_NUM_D]; + int b_count, d_count; +} uk0_rx_t; + +enum uk0_state { + /* interface off */ + UK0_STATE_NULL = 0, + /* deactivated state, waiting for LT or NT activation */ + UK0_STATE_LT_1_1, + /* got U1W, send U2W */ + UK0_STATE_LT_1_2, + /* got activation from LT, send U2W */ + UK0_STATE_LT_1_3, + /* wait for U1 or U3 */ + UK0_STATE_LT_1_4, + /* wait for U3 */ + UK0_STATE_LT_1_5, + /* send U4H */ + UK0_STATE_LT_1_6, + /* send U4 */ + UK0_STATE_LT_1_7, + /* wait for U0 */ + UK0_STATE_LT_1_8, +}; + +enum uk0_event { + UK0_EVENT_DISABLE = 0, + UK0_EVENT_ENABLE, + UK0_EVENT_DEACTIVATE, + UK0_EVENT_ACTIVATE, + UK0_EVENT_TIMEOUT, + UK0_EVENT_U0, + UK0_EVENT_U1W, + UK0_EVENT_U1A, + UK0_EVENT_U1, + UK0_EVENT_U3, + UK0_EVENT_U5, + UK0_EVENT_SP, + UK0_EVENT_ANY, +}; + +struct tx_queue { + struct tx_queue *next; + int length; + uint8_t data[0]; +}; + +typedef struct uk0 { + const char *name; + enum uk0_state state; + int loopback2; + int ti1, ti2, timer; + uk0_tx_t tx; + uk0_rx_t rx; + hdlc_tx_t hdlc_tx[3]; + hdlc_rx_t hdlc_rx[3]; + struct tx_queue *tx_queue[3], **tx_queue_tail[3]; + int tx_queue_size[3]; + ph_socket_t ph_socket; + + /* measurements */ + int measure_level_interval; + int measure_level_index; + double measure_level_error; + int measure_frame_interval; + int measure_frame_index; + int measure_frame_error; + dispmeas_t dispmeas; /* display measurements */ + dispmeasparam_t *dmp_level; + dispmeasparam_t *dmp_level_error; + + /* wave */ + dispwav_t dispwav; /* display wave form */ + +} uk0_t; + +void uk0_init(void); +uk0_t *uk0_create(const char *name, int samplerate, int buffer_size); +void uk0_start(uk0_t *uk0); +void uk0_destroy(uk0_t *uk0); +void uk0_work(uk0_t *uk0, int buffer_size); +void uk0_send(uk0_t *uk0, int ch, uint8_t *data, int length); +void uk0_receive(uk0_t *uk0, int ch, uint8_t *data, int length); +void uk0_handle_event(uk0_t *uk0, enum uk0_event event); +void uk0_encode_mms43(uk0_t *uk0, sample_t *samples, int length); +void uk0_decode_mms43(uk0_t *uk0, sample_t *samples, int length); + +void uk0_tx_flush(uk0_t *uk0, int channel); +void uk0_tx_enqueue(uk0_t *uk0, int channel, uint8_t *data, int length); +int uk0_tx_dequeue(uk0_t *uk0, int channel, uint8_t *data, int size); +