folder /app/usecase/ contains set of examples for different Radio Access technology (LTE|5G NR), different category (A|B)
and list of numerologies (0,1,3) and list of bandwidths (5,10,20,100Mhz).
-Some configuration options are not used in the Bronze Release and are reserved
+Some configuration options are not used in the current release and are reserved
for future use.
The following options are available:
Table 11. struct xran_cp_header_params – Section Specific Parameters
-+----------+----------+----------+---------+---+---+---+---+----------+
-| | Des\ | Section | Remarks | | | | | |
-| | cription | Type | | | | | | |
-| | | ap\ | | | | | | |
-| | | plicable | | | | | | |
-+==========+==========+==========+=========+===+===+===+===+==========+
-| | | 0 | 1 | 3 | 5 | 6 | 7 | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| fftSize | FFT size | X | | X | | | | 5.4.4.13 |
-| | in frame | | | | | | | |
-| | st\ | | | | | | | |
-| | ructure. | | | | | | | |
-| | A\ | | | | | | | |
-| | vailable | | | | | | | |
-| | values | | | | | | | |
-| | are | | | | | | | |
-| | defined | | | | | | | |
-| | as | | | | | | | |
-| | X\ | | | | | | | |
-| | RAN_FFTS\| | | | | | | |
-| | IZE_xxxx | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| Scs | Su\ | X | | X | | | | 5.4.4.13 |
-| | bcarrier | | | | | | | |
-| | Spacing | | | | | | | |
-| | in the | | | | | | | |
-| | frame | | | | | | | |
-| | st\ | | | | | | | |
-| | ructure. | | | | | | | |
-| | A\ | | | | | | | |
-| | vailable | | | | | | | |
-| | values | | | | | | | |
-| | are | | | | | | | |
-| | defined | | | | | | | |
-| | as | | | | | | | |
-| | XRAN_SCS\| | | | | | | |
-| | _xxxx | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| iqWidth | I/Q bit | | X | X | X | | | 5.4.4.10 |
-| | width in | | | | | | | |
-| | user | | | | | | | 6.3.3.13 |
-| | data | | | | | | | |
-| | com\ | | | | | | | |
-| | pression | | | | | | | |
-| | header. | | | | | | | |
-| | Should | | | | | | | |
-| | be set | | | | | | | |
-| | by zero | | | | | | | |
-| | for | | | | | | | |
-| | 16bits | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| compMeth | Com\ | | X | X | X | | | 5.4.4.10 |
-| | pression | | | | | | | |
-| | Method | | | | | | | 6.3.3.13 |
-| | in user | | | | | | | |
-| | data | | | | | | | |
-| | com\ | | | | | | | |
-| | pression | | | | | | | |
-| | header. | | | | | | | |
-| | A\ | | | | | | | |
-| | vailable | | | | | | | |
-| | values | | | | | | | |
-| | are | | | | | | | |
-| | defined | | | | | | | |
-| | as | | | | | | | |
-| | O-RAN\ | | | | | | | |
-| | _COMPMET\| | | | | | | |
-| | HOD_xxxx | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| numUEs | Number | | | | | X | | 5.4.4.11 |
-| | of UEs. | | | | | | | |
-| | Applies | | | | | | | |
-| | to | | | | | | | |
-| | section | | | | | | | |
-| | type 6 | | | | | | | |
-| | and not | | | | | | | |
-| | s\ | | | | | | | |
-| | upported | | | | | | | |
-| | in this | | | | | | | |
-| | release. | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| ti\ | Time | X | | X | | | | 5.4.4.12 |
-| meOffset | Offset. | | | | | | | |
-| | Time | | | | | | | |
-| | offset | | | | | | | |
-| | from the | | | | | | | |
-| | start of | | | | | | | |
-| | the slot | | | | | | | |
-| | to start | | | | | | | |
-| | of | | | | | | | |
-| | Cyclic | | | | | | | |
-| | Prefix. | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
-| cpLength | Cyclic | X | | X | | | | 5.4.4.14 |
-| | Prefix | | | | | | | |
-| | Length. | | | | | | | |
-+----------+----------+----------+---------+---+---+---+---+----------+
++----------+-----------+------------------------------------+----------+
+| | Des\ | Section Type applicable | Remarks |
+| | cription | | |
++==========+===========+==========+=========+===+===+===+===+==========+
+| | | 0 | 1 | 3 | 5 | 6 | 7 | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| fftSize || FFT size | X | | X | | | | 5.4.4.13 |
+| || in frame | | | | | | | |
+| || st\ | | | | | | | |
+| | ructure. | | | | | | | |
+| || A\ | | | | | | | |
+| | vailable | | | | | | | |
+| || values | | | | | | | |
+| || are | | | | | | | |
+| || defined | | | | | | | |
+| || as | | | | | | | |
+| || X\ | | | | | | | |
+| | RAN_FFT\ | | | | | | | |
+| || SIZE_xxxx| | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| Scs || Su\ | X | | X | | | | 5.4.4.13 |
+| | bcarrier | | | | | | | |
+| || Spacing | | | | | | | |
+| || in the | | | | | | | |
+| || frame | | | | | | | |
+| || st\ | | | | | | | |
+| | ructure. | | | | | | | |
+| || A\ | | | | | | | |
+| | vailable | | | | | | | |
+| || values | | | | | | | |
+| || are | | | | | | | |
+| || defined | | | | | | | |
+| || as | | | | | | | |
+| || XRAN_SCS\| | | | | | | |
+| | _xxxx | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| iqWidth || I/Q bit | | X | X | X | | | 5.4.4.10 |
+| || width in | | | | | | | |
+| || user | | | | | | | 6.3.3.13 |
+| || data | | | | | | | |
+| || com\ | | | | | | | |
+| | pression | | | | | | | |
+| || header. | | | | | | | |
+| || Should | | | | | | | |
+| || be set | | | | | | | |
+| || by zero | | | | | | | |
+| || for | | | | | | | |
+| || 16bits | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| compMeth || Com\ | | X | X | X | | | 5.4.4.10 |
+| | pression | | | | | | | |
+| || Method | | | | | | | 6.3.3.13 |
+| || in user | | | | | | | |
+| || data | | | | | | | |
+| || com\ | | | | | | | |
+| | pression | | | | | | | |
+| || header. | | | | | | | |
+| || A\ | | | | | | | |
+| | vailable | | | | | | | |
+| || values | | | | | | | |
+| || are | | | | | | | |
+| || defined | | | | | | | |
+| || as | | | | | | | |
+| || O-RAN\ | | | | | | | |
+| | _COMP | | | | | | | |
+| || METHOD_x\| | | | | | | |
+| || xxx | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| numUEs || Number | | | | | X | | 5.4.4.11 |
+| || of UEs. | | | | | | | |
+| || Applies | | | | | | | |
+| || to | | | | | | | |
+| || section | | | | | | | |
+| || type 6 | | | | | | | |
+| || and not | | | | | | | |
+| || s\ | | | | | | | |
+| | upported | | | | | | | |
+| || in this | | | | | | | |
+| || release. | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| ti\ || Time | X | | X | | | | 5.4.4.12 |
+| meOffset || Offset. | | | | | | | |
+| || Time | | | | | | | |
+| || offset | | | | | | | |
+| || from the | | | | | | | |
+| || start of | | | | | | | |
+| || the slot | | | | | | | |
+| || to start | | | | | | | |
+| || of | | | | | | | |
+| || Cyclic | | | | | | | |
+| || Prefix. | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
+| cpLength || Cyclic | X | | X | | | | 5.4.4.14 |
+| || Prefix | | | | | | | |
+| || Length. | | | | | | | |
++----------+-----------+----------+---------+---+---+---+---+----------+
**Only sections types 1 and 3 are supported in the current release.**
Table 12. Parameters for Sections
-+-------+-------+-------+-------+-------+-------+-------+-------+
-| | D\ | Se\ | Re\ | | | | |
-| | escri\| ction | marks | | | | |
-| | ption | Type | | | | | |
-| | | appli\| | | | | |
-| | | cable | | | | | |
++-------+-------+---------------------------------------+-------+
+| | Descr\| Section Type applicable | Remar\|
+| | iption| | ks |
+=======+=======+=======+=======+=======+=======+=======+=======+
| | | 0 | 1 | 3 | 5 | 6 | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| Id | Se\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
+| Id || Se\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
| | ction | | | | | | 4.5.1 |
-| | I\ | | | | | | |
+| || I\ | | | | | | |
| | denti\| | | | | | |
| | fier. | | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| Rb | Res\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
-| | ource | | | | | | 4.5.2 |
-| | Block\| | | | | | |
-| | Indic\| | | | | | |
-| | ator. | | | | | | |
-| | Avai\ | | | | | | |
+| Rb || Res\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
+| || ource| | | | | | 4.5.2 |
+| || Block| | | | | | |
+| || Indi\| | | | | | |
+| | cator.| | | | | | |
+| || Avai\| | | | | | |
| | lable | | | | | | |
-| | v\ | | | | | | |
+| || v\ | | | | | | |
| | alues | | | | | | |
-| | are | | | | | | |
-| | de\ | | | | | | |
+| || are | | | | | | |
+| || de\ | | | | | | |
| | fined | | | | | | |
-| | as | | | | | | |
-| | O-RAN\| | | | | | |
-| | _\ | | | | | | |
-| | RBI\ | | | | | | |
-| | ND_xx\| | | | | | |
-| | xx. | | | | | | |
+| || as | | | | | | |
+| || O-RA\| | | | | | |
+| | N\ | | | | | | |
+| || _RBI\| | | | | | |
+| | ND\ | | | | | | |
+| || _xxxx| | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| s\ | S\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
+| s\ || S\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
| ymInc | ymbol | | | | | | 4.5.3 |
-| | n\ | | | | | | |
+| || n\ | | | | | | |
| | umber | | | | | | |
-| | Incr\ | | | | | | |
+| || Incr\| | | | | | |
| | ement | | | | | | |
-| | com\ | | | | | | |
+| || com\ | | | | | | |
| | mand. | | | | | | |
-| | Avai\ | | | | | | |
+| || Avai\| | | | | | |
| | lable | | | | | | |
-| | v\ | | | | | | |
+| || v\ | | | | | | |
| | alues | | | | | | |
-| | are | | | | | | |
-| | de\ | | | | | | |
+| || are | | | | | | |
+| || de\ | | | | | | |
| | fined | | | | | | |
-| | as | | | | | | |
-| | XRA\ | | | | | | |
+| || as | | | | | | |
+| || XRA\ | | | | | | |
| | N_SYM\| | | | | | |
-| | BOL\ | | | | | | |
-| | NUMBE\| | | | | | |
-| | R_xx\ | | | | | | |
-| | xx. | | | | | | |
+| || BOL\ | | | | | | |
+| || NUMB\| | | | | | |
+| | ER | | | | | | |
+| || _xxxx| | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| star\ | Sta\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
+|| star\|| Sta\ | **X** | **X** | **X** | **X** | **X** | 5.\ |
| tPrbc | rting\| | | | | | 4.5.4 |
-| | PRB | | | | | | |
+| || PRB | | | | | | |
| | of | | | | | | |
| | data | | | | | | |
-| | se\ | | | | | | |
+| || se\ | | | | | | |
| | ction | | | | | | |
-| | de\ | | | | | | |
+| || de\ | | | | | | |
| | scrip\| | | | | | |
| | tion. | | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| nu | The | **X** | **X** | **X** | **X** | **X** | 5.\ |
-| mPrbc | n\ | | | | | | 4.5.6 |
+|| num\ || The | **X** | **X** | **X** | **X** | **X** | 5.\ |
+| Prbc | n\ | | | | | | 4.5.6 |
| | umber | | | | | | |
-| | of | | | | | | |
-| | conti\| | | | | | |
-| | guous | | | | | | |
-| | PRBs | | | | | | |
-| | per | | | | | | |
-| | data | | | | | | |
-| | se\ | | | | | | |
+| || of | | | | | | |
+| || cont\| | | | | | |
+| | iguous| | | | | | |
+| || PRBs | | | | | | |
+| || per | | | | | | |
+| || data | | | | | | |
+| || se\ | | | | | | |
| | ction | | | | | | |
-| | de\ | | | | | | |
+| || de\ | | | | | | |
| | scrip\| | | | | | |
| | tion. | | | | | | |
-| | When | | | | | | |
-| | nu\ | | | | | | |
+| || When | | | | | | |
+| || nu\ | | | | | | |
| | mPrbc | | | | | | |
-| | is | | | | | | |
-| | gr\ | | | | | | |
+| || is | | | | | | |
+| || gr\ | | | | | | |
| | eater | | | | | | |
-| | than | | | | | | |
+| || than | | | | | | |
| | 255, | | | | | | |
-| | it | | | | | | |
+| || it | | | | | | |
| | will | | | | | | |
| | be | | | | | | |
-| | conv\ | | | | | | |
+| || conv\| | | | | | |
| | erted | | | | | | |
-| | to | | | | | | |
+| || to | | | | | | |
| | zero | | | | | | |
-| | by | | | | | | |
+| || by | | | | | | |
| | the | | | | | | |
| | macro | | | | | | |
-| | (XR\ | | | | | | |
-| | AN_CO\| | | | | | |
-| | NVERT\| | | | | | |
-| | _NUMP\| | | | | | |
-| | RBC). | | | | | | |
+| || (XRA\| | | | | | |
+| | N_CO\| | | | | | |
+| | NVERT| | | | | | |
+| || _NUM\| | | | | | |
+| || PRBC)| | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
| r\ | Res\ | **X** | **X** | **X** | **X** | | 5.\ |
| eMask | ource\| | | | | | 4.5.5 |
| | Of\ | | | | | | |
| | fset. | | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| ueId | UE\ | | | | **X** | **X** | 5.4\ |
+| ueId || UE\ | | | | **X** | **X** | 5.4\ |
| | i\ | | | | | | .5.10 |
| | denti\| | | | | | |
| | fier. | | | | | | |
-| | Not | | | | | | |
-| | supp\ | | | | | | |
+| || Not | | | | | | |
+| || supp\| | | | | | |
| | orted | | | | | | |
-| | in | | | | | | |
+| || in | | | | | | |
| | this | | | | | | |
-| | rel\ | | | | | | |
+| || rel\ | | | | | | |
| | ease. | | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| regF\ | Regu\ | | | | | **X** | 5.4\ |
+| regF\ || Regu\| | | | | **X** | 5.4\ |
| actor | lariz\| | | | | | .5.12 |
| | ation | | | | | | |
-| | Fa\ | | | | | | |
+| || Fa\ | | | | | | |
| | ctor. | | | | | | |
-| | Not | | | | | | |
-| | supp\ | | | | | | |
+| || Not | | | | | | |
+| || supp\| | | | | | |
| | orted | | | | | | |
-| | in | | | | | | |
+| || in | | | | | | |
| | this | | | | | | |
| | re\ | | | | | | |
| | lease | | | | | | |
+-------+-------+-------+-------+-------+-------+-------+-------+
-| Ef | Exte\ | | **X** | **X** | **X** | **X** | 5.\ |
+| Ef || Exte\| | **X** | **X** | **X** | **X** | 5.\ |
| | nsion | | | | | | 4.5.8 |
| | Flag. | | | | | | |
-| | Not | | | | | | |
-| | supp\ | | | | | | |
+| || Not | | | | | | |
+| || supp\| | | | | | |
| | orted | | | | | | |
-| | in | | | | | | |
+| || in | | | | | | |
| | this | | | | | | |
| | rel\ | | | | | | |
| | ease. | | | | | | |
Note. Since the context index is not managed by the library and APIs are
expecting it from the caller as a parameter, the caller shall
-consider a proper method to manage it to avoid corruption. The
+consider a proper way to manage it to avoid corruption. The
current reference implementation uses a slot and subframe index to
calculate the context index.