diff --git a/doc/FEATURE_SET.md b/doc/FEATURE_SET.md new file mode 100644 index 0000000000..f5f6de8b4f --- /dev/null +++ b/doc/FEATURE_SET.md @@ -0,0 +1,242 @@ +**Table of Contents** + +1. [OpenAirInterface eNB Feature Set](#openairinterface-enb-feature-set) + 1. [eNB PHY Layer](#enb-phy-layer) + 2. [eNB MAC Layer](#enb-mac-layer) + 3. [eNB RLC Layer](#enb-rlc-layer) + 4. [eNB PDCP Layer](#enb-pdcp-layer) + 5. [eNB RRC Layer](#enb-rrc-layer) + 6. [eNB X2AP](#enb-x2ap) + 7. [eNB Advanced Features](#enb-advanced-features) +2. [OpenAirInterface UE Feature Set](#openairinterface-ue-feature-set) + 1. [LTE UE PHY Layer](#lte-ue-phy-layer) + 2. [LTE UE MAC Layer](#lte-ue-mac-layer) + 3. [LTE UE RLC Layer](#lte-ue-rlc-layer) + 4. [LTE UE PDCP Layer](#lte-ue-pdcp-layer) + 5. [LTE UE RRC Layer](#lte-ue-rrc-layer) +3. [OpenAirInterface Functional Split](#openairinterface-functional-split) +4. [OpenAirInterface 5G-NR Feature Set](#openairinterface-5g-nr-feature-set) + 1. [General Parameters](#general-parameters) + 2. [gNB Features](#gnb-features) + 1. [gNB Physical Layer](#gnb-phy-layer) + 2. [gNB Higher Layers](#gnb-higher-layers) + 3. [NR UE Features](#nr-ue-features) + 1. [NR UE Physical Layer](#nr-ue-phy-layer) + 2. [NR UE Higher Layers](#nr-ue-higher-layers) + +# OpenAirInterface Block diagram # + +![Block Diagram](./oai_enb_block_diagram.png) + +# OpenAirInterface eNB Feature Set # + +## eNB PHY Layer ## + +The Physical layer implements **3GPP 36.211**, **36.212**, **36.213** and provides the following features: + +- LTE release 8.6 compliant, and implements a subset of release 10 +- FDD and TDD configurations: 1 (experimental) and 3 +- Bandwidth: 5, 10, and 20 MHz +- Transmission modes: 1, 2 (stable), 3, 4, 5, 6, 7 (experimental) +- Max number of antennas: 2 +- CQI/PMI reporting: aperiodic, feedback mode 3 - 0 and 3 - 1 +- PRACH preamble format 0 +- All downlink (DL) channels are supported: PSS, SSS, PBCH, PCFICH, PHICH, PDCCH, PDSCH, PMCH +- All uplink (UL) channels are supported: PRACH, PUSCH, PUCCH (format 1/1a/1b), SRS, DRS +- HARQ support (UL and DL) +- Highly optimized base band processing (including turbo decoder) + +### Performances ### + +**Transmission Mode, Bandwidth** | **Expected Throughput** | **Measured Throughput** | **Measurement Conditions** +-------------------------------- | ----------------------- | ------------------------| ----------------: +FDD DL: 5 MHz, 25 PRBS/ MCS 28 | 16 - 17 Mbit/s | TM1: 17.0 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +FDD DL: 10 MHz, 50 PRBS/ MCS 28 | 34 - 35 Mbit/s | TM1: 32.8 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +FDD DL: 20 MHz, 100 PRBS/ MCS 28 | 70 Mbit/s | TM1: 69.9 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) + | | | +FDD UL: 5 MHz, 25 PRBS/ MCS 20 | 9 Mbit/s | TM1: 8.28 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +FDD UL: 10 MHz, 50 PRBS/ MCS 20 | 17 Mbit/s | TM1: 15.2 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +FDD UL: 20 MHz, 100 PRBS/ MCS 20 | 35 Mbit/s | TM1: 18.6 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) + | | +TDD DL: 5 MHz, 25 PRBS/ MCS **XX** | **TBC** Mbit/s | 3.33 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +TDD DL: 10 MHz, 50 PRBS/ MCS **XX** | **TBC** Mbit/s | 8.90 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +TDD DL: 20 MHz, 100 PRBS/ MCS **XX** | **TBC** Mbit/s | N/A | COTS-UE Cat 4 (150/50 Mbps) + | | | +TDD UL: 5 MHz, 25 PRBS/ MCS **XX** | **TBC** Mbit/s | 1.66 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +TDD UL: 10 MHz, 50 PRBS/ MCS **XX** | **TBC** Mbit/s | 1.89 Mbits/s | COTS-UE Cat 4 (150/50 Mbps) +TDD UL: 20 MHz, 100 PRBS/ MCS **XX** | **TBC** Mbit/s | N/A | COTS-UE Cat 4 (150/50 Mbps) + +- Number of supported UEs: **To Be Completed** + +## eNB MAC Layer ## + +The MAC layer implements a subset of the **3GPP 36.321** release v8.6 in support of BCH, DLSCH, RACH, and ULSCH channels. + +- RRC interface for CCCH, DCCH, and DTCH +- Proportional fair scheduler (round robin scheduler soon) +- DCI generation +- HARQ Support +- RA procedures and RNTI management +- RLC interface (AM, UM) +- UL power control +- Link adaptation + +## eNB RLC Layer ## + +The RLC layer implements a full specification of the 3GPP 36.322 release v9.3. + +- RLC TM (mainly used for BCCH and CCCH) + * Neither segment nor concatenate RLC SDUs + * Do not include a RLC header in the RLC PDU + * Delivery of received RLC PDUs to upper layers +- RLC UM (mainly used for DTCH) + * Segment or concatenate RLC SDUs according to the TB size selected by MAC + * Include a RLC header in the RLC PDU + * Duplication detection + * PDU reordering and reassembly +- RLC AM, compatible with 9.3 + * Segmentation, re-segmentation, concatenation, and reassembly + * Padding + * Data transfer to the user + * RLC PDU retransmission in support of error control and correction + * Generation of data/control PDUs + +## eNB PDCP Layer ## + +The current PDCP layer is header compliant with **3GPP 36.323** Rel 10.1.0 and implements the following functions: + +- User and control data transfer +- Sequence number management +- RB association with PDCP entity +- PDCP entity association with one or two RLC entities +- Integrity check and encryption using the AES and Snow3G algorithms + +## eNB RRC Layer ## + +The RRC layer is based on **3GPP 36.331** v14.3.0 and implements the following functions: + +- System Information broadcast (SIB 1, 2, 3, and 13) + * SIB1: Up to 6 PLMN IDs broadcast +- RRC connection establishment +- RRC connection reconfiguration (addition and removal of radio bearers, connection release) +- RRC connection release +- RRC connection re-establishment +- Inter-frequency measurement collection and reporting (experimental) +- eMBMS for multicast and broadcast (experimental) +- Handover (experimental) +- Paging (soon) + +## eNB X2AP ## + +The X2AP layer is based on **3GPP 36.423** v14.6.0 and implements the following functions: + + - X2 Setup Request + - X2 Setup Response + +## eNB Advanced Features ## + +**To be completed** + +# OpenAirInterface UE Feature Set # + +## LTE UE PHY Layer ## + +The Physical layer implements **3GPP 36.211**, **36.212**, **36.213** and provides the following features: + +- LTE release 8.6 compliant, and implements a subset of release 10 +- FDD and TDD configurations: 1 (experimental) and 3 +- Bandwidth: 5, 10, and 20 MHz +- Transmission modes: 1, 2 (stable) +- Max number of antennas: 2 +- CQI/PMI reporting: aperiodic, feedback mode 3 - 0 and 3 - 1 +- PRACH preamble format 0 +- All downlink (DL) channels are supported: PSS, SSS, PBCH, PCFICH, PHICH, PDCCH, PDSCH, PMCH +- All uplink (UL) channels are supported: PRACH, PUSCH, PUCCH (format 1/1a/1b), SRS, DRS + +## LTE UE MAC Layer ## + +The MAC layer implements a subset of the **3GPP 36.321** release v8.6 in support of BCH, DLSCH, RACH, and ULSCH channels. + +- RRC interface for CCCH, DCCH, and DTCH +- HARQ Support +- RA procedures and RNTI management +- RLC interface (AM, UM) +- UL power control +- Link adaptation + +## LTE UE RLC Layer ## + +The RLC layer implements a full specification of the 3GPP 36.322 release v9.3. + +## LTE UE PDCP Layer ## + +The current PDCP layer is header compliant with **3GPP 36.323** Rel 10.1.0. + +## LTE UE RRC Layer ## + +The RRC layer is based on **3GPP 36.331** v14.3.0 and implements the following functions: + +- System Information decoding +- RRC connection establishment + +# OpenAirInterface Functional Split # + +- RCC: Radio-Cloud Center +- RAU: Radio-Access Unit +- RRU: Remote Radio-Unit + +![Functional Split Architecture](./oai_enb_func_split_arch.png) + +- IF4.5 / IF5 : similar to IEEE P1914.1 +- FAPI (IF2) : specified by Small Cell Forum (open-nFAPI implementation) +- IF1 : F1 in 3GPP Release 15 + +# OpenAirInterface 5G-NR Feature Set # + +## General Parameters ## + +The following features are valid for the gNB and the 5G-NR UE. + +* Static TDD, +* Normal CP +* 30 kHz subcarrier spacing +* Bandwidths up to 80MHz (217 Physical Resource Blocks) +* Single antenna port (single beam) +* Slot format: 14 OFDM symbols in UL or DL + +## gNB Features ## + +### gNB PHY Layer ### + +* Generation of PSS/SSS/PBCH for a single beam +* Generation of PDCCH for SIB1 (as defined in the MIB) + - (including generation of DCI, polar encoding, scrambling, modulation, RB mapping, etc). +* Generation of PDSCH + - (including Segmentation, LDPC encoding, rate matching, scrambling, modulation, RB mapping, etc). + +### gNB higher Layers ### + +- NR RRC (38.331) Rel 15 messages using new asn1c +- LTE RRC (36.331) also updated to Rel 15 +- Generation of MIB +- Application to read configuration file and program gNB RRC +- RRC -> MAC configuration +- MAC -> PHY configuration (using NR FAPI P5 interface) +- FAPI P7 interface for BCH PDU, DCI PDU, PDSCH PDU + +For more details see [this document](https://gitlab.eurecom.fr/oai/openairinterface5g/uploads/ba5368448d627743a28c770c29e8978e/OAI_Software_Architecture_for_Dual_Connectivity_in_E-UTRA_and_5G-NR_and_nFAPI_for_MAC-PHY_Interface.docx) + +## NR UE Features ## + +### NR UE PHY Layer ### + +- initial synchronization (single-beam only) +- PBCH RX +- PDCCH RX +- PDSCH RX + +### NR UE higher Layers ### + +For more details see [this document](https://gitlab.eurecom.fr/oai/openairinterface5g/uploads/f7386f3a64806fd6b2ac1fc3d0252fff/UE_FAPI-like_interface.docx) + + diff --git a/doc/oai_enb_block_diagram.png b/doc/oai_enb_block_diagram.png new file mode 100644 index 0000000000..58c8eb9e95 Binary files /dev/null and b/doc/oai_enb_block_diagram.png differ diff --git a/doc/oai_enb_func_split_arch.png b/doc/oai_enb_func_split_arch.png new file mode 100644 index 0000000000..5cb6ce7957 Binary files /dev/null and b/doc/oai_enb_func_split_arch.png differ diff --git a/targets/DOCS/api_icic.xml b/targets/DOCS/api_icic.xml deleted file mode 100644 index 80984fb236..0000000000 --- a/targets/DOCS/api_icic.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - SBMAP_CONF - openair2/LAYER2/MAC/defs.h - - sbmap[13] - unsigned char - subband map indicates to scheduler allowed SB for eNB - - - periodicity - unsigned char - in millisecond indicate update instant - - - first_subframe - unsigned char - ... - - - sb_size - unsigned char - number of PRB in this subband - - - nb_active_sb - unsigned char - indicates the number of set subbands - - - - - eNB_MAC_INST - openair2/LAYER2/MAC/defs.h - - ... - - - sbmap_conf - SBMAP_CONF - subband map configuration for each eNB - - openair2/LAYER2/MAC/main.c - mac_top_init - - - - MAC_xface - openair2/PHY_INTERFACE/defs.h - - ... - - - (*get_SB_size)(unsigned char) - function pointer n - return the number of PRB supported in a subband configuration - - openair2/LAYER2/MAC/main.c - l2_init - - - - Get_Cell_SBMap - unsigned char Mod_id - void - openair2/LAYER2/MAC/defs.h - openair2/LAYER2/MAC/eNB_scheduler.c - imlements ICIC algo - - - Get_SB_size - unsigned char n_rb_dl - unsigned char - openair1/PHY/LTE_TRANSPORT/proto.h - openair1/PHY/LTE_TRANSPORT/lte_mcs.c - return the number of PRB supported in a subband configuration. - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/targets/DOCS/oaiemu.doc b/targets/DOCS/oaiemu.doc deleted file mode 100644 index 13433a5f35..0000000000 Binary files a/targets/DOCS/oaiemu.doc and /dev/null differ diff --git a/targets/DOCS/oaisim_walkthrough.pdf b/targets/DOCS/oaisim_walkthrough.pdf deleted file mode 100644 index b6d766e7f6..0000000000 Binary files a/targets/DOCS/oaisim_walkthrough.pdf and /dev/null differ diff --git a/targets/DOCS/openair_header.tex b/targets/DOCS/openair_header.tex deleted file mode 100755 index 14e1baee5a..0000000000 --- a/targets/DOCS/openair_header.tex +++ /dev/null @@ -1,47 +0,0 @@ -\documentclass[a4paper]{book} -\usepackage{a4wide} -\usepackage{makeidx} -\usepackage{fancyhdr} -\usepackage{graphicx} -\usepackage{multicol} -\usepackage{float} -\usepackage{textcomp} -\usepackage{alltt} -\usepackage{amsmath} -\usepackage{amssymb} -\ifx\pdfoutput\undefined -\usepackage[ps2pdf, - pagebackref=true, - colorlinks=true, - linkcolor=blue - ]{hyperref} -\usepackage{pspicture} -\else -\usepackage[pdftex, - pagebackref=true, - colorlinks=true, - linkcolor=blue - ]{hyperref} -\fi -\usepackage{doxygen} -\usepackage{times} -\makeindex -\setcounter{tocdepth}{1} -\renewcommand{\footrulewidth}{0.4pt} -\begin{document} -\begin{titlepage} -\vspace*{7cm} -\begin{center} -{\Large openair Specifications }\\ -Phyiscal, Medium-Access, Radio-link Control, Packet Data Convergence Protocol and Radio Resource Control Layers\\ -\vspace*{1cm} -{\large Generated by Doxygen 1.3.8}\\ -\vspace*{0.5cm} -{\small Sun Oct 31 19:27:37 2004}\\ -\end{center} -\end{titlepage} -\clearemptydoublepage -\pagenumbering{roman} -\tableofcontents -\clearemptydoublepage -\pagenumbering{arabic} diff --git a/targets/DOCS/path_loss_oaisim.xlsx b/targets/DOCS/path_loss_oaisim.xlsx deleted file mode 100644 index 2ba25b466b..0000000000 Binary files a/targets/DOCS/path_loss_oaisim.xlsx and /dev/null differ