DOCUMENT

000.00.00
224.10.01

5G FAPI: Network
Document title
Monitor
Month Year Mode API
March 2020

[Link]
Small Cell Forum develops the technical and commercial enablers to
accelerate small cell adoption and drive wide-scale densification.

Broad roll-out of small cells will make high-grade mobile connectivity accessible
and affordable for industries, enterprises and for rural and urban communities.
That, in turn, will drive new business opportunities for a widening ecosystem of
service providers.

Those service providers are central to our work program. Our operator
members establish the requirements that drive the activities and outputs of
our technical groups.

We have driven the standardization of key elements of small cell technology

including Iuh, FAPI, nFAPI, SON, services APIs, TR-069 evolution and the
enhancement of the X2 interface. These specifications enable an open,
multivendor platform and lower barriers to densification for all stakeholders.

Today our members are driving solutions that include:

• 5G Components, Products, Networks
• Dis-aggregated 5G Small Cells
• Planning, Management and Automation
• 5G regulation & safety
• Neutral Hosts & Multi-operator
• Private and Public Network coexistence
• Edge compute with Small Cell Blueprint
• End to end orchestration

The Small Cell Forum Release Program has now established business cases
and market drivers for all the main use cases, clarifying market needs and
addressing barriers to deployment for residential, enterprise, rural & remote,
and urban small cells. It has also established initiatives relating to both public
and private (MNO) coordination. The Small Cell Forum Release Program
website can be found here: [Link]

If you would like more information about Small Cell Forum or would
like to be included on our mailing list, please contact:

Email info@[Link]

Post Small Cell Forum, PO Box 23, GL11 5WA UK

Member Services memberservices@[Link]

Scope
The functional application platform interface (FAPI) is an initiative within the small cell
industry released by the Small Cell Forum, which establishes interoperability and
innovation among suppliers of platform hardware, platform software and application
software by providing a common API around which suppliers can create a competitive
ecosystem. In doing this, we support a long and distinguished engineering tradition of
providing an ‘interchangeability of parts’ to ensure that the systems vendors can take
advantage of the latest innovations in silicon and software with minimum barriers to
entry, and the least amount of custom re-engineering. Hence the specification helps
support an innovative and competitive ecosystem for vendors of 5G small cell
hardware, software and equipment.

For 5G, the FAPI suite comprises three specification documents covering the following
APIs:

• ‘5G FAPI: PHY API’ - main data path (P7) and PHY mode control (P5)
interface [SCF222]
• ‘5G FAPI: RF and Digital Front End Control API’ – (P19) for Frontend Unit
control [SCF223]
• ‘Network Monitor Mode API’ - (P4) for 2G/3G/4G/5G [SCF224] (this
document)

The 5G FAPI defines internal interfaces and is agnostic to RAN architecture.

A separate 5G nFAPI specification [SCF225] is currently being developed for the

disaggregated RAN architecture where the split is at the PHY-MAC layer (option 6).

Historical placeholder APIs P1, P2, P3, P6 and M1 are outside the scope of this
document.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
The table below summarises all of SCF’s FAPI API specifications, covering 5G, 4G, 3G
and 2G radio access technologies (RATs).

New for 5G

SCF FAPI Support

Small cell
Network
3GPP RAT Type RF / Digital network FAPI (PNF/RU)
Brand name PHY API Monitor
[TS29.274] Front End PHY/MAC split management
Mode
model

2G GSM GERAN [SCF224]

3G UMTS UTRAN [SCF048] [SCF224]

3G HSPA HSPA Evolution [SCF048] [SCF224]

EUTRAN
4G LTE [SCF082] [SCF224] [SCF082] [SCF082] [SCF167]
(WB-E-UTRAN)

4G LTE-NB-IoT EUTRAN-NB-IoT [SCF082] [SCF224] [SCF082] [SCF082] [SCF167]

4G LTE-M LTE-M [SCF082] [SCF224] [SCF082] [SCF082] [SCF167]

5G 5G NR NR [SCF222] [SCF224] [SCF223] [SCF225]* [SCF239]*

*currently under development

SCF FAPI support for different radio access technologies

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
P4 NMM Executive summary
In a small cell, one of the cornerstone capabilities that enables SON (Self Organising
Networks) [SCF233] is the ability to listen to the radio environment in the vicinity of
the deployment, and optimize the RAN deployment parameters accordingly. This
capability, known as network monitoring or network listening, involves the small cell
acting as a passive UE receiver, receiving the RF signal as well as searching and
decoding system parameters from any nearby cells received with sufficient signal
strength.

An example of a network monitor functions is to configure the PHY to scan

neighbouring 5GNR, LTE, NBIoT, UTRAN, and GERAN cells to identify potential
reference sources for synchronisation, as well as to create a map of the interference
spectrum. Network monitor is typically used by the SON system of some 4G and 5G
small cell configurations such as residential femtocells where network planning
overhead is minimised, or in spectrum sharing deployments where the RF environment
is dynamic and in need of periodic monitoring.

The FAPI Network Monitor Mode (NMM) P4 API interface configures and operates
network monitoring functions within the capability of the PHY(s). The NMM
specification defines the procedures, messages and structures to implement NMM
functions for 5G 3GPP release 15 as well as legacy LTE, UTRAN, GERAN, NBIoT.

This standalone SCF224 NMM specification published for the 5G FAPI release is derived
from section 5 of V3.0.13 of the legacy Small Cell Forum nFAPI and FAPI Specification
[SCF082]. The key updates are updated diagrams and additional 5G messages and
structures.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
Contents
1. NMM Procedures...........................................................1
1.1 Generic NMM Procedures .................................................. 1
1.2 NMM Procedure Timeout ................................................... 3
1.3 NMM Procedure Sequences ............................................... 4
1.4 RSSI Procedure ............................................................... 9
1.5 Cell Search Procedure ...................................................... 9
1.6 Broadcast Detect Procedure ............................................ 10
1.7 System Information Schedule Procedure .......................... 10
1.8 System Information Procedure ........................................ 11
2. NMM Messages ...........................................................12
2.1 General Message Format ................................................ 12
2.2 P4 Messages ................................................................. 13
2.2.1 RSSI ............................................................................ 13
2.2.2 CELL SEARCH ............................................................... 19
2.2.3 BROADCAST DETECT ..................................................... 27
2.2.4 SYSTEM INFORMATION SCHEDULE .................................. 32
2.2.5 SYSTEM INFORMATION .................................................. 36
2.2.6 NMM Stop ..................................................................... 46
2.3 NMM nFAPI Tag Values ................................................... 46
2.4 Error codes ................................................................... 48
3. Constants ...................................................................49
References ............................................................................50

Tables

Table 2-1 P4 message types ..................................................................... 12

Table 2-3 [Link] parameters ........................................................... 13
Table 2-4 LTE RSSI Request ..................................................................... 14
Table 2-5 UTRAN RSSI Request ................................................................ 14
Table 2-6 GERAN RSSI Request ................................................................ 15
Table 2-7 NB-IoT RSSI Request ................................................................ 16
Table 2-8 5GNR RSSI Request .................................................................. 17
Table 2-9 [Link] parameters ......................................................... 17
Table 2-10 Error codes for [Link] ................................................... 18
Table 2-11 [Link] parameters ........................................................ 18
Table 2-12 RSSI Indication ........................................................................ 18
Table 2-13 Error codes for [Link] ............................................... 19
Table 2-14 CELL [Link] parameters .............................................. 19

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
Table 2-15 LTE CELL SEARCH Request ......................................................... 20
Table 2-16 UTRAN CELL SEARCH Request .................................................... 20
Table 2-17 GERAN CELL SEARCH Request .................................................... 21
Table 2-18 NB-IoT CELL SEARCH Request .................................................... 22
Table 2-19 5GNR CELL SEARCH Request ...................................................... 22
Table 2-20 CELL [Link] parameters ............................................ 22
Table 2-21 Error codes for CELL [Link] ....................................... 23
Table 2-22 CELL [Link] parameters ........................................... 23
Table 2-23 LTE CELL SEARCH Indication ...................................................... 24
Table 2-24 UTRAN CELL SEARCH Indication ................................................. 24
Table 2-25 GERAN CELL SEARCH Indication ................................................. 25
Table 2-26 NB-IoT CELL SEARCH Indication ................................................. 26
Table 2-27 5GNR CELL SEARCH Indication ................................................... 26
Table 2-28 Error codes for CELL [Link] .................................... 26
Table 2-29 BROADCAST [Link] parameters .................................... 27
Table 2-30 LTE BROADCAST DETECT Request .............................................. 28
Table 2-31 UTRAN BROADCAST DETECT Request .......................................... 28
Table 2-32 NB-IoT BROADCAST DETECT Request .......................................... 28
Table 2-33 5GNR BROADCAST DETECT Request ........................................... 29
Table 2-34 BROADCAST [Link] parameters .................................. 29
Table 2-35 Error codes for BROADCAST [Link] ............................... 29
Table 2-36 BROADCAST [Link] parameters ................................. 30
Table 2-37 LTE BROADCAST DETECT Indication ............................................ 31
Table 2-38 UTRAN BROADCAST DETECT Indication ....................................... 31
Table 2-39 NB-IoT BROADCAST DETECT Indication ....................................... 31
Table 2-40 5GNR BROADCAST DETECT Indication ......................................... 32
Table 2-41 Error codes for BROADCAST DETECT Indication ............................ 32
Table 2-42 SYSTEM INFORMATION [Link] parameters ................. 33
Table 2-43 LTE SYSTEM INFORMATION SCHEDULE Request ........................... 33
Table 2-44 NB-IoT SYSTEM INFORMATION SCHEDULE Request ...................... 34
Table 2-45 5GNR SYSTEM INFORMATION SCHEDULE Request .......................... 35
Table 2-46 SYSTEM INFORMATION [Link] parameters ............... 35
Table 2-47 Error codes for SYSTEM INFORMATION [Link] ......... 35
Table 2-48 SYSTEM INFORMATION [Link] parameters .............. 36
Table 2-49 Error codes for SYSTEM INFORMATION [Link]......... 36
Table 2-50 SYSTEM [Link] parameters ................................. 37
Table 2-51 LTE SYSTEM INFORMATION Request ........................................... 38
Table 2-52 UTRAN SYSTEM INFORMATION Request ....................................... 38
Table 2-53 GERAN SYSTEM INFORMATION Request ...................................... 39
Table 2-54 NB-IoT SYSTEM INFORMATION Request ...................................... 40
Table 2-55 5GNR SYSTEM INFORMATION Request ........................................ 42
Table 2-56 SYSTEM [Link] parameters ............................... 42
Table 2-57 Error codes for SYSTEM [Link] ......................... 42
Table 2-58 SYSTEM [Link] parameters .............................. 43

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
Table 2-59 LTE SYSTEM INFORMATION Indication ......................................... 43
Table 2-60 UTRAN SYSTEM INFORMATION Indication .................................... 43
Table 2-61 GERAN SYSTEM INFORMATION Indication .................................... 44
Table 2-62 NB-IoT SYSTEM INFORMATION Indication .................................... 44
Table 2-63 5GNR SYSTEM INFORMATION Indication ...................................... 44
Table 2-64 Error codes for SYSTEM [Link] ......................... 45
Table 2-65 NMM [Link] parameters ................................................. 46
Table 2-66 Error codes for NMM [Link] .......................................... 46
Table 2-67 nFAPI NMM (P4) tag values ........................................................ 48
Table 2-68 NMM error codes....................................................................... 48
Table 3-1 Constants used for NMM message sizing ...................................... 49

Figures

Figure 1-1 General NMM Procedure - Normal case ..........................................1

Figure 1-2 General NMM Procedure - Stop .....................................................2
Figure 1-3 General NMM Procedure - Stopped with crossover of normal
termination ................................................................................3
Figure 1-4 Basic full NMM Sequence for GERAN ..............................................4
Figure 1-5 Basic full NMM Sequence for UTRAN ..............................................5
Figure 1-6 Basic full NMM Sequence for LTE ...................................................6
Figure 1-7 Bandwidth-optimised LTE sequence...............................................7
Figure 1-8 Basic full NMM sequence for NB-IoT ..............................................8
Figure 1-9 Standard NMM Sequence for 5G NR ..............................................9
Figure 1-10 NMM System Information Procedure............................................ 11

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0
1. NMM Procedures

1.1 Generic NMM Procedures

The NMM procedures are a set of procedures which perform an NMM function. All the
NMM procedures follow a common generic pattern which is illustrated in Figure 1-1.

Figure 1-1 General NMM Procedure - Normal case

This generic procedure is used for each of the specific procedures described in the
following sections, unless otherwise specified below.

These NMM procedures may be carried out in the Configured state, or depending on
the PHY capabilities, may also be carried out in the Running state. There are only 2
NMM states, NMM Idle and NMM Active, which are sub-states of the PHY state.
Transitions of the PHY state are only permitted in the NMM Idle sub state.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 1
Any of the NMM procedures may also be terminated by the NMM Stop message
exchange as illustrated in Figure 1-2.

Figure 1-2 General NMM Procedure - Stop

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 2
The NMM PHY may emit the NMM procedure terminating indication in advance of the
NMM Stop response, containing partial or full results from the NMM procedure. Since
the NMM Stop request from the NMM Ctrl may cross with a NMM procedure indication
from the NMM PHY at the normal termination of the NMM procedure, it is not an error
for the NMM Stop request to arrive after completion of the NMM procedure at the NMM
PHY in the NMM Idle state, as illustrated in Figure 1-3.

Figure 1-3 General NMM Procedure - Stopped with crossover of normal termination

1.2 NMM Procedure Timeout

All NMM procedures also include a Timeout value. This value should be used by the
NMM PHY to guide the maximum time it should take to complete the procedure, and
thus may control the quality or likely success of the results. If this timeout expires
before successful completion of the procedure, the NMM PHY should abort the
procedure, and indicate a timeout failure.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 3
1.3 NMM Procedure Sequences

The NMM procedures must be carried out in the order they are presented below
(except the RSSI procedure, which is optional, and may be carried out in any order
with respect to the other procedures), as each typically depends on state information
retrieved in a previous procedure.

The basic full NMM sequence for GERAN (which does not use the Broadcast Detect or
System Information Schedule procedures) is illustrated in Figure 1-4 below.

Figure 1-4 Basic full NMM Sequence for GERAN

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 4
The basic full NMM sequence for UTRAN (which does not use the System Information
Schedule procedure) is illustrated in Figure 1-5 below.

Figure 1-5 Basic full NMM Sequence for UTRAN

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 5
The basic full NMM sequence for LTE (which uses the System Information Schedule
procedure) is illustrated in Figure 1-6 below.

Figure 1-6 Basic full NMM Sequence for LTE

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 6
For LTE, which requires the cell bandwidth to have been determined from the
Broadcast Detect procedure before performing the Information Schedule and System
Information procedures with the correct bandwidth, it may be more efficient to
perform the Bandwidth Detect procedures for all detected cells before performing any
of the System Information Schedule and System Information procedures, as
illustrated in Figure 1-7 below.

Figure 1-7 Bandwidth-optimised LTE sequence

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 7
The basic full NMM sequence for NB-IoT (which uses the System Information Schedule
procedure) is illustrated in Figure 1-8 below.

Figure 1-8 Basic full NMM sequence for NB-IoT

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 8
The basic full NMM sequence for 5G NR (which uses the System Information Schedule
procedure) is illustrated in Figure 1-9 below.

Figure 1-9 Standard NMM Sequence for 5G NR

The above sequences may be repeated for each LTE EARFCN, UTRAN UARFCN, GERAN
band or NB-IoT EARFCN (and Raster offset) and 5G NR for which NMM information is
required. All other possible sequences are outside the scope of this specification.

1.4 RSSI Procedure

This procedure is used to measure the RSSI of a set of channels at a specified

bandwidth. It does not require any signals to be demodulated, and depending on PHY
capabilities, may be carried out on channels which are normally uplink or downlink
channels.

1.5 Cell Search Procedure

This procedure is used to attempt to find one or more cells of the specified
technologies which are broadcasting on a set of channels. It only attempts to detect

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 9
the cells by detecting their fundamental synchronisation channels, and does not
decode any information from the broadcast channels.

1.6 Broadcast Detect Procedure

This procedure is used to synchronise to the cell and to return the fundamental
broadcast information (e.g. MIB) from a detected cell. For GERAN there is no such
fundamental broadcast information, so this procedure is not used.

1.7 System Information Schedule Procedure

This procedure is used to return the System Information Schedule information, and is
only relevant to those technologies which use SI Schedule information as a necessary
part of their System Information broadcasts. It is not used for UTRAN or GERAN.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 10
1.8 System Information Procedure

This procedure is used to return one or more of the System Information messages
from a detected cell. This procedure uses a modified version of the NMM generic
procedure, with multiple indications from the NMM PHY to the NMM Ctrl, as illustrated
in Figure 1-10 below.

Figure 1-10 NMM System Information Procedure

Each of the indication messages from the NMM PHY to the NMM Ctrl includes a cause
code which states whether it is the final indication or not, and the procedure is
terminated by the final indication. Each indication carries a single System Information
element except that the final indication may optionally omit any System Information
element, and only indicate the termination of the procedure.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 11
2. NMM Messages

2.1 General Message Format

The general message format in nFAPI is described in [SCF082] for LTE and [SCF225]
for 5G.

The general message format in FAPI is described in [SCF082] for LTE and [SCF222]
for 5G

Table 2-1 shows the different NMM message types

Message Value Message Body Definition

[Link] 0x0200 See Section 2.2.1

[Link] 0x0201 See Section 2.2.1

[Link] 0x0202 See Section 2.2.1

CELL_SEARCH.request 0x0203 See Section 2.2.2

CELL_SEARCH.response 0x0204 See Section 2.2.2

CELL_SEARCH.indication 0x0205 See Section 2.2.2

BROADCAST_DETECT.request 0x0206 See Section 2.2.3

BRAODCAST_DETECT.response 0x0207 See Section 2.2.3

BRAODCAST_DETECT.indication 0x0208 See Section 2.2.3

SYSTEM_INFORMATION_SCHED 0x0209 See Section 2.2.4

[Link]

SYSTEM_INFORMATION_SCHED 0x020a See Section 2.2.4

[Link]

SYSTEM_INFORMATION_SCHED 0x020b See Section 2.2.4

[Link]

SYSTEM_INFORMATION.request 0x020c See Section 2.2.5

SYSTEM_INFORMATION.respons 0x020d See Section 2.2.5

e

SYSTEM_INFORMATION.indicatio 0x020e See Section 2.2.5

n

NMM_STOP.request 0x020f See Section 2.2.6

NMM_STOP.response 0x0210 See Section 2.2.6

RESERVED 0x0211 to 0x02ff Reserved for NMM P4

messages

Table 2-1 P4 message types

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 12
2.2 P4 Messages

2.2.1 RSSI

[Link] [Link]

The [Link] message is sent by the NMM Ctrl to request that the NMM PHY
performs an RSSI measurement on the requested channels at the requested
bandwidth. Only one of the RAT-specific structures shall be included in the message.

Tag Field Type Description nFAPI

N/A RAT Type uint8_t RAT Type of this request, which specifies V
which of the possible TLV structures is
included below: 0=LTE, 1=UTRAN,
2=GERAN, 3=NB-IoT

0x3000 LTE RSSI struct The LTE RSSI request information as TLV
Request defined in Table 2-3

0x3001 UTRAN RSSI struct The UTRAN RSSI request information as TLV
Request defined in Table 2-4

0x3002 GERAN RSSI struct The GERAN RSSI request information as TLV
Request defined in Table 2-5

0x3020 NB-IoT RSSI struct The NB-IoT RSSI request information as TLV
Request defined in Table 2-6

0x3040 5GNR RSSI struct The 5GNR RSSI request information as TLV
Request defined in Table 2-7

Table 2-2 [Link] parameters

[Link].1 LTE RSSI Request

Field Type Description

Tag uint16_t The RSSI Request Tag

Length uint16_t The length in bytes of the values

Frequency Band uint8_t The E-UTRA band for which the carrierList applies.
Indicator

Measurement Period uint16_t The length of time to measure RSSI over, in units of
1ms.

Bandwidth uint8_t The bandwidth (in resource blocks) over which the
RSSI is measured.
Value: 6,15, 25, 50, 75,100

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of EARFCNs uint8_t The number of EARFCNs which should be measured.

In the case that no EARFCN (value 0) is specified,
all valid EARFCNs for the specified bandwidth in the

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 13
 Field Type Description

band shall be measured, in order of ascending

EARCFN. Range: 0… MAX_CARRIER_LIST.

For (Number of EARFCNs) {

EARFCN uint16_t The list of EARFCNs to be measured.

Table 2-3 LTE RSSI Request

[Link].2 UTRAN RSSI Request

Field Type Description

Tag uint16_t The RSSI Request Tag

Length uint16_t The length in bytes of the values

Frequency Band uint8_t The UTRA band for which the carrierList applies.
Indicator

Measurement Period uint16_t The length of time to measure RSSI over, in units of
1ms.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of UARFCNs uint8_t The number of UARFCNs which should be

measured. In the case that no UARFCN (value 0) is
specified, all UARFCNs in the band shall be
measured, in order of ascending UARCFN. Range:
0… MAX_CARRIER_LIST.

For (Number of UARFCNs) {

UARFCN uint16_t The list of UARFCNs to be measured.

Table 2-4 UTRAN RSSI Request

[Link].3 GERAN RSSI Request

Field Type Description

Tag uint16_t The RSSI Request Tag

Length uint16_t The length in bytes of the values

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 14
 Field Type Description

Frequency Band uint8_t The GERAN band for which the carrierList applies.
Indicator Values, as defined in 3GPP 45.005:

1 = T-GSM 380
2 = T-GSM 410
3 = GSM 450
4 = GSM 480
5 = GSM 710
6 = GSM 750
7 = T-GSM 810
8 = GSM 850
9 = P-GSM 900
10 = E-GSM 900
11 = R-GSM 900
12 (void)
13 = DCS 1800
14 = PCS 1900

Measurement Period uint16_t The length of time to measure RSSI over, in units of
1ms.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of ARFCNs uint8_t The number of ARFCNs which should be measured.

In the case that no ARFCN (value 0) is specified, all
ARFCNs in the band shall be measured, in order of
ascending ARCFN. Range: 0… MAX_CARRIER_LIST.

For (Number of ARFCNs) {

ARFCN uint16_t The list of ARFCNs to be measured.

Direction uint8_t The link direction to be measured.

Value: 0=DL, 1=UL

Table 2-5 GERAN RSSI Request

[Link].4 NB-IoT RSSI Request

Field Type Description

NB-IoT RSSI uint16_t The RSSI Request Tag

RequestTag

Length uint16_t The length in bytes of the values

Frequency Band uint8_t The band for which the carrierList applies.
Indicator Band indicator is encoded as specified in 3GPP
[36.104].

Measurement Period uint16_t The length of time to measure RSSI over, in units of
1ms.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 15
 Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of EARFCNs uint8_t The number of EARFCNs which should be measured.

In the case that no EARFCN (value 0) is specified,
all valid EARFCNs and raster offsets in the band
shall be measured, in order of ascending EARCFN.
Range: 0… MAX_CARRIER_LIST.

For (Number of EARFCNs) {

EARFCN uint16_t The value of EARFCN to be measured.

Number of RODL uint8_t RODL is used to specify the NB-IoT raster offset
from the EARFCN channel.

If no offset is specified then RSSI should be

measured on all valid offset values.

For (Number of RODL)

{

RODL uint8_t Raster offset from the EARFCN channel, encoded as

below:

Value:
0 = -7.5KHz
1 = -2.5KHz
2 = 0 (aligned to carrier raster)
3 = +2.5KHz
4 = +7.5KHz

Table 2-6 NB-IoT RSSI Request

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 16
[Link].5 5GNR RSSI Request
Field Type Description

Tag uint16_t The RSSI Request Tag

Length uint16_t The length in bytes of the values

Frequency Band uint16_t Band number for which this carrierList applies as
Indicator defined in Tables 5.2-1 and 5.2-2 of [TS38.104]

Measurement Period uint16_t The length of time to measure RSSI over, in units of
1ms.

Minimum Bandwidth uint8_t The bandwidth (in MHz) over which the RSSI is
measured.
Value: 5MHz, 10MHz, 40MHz [TS38.213]
[TS38.104]

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

For (Number of GSCNs) {

GSCN uint16_t The list of GSCNs to be measured in the specified

band. Where GSCN is Global Synchronization Raster
Channel.

Table 2-7 5GNR RSSI Request

[Link] [Link]

The [Link] message is sent by the NMM PHY on receipt of an RSSI request. If
the error code indicates no error, the NMM PHY shall start the requested procedure,
and shall send the [Link] once the procedure is complete.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-8 [Link] parameters

[Link] [Link] errors

The error codes that may be returned in [Link] are given in Table 2-9.

Error code Description

MSG_OK Message is OK.

MSG_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 17
 Error code Description

MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY PHY instance.

Table 2-9 Error codes for [Link]

[Link] [Link]

The [Link] message is sent by the NMM PHY on completion of the RSSI
procedure, and conveys the results of the RSSI procedure to the NMM Ctrl.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

0x3003 RSSI Indication struct The RSSI indication information as TLV

defined in Table 2-11

Table 2-10 [Link] parameters

[Link].1 RSSI Indication

Field Type Description

Tag uint16_t The RSSI Indication Tag

Length uint16_t The length in bytes of the values

Number of RSSI uint16_t The number of RSSI results returned in the

following array.

For (Number of PCIs) {

RSSI int16_t Total received signal power per cell ID. The list of
RSSI values of the carriers measured, in the order
of the list of the original request.

While measuring NB-IoT cell, if Raster offset was

not specified then, for every channel 5 RSSI values
will be reported in the order of the list of all valid
RODL values as specified in Table 2-6

Value in steps of 0.1dBm, with 0=0dBm.

Table 2-11 RSSI Indication

[Link] [Link] errors

The error codes that may be returned in [Link] are given in Table 2-12.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 18
 Error code Description

MSG_PROCEDURE_COMPLETE The requested procedure completed normally and the

results, if any, are included in the indication.

MSG_PROCEDURE_STOPPED The requested procedure was stopped by an NMM

[Link] and the results so far collected, if any,
are included in the indication.

MSG_TIMEOUT The procedure timed out, and partial or no results are

included in the indication.

Table 2-12 Error codes for [Link]

2.2.2 CELL SEARCH

[Link] CELL [Link]

The CELL [Link] message is sent by the NMM Ctrl to request that the NMM
PHY performs a CELL SEARCH measurement on the requested channels. Only one of
the RAT-specific structures shall be included in the message.

Tag Field Type Description nFAPI

N/A RAT Type Uint_8 RAT Type of this request, which specifies V
which of the possible TLV structures is
included below: 0=LTE, 1=UTRAN,
2=GERAN, 3=NB-IoT

0x3004 LTE CELL struct The LTE CELL SEARCH request information TLV
SEARCH as defined in Table 2-14
Request

0x3005 UTRAN CELL struct The UTRAN CELL SEARCH request TLV
SEARCH information as defined in Table 2-15
Request

0x3006 GERAN CELL struct The GERAN CELL SEARCH request TLV
SEARCH information as defined in Table 2-16
Request

0x3021 NB-IoT CELL struct The NB-IoT CELL SEARCH request TLV
SEARCH information as defined in Table 2-17
Request

0x3041 5GNR CELL struct The 5GNR CELL SEARCH request TLV
SEARCH information as defined in Table 2-18
Request

Table 2-13 CELL [Link] parameters

[Link].1 LTE CELL SEARCH Request

Field Type Description

Tag uint16_t The LTE CELL SEARCH Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for which cells should be measured.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 19
 Field Type Description

Measurement Bandwidth uint8_t The number of resource blocks which should be

used for measuring RSRP. See [TS36.212]

Exhaustive Search uint8_t NMM should try to find all cells on the carrier.
Value: 0=non-exhaustive search, 1=exhaustive
search

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of PCI uint8_t The number of cells in the PCI list. If 0 all cells on
the carrier should be found. Otherwise, depending
on exhaustiveSearch flag, only the given pciList is
searched or the pciList is used for indicating a
priority list. Range: 0 to MAX_PCI_LIST.

For (Number of PCI) {

PCI uint16_t The list of PCI for cells which should be searched.

Table 2-14 LTE CELL SEARCH Request

[Link].2 UTRAN CELL SEARCH Request

Field Type Description

Tag uint16_t The UTRAN CELL SEARCH Request Tag

Length uint16_t The length in bytes of the values

UARFCN uint16_t The UARFCN for which cells should be measured.

Exhaustive Search uint8_t NMM should try to find all cells on the carrier.
Value: 0=non-exhaustive search, 1=exhaustive
search

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of PSC uint8_t The number of cells in the PSC list. If 0 all cells on
the carrier should be found. Otherwise, depending
on Exhaustive Search flag, only the given PSC list is
searched or the PSC list is used for indicating a
priority list. Range: 0 to MAX_PSC_LIST.

For (Number of PSC) {

PSC uint16_t The list of PSC for cells which should be searched.

Table 2-15 UTRAN CELL SEARCH Request

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 20
[Link].3 GERAN CELL SEARCH Request
Field Type Description

Tag uint16_t The GERAN CELL SEARCH Request Tag

Length uint16_t The length in bytes of the values

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of ARFCN uint8_t The number of cells in the ARFCN List. Range: 0 to
MAX_ARFCN_LIST.

For (Number of ARFCN) {

ARFCN uint16_t The list of ARFCN for cells which should be

searched.

Table 2-16 GERAN CELL SEARCH Request

[Link].4 NB-IoT CELL SEARCH Request

Field Type Description

Tag uint16_t The NB-IoT CELL SEARCH Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for which cells should be measured.

RODL uint8_t Raster offset from the EARFCN channel, encoded as

below:
Value:
0 = -7.5KHz
1 = -2.5KHz
2 = 0 (aligned to carrier raster)
3 = +2.5KHz
4 = +7.5KHz

Exhaustive Search uint8_t NMM should try to find all cells on the carrier.
Value: 0=non-exhaustive search, 1=exhaustive
search

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of PCI uint8_t The number of cells in the PCI list. If 0 all cells on
the carrier should be found. Otherwise, depending
on exhaustiveSearch flag, only the given pciList is
searched or the pciList is used for indicating a
priority list. Range: 0 to MAX_PCI_LIST.

For (Number of PCI) {

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 21
 Field Type Description

PCI uint16_t The list of PCI for cells which should be searched.

Table 2-17 NB-IoT CELL SEARCH Request

[Link].5 5GNR CELL SEARCH Request

Field Type Description

Tag uint16_t The 5GNR CELL SEARCH Request Tag

Length uint16_t The length in bytes of the values

GSCN uint16_t The GSCN where the SSB should be detected.

Measurement Bandwidth uint16_t The number of resource blocks which should be

used for measuring RSRP

Exhaustive Search uint8_t NMM should try to find all cells on the carrier.
Value: 0=non-exhaustive search, 1=exhaustive
search

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Number of PCI uint8_t The number of cells in the PCI list. If 0 all cells on
the carrier should be found. Otherwise, depending
on exhaustiveSearch flag, only the given pciList is
searched or the pciList is used for indicating a
priority list. Range: 0 to MAX_PCI_LIST.

For (Number of PCI) {

PCI uint16_t The list of PCI for cells which should be searched.

Table 2-18 5GNR CELL SEARCH Request

[Link] CELL [Link]

The CELL [Link] message is sent by the NMM PHY on receipt of a CELL
SEARCH request. If the error code indicates no error, the NMM PHY shall start the
requested procedure, and shall send the CELL [Link] once the
procedure is complete.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-19 CELL [Link] parameters

[Link] CELL [Link] errors

The error codes that can be returned in CELL [Link] are given in Table
2-20.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 22
 Error code Description

MSG_OK Message is OK.

MSG_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY PHY instance.

Table 2-20 Error codes for CELL [Link]

[Link] CELL [Link]

The CELL [Link] message is sent by the NMM PHY on completion of the
CELL SEARCH procedure, and conveys the results of the CELL SEARCH procedure to
the NMM Ctrl.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

0x3007 LTE CELL Struct The LTE CELL SEARCH indication TLV
SEARCH information as defined in Table 2-22
Indication

0x3008 UTRAN CELL Struct The UTRAN CELL SEARCH indication TLV
SEARCH information as defined in Table 2-23
Indication

0x3009 GERAN CELL Struct The GERAN CELL SEARCH indication TLV
SEARCH information as defined in Table 2-24
Indication

0x300a NMM PHY CELL Struct A structure of opaque data optionally TLV
SEARCH STATE sent by the NMM PHY to the NMM Ctrl. If
included, the NMM Ctrl shall include the
same structure of data in all subsequent
BROADCAST DETECT request messages
for any of the found cells.

0x3022 NB-IoT CELL Struct The NB-IoT CELL SEARCH indication TLV
SEARCH information as defined in Table 2-25
Indication

0x3042 5GNR CELL Struct The 5GNR CELL SEARCH indication TLV
SEARCH information as defined in Table 2-26
Indication

Table 2-21 CELL [Link] parameters

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 23
[Link].1 LTE CELL SEARCH Indication
Field Type Description

Tag uint16_t The LTE CELL SEARCH Indication Tag

Length uint16_t The length in bytes of the values

Number of LTE Cells uint16_t The number of LTE cells indicated in this message.
Found

For (Number of LTE Cells Found) {

PCI uint16_t The physical cell identity of the cell which the NMM
synchronized to.

RSRP uint8_t The measured RSRP value in units of -1dBm. See

[TS36.214]

RSRQ uint8_t The measured RSRQ value in units of -1dB. See

[TS36.214]

Frequency Offset int16_t The estimated frequency offset (in ppb) of the
detected cell compared to the timebase clock of the
NMM PHY. A value of 0x8000 shall indicate that no
Frequency Offset information is available.

Table 2-22 LTE CELL SEARCH Indication

[Link].2 UTRAN CELL SEARCH Indication

Field Type Description

Tag uint16_t The UTRAN CELL SEARCH Indication Tag

Length uint16_t The length in bytes of the values

Number of UTRAN Cells uint16_t The number of LTE cells indicated in this message.
Found

For (Number of UTRAN Cells Found) {

PSC uint16_t The primary scrambling code of the cell which the
NMM synchronized to.

RSCP uint8_t The measured RSCP value in units of -1dB. See

[TS25.215].

EcN0 uint8_t The measured Ec/No value in units of -1dB.

See[TS25.215].

Frequency Offset int16_t The estimated frequency offset (in ppb) of the
detected cell compared to the timebase clock of the
NMM PHY. A value of 0x8000 shall indicate that no
Frequency Offset information is available.

Table 2-23 UTRAN CELL SEARCH Indication

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 24
[Link].3 GERAN CELL SEARCH Indication
Field Type Description

Tag uint16_t The GERAN CELL SEARCH Indication Tag

Length uint16_t The length in bytes of the values

Number of GSM Cells uint16_t The number of GSM cells indicated in this message.
Found

For (Number of GSM Cells Found) {

ARFCN uint16_t The ARFCN of the cell which the NMM synchronized
to.

BSIC uint8_t The BSIC of the cell which the NMM synchronized
to.

RxLev uint8_t The measured RxLev value. See [TS45.008].

RxQual uint8_t The measured RxQual value. See [TS45.008].

Frequency Offset int16_t The estimated frequency offset (in ppb) of the
detected cell compared to the timebase clock of the
NMM PHY. A value of 0x8000 shall indicate that no
Frequency Offset information is available.

SFN Offset uint32_t The offset in µs of the start of the current GSM
Radio HyperFrame (i.e. FN=0) from the start of the
preceding LTE Radio Frame of the NMM PHY for
SFN=0. Valid range: 0 to 10239999. If the NMM
PHY does not have a SFN/SF reference timebase
operational or cannot derive this offset value, it
should set this to the value 0xFFFFFFFF.

Table 2-24 GERAN CELL SEARCH Indication

[Link].4 NB-IoT CELL SEARCH Indication

Field Type Description

Tag uint16_t The NB-IoT CELL SEARCH Indication Tag

Length uint16_t The length in bytes of the values

Number of NB-IoT Cells uint16_t The number of NB-IoT cells indicated in this
Found message.

For (Number of NB-IoT Cells Found) {

PCI uint16_t The physical cell identity of the cell which the NMM
synchronized to.

RSRP uint8_t The measured RSRP value in units of -1dBm. See

[TS36.214]

RSRQ uint8_t The measured RSRQ value in units of -1dB. See

[TS36.214]

Frequency Offset int16_t The estimated frequency offset (in ppb) of the
detected cell compared to the timebase clock of the
NMM PHY. A value of 0x8000 shall indicate that no
Frequency Offset information is available.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 25
 Field Type Description

Table 2-25 NB-IoT CELL SEARCH Indication

[Link].5 5GNR CELL SEARCH Indication

Field Type Description

Tag uint16_t The 5GNR CELL SEARCH Indication Tag

Length uint16_t The length in bytes of the values

Number of 5GNR Cells uint16_t The number of 5GNR cells indicated in this
Found message.

For (Number of 5GNR Cells Found) {

PCI uint16_t The physical cell identity of the cell which the NMM
synchronized to.

iSSB uint8_t The 3bit LSB of SSB index value.

OffsetToPointA uint16_t

RSRP uint8_t The measured SS-RSRP value in dBm in units of

-1dB. See [TS38.214].

RSRQ uint8_t The measured SS-RSRQ value in units of -1dB. See

[TS38.214].

Frequency Offset int16_t The estimated frequency offset (in ppb) of the
detected cell compared to the timebase clock of the
NMM PHY. A value of 0x8000 shall indicate that no
Frequency Offset information is available.

Table 2-26 5GNR CELL SEARCH Indication

[Link] CELL [Link] errors

The error codes that can be returned in CELL [Link] are given in Table
2-27.

Error code Description

MSG_PROCEDURE_COMPLETE The requested procedure completed normally

and the results, if any, are included in the
indication.

MSG_PROCEDURE_STOPPED The requested procedure was stopped by an

NMM [Link] and the results so far
collected, if any, are included in the
indication.

MSG_TIMEOUT The procedure timed out, and partial or no

results are included in the indication.

Table 2-27 Error codes for CELL [Link]

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 26
2.2.3 BROADCAST DETECT

[Link] BROADCAST [Link]

The BROADCAST [Link] message is sent by the NMM Ctrl to request that
the NMM PHY performs a BROADCAST DETECT measurement on the requested cell.
Only one of the RAT-specific structures shall be included in the message.

Tag Field Type Description nFAPI

N/A RAT Type uint_8 RAT Type of this request, which specifies V
which of the possible TLV structures is
included below: 0=LTE, 1=UTRAN, 2=NB-
IoT

0x300b LTE struct The LTE BROADCAST DETECT request TLV

BROADCAST information as defined in Table 2-29
DETECT
Request

0x300c UTRAN struct The UTRAN BROADCAST DETECT request TLV

BROADCAST information as defined in Table 2-30
DETECT
Request

0x300a NMM PHY struct A structure of opaque data conditionally TLV

CELL SEARCH sent by the NMM Ctrl to the NMM PHY. It
STATE must be included if the NMM PHY included it
in the CELL [Link].

0x3023 NB-IoT struct The NB-IoT BROADCAST DETECT request TLV

BROADCAST information as defined in Table 2-31
DETECT
Request

0x3043 5GNR struct The 5GNR 5GNR BROADCAST DETECT TLV

BROADCAST Request Table 2-32
DETECT
Request

Table 2-28 BROADCAST [Link] parameters

[Link].1 LTE BROADCAST DETECT Request

Field Type Description

Tag uint16_t The BROADCAST DETECT Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for the cell which the NMM should read
the PBCH.

PCI uint16_t The physical cell identity of the cell which the NMM
should read the PBCH.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 27
 Field Type Description

complete the procedure without any NMM Ctrl

imposed timeout.

Table 2-29 LTE BROADCAST DETECT Request

[Link].2 UTRAN BROADCAST DETECT Request

Field Type Description

Tag uint16_t The BROADCAST DETECT Request Tag

Length uint16_t The length in bytes of the values

UARFCN uint16_t The UARFCN for the cell which the NMM should read
the PBCH.

PSC uint16_t The primary scrambling code of the cell which the
NMM should read the PBCH.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-30 UTRAN BROADCAST DETECT Request

[Link].3 NB-IoT BROADCAST DETECT Request

Field Type Description

Tag uint16_t The BROADCAST DETECT Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for the NB-IoT carrier for which the
NMM should read the NPBCH.

RODL uint8_8 Raster offset for the carrier

Value:
0 = -7.5KHz
1 = -2.5KHz
2 = 0 (aligned to carrier raster)
3 = +2.5KHz
4 = +7.5KHz

PCI uint16_t The physical cell identity of the cell which the NMM
should read the NPBCH.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Table 2-31 NB-IoT BROADCAST DETECT Request

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 28
[Link].4 5GNR BROADCAST DETECT Request
Field Type Description

Tag uint16_t The BROADCAST DETECT Request Tag

Length uint16_t The length in bytes of the values

GSCN uint16_t The GSCN where the SSB should be detected.

PCI uint16_t The physical cell identity of the cell which the NMM
should read the PBCH.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-32 5GNR BROADCAST DETECT Request

[Link] BROADCAST [Link]

The BROADCAST [Link] message is sent by the NMM PHY on receipt of a

BROADCAST DETECT request. If the error code indicates no error, the NMM PHY shall
start the requested procedure, and shall send the BROADCAST [Link]
once the procedure is complete.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-33 BROADCAST [Link] parameters

[Link] BROADCAST [Link] errors

The error codes that can be returned in BROADCAST [Link] are given in
Table 2-34.

Error code Description

MSG_OK Message is OK.

MSG_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY PHY instance.

Table 2-34 Error codes for BROADCAST [Link]

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 29
[Link] BROADCAST [Link]

The BROADCAST [Link] message is sent by the NMM PHY on completion

of the BROADCAST DETECT procedure, and conveys the results of the BROADCAST
DETECT procedure to the NMM Ctrl.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

0x300e LTE struct The LTE BROADCAST DETECT indication TLV

BROADCAST information as defined in Table 2-36
DETECT
Indication

0x300f UTRAN struct The UTRAN BROADCAST DETECT TLV

BROADCAST indication information as defined in Table
DETECT 2-37
Indication

0x3010 NMM PHY CELL struct A structure of opaque data optionally TLV
BROADCAST sent by the NMM PHY to the NMM Ctrl. If
STATE included, the NMM Ctrl shall include the
same structure of data in any
subsequent SYSTEM INFORMATION
SCHEDULE request or subsequent
SYSTEM INFORMATION request message
for this cell.

0x3024 NB-IoT struct The NB-IoT BROADCAST DETECT TLV

BROADCAST indication information as defined in Table
DETECT 2-38
Indication

0x3044 5GNR struct The 5GNR BROADCAST DETECT TLV

BROADCAST indication information as defined in Table
DETECT 2-39
Indication

Table 2-35 BROADCAST [Link] parameters

[Link].1 LTE BROADCAST DETECT Indication

Field Type Description

Tag uint16_t The LTE BROADCAST DETECT Indication Tag

Length uint16_t The length in bytes of the value

Number of Tx Antenna uint8_t The number of Tx Antenna detected for the cell: 1,
2 or 4

MIB Length uint16_t Length in bytes of the following MIB array

MIB[MIB Length] array of The MIB read from the specified cell.
uint8_t

SFN Offset uint32_t The offset in µs of the first Radio Frame which
contained this MIB from the start of the preceding
Radio Frame of the NMM PHY for SFN=0 and SF=0.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 30
 Field Type Description

Valid range: 0 to 10239999. If the NMM PHY does

not have a SFN/SF reference timebase operational
or cannot derive this offset value, it should set this
to the value 0xFFFFFFFF.

Table 2-36 LTE BROADCAST DETECT Indication

[Link].2 UTRAN BROADCAST DETECT Indication

Field Type Description

Tag uint16_t The UTRAN BROADCAST DETECT Indication Tag

Length uint16_t The length in bytes of the value

MIB Length uint16_t Length in bytes of the following MIB array

MIB[MIB Length] array of The MIB read from the specified cell.
uint8_t

SFN Offset uint32_t The offset in µs of the first UTRAN Radio Frame
which contained this MIB from the start of the
preceding Radio Frame of the NMM PHY for SFN=0
and SF=0. Valid range: 0 to 10239999. If the NMM
PHY does not have a SFN/SF reference timebase
operational or cannot derive this offset value, it
should set this to the value 0xFFFFFFFF.

Table 2-37 UTRAN BROADCAST DETECT Indication

[Link].3 NB-IoT BROADCAST DETECT Indication

Field Type Description

Tag uint16_t The NB-IoT BROADCAST DETECT Indication Tag

Length uint16_t The length in bytes of the value

Number of Tx Antenna uint8_t The number of Tx Antenna detected for the cell: 1
or 2

MIB Length uint16_t Length in bytes of the following MIB array

MIB[MIB Length] array of The MIB read from the specified cell.
uint8_t

SFN Offset uint32_t The offset in µs of the first Radio Frame which
contained this MIB from the start of the preceding
Radio Frame of the NMM PHY for SFN=0 and SF=0.
Valid range: 0 to 10239999. If the NMM PHY does
not have a SFN/SF reference timebase operational
or cannot derive this offset value, it should set this
to the value 0xFFFFFFFF.

Table 2-38 NB-IoT BROADCAST DETECT Indication

[Link].4 5GNR BROADCAST DETECT Indication

Field Type Description

Tag uint16_t The 5GNR BROADCAST DETECT Indication Tag

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 31
 Field Type Description

Length uint16_t The length in bytes of the value

kSSB uint8_t The number of Tx Antenna detected for the cell: 1,

2 or 4

MIB Length uint16_t Length in bytes of the following MIB array

MIB[MIB Length] array of The MIB read from the specified cell.
uint8_t

SFN Offset uint32_t The offset in µs of the first Radio Frame which
contained this MIB from the start of the preceding
Radio Frame of the NMM PHY for SFN=0 and SF=0.
Valid range: 0 to 10239999. If the NMM PHY does
not have a SFN/SF reference timebase operational
or cannot derive this offset value, it should set this
to the value 0xFFFFFFFF.

Table 2-39 5GNR BROADCAST DETECT Indication

[Link] BROADCAST [Link] errors

The error codes that can be returned in BROADCAST [Link] are given in
Table 2-40.

Error code Description

MSG_PROCEDURE_COMPLETE The requested procedure completed normally

and the results, if any, are included in the
indication.

MSG_PROCEDURE_STOPPED The requested procedure was stopped by an

NMM [Link] and the results so far
collected, if any, are included in the
indication.

MSG_TIMEOUT The procedure timed out, and partial or no

results are included in the indication.

Table 2-40 Error codes for BROADCAST DETECT Indication

2.2.4 SYSTEM INFORMATION SCHEDULE

[Link] SYSTEM INFORMATION [Link]

The SYSTEM INFORMATION [Link] message is sent by the NMM Ctrl to

request that the NMM PHY performs a SYSTEM INFORMATION SCHEDULE
measurement on the requested cell. Only one of the RAT-specific structures shall be
included in the message

Tag Field Type Description nFAPI

N/A RAT Type Uint_8 RAT Type of this request, which specifies V
which of the possible TLV structures is
included below: 0=LTE, 1=UTRAN,
2=GERAN, 3=NB-IoT

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 32
 Tag Field Type Description nFAPI

0x3011 LTE SYSTEM struct The LTE SYSTEM INFORMATION TLV

INFORMATION SCHEDULE request information as
SCHEDULE defined in Table 2-42
Request

0x3010 NMM PHY CELL struct A struct of opaque data conditionally TLV
BROADCAST sent by the NMM Ctrl to the NMM PHY. It
STATE must be included if the NMM PHY
included it in the BROADCAST
[Link] for this cell.

0x3025 NB-IoT SYSTEM struct The NB-IoT SYSTEM INFORMATION TLV

INFORMATION SCHEDULE request information as
SCHEDULE defined in Table 2-43
Request

0x3045 5GNR SYSTEM struct The 5GNR SYSTEM INFORMATION TLV

INFORMATION SCHEDULE request information as
SCHEDULE defined in Table 2-44
Request

Table 2-41 SYSTEM INFORMATION [Link] parameters

[Link].1 LTE SYSTEM INFORMATION SCHEDULE Request

Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION SCHEDULE Request

Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN of the cell for which the SIB1 is wanted

PCI uint16_t PCI of the cell for which the SIB1 is wanted

Downlink channel uint16_t Downlink channel bandwidth (in resource blocks) of

bandwidth the cell for which SIB1 is wanted.
See [36.104] section 5.6.
Value: 6, 15, 25, 50, 75, 100

PHICH Configuration uint8_t The PHICH-Config of the cell, mapped as:

Bits 7-4: Reserved (0)
Bit 3: PHICH Duration, encoded as: 0=Normal,
1=Extended
Bits 1-0: PHICH Resource, encoded as: 0=1/6;
1=1/2; 2=1, 3=2

Number of Tx Antenna uint8_t The number of Tx Antenna for the cell: 1, 2 or 4

retryCount uint8_t The number of SIB1 repetition periods for which

decoding of SIB1 should be retried.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Table 2-42 LTE SYSTEM INFORMATION SCHEDULE Request

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 33
[Link].2 NB-IoT SYSTEM INFORMATION SCHEDULE Request
Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION SCHEDULE Request

Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for the NB-IoT carrier for which the
NMM should read the NPBCH.

RODL uint8_8 Raster offset for the carrier

Value:
0 = -7.5KHz
1 = -2.5KHz
2 = 0 (aligned to carrier raster)
3 = +2.5KHz
4 = +7.5KHz

PCI uint16_t PCI of the cell for which the SIB1-NB is wanted

SchedulingInfoSIB1-NB uint8_t Indicates the number of NPDSCH repetitions and

TBS value for SIB1-NB. This field is encoded as
specified in [TS36.212].

Value: 0 → 15.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-43 NB-IoT SYSTEM INFORMATION SCHEDULE Request

[Link].3 5GNR SYSTEM INFORMATION SCHEDULE Request

Field Type Description

Tag uint16_t The 5GNR SYSTEM INFORMATION SCHEDULE

Request Tag

Length uint16_t The length in bytes of the values

NR-ARFCN uint16_t The NR-ARFCN of the cell for which the SIB1 is
wanted, encoded as in [TS38.331]

PCI uint16_t PCI of the cell for which the SIB1 is wanted

kSSB uint8_t Value: 0~23, as encoded in [TS38.211]

pdcchConfigSIB1 uint8_t The configuration for CORESET #0 and search

space#0, as encoded in 38.213 [TS38.213]

subCarrierSpacingComm uint8_t The subcarrier spacing for SIB1, as encoded in

on [TS38.211], 0->15kHz, 1->30kHz, 2->60kHz, 3-
>120kHz, 4->240kHz.

retryCount uint8_t The number of SIB1 repetition periods for which

decoding of SIB1 should be retried.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 34
 Field Type Description

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-44 5GNR SYSTEM INFORMATION SCHEDULE Request

[Link] SYSTEM INFORMATION [Link]

The SYSTEM INFORMATION [Link] message is sent by the NMM PHY on

receipt of a SYSTEM INFORMATION SCHEDULE request. If the error code indicates no
error, the NMM PHY shall start the requested procedure, and shall send the SYSTEM
INFORMATION [Link] once the procedure is complete.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-45 SYSTEM INFORMATION [Link] parameters

[Link] SYSTEM INFORMATION [Link] errors

The error codes that can be returned in SYSTEM INFORMATION [Link] are
given in Table 2-46.

Error code Description

MSG_OK Message is OK.

MSG_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY PHY instance.

Table 2-46 Error codes for SYSTEM INFORMATION [Link]

[Link] SYSTEM INFORMATION [Link]

The SYSTEM INFORMATION [Link] message is sent by the NMM PHY on

completion of the SYSTEM INFORMATION SCHEDULE procedure, and conveys the
results of the SYSTEM INFORMATION SCHEDULE procedure to the NMM Ctrl.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 35
 Tag Field Type Description nFAPI

0x3018 LTE SYSTEM struct The LTE SYSTEM INFORMATION as TLV

INFORMATION defined in Table 2-58, which for this
Indication message carries the SIB1

0x3026 NB-IoT struct The NB-IoT SYSTEM INFORMATION TLV

SYSTEM Indication as defined in Table 2-61
INFORMATION
Indication

0x3046 5GNR SYSTEM struct The 5GNR SYSTEM INFORMATION TLV

INFORMATION Indication as defined in Table 2-61
Indication

Table 2-47 SYSTEM INFORMATION [Link] parameters

[Link] SYSTEM INFORMATION [Link] errors

The error codes that can be returned in SYSTEM INFORMATION [Link]

are given in Table 2-48.

Error code Description

MSG_PROCEDURE_COMPLETE The requested procedure completed normally

and the results, if any, are included in the
indication.

MSG_PROCEDURE_STOPPED The requested procedure was stopped by an

NMM [Link] and the results so far
collected, if any, are included in the
indication.

MSG_TIMEOUT The procedure timed out, and partial or no

results are included in the indication.

Table 2-48 Error codes for SYSTEM INFORMATION [Link]

2.2.5 SYSTEM INFORMATION

[Link] SYSTEM [Link]

The SYSTEM [Link] message is sent by the NMM Ctrl to request that
the NMM PHY performs a SYSTEM INFORMATION measurement on the requested cell.
Only one of the RAT-specific structures shall be included in the message.

Tag Field Type Description nFAPI

N/A RAT Type uint_8 RAT Type of this request, which V

specifies which of the possible TLV
structures is included below: 0=LTE,
1=UTRAN, 2=GERAN, 3=NB-IoT

0x3014 LTE SYSTEM struct The LTE SYSTEM INFORMATION TLV

INFORMATION request information as defined in
Request Table 2-50

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 36
 Tag Field Type Description nFAPI

0x3015 UTRAN struct The UTRAN SYSTEM INFORMATION TLV

SYSTEM request information as defined in
INFORMATION Table 2-51
Request

0x3016 GERAN struct The GERAN SYSTEM INFORMATION TLV

SYSTEM request information as defined in
INFORMATION Table 2-52
Request

0x3010 NMM PHY struct A structure of opaque data TLV

CELL conditionally sent by the NMM Ctrl to
BROADCAST the NMM PHY. It must be included if
STATE the NMM PHY included it in the
BROADCAST [Link] for
this cell.

0x3027 NB-IoT struct The NB-IoT SYSTEM INFORMATION TLV

SYSTEM Request information as defined in
INFORMATION Table 2-53
Request

0x3046 5GNR SYSTEM struct The 5GNR SYSTEM INFORMATION TLV

INFORMATION Request information as defined in
Request Table 2 54

Table 2-49 SYSTEM [Link] parameters

[Link].1 LTE SYSTEM INFORMATION Request

Field Type Description

Tag uint16_t The SYSTEM INFORMATION Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN of the cell for which the SIBs are
wanted

PCI uint16_t PCI of the cell for which the SIBs are wanted

Downlink channel uint16_t Downlink channel bandwidth (in resource blocks) of

bandwidth the cell for which SIBs are wanted.
See [TS36.104] section 5.6.
Value: 6, 15, 25, 50, 75, 100

PHICH Configuration Uint8_t The PHICH-Config of the cell, mapped as:

Bits 7-4: Reserved (0)
Bit 3: PHICH Duration, encoded as: 0=Normal,
1=Extended
Bits 1-0: PHICH Resource, encoded as: 0=1/6;
1=1/2; 2=1, 3=2

Number of Tx Antenna uint8_t The number of Tx Antenna for the cell: 1, 2 or 4

Number of SI Periodicity uint8_t The number of System Information periodicity

values in the following array

For (Number of SI Periodicity) {

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 37
 Field Type Description

SI Periodicity uint8_t The SI Periodicity of the requested SIBs, with the

first element being for SIB2, the next for SIB3, etc,
encoded as follows:
0=This SIB not required
1=80ms
2=160ms
3=320ms
4=640ms
5=1280ms
6=2560ms
7=5120ms

SI Index uint8_t The index of this SIB in the SIB1

SchedulingInfoList:
0 = This SIB not required
1…32 = index value in SIB1 SchedulingInfoList

SI Window Length unit8_t The SI window in units of 1ms, with the following
valid values: 1,2,5,10,15,20,40

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-50 LTE SYSTEM INFORMATION Request

[Link].2 UTRAN SYSTEM INFORMATION Request

Field Type Description

Tag uint16_t The SYSTEM INFORMATION Request Tag

Length uint16_t The length in bytes of the values

UARFCN uint16_t The UARFCN for the cell for which the SIBs are
wanted.

PSC uint16_t The primary scrambling code of the cell for which
the SIBs are wanted.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl-
imposed timeout.

Table 2-51 UTRAN SYSTEM INFORMATION Request

[Link].3 GERAN SYSTEM INFORMATION Request

Field Type Description

Tag uint16_t The SYSTEM INFORMATION Request Tag

Length uint16_t The length in bytes of the values

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 38
 Field Type Description

ARFCN uint16_t The ARFCN of the cell for which the SIs are wanted.

BSIC uint8_t The BSIC of the cell for which the SIs are wanted.

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-52 GERAN SYSTEM INFORMATION Request

[Link].4 NB-IoT SYSTEM INFORMATION Request

Field Type Description

Tag uint16_t The SYSTEM INFORMATION Request Tag

Length uint16_t The length in bytes of the values

EARFCN uint16_t The EARFCN for the NB-IoT carrier for which the
NMM should read the NPBCH.

RODL uint8_8 Raster offset for the carrier

Value:
0 = -7.5KHz
1 = -2.5KHz
2 = 0 (aligned to carrier raster)
3 = +2.5KHz
4 = +7.5KHz

PCI uint16_t PCI of the cell for which the SIBs are wanted

Number of SI Periodicity uint8_t The number of System Information periodicity

values in the following array

For (Number of SI Periodicity) {

SI Periodicity uint8_t The SI Periodicity of the requested SIBs, with the

first element being for SIB2-NB, the next for SIB3-
NB, etc, encoded as follows:
0=640ms
1=1280ms
2=2560ms
3=5120ms
4=10240ms
5=20480ms
6=40960ms

SI RepetitionPattern uint8_t The repetition pattern of the requested SIBs, with

the first element being for SIB2-NB, next for SIB3-
NB etc, encoded as follows:
0=every2ndRF
1=every4thRF
2=every8thRF
3=every16thRF

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 39
 Field Type Description

SI TB Size uint8_t This gives the transport block size of the System
Information messages and is encoded as follows:
0=56bits
1=120bits
2=208bits
3=256bits
4=328bits
5=440bits
6=552bits
7=680bits

Number of SI Index uint8_t Number of SIBs associated with a particular SI

periodicity

Value: 0 → 7.

For (Number of SI
Index) {

SI Index uint8_t Index of this SIB type in SIB-Mapping-Info-NB,

encoded as follows:
0 = SIB3-NB
1 = SIB4-NB
2 = SIB5-NB
3 = SIB14-NB
4 = SIB16-NB

SI Window Length unit8_t The SI window encoded as follows:

0=160ms
1=320ms
2=480ms
3=640ms
4=960ms
5=1280ms
6=1600ms

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-53 NB-IoT SYSTEM INFORMATION Request

[Link].5 5GNR SYSTEM INFORMATION Request

Field Type Description

Tag uint16_t The 5GNR SYSTEM INFORMATION Request Tag

Length uint16_t The length in bytes of the values

NR-ARFCN uint16_t The NR-ARFCN for the 5GNR carrier for which the
SIBs are wanted, as encoded in [TS38.331]

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 40
 Field Type Description

PCI uint16_t PCI of the cell for which the SIBs are wanted

kSSB uint8_t Value: 0~23, as encoded in [TS38.211]

pdcchConfigSIB1 uint8_t The configuration for CORESET #0 and search

space#0, , as encoded in [TS38.213]

subCarrierSpacingComm uint8_t The subcarrier spacing for SIB1, as encoded in

on [TS38.211], 0->15kHz, 1->30kHz, 2->60kHz, 3-
>120kHz, 4->240kHz.

Number of SI Periodicity uint8_t The number of System Information periodicity values

in the following array

For (Number of SI Periodicity) {

SI Periodicity uint8_t The SI Periodicity of the requested SIBs, with the

first element being for SIB2, the next for SIB3, etc,
encoded as follows:
0=This SIB not required
1=80ms
2=160ms
3=320ms
4=640ms
5=1280ms
6=2560ms
7=5120ms

SI Index uint8_t The index of this SIB in the SIB1 SchedulingInfoList:

0 = This SIB not required
1…32 = index value in SIB1 SchedulingInfoList

SI Periodicity uint8_t The SI Periodicity of the requested SIBs, with the

first element being for SIB2, the next for SIB3, etc,
encoded as follows:
0=This SIB not required
1=80ms
2=160ms
3=320ms
4=640ms
5=1280ms
6=2560ms
7=5120ms

SI Index uint8_t The index of this SIB in the SIB1 SchedulingInfoList:

0 = This SIB not required
1…32 = index value in SIB1 SchedulingInfoList

SI Window Length unit8_t The SI window encoded as follows:

0=5 slots
1=10 slots
2=20 slots
3=40 slots
4=80 slots

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 41
 Field Type Description

5=160 slots
6=320 slots
7=640 slots
8=1280 slots

Timeout uint32_t The timeout value after which the NMM PHY should
abort the procedure in units of 1ms. The value of 0
indicates that the NMM PHY should attempt to
complete the procedure without any NMM Ctrl
imposed timeout.

Table 2-54 5GNR SYSTEM INFORMATION Request

[Link] SYSTEM [Link]

The SYSTEM [Link] message is sent by the NMM PHY on receipt of n

SYSTEM INFORMATION request. If the error code indicates no error, the NMM PHY
shall start the requested procedure, and shall send the SYSTEM
[Link] once the procedure is complete.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-55 SYSTEM [Link] parameters

[Link] SYSTEM [Link] errors

The error codes that can be returned in SYSTEM [Link] are given in
Table 2-56.

Error code Description

MSG_OK Message is OK.

MSG_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY PHY instance.

Table 2-56 Error codes for SYSTEM [Link]

[Link] SYSTEM [Link]

The SYSTEM [Link] message is sent by the NMM PHY during and
on completion of the SYSTEM INFORMATION procedure, and conveys the results of the
SYSTEM INFORMATION procedure to the NMM Ctrl. The final indication of the
procedure may omit the SYSTEM INFORMATION Indication. Only one of the RAT-
specific structures shall be included in the message.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 42
 Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

0x3018 LTE SYSTEM struct The LTE SYSTEM INFORMATION TLV

INFORMATION indication information as defined in Table
Indication 2-58

0x3019 UTRAN SYSTEM struct The UTRAN SYSTEM INFORMATION TLV

INFORMATION indication information as defined in Table
Indication 2-59

0x301a GERAN SYSTEM struct The GERAN SYSTEM INFORMATION TLV

INFORMATION indication information as defined in Table
Indication 2-60

0x3026 NB-IoT SYSTEM struct The NB-IoT SYSTEM INFORMATION TLV

INFORMATION indication information as defined in Table
Indication 2-61

0x3047 5GNR SYSTEM struct The 5GNR SYSTEM INFORMATION TLV

INFORMATION indication information as defined in
Indication Table 2-62

Table 2-57 SYSTEM [Link] parameters

[Link].1 LTE SYSTEM INFORMATION Indication

Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION Indication Tag

Length uint16_t The length in bytes of the values

SIB Type uint8_t The SIB type carried in the array below.
LTE Values: 0=MIB; 1=SIB1; 2=SIB2 etc

SIB Length uint16_t The length in bytes of the following SIB array

SIB[SIB Length] array of The SIB element read from the specified cell.
uint8_t

Table 2-58 LTE SYSTEM INFORMATION Indication

[Link].2 UTRAN SYSTEM INFORMATION Indication

Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION Indication Tag

Length uint16_t The length in bytes of the values

SIB Length uint16_t The length in bytes of the following SIB array

SIB[SIB Length] array of The SIB element read from the specified cell.
uint8_t

Table 2-59 UTRAN SYSTEM INFORMATION Indication

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 43
[Link].3 GERAN SYSTEM INFORMATION Indication
Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION Indication Tag

Length uint16_t The length in bytes of the values

SI Length uint16_t The length in bytes of the following SI array

SI[SI Length] array of The SI element read from the specified cell.
uint8_t

Table 2-60 GERAN SYSTEM INFORMATION Indication

[Link].4 NB-IoT SYSTEM INFORMATION Indication

Field Type Description

Tag uint16_t The LTE SYSTEM INFORMATION Indication Tag

Length uint16_t The length in bytes of the values

SIB Type uint8_t The SIB type carried in the array below and
encoded as follows.
Values:
0=MIB-NB
1=SIB1-NB
2=SIB2-NB
3=SIB3-NB
4=SIB4-NB
5-13 = Reserved
14=SIB14-NB
15=Reserved
16=SIB16-NB

SIB Length uint16_t The length in bytes of the following SIB array

SIB[SIB Length] array of The SIB element read from the specified cell.
uint8_t

Table 2-61 NB-IoT SYSTEM INFORMATION Indication

[Link].5 5GNR SYSTEM INFORMATION Indication

Error code Description

Tag uint16_t

Length uint16_t

SIB Type uint8_t

SIB Length uint16_t

Table 2-62 5GNR SYSTEM INFORMATION Indication

[Link] SYSTEM [Link] errors

The error codes that can be returned in SYSTEM [Link] are given
in Table 2-63.

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 44
 Error code Description

MSG_PROCEDURE_COMPLETE The requested procedure completed normally

and the results, if any, are included in the
indication.

MSG_PARTIAL_RESULTS The requested procedure has produced the

partial results included, but the procedure is
continuing and further indications will follow.

MSG_PROCEDURE_STOPPED The requested procedure was stopped by an

NMM [Link] and the results so far
collected, if any, are included in the
indication.

MSG_TIMEOUT The procedure timed out, and partial or no

results are included in the indication.

Table 2-63 Error codes for SYSTEM [Link]

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 45
2.2.6 NMM Stop

[Link] NMM [Link]

The NMM [Link] message may be sent by the NMM Ctrl to stop any ongoing
NMM procedure.

No message body is defined for the NMM Stop request.

[Link] NMM [Link]

The NMM [Link] message is sent by the NMM PHY on receipt of an NMM Stop
request message. The NMM PHY may emit an NMM procedure indication in advance of
the NMM Stop response, containing partial or full results from the NMM procedure.
Since the NMM Stop request from the NMM Ctrl may cross with the NMM procedure
indication from the NMM PHY at the normal termination of the NMM procedure, it is
not an error for the NMM Stop request to arrive after completion of the NMM
procedure at the NMM PHY.

Tag Field Type Description nFAPI

N/A Error Code uint32_t The error code V

Table 2-64 NMM [Link] parameters

[Link] NMM [Link] errors

The error codes that can be returned in NMM [Link] are given in Table 2-65.

Error code Description

MSG_NMM_STOP_OK The NMM [Link] caused an NMM

procedure to be stopped.

MSG_NMM_STOP_IGNORED The NMM [Link] was received when

no NMM procedure was in progress, so was
ignored.

MSG_NMM_STOP_INVALID_STATE The request was received when the PHY was

in the IDLE state, or in the RUNNING state
and this NMM PHY does not support
RUNNING state NMM.

Table 2-65 Error codes for NMM [Link]

2.3 NMM nFAPI Tag Values

The tag values used in the TLV sections of nFAPI P7 messages are given in Table 2-66.

Tag (Hex) Description

0x3000 LTE RSSI Request

0x3001 UTRAN RSSI Request

0x3002 GERAN RSSI Request

0x3003 RSSI Indication

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 46
 Tag (Hex) Description

0x3004 LTE CELL SEARCH Request

0x3005 UTRAN CELL SEARCH Request

0x3006 GERAN CELL SEARCH Request

0x3007 LTE CELL SEARCH Indication

0x3008 UTRAN CELL SEARCH Indication

0x3009 GERAN CELL SEARCH Indication

0x300a PNF CELL SEARCH STATE

0x300b LTE BROADCAST DETECT Request

0x300c UTRAN BROADCAST DETECT Request

0x300e LTE BROADCAST DETECT Indication

0x300f UTRAN BROADCAST DETECT Indication

0x3010 PNF CELL BROADCAST STATE

0x3011 LTE SYSTEM INFORMATION SCHEDULE Request

0x3014 LTE SYSTEM INFORMATION Request

0x3015 UTRAN SYSTEM INFORMATION Request

0x3016 GERAN SYSTEM INFORMATION Request

0x3018 LTE SYSTEM INFORMATION Indication

0x3019 UTRAN SYSTEM INFORMATION Indication

0x301a GERAN SYSTEM INFORMATION Indication

0x301b – 0x301f Reserved

0x3020 NB-IoT RSSI Request

0x3021 NB-IoT CELL SEARCH Request

0x3022 NB-IoT CELL SEARCH Indication

0x3023 NB-IoT BROADCAST DETECT Request

0x3024 NB-IoT BROADCAST DETECT Indication

0x3025 NB-IoT SYSTEM INFORMATION SCHEDULE Request

0x3026 NB-IoT SYSTEM INFORMATION Indication

0x3027 NB-IoT SYSTEM INFORMATION Request

0x3027 – 0x3039 Reserved

0x3040 5GNR RSSI Request Request

0x3041 5GNR CELL SEARCH Request

0x3042 5GNR CELL SEARCH Indication

0x3043 5GNR BROADCAST DETECT Request

0x3044 5GNR BROADCAST DETECT Indication

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 47
 Tag (Hex) Description

0x3045 5GNR SYSTEM INFORMATION SCHEDULE Request

0x3046 5GNR SYSTEM INFORMATION Request

0x3047 5GNR SYSTEM INFORMATION Indication

Table 2-66 nFAPI NMM (P4) tag values

2.4 Error codes

The list of possible error codes returned in either .response messages or

.indication messages is given in Table 2-67.

Value Error code Description

100 MSG_OK Message is OK.

101 MSG_INVALID_STATE The request was received when the PHY

was in the IDLE state, or in the RUNNING
state and this NMM PHY does not support
RUNNING state NMM, or another NMM
procedure was already in progress.

102 MSG_INVALID_CONFIG The request parameters provided has

missing mandatory TLVs, or TLVs that are
invalid or unsupported in this PHY state.

103 MSG_RAT_NOT_SUPPORTED The request was for a RAT not supported by

this NMM PHY instance.

200 MSG_NMM_STOP_OK The NMM [Link] caused an NMM

procedure to be stopped.

201 MSG_NMM_STOP_IGNORED The NMM [Link] was received when

no NMM procedure was in progress, so was
ignored.

202 MSG_NMM_STOP_INVALID_STAT The request was received when the PHY

E was in the IDLE state, or in the RUNNING
state and this NMM PHY does not support
RUNNING state NMM.

300 MSG_PROCEDURE_COMPLETE The requested procedure completed

normally and the results, if any, are
included in the indication.

301 MSG_PROCEDURE_STOPPED The requested procedure was stopped by an

NMM [Link] and the results so far
collected, if any, are included in the
indication.

302 MSG_PARTIAL_RESULTS The requested procedure has produced the

partial results included, but the procedure is
continuing and further indications will
follow.

303 MSG_TIMEOUT The procedure timed out, and partial or no

results are included in the indication.

Table 2-67 NMM error codes

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 48
3. Constants

Constant Usage Value

MAX_CARRIER_LIST Maximum number of carriers present in a single NMM 32

message

MAX_PCI_LIST Maximum number of cell PCIs present in a single NMM 32

message

MAX_PSC_LIST Maximum number of cells PSCs present in a single 32

NMM message

MAX_ARFCN_LIST Maximum number of ARFCN present in a single NMM 128

message

Table 3-1 Constants used for NMM message sizing

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 49
References
Ref. Title Number Version & Date
[1] SON API for Small Cells SCF083 083.05.01
[2] FAPI and nFAPI specifications (LTE) SCF082 082.09.05
[3] 5G FAPI: API API Specification SCF222 Add published
version
[4] 5G NRF FAPI P19 FrontEnd Interface SCF223 Add published
Specification version
[5] Small Cell SON and Orchestration from SCF233 233.10.01
4G to 5G
[6] 5G nFAPI specification - placeholder SCF225
[7] 3GPP Evolved Universal Terrestrial TS36.213 13.5.0
Radio Access (E-UTRA); Physical Layer
procedures
[8] 3GPP Base Station(BS) Radio TS36.104 13.7.0
Transmission and Reception
[9] 3GPP Evolved Universal Terrestrial TS36.212 13.5.0
Radio Access (E-UTRA); Multiplexing
and channel coding
[10] 3GPP Evolved Universal Terrestrial TS36.214 13.4.0
Radio Access (E-UTRA); Physical layer;
Measurements
[11] 3GPP GSM/EDGE Radio Access TS45.008 13.5.0
Network; Radio subsystem link control
[12] 3GPP Radio Access Network; Physical TS25.215 10.0.0
Layer Measurements (FDD)
[13] 3GPP NR Physical Channel and TS38.211 v15.5.0
Modulation
[14] 3GPP NR Multiplexing and Channel TS38.212 v15.5.0
Coding
[15] 3GPP NR Physical Layer Procedures for TS38.213 v15.5.0
Control
[16] 3GPP NR Physical Layer Procedures for TS38.214 v15.5.0
Data
[17] 3GPP NR Radio Resource Control TS38.331 v15.5.0
(RRC) protocol specification
[18] 3GPP NR Base Station (BS) radio TS38.104 v15.5.0
transmission and reception

Report title: 5G FAPI: Network Monitor Mode API

Issue date: 23 March 2020
Version: 1.0.0 50