maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Fix: avoid infinite loop on mulitcast read thread if no data to read

Browse Source 
Pre-ci test passed

git-svn-id: http://svn.eurecom.fr/openair4G/trunk@4000 818b1a75-f10b-46b9-bf7c-635c3b92a50f
This commit is contained in:
Cedric Roux
2013-06-25 09:05:02 +00:00
commit 56c66c09aa
4111 changed files with 2133103 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
openair2/DOCS/TEMPLATES/CODE/COPYING
+340
View File
@@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) 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
this service 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 make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. 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.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
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
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the 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 a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE 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.
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
convey 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 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision 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, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This 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 Library General
Public License instead of this License.
openair2/DOCS/TEMPLATES/CODE/Doxyfile
+231
View File
@@ -0,0 +1,231 @@
# Doxyfile 1.5.3
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = OpenAirInterface
PROJECT_NUMBER = V1.0
OUTPUT_DIRECTORY =
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = example_doxy.h
INPUT_ENCODING = UTF-8
FILE_PATTERNS =
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH = images/
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH = /usr/bin/dot
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
openair2/DOCS/TEMPLATES/CODE/example_doxy.h
+149
View File
@@ -0,0 +1,149 @@
/*******************************************************************************
Eurecom OpenAirInterface 2
Copyright(c) 1999 - 2010 Eurecom
This program is free software; you can redistribute it and/or modify it
under the terms and conditions of the GNU General Public License,
version 2, as published by the Free Software Foundation.
This program is distributed in the hope it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
The full GNU General Public License is included in this distribution in
the file called "COPYING".
Contact Information
Openair Admin: openair_admin@eurecom.fr
Openair Tech : openair_tech@eurecom.fr
Forums : http://forums.eurecom.fsr/openairinterface
Address : Eurecom, 2229, route des crêtes, 06560 Valbonne Sophia Antipolis, France
*******************************************************************************/
/*! \file doxy_template.h
* \brief explain how this block is organized, and how it works
* \author Navid Nikaein
* \date 2006-2010
* \version 4.0
* \company Eurecom
* \email: navid.nikaein@eurecom.fr
* \note this a note
* \bug this is a bug
* \warning this is a warning
*/
//-----------------------------------begin group-----------------------------
/** @defgroup _oai System definitions
There is different modules:
- OAI Address
- OAI Components
- \ref _frame
The following diagram is based on graphviz (http://www.graphviz.org/), you need to install the package to view the diagram.
* \dot
* digraph group_frame {
* node [shape=rect, fontname=Helvetica, fontsize=8,style=filled,fillcolor=lightgrey];
* a [ label = " address"];
* b [ label = " component"];
* c [ label = " frame",URL="\ref _frame"];
* a->b;
* a->c;
* b->d;
* label="Architecture"
*
* }
* \enddot
\section _doxy Doxygen Help
You can use the provided Doxyfile as the configuration file or alternatively run "doxygen -g Doxyfile" to generat the file.
You need at least to set the some variables in the Doxyfile including "PROJECT_NAME","PROJECT_NUMBER","INPUT","IMAGE_PATH".
Doxygen help and commands can be found at http://www.stack.nl/~dimitri/doxygen/commands.html#cmdprotocol
\section _arch Architecture
You need to set the IMAGE_PATH in your Doxyfile
\image html arch.png "Architecture"
\image latex arch.eps "Architecture"
\subsection _mac MAC
thisis the mac
\subsection _rlc RLC
this is the rlc
\subsection _impl Implementation
what about the implementation
*@{*/
/*!\brief OAI protocol verion */
#define OAI_PROTOCOL_Version 0x00
/*!\brief Length in bytes of the OAI address */
#define OAI_ADDR_LEN 6
/*!\brief OAI snode type */
enum NodeType {
/*!\brief mesh routers are */
meshrouter = 1,
/*!\brief relay nodes are */
relaynode = 2,
/*!\brief clusterheads are */
clusterhead = 3
};
/*@}*/
// --------------------------end group ------------------------------
//---------------------------begin group------------------------------
/** @defgroup _frame Frame Structure
* @ingroup _oai
The Frame is composed of ....
*@{*/
/*! \brief the frame structure is ... */
struct frame {
u_short duration; /*!< \brief Duration in us (2 bytes) */
u_char da[OAI_ADDR_LEN];/*!< \brief Destination MAC@ (OAI_ADDR_LEN bytes) */
u_char sa[OAI_ADDR_LEN];/*!< \brief Source MAC@ (OAI_ADDR_LEN bytes)*/
u_char body[0]; /*!< \brief Body of the frame */
};
/*! \brief Broadcast ID is ... */
#define BROADCAST_ID 15
/*@}*/
//--------------------------end group-----------------------
//-----------------------begin func proto-------------------
/*! \fn int init(int,int)
* \brief this function initializes and allocates memories and etc.
* \param[in] src the memory area to copy frrm
* \param[out] dst the memory area to copy to
* \return 0 on success, otherwise -1
* \note
* @ingroup _oai
*/
int init(int src, int dst);
//-----------------------end func proto-------------------
openair2/DOCS/TEMPLATES/CODE/images/arch.eps
+785
View File
@@ -0,0 +1,785 @@
%!PS-Adobe-2.0 EPSF-2.0
%%Title: /homes/nikaeinn/templates/dev/arch.dia
%%Creator: Dia v0.95
%%CreationDate: Fri Dec 11 12:31:01 2009
%%For: nikaeinn
%%Orientation: Portrait
%%Magnification: 1.0000
%%BoundingBox: 0 0 355 138
%%BeginSetup
%%EndSetup
%%EndComments
%%BeginProlog
[ /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/.notdef /.notdef /space /exclam /quotedbl /numbersign /dollar /percent /ampersand /quoteright
/parenleft /parenright /asterisk /plus /comma /hyphen /period /slash /zero /one
/two /three /four /five /six /seven /eight /nine /colon /semicolon
/less /equal /greater /question /at /A /B /C /D /E
/F /G /H /I /J /K /L /M /N /O
/P /Q /R /S /T /U /V /W /X /Y
/Z /bracketleft /backslash /bracketright /asciicircum /underscore /quoteleft /a /b /c
/d /e /f /g /h /i /j /k /l /m
/n /o /p /q /r /s /t /u /v /w
/x /y /z /braceleft /bar /braceright /asciitilde /.notdef /.notdef /.notdef
/.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
/space /exclamdown /cent /sterling /currency /yen /brokenbar /section /dieresis /copyright
/ordfeminine /guillemotleft /logicalnot /hyphen /registered /macron /degree /plusminus /twosuperior /threesuperior
/acute /mu /paragraph /periodcentered /cedilla /onesuperior /ordmasculine /guillemotright /onequarter /onehalf
/threequarters /questiondown /Agrave /Aacute /Acircumflex /Atilde /Adieresis /Aring /AE /Ccedilla
/Egrave /Eacute /Ecircumflex /Edieresis /Igrave /Iacute /Icircumflex /Idieresis /Eth /Ntilde
/Ograve /Oacute /Ocircumflex /Otilde /Odieresis /multiply /Oslash /Ugrave /Uacute /Ucircumflex
/Udieresis /Yacute /Thorn /germandbls /agrave /aacute /acircumflex /atilde /adieresis /aring
/ae /ccedilla /egrave /eacute /ecircumflex /edieresis /igrave /iacute /icircumflex /idieresis
/eth /ntilde /ograve /oacute /ocircumflex /otilde /odieresis /divide /oslash /ugrave
/uacute /ucircumflex /udieresis /yacute /thorn /ydieresis] /isolatin1encoding exch def
/cp {closepath} bind def
/c {curveto} bind def
/f {fill} bind def
/a {arc} bind def
/ef {eofill} bind def
/ex {exch} bind def
/gr {grestore} bind def
/gs {gsave} bind def
/sa {save} bind def
/rs {restore} bind def
/l {lineto} bind def
/m {moveto} bind def
/rm {rmoveto} bind def
/n {newpath} bind def
/s {stroke} bind def
/sh {show} bind def
/slc {setlinecap} bind def
/slj {setlinejoin} bind def
/slw {setlinewidth} bind def
/srgb {setrgbcolor} bind def
/rot {rotate} bind def
/sc {scale} bind def
/sd {setdash} bind def
/ff {findfont} bind def
/sf {setfont} bind def
/scf {scalefont} bind def
/sw {stringwidth pop} bind def
/tr {translate} bind def
/ellipsedict 8 dict def
ellipsedict /mtrx matrix put
/ellipse
{ ellipsedict begin
/endangle exch def
/startangle exch def
/yrad exch def
/xrad exch def
/y exch def
/x exch def /savematrix mtrx currentmatrix def
x y tr xrad yrad sc
0 0 1 startangle endangle arc
savematrix setmatrix
end
} def
/mergeprocs {
dup length
3 -1 roll
dup
length
dup
5 1 roll
3 -1 roll
add
array cvx
dup
3 -1 roll
0 exch
putinterval
dup
4 2 roll
putinterval
} bind def
/dpi_x 300 def
/dpi_y 300 def
/conicto {
/to_y exch def
/to_x exch def
/conic_cntrl_y exch def
/conic_cntrl_x exch def
currentpoint
/p0_y exch def
/p0_x exch def
/p1_x p0_x conic_cntrl_x p0_x sub 2 3 div mul add def
/p1_y p0_y conic_cntrl_y p0_y sub 2 3 div mul add def
/p2_x p1_x to_x p0_x sub 1 3 div mul add def
/p2_y p1_y to_y p0_y sub 1 3 div mul add def
p1_x p1_y p2_x p2_y to_x to_y curveto
} bind def
/start_ol { gsave 1.1 dpi_x div dup scale} bind def
/end_ol { closepath fill grestore } bind def
28.346000 -28.346000 scale
-4.400000 -8.150000 translate
%%EndProlog
1.000000 1.000000 1.000000 srgb
n 4.450000 3.350000 m 4.450000 8.100000 l 16.850000 8.100000 l 16.850000 3.350000 l f
0.100000 slw
[] 0 sd
[] 0 sd
0 slj
0.000000 0.000000 0.000000 srgb
n 4.450000 3.350000 m 4.450000 8.100000 l 16.850000 8.100000 l 16.850000 3.350000 l cp s
gsave 8.875000 4.300000 translate 0.035278 -0.035278 scale
start_ol
1762 3044 moveto
1276 3044 990 2673 conicto
704 2303 704 1663 conicto
704 1025 990 654 conicto
1276 284 1762 284 conicto
2248 284 2532 654 conicto
2816 1025 2816 1663 conicto
2816 2303 2532 2673 conicto
2248 3044 1762 3044 conicto
1762 3392 moveto
2446 3392 2855 2922 conicto
3264 2453 3264 1664 conicto
3264 876 2855 406 conicto
2446 -64 1762 -64 conicto
1077 -64 666 405 conicto
256 874 256 1664 conicto
256 2453 666 2922 conicto
1077 3392 1762 3392 conicto
end_ol grestore
gsave 9.330083 4.300000 translate 0.035278 -0.035278 scale
start_ol
1536 2838 moveto
935 1180 lineto
2140 1180 lineto
1536 2838 lineto
1286 3282 moveto
1789 3282 lineto
3038 0 lineto
2577 0 lineto
2278 832 lineto
801 832 lineto
503 0 lineto
35 0 lineto
1286 3282 lineto
end_ol grestore
gsave 9.736483 4.300000 translate 0.035278 -0.035278 scale
start_ol
448 3328 moveto
874 3328 lineto
874 0 lineto
448 0 lineto
448 3328 lineto
end_ol grestore
gsave 9.914283 4.300000 translate 0.035278 -0.035278 scale
start_ol
end_ol grestore
gsave 10.100550 4.300000 translate 0.035278 -0.035278 scale
start_ol
1536 2838 moveto
935 1180 lineto
2140 1180 lineto
1536 2838 lineto
1286 3282 moveto
1789 3282 lineto
3038 0 lineto
2577 0 lineto
2278 832 lineto
801 832 lineto
503 0 lineto
35 0 lineto
1286 3282 lineto
end_ol grestore
gsave 10.506950 4.300000 translate 0.035278 -0.035278 scale
start_ol
1842 2133 moveto
1776 2174 1696 2193 conicto
1616 2212 1519 2212 conicto
1177 2212 993 1983 conicto
810 1755 810 1328 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2129 lineto
937 2347 1141 2453 conicto
1345 2560 1638 2560 conicto
1680 2560 1730 2554 conicto
1781 2548 1842 2536 conicto
1842 2133 lineto
end_ol grestore
gsave 10.752483 4.300000 translate 0.035278 -0.035278 scale
start_ol
2176 2404 moveto
2176 2020 lineto
2008 2116 1838 2164 conicto
1669 2212 1496 2212 conicto
1109 2212 895 1958 conicto
682 1705 682 1248 conicto
682 791 895 537 conicto
1109 284 1496 284 conicto
1669 284 1838 332 conicto
2008 380 2176 476 conicto
2176 97 lineto
2009 17 1830 -23 conicto
1652 -64 1449 -64 conicto
902 -64 579 291 conicto
256 646 256 1248 conicto
256 1859 582 2209 conicto
909 2560 1476 2560 conicto
1660 2560 1835 2521 conicto
2011 2482 2176 2404 conicto
end_ol grestore
gsave 11.074217 4.300000 translate 0.035278 -0.035278 scale
start_ol
2474 1509 moveto
2474 0 lineto
2048 0 lineto
2048 1502 lineto
2048 1858 1913 2035 conicto
1778 2212 1509 2212 conicto
1185 2212 997 1999 conicto
810 1786 810 1419 conicto
810 0 lineto
384 0 lineto
384 3456 lineto
810 3456 lineto
810 2120 lineto
954 2343 1152 2451 conicto
1350 2560 1609 2560 conicto
2037 2560 2255 2293 conicto
2474 2027 2474 1509 conicto
end_ol grestore
1.000000 1.000000 1.000000 srgb
n 4.900000 6.250000 m 4.900000 7.500000 l 8.250000 7.500000 l 8.250000 6.250000 l f
0.100000 slw
[] 0 sd
[] 0 sd
0 slj
0.000000 0.000000 0.000000 srgb
n 4.900000 6.250000 m 4.900000 7.500000 l 8.250000 7.500000 l 8.250000 6.250000 l cp s
1.000000 1.000000 1.000000 srgb
n 8.900000 6.200000 m 8.900000 7.495000 l 12.500000 7.495000 l 12.500000 6.200000 l f
0.100000 slw
[] 0 sd
[] 0 sd
0 slj
0.000000 0.000000 0.000000 srgb
n 8.900000 6.200000 m 8.900000 7.495000 l 12.500000 7.495000 l 12.500000 6.200000 l cp s
1.000000 1.000000 1.000000 srgb
n 13.090000 6.195000 m 13.090000 7.495000 l 16.400000 7.495000 l 16.400000 6.195000 l f
0.100000 slw
[] 0 sd
[] 0 sd
0 slj
0.000000 0.000000 0.000000 srgb
n 13.090000 6.195000 m 13.090000 7.495000 l 16.400000 7.495000 l 16.400000 6.195000 l cp s
gsave 5.400000 7.100000 translate 0.035278 -0.035278 scale
start_ol
1536 2838 moveto
935 1180 lineto
2140 1180 lineto
1536 2838 lineto
1286 3282 moveto
1789 3282 lineto
3038 0 lineto
2577 0 lineto
2278 832 lineto
801 832 lineto
503 0 lineto
35 0 lineto
1286 3282 lineto
end_ol grestore
gsave 5.795817 7.100000 translate 0.035278 -0.035278 scale
start_ol
2048 2116 moveto
2048 3456 lineto
2474 3456 lineto
2474 0 lineto
2048 0 lineto
2048 380 lineto
1922 154 1727 45 conicto
1533 -64 1261 -64 conicto
816 -64 536 297 conicto
256 659 256 1248 conicto
256 1837 536 2198 conicto
816 2560 1260 2560 conicto
1532 2560 1726 2450 conicto
1921 2341 2048 2116 conicto
682 1248 moveto
682 798 864 541 conicto
1046 284 1364 284 conicto
1683 284 1865 541 conicto
2048 798 2048 1248 conicto
2048 1699 1865 1955 conicto
1683 2212 1364 2212 conicto
1046 2212 864 1955 conicto
682 1699 682 1248 conicto
end_ol grestore
gsave 6.176817 7.100000 translate 0.035278 -0.035278 scale
start_ol
2048 2116 moveto
2048 3456 lineto
2474 3456 lineto
2474 0 lineto
2048 0 lineto
2048 380 lineto
1922 154 1727 45 conicto
1533 -64 1261 -64 conicto
816 -64 536 297 conicto
256 659 256 1248 conicto
256 1837 536 2198 conicto
816 2560 1260 2560 conicto
1532 2560 1726 2450 conicto
1921 2341 2048 2116 conicto
682 1248 moveto
682 798 864 541 conicto
1046 284 1364 284 conicto
1683 284 1865 541 conicto
2048 798 2048 1248 conicto
2048 1699 1865 1955 conicto
1683 2212 1364 2212 conicto
1046 2212 864 1955 conicto
682 1699 682 1248 conicto
end_ol grestore
gsave 6.557817 7.100000 translate 0.035278 -0.035278 scale
start_ol
1842 2133 moveto
1776 2174 1696 2193 conicto
1616 2212 1519 2212 conicto
1177 2212 993 1983 conicto
810 1755 810 1328 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2129 lineto
937 2347 1141 2453 conicto
1345 2560 1638 2560 conicto
1680 2560 1730 2554 conicto
1781 2548 1842 2536 conicto
1842 2133 lineto
end_ol grestore
gsave 6.790121 7.100000 translate 0.035278 -0.035278 scale
start_ol
2538 1329 moveto
2538 1124 lineto
682 1124 lineto
682 714 908 499 conicto
1134 284 1537 284 conicto
1772 284 1991 340 conicto
2211 396 2432 509 conicto
2432 128 lineto
2216 34 1988 -15 conicto
1760 -64 1526 -64 conicto
940 -64 598 284 conicto
256 633 256 1226 conicto
256 1839 582 2199 conicto
909 2560 1463 2560 conicto
1960 2560 2249 2229 conicto
2538 1898 2538 1329 conicto
2112 1472 moveto
2112 1809 1931 2010 conicto
1751 2212 1453 2212 conicto
1116 2212 914 2018 conicto
712 1824 682 1472 conicto
2112 1472 lineto
end_ol grestore
gsave 7.154187 7.100000 translate 0.035278 -0.035278 scale
start_ol
2021 2424 moveto
2021 2034 lineto
1818 2123 1638 2167 conicto
1459 2212 1267 2212 conicto
975 2212 828 2119 conicto
682 2026 682 1838 conicto
682 1696 784 1615 conicto
887 1535 1196 1461 conicto
1327 1430 lineto
1748 1337 1930 1166 conicto
2112 995 2112 690 conicto
2112 342 1839 139 conicto
1566 -64 1089 -64 conicto
891 -64 675 -25 conicto
460 14 222 94 conicto
222 519 lineto
481 402 692 343 conicto
903 284 1110 284 conicto
1387 284 1536 383 conicto
1686 482 1686 661 conicto
1686 829 1580 917 conicto
1475 1006 1118 1088 conicto
985 1121 lineto
620 1201 438 1367 conicto
256 1533 256 1823 conicto
256 2176 507 2368 conicto
758 2560 1219 2560 conicto
1448 2560 1649 2526 conicto
1851 2492 2021 2424 conicto
end_ol grestore
gsave 7.458988 7.100000 translate 0.035278 -0.035278 scale
start_ol
2021 2424 moveto
2021 2034 lineto
1818 2123 1638 2167 conicto
1459 2212 1267 2212 conicto
975 2212 828 2119 conicto
682 2026 682 1838 conicto
682 1696 784 1615 conicto
887 1535 1196 1461 conicto
1327 1430 lineto
1748 1337 1930 1166 conicto
2112 995 2112 690 conicto
2112 342 1839 139 conicto
1566 -64 1089 -64 conicto
891 -64 675 -25 conicto
460 14 222 94 conicto
222 519 lineto
481 402 692 343 conicto
903 284 1110 284 conicto
1387 284 1536 383 conicto
1686 482 1686 661 conicto
1686 829 1580 917 conicto
1475 1006 1118 1088 conicto
985 1121 lineto
620 1201 438 1367 conicto
256 1533 256 1823 conicto
256 2176 507 2368 conicto
758 2560 1219 2560 conicto
1448 2560 1649 2526 conicto
1851 2492 2021 2424 conicto
end_ol grestore
gsave 9.020000 7.095000 translate 0.035278 -0.035278 scale
start_ol
2880 3094 moveto
2880 2615 lineto
2656 2831 2402 2937 conicto
2149 3044 1864 3044 conicto
1301 3044 1002 2689 conicto
704 2334 704 1663 conicto
704 993 1002 638 conicto
1301 284 1864 284 conicto
2149 284 2402 390 conicto
2656 497 2880 713 conicto
2880 238 lineto
2649 87 2390 11 conicto
2132 -64 1845 -64 conicto
1106 -64 681 399 conicto
256 863 256 1664 conicto
256 2466 681 2929 conicto
1106 3392 1845 3392 conicto
2137 3392 2395 3317 conicto
2654 3243 2880 3094 conicto
end_ol grestore
gsave 9.434867 7.095000 translate 0.035278 -0.035278 scale
start_ol
1377 2212 moveto
1055 2212 868 1954 conicto
682 1696 682 1248 conicto
682 800 867 542 conicto
1053 284 1377 284 conicto
1697 284 1883 543 conicto
2070 802 2070 1248 conicto
2070 1692 1883 1952 conicto
1697 2212 1377 2212 conicto
1376 2560 moveto
1899 2560 2197 2212 conicto
2496 1864 2496 1248 conicto
2496 635 2197 285 conicto
1899 -64 1376 -64 conicto
851 -64 553 285 conicto
256 635 256 1248 conicto
256 1864 553 2212 conicto
851 2560 1376 2560 conicto
end_ol grestore
gsave 9.798933 7.095000 translate 0.035278 -0.035278 scale
start_ol
2339 2028 moveto
2493 2302 2705 2431 conicto
2918 2560 3204 2560 conicto
3591 2560 3800 2286 conicto
4010 2013 4010 1509 conicto
4010 0 lineto
3584 0 lineto
3584 1502 lineto
3584 1862 3460 2037 conicto
3336 2212 3082 2212 conicto
2771 2212 2590 1999 conicto
2410 1786 2410 1419 conicto
2410 0 lineto
1984 0 lineto
1984 1502 lineto
1984 1865 1860 2038 conicto
1736 2212 1477 2212 conicto
1171 2212 990 1998 conicto
810 1784 810 1419 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2120 lineto
947 2344 1141 2452 conicto
1335 2560 1602 2560 conicto
1871 2560 2060 2423 conicto
2249 2287 2339 2028 conicto
end_ol grestore
gsave 10.383133 7.095000 translate 0.035278 -0.035278 scale
start_ol
810 380 moveto
810 -960 lineto
384 -960 lineto
384 2496 lineto
810 2496 lineto
810 2116 lineto
937 2339 1131 2449 conicto
1325 2560 1595 2560 conicto
2042 2560 2322 2198 conicto
2602 1837 2602 1248 conicto
2602 659 2322 297 conicto
2043 -64 1595 -64 conicto
1325 -64 1131 45 conicto
938 155 810 380 conicto
2176 1248 moveto
2176 1699 1994 1955 conicto
1812 2212 1493 2212 conicto
1175 2212 992 1955 conicto
810 1699 810 1248 conicto
810 798 992 541 conicto
1175 284 1493 284 conicto
1812 284 1994 541 conicto
2176 798 2176 1248 conicto
end_ol grestore
gsave 10.755667 7.095000 translate 0.035278 -0.035278 scale
start_ol
1377 2212 moveto
1055 2212 868 1954 conicto
682 1696 682 1248 conicto
682 800 867 542 conicto
1053 284 1377 284 conicto
1697 284 1883 543 conicto
2070 802 2070 1248 conicto
2070 1692 1883 1952 conicto
1697 2212 1377 2212 conicto
1376 2560 moveto
1899 2560 2197 2212 conicto
2496 1864 2496 1248 conicto
2496 635 2197 285 conicto
1899 -64 1376 -64 conicto
851 -64 553 285 conicto
256 635 256 1248 conicto
256 1864 553 2212 conicto
851 2560 1376 2560 conicto
end_ol grestore
gsave 11.119733 7.095000 translate 0.035278 -0.035278 scale
start_ol
2474 1509 moveto
2474 0 lineto
2048 0 lineto
2048 1502 lineto
2048 1858 1913 2035 conicto
1778 2212 1509 2212 conicto
1185 2212 997 1999 conicto
810 1786 810 1419 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2120 lineto
954 2340 1152 2450 conicto
1350 2560 1609 2560 conicto
2037 2560 2255 2293 conicto
2474 2027 2474 1509 conicto
end_ol grestore
gsave 11.500733 7.095000 translate 0.035278 -0.035278 scale
start_ol
2538 1329 moveto
2538 1124 lineto
682 1124 lineto
682 714 908 499 conicto
1134 284 1537 284 conicto
1772 284 1991 340 conicto
2211 396 2432 509 conicto
2432 128 lineto
2216 34 1988 -15 conicto
1760 -64 1526 -64 conicto
940 -64 598 284 conicto
256 633 256 1226 conicto
256 1839 582 2199 conicto
909 2560 1463 2560 conicto
1960 2560 2249 2229 conicto
2538 1898 2538 1329 conicto
2112 1472 moveto
2112 1809 1931 2010 conicto
1751 2212 1453 2212 conicto
1116 2212 914 2018 conicto
712 1824 682 1472 conicto
2112 1472 lineto
end_ol grestore
gsave 11.864800 7.095000 translate 0.035278 -0.035278 scale
start_ol
2474 1509 moveto
2474 0 lineto
2048 0 lineto
2048 1502 lineto
2048 1858 1913 2035 conicto
1778 2212 1509 2212 conicto
1185 2212 997 1999 conicto
810 1786 810 1419 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2120 lineto
954 2340 1152 2450 conicto
1350 2560 1609 2560 conicto
2037 2560 2255 2293 conicto
2474 2027 2474 1509 conicto
end_ol grestore
gsave 12.245800 7.095000 translate 0.035278 -0.035278 scale
start_ol
832 3213 moveto
832 2524 lineto
1664 2524 lineto
1664 2176 lineto
832 2176 lineto
832 826 lineto
832 521 914 434 conicto
997 348 1249 348 conicto
1664 348 lineto
1664 0 lineto
1242 0 lineto
768 0 587 179 conicto
406 359 406 826 conicto
406 2176 lineto
128 2176 lineto
128 2524 lineto
406 2524 lineto
406 3213 lineto
832 3213 lineto
end_ol grestore
gsave 13.945000 6.995000 translate 0.035278 -0.035278 scale
start_ol
448 3328 moveto
2313 3328 lineto
2313 2980 lineto
874 2980 lineto
874 1948 lineto
2173 1948 lineto
2173 1600 lineto
874 1600 lineto
874 27 lineto
448 27 lineto
448 3328 lineto
end_ol grestore
gsave 14.239614 6.995000 translate 0.035278 -0.035278 scale
start_ol
1842 2133 moveto
1776 2174 1696 2193 conicto
1616 2212 1519 2212 conicto
1177 2212 993 1983 conicto
810 1755 810 1328 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2129 lineto
937 2347 1141 2453 conicto
1345 2560 1638 2560 conicto
1680 2560 1730 2554 conicto
1781 2548 1842 2536 conicto
1842 2133 lineto
end_ol grestore
gsave 14.485147 6.995000 translate 0.035278 -0.035278 scale
start_ol
1528 1252 moveto
1050 1252 866 1139 conicto
682 1026 682 754 conicto
682 538 820 411 conicto
958 284 1196 284 conicto
1523 284 1721 523 conicto
1920 763 1920 1161 conicto
1920 1252 lineto
1528 1252 lineto
2346 1426 moveto
2346 0 lineto
1920 0 lineto
1920 383 lineto
1785 154 1579 45 conicto
1374 -64 1076 -64 conicto
701 -64 478 154 conicto
256 373 256 739 conicto
256 1166 543 1383 conicto
830 1600 1367 1600 conicto
1920 1600 lineto
1920 1639 lineto
1920 1913 1740 2062 conicto
1561 2212 1238 2212 conicto
1032 2212 836 2162 conicto
641 2113 448 2014 conicto
448 2386 lineto
670 2473 879 2516 conicto
1088 2560 1285 2560 conicto
1819 2560 2082 2279 conicto
2346 1998 2346 1426 conicto
end_ol grestore
gsave 14.849214 6.995000 translate 0.035278 -0.035278 scale
start_ol
2339 2028 moveto
2493 2302 2705 2431 conicto
2918 2560 3204 2560 conicto
3591 2560 3800 2286 conicto
4010 2013 4010 1509 conicto
4010 0 lineto
3584 0 lineto
3584 1502 lineto
3584 1862 3460 2037 conicto
3336 2212 3082 2212 conicto
2771 2212 2590 1999 conicto
2410 1786 2410 1419 conicto
2410 0 lineto
1984 0 lineto
1984 1502 lineto
1984 1865 1860 2038 conicto
1736 2212 1477 2212 conicto
1171 2212 990 1998 conicto
810 1784 810 1419 conicto
810 0 lineto
384 0 lineto
384 2496 lineto
810 2496 lineto
810 2120 lineto
947 2344 1141 2452 conicto
1335 2560 1602 2560 conicto
1871 2560 2060 2423 conicto
2249 2287 2339 2028 conicto
end_ol grestore
gsave 15.433414 6.995000 translate 0.035278 -0.035278 scale
start_ol
2538 1329 moveto
2538 1124 lineto
682 1124 lineto
682 714 908 499 conicto
1134 284 1537 284 conicto
1772 284 1991 340 conicto
2211 396 2432 509 conicto
2432 128 lineto
2216 34 1988 -15 conicto
1760 -64 1526 -64 conicto
940 -64 598 284 conicto
256 633 256 1226 conicto
256 1839 582 2199 conicto
909 2560 1463 2560 conicto
1960 2560 2249 2229 conicto
2538 1898 2538 1329 conicto
2112 1472 moveto
2112 1809 1931 2010 conicto
1751 2212 1453 2212 conicto
1116 2212 914 2018 conicto
712 1824 682 1472 conicto
2112 1472 lineto
end_ol grestore
showpage
openair2/DOCS/TEMPLATES/CODE/images/arch.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.8 KiB

openair2/DOCS/TEMPLATES/README/Readme.doxy
+112
View File
@@ -0,0 +1,112 @@
/*******************************************************************************
OPENAIRINTERFACE 0/1/2/3
Copyright(c) 1999 - 2010 EURECOM
This program is free software; you can redistribute it and/or modify it
under the terms and conditions of the GNU General Public License,
version 2, as published by the Free Software Foundation.
This program is distributed in the hope it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
The full GNU General Public License is included in this distribution in
the file called "COPYING".
Contact Information:
Openair Admin <openair_admin@eurecom.fr>
Mailing List <openair_tech@eurecom.fr>
Forums http://forums.eurecom.fr/openairinterface
Eurecom, 2229, route des cretes, 06560 Valbonne Sophia Antipolis, France
*******************************************************************************/
/*! \file Readme.doxy
* \brief explain how this block is organized, and how it works
* \author Navid Nikaein
* \date 2009
* \version 0.1
* \company Eurecom
* \note This conde is under GNU GENERAL PUBLIC LICENSE, version 2, June 1991
* \email: navid.nikaein@eurecom.fr
* \warning
*/
/*! \mainpage Table of contents
The content of this readme is the following:
-# What is this block about in OpenAirInterface
-# Folders and files description
-# Organization of the folders and their dependancies
-# Makefile targets and how to build
-# How to use through a tutorial: run a simple experimentation
\section _block What is this block about in OpenAirInterface ?
It essentially means "the hardware part" located at openair0.
Explain through the figures:
\image html image.png "caption" width=3cm
\image latex image.pdf "caption"
More information about ??? can be found on the Twiki:
https://twiki.eurecom.fr/twiki/bin/view/OpenAirInterface/WebHome
\section _folders Folders and files description
The structure is the following:
<table>
<tr><td>File/Folder</td> <td> Description </td> </tr>
</table>
- Folder1: Contains this and that
- Folder2: Contains this and that
- init.bash: A simple script file, that any user SHOULD source from its environment personal set-up script (this is typically ~/.bashrc) by adding the following lines to it:
This is my ~/.bashrc file or equivalent export OPENAIRX=path/to/my/openairX/folder source $OPENAIRX/init.bash. The file includes variable definitions & path settings to access softwares, sources & Makefiles, software distribution in openair, and so on.
YOU DEFINETELY NEED TO SOURCE THIS FILE. Description
\section _organization Organization of the folders and their dependancies
The 3 folders have the following structures
- Folder1/subfolder1/: contains any ressource related to the design
- Folder2/subfolder2/: contains
- Folder2/src/
- Folder2/lib/
- Folder2/bin/
Explain where are the source files.
Explain the relationship with other Blocks.
\section _makefile Makefile targets and how to build
Explain whether you are using symbolic links or not,
how to backup/archive
how to generate the tags
how to print the vars
how to create the documentation
\section _howto How to use through a tutorial: run a simple experimentation
...
*/
openair2/DOCS/TEMPLATES/README/readme.txt
+120
View File
@@ -0,0 +1,120 @@
/*******************************************************************************
OPENAIRINTERFACE 0/1/2/3
Copyright(c) 1999 - 2010 EURECOM
This program is free software; you can redistribute it and/or modify it
under the terms and conditions of the GNU General Public License,
version 2, as published by the Free Software Foundation.
This program is distributed in the hope it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
The full GNU General Public License is included in this distribution in
the file called "COPYING".
Contact Information:
Openair Admin <openair_admin@eurecom.fr>
Mailing List <openair_tech@eurecom.fr>
Forums http://forums.eurecom.fr/openairinterface
Eurecom, 2229, route des cretes, 06560 Valbonne Sophia Antipolis, France
*******************************************************************************/
/*________________________OEPNAIR/OPENAIR0/________________________
File : Readme.txt
Authors : navid nikaein
Company : EURECOM
Emails : navid.nikaein@eurecom.fr
________________________________________________________________*/
-------------------------
Table of contents
-------------------------
The content of this readme is the following:
1) What is this block about in OpenAirInterface
2) Folders and files description
3) Organization of the folders and their dependancies
4) Makefile targets and how to build
5) How to use through a tutorial: run a simple experimentation
------------------------------------------------
1) What is this block about in OpenAirInterface ?
-----------------------------------------------
It essentially means "the hardware part" located at openair0.
More information about ??? can be found on the Twiki:
https://twiki.eurecom.fr/twiki/bin/view/OpenAirInterface/WebHome
-----------------------------------------
2) Folders and files description
-----------------------------------------
File/Folder Description
----------- -----------
- Folder1/ contains
- Folder2/ contains
- init.bash A simple script file, that any user SHOULD source from
its environment personal set-up script (this is typically ~/.bashrc)
by adding the following lines to it:
# This is my ~/.bashrc file or equivalent
export OPENAIRX=path/to/my/openairX/folder
source $OPENAIRX/init.bash
The file includes variable definitions & path settings to
access softwares, sources & Makefiles, software
distribution in openair, and so on.
YOU DEFINETELY NEED TO SOURCE THIS FILE.
----------------------------------------------------
3) Organization of the folders and their dependancies
----------------------------------------------------
The 3 folders have the following structures
- Folder1/subfolder1/ contains any ressource related to the design
- Folder2/subfolder2/ contains
- Folder2/src/
- Folder2/lib/
- Folder2/bin/
Explain where are the source files.
Explain the relationship with other Blocks.
-----------------------------------------
4) Makefile targets and how to build
-----------------------------------------
Explain whether you are using symbolic links or not,
how to backup/archive
how to generate the tags
how to print the vars
how to create the documentation
----------------------------------------------------------------
6) How to use through a tutorial: run a simple experimentation
----------------------------------------------------------------
...