Fix licensing issues
[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 syntax = "proto3";
19 package entities;
20
21 import "enb.proto";
22
23 // 9.1.2.1
24 message RanLoadInformation {
25     uint64 load_timestamp = 1;
26     repeated CellLoadInformation cell_load_infos = 2;
27 }
28
29 message CellLoadInformation {
30     string cell_id = 1;
31     repeated UlInterferenceOverloadIndication ul_interference_overload_indications = 2;
32     repeated UlHighInterferenceInformation ul_high_interference_infos = 3;
33     RelativeNarrowbandTxPower relative_narrowband_tx_power = 4;
34     AbsInformation abs_information = 5;
35     InvokeIndication invoke_indication = 6;
36     SubframeAssignment intended_ul_dl_configuration = 7; // TODO: import type
37     ExtendedUlInterferenceOverloadInfo extended_ul_interference_overload_info = 8;
38     CompInformation comp_information = 9;
39     DynamicDlTransmissionInformation dynamic_dl_transmission_information = 10;
40 }
41
42 // 9.2.17
43 enum UlInterferenceOverloadIndication {
44     UNKNOWN_UL_INTERFERENCE_OVERLOAD_INDICATION = 0;
45     HIGH_INTERFERENCE = 1;
46     MEDIUM_INTERFERENCE = 2;
47     LOW_INTERFERENCE = 3;
48 }
49
50 // 9.2.18
51 message UlHighInterferenceInformation {
52     string target_cell_id = 1;
53     string ul_high_interference_indication = 2;
54 }
55
56 // 9.2.19
57 message RelativeNarrowbandTxPower {
58     string rntp_per_prb = 1;
59     RntpThreshold rntp_threshold = 2;
60     NumberOfCellSpecificAntennaPorts number_of_cell_specific_antenna_ports = 3;
61     uint32 p_b = 4;
62     uint32 pdcch_interference_impact = 5;
63     EnhancedRntp enhanced_rntp = 6;
64 }
65
66 enum RntpThreshold {
67     UNKNOWN_RNTP_THRESHOLD = 0;
68     NEG_INFINITY = 1;
69     NEG_11 = 2;
70     NEG_10 = 3;
71     NEG_9 = 4;
72     NEG_8 = 5;
73     NEG_7 = 6;
74     NEG_6 = 7;
75     NEG_5 = 8;
76     NEG_4 = 9;
77     NEG_3 = 10;
78     NEG_2 = 11;
79     NEG_1 = 12;
80     V0 = 13;
81     V1 = 14;
82     V2 = 15;
83     V3 = 16;
84 }
85
86 enum NumberOfCellSpecificAntennaPorts {
87     UNKNOWN_NUMBER_OF_CELL_SPECIFIC_ANTENNA_PORTS = 0;
88     V1_ANT_PRT = 1;
89     V2_ANT_PRT = 2;
90     V4_ANT_PRT = 4;
91 }
92
93 message EnhancedRntp {
94     string enhanced_rntp_bitmap = 1;
95     RntpThreshold rntp_high_power_threshold = 2;
96     StartTime enhanced_rntp_start_time = 3;
97 }
98
99 message StartTime {
100     int32 start_sfn = 1;
101     int32 start_subframe_number = 2;
102 }
103
104 enum AbsInformationMode {
105     UNKNOWN_ABS_INFORMATION_MODE = 0;
106     ABS_INFO_FDD = 1;
107     ABS_INFO_TDD = 2;
108     ABS_INACTIVE = 3;
109 }
110
111 // 9.2.54
112 message AbsInformation {
113     AbsInformationMode mode = 1;
114     string abs_pattern_info = 2;
115     NumberOfCellSpecificAntennaPorts number_of_cell_specific_antenna_ports = 3;
116     string measurement_subset = 4;
117 }
118
119 // 9.2.55
120 enum InvokeIndication {
121     UNKNOWN_INVOKE_INDICATION = 0;
122     ABS_INFORMATION = 1;
123     START_NAICS_INFORMATION = 2;
124     STOP_NAICS_INFORMATION = 3;
125 }
126
127 // 9.2.67
128 message ExtendedUlInterferenceOverloadInfo {
129     string associated_subframes = 1;
130     repeated UlInterferenceOverloadIndication extended_ul_interference_overload_indications = 2;
131 }
132
133 // 9.2.74
134 message CompInformation {
135     repeated CompInformationItem comp_information_items = 1;
136     StartTime comp_information_start_time = 2;
137 }
138
139 message CompInformationItem {
140     repeated CompHypothesisSet comp_hypothesis_sets = 1;
141     int32 benefit_metric = 2;
142 }
143
144 message CompHypothesisSet {
145     string cell_id = 1;
146     string comp_hypothesis = 2;
147 }
148
149 enum NaicsState {
150     UNKNOWN_NAICS_STATE = 0;
151     NAICS_ACTIVE = 1;
152     NAICS_INACTIVE = 2;
153 }
154
155 // 9.2.77
156 message DynamicDlTransmissionInformation {
157     NaicsState state = 1;
158     string transmission_modes = 2;
159     uint32 p_b = 3;
160     repeated PA p_a_list = 4;
161 }
162
163 enum PA {
164     UNKNOWN_PA = 0;
165     DB_NEG_6 = 1;
166     DB_NEG_4_DOT_77 = 2;
167     DB_NEG_3 = 3;
168     DB_NEG_1_DOT_77 = 4;
169     DB_0 = 5;
170     DB_1 = 6;
171     DB_2 = 7;
172     DB_3 = 8;
173 }