Merge "RICPLT-2707 - Create RNIB reader in C"
[ric-plt/nodeb-rnib.git] / entities / ran_load_information.proto
1 /*
2  * Copyright 2019 AT&T Intellectual Property
3  * Copyright 2019 Nokia
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /*
19  * This source code is part of the near-RT RIC (RAN Intelligent Controller)
20  * platform project (RICP).
21  */
22
23
24 syntax = "proto3";
25 package entities;
26
27 import "enb.proto";
28
29 // 9.1.2.1
30 message RanLoadInformation {
31     uint64 load_timestamp = 1;
32     repeated CellLoadInformation cell_load_infos = 2;
33 }
34
35 message CellLoadInformation {
36     string cell_id = 1;
37     repeated UlInterferenceOverloadIndication ul_interference_overload_indications = 2;
38     repeated UlHighInterferenceInformation ul_high_interference_infos = 3;
39     RelativeNarrowbandTxPower relative_narrowband_tx_power = 4;
40     AbsInformation abs_information = 5;
41     InvokeIndication invoke_indication = 6;
42     SubframeAssignment intended_ul_dl_configuration = 7; // TODO: import type
43     ExtendedUlInterferenceOverloadInfo extended_ul_interference_overload_info = 8;
44     CompInformation comp_information = 9;
45     DynamicDlTransmissionInformation dynamic_dl_transmission_information = 10;
46 }
47
48 // 9.2.17
49 enum UlInterferenceOverloadIndication {
50     UNKNOWN_UL_INTERFERENCE_OVERLOAD_INDICATION = 0;
51     HIGH_INTERFERENCE = 1;
52     MEDIUM_INTERFERENCE = 2;
53     LOW_INTERFERENCE = 3;
54 }
55
56 // 9.2.18
57 message UlHighInterferenceInformation {
58     string target_cell_id = 1;
59     string ul_high_interference_indication = 2;
60 }
61
62 // 9.2.19
63 message RelativeNarrowbandTxPower {
64     string rntp_per_prb = 1;
65     RntpThreshold rntp_threshold = 2;
66     NumberOfCellSpecificAntennaPorts number_of_cell_specific_antenna_ports = 3;
67     uint32 p_b = 4;
68     uint32 pdcch_interference_impact = 5;
69     EnhancedRntp enhanced_rntp = 6;
70 }
71
72 enum RntpThreshold {
73     UNKNOWN_RNTP_THRESHOLD = 0;
74     NEG_INFINITY = 1;
75     NEG_11 = 2;
76     NEG_10 = 3;
77     NEG_9 = 4;
78     NEG_8 = 5;
79     NEG_7 = 6;
80     NEG_6 = 7;
81     NEG_5 = 8;
82     NEG_4 = 9;
83     NEG_3 = 10;
84     NEG_2 = 11;
85     NEG_1 = 12;
86     V0 = 13;
87     V1 = 14;
88     V2 = 15;
89     V3 = 16;
90 }
91
92 enum NumberOfCellSpecificAntennaPorts {
93     UNKNOWN_NUMBER_OF_CELL_SPECIFIC_ANTENNA_PORTS = 0;
94     V1_ANT_PRT = 1;
95     V2_ANT_PRT = 2;
96     V4_ANT_PRT = 4;
97 }
98
99 message EnhancedRntp {
100     string enhanced_rntp_bitmap = 1;
101     RntpThreshold rntp_high_power_threshold = 2;
102     StartTime enhanced_rntp_start_time = 3;
103 }
104
105 message StartTime {
106     int32 start_sfn = 1;
107     int32 start_subframe_number = 2;
108 }
109
110 enum AbsInformationMode {
111     UNKNOWN_ABS_INFORMATION_MODE = 0;
112     ABS_INFO_FDD = 1;
113     ABS_INFO_TDD = 2;
114     ABS_INACTIVE = 3;
115 }
116
117 // 9.2.54
118 message AbsInformation {
119     AbsInformationMode mode = 1;
120     string abs_pattern_info = 2;
121     NumberOfCellSpecificAntennaPorts number_of_cell_specific_antenna_ports = 3;
122     string measurement_subset = 4;
123 }
124
125 // 9.2.55
126 enum InvokeIndication {
127     UNKNOWN_INVOKE_INDICATION = 0;
128     ABS_INFORMATION = 1;
129     START_NAICS_INFORMATION = 2;
130     STOP_NAICS_INFORMATION = 3;
131 }
132
133 // 9.2.67
134 message ExtendedUlInterferenceOverloadInfo {
135     string associated_subframes = 1;
136     repeated UlInterferenceOverloadIndication extended_ul_interference_overload_indications = 2;
137 }
138
139 // 9.2.74
140 message CompInformation {
141     repeated CompInformationItem comp_information_items = 1;
142     StartTime comp_information_start_time = 2;
143 }
144
145 message CompInformationItem {
146     repeated CompHypothesisSet comp_hypothesis_sets = 1;
147     int32 benefit_metric = 2;
148 }
149
150 message CompHypothesisSet {
151     string cell_id = 1;
152     string comp_hypothesis = 2;
153 }
154
155 enum NaicsState {
156     UNKNOWN_NAICS_STATE = 0;
157     NAICS_ACTIVE = 1;
158     NAICS_INACTIVE = 2;
159 }
160
161 // 9.2.77
162 message DynamicDlTransmissionInformation {
163     NaicsState state = 1;
164     string transmission_modes = 2;
165     uint32 p_b = 3;
166     repeated PA p_a_list = 4;
167 }
168
169 enum PA {
170     UNKNOWN_PA = 0;
171     DB_NEG_6 = 1;
172     DB_NEG_4_DOT_77 = 2;
173     DB_NEG_3 = 3;
174     DB_NEG_1_DOT_77 = 4;
175     DB_0 = 5;
176     DB_1 = 6;
177     DB_2 = 7;
178     DB_3 = 8;
179 }