Added a new Flag ODU_LWR_MAC_DEBUG in the code
[o-du/l2.git] / docs / overview.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3
4
5 O-DU-L2 Architecture
6 ======================
7
8
9 O-DU implements the functional blocks of L2 layer of a 5G NR protocol stacks.
10 These layers primarily include NR MAC NR Scheduler and NR RLC layers.
11
12 O-DU modules are developed as shown in the below diagram.
13
14 .. image:: ODUArch.jpg
15   :width: 400
16   :alt: ODU Arch diagram
17
18 O-DU Thread Architecture
19 --------------------------
20
21 As shown in Figure 1, there are multiple entities within O-DU. Modules sharing a
22 given color belong to one thread. O-DU architecture can be defined at a thread
23 level as follows:
24
25 -       Thread 1: O-DU thread
26
27 -       Thread 2: DU APP inclusive of Config Handler, DU Manager, UE Manager, EGTP Handler and ASN.1 Codecs
28
29 -       Thread 3: 5G NR RLC DL and MAC (inclusive of 5G NR SCH and Lower MAC)
30
31 -       Thread 4: 5G NR RLC UL
32
33 -       Thread 5: SCTP Handler
34
35
36 O-DU Modules
37 --------------------------
38
39 DU APP 
40 ^^^^^^^^^^^^^^^^^^
41 This module configures and manages all the operations of O-DU.
42 It interfaces with external entities as follows:
43
44 -       OAM:  DU APP interacts with OAM on the O1 interface for configuration, alarms and performance management.
45
46 -       O-CU: DU APP interacts with O-CU for RAN functionalities over the F1 interface which is built on SCTP. Control messages are exchanged on the F1-C interface and data messages on the F1-U interface.
47
48 -       RIC: DU APP interacts with RIC on E2 interface over SCTP.
49
50
51 DU App submodules are as follows:
52
53 -       Config Handler manages the configurations received on O1 interfaces andstores them within DU APP context.
54
55 -       DU Manager handles all cell operations at the DU APP.
56
57 -       UE Manager handles UE contexts at the DU APP.
58
59 -       SCTP handler is responsible for establishing SCTP connections with O-CU, RIC.
60
61 -       EGTP handler is responsible for establishing EGTP connection with O-CU for data message exchange.
62
63 -       ASN.1 Codecs contain ASN.1 encode/decode functions which are used for System information, F1AP and E2AP messages.
64
65 5G NR RLC
66 ^^^^^^^^^^^^^^^^^^
67 This module provides services for transferring the control and data messages
68 between MAC layer and O-CU (via DU App).
69
70 5G NR RLC UL and 5G NR RLC DL are the sub modules of this module that implement
71 uplink and downlink functionality respectively. 
72
73 5G NR MAC
74 ^^^^^^^^^^^^^^^^^^
75 This module uses the services of the NR physical layer to send and receive data
76 on the various logical channels.
77 Functions of the 5G NR MAC module are as follows:
78
79 -       5G NR MAC is responsible for multiplexing and de-multiplexing of the data on various logical channels.
80
81 -       5G NR SCH schedules resources on UL and DL for cell and UE based procedures.
82
83 -       Lower MAC interfaces between the MAC and the lower layers of the O-DU and implements all the messages of FAPI specification.
84
85 O-DU Utility and Common Functions
86 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
87 These modules help in the working of O-DU and message exchanges between
88 the O-DU modules.
89
90