Commit 9a1b5517 authored by Lionel Gauthier's avatar Lionel Gauthier

Old rev code


git-svn-id: http://svn.eurecom.fr/openair4G/trunk@7375 818b1a75-f10b-46b9-bf7c-635c3b92a50f
parent 3c6f1e19
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>.
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
#include "rtos_header.h"
#include "platform_types.h"
#include "list.h"
#include "rlc_um_entity.h"
#include "rlc_um_structs.h"
#include "rlc_def.h"
#include "rlc_primitives.h"
#include "mac_primitives.h"
#include "rlc_um_segment_proto_extern.h"
#include "rlc_um_receiver_proto_extern.h"
#include "LAYER2/MAC/extern.h"
//#define DEBUG_RLC_UM_DATA_REQUEST
//#define DEBUG_RLC_UM_MAC_DATA_REQUEST
//#define DEBUG_RLC_UM_MAC_DATA_INDICATION
//#define DEBUG_RLC_UM_DISCARD_SDU
//-----------------------------------------------------------------------------
uint32_t rlc_um_get_buffer_occupancy (struct rlc_um_entity* rlcP);
void rlc_um_get_pdus (void* argP);
void rlc_um_rx (void* argP, struct mac_data_ind data_indP);
struct mac_status_resp rlc_um_mac_status_indication (void* rlcP, uint16_t no_tbP, uint16_t tb_sizeP, struct mac_status_ind
tx_statusP);
struct mac_data_req rlc_um_mac_data_request (void* rlcP);
void rlc_um_mac_data_indication (void* rlcP, struct mac_data_ind data_indP);
void rlc_um_data_req (void* rlcP, mem_block_t* sduP);
//-----------------------------------------------------------------------------
void
rlc_um_stat_req (struct rlc_um_entity* rlcP,
unsigned int* tx_pdcp_sdu,
unsigned int* tx_pdcp_sdu_discarded,
unsigned int* tx_data_pdu,
unsigned int* rx_sdu,
unsigned int* rx_error_pdu,
unsigned int* rx_data_pdu,
unsigned int* rx_data_pdu_out_of_window)
{
//-----------------------------------------------------------------------------
*tx_pdcp_sdu = rlcP->tx_pdcp_sdu;
*tx_pdcp_sdu_discarded = rlcP->tx_pdcp_sdu_discarded;
*tx_data_pdu = rlcP->tx_data_pdu;
*rx_sdu = rlcP->rx_sdu;
*rx_error_pdu = rlcP->rx_error_pdu;
*rx_data_pdu = rlcP->rx_data_pdu;
*rx_data_pdu_out_of_window = rlcP->rx_data_pdu_out_of_window;
}
//-----------------------------------------------------------------------------
uint32_t
rlc_um_get_buffer_occupancy (struct rlc_um_entity* rlcP)
{
//-----------------------------------------------------------------------------
if (rlcP->buffer_occupancy > 0) {
return rlcP->buffer_occupancy;
} else {
if ((rlcP->li_one_byte_short_to_add_in_next_pdu) ||
(rlcP->li_exactly_filled_to_add_in_next_pdu)) {
// WARNING LG WE ASSUME TRANSPORT BLOCKS ARE < 125 bytes
return 3; // so this is the exact size of the next TB to be sent (SN + 2LIs)
} else {
return 0;
}
}
}
//-----------------------------------------------------------------------------
void
rlc_um_get_pdus (void* argP)
{
//-----------------------------------------------------------------------------
struct rlc_um_entity* rlc = (struct rlc_um_entity*) argP;
switch (rlc->protocol_state) {
case RLC_NULL_STATE:
// from 3GPP TS 25.322 V6.1.0
// In the NULL state the RLC entity does not exist and therefore it is not possible to transfer any data through
// it.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating establishment, the RLC entity:
// - is created; and
// - enters the DATA_TRANSFER_READY state.
break;
case RLC_DATA_TRANSFER_READY_STATE:
// from 3GPP TS 25.322 V6.1.0
// In the DATA_TRANSFER_READY state, unacknowledged mode data can be exchanged between the entities
// according to subclause 11.2.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating release, the RLC entity:
// - enters the NULL state; and
// - is considered as being terminated.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating modification, the RLC entity:
// - stays in the DATA_TRANSFER_READY state;
// - modifies only the protocol parameters and timers as indicated by upper layers.
// Upon reception of a CRLC-SUSPEND-Req from upper layers, the RLC entity:
// - enters the LOCAL_SUSPEND state.
// SEND DATA TO MAC
if (rlc->data_pdu_size > 125) {
rlc_um_segment_15 (rlc);
} else {
rlc_um_segment_7 (rlc);
}
break;
case RLC_LOCAL_SUSPEND_STATE:
// from 3GPP TS 25.322 V4.2.0
// In the LOCAL_SUSPEND state, the RLC entity is suspended, i.e. it does not send UMD PDUs with SN greater than
// equal to certain specified value (see subclause 9.7.5).
// Upon reception of a CRLC-RESUME-Req from upper layers, the RLC entity:
// - enters the DATA_TRANSFER_READY state; and
// - resumes the data transmission.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating modification, the RLC entity:
// - stays in the LOCAL_SUSPEND state;
// - modifies only the protocol parameters and timers as indicated by upper layers.
// TO DO TAKE CARE OF SN : THE IMPLEMENTATION OF THIS FUNCTIONNALITY IS NOT CRITICAL
break;
default:
msg ("[RLC_UM_LITE %p] MAC_DATA_REQ UNKNOWN PROTOCOL STATE %02X hex\n", rlc, rlc->protocol_state);
}
}
//-----------------------------------------------------------------------------
void
rlc_um_rx (void* argP, struct mac_data_ind data_indP)
{
//-----------------------------------------------------------------------------
struct rlc_um_entity* rlc = (struct rlc_um_entity*) argP;
switch (rlc->protocol_state) {
case RLC_NULL_STATE:
// from 3GPP TS 25.322 V4.2.0
// In the NULL state the RLC entity does not exist and therefore it is not possible to transfer any data through
//it.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating establishment, the RLC entity:
// - is created; and
// - enters the DATA_TRANSFER_READY state.
msg ("[RLC_UM_LITE_RX %p] ERROR MAC_DATA_IND IN RLC_NULL_STATE\n", argP);
list_free (&data_indP.data);
break;
case RLC_DATA_TRANSFER_READY_STATE:
// from 3GPP TS 25.322 V4.2.0
// In the DATA_TRANSFER_READY state, unacknowledged mode data can be exchanged between the entities
// according to subclause 11.2.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating release, the RLC entity:
// - enters the NULL state; and
// - is considered as being terminated.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating modification, the RLC entity:
// - stays in the DATA_TRANSFER_READY state;
// - modifies only the protocol parameters and timers as indicated by upper layers.
// Upon reception of a CRLC-SUSPEND-Req from upper layers, the RLC entity:
// - enters the LOCAL_SUSPEND state.
data_indP.tb_size = data_indP.tb_size >> 3; // from bits to bytes
//data_indP.tb_size = (data_indP.tb_size + 7) >> 3; // from bits to bytes
// msg("[RLC_UM_LITE_RX][RB %d] tb_size %d\n",rlc->rb_id,
// data_indP.tb_size);
rlc_um_receive (rlc, data_indP);
break;
case RLC_LOCAL_SUSPEND_STATE:
// from 3GPP TS 25.322 V4.2.0
// In the LOCAL_SUSPEND state, the RLC entity is suspended, i.e. it does not send UMD PDUs with SN greater than
// equal to certain specified value (see subclause 9.7.5).
// Upon reception of a CRLC-RESUME-Req from upper layers, the RLC entity:
// - enters the DATA_TRANSFER_READY state; and
// - resumes the data transmission.
// Upon reception of a CRLC-CONFIG-Req from upper layer indicating modification, the RLC entity:
// - stays in the LOCAL_SUSPEND state;
// - modifies only the protocol parameters and timers as indicated by upper layers.
msg ("[RLC_UM_RX ] RLC_LOCAL_SUSPEND_STATE\n");
break;
default:
msg ("[RLC_UM_LITE_RX][RB %d] TX UNKNOWN PROTOCOL STATE %02X hex\n", rlc->rb_id, rlc->protocol_state);
}
}
//-----------------------------------------------------------------------------
struct mac_status_resp
rlc_um_mac_status_indication (void* rlcP, uint16_t no_tbP, uint16_t tb_sizeP, struct mac_status_ind tx_statusP)
{
//-----------------------------------------------------------------------------
struct mac_status_resp status_resp;
if (rlcP) {
((struct rlc_um_entity*) rlcP)->nb_pdu_requested_by_mac = no_tbP - ((struct rlc_um_entity*)
rlcP)->pdus_to_mac_layer.nb_elements;
//((struct rlc_um_entity *) rlcP)->data_pdu_size = (tb_sizeP + 7) >> 3;
((struct rlc_um_entity*) rlcP)->data_pdu_size = tb_sizeP >> 3;
((struct rlc_um_entity*) rlcP)->data_pdu_size_in_bits = tb_sizeP;
#ifdef NODE_RG
// msg("[RLC_UM_LITE][RB %d] MAC_STATUS_INDICATION data_pdu_size_in_bits = %d\n", ((struct rlc_um_entity *) rlcP)->rb_id, tb_sizeP);
#endif
status_resp.buffer_occupancy_in_bytes = rlc_um_get_buffer_occupancy ((struct rlc_um_entity*) rlcP);
// LG + HA : approximation of num of transport blocks 21/10/2008
if (status_resp.buffer_occupancy_in_bytes == 0 ) {
status_resp.buffer_occupancy_in_pdus = 0;
} else if ((status_resp.buffer_occupancy_in_bytes + 1) <= ((struct rlc_um_entity*) rlcP)->data_pdu_size) {
status_resp.buffer_occupancy_in_pdus = 1;
} else {
status_resp.buffer_occupancy_in_pdus = status_resp.buffer_occupancy_in_bytes / (((struct rlc_um_entity*)
rlcP)->data_pdu_size - 1);
if ( ( status_resp.buffer_occupancy_in_bytes % (((struct rlc_um_entity*)rlcP)->data_pdu_size - 1)) > 0 ) {
status_resp.buffer_occupancy_in_pdus += 1;
}
}
status_resp.rlc_info.rlc_protocol_state = ((struct rlc_um_entity*) rlcP)->protocol_state;
#ifdef TRACE_RLC_UM_TX_STATUS
if (((struct rlc_um_entity*) rlcP)->rb_id > 0) {
msg ("[RLC_UM_LITE][RB %d] MAC_STATUS_INDICATION (DATA) %d TBs -> %d TBs\n", ((struct rlc_um_entity*) rlcP)->rb_id, no_tbP,
status_resp.buffer_occupancy_in_pdus);
if ((tx_statusP.tx_status == MAC_TX_STATUS_SUCCESSFUL) && (tx_statusP.no_pdu)) {
msg ("[RLC_UM_LITE][RB %d] MAC_STATUS_INDICATION TX STATUS SUCCESSFUL %d PDUs\n", ((struct rlc_um_entity*)
rlcP)->rb_id, tx_statusP.no_pdu);
}
if ((tx_statusP.tx_status == MAC_TX_STATUS_UNSUCCESSFUL) && (tx_statusP.no_pdu)) {
msg ("[RLC_UM_LITE][RB %d] MAC_STATUS_INDICATION TX STATUS UNSUCCESSFUL %d PDUs\n", ((struct rlc_um_entity*)
rlcP)->rb_id, tx_statusP.no_pdu);
}
}
#endif
} else {
msg("[RLC] RLCp not defined!!!\n");
}
return status_resp;
}
//-----------------------------------------------------------------------------
struct mac_data_req
rlc_um_mac_data_request (void* rlcP)
{
//-----------------------------------------------------------------------------
struct mac_data_req data_req;
rlc_um_get_pdus (rlcP);
list_init (&data_req.data, NULL);
list_add_list (&((struct rlc_um_entity*) rlcP)->pdus_to_mac_layer, &data_req.data);
#ifdef DEBUG_RLC_STATS
((struct rlc_um_entity*) rlcP)->tx_pdus += data_req.data.nb_elements;
#endif
#ifdef DEBUG_RLC_UM_MAC_DATA_REQUEST
if (((struct rlc_um_entity*) rlcP)->rb_id > 10) {
msg ("[RLC_UM_LITE] TTI %d: MAC_DATA_REQUEST %d TBs on RB %d\n",
Mac_rlc_xface->frame,
data_req.data.nb_elements,
((struct rlc_um_entity*) rlcP)->rb_id);
}
#endif
data_req.buffer_occupancy_in_bytes = rlc_um_get_buffer_occupancy ((struct rlc_um_entity*) rlcP);
data_req.buffer_occupancy_in_pdus = data_req.buffer_occupancy_in_bytes / ((struct rlc_um_entity*)
rlcP)->data_pdu_size;
data_req.rlc_info.rlc_protocol_state = ((struct rlc_um_entity*) rlcP)->protocol_state;
return data_req;
}
//-----------------------------------------------------------------------------
void
rlc_um_mac_data_indication (void* rlcP, struct mac_data_ind data_indP)
{
//-----------------------------------------------------------------------------
rlc_um_rx (rlcP, data_indP);
}
//-----------------------------------------------------------------------------
void
rlc_um_data_req (void* rlcP, mem_block_t* sduP)
{
//-----------------------------------------------------------------------------
struct rlc_um_entity* rlc = (struct rlc_um_entity*) rlcP;
uint8_t use_special_li;
uint8_t insert_sdu = 0;
#ifdef DEBUG_RLC_UM_DISCARD_SDU
int index;
#endif
#ifndef USER_MODE
unsigned long int rlc_um_time_us;
int min, sec, usec;
#endif
#ifdef DEBUG_RLC_UM_DATA_REQUEST
if (rlc->rb_id > 10)
msg ("[RLC_UM_LITE] TTI %d RLC_UM_DATA_REQ size %d Bytes, rb %d, BO %ld , NB SDU %d current_sdu_index=%d next_sdu_index=%d\n",
Mac_rlc_xface->frame,
((struct rlc_um_data_req*) (sduP->data))->data_size,
rlc->rb_id,
rlc->buffer_occupancy,
rlc->nb_sdu,
rlc->current_sdu_index,
rlc->next_sdu_index);
/*#ifndef USER_MODE
rlc_um_time_us = (unsigned long int)(rt_get_time_ns ()/(RTIME)1000);
sec = (rlc_um_time_us/ 1000000);
min = (sec / 60) % 60;
sec = sec % 60;
usec = rlc_um_time_us % 1000000;
msg ("[RLC_UM_LITE][RB %d] at time %2d:%2d.%6d\n", rlc->rb_id, min, sec , usec);
#endif*/
#endif
if (rlc->input_sdus[rlc->next_sdu_index] == NULL) {
insert_sdu = 1;
} else {
// from 3GPP TS 25.322 V4.2.0
// If SDU discard has not been configured for an unacknowledged mode RLC entity, SDUs in the
// transmitter shall not be discarded unless the Transmission buffer is full.
// When the Transmission buffer in an unacknowledged mode RLC entity is full, the Sender may:
// - if segments of the SDU to be discarded have been submitted to lower layer:
// - discard the SDU without explicit signalling according to subclause 11.2.4.3.
// - otherwise, if no segments of the SDU to be discarded have been submitted to lower layer:
// - remove the SDU from the Transmission buffer without utilising any of the discard procedures.
if ((rlc->sdu_discard_mode & RLC_SDU_DISCARD_NOT_CONFIGURED)) {
if ((rlc->input_sdus[rlc->current_sdu_index])) {
#ifdef DEBUG_RLC_UM_DISCARD_SDU
msg ("[RLC_UM_LITE][RB %d] SDU DISCARDED : BUFFER OVERFLOW, BO %ld , NB SDU %d\n", rlc->rb_id, rlc->buffer_occupancy, rlc->nb_sdu);
#endif
if (((struct rlc_um_tx_sdu_management*) (rlc->input_sdus[rlc->current_sdu_index]->data))->sdu_remaining_size !=
((struct rlc_um_tx_sdu_management*) (rlc->input_sdus[rlc->current_sdu_index]->data))->sdu_size) {
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE][RB %d] Inc VT(US) in rlc_um_data_req()/discarding SDU\n", rlc->rb_id);
#endif
rlc->vt_us = (rlc->vt_us + 1) & 0x7F;
rlc->li_one_byte_short_to_add_in_next_pdu = 0;
rlc->li_exactly_filled_to_add_in_next_pdu = 1;
rlc->buffer_occupancy -= ((struct rlc_um_tx_sdu_management*)
(rlc->input_sdus[rlc->current_sdu_index]->data))->sdu_remaining_size;
} else {
rlc->buffer_occupancy -= ((struct rlc_um_tx_sdu_management*)
(rlc->input_sdus[rlc->current_sdu_index]->data))->sdu_size;
}
rlc->nb_sdu -= 1;
free_mem_block (rlc->input_sdus[rlc->current_sdu_index]);
rlc->input_sdus[rlc->current_sdu_index] = NULL;
insert_sdu = 1;
rlc->current_sdu_index = (rlc->current_sdu_index + 1) % rlc->size_input_sdus_buffer;
#ifdef DEBUG_RLC_UM_DISCARD_SDU
//msg ("[RLC_UM_LITE][RB %d] DISCARD RESULT:\n", rlc->rb_id);
//msg ("[RLC_UM_LITE][RB %d] size input buffer=%d current_sdu_index=%d next_sdu_index=%d\n", rlc->rb_id, rlc->size_input_sdus_buffer, rlc->current_sdu_index, rlc->next_sdu_index);
//for (index = 0; index < rlc->size_input_sdus_buffer; index++) {
//msg ("[RLC_UM_LITE][RB %d] BUFFER[%d]=%p\n", rlc->rb_id, index, rlc->input_sdus[index]);
//}
#endif
} else {
#ifdef DEBUG_RLC_UM_DISCARD_SDU
msg ("[RLC_UM_LITE][RB %d] DISCARD : BUFFER OVERFLOW ERROR : SHOULD FIND A SDU\n", rlc->rb_id);
msg ("[RLC_UM_LITE][RB %d] size input buffer=%d current_sdu_index=%d next_sdu_index=%d\n", rlc->rb_id, rlc->size_input_sdus_buffer, rlc->current_sdu_index,
rlc->next_sdu_index);
for (index = 0; index < rlc->size_input_sdus_buffer; index++) {
msg ("[RLC_UM_LITE][rb %d] BUFFER[%d]=%p\n", rlc->rb_id, index, rlc->input_sdus[index]);
}
#endif
}
}
}
if ((insert_sdu)) {
rlc->input_sdus[rlc->next_sdu_index] = sduP;
// IMPORTANT : do not change order of affectations
use_special_li = ((struct rlc_um_data_req*) (sduP->data))->use_special_li;
((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_size = ((struct rlc_um_data_req*) (sduP->data))->data_size;
((struct rlc_um_tx_sdu_management*) (sduP->data))->use_special_li = use_special_li;
rlc->buffer_occupancy += ((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_size;
rlc->nb_sdu += 1;
((struct rlc_um_tx_sdu_management*) (sduP->data))->first_byte = &sduP->data[sizeof (struct rlc_um_data_req_alloc)];
((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_remaining_size = ((struct rlc_um_tx_sdu_management*)
(sduP->data))->sdu_size;
((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_segmented_size = 0;
((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_creation_time = *rlc->frame_tick_milliseconds;
((struct rlc_um_tx_sdu_management*) (sduP->data))->sdu_creation_time = 0;
rlc->next_sdu_index = (rlc->next_sdu_index + 1) % rlc->size_input_sdus_buffer;
} else {
// msg("[RLC][UM] Freeing sduP (%p)\n",sduP);
free_mem_block (sduP);
}
}
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_CONSTANTS_H__
# define __RLC_UM_CONSTANTS_H__
// SN Field
# define RLC_UM_SN_7BITS_MASK 0xFF
// li field (values shifted 1 bit left)
# define RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU 16
//----------------------------------------------------------
// Events defined for state model of the acknowledged mode entity
# define RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_NULL_STATE_EVENT 0x00
# define RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_DATA_TRANSFER_READY_STATE_EVENT 0x01
# define RLC_UM_RECEIVE_CRLC_SUSPEND_REQ_EVENT 0x10
# define RLC_UM_TRANSMIT_CRLC_SUSPEND_CNF_EVENT 0x11
# define RLC_UM_RECEIVE_CRLC_RESUME_REQ_EVENT 0x12
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
#include "rtos_header.h"
#include "platform_types.h"
//-----------------------------------------------------------------------------
#include "rlc_um_entity.h"
#include "rlc_um_constants.h"
#include "rlc_um_structs.h"
#include "rlc_primitives.h"
#include "rlc_um_fsm_proto_extern.h"
#include "list.h"
#include "rrm_config_structs.h"
#include "LAYER2/MAC/extern.h"
//-----------------------------------------------------------------------------
void config_req_rlc_um (struct rlc_um_entity *rlcP, module_id_t module_idP, rlc_um_info_t * config_umP, uint8_t rb_idP, rb_type_t rb_typeP);
void send_rlc_um_control_primitive (struct rlc_um_entity *rlcP, module_id_t module_idP, mem_block_t *cprimitiveP);
void init_rlc_um (struct rlc_um_entity *rlcP);
void rlc_um_reset_state_variables (struct rlc_um_entity *rlcP);
void rlc_um_free_all_resources (struct rlc_um_entity *rlcP);
void rlc_um_set_configured_parameters (struct rlc_um_entity *rlcP, mem_block_t *cprimitiveP);
//void rlc_um_probing_get_buffer_occupancy_measurements (struct rlc_um_entity *rlcP, probing_report_traffic_rb_parameters *reportP, int measurement_indexP);
//-----------------------------------------------------------------------------
/*void
rlc_um_probing_get_buffer_occupancy_measurements (struct rlc_um_entity *rlcP, probing_report_traffic_rb_parameters *reportP, int measurement_indexP)
{
//-----------------------------------------------------------------------------
if (rlcP->protocol_state != RLC_NULL_STATE) {
reportP->incoming_sdu[measurement_indexP] = rlcP->buffer_occupancy;
reportP->retransmission[measurement_indexP] = 0;
reportP->ready_to_send[measurement_indexP] = 0;
}
}*/
//-----------------------------------------------------------------------------
void
config_req_rlc_um (struct rlc_um_entity *rlcP, module_id_t module_idP, rlc_um_info_t * config_umP, uint8_t rb_idP, rb_type_t rb_typeP)
{
//-----------------------------------------------------------------------------
mem_block_t *mb;
mb = get_free_mem_block (sizeof (struct crlc_primitive));
((struct crlc_primitive *) mb->data)->type = CRLC_CONFIG_REQ;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.e_r = RLC_E_R_ESTABLISHMENT;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.stop = 0;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.cont = 1;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.timer_discard = config_umP->timer_discard;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.sdu_discard_mode = config_umP->sdu_discard_mode;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.frame_tick_milliseconds = &Mac_rlc_xface->frame;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.size_input_sdus_buffer = 256;
((struct crlc_primitive *) mb->data)->primitive.c_config_req.parameters.um_parameters.rb_id = rb_idP;
send_rlc_um_control_primitive (rlcP, module_idP, mb);
if (rb_typeP != SIGNALLING_RADIO_BEARER) {
rlcP->data_plane = 1;
} else {
rlcP->data_plane = 0;
}
}
//-----------------------------------------------------------------------------
void
send_rlc_um_control_primitive (struct rlc_um_entity *rlcP, module_id_t module_idP, mem_block_t *cprimitiveP)
{
//-----------------------------------------------------------------------------
switch (((struct crlc_primitive *) cprimitiveP->data)->type) {
case CRLC_CONFIG_REQ:
switch (((struct crlc_primitive *) cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.e_r) {
case RLC_E_R_ESTABLISHMENT:
rlcP->module_id = module_idP;
if (rlc_um_fsm_notify_event (rlcP, RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_DATA_TRANSFER_READY_STATE_EVENT)) {
rlc_um_set_configured_parameters (rlcP, cprimitiveP); // the order of the calling of procedures...
rlc_um_reset_state_variables (rlcP); // ...must not ...
}
break;
case RLC_E_R_MODIFICATION:
msg ("[RLC_UM_LITE][ERROR] send_rlc_um_control_primitive(CRLC_CONFIG_REQ) RLC_AM_E_R_MODIFICATION not handled\n");
break;
case RLC_E_R_RELEASE:
if (rlc_um_fsm_notify_event (rlcP, RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_NULL_STATE_EVENT)) {
rlc_um_free_all_resources (rlcP);
}
break;
default:
msg ("[RLC_UM_LITE][ERROR] send_rlc_um_control_primitive(CRLC_CONFIG_REQ) unknown parameter E_R\n");
}
break;
case CRLC_RESUME_REQ:
msg ("[RLC_UM_LITE][ERROR] send_rlc_um_control_primitive(CRLC_RESUME_REQ) cprimitive not handled\n");
break;
default:
msg ("[RLC_UM_LITE][RB %d][ERROR] send_rlc_um_control_primitive(UNKNOWN CPRIMITIVE)\n", rlcP->rb_id);
}
free_mem_block (cprimitiveP);
}
//-----------------------------------------------------------------------------
void
init_rlc_um (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
memset (rlcP, 0, sizeof (struct rlc_um_entity));
// TX SIDE
list_init (&rlcP->pdus_to_mac_layer, NULL);
rlcP->protocol_state = RLC_NULL_STATE;
rlcP->nb_sdu = 0;
rlcP->next_sdu_index = 0;
rlcP->current_sdu_index = 0;
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
rlcP->li_length_15_was_used_for_previous_pdu = 0;
rlcP->vt_us = 0;
rlcP->first_li_in_next_pdu = RLC_LI_UNDEFINED;
// RX SIDE
list_init (&rlcP->pdus_from_mac_layer, NULL);
rlcP->vr_us = 0;
rlcP->output_sdu_size_to_write = 0;
rlcP->output_sdu_in_construction = NULL;
rlcP->tx_pdcp_sdu = 0;
rlcP->tx_pdcp_sdu_discarded = 0;
rlcP->tx_data_pdu = 0;
rlcP->rx_sdu = 0;
rlcP->rx_error_pdu = 0;
rlcP->rx_data_pdu = 0;
rlcP->rx_data_pdu_out_of_window = 0;
}
//-----------------------------------------------------------------------------
void
rlc_um_reset_state_variables (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
// TX SIDE
rlcP->buffer_occupancy = 0;
rlcP->nb_sdu = 0;
rlcP->next_sdu_index = 0;
rlcP->current_sdu_index = 0;
rlcP->vt_us = 0;
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
rlcP->li_length_15_was_used_for_previous_pdu = 0;
// RX SIDE
rlcP->last_reassemblied_sn = 127;
rlcP->vr_us = 0;
}
//-----------------------------------------------------------------------------
void
rlc_um_free_all_resources (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
int index;
// TX SIDE
list_free (&rlcP->pdus_to_mac_layer);
if (rlcP->input_sdus_alloc) {
for (index = 0; index < rlcP->size_input_sdus_buffer; index++) {
if (rlcP->input_sdus[index]) {
free_mem_block (rlcP->input_sdus[index]);
}
}
free_mem_block (rlcP->input_sdus_alloc);
rlcP->input_sdus_alloc = NULL;
}
// RX SIDE
list_free (&rlcP->pdus_from_mac_layer);
if ((rlcP->output_sdu_in_construction)) {
free_mem_block (rlcP->output_sdu_in_construction);
}
}
//-----------------------------------------------------------------------------
void
rlc_um_set_configured_parameters (struct rlc_um_entity *rlcP, mem_block_t *cprimitiveP)
{
//-----------------------------------------------------------------------------
// timers
rlcP->timer_discard_init = ((struct crlc_primitive *)
cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.timer_discard;
// protocol_parameters
rlcP->sdu_discard_mode = ((struct crlc_primitive *)
cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.sdu_discard_mode;
// SPARE : not 3GPP
rlcP->frame_tick_milliseconds = ((struct crlc_primitive *)
cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.frame_tick_milliseconds;
rlcP->size_input_sdus_buffer = ((struct crlc_primitive *)
cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.size_input_sdus_buffer;
rlcP->rb_id = ((struct crlc_primitive *) cprimitiveP->data)->primitive.c_config_req.parameters.um_parameters.rb_id;
if ((rlcP->input_sdus_alloc == NULL) && (rlcP->size_input_sdus_buffer > 0)) {
rlcP->input_sdus_alloc = get_free_mem_block (rlcP->size_input_sdus_buffer * sizeof (void *));
rlcP->input_sdus = (mem_block_t **) (rlcP->input_sdus_alloc->data);
memset (rlcP->input_sdus, 0, rlcP->size_input_sdus_buffer * sizeof (void *));
}
rlcP->first_pdu = 1;
#ifdef RLC_UM_LITE_FOR_RNRT_COSINUS
// crc on header only for radio access bearers
if ((rlcP->data_plane)) {
rlcP->crc_on_header = 1;
} else {
rlcP->crc_on_header = 0;
}
#else
rlcP->crc_on_header = 0;
#endif
#ifdef DEBUG_LOAD_CONFIG
if (rlcP->sdu_discard_mode == RLC_SDU_DISCARD_TIMER_BASED_NO_EXPLICIT) {
msg ("[RLC UM][RB %d] SDU_DISCARD_TIMER_BASED_NO_EXPLICIT time out %d\n", rlcP->rb_id, rlcP->timer_discard_init);
} else if (rlcP->sdu_discard_mode == RLC_SDU_DISCARD_NOT_CONFIGURED) {
msg ("[RLC UM][RB %d] SDU_DISCARD_NOT_CONFIGURED\n", rlcP->rb_id);
} else {
msg ("[RLC UM][RB %d][ERROR] sdu discard mode not configured\n", rlcP->rb_id);
}
#endif
}
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_CONTROL_PRIMITIVES_H__
# define __RLC_UM_CONTROL_PRIMITIVES_H__
//-----------------------------------------------------------------------------
# include "rlc_um_entity.h"
# include "mem_block.h"
# include "rrm_config_structs.h"
//-----------------------------------------------------------------------------
extern void config_req_rlc_um (struct rlc_um_entity *rlcP, module_id_t module_idP, rlc_um_info_t * config_umP, uint8_t rb_idP, rb_type_t rb_typeP);
extern void send_rlc_um_control_primitive (struct rlc_um_entity *rlcP, module_id_t module_idP, mem_block_t *cprimitiveP);
extern void init_rlc_um (struct rlc_um_entity *rlcP);
extern void rlc_um_reset_state_variables (struct rlc_um_entity *rlcP);
extern void rlc_um_free_all_resources (struct rlc_um_entity *rlcP);
extern void rlc_um_set_configured_parameters (struct rlc_um_entity *rlcP, mem_block_t *cprimitiveP);
//extern void rlc_um_probing_get_buffer_occupancy_measurements (struct rlc_um_entity *rlcP, probing_report_traffic_rb_parameters *reportP, int measurement_indexP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_ENTITY_H__
# define __RLC_UM_ENTITY_H__
# include "platform_types.h"
# include "platform_constants.h"
# include "list.h"
# include "rlc_primitives.h"
# include "rlc_def.h"
struct rlc_um_entity {
module_id_t module_id;
uint8_t allocation;
uint8_t protocol_state;
// for stats and trace purpose :
uint16_t data_plane; // act as a boolean
uint16_t crc_on_header; // act as a boolean
//*****************************************************************************
// TRANSMITER
//*****************************************************************************
//-----------------------------
// protocol variables
//-----------------------------
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.
uint8_t vt_us;
//-----------------------------
// discard info
//-----------------------------
uint8_t sdu_discard_mode;
//-----------------------------
// timers
//-----------------------------
uint16_t timer_discard_init;
uint32_t *frame_tick_milliseconds; // pointer on this tick variable handled by RRC : READ ONLY
//-----------------------------
// tranmission
//-----------------------------
// sdu communication;
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;
uint16_t data_pdu_size;
uint16_t data_pdu_size_in_bits;
uint16_t nb_pdu_requested_by_mac;
uint8_t li_one_byte_short_to_add_in_next_pdu;
uint8_t li_exactly_filled_to_add_in_next_pdu;
uint8_t li_length_15_was_used_for_previous_pdu;
list_t pdus_to_mac_layer;
//-----------------------------
// C-SAP
//-----------------------------
list_t c_sap;
//-----------------------------
// Mapping info
//-----------------------------
uint8_t logical_channel_identity;
//*****************************************************************************
// RECEIVER
//*****************************************************************************
//-----------------------------
// protocol variables
//-----------------------------
uint8_t vr_us; // Receiver Send Sequence state variable
// The sequence number of the next PDU to be received. It shall be
// set equal to SN+1 upon reception of a PDU. The initial value of
// this state variable is 0;
//-----------------------------
// receiver
//-----------------------------
// the current output sdu is the first in the list
list_t output_sdu_list;
mem_block_t *output_sdu_in_construction;
int32_t output_sdu_size_to_write; // for writing in sdu
//struct rlc_um_data_ind output_rlc_primitive;// for writing header in rt_fifo
list_t pdus_from_mac_layer;
uint8_t last_reassemblied_sn:7;
uint16_t rb_id;
uint32_t tx_sdus;
uint32_t rx_sdus;
uint32_t tx_pdus;
uint32_t rx_pdus;
uint32_t rx_pdus_in_error;
uint8_t first_pdu;
unsigned int tx_pdcp_sdu;
unsigned int tx_pdcp_sdu_discarded;
unsigned int tx_data_pdu;
unsigned int rx_sdu;
unsigned int rx_error_pdu;
unsigned int rx_data_pdu;
unsigned int rx_data_pdu_out_of_window;
};
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
#include "rtos_header.h"
#include "platform_types.h"
//-----------------------------------------------------------------------------
#include "rlc_um_entity.h"
#include "rlc_um_constants.h"
#include "rlc_def.h"
#include "LAYER2/MAC/extern.h"
//-----------------------------------------------------------------------------
#ifdef DEBUG_RLC_UM_FSM
# define PRINT_RLC_UM_FSM msg
#else
# define PRINT_RLC_UM_FSM //
#endif
//-----------------------------------------------------------------------------
int
rlc_um_fsm_notify_event (struct rlc_um_entity *rlcP, uint8_t eventP)
{
//-----------------------------------------------------------------------------
switch (rlcP->protocol_state) {
//-------------------------------
// RLC_NULL_STATE
//-------------------------------
case RLC_NULL_STATE:
switch (eventP) {
case RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_DATA_TRANSFER_READY_STATE_EVENT:
PRINT_RLC_UM_FSM ("[RLC_UM_LITE][RB %d][FSM] RLC_NULL_STATE -> RLC_DATA_TRANSFER_READY_STATE\n", rlcP->rb_id);
rlcP->protocol_state = RLC_DATA_TRANSFER_READY_STATE;
return 1;
break;
default:
msg ("[RLC_UM_LITE][RB %d][FSM] WARNING PROTOCOL ERROR - EVENT %02X hex NOT EXPECTED FROM NULL_STATE\n", rlcP->rb_id, eventP);
mac_xface->macphy_exit("");
return 0;
}
break;
//-------------------------------
// RLC_DATA_TRANSFER_READY_STATE
//-------------------------------
case RLC_DATA_TRANSFER_READY_STATE:
switch (eventP) {
case RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_NULL_STATE_EVENT:
PRINT_RLC_UM_FSM ("[RLC_UM_LITE][RB %d][FSM] RLC_DATA_TRANSFER_READY_STATE -> RLC_NULL_STATE\n", rlcP->rb_id);
rlcP->protocol_state = RLC_NULL_STATE;
return 1;
break;
case RLC_UM_RECEIVE_CRLC_SUSPEND_REQ_EVENT:
case RLC_UM_TRANSMIT_CRLC_SUSPEND_CNF_EVENT:
PRINT_RLC_UM_FSM ("[RLC_UM_LITE][RB %d][FSM] RLC_DATA_TRANSFER_READY_STATE -> RLC_LOCAL_SUSPEND_STATE\n", rlcP->rb_id);
rlcP->protocol_state = RLC_LOCAL_SUSPEND_STATE;
return 1;
break;
default:
msg ("[RLC_UM_LITE][RB %d][FSM] WARNING PROTOCOL ERROR - EVENT %02X hex NOT EXPECTED FROM DATA_TRANSFER_READY_STATE\n", rlcP->rb_id, eventP);
return 0;
}
break;
//-------------------------------
// RLC_LOCAL_SUSPEND_STATE
//-------------------------------
case RLC_LOCAL_SUSPEND_STATE:
switch (eventP) {
case RLC_UM_RECEIVE_CRLC_CONFIG_REQ_ENTER_NULL_STATE_EVENT:
PRINT_RLC_UM_FSM ("[RLC_UM_LITE %p][FSM] RLC_LOCAL_SUSPEND_STATE -> RLC_NULL_STATE\n", rlcP);
rlcP->protocol_state = RLC_NULL_STATE;
return 1;
break;
case RLC_UM_RECEIVE_CRLC_RESUME_REQ_EVENT:
PRINT_RLC_UM_FSM ("[RLC_UM_LITE %p][FSM] RLC_LOCAL_SUSPEND_STATE -> RLC_DATA_TRANSFER_READY_STATE\n", rlcP);
rlcP->protocol_state = RLC_DATA_TRANSFER_READY_STATE;
return 1;
break;
default:
msg ("[RLC_UM_LITE %p][FSM] WARNING PROTOCOL ERROR - EVENT %02X hex NOT EXPECTED FROM RLC_LOCAL_SUSPEND_STATE\n", rlcP, eventP);
return 0;
}
break;
default:
msg ("[RLC_UM_LITE %p][FSM] ERROR UNKNOWN STATE %d\n", rlcP, rlcP->protocol_state);
return 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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_FSM_PROTO_EXTERN_H__
# define __RLC_UM_FSM_PROTO_EXTERN_H__
//-----------------------------------------------------------------------------
# include "platform_types.h"
# include "rlc_um_entity.h"
//-----------------------------------------------------------------------------
extern int rlc_um_fsm_notify_event (struct rlc_um_entity *rlcP, uint8_t eventP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_PROTO_EXTERN_H__
# define __RLC_UM_PROTO_EXTERN_H__
# include "rlc_um_entity.h"
# include "mem_block.h"
extern void rlc_um_stat_req (struct rlc_um_entity *rlcP,
unsigned int* tx_pdcp_sdu,
unsigned int* tx_pdcp_sdu_discarded,
unsigned int* tx_data_pdu,
unsigned int* rx_sdu,
unsigned int* rx_error_pdu,
unsigned int* rx_data_pdu,
unsigned int* rx_data_pdu_out_of_window);
extern void rlc_um_get_pdus (void *argP);
extern void rlc_um_rx (void *argP, struct mac_data_ind data_indP);
extern struct mac_status_resp rlc_um_mac_status_indication (void *rlcP, uint16_t no_tbP, uint16_t tb_sizeP, struct mac_status_ind tx_statusP);
extern struct mac_data_req rlc_um_mac_data_request (void *rlcP);
extern void rlc_um_mac_data_indication (void *rlcP, struct mac_data_ind data_indP);
extern void rlc_um_data_req (void *rlcP, mem_block_t *sduP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
#define RLC_UM_C
#include "rtos_header.h"
#include "platform_types.h"
//-----------------------------------------------------------------------------
#include "rlc.h"
#include "rlc_um_entity.h"
#include "rlc_um_structs.h"
#include "rlc_primitives.h"
#include "rlc_um_constants.h"
#include "list.h"
#include "LAYER2/MAC/extern.h"
//#define DEBUG_RLC_UM_REASSEMBLY 1
//#define DEBUG_RLC_UM_DISPLAY_ASCII_DATA 1
//#define DEBUG_RLC_UM_SEND_SDU
void rlc_um_clear_rx_sdu (struct rlc_um_entity *rlcP);
void rlc_um_reassembly (uint8_t * srcP, int32_t lengthP, struct rlc_um_entity *rlcP);
void rlc_um_send_sdu_minus_1_byte (struct rlc_um_entity *rlcP);
void rlc_um_send_sdu (struct rlc_um_entity *rlcP);
//-----------------------------------------------------------------------------
inline void
rlc_um_clear_rx_sdu (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
rlcP->output_sdu_size_to_write = 0;
}
//-----------------------------------------------------------------------------
void
rlc_um_reassembly (uint8_t * srcP, int32_t lengthP, struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
int sdu_max_size;
#ifdef DEBUG_RLC_UM_DISPLAY_ASCII_DATA
int index;
#endif
#ifdef DEBUG_RLC_UM_REASSEMBLY
msg ("[RLC_UM_LITE][MOD %d][RB %d][REASSEMBLY] reassembly() %d bytes\n", rlcP->module_id, rlcP->rb_id, lengthP);
#endif
if ((rlcP->data_plane)) {
sdu_max_size = RLC_SDU_MAX_SIZE_DATA_PLANE;
} else {
sdu_max_size = RLC_SDU_MAX_SIZE_CONTROL_PLANE;
}
if (rlcP->output_sdu_in_construction == NULL) {
// msg("[RLC_UM_LITE] Getting mem_block ...\n");
rlcP->output_sdu_in_construction = get_free_mem_block (sdu_max_size);
rlcP->output_sdu_size_to_write = 0;
}
if ((rlcP->output_sdu_in_construction)) {
#ifdef DEBUG_RLC_UM_DISPLAY_ASCII_DATA
msg ("[RLC_UM_LITE][RB %d][REASSEMBLY] DATA :", rlcP->rb_id);
for (index = 0; index < lengthP; index++) {
msg ("%02X.", srcP[index]);
}
msg ("\n");
#endif
// check if no overflow in size
if ((rlcP->output_sdu_size_to_write + lengthP) <= sdu_max_size) {
memcpy (&rlcP->output_sdu_in_construction->data[rlcP->output_sdu_size_to_write], srcP, lengthP);
rlcP->output_sdu_size_to_write += lengthP;
} else {
msg ("[RLC_UM_LITE][RB %d][REASSEMBLY] ERROR SDU SIZE OVERFLOW SDU GARBAGED\n", rlcP->rb_id);
// erase SDU
rlcP->output_sdu_size_to_write = 0;
}
} else {
msg ("[RLC_UM_LITE][RB %d][REASSEMBLY] ERROR OUTPUT SDU IS NULL\n", rlcP->rb_id);
}
}
//-----------------------------------------------------------------------------
inline void
rlc_um_send_sdu_minus_1_byte (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
rlcP->output_sdu_size_to_write -= 1;
rlc_um_send_sdu (rlcP);
}
//-----------------------------------------------------------------------------
void
rlc_um_send_sdu (struct rlc_um_entity *rlcP)
{
//-----------------------------------------------------------------------------
/*#ifndef USER_MODE
unsigned long int rlc_um_time_us;
int min, sec, usec;
#endif*/
if ((rlcP->output_sdu_in_construction)) {
#ifdef DEBUG_RLC_UM_SEND_SDU
msg ("[RLC_UM_LITE][MOD %d][RB %d][SEND_SDU] %d bytes frame %d\n", rlcP->module_id, rlcP->rb_id, rlcP->output_sdu_size_to_write, Mac_rlc_xface->frame);
/*#ifndef USER_MODE
rlc_um_time_us = (unsigned long int)(rt_get_time_ns ()/(RTIME)1000);
sec = (rlc_um_time_us/ 1000000);
min = (sec / 60) % 60;
sec = sec % 60;
usec = rlc_um_time_us % 1000000;
msg ("[RLC_UM_LITE][RB %d] at time %2d:%2d.%6d\n", rlcP->rb_id, min, sec , usec);
#endif*/
#endif
if (rlcP->output_sdu_size_to_write > 0) {
#ifdef DEBUG_RLC_STATS
rlcP->rx_sdus += 1;
#endif
#ifdef BENCH_QOS_L2
fprintf (bench_l2, "[SDU DELIVERY] FRAME %d SIZE %d RB %d RLC-UM %p\n", Mac_rlc_xface->frame, rlcP->output_sdu_size_to_write, rlcP->rb_id, rlcP);
#endif
// msg("[RLC] DATA IND ON MOD_ID %d RB ID %d, size %d\n",rlcP->module_id, rlcP->rb_id,rlcP->output_sdu_size_to_write);
rlc_data_ind (rlcP->module_id, rlcP->rb_id, rlcP->output_sdu_size_to_write, rlcP->output_sdu_in_construction, rlcP->data_plane);
} else {
#ifdef DEBUG_RLC_UM_SEND_SDU
msg ("[RLC_UM_LITE][RB %d][SEND_SDU] ERROR SIZE <= 0\n", rlcP->rb_id);
#endif
msg ("[RLC_UM_LITE][RB %d][SEND_SDU] ERROR SIZE <= 0\n", rlcP->rb_id);
msg("[RLC_UM_LITE] Freeing mem_block ...\n");
free_mem_block (rlcP->output_sdu_in_construction);
}
rlcP->output_sdu_in_construction = NULL;
rlcP->output_sdu_size_to_write = 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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_REASSEMBLY_PROTO_EXTERN_H__
# define __RLC_UM_REASSEMBLY_PROTO_EXTERN_H__
//-----------------------------------------------------------------------------
# include "rlc_um_entity.h"
//-----------------------------------------------------------------------------
extern void rlc_um_send_sdu_minus_1_byte (struct rlc_um_entity *rlcP);
extern void rlc_um_clear_rx_sdu (struct rlc_um_entity *rlcP);
extern void rlc_um_reassembly (uint8_t * srcP, uint16_t lengthP, struct rlc_um_entity *rlcP);
extern void rlc_um_send_sdu (struct rlc_um_entity *rlcP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
#define RLC_UM_C
#include "rtos_header.h"
#include "platform_types.h"
//-----------------------------------------------------------------------------
#include "rlc.h"
#include "rlc_um_entity.h"
#include "rlc_um_constants.h"
#include "rlc_um_structs.h"
#include "rlc_primitives.h"
#include "rlc_def.h"
#include "mac_primitives.h"
#include "list.h"
#include "rlc_um_reassembly_proto_extern.h"
#include "rlc_um_segment_proto_extern.h"
//#define TRACE_RLC_UM_RX 1
//#define TRACE_RLC_UM_RX_DECODE_LI 1
//#define DEBUG_RLC_UM_DISPLAY_TB_DATA 1
//#define TEST_EXIT_HICHAM 1
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
void
rlc_um_receive_process_pdu (struct rlc_um_entity* rlcP, struct rlc_um_rx_pdu_management* pdu_mngtP, struct
rlc_um_rx_data_pdu_struct* dataP, uint16_t tb_sizeP, uint16_t bad_crc_l1P)
{
//-----------------------------------------------------------------------------
uint8_t* data_pdu;
int32_t remaining_data_size;
uint32_t rlc_um_crc;
int nb_li;
int li_index;
uint16_t li[RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU];
uint16_t li_synched;
uint16_t rlc_crc_to_check;
pdu_mngtP->sn = dataP->byte1 >> 1;
#ifdef TRACE_RLC_UM_RX
msg ("[RLC_UM_LITE][MOD ID %d][RB %d] RX PDU SN %d VR(US) %d TBsize %d\n", rlcP->module_id, rlcP->rb_id, pdu_mngtP->sn, rlcP->vr_us,tb_sizeP);
#endif
if (!(bad_crc_l1P)) {
rlc_crc_to_check = 0;
if (pdu_mngtP->sn == rlcP->vr_us) {
li_synched = 1;
} else {
// if the sn is not synched, then garbage the previous SDU in construction if any
//msg ("[RLC_UM_LITE][RB %d] RX7 OUT OF SYNC -> GARBAGE\n", rlcP->rb_id);
rlc_um_clear_rx_sdu (rlcP);
li_synched = 0;
//#ifdef TEST_EXIT_HICHAM
//#warning TEST_EXIT_HICHAM
//#ifdef USER_MODE
// mac_xface->macphy_exit ("[RLC][UM_RECEIVER]SYNCHRO LOST");
//#endif
//#endif
}
} else if ((rlcP->crc_on_header)) {
rlc_crc_to_check = 1;
if (pdu_mngtP->sn == rlcP->vr_us) {
li_synched = 1;
} else {
// if the sn is not synched, then garbage the previous SDU in construction if any
//msg ("[RLC_UM_LITE][RB %d] RX7 OUT OF SYNC -> GARBAGE\n", rlcP->rb_id);
rlc_um_clear_rx_sdu (rlcP);
li_synched = 0;
}
} else {
#ifdef TRACE_RLC_UM_RX
msg ("[RLC_UM_LITE][RB %d] RX7 PDU SN %02X hex??? WITH ERROR INDICATED BY LOWER LAYERS -> GARBAGE\n", rlcP->rb_id, pdu_mngtP->sn);
#endif
return;
}
//---------------------------------
// NO LENGTH INDICATOR IN PDU
//---------------------------------
if ((dataP->byte1 & RLC_E_MASK) == (uint8_t) RLC_E_NEXT_FIELD_IS_DATA) {
if ((li_synched)) {
if ((rlcP->crc_on_header)) {
if ((rlc_crc_to_check)) {
// may be the sn was not good
rlc_um_crc = rlc_um_crc8_xor (&dataP->byte1, 1); // >> 24;
if (rlc_um_crc != dataP->li_data_7[tb_sizeP - 2]) {
msg ("[RLC_UM_LITE][RB %d] BAD CRC ON RLC HEADER 1 byte crc computed %d, crc %d, byte %d \n", rlcP->rb_id, rlc_um_crc, dataP->li_data_7[tb_sizeP - 2],
dataP->byte1);
return;
} else {
msg ("[RLC_UM_LITE][RB %d] GOOD CRC ON RLC HEADER 1 byte\n", rlcP->rb_id);
}
}
rlc_um_reassembly ((uint8_t*) (&dataP->li_data_7[0]), tb_sizeP - 2, rlcP, 0);
} else {
rlc_um_reassembly ((uint8_t*) (&dataP->li_data_7[0]), tb_sizeP - 1, rlcP, 0);
}
}
//---------------------------------
// 1 OR MORE LENGTH INDICATOR IN PDU
//---------------------------------
} else {
nb_li = 0;
if (tb_sizeP <= 125) {
while (((li[nb_li] = ((uint16_t) dataP->li_data_7[nb_li])) & RLC_E_NEXT_FIELD_IS_LI_E)
&& (nb_li < RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU)) {
li[nb_li] = li[nb_li] & (~(uint8_t) RLC_E_NEXT_FIELD_IS_LI_E);
nb_li++;
}
nb_li++; // count the last li
} else {
while ((li[nb_li] = ((((uint16_t) dataP->li_data_7[nb_li << 1]) << 8) + dataP->li_data_7[(nb_li << 1) + 1]))
& RLC_E_NEXT_FIELD_IS_LI_E) {
li[nb_li] = li[nb_li] & (~(uint16_t) RLC_E_NEXT_FIELD_IS_LI_E);
nb_li++;
}
nb_li++; // count the last li
}
//---------------------------------
// CHECK CRC ON RLC UM HEADER
//---------------------------------
if ((rlc_crc_to_check)) {
if (nb_li > RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU) {
return; // must be corrupted not necessary to check CRC
} else {
if (tb_sizeP <= 125) {
rlc_um_crc = rlc_um_crc8_xor (&dataP->byte1, nb_li + 1) ; //>> 24;
} else {
rlc_um_crc = rlc_um_crc8_xor (&dataP->byte1, (nb_li << 1) + 1); // >> 24;
}
if (rlc_um_crc != dataP->li_data_7[tb_sizeP - 2]) {
msg ("[RLC_UM_LITE][RB %d] BAD CRC ON RLC HEADER %d LI TB size %d\n", rlcP->rb_id, nb_li, tb_sizeP);
return;
} else {
msg ("[RLC_UM_LITE][RB %d] GOOD CRC ON RLC HEADER %d LI TB size %d\n", rlcP->rb_id, nb_li, tb_sizeP);
if (pdu_mngtP->sn == rlcP->vr_us) {
li_synched = 1;
} else {
// if the sn is not synched, then garbage the previous SDU in construction if any
rlc_um_clear_rx_sdu (rlcP);
li_synched = 0;
}
}
}
}
if ((rlcP->crc_on_header)) {
if (tb_sizeP <= 125) {
remaining_data_size = tb_sizeP - 2 - nb_li;
data_pdu = (uint8_t*) (&dataP->li_data_7[nb_li]);
} else {
remaining_data_size = tb_sizeP - 2 - (nb_li << 1);
data_pdu = (uint8_t*) (&dataP->li_data_7[nb_li << 1]);
}
} else {
if (tb_sizeP <= 125) {
remaining_data_size = tb_sizeP - 1 - nb_li;
data_pdu = (uint8_t*) (&dataP->li_data_7[nb_li]);
} else {
remaining_data_size = tb_sizeP - 1 - (nb_li << 1);
data_pdu = (uint8_t*) (&dataP->li_data_7[nb_li << 1]);
}
}
li_index = 0;
while (li_index < nb_li) {
switch (li[li_index]) {
case (uint8_t) RLC_LI_LAST_PDU_EXACTLY_FILLED:
#ifdef TRACE_RLC_UM_RX_DECODE_LI
msg ("[RLC_UM_LITE][RB %d] RX_7 PDU %p Li RLC_LI_LAST_PDU_EXACTLY_FILLED\n", rlcP->rb_id, pdu_mngtP);
#endif
if ((li_synched)) {
rlc_um_send_sdu (rlcP);
}
li_synched = 1;
break;
case (uint8_t) RLC_LI_LAST_PDU_ONE_BYTE_SHORT:
#ifdef TRACE_RLC_UM_RX_DECODE_LI
msg ("[RLC_UM_LITE][RB %d] RX_7 PDU %p Li RLC_LI_LAST_PDU_ONE_BYTE_SHORT\n", rlcP->rb_id, pdu_mngtP);
#endif
if ((li_synched)) {
rlc_um_send_sdu_minus_1_byte (rlcP);
}
li_synched = 1;
break;
case (uint8_t) RLC_LI_PDU_PIGGY_BACKED_STATUS: // ignore for RLC-AM
case (uint8_t) RLC_LI_PDU_PADDING:
#ifdef TRACE_RLC_UM_RX_DECODE_LI
msg ("[RLC_UM_LITE][RB %d] RX_7 PDU %p Li RLC_LI_PDU_PADDING\n", rlcP->rb_id, pdu_mngtP);
#endif
remaining_data_size = 0;
break;
case (uint8_t) RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU:
#ifdef TRACE_RLC_UM_RX_DECODE_LI
msg ("[RLC_UM_LITE][RB %d] RX_7 PDU %p Li RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id, pdu_mngtP);
#endif
rlc_um_clear_rx_sdu (rlcP);
li_synched = 1;
break;
default: // li is length
#ifdef TRACE_RLC_UM_RX_DECODE_LI
msg ("[RLC_UM_LITE][RB %d] RX_7 PDU %p Li LI_SIZE %d Bytes\n", rlcP->rb_id, pdu_mngtP, li[li_index] >> 1);
#endif
remaining_data_size = remaining_data_size - (li[li_index] >> 1);
if ((li_synched)) {
rlc_um_reassembly (data_pdu, (li[li_index] >> 1), rlcP);
rlc_um_send_sdu (rlcP);
}
li_synched = 1;
data_pdu = (uint8_t*) ((uint32_t) data_pdu + (li[li_index] >> 1));
}
li_index++;
}
if ((remaining_data_size > 0)) {
rlc_um_reassembly (data_pdu, remaining_data_size, rlcP);
remaining_data_size = 0;
}
}
rlcP->vr_us = (pdu_mngtP->sn + 1) & 127;
}
//-----------------------------------------------------------------------------
void
rlc_um_receive (struct rlc_um_entity* rlcP, struct mac_data_ind data_indP)
{
//-----------------------------------------------------------------------------
struct rlc_um_rx_data_pdu_struct* data;
struct rlc_um_rx_pdu_management* pdu_mngt;
mem_block_t* tb;
uint8_t* first_byte;
uint8_t tb_size_in_bytes;
uint8_t first_bit;
uint8_t bits_to_shift;
uint8_t bits_to_shift_last_loop;
while ((tb = list_remove_head (&data_indP.data))) {
#ifdef DEBUG_RLC_STATS
rlcP->rx_pdus += 1;
#endif
#ifdef DEBUG_RLC_UM_DISPLAY_TB_DATA
// if (rlcP->rb_id == 4) {
// if ((((struct mac_tb_ind *) (tb->data))->error_indication) && (rlcP->crc_on_header)) {
msg ("[RLC_UM_LITE][RB %d] DUMP RX PDU:", rlcP->rb_id);
for (tb_size_in_bytes = 0; tb_size_in_bytes < data_indP.tb_size; tb_size_in_bytes++) {
msg ("%02X.", ((struct mac_tb_ind*) (tb->data))->data_ptr[tb_size_in_bytes]);
}
msg("\n");
// }
// }
#endif
if (!(((struct mac_tb_ind*) (tb->data))->error_indication) || (rlcP->crc_on_header)) {
//msg("YES\n");
//----------------------------------
// align on byte boundary if not
//----------------------------------
first_byte = ((struct mac_tb_ind*) (tb->data))->data_ptr;
pdu_mngt = (struct rlc_um_rx_pdu_management*) (tb->data);
tb_size_in_bytes = data_indP.tb_size;
// msg("[RLC_RECEIVE] RX_size %d\n",data_indP.tb_size);
first_bit = ((struct mac_tb_ind*) (tb->data))->first_bit;
if (first_bit > 0) {
// shift data of transport_block TO CHECK
bits_to_shift_last_loop = 0;
while ((tb_size_in_bytes)) {
bits_to_shift = first_byte[tb_size_in_bytes] >> (8 - first_bit);
first_byte[tb_size_in_bytes] = (first_byte[tb_size_in_bytes] << first_bit) | (bits_to_shift_last_loop);
tb_size_in_bytes -= 1;
bits_to_shift_last_loop = bits_to_shift;
}
first_byte[0] = (first_byte[0] << first_bit) | (bits_to_shift_last_loop);
}
pdu_mngt->first_byte = first_byte;
data = (struct rlc_um_rx_data_pdu_struct*) (first_byte);
rlc_um_receive_process_pdu (rlcP, pdu_mngt, data, data_indP.tb_size, ((struct mac_tb_ind*) (tb->data))->error_indication);
} else {
//msg("NO\n");
#ifdef DEBUG_RLC_STATS
rlcP->rx_pdus_in_error += 1;
#endif
#ifdef TRACE_RLC_UM_RX
msg ("[RLC_UM_LITE][RB %d] RX PDU WITH ERROR INDICATED BY LOWER LAYERS -> GARBAGE\n", rlcP->rb_id);
#endif
}
free_mem_block (tb);
} // end while
}
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_RECEIVER_PROTO_EXTERN_H__
# define __RLC_UM_RECEIVER_PROTO_EXTERN_H__
# include "rlc_um_entity.h"
# include "mac_primitives.h"
void rlc_um_receive (struct rlc_um_entity *rlcP, struct mac_data_ind data_indP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
/*
rlc_um_segment.c
-------------------
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
3GPP TS 25.322 V6.1.0 page 15:
The transmitting UM RLC entity segments the RLC SDU into UMD PDUs of appropriate size,
if the RLC SDU is larger than the length of available space in the UMD PDU. The UMD
PDU may contain segmented and/or concatenated RLC SDUs. UMD PDU may also contain
padding to ensure that it is of a valid length. Length Indicators are used to define
boundaries between RLC SDUs within UMD PDUs. Length Indicators are also used to define
whether Padding is included in the UMD PDU.
3GPP TS 25.322 V6.1.0 page 30:
Length indicators:
A "Length Indicator" is used to indicate the last octet of each RLC SDU ending within the PDU.
Except for the predefined values reserved for special purposes and listed in the tables below, the "Length Indicator"
shall:
- be set to the number of octets between the end of the RLC header and up to and including the last octet of an RLC SDU
segment;
- be included in the PDUs that they refer to.
The size of the "Length Indicator" may be either 7 bits or 15 bits. The "Length Indicator" size is determined
independently for uplink and downlink. The value of a "Length Indicator" shall not exceed the values specified in
subclauses 11.2.4.2 and 11.3.4.5 respectively for UMD and AMD PDUs.
The "Length Indicators" which refer to the same PDU shall:
- not be reordered in case of retransmission;
- be in the same order as the RLC SDUs that they refer to.
For UM uplink:
- if the "largest UL UMD PDU size" is < 125 octets:
- 7-bit "Length Indicators" shall be used.
- else:
- 15-bit "Length Indicators" shall be used.
For UM downlink:
- the "Length Indicator" size provided in "DL RLC UM LI size" shall be used.
For UM:
-between modifications of the "largest UMD PDU size", the size of the "Length Indicator" is the same for all UMD
PDUs;
-if the RLC SDU begins in the beginning of the RLC PDU; and
-if the RLC PDU is transmitted in uplink; and
-if the "Length Indicators" indicating that a RLC SDU ended exactly in the end or one octet short (only when 15-bit
"Length Indicators" is used) of the previous RLC PDU are not present:
-if 7-bit "Length Indicator" is used:
-the "Length Indicator" with value "111 1100" shall be used;
-if 15-bit "Length Indicator" is used:
-the "Length Indicator" with value "111 1111 1111 1100" shall be used.
-in downlink:
-if 7-bit "Length Indicator" is used:
-the Receiver shall be prepared to receive the "Length Indicator" with value "111 1100";
-the Receiver shall follow the discard rules in subclause 11.2.3 both when the "Length Indicator" with
value "111 1100" is present and when it is absent.
-if 15-bit "Length Indicator" is used:
-the Receiver shall be prepared to receive the "Length Indicator" with value "111 1111 1111 1100";
-the Receiver shall follow the discard rules in subclause 11.2.3 both when the "Length Indicator" with
value "111 1111 1111 1100" is present and when it is absent.
In the case where the end of the last segment of an RLC SDU exactly ends at the end of a PDU and there is no "Length
Indicator" that indicates the end of the RLC SDU:
-if 7-bit "Length Indicator" is used:
-a "Length Indicator" with value "000 0000" shall be placed as the first "Length Indicator" in the following
PDU;
-if 15-bit "Length Indicator" is used:
-a "Length Indicator" with value "000 0000 0000 0000" shall be placed as the first "Length Indicator" in the
following PDU.
In the case where a PDU contains a 15-bit "Length Indicator" indicating that an RLC SDU ends with one octet left in the
PDU, the last octet of this PDU shall:
-be padded by the Sender and ignored by the Receiver though there is no "Length Indicator" indicating the existence
of Padding; and
-not be filled with the first octet of the next RLC SDU data.
In the case where 15-bit "Length Indicators" are used in a PDU and the last segment of an RLC SDU is one octet short of
exactly filling the PDU:
-if a 15-bit "Length Indicator" is used for the following PDU:
-the "Length Indicator" with value "111 1111 1111 1011" shall be placed as the first "Length Indicator" in the
following PDU;
-the remaining one octet in the current PDU shall be padded by the Sender and ignored at the Receiver though
there is no "Length Indicator" indicating the existence of Padding;
-if a 7-bit "Length Indicator" is used for the following PDU:
-if RLC is configured for UM mode:
-the "Length Indicator" with value "000 0000" shall be placed as the first "Length indicator" in the
following PDU and its "Sequence Number" shall be incremented by 2 before it is transmitted.
For UM and AM RLC:
-if a 7 bit "Length Indicator" is used in a RLC PDU and one or more padding octets are present in the RLC PDU after
the end of the last RLC SDU:
-indicate the presence of padding by including a "Length Indicator" with value "1111111" as the last "Length
Indicator" in the PDU.
-if a 15 bit "Length Indicator" is used in a RLC PDU and two or more padding octets are present in the RLC PDU after
the end of the last RLC SDU:
-indicate the presence of padding by including a "Length Indicator" with value "111 1111 1111 1111" as the last
"Length Indicator" in the PDU.
NOTE: After the "Length Indicator" indicating the presence of padding has been included in the RLC PDU, the length of
the padding may be zero.
If a "Length Indicator" is still awaiting transmission and there is no RLC SDU available, an RLC PDU consisting of this
"Length Indicator", the appropriate padding "Length Indicator" and padding may be transmitted.
Predefined values of the "Length Indicator" are used to indicate padding. The values that are reserved for special
purposes are listed in the tables below depending on the size of the "Length Indicator". Only predefined "Length
Indicator" values can refer to the padding space. These values shall only be placed after all other "Length Indicators"
for a PDU.
STATUS PDUs can be piggybacked on the AMD PDU by using part or all of the padding space. A predefined "Length Indicator"
shall be used to indicate the presence of a piggybacked STATUS PDU. This "Length Indicator" replaces the padding "Length
Indicator". The piggybacked STATUS PDU shall be appended immediately following the PDU data. When only part of the
padding space is used, the end of the piggybacked STATUS PDU is indicated by one of the SUFI fields NO_MORE or ACK. Thus
no additional "Length Indicator" is required to show that there is still padding in the AMD PDU.
Length: 7 bits
0000000 The previous RLC PDU was exactly filled with the last segment of an RLC SDU and there is no "Length Indicator"
that indicates the end of the RLC SDU in the previous RLC PDU.
1111100 UMD PDU: The first data octet in this RLC PDU is the first octet of an RLC SDU. AMD PDU: Reserved (PDUs with
this coding will be discarded by this version of the protocol).
1111101 Reserved (PDUs with this coding will be discarded by this version of the protocol).
1111110 AMD PDU: The rest of the RLC PDU includes a piggybacked STATUS PDU. UMD PDU: Reserved (PDUs with this coding
will be discarded by this version of the protocol).
1111111 The rest of the RLC PDU is padding. The padding length can be zero.
Length: 15bits
000000000000000 The previous RLC PDU was exactly filled with the last segment of an RLC SDU and there is no "Length
Indicator" that indicates the end of the RLC SDU in the previous RLC PDU.
111111111111011 The last segment of an RLC SDU was one octet short of exactly filling the previous RLC PDU and there is
no "Length Indicator" that indicates the end of the RLC SDU in the previous RLC PDU. The remaining one octet in the
previous RLC PDU is ignored.
111111111111100 UMD PDU: The first data octet in this RLC PDU is the first octet of an RLC SDU. AMD PDU: Reserved (PDUs
with this coding will be discarded by this version of the protocol).
111111111111101 Reserved (PDUs with this coding will be discarded by this version of the protocol).
111111111111110 AMD PDU: The rest of the RLC PDU includes a piggybacked STATUS PDU. UMD PDU: Reserved (PDUs with this
coding will be discarded by this version of the protocol).
111111111111111 The rest of the RLC PDU is padding. The padding length can be zero.
************************************************************************** */
#include "rtos_header.h"
#include "platform_types.h"
#include "list.h"
#include "rlc_um_entity.h"
#include "rlc_um_structs.h"
#include "rlc_primitives.h"
#include "rlc_def.h"
#include "rlc_um_constants.h"
//#define DEBUG_RLC_UM_SEGMENT 1
//#define DEBUG_RLC_UM_SEGMENT_LI 1
//#define DEBUG_RLC_UM_DISCARD_SDU 1
//#define DEBUG_RLC_UM_SEGMENT_FILL_DATA 1
//#define DEBUG_RLC_UM_SEGMENT_ENCODE 1
//#define DEBUG_RLC_UM_VT_US
#ifdef DEBUG_RLC_UM_SEGMENT
#define PRINT_RLC_UM_SEGMENT msg
#else
#define PRINT_RLC_UM_SEGMENT //
#endif
#ifdef DEBUG_RLC_UM_SEGMENT_ENCODE
#define PRINT_RLC_UM_SEGMENT_ENCODE msg
#else
#define PRINT_RLC_UM_SEGMENT_ENCODE //
#endif
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
#define PRINT_RLC_UM_SEGMENT_FILL_DATA msg
#else
#define PRINT_RLC_UM_SEGMENT_FILL_DATA //
#endif
#ifdef DEBUG_RLC_UM_DISCARD_SDU
#define PRINT_RLC_UM_DISCARD_SDU msg
#else
#define PRINT_RLC_UM_DISCARD_SDU //
#endif
//-----------------------------------------------------------------------------
uint8_t rlc_um_crc8_xor(char*, signed int);
mem_block_t* rlc_um_build_pdu_with_only_2li (struct rlc_um_entity* rlcP, uint16_t li0P, uint16_t li1P);
inline void rlc_um_encode_pdu_7 (struct rlc_um_entity* rlcP, struct rlc_um_tx_data_pdu_struct* rlc_headerP, struct
rlc_um_tx_pdu_management* pdu_mngtP, uint16_t* li_arrayP, uint8_t nb_liP);
inline void rlc_um_fill_pdus (struct rlc_um_entity* rlcP, list_t* pdusP, list_t* segmented_sdusP);
void rlc_um_segment_15 (struct rlc_um_entity* rlcP);
//-----------------------------------------------------------------------------
uint8_t rlc_um_crc8_xor (char* mem_areaP, signed int num_bytesP)
{
//-----------------------------------------------------------------------------
uint8_t crc = 0;
while (num_bytesP > 0) {
num_bytesP = num_bytesP -1;
crc = crc ^ mem_areaP[num_bytesP];
}
return crc;
}
//-----------------------------------------------------------------------------
mem_block_t*
rlc_um_build_pdu_with_only_2li (struct rlc_um_entity* rlcP, uint16_t li0P, uint16_t li1P)
{
//-----------------------------------------------------------------------------
struct rlc_um_tx_data_pdu_struct* rlc_header;
struct rlc_um_tx_pdu_management* pdu_mngt;
mem_block_t* pdu;
uint32_t rlc_um_crc;
if (!(pdu = get_free_mem_block (rlcP->data_pdu_size + sizeof (struct rlc_um_tx_data_pdu_management) + GUARD_CRC_LIH_SIZE))) {
msg ("[RLC_UM_LITE][RB %d] BUILD PDU 2 LI ERROR COULD NOT GET NEW PDU, EXIT...BEFORE CRASH\n", rlcP->rb_id);
return NULL;
}
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT PDU SN %d SET LIs %04X %04X\n", rlcP->rb_id, rlcP->vt_us, li0P, li1P);
#endif
rlc_header = (struct rlc_um_tx_data_pdu_struct*) (&pdu->data[sizeof (struct rlc_um_tx_data_pdu_management)]);
pdu_mngt = (struct rlc_um_tx_pdu_management*) (pdu->data);
memset (pdu->data, 0, sizeof (struct rlc_um_tx_pdu_management));
rlc_header->byte1 = (rlcP->vt_us << 1) | RLC_E_NEXT_FIELD_IS_LI_E;
if (rlcP->data_pdu_size > 125) {
rlc_header->li_data_7[0] = (uint8_t) (li0P >> 8);
rlc_header->li_data_7[1] = (uint8_t) (li0P | RLC_E_NEXT_FIELD_IS_LI_E);
rlc_header->li_data_7[2] = (uint8_t) (li1P >> 8);
rlc_header->li_data_7[3] = (uint8_t) li1P;
rlcP->li_length_15_was_used_for_previous_pdu = 1;
if ((rlcP->crc_on_header)) {
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT PDU SN %d put CRC\n", rlcP->rb_id, (rlcP->vt_us + 1) & 0x7F);
#endif
rlc_um_crc = rlc_um_crc8_xor (&rlc_header->byte1, 5);// * 8);
rlc_header->li_data_7[rlcP->data_pdu_size - 2] = (uint8_t) (rlc_um_crc ) ; //>> 24);
}
} else {
rlc_header->li_data_7[0] = (uint8_t) (li0P | RLC_E_NEXT_FIELD_IS_LI_E);
rlc_header->li_data_7[1] = (uint8_t) li1P;
rlcP->li_length_15_was_used_for_previous_pdu = 0;
if ((rlcP->crc_on_header)) {
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT PDU SN %d put CRC\n", rlcP->rb_id, (rlcP->vt_us + 1) & 0x7F);
#endif
rlc_um_crc = rlc_um_crc8_xor (&rlc_header->byte1, 3);// * 8);
rlc_header->li_data_7[rlcP->data_pdu_size - 2] = (uint8_t) (rlc_um_crc); // >> 24);
}
}
// inc vt_us
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE][RB %d] Inc VT(US) in rlc_um_build_pdu_with_only_2li()\n", rlcP->rb_id);
#endif
rlcP->vt_us = (rlcP->vt_us + 1) & 0x7F;
pdu_mngt->first_byte = (uint8_t*) rlc_header;
pdu_mngt->data_size = 0;
pdu_mngt->payload = NULL;
return pdu;
}
//-----------------------------------------------------------------------------
inline void
rlc_um_encode_pdu_15 (struct rlc_um_entity* rlcP, struct rlc_um_tx_data_pdu_struct* rlc_headerP, struct
rlc_um_tx_pdu_management* pdu_mngtP, uint16_t* li_arrayP, uint8_t nb_liP)
{
//-----------------------------------------------------------------------------
uint8_t li_index;
uint32_t rlc_um_crc;
#ifdef DEBUG_RLC_UM_SEGMENT
int index;
msg ("[RLC_UM_LITE][RB %d] SEGMENT_15 PDU SN %d SET LIs: ", rlcP->rb_id, rlcP->vt_us);
for (index = 0; index < nb_liP; index++) {
msg ("%04X ", li_arrayP[index]);
}
msg ("\n");
#endif
rlc_headerP->byte1 = (rlcP->vt_us << 1);
// inc vt_us
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE %p] Inc VT(US) in rlc_um_encode_pdu_15\n", rlcP);
#endif
rlcP->vt_us = (rlcP->vt_us + 1) & 127;
nb_liP = nb_liP << 1;
pdu_mngtP->payload = (uint8_t*) ((uint32_t) (&rlc_headerP->li_data_7[nb_liP]));
if (nb_liP) {
rlc_headerP->byte1 |= RLC_E_NEXT_FIELD_IS_LI_E;
li_index = 0;
// COPY LI
while (li_index < nb_liP) {
rlc_headerP->li_data_7[li_index] = li_arrayP[li_index >> 1] >> 8;
li_index += 1;
rlc_headerP->li_data_7[li_index] = li_arrayP[li_index >> 1] | RLC_E_NEXT_FIELD_IS_LI_E;
li_index += 1;
}
rlc_headerP->li_data_7[li_index - 1] = rlc_headerP->li_data_7[li_index - 1] ^ (uint8_t) RLC_E_NEXT_FIELD_IS_LI_E;
}
if ((rlcP->crc_on_header)) {
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT PDU put CRC\n", rlcP->rb_id);
#endif
rlc_um_crc = rlc_um_crc8_xor (&rlc_headerP->byte1, (nb_liP + 1));// * 8);
rlc_headerP->li_data_7[rlcP->data_pdu_size - 2] = (uint8_t) (rlc_um_crc); // >> 24);
}
}
//-----------------------------------------------------------------------------
inline void
rlc_um_encode_pdu_7 (struct rlc_um_entity* rlcP, struct rlc_um_tx_data_pdu_struct* rlc_headerP, struct
rlc_um_tx_pdu_management* pdu_mngtP, uint16_t* li_arrayP, uint8_t nb_liP)
{
//-----------------------------------------------------------------------------
uint8_t li_index;
uint32_t rlc_um_crc;
#ifdef DEBUG_RLC_UM_SEGMENT_ENCODE
int index;
msg ("[RLC_UM_LITE][RB %d] SEGMENT_7 PDU %p SN %d SET LIs: ", rlcP->rb_id, pdu_mngtP, rlcP->vt_us);
for (index = 0; index < nb_liP; index++) {
msg ("%04X ", li_arrayP[index]);
}
msg ("\n");
#endif
rlc_headerP->byte1 = (rlcP->vt_us << 1);
// inc vt_us
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE][RB %d] Encode VT(US) %d and Inc VT(US) in rlc_um_encode_pdu_7()\n", rlcP->rb_id, rlcP->vt_us);
#endif
rlcP->vt_us = (rlcP->vt_us + 1) & 127;
pdu_mngtP->payload = (uint8_t*) ((uint32_t) (&rlc_headerP->li_data_7[nb_liP]));
if (nb_liP) {
rlc_headerP->byte1 |= RLC_E_NEXT_FIELD_IS_LI_E;
li_index = 0;
// COPY LI
while (li_index < nb_liP) {
rlc_headerP->li_data_7[li_index] = (uint8_t) (li_arrayP[li_index]) | RLC_E_NEXT_FIELD_IS_LI_E;
li_index += 1;
}
rlc_headerP->li_data_7[li_index - 1] = rlc_headerP->li_data_7[li_index - 1] ^ (uint8_t) RLC_E_NEXT_FIELD_IS_LI_E;
}
if ((rlcP->crc_on_header)) {
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT PDU SN %d put CRC\n", rlcP->rb_id);
#endif
rlc_um_crc = rlc_um_crc8_xor (&rlc_headerP->byte1, (nb_liP + 1));// * 8);
rlc_headerP->li_data_7[rlcP->data_pdu_size - 2] = (uint8_t) (rlc_um_crc); // >> 24);
}
}
//-----------------------------------------------------------------------------
inline void
rlc_um_fill_pdus (struct rlc_um_entity* rlcP, list_t* pdusP, list_t* segmented_sdusP)
{
//-----------------------------------------------------------------------------
mem_block_t* pdu;
mem_block_t* sdu;
uint8_t* data_sdu = NULL;
uint8_t* data_pdu;
struct rlc_um_tx_data_pdu_struct* rlc_header;
struct rlc_um_tx_pdu_management* pdu_mngt;
struct rlc_um_tx_sdu_management* sdu_mngt;
uint16_t pdu_remaining_size;
uint16_t sdu_available_size;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
int tb_size_in_bytes;
#endif
pdu = NULL;
sdu = NULL;
// dispatch sdus
while ((pdu = list_remove_head (pdusP))) {
pdu_mngt = (struct rlc_um_tx_pdu_management*) (pdu->data);
rlc_header = (struct rlc_um_tx_data_pdu_struct*) (pdu_mngt->first_byte);
pdu_remaining_size = pdu_mngt->data_size;
data_pdu = (uint8_t*) pdu_mngt->payload;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE][RB %d] SEGMENT FILL GET PDU %p REMAINING SIZE=%d\n", rlcP->rb_id, pdu, pdu_remaining_size);
#endif
if (pdu_remaining_size > 0) {
// fill the pdu with data of sdu
while (pdu) {
if (sdu == NULL) {
sdu = list_remove_head (segmented_sdusP);
sdu_mngt = (struct rlc_um_tx_sdu_management*) (sdu->data);
data_sdu = &sdu->data[sizeof (struct rlc_um_tx_sdu_management) + sdu_mngt->sdu_segmented_size];
sdu_available_size = sdu_mngt->sdu_size - sdu_mngt->sdu_remaining_size - sdu_mngt->sdu_segmented_size;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE %p] SEGMENT FILL GET SDU %p AVAILABLE_SZ=%d (SZ %d REMAIN_SZ %d SEGMENT_SZ %d)\n", rlcP, sdu,
sdu_available_size, sdu_mngt->sdu_size, sdu_mngt->sdu_remaining_size, sdu_mngt->sdu_segmented_size);
#endif
}
// copy the whole remaining data of the sdu in the remaining area of the pdu
if (pdu_remaining_size >= sdu_available_size) {
memcpy (data_pdu, data_sdu, sdu_available_size);
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE %p] SEGMENT FILL PDU %p WITH SDU %p %p <- %p %d bytes (SZ %d REMAIN_SZ %d SEGMENT_SZ %d)\n",
rlcP, pdu, sdu, data_pdu, data_sdu, sdu_available_size, sdu_mngt->sdu_size, sdu_mngt->sdu_remaining_size, sdu_mngt->sdu_segmented_size);
#endif
pdu_remaining_size -= sdu_available_size;
sdu_mngt->sdu_segmented_size += sdu_available_size;
data_pdu = (uint8_t*) ((uint32_t) data_pdu + sdu_available_size);
sdu_available_size = 0;
// dispatch the sdu
free_mem_block (sdu);
sdu = NULL;
// dispatch the pdu
if (pdu_remaining_size == 0) {
((struct mac_tb_req*) (pdu->data))->rlc = NULL;
((struct mac_tb_req*) (pdu->data))->data_ptr = &rlc_header->byte1;
((struct mac_tb_req*) (pdu->data))->first_bit = 0;
((struct mac_tb_req*) (pdu->data))->tb_size_in_bits = rlcP->data_pdu_size_in_bits;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE][RB %d] DUMP TX PDU:", rlcP->rb_id);
for (tb_size_in_bytes = 0; tb_size_in_bytes < (rlcP->data_pdu_size_in_bits >> 3); tb_size_in_bytes++) {
msg ("%02X.", (((struct mac_tb_req*) (pdu->data))->data_ptr)[tb_size_in_bytes]);
}
msg("\n");
#endif
list_add_tail_eurecom (pdu, &rlcP->pdus_to_mac_layer);
pdu = NULL;
} else {
}
// copy some data of the sdu in the whole remaining area of the pdu
} else {
memcpy (data_pdu, data_sdu, pdu_remaining_size);
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE %p] SEGMENT FILL PDU %p WITH SDU %p %p <- %p %d bytes (SZ %d REMAIN_SZ %d SEGMENT_SZ %d)\n",
rlcP, pdu, sdu, data_pdu, data_sdu, pdu_remaining_size, sdu_mngt->sdu_size, sdu_mngt->sdu_remaining_size, sdu_mngt->sdu_segmented_size);
#endif
sdu_mngt->sdu_segmented_size += pdu_remaining_size;
sdu_available_size -= pdu_remaining_size;
data_sdu = (uint8_t*) ((uint32_t) data_sdu + (uint32_t) pdu_remaining_size);
// dispatch the pdu
((struct mac_tb_req*) (pdu->data))->rlc = NULL;
((struct mac_tb_req*) (pdu->data))->data_ptr = &rlc_header->byte1;
((struct mac_tb_req*) (pdu->data))->first_bit = 0;
((struct mac_tb_req*) (pdu->data))->tb_size_in_bits = rlcP->data_pdu_size_in_bits;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE][RB %d] DUMP TX PDU:", rlcP->rb_id);
for (tb_size_in_bytes = 0; tb_size_in_bytes < (rlcP->data_pdu_size_in_bits >> 3); tb_size_in_bytes++) {
msg ("%02X.", (((struct mac_tb_req*) (pdu->data))->data_ptr)[tb_size_in_bytes]);
}
msg("\n");
#endif
list_add_tail_eurecom (pdu, &rlcP->pdus_to_mac_layer);
pdu = NULL;
pdu_remaining_size = 0;
}
}
} else { // end if pdu_remaining_size > 0
if (pdu) {
((struct mac_tb_req*) (pdu->data))->rlc = NULL;
((struct mac_tb_req*) (pdu->data))->data_ptr = &rlc_header->byte1;
((struct mac_tb_req*) (pdu->data))->first_bit = 0;
((struct mac_tb_req*) (pdu->data))->tb_size_in_bits = rlcP->data_pdu_size_in_bits;
#ifdef DEBUG_RLC_UM_SEGMENT_FILL_DATA
msg ("[RLC_UM_LITE][RB %d] DUMP TX PDU:", rlcP->rb_id);
for (tb_size_in_bytes = 0; tb_size_in_bytes < (rlcP->data_pdu_size_in_bits >> 3); tb_size_in_bytes++) {
msg ("%02X.", (((struct mac_tb_req*) (pdu->data))->data_ptr)[tb_size_in_bytes]);
}
msg("\n");
#endif
list_add_tail_eurecom (pdu, &rlcP->pdus_to_mac_layer);
pdu = NULL;
}
}
}
list_display (&rlcP->pdus_to_mac_layer);
list_free (segmented_sdusP);
}
//-----------------------------------------------------------------------------
void
rlc_um_segment_15 (struct rlc_um_entity* rlcP)
{
//-----------------------------------------------------------------------------
list_t segmented_sdus; // the copying of sdu data is done after identification of all LIs to put in pdu
list_t pdus;
struct rlc_um_tx_sdu_management* sdu_mngt;
struct rlc_um_tx_pdu_management* pdu_mngt;
struct rlc_um_tx_data_pdu_struct* rlc_header;
mem_block_t* pdu;
mem_block_t* sdu_copy;
int16_t pdu_remaining_size;
uint16_t li[RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU];
uint8_t discard_go_on = 1;
uint8_t li_index = 0;
uint8_t nb_pdu_to_transmit = rlcP->nb_pdu_requested_by_mac;
pdu = NULL;
list_init (&segmented_sdus, NULL); // param string identifying the list is NULL
list_init (&pdus, NULL); // param string identifying the list is NULL
// DISCARD of SDUs : TIMER_BASED_NO_EXPLICIT
// from 3GPP TS 25.322 V6.1.0 page 52
// This alternative is only applicable to RLC entities operating in unacknowledged or transparent mode.
// It uses the same timer based trigger for SDU discard (Timer_Discard) as the one described in the
// subclause9.7.3.1. The difference is that this discard method does not use any peer-to-peer signalling.
// For every SDU received from upper layers, the Sender shall:
// - start timer monitoring of the transmission time of the SDU.
// When the transmission time exceeds the configured value for a SDU, the Sender shall:
// - discard the SDU without explicit signalling (for RLC entities operating in unacknowledged mode
// apply subclause 11.2.4.3 for updating the state variables).
// from 3GPP TS 25.322 V6.1.0 page 61
// Upon expiry of the timer Timer_Discard in the Sender, the Sender shall:
// - discard the associated SDU;
// - if requested:
// -inform the upper layers of the discarded SDU;
// - for the first UMD PDU to be transmitted after the discard operation, the Sender shall:
// - increment VT(US) so that the "Sequence Number" field in this UMD PDU is incremented with two
// compared with the previous UMD PDU;
// - fill the first data octet in this UMD PDU with the first octet of an RLC SDU;
// - set the first "Length Indicator" in this UMD PDU to indicate that the previous RLC PDU
// was exactly filled with the last segment of an RLC SDU (to avoid that the Receiver unnecessarily
// discards an extra SDU).
if ((rlcP->sdu_discard_mode & RLC_SDU_DISCARD_TIMER_BASED_NO_EXPLICIT)) {
discard_go_on = 1;
while ((rlcP->input_sdus[rlcP->current_sdu_index]) && discard_go_on) {
if ((*rlcP->frame_tick_milliseconds - ((struct rlc_um_tx_sdu_management*)
(rlcP->input_sdus[rlcP->current_sdu_index]->data))->sdu_creation_time) >= rlcP->timer_discard_init) {
#ifdef DEBUG_RLC_UM_DISCARD_SDU
msg ("[RLC_UM_LITE][RB %d] SDU DISCARDED : TIMED OUT %d ms\n", rlcP->rb_id, *rlcP->frame_tick_milliseconds - ((struct rlc_um_tx_sdu_management*)
(rlcP->input_sdus[rlcP->current_sdu_index]->data))->sdu_creation_time);
#endif
free_mem_block (rlcP->input_sdus[rlcP->current_sdu_index]);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE][RB %d] Inc VT(US) in discarding sdu in rlc_um_segment_15()\n", rlcP->rb_id);
#endif
rlcP->vt_us = (rlcP->vt_us + 1) & 0x7F;
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
} else {
discard_go_on = 0;
}
}
}
while ((rlcP->input_sdus[rlcP->current_sdu_index]) && (nb_pdu_to_transmit > 0)) {
sdu_mngt = ((struct rlc_um_tx_sdu_management*) (rlcP->input_sdus[rlcP->current_sdu_index]->data));
// pdu management
if (!pdu) {
if (!(pdu = get_free_mem_block (rlcP->data_pdu_size + sizeof (struct rlc_um_tx_data_pdu_management) + GUARD_CRC_LIH_SIZE))) {
msg ("[RLC_UM_LITE][SEGMENT] ERROR COULD NOT GET NEW PDU, EXIT\n");
return;
}
li_index = 0;
if ((rlcP->crc_on_header)) {
pdu_remaining_size = rlcP->data_pdu_size - 2; // 4= size of header + size of CRC on RLC header
} else {
pdu_remaining_size = rlcP->data_pdu_size - 1; // 2= size of header, minimum = sequence number
}
pdu_mngt = (struct rlc_um_tx_pdu_management*) (pdu->data);
memset (pdu->data, 0, sizeof (struct rlc_um_tx_pdu_management));
pdu_mngt->first_byte = &pdu->data[sizeof (struct rlc_um_tx_data_pdu_management)];
rlc_header = (struct rlc_um_tx_data_pdu_struct*) (pdu_mngt->first_byte);
// -if the RLC SDU begins in the beginning of the RLC PDU; and
// -if the RLC PDU is transmitted in uplink; and
// -if the "Length Indicators" indicating that a RLC SDU ended exactly in the end or one octet short (only
// when 15-bit "Length Indicators" is used) of the previous RLC PDU are not present:
// -if 7-bit "Length Indicator" is used:
// -the "Length Indicator" with value "111 1100" shall be used;
// -if 15-bit "Length Indicator" is used:
// -the "Length Indicator" with value "111 1111 1111 1100" shall be used.
if ((rlcP->li_length_15_was_used_for_previous_pdu) && (rlcP->li_one_byte_short_to_add_in_next_pdu)) {
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 15] ADD RLC_LI_LAST_PDU_ONE_BYTE_SHORT\n", rlcP->rb_id);
#endif
li[li_index++] = RLC_LI_LAST_PDU_ONE_BYTE_SHORT;
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
pdu_remaining_size -= 2;
}
if (rlcP->li_exactly_filled_to_add_in_next_pdu) {
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 15] ADD RLC_LI_LAST_PDU_EXACTLY_FILLED\n", rlcP->rb_id);
#endif
li[li_index++] = RLC_LI_LAST_PDU_EXACTLY_FILLED;
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
pdu_remaining_size -= 2;
}
#ifdef NODE_MT
if (sdu_mngt->sdu_size == sdu_mngt->sdu_remaining_size) {
if (!(rlcP->li_exactly_filled_to_add_in_next_pdu) && !(rlcP->li_one_byte_short_to_add_in_next_pdu)) {
# ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id);
# endif
li[li_index++] = RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU;
pdu_remaining_size -= 2;
//sdu_mngt->use_special_li = 0;
}
}
#endif
#ifdef NODE_RG
if (sdu_mngt->use_special_li) {
# ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id);
# endif
li[li_index++] = RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU;
pdu_remaining_size -= 2;
sdu_mngt->use_special_li = 0; // this field is not active when the sdu does not start at the begining of a pdu
}
#endif
}
if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) < 0) {
pdu_mngt->data_size += pdu_remaining_size;
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_length_15_was_used_for_previous_pdu = 1;
pdu = NULL;
nb_pdu_to_transmit -= 1;
sdu_mngt->sdu_remaining_size = sdu_mngt->sdu_remaining_size - pdu_remaining_size;
sdu_mngt->use_special_li = 0; // this field is not active when the sdu does not start at the begining of a pdu
} else {
if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) >= 2) {
pdu_remaining_size = pdu_remaining_size - sdu_mngt->sdu_remaining_size - 2; // size of li length
pdu_mngt->data_size += sdu_mngt->sdu_remaining_size;
li[li_index++] = sdu_mngt->sdu_remaining_size << 1;
sdu_mngt->sdu_remaining_size = 0;
list_add_tail_eurecom (rlcP->input_sdus[rlcP->current_sdu_index], &segmented_sdus);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
rlcP->buffer_occupancy -= sdu_mngt->sdu_size;
rlcP->nb_sdu -= 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
if (rlcP->nb_sdu == 0) {
if (pdu_remaining_size >= 2) {
li[li_index++] = RLC_LI_PDU_PADDING;
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_length_15_was_used_for_previous_pdu = 1;
pdu = NULL;
nb_pdu_to_transmit -= 1;
} else {
if (pdu_remaining_size == 0) {
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
pdu = NULL;
nb_pdu_to_transmit -= 1;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
rlcP->li_length_15_was_used_for_previous_pdu = 1;
// In the case where 15-bit "Length Indicators" are used for the previous PDU and the last segment
// of an RLC SDU is one octet short of exactly filling the PDU:
// - if a 15-bit "Length Indicator" is used for the following PDU:
// - the "Length Indicator" with value "111 1111 1111 1011" shall be placed as the first "Length Indicator" in the following PDU;
// - the remaining one octet in the previous PDU shall be padded by the Sender and ignored at the Receiver
// though there is no "Length Indicator" indicating the existence of Padding;
// - in case this SDU was the last one to be transmitted:
// - a RLC PDU consisting of an RLC Header with "Length Indicator" "111 1111 1111 1011" followed by a padding
// "Length Indicator" and padding may be transmitted;
} else if (pdu_remaining_size == 1) { // one byte remaining
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
pdu = NULL;
nb_pdu_to_transmit -= 1;
rlcP->li_one_byte_short_to_add_in_next_pdu = 1;
rlcP->li_length_15_was_used_for_previous_pdu = 1;
}
}
}
//
// } else { // else:if (!last_sdu)
// } // the while loop continue with the same pdu
} else if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) == 0) {
// from 3GPP TS 25.322 V6.1.0
//In the case where the end of the last segment of an RLC SDU exactly ends at the end of a PDU and there is
// no "Length Indicator" that indicates the end of the RLC SDU:
// - if 7-bit "Length Indicator" is used:
// - a "Length Indicator" with value "000 0000" shall be placed as the first "Length Indicator" in the following PDU;
// - if 15-bit "Length Indicator" is used:
// - a "Length Indicator" with value "000 0000 0000 0000" shall be placed as the first "Length Indicator" in the following PDU.
pdu_mngt->data_size += pdu_remaining_size;
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
pdu = NULL;
nb_pdu_to_transmit -= 1;
sdu_mngt->sdu_remaining_size = 0;
list_add_tail_eurecom (rlcP->input_sdus[rlcP->current_sdu_index], &segmented_sdus);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
rlcP->buffer_occupancy -= sdu_mngt->sdu_size;
rlcP->nb_sdu -= 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
rlcP->li_length_15_was_used_for_previous_pdu = 1;
} else if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) == 1) { // one byte remaining
// from 3GPP TS 25.322 V6.1.0
// In the case where a PDU contains a 15-bit "Length Indicator" indicating that an RLC SDU ends with
// one octet left in the PDU, the last octet of this PDU shall:
// - be padded by the Sender and ignored by the Receiver though there is no "Length Indicator"
// indicating the existence of Padding; and
// - not be filled with the first octet of the next RLC SDU data.
// In the case where 15-bit "Length Indicators" are used for the previous PDU and the last segment
// of an RLC SDU is one octet short of exactly filling the PDU:
// - if a 15-bit "Length Indicator" is used for the following PDU:
// - the "Length Indicator" with value "111 1111 1111 1011" shall be placed as the first "Length Indicator" in the following PDU;
// - the remaining one octet in the previous PDU shall be padded by the Sender and ignored at the Receiver
// though there is no "Length Indicator" indicating the existence of Padding;
// - in case this SDU was the last one to be transmitted:
// - a RLC PDU consisting of an RLC Header with "Length Indicator" "111 1111 1111 1011" followed by a padding
// "Length Indicator" and padding may be transmitted;
pdu_mngt->data_size += sdu_mngt->sdu_remaining_size;
rlc_um_encode_pdu_15 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
pdu = NULL;
nb_pdu_to_transmit -= 1;
sdu_mngt->sdu_remaining_size = 0;
list_add_tail_eurecom (rlcP->input_sdus[rlcP->current_sdu_index], &segmented_sdus);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
rlcP->buffer_occupancy -= sdu_mngt->sdu_size;
rlcP->nb_sdu -= 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
rlcP->li_one_byte_short_to_add_in_next_pdu = 1;
rlcP->li_length_15_was_used_for_previous_pdu = 1;
}
}
}
if (nb_pdu_to_transmit > 0) {
if ((rlcP->li_one_byte_short_to_add_in_next_pdu)) {
pdu = rlc_um_build_pdu_with_only_2li (rlcP, RLC_LI_LAST_PDU_ONE_BYTE_SHORT, RLC_LI_PDU_PADDING);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
} else if (rlcP->li_exactly_filled_to_add_in_next_pdu) {
pdu = rlc_um_build_pdu_with_only_2li (rlcP, RLC_LI_LAST_PDU_EXACTLY_FILLED, RLC_LI_PDU_PADDING);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
}
if (!(sdu_mngt)) {
rlc_um_fill_pdus (rlcP, &pdus, &segmented_sdus);
}
}
if ((sdu_mngt)) {
if (sdu_mngt->sdu_remaining_size > 0) {
sdu_copy = get_free_copy_mem_block ();
sdu_copy->data = (uint8_t*) sdu_mngt;
list_add_tail_eurecom (sdu_copy, &segmented_sdus);
}
rlc_um_fill_pdus (rlcP, &pdus, &segmented_sdus);
}
}
//-----------------------------------------------------------------------------
void
rlc_um_segment_7 (struct rlc_um_entity* rlcP)
{
//-----------------------------------------------------------------------------
list_t segmented_sdus; // the copying of sdu data is done after identification of all LIs to put in pdu
list_t pdus;
struct rlc_um_tx_sdu_management* sdu_mngt = NULL;
struct rlc_um_tx_pdu_management* pdu_mngt;
struct rlc_um_tx_data_pdu_struct* rlc_header;
mem_block_t* pdu;
mem_block_t* sdu_copy;
int16_t pdu_remaining_size;
uint16_t li[RLC_UM_SEGMENT_NB_MAX_LI_PER_PDU];
uint8_t discard_go_on = 1;
uint8_t sdu_discarded = 0;
uint8_t li_index = 0;
uint8_t nb_pdu_to_transmit = rlcP->nb_pdu_requested_by_mac;
pdu = NULL;
list_init (&segmented_sdus, NULL); // param string identifying the list is NULL
list_init (&pdus, NULL); // param string identifying the list is NULL
// DISCARD of SDUs : TIMER_BASED_NO_EXPLICIT
// from 3GPP TS 25.322 V6.1.0 page 52
// This alternative is only applicable to RLC entities operating in unacknowledged or transparent mode.
// It uses the same timer based trigger for SDU discard (Timer_Discard) as the one described in the
// subclause9.7.3.1. The difference is that this discard method does not use any peer-to-peer signalling.
// For every SDU received from upper layers, the Sender shall:
// - start timer monitoring of the transmission time of the SDU.
// When the transmission time exceeds the configured value for a SDU, the Sender shall:
// - discard the SDU without explicit signalling (for RLC entities operating in unacknowledged mode
// apply subclause 11.2.4.3 for updating the state variables).
// from 3GPP TS 25.322 V6.1.0 page 61
// Upon expiry of the timer Timer_Discard in the Sender, the Sender shall:
// - discard the associated SDU;
// - if requested:
// -inform the upper layers of the discarded SDU;
// - for the first UMD PDU to be transmitted after the discard operation, the Sender shall:
// - increment VT(US) so that the "Sequence Number" field in this UMD PDU is incremented with two
// compared with the previous UMD PDU;
// - fill the first data octet in this UMD PDU with the first octet of an RLC SDU;
// - set the first "Length Indicator" in this UMD PDU to indicate that the previous RLC PDU
// was exactly filled with the last segment of an RLC SDU (to avoid that the Receiver unnecessarily
// discards an extra SDU).
if ((rlcP->sdu_discard_mode & RLC_SDU_DISCARD_TIMER_BASED_NO_EXPLICIT)) {
discard_go_on = 1;
while ((rlcP->input_sdus[rlcP->current_sdu_index]) && discard_go_on) {
if ((*rlcP->frame_tick_milliseconds - ((struct rlc_um_tx_sdu_management*) (rlcP->input_sdus[rlcP->current_sdu_index]->data))->sdu_creation_time) >=
rlcP->timer_discard_init) {
#ifdef DEBUG_RLC_UM_DISCARD_SDU
msg ("[RLC_UM_LITE %p] SDU DISCARDED TIMED OUT %ld ms ", rlcP,
(*rlcP->frame_tick_milliseconds - ((struct rlc_um_tx_sdu_management*) (rlcP->input_sdus[rlcP->current_sdu_index]->data))->sdu_creation_time));
msg ("BO %d, NB SDU %d\n", rlcP->buffer_occupancy, rlcP->nb_sdu);
#endif
rlcP->buffer_occupancy -= ((struct rlc_um_tx_sdu_management*) (rlcP->input_sdus[rlcP->current_sdu_index]->data))->sdu_remaining_size;
rlcP->nb_sdu -= 1;
free_mem_block (rlcP->input_sdus[rlcP->current_sdu_index]);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
sdu_discarded = 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
} else {
discard_go_on = 0;
}
}
// increment VT(US) only once even if several SDUs discarded
if ((sdu_discarded)) {
#ifdef DEBUG_RLC_UM_VT_US
msg ("[RLC_UM_LITE %p] Inc VT(US) in discarding SDU in rlc_um_segment_7()\n", rlcP);
#endif
rlcP->vt_us = (rlcP->vt_us + 1) & 0x7F;
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
}
}
// DO SEGMENTATION
while ((rlcP->input_sdus[rlcP->current_sdu_index]) && (nb_pdu_to_transmit > 0)) {
sdu_mngt = ((struct rlc_um_tx_sdu_management*) (rlcP->input_sdus[rlcP->current_sdu_index]->data));
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d] SEGMENT GET NEW SDU %p AVAILABLE SIZE %d Bytes crc %d\n", rlcP->rb_id, sdu_mngt, sdu_mngt->sdu_remaining_size, rlcP->crc_on_header);
#endif
// pdu management
if (!(pdu)) {
if (!(pdu = get_free_mem_block (rlcP->data_pdu_size + sizeof (struct rlc_um_tx_data_pdu_management) + GUARD_CRC_LIH_SIZE))) {
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ERROR COULD NOT GET NEW PDU, EXIT\n", rlcP->rb_id);
return;
}
li_index = 0;
if ((rlcP->crc_on_header)) {
pdu_remaining_size = rlcP->data_pdu_size - 2; // 2= minimum size of header + size of CRC on RLC header
} else {
pdu_remaining_size = rlcP->data_pdu_size - 1; // 1= minimum size of header = sequence number
}
pdu_mngt = (struct rlc_um_tx_pdu_management*) (pdu->data);
memset (pdu->data, 0, sizeof (struct rlc_um_tx_pdu_management));
pdu_mngt->first_byte = &pdu->data[sizeof (struct rlc_um_tx_data_pdu_management)];
rlc_header = (struct rlc_um_tx_data_pdu_struct*) (pdu_mngt->first_byte);
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] CONSTRUCT NEW PDU\n", rlcP->rb_id);
#endif
// -if the RLC SDU begins in the beginning of the RLC PDU; and
// -if the RLC PDU is transmitted in uplink; and
// -if the "Length Indicators" indicating that a RLC SDU ended exactly in the end or one octet short (only
// when 15-bit "Length Indicators" is used) of the previous RLC PDU are not present:
// -if 7-bit "Length Indicator" is used:
// -the "Length Indicator" with value "111 1100" shall be used;
// -if 15-bit "Length Indicator" is used:
// -the "Length Indicator" with value "111 1111 1111 1100" shall be used.
if ((rlcP->li_length_15_was_used_for_previous_pdu) && (rlcP->li_one_byte_short_to_add_in_next_pdu)) {
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id);
#endif
li[li_index++] = RLC_LI_LAST_PDU_EXACTLY_FILLED;
pdu_remaining_size -= 1;
rlcP->vt_us = (rlcP->vt_us + 1) & 0x7F;
}
if (rlcP->li_exactly_filled_to_add_in_next_pdu) {
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_LAST_PDU_EXACTLY_FILLED\n", rlcP->rb_id);
#endif
li[li_index++] = RLC_LI_LAST_PDU_EXACTLY_FILLED;
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
pdu_remaining_size -= 1;
}
#ifdef NODE_MT
if (sdu_mngt->sdu_size == sdu_mngt->sdu_remaining_size) {
if (!(rlcP->li_exactly_filled_to_add_in_next_pdu) && !(rlcP->li_one_byte_short_to_add_in_next_pdu)) {
# ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id);
# endif
li[li_index++] = RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU;
pdu_remaining_size -= 1;
//sdu_mngt->use_special_li = 0;
}
}
#endif
#ifdef NODE_RG
if (sdu_mngt->use_special_li) {
# ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU\n", rlcP->rb_id);
# endif
li[li_index++] = RLC_LI_1ST_BYTE_SDU_IS_1ST_BYTE_PDU;
pdu_remaining_size -= 1;
sdu_mngt->use_special_li = 0; // this field is not active when the sdu does not start at the begining of a pdu
}
#endif
}
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
rlcP->li_length_15_was_used_for_previous_pdu = 0;
// SDU fills more than a PDU
if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) < 0) {
pdu_mngt->data_size += pdu_remaining_size;
rlcP->buffer_occupancy -= pdu_remaining_size;
rlc_um_encode_pdu_7 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
//rlcP->li_length_15_was_used_for_previous_pdu = 0;
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] PDU %p CONSTRUCTED WITH PAYLOAD %d Bytes offset_end_sdu %d @0\n", rlcP->rb_id, pdu, pdu_mngt->data_size,
sdu_mngt->sdu_remaining_size);
#endif
pdu = NULL;
nb_pdu_to_transmit -= 1;
sdu_mngt->sdu_remaining_size = sdu_mngt->sdu_remaining_size - pdu_remaining_size;
sdu_mngt->use_special_li = 0; // this field is not active when the sdu does not start at the begining of a pdu
// SDU does not fill a PDU
} else {
// more than one byte left
if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) >= 1) {
pdu_remaining_size = pdu_remaining_size - sdu_mngt->sdu_remaining_size - 1; // size of li length
pdu_mngt->data_size += sdu_mngt->sdu_remaining_size;
li[li_index++] = sdu_mngt->sdu_remaining_size << 1;
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD LI LENGTH %d\n", rlcP->rb_id, sdu_mngt->sdu_remaining_size);
#endif
rlcP->buffer_occupancy -= sdu_mngt->sdu_remaining_size;
sdu_mngt->sdu_remaining_size = 0;
list_add_tail_eurecom (rlcP->input_sdus[rlcP->current_sdu_index], &segmented_sdus);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
rlcP->nb_sdu -= 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
// from 3GPP TS 25.322 V6.1.0
// -if a 7 bit "Length Indicator" is used in a RLC PDU and one or more padding octets are present in the RLC PDU
// after the end of the last RLC SDU:
// -indicate the presence of padding by including a "Length Indicator" with value "1111111" as the last "Length
// Indicator" in the PDU.
// -if a 15 bit "Length Indicator" is used in a RLC PDU and two or more padding octets are present in the RLC PDU
// after the end of the last RLC SDU:
// -indicate the presence of padding by including a "Length Indicator" with value "111 1111 1111 1111" as the
// last "Length Indicator" in the PDU.
if (rlcP->nb_sdu == 0) {
if (pdu_remaining_size >= 1) {
li[li_index++] = RLC_LI_PDU_PADDING;
#ifdef DEBUG_RLC_UM_SEGMENT_LI
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] ADD LI PADDING\n", rlcP->rb_id);
#endif
rlc_um_encode_pdu_7 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] PDU %p CONSTRUCTED WITH PAYLOAD %d Bytes offset_end_sdu %d @1\n", rlcP->rb_id, pdu, pdu_mngt->data_size,
sdu_mngt->sdu_remaining_size);
#endif
pdu = NULL;
nb_pdu_to_transmit -= 1;
} else {
if (pdu_remaining_size == 0) {
rlc_um_encode_pdu_7 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7]PDU %p CONSTRUCTED WITH PAYLOAD %d Bytes offset_end_sdu %d @2\n", rlcP->rb_id, pdu, pdu_mngt->data_size,
sdu_mngt->sdu_remaining_size);
#endif
pdu = NULL;
nb_pdu_to_transmit -= 1;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
}
}
}
/*
} else { // else:if (!last_sdu)
} // the while loop continue with the same pdu */
// the SDU fills exactly the PDU
} else if ((pdu_remaining_size - sdu_mngt->sdu_remaining_size) == 0) {
// from 3GPP TS 25.322 V6.1.0
//In the case where the end of the last segment of an RLC SDU exactly ends at the end of a PDU and there is
// no "Length Indicator" that indicates the end of the RLC SDU:
// - if 7-bit "Length Indicator" is used:
// - a "Length Indicator" with value "000 0000" shall be placed as the first "Length Indicator" in the following PDU;
// - if 15-bit "Length Indicator" is used:
// - a "Length Indicator" with value "000 0000 0000 0000" shall be placed as the first "Length Indicator" in the following PDU.
pdu_mngt->data_size += pdu_remaining_size;
rlc_um_encode_pdu_7 (rlcP, rlc_header, pdu_mngt, li, li_index);
list_add_tail_eurecom (pdu, &pdus);
#ifdef DEBUG_RLC_UM_SEGMENT
msg ("[RLC_UM_LITE][RB %d][SEGMENT 7] PDU %p CONSTRUCTED WITH PAYLOAD %d Bytes offset_end_sdu %d @3\n", rlcP->rb_id, pdu, pdu_mngt->data_size,
sdu_mngt->sdu_remaining_size);
#endif
pdu = NULL;
nb_pdu_to_transmit -= 1;
rlcP->buffer_occupancy -= sdu_mngt->sdu_remaining_size;
sdu_mngt->sdu_remaining_size = 0;
list_add_tail_eurecom (rlcP->input_sdus[rlcP->current_sdu_index], &segmented_sdus);
rlcP->input_sdus[rlcP->current_sdu_index] = NULL;
rlcP->nb_sdu -= 1;
rlcP->current_sdu_index = (rlcP->current_sdu_index + 1) % rlcP->size_input_sdus_buffer;
rlcP->li_exactly_filled_to_add_in_next_pdu = 1;
//rlcP->li_length_15_was_used_for_previous_pdu = 0;
}
}
}
// There is no more SDU to fill requested PDUs
if (nb_pdu_to_transmit > 0) {
if ((rlcP->li_length_15_was_used_for_previous_pdu) && (rlcP->li_one_byte_short_to_add_in_next_pdu)) {
rlcP->vt_us = (rlcP->vt_us + 1) & 0x7F;
pdu = rlc_um_build_pdu_with_only_2li (rlcP, RLC_LI_LAST_PDU_EXACTLY_FILLED, RLC_LI_PDU_PADDING);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_one_byte_short_to_add_in_next_pdu = 0;
} else if (rlcP->li_exactly_filled_to_add_in_next_pdu) {
pdu = rlc_um_build_pdu_with_only_2li (rlcP, RLC_LI_LAST_PDU_EXACTLY_FILLED, RLC_LI_PDU_PADDING);
list_add_tail_eurecom (pdu, &pdus);
rlcP->li_exactly_filled_to_add_in_next_pdu = 0;
}
if (!(sdu_mngt)) {
rlc_um_fill_pdus (rlcP, &pdus, &segmented_sdus);
}
}
// if a SDU was partialy segmented, register it for filling pdus
if ((sdu_mngt)) {
if (sdu_mngt->sdu_remaining_size > 0) {
sdu_copy = get_free_copy_mem_block ();
sdu_copy->data = (uint8_t*) sdu_mngt;
list_add_tail_eurecom (sdu_copy, &segmented_sdus);
}
rlc_um_fill_pdus (rlcP, &pdus, &segmented_sdus);
}
}
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_SEGMENT_PROTO_EXTERN_H__
# define __RLC_UM_SEGMENT_PROTO_EXTERN_H__
//-----------------------------------------------------------------------------
# include "rlc_um_entity.h"
//-----------------------------------------------------------------------------
extern uint8_t rlc_um_crc8_xor (char *mem_areaP, signed int num_bytesP);
extern void rlc_um_segment_15 (struct rlc_um_entity *rlcP);
extern void rlc_um_segment_7 (struct rlc_um_entity *rlcP);
# endif
/*******************************************************************************
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
*******************************************************************************/
/******************************************************************************
AUTHOR : Lionel GAUTHIER
COMPANY : EURECOM
EMAIL : Lionel.Gauthier@eurecom.fr
*******************************************************************************/
# ifndef __RLC_UM_STRUCTS_H__
# define __RLC_UM_STRUCTS_H__
# include "platform_types.h"
# include "list.h"
# include "rlc_am_constants.h"
# include "mac_primitives.h"
# include "rlc_primitives.h"
//#ifdef USER_MODE
# include "mac_rlc_primitives.h"
//#endif //USER_MODE
//-----------------------
struct rlc_um_tx_sdu_management {
uint8_t *first_byte;
int32_t sdu_creation_time;
uint16_t sdu_remaining_size;
uint16_t sdu_segmented_size;
uint16_t sdu_size;
uint8_t use_special_li;
};
//-----------------------
struct rlc_um_tx_pdu_management {
uint8_t *first_byte; // point to first byte of RLC header
uint8_t *payload;
uint16_t data_size; // size of payload (not included byte1, LIs, and padding)
uint8_t dummy[MAC_HEADER_MAX_SIZE]; // optimization for MAC layer : reserve bytes for MAC header
};
//-----------------------
struct rlc_um_rx_pdu_management {
uint8_t *first_byte;
uint8_t sn;
};
//-----------------------
struct rlc_um_tx_data_pdu_management {
union {
struct rlc_um_tx_pdu_management tx_pdu_mngmnt;
struct mac_tb_req tb_req;
struct mac_tx_tb_management tb_mngt;
# ifdef BYPASS_L1
struct rlc_um_rx_pdu_management dummy1;
struct mac_tb_ind dummy2;
struct mac_rx_tb_management dummy3;
struct rlc_indication dummy4;
# endif
} dummy;
};
//-----------------------
struct rlc_um_rx_data_pdu_struct {
uint8_t byte1;
uint8_t li_data_7[1];
};
//-----------------------
struct rlc_um_tx_data_pdu_struct {
uint8_t byte1;
uint8_t li_data_7[1];
};
//-----------------------
struct rlc_um_data_req_alloc { // alloc enought bytes for sdu mngt also
union {
struct rlc_um_data_req dummy1;
struct rlc_um_tx_sdu_management dummy2;
} dummy;
};
# endif
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment