diff --git a/openair2/LAYER2/RLC/AM_v9.2.0/COPYING b/openair2/LAYER2/RLC/AM_v9.2.0/COPYING deleted file mode 100644 index 94a9ed024d3859793618152ea559a168bbcbb5e2..0000000000000000000000000000000000000000 --- a/openair2/LAYER2/RLC/AM_v9.2.0/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - 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. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - 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 <http://www.gnu.org/licenses/>. - -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: - - <program> Copyright (C) <year> <name of author> - 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 -<http://www.gnu.org/licenses/>. - - 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 -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/openair2/LAYER2/RLC/AM_v9.2.0/README b/openair2/LAYER2/RLC/AM_v9.2.0/README deleted file mode 100644 index 527ad3e3a1ee5f0d017af079505053af13a31edc..0000000000000000000000000000000000000000 --- a/openair2/LAYER2/RLC/AM_v9.2.0/README +++ /dev/null @@ -1,37 +0,0 @@ -####################################### -WHAT IS IMPLEMENTED: -####################################### -- Segmentation and reassembly: - -- Concatenation: - -- Padding: -- Transfer of user data: - -- Error correction: - -- In-sequence delivery of upper layer PDUs: - -- Duplicate detection: - -- Flow control: - -- Sequence number check: - -- Protocol error detection and recovery: - -- Ciphering: -Not implemented - -- SDU discard: - -- Out of sequence SDU delivery: - -- Duplicate avoidance and reordering: - - - -####################################### -MEMO FOR LG: -####################################### -The uplink AMD PDU size is a semi-static value that is configured by upper layers and can only be changed through re-establishment of the AM RLC entity by upper layers. diff --git a/openair2/LAYER2/RLC/AM_v9.2.0/rlc_am_entity.h b/openair2/LAYER2/RLC/AM_v9.2.0/rlc_am_entity.h deleted file mode 100755 index 027e0d3cc4b8e30daf2f922baa65aacb976f8024..0000000000000000000000000000000000000000 --- a/openair2/LAYER2/RLC/AM_v9.2.0/rlc_am_entity.h +++ /dev/null @@ -1,531 +0,0 @@ -/******************************************************************************* - OpenAirInterface - Copyright(c) 1999 - 2014 Eurecom - - OpenAirInterface 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. - - - OpenAirInterface 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 OpenAirInterface.The full GNU General Public License is - included in this distribution in the file called "COPYING". If not, - see <http://www.gnu.org/licenses/>. - - Contact Information - OpenAirInterface Admin: openair_admin@eurecom.fr - OpenAirInterface Tech : openair_tech@eurecom.fr - OpenAirInterface Dev : openair4g-devel@eurecom.fr - - Address : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE - - *******************************************************************************/ -/*************************************************************************** - rlc_am_entity.h - - ------------------- - AUTHOR : Lionel GAUTHIER - COMPANY : EURECOM - EMAIL : Lionel.Gauthier@eurecom.fr - - ***************************************************************************/ -# ifndef __RLC_AM_ENTITY_H__ -# define __RLC_AM_ENTITY_H__ -//----------------------------------------------------------------------------- -# include "mem_block.h" -# include "rlc_am_structs.h" -# include "rlc_def.h" -# include "platform_types.h" -# include "platform_constants.h" -//----------------------------------------------------------------------------- -struct rlc_am_entity { - module_id_t module_id; - // for stats and trace purpose : - uint16_t data_plane; // act as a boolean - - uint16_t rb_id; - //----------------------------- - // polling info - //----------------------------- - uint16_t poll_pdu_trigger; - uint16_t poll_sdu_trigger; - uint16_t timer_poll_trigger; - uint16_t timer_poll_prohibit_trigger; - uint8_t last_transmission_pdu_poll_trigger; - uint8_t last_retransmission_pdu_poll_trigger; - uint8_t poll_window_trigger; - //mem_block_t *timer_rst; - uint16_t time_out_events; - //mem_block_t *timer_mrw; // if NULL : no timer is running - //uint8_t timer_mrw_is_running; - - - uint16_t timer_rst_init; - uint16_t timer_mrw_init; - - uint32_t transmitted_pdu_types; - int last_tx_status_frame; - - uint32_t *frame_tick_milliseconds; // pointer on this tick variable handled by RRC : READ ONLY - - uint8_t missing_pdu_indicator; - //----------------------------- - // tranmission - //----------------------------- - - //struct cnt_dbl_lk_list_up segmentation_buffer; // output of segmentation/concatenation function - list2_t sdu_conf_segmented; // contain sdu_headers:sdu processed by the segmentation unit. (we keep them for confirm) - list2_t sdu_discard_segmented; // contain sdu_headers:sdu processed by the segmentation unit. (we keep them for discard) - list2_t sdu_discarded; // contain sdu_headers - - list2_t discard_procedures; // contain procedures (struct rlc_am_discard_procedure) - - //struct cnt_dbl_lk_list_up transmission_buffer; // output of mux module - - //uint16_t data_pdu_size; - //uint16_t control_pdu_size; - - - - //struct cnt_list_up dcch_pdus_to_mac_layer; - //struct cnt_list_up dtch_pdus_to_mac_layer; - - //struct list_up dcch_pdus_from_mac_layer; - //struct list_up dtch_pdus_from_mac_layer; - - // implementation specific: our transmiter buffer is an array whose size must be a power of 2 -# define RLC_AM_DISCARD_REASSEMBLY_AT_LI_INDEX_0 0x00 - uint8_t discard_reassembly_after_li; // when received mrw sufi - uint16_t discard_reassembly_start_sn; - //----------------------------- - // management of received PDU for piggybacked status PDU and status PDU - //----------------------------- - struct sufi_to_insert_in_status status_in_construction[NB_MAX_SUFI]; - struct sufi_ack ack; - uint8_t sufi_to_insert_index; - //----------------------------- - // Reset - //----------------------------- - uint8_t send_status_pdu_requested; - uint8_t reset_sequence_number; - uint8_t last_received_rsn; - uint8_t max_rst; - //----------------------------- - // Mapping info - //----------------------------- - uint8_t dcch_logical_channel_identity; - uint8_t dtch_logical_channel_identity; - uint8_t nb_logical_channels_per_rlc; - //----------------------------- - // buffer occupancy measurements sent to MAC - //----------------------------- - // note occupancy of other buffers is deducted from nb elements in lists - uint32_t buffer_occupancy_retransmission_buffer; // nb of pdus - - //************************************************************** - // new members - //************************************************************** - uint8_t allocation; - uint8_t location; // UTRAN/UE - uint8_t protocol_state; - //----------------------------- - // STATE VARIABLES - //----------------------------- - uint16_t vt_s; // send state variable - // This state variable contains the "Sequence Number" of the next AMD PDU to - // be transmitted for the first time (i.e. excluding retransmitted PDUs). It - // shall be updated after the aforementioned AMD PDU is transmitted or after - // transmission of a MRW SUFI which includes SN_MRWLENGTH >VT(S) - // (see subclause 11.6). - // The initial value of this variable is 0 - - - uint16_t vt_a; // Acknowledge state variable - // This state variable contains the "Sequence Number" following the "Sequence - // Number" of the last in-sequence acknowledged AMD PDU. This forms the lower - // edge of the transmission window of acceptable acknowledgements. VT(A) shall - // be updated based on the receipt of a STATUS PDU including an ACK (see - // subclause 9.2.2.11.2) and/or an MRW_ACK SUFI (see subclause 11.6). - // The initial value of this variable is 0. For the purpose of initialising - // the protocol, this value shall be assumed to be the first "Sequence Number" - // following the last in-sequence acknowledged AMD PDU. - - - uint16_t vt_ms; // Maximum send state variable - // This state variable contains the "Sequence Number" of the first AMD PDU - // that can be rejected by the peer Receiver, VT(MS) = VT(A) + VT(WS). - // This value represents the upper edge of the transmission window. The - // transmitter shall not transmit AMD PDUs with "Sequence Number" >= VT(MS) - // unless VT(S) >= VT(MS). In that case, the AMD PDU with - // "Sequence Number" = VT(S) - 1 can also be transmitted. VT(MS) shall be - // updated when VT(A) or VT(WS) is updated. - // The initial value of this variable is Configured_Tx_Window_size. - - - uint16_t vt_pdu; - // This state variable is used when the "poll every Poll_PDU PDU" polling - // trigger is configured. It shall be incremented by 1 for each AMD PDU that - // is transmitted including both new and retransmitted AMD PDUs. When it - // becomes equal to the value Poll_PDU, a new poll shall be transmitted and - // the state variable shall be set to zero. - // The initial value of this variable is 0. - - - uint16_t vt_sdu; - // This state variable is used when the "poll every Poll_SDU SDU" polling - // trigger is configured. It shall be incremented by 1 for a given SDU when - // the AMD PDU carrying the first segment of this SDU is scheduled to be - // transmitted for the first time. When it becomes equal to the value Poll_SDU - // a new poll shall be transmitted and the state variable shall be set to - // zero. The "Polling bit" shall be set to "1" in the first transmission of - // the AMD PDU that contains the last segment of an RLC SDU (indicated either - // by the "Length Indicator" indicating the end of the SDU or by the special - // value of the HE field). - // The initial value of this variable is 0. - - - uint16_t vt_rst; // Reset state variable - // This state variable is used to count the number of times a RESET PDU is - // scheduled to be transmitted before the reset procedure is completed. - // VT(RST) shall be incremented by 1 according to subclauses 11.4.2 and - // 11.4.5.1. VT(RST) shall only be reset upon the reception of a RESET ACK - // PDU ( i.e. VT(RST) shall not be reset when an RLC reset initiated by the - // peer RLC entity occurs) unless otherwise specified in subclause 9.7.7. - // The initial value of this variable is 0. - - - uint16_t vt_mrw; // MRW command send state variable - // This state variable is used to count the number of times a MRW command is - // transmitted. VT(MRW) is incremented by 1 each time a timer Timer_MRW - // expires. VT(MRW) shall be reset when the SDU discard with explicit - // signalling procedure is terminated. - // The initial value of this variable is 0. - - - uint16_t vt_ws; // transmitter window size state variable - // This state variable contains the size that shall be used for the - // transmission window. VT(WS) shall be set equal to the WSN field when the - // transmitter receives a STATUS PDU including a WINDOW SUFI. - // The initial value of this variable is Configured_Tx_Window_size. - - - uint16_t vr_r; // Receive state variable - // This state variable contains the "Sequence Number" following that of the - // last in-sequence AMD PDU received. It shall be updated upon the receipt of - // the AMD PDU with "Sequence Number" equal to VR(R). - // The initial value of this variable is 0. For the purpose of initialising - // the protocol, this value shall be assumed to be the first "Sequence Number" - // following the last in-sequence received AMD PDU. - - - uint16_t vr_h; // Highest expected state variable - // This state variable contains the "Sequence Number" following the highest - // "Sequence Number" of any AMD PDU received or identified to be missing.. - // When a AMD PDU is received with "Sequence Number" x or a POLL SUFI is - // received with POLL_SN=x such that VR(H)<=x<VR(MR), this state variable - // shall be set equal to x+1. - // The initial value of this variable is 0. - - - uint16_t vr_mr; // Maximum acceptable Receive state variable - // This state variable contains the "Sequence Number" of the first AMD PDU - // that shall be rejected by the Receiver, - // VR(MR) = VR(R) + Configured_Rx_Window_Size.. - - - //----------------------------- - // TIMERS - //----------------------------- - list2_t rlc_am_timer_list; - - signed int timer_poll; - signed int timer_poll_init; - //This timer shall only be used when so configured by upper layers. The value - // of the timer is signalled by upper layers. In the UE this timer shall be - // started (or restarted) when the successful or unsuccessful transmission of - // a poll is indicated by lower layer. In UTRAN it should be started when a - // poll is submitted to lower layer. If x is the value of the state variable - // VT(S) after the poll was submitted to lower layer, the timer shall be - // stopped upon receiving: - // - positive acknowledgements for all the AMD PDUs with "Sequence Number" - // up to and including x - 1; or - // - a negative acknowledgement for the AMD PDU with - // "Sequence Number" = x - 1. - // If the timer expires and no STATUS PDU fulfilling the criteria above has - // been received: - // - the Receiver shall be polled once more; - // - the timer shall be restarted; and - // - the new value of VT(S) shall be saved. - // If a new poll is sent when the timer is active, the timer shall be - // restarted at the time specified above, and the value of VT(S) shall be saved. - - signed int timer_poll_prohibit; - signed int timer_poll_prohibit_init; - // This timer shall only be used when so configured by upper layers. It is - // used to prohibit transmission of polls within a certain period. The value - // of the timer is signalled by upper layers. - // In the UE this timer shall be started (or restarted) when the successful or - // unsuccessful transmission of a poll is indicated by lower layer. In UTRAN - // it should be started when a poll is submitted to lower layer. - // From the time a poll is triggered until the timer expires, polling is - // prohibited. If another poll is triggered while polling is prohibited, its - // transmission shall be delayed until the timer expires - // (see subclause 9.7.1). Only one poll shall be transmitted when - // Timer_Poll_Prohibit expires even if several polls were triggered in the - // meantime. This timer shall not be affected by the reception of STATUS PDUs. - // When Timer_Poll_Prohibit is not configured by upper layers, polling is - // never prohibited. - - - signed int timer_discard; - signed int timer_discard_init; - // This timer shall be used when timer-based SDU discard is configured by - // upper layers. The value of the timer is signalled by upper layers. In the - // transmitter, a new timer is started upon reception of an SDU from upper - // layer. - // ...In AM, if a timer expires before the corresponding SDU is acknowledged, - // "SDU discard with explicit signalling" specified in subclause 11.6 shall be - // initiated. - - - signed int timer_poll_periodic; - signed int timer_poll_periodic_init; - // This timer shall only be used when "timer based polling" is configured by - // upper layers. The value of the timer is signalled by upper layers. The - // timer shall be started when the RLC entity is created. When the timer - // expires, the RLC entity shall: - // - restart the timer; - // - if AMD PDUs are available for transmission or retransmission (not yet - // acknowledged): - // - trigger a poll. - - - signed int timer_status_prohibit; - signed int timer_status_prohibit_init; - // This timer shall only be used when so configured by upper layers. It is - // meant to prohibit the Receiver from sending consecutive acknowledgement - // status reports. A status report is an acknowledgement status report if it - // contains any of the SUFIs LIST, BITMAP, RLIST or ACK. The value of the - // timer is signalled by upper layers. - // In the UE, this timer shall be started (or restarted) when the successful - // or unsuccessful transmission of the last STATUS PDU of an acknowledgement - // status report is indicated by lower layer. In UTRAN it should be started - // when the last STATUS PDU of an acknowledgement status report is submitted - // to lower layer. - // From the time an acknowledgement status report is triggered until the - // Timer_Status_Prohibit timer expires, acknowledgement is prohibited. If - // another such status report is triggered while acknowledgement is - // prohibited, its transmission shall be delayed until the timer expires - // (see subclause 9.7.2). The status report may be updated during this time. - // The transmission of SUFIs MRW, MRW_ACK, WINDOW or NO_MORE is not restricted. - // When Timer_Status_Prohibit is not configured by upper layers, - // acknowledgment is not prohibited. - - - signed int timer_status_periodic; - signed int timer_status_periodic_init; - // This timer shall only be used when timer based status reporting is - // configured by upper layers. - // This timer shall be started when the RLC entity is created. When the timer - // expires the transmission of a status report shall be triggered and the - // timer shall be restarted. This timer can be blocked by upper layers. The - // timer shall be restarted when upper layers indicate that it is no longer - // blocked. - - - signed int timer_rst; - signed int timer_rst_init; - // This timer is meant to handle the loss of a RESET PDU by the peer entity, - // or the loss of a RESET ACK PDU from the peer entity. The value of the timer - // is signalled by upper layers. - // In the UE this timer shall be started (or restarted) when the successful or - // unsuccessful transmission of a RESET PDU is indicated by lower layer. In - // UTRAN it should be started when a RESET PDU is submitted to lower layer. - // Timer_RST shall only be stopped upon reception of a RESET ACK PDU (with - // same RSN as RESET PDU), i.e. this timer shall not be stopped when an RLC - // reset initiated by the peer RLC entity occurs. If this timer expires, the - // RESET PDU shall be retransmitted. - - - signed int timer_mrw; - signed int timer_mrw_init; - // This timer is used to trigger the retransmission of a status report - // containing an MRW SUFI field. The value of the timer is signalled by upper - // layers. - // In the UE this timer shall be started (or restarted) when the successful or - // unsuccessful transmission of a STATUS PDU containing the MRW SUFI is - // indicated by lower layer. In UTRAN, it should be started when a STATUS PDU - // containing the MRW SUFI is submitted to lower layer. - // Each time the timer expires the MRW SUFI is retransmitted. It shall be - // stopped when one of the termination criteria for the SDU discard with - // explicit signalling procedure is fulfilled (see subclause 11.6.4). - - - //----------------------------- - // PROTOCOL PARAMETERS - //----------------------------- - uint16_t max_dat; - // The maximum number of transmissions of an AMD PDU is equal to MaxDAT – 1. - // This protocol parameter represents the upper limit for state variable - // VT(DAT). When VT(DAT) equals the value MaxDAT, either RLC RESET procedure - // or SDU discard procedure shall be initiated according to the configuration - // by upper layers. - - uint16_t poll_pdu; - // This protocol parameter indicates how often the transmitter shall poll the - // Receiver in the case where "polling every Poll_PDU PDU" is configured by - // upper layers. It represents the upper limit for the state variable VT(PDU). - // When VT(PDU) equals the value Poll_PDU a poll shall be transmitted to the - // peer entity. - - uint16_t poll_sdu; - // This protocol parameter indicates how often the transmitter shall poll the - // Receiver in the case where "polling every Poll_SDU SDU" is configured by - // upper layers. It represents the upper limit for state variable VT(SDU). - // When VT(SDU) equals the value Poll_SDU a poll shall be transmitted to the - // peer entity. - - - uint16_t poll_window; - // This protocol parameter indicates when the transmitter shall poll the - // Receiver in the case where "window-based polling" is configured by upper - // layers. A poll is triggered for each AMD PDU when J >= Poll_Window, where - // J is the transmission window percentage.(see formula of J in spec document) - - - uint16_t max_rst; - // The maximum number of transmissions of a RESET PDU is equal to MaxRST – 1. - // This protocol parameter represents the upper limit for state variable - // VT(RST). When VT(RST) equals the value MaxRST, unrecoverable error shall be - // indicated to upper layers. - - - uint16_t configured_tx_window_size; - // This protocol parameter indicates both the maximum allowed transmission - // window size and the value for the state variable VT(WS). - - - //uint16_t configured_rx_window_size; - // This protocol parameter indicates the reception window size. This parameter - // is applicable both for RLC UM and AM. This parameter is only configured for - // RLC-UM in case out-of-sequence reception is supported. - - - uint16_t max_mrw; - // The maximum number of transmissions of an MRW command is equal to MaxMRW. - // This protocol parameter represents the upper limit for state variable - // VT(MRW). When VT(MRW) equals the value MaxMRW, the RLC RESET procedure - // shall be initiated. - - - uint16_t first_li_in_next_pdu; // indicates : - // value = 000000000000000 that the previous PDU was exactly - // with the last segment of an RLC SDU and there is no LI that - // indicates the end of the SDU in the previous RLC PDU. - // value = 111111111111011 The last segment of an RLC SDU was one octet - // short of exactly filling the previous RLC PDU and there is no LI that - // indicates the end of the SDU in the previous RLC PDU. The remaining one - // octet in the previous RLC PDU is ignored. - // value = 111111111111110 AMD PDU: The rest of the RLC PDU includes a - // piggybacked STATUS PDU. - // value = 111111111111111 The rest of the RLC PDU is padding. The padding - // length can be zero. - - - - //----------------------------- - // C-SAP - //----------------------------- - list_t c_sap; - - //----------------------------- - // discard - //----------------------------- - uint8_t sdu_discard_mode; - uint8_t send_mrw; - //----------------------------- - // tranmission - //----------------------------- - mem_block_t **input_sdus; // should be accessed as an array - mem_block_t *input_sdus_alloc; // allocation of the array - uint16_t size_input_sdus_buffer; - uint16_t nb_sdu; - - uint16_t next_sdu_index; // next location of incoming sdu - uint16_t current_sdu_index; - uint32_t buffer_occupancy; - // for segmentation procedures (optimization save space on stack) - uint16_t li[RLC_AM_SEGMENT_NB_MAX_LI_PER_PDU]; - - - - // implementation specific: our transmiter buffer is an array whose size must be a power of 2 - uint16_t recomputed_configured_tx_window_size; - - mem_block_t *(*rlc_segment) (struct rlc_am_entity * rlcP); - - mem_block_t *retransmission_buffer_alloc; - mem_block_t **retransmission_buffer; - - list2_t retransmission_buffer_to_send; // contains PDUs that must be immediatly retransmitted - list_t control; // contains control pdus - - uint16_t nb_pdu_requested_by_mac_on_ch1; - uint16_t nb_pdu_requested_by_mac_on_ch2; - uint16_t pdu_size; - - uint8_t li_one_byte_short_to_add_in_next_pdu; - uint8_t li_exactly_filled_to_add_in_next_pdu; - - list_t pdus_to_mac_layer_ch1; - list_t pdus_to_mac_layer_ch2; - - //----------------------------- - // receiver - //----------------------------- - sdu_size_t output_sdu_size_to_write; - mem_block_t *output_sdu_in_construction; - - mem_block_t *receiver_buffer_alloc; - mem_block_t **receiver_buffer; - - uint16_t last_reassemblied_sn; - uint16_t configured_rx_window_size; - uint16_t recomputed_configured_rx_window_size; - - list_t pdus_from_mac_layer_ch1; - list_t pdus_from_mac_layer_ch2; - - //----------------------------- - // status generation - //----------------------------- - mem_block_t *holes_alloc; - struct rlc_am_hole *holes; - uint16_t nb_missing_pdus; - uint16_t ack_sn; - uint16_t nb_holes; -# ifdef BYPASS_L1 - unsigned int pdu_counter; -# endif - - - unsigned int stat_tx_pdcp_sdu; - unsigned int stat_tx_pdcp_sdu_discarded; - unsigned int stat_tx_retransmit_pdu_unblock; - unsigned int stat_tx_retransmit_pdu_by_status; - unsigned int stat_tx_retransmit_pdu; - unsigned int stat_tx_data_pdu; - unsigned int stat_tx_control_pdu; - - unsigned int stat_rx_sdu; - unsigned int stat_rx_error_pdu; - unsigned int stat_rx_data_pdu; - unsigned int stat_rx_data_pdu_out_of_window; - unsigned int stat_rx_control_pdu; -}; -# endif