From 3af13f4f2ea055145d9c8eca0ea75a5786c7ae27 Mon Sep 17 00:00:00 2001 From: Pedro Alvarez Date: Thu, 18 Jan 2018 13:53:53 +0000 Subject: [PATCH] Removing docs for now. Information is too basic. --- srsepc/docs/.gitignore | 1 - srsepc/docs/Makefile | 216 --- srsepc/docs/README | 7 - srsepc/docs/source/_imgs/epc-auth-plane.svg | 289 --- .../docs/source/_imgs/epc-control-plane.svg | 598 ------ srsepc/docs/source/_imgs/epc-overall.svg | 381 ---- srsepc/docs/source/_imgs/epc-uml.svg | 1612 ----------------- srsepc/docs/source/_imgs/epc-user-plane.svg | 388 ---- srsepc/docs/source/_static/.gitignore | 0 srsepc/docs/source/_templates/.gitignore | 0 srsepc/docs/source/conf.py | 283 --- srsepc/docs/source/epc_design.rst | 30 - srsepc/docs/source/epc_overview.rst | 225 --- srsepc/docs/source/epc_usage.rst | 2 - srsepc/docs/source/index.rst | 18 - 15 files changed, 4050 deletions(-) delete mode 100644 srsepc/docs/.gitignore delete mode 100644 srsepc/docs/Makefile delete mode 100644 srsepc/docs/README delete mode 100644 srsepc/docs/source/_imgs/epc-auth-plane.svg delete mode 100644 srsepc/docs/source/_imgs/epc-control-plane.svg delete mode 100644 srsepc/docs/source/_imgs/epc-overall.svg delete mode 100644 srsepc/docs/source/_imgs/epc-uml.svg delete mode 100644 srsepc/docs/source/_imgs/epc-user-plane.svg delete mode 100644 srsepc/docs/source/_static/.gitignore delete mode 100644 srsepc/docs/source/_templates/.gitignore delete mode 100644 srsepc/docs/source/conf.py delete mode 100644 srsepc/docs/source/epc_design.rst delete mode 100644 srsepc/docs/source/epc_overview.rst delete mode 100644 srsepc/docs/source/epc_usage.rst delete mode 100644 srsepc/docs/source/index.rst diff --git a/srsepc/docs/.gitignore b/srsepc/docs/.gitignore deleted file mode 100644 index a007feab0..000000000 --- a/srsepc/docs/.gitignore +++ /dev/null @@ -1 +0,0 @@ -build/* diff --git a/srsepc/docs/Makefile b/srsepc/docs/Makefile deleted file mode 100644 index 5dfc21fa8..000000000 --- a/srsepc/docs/Makefile +++ /dev/null @@ -1,216 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/srsEPC.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/srsEPC.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/srsEPC" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/srsEPC" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/srsepc/docs/README b/srsepc/docs/README deleted file mode 100644 index 7fc58da70..000000000 --- a/srsepc/docs/README +++ /dev/null @@ -1,7 +0,0 @@ -# srsepc-docs -The docs of srsEPC require sphinx, and the sphinx-seqdiag and sphinx-blockdiag extensions. - -On Ubuntu, you can do: -sudo apt install python-sphinx python-sphinxcontrib.seqdiag python-sphinxcontrib.blockdiag - -To make the documentation do 'make html' on the main ./docs folder diff --git a/srsepc/docs/source/_imgs/epc-auth-plane.svg b/srsepc/docs/source/_imgs/epc-auth-plane.svg deleted file mode 100644 index af6426710..000000000 --- a/srsepc/docs/source/_imgs/epc-auth-plane.svg +++ /dev/null @@ -1,289 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - MME - S6a - - HSS - - - - Diameter - - SCTP - - IP - - L2/L1 - - - - - - - Diameter - - SCTP - - IP - - L2/L1 - - - - - diff --git a/srsepc/docs/source/_imgs/epc-control-plane.svg b/srsepc/docs/source/_imgs/epc-control-plane.svg deleted file mode 100644 index 3e84c8a6c..000000000 --- a/srsepc/docs/source/_imgs/epc-control-plane.svg +++ /dev/null @@ -1,598 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - S1-MME - - - S1-APP - - SCTP - - IP - - L2/L1 - - - - S1-APP - - SCTP - - IP - - L2/L1 - - - - eNB - MME - S11 - - - GTP-C - - UDP - - IP - - L2/L1 - - - S-GW - - - - GTP-C - - UDP - - IP - - L2/L1 - - S5/S8 - - - GTP-C - - UDP - - IP - - L2/L1 - - - P-GW - - - - diff --git a/srsepc/docs/source/_imgs/epc-overall.svg b/srsepc/docs/source/_imgs/epc-overall.svg deleted file mode 100644 index 68f037fe7..000000000 --- a/srsepc/docs/source/_imgs/epc-overall.svg +++ /dev/null @@ -1,381 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - LTE - - - - - - - - HSS - - - - P-GW - - - - MME - - - eNB - - - UE - - - - - - - S5/S8 - S1-U - S1-MME - - S6a - S11 - - diff --git a/srsepc/docs/source/_imgs/epc-uml.svg b/srsepc/docs/source/_imgs/epc-uml.svg deleted file mode 100644 index 75aa8aaf0..000000000 --- a/srsepc/docs/source/_imgs/epc-uml.svg +++ /dev/null @@ -1,1612 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/srsepc/docs/source/_imgs/epc-user-plane.svg b/srsepc/docs/source/_imgs/epc-user-plane.svg deleted file mode 100644 index 23d4519ef..000000000 --- a/srsepc/docs/source/_imgs/epc-user-plane.svg +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - - - - image/svg+xml - - - - - - - S1-U - - - GTP-U - - UDP - - IP - - L2/L1 - - - - GTP-U - - UDP - - IP - - L2/L1 - - - - eNB - S-GW - S5/S8 - - - GTP-U - - UDP - - IP - - L2/L1 - - - P-GW - - - diff --git a/srsepc/docs/source/_static/.gitignore b/srsepc/docs/source/_static/.gitignore deleted file mode 100644 index e69de29bb..000000000 diff --git a/srsepc/docs/source/_templates/.gitignore b/srsepc/docs/source/_templates/.gitignore deleted file mode 100644 index e69de29bb..000000000 diff --git a/srsepc/docs/source/conf.py b/srsepc/docs/source/conf.py deleted file mode 100644 index 1855f653f..000000000 --- a/srsepc/docs/source/conf.py +++ /dev/null @@ -1,283 +0,0 @@ -# -*- coding: utf-8 -*- -# -# srsEPC documentation build configuration file, created by -# sphinx-quickstart on Mon Oct 2 14:30:47 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinxcontrib.seqdiag','sphinxcontrib.blockdiag'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'srsEPC' -copyright = u'2017, Pedro Alvarez' -author = u'Pedro Alvarez' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'2.0.0' -# The full version, including alpha/beta/rc tags. -release = u'2.0.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = {"nosidebar": "true"} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'srsEPCdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'srsEPC.tex', u'srsEPC Documentation', - u'Pedro Alvarez', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'srsepc', u'srsEPC Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'srsEPC', u'srsEPC Documentation', - author, 'srsEPC', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False diff --git a/srsepc/docs/source/epc_design.rst b/srsepc/docs/source/epc_design.rst deleted file mode 100644 index 17861938f..000000000 --- a/srsepc/docs/source/epc_design.rst +++ /dev/null @@ -1,30 +0,0 @@ -EPC Design -========== - -Code Structure -************** - -The LTE library should include the following functionality that will be common accress multiple nodes. - -.. _epc-overall: - -.. figure:: _imgs/epc-uml.svg - - EPC overall class architecture - - - - -MME Design -********** - -The srsMME must maintain three EPC interfaces, the S1-MME, the S11 and the S6a interfaces. The S1-MME will use an SCTP (many-to-one) socket and the S11 will use the GTP-Cv2 protocol over UDP. The S6a will be implmented as a Diameter application over UDP. - -The main loop of the MME will - -HSS Design -********** - -SP-GW Design -*********** - diff --git a/srsepc/docs/source/epc_overview.rst b/srsepc/docs/source/epc_overview.rst deleted file mode 100644 index 40309eee5..000000000 --- a/srsepc/docs/source/epc_overview.rst +++ /dev/null @@ -1,225 +0,0 @@ -EPC Overview -============ - -The Evolved Packet Core (EPC) refers to the elements of an LTE network that make up the core of the network. The main functionality of these elements is to provide data conectivity, mobility and user authentification. - -:ref:`epc-overall` illustrates the main components and their interfaces in the EPC. - -.. _epc-overall: - -.. figure:: _imgs/epc-overall.svg - - EPC overall architecture - -* *HSS*: The Home Subscriber Service (HSS) is the user database. It stores information such as the user's id, key, usage limits, etc. It is responsible for authenticating an authorizing the user's access to the network. - -* *MME*: Mobility Managment Entity (MME) is the main control element in the network. It handles mobility and attach control messages. It is also responsible for paging UEs in idle mode. - -* *S-GW*: The S-GW is the main dataplane gateway for the users, as it provides the mobility anchor for the UEs. It works as an IP router and helps setting up GTP sessions between the eNB and the P-GW. - -* *P-GW*: The Packet Gateway (P-GW) is the point of contact with external networks. It enforces the QoS parameters for subscriber sessions. - -EPC User and Control Plane -************************** - -In this subsection, we will breifly describe the EPC's user and control plane. The user plane, uses the GPRS Tunneling Protocol to estabilish tunnels between the P-GW and the eNB. The GTP is a IP-over-IP protocol, that encapsulates user packets in another IP packet plus a label to provide mobility. To see a more detailed description of GTP, go to :ref:`gtp-section`. - -These user plane tunnels are set up between the eNB, the S-GW and the P-GW over the S1-U and S5/S8 interfaces. The full protocol stack is illustrated in :ref:`epc-user-plane`. - -.. _epc-user-plane: - -.. figure:: _imgs/epc-user-plane.svg - - EPC User Plane (S1-U and S5/S8) - -To establish these user tunnels, the GTP-Cv2 protocol and the S1-APP protocol are used. These protocols provide the interfaces between the eNB, the MME, the S-PGW and the P-GW. The full protocol stack can be seen in :ref:`epc-control-plane`. The details of the GTP-Cv2 and S1-APP can be seen in :ref:`gtp-section` and :ref:`s1app-section`, respectively. - -.. _epc-control-plane: - -.. figure:: _imgs/epc-control-plane.svg - - EPC Control Plane (S1-MME, S11 and S5/S8) - -Finally, to authenticate the user and authorize him or her, the MME comunicates with the HSS over the S6a interface. This interface will run the Diameter protocol the exchange user authentification and authorization information, as seen in :ref:`epc-auth-plane`. More details on :ref:`diameter-section` - -.. _epc-auth-plane: - -.. figure:: _imgs/epc-auth-plane.svg - - EPC Authentication Plane (S6a) - -Procedures -********** - -In this section we will generally describe the most relevant procedures and their implementation status. This will be more of an higher layer view, as the details of each message passed will be elaborated on the :ref:`s1app-section`, :ref:`gtp-section` and :ref:`diameter-section` sections. - -UE Attach proceedure -++++++++++++++++++++ - -The UE attach procedure is one of the first and most crucial steps for the UE to get connectivity. For this reason, this is the first procedure to be described. This can be broken down to multiple procedures and you can see bellow - -.. seqdiag:: - - seqdiag { - - === Random Access Procedure === - UE <- eNB [label = "MIB"] - UE <- eNB [label = "SIB1"] - UE <- eNB [label = "SIB2"] - UE -> eNB [label = "Random Access Preamble"]; - UE <- eNB [label = "Random Access Response [Tmp C-RNTI]"]; - UE -> eNB [label = "RRC Connection Request [Tmp C-RNTI]"]; - UE <- eNB [label = "RRC Connection Setup [C-RNTI]"]; - UE -> eNB [label = "RRC Connection Completed [Attach Request (IMSI), PDN Connection Request]"]; - === User Authentication Procedure === - eNB -> MME [label = "Initial UE Msg [Attach Request, PDN Connection Request]"]; - MME -> HSS [label = "Auth Info Request (IMSI)"]; - MME <- HSS [label = "Auth Info Answer (Kasme, AUTN, RAND, XRES)"] - eNB <- MME [label = "DL NAS Xport [Authn Request]"]; - UE <- eNB [label = "DL Info Xfer [Auth Request (AUTN, RAND)]"]; - UE -> eNB [label = "Auth Response (RES)"]; - eNB -> MME [label = "Auth Response (RES)", note = "MME compares RES with XRES"]; - === NAS Security Setup Procedure === - eNB <- MME [label = "DL NAS Xport [Security Mode Command]"]; - UE <- eNB [label = "DL Info Xfer [Security Mode Command]"]; - UE -> eNB [label = "Security Mode Complete"] - eNB -> MME [label = "SMC Completed"] - === Authorization === - MME -> HSS [label = "Location Update Request (IMSI)"] - MME <- HSS [label = "Location Update Response (Subscription Data)"] - === GTP Tunnel setup === - MME -> SGW [label = "Create Session Request (IMSI, TEID, PGW IP)"] - SGW -> PGW [label = "Create Session Request (IMSI, TEID)"] - SGW <- PGW [label = "Create Session Response (TEIDs)", note = "S5 GTP Tunnel created"] - MME <- SGW [label = "Create Session Response (TEIDs)"] - eNB <- MME [label = "Initial Context Setup Request (UE Context Info, TEID)", note="NAS Attach Accept, NAS Activate default bearer"] - UE <- eNB [label = "RRC Security Mode Command (AS Algorithm)"] - UE -> eNB [label = "RRC Security Mode Complete"] - //UE <-> eNB [label = "UE Radio Capabilities"] - UE <- eNB [label = "RRC Connection Reconfiguration", note = "NAS Attach Accept, NAS Activate Default Bearer"] - UE -> eNB [label = "RRC Reconfiguration Complete"] - eNB -> MME [label = "Initial Context Setup Complete (S1U TIED)"] - UE -> eNB [label = "Uplink Information Transfer [NAS Attach Complete, NAS Activate default bearer accept]"] - eNB -> MME [label = "Uplink NAS Xport [NAS Attach Complete, NAS Activate default bearer accept]"] - MME -> SGW [label = "Modify bearer request (S1-U TEID)"] - MME <- SGW [label = "Modify bearer response"] - === Networking Setup === - } - -.. _gtp-section: - -GPRS Tunneling Protocol -*********************** - -The GPRS Tunneling Protocol (GTP) main objective is to tunnel IP packets to the UE, allowing him to keep his IP even when the user is mobile. -It is composed of two parts, the user plane and the control plane. - -Transport Layer -+++++++++++++++ - -Both GTP-C and GTP-U use UDP for the transport layer. The specific port for GTP-C TX and RX is 2123. For GTP-U packets must have a destination port of 2152, but can use any source port. - -Setting up TEIDs -++++++++++++++++ - -In this section we will describe the setup of GTP tunnels, both between the S-GW and P-GW and between the S-GW and the eNB. -We will start with the setup of the of GTP tunnels between the S-GW and the P-GW for simplicity. - -Initially, the S-GW sends a message to TEID 0 (the butler tunnel) saying that it wants to set up a GTP-U tunnel. This should include the IMSI of the user, the IP address of the S-GW, control plane TEID_sgw_d, user plane TEID_sgw_d, - -The P-GW replies with the with the Create Session Response message, that contains the control TEID_pgw_u that the P-GW allocated for signaling messages for that UE. It will also send the P-GWs IP address and user TEID_pgw_u for uplink user traffic. After this, the TEID tunnels are set up between the S-GW and the P-GW. - -For the set up of GTP-U tunnels between the eNB and the S-GW the process is similar, but the S1-MME (which uses S1-APP instead of GTP-C) must be used. This procedure is initiated by the MME requesting a GTP-U tunnel on behalf of the eNB, by sending a Create Session Request to the S-GW. The S-GW will create a tunnel between himself and the P-GW and after that it will reply to the MME. The MME will finally relay the information of the IP of the S-GW and the TEIDs to the eNB in the Initial Context Setup Request message. - -The whole process is illustrated below: - -.. seqdiag:: - - seqdiag { - activation = none; - MME -> S-GW [label = "Create Session Request"]; - S-GW -> P-GW [label = "Create Session Request"] - S-GW <- P-GW [label = "Create Session Response"]; - MME <- S-GW [label = "Create Session Response"]; - eNB <- MME [label = "Initial Context Setup"]; - } - - - -.. _s1app-section: - -S1-APP -****** - -In this section, we will describe the S1-APP protocol. The S1-APP will run over SCTP and the eNB will initiate the assotiation using the destination port 36412. - -This protocol involved in of multiple procedures, such as S1-MME Setup, UE attach, paging etc. -As this protocol is quite large, we will focus on the procedures we consider most relevant. - -The following sub-sections describe these procedures and give some small indication of their implementation status: - -* :ref:`s1-setup` -* :ref:`erab-setup-request` - -.. _s1-setup: - -S1 Setup -++++++++++ - -This is the first procedure between the eNB and the MME, started once the transport layer is active, to setup the S1-MME connection. -After this procedure takes place, both nodes will store the information exchanged. If the information is already present, it is erased and updated with the most recent information exchanged. - -In this procedure, the following information is sent to the MME from the eNB: - -* *eNB Id* (M): This field will be the global eNB Id; -* *eNB Name* (O): This field will include the human readable name of the eNB; -* *Supported TA* (M): This field will include the -* *Default Paging DRX* (M): This message -* *CSG List Ids* (O): This - -In the case of success, the MME will reply the following: - -* *MME Name* (O): This message will include the human readable name of the MME; -* *Served GUMMEI* (M): This field will contain the Globally Unique MME Id. This is composed by the MCC, MNC, MME Group Id and MME code. -* *Relative MME Capacity* (M): This message will contain a weight factor for MME load balancing purposes -* *Criticality Diagnosis* (O): This field indicates if some IE were not understood by the MME or missing - -In the case of failure, the MME will reply the following: - -* *Cause Id* (M): This message will what was the cause for the setup failure; -* *Time to wait* (O): This will indicate the eNB to wait at least the indicated amount of time before restarting the S1 Setup -* *Criticality Diagnosis* (O): This field indicates if some IE were not understood by the MME or missing - -You can see the message diagram for both the success and failure case below: - -.. _success-s1-setup: - -.. seqdiag:: - - seqdiag { - activation = none; - eNB -> MME [label = "S1 Setup Request"]; - eNB <- MME [label = "S1 Setup Response"]; - } - -.. _fail-s1-setup: - -.. seqdiag:: - - seqdiag { - activation = none; - eNB -> MME [label = "S1 Setup Request"] - eNB <- MME [label = "S1 Setup Failure"] - } - - -.. _erab-setup-request: - -E-RAB Setup Request -+++++++++++++++++++ - -.. _diameter-section: - -Diameter -******** - diff --git a/srsepc/docs/source/epc_usage.rst b/srsepc/docs/source/epc_usage.rst deleted file mode 100644 index e98ac2cfa..000000000 --- a/srsepc/docs/source/epc_usage.rst +++ /dev/null @@ -1,2 +0,0 @@ -EPC Usage -********* diff --git a/srsepc/docs/source/index.rst b/srsepc/docs/source/index.rst deleted file mode 100644 index 4cacb24ed..000000000 --- a/srsepc/docs/source/index.rst +++ /dev/null @@ -1,18 +0,0 @@ - -.. srsEPC documentation master file, created by - sphinx-quickstart on Mon Oct 2 14:30:47 2017. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to srsEPC's documentation! -================================== - - -.. toctree:: - :maxdepth: 2 - - epc_overview.rst - epc_design.rst - epc_usage.rst - -