Adding RESET connection status for E2 Reset
[ric-plt/nodeb-rnib.git] / entities / enb.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 "additional_cell_information.proto";
28 import "e2node_component_config.proto";
29 import "nb_types.proto";
30 option go_package = "gerrit.o-ran-sc.org/r/ric-plt/nodeb-rnib/entities";
31
32 message Enb{
33         EnbType enb_type = 1;
34         repeated ServedCellInfo served_cells = 2;
35         repeated string gu_group_ids = 3;
36         repeated E2nodeComponentConfig node_configs = 4;
37 }
38
39 message ServedCellInfo{
40         uint32 pci = 1;
41         string cell_id = 2;
42         string tac      = 3;
43         repeated string broadcast_plmns = 4;
44         ChoiceEUTRAMode choice_eutra_mode = 5;
45         Eutra.Mode eutra_mode = 6;
46         NumberOfAntennaPorts number_of_antenna_ports = 7;
47         PrachConfiguration prach_configuration = 8;
48         repeated MbsfnSubframe mbsfn_subframe_infos = 9;
49         string csg_id = 10;
50         repeated string mbms_service_area_identities = 11;
51         repeated uint32 multiband_infos = 12;
52         FreqBandIndicatorPriority freq_band_indicator_priority = 13;
53         BandwidthReducedSI bandwidth_reduced_si = 14;
54         repeated NeighbourInformation neighbour_infos = 15;
55         AdditionalCellInformation additional_cell_information = 16;
56 }
57
58 message ChoiceEUTRAMode{
59                 FddInfo fdd  = 1;
60                 TddInfo tdd  = 2;
61 }
62
63 message Eutra{
64         enum Mode{
65                 UNKNOWN = 0;
66                 FDD = 1;
67                 TDD = 2;
68         }
69 }
70
71 message NeighbourInformation{
72         string ecgi = 1;
73         uint32 pci = 2;
74         uint32 ear_fcn = 3;
75         string tac = 4;
76 }
77
78 enum FreqBandIndicatorPriority{
79         UNKNOWN_FREQ_BAND_INDICATOR_PRIORITY = 0;
80         NOT_BROADCASTED = 1;
81         BROADCASTED = 2;
82 }
83
84 enum BandwidthReducedSI{
85         UNKNOWN_BANDWIDTH_REDUCED_SI = 0;
86         SCHEDULED = 1;
87 }
88
89 message MbsfnSubframe{
90         RadioframeAllocationPeriod      radioframe_allocation_period = 1;
91         uint32 radioframe_allocation_offset = 2;
92         string subframe_allocation = 3;
93         SubframeAllocationType subframe_allocation_type = 4;
94 }
95
96 enum SubframeAllocationType{
97         UNKNOWN_SUBFRAME_ALLOCATION_TYPE = 0;
98         ONE_FRAME = 1;
99         FOUR_FRAME = 2;
100 }
101
102 enum RadioframeAllocationPeriod{
103         UNKNOWN_RADIOFRAME_ALLOCATION_PERIOD = 0;
104         N1 = 1;
105         N2 = 2;
106         N4 = 3;
107         N8 = 4;
108         N16 = 5;
109         N32 = 6;
110 }
111 message PrachConfiguration{
112         uint32 root_sequence_index = 1;
113         uint32 zero_correlation_zone_configuration      = 2;
114         bool high_speed_flag = 3;
115         uint32 prach_frequency_offset = 4;
116         uint32 prach_configuration_index = 5;
117 }
118
119 enum NumberOfAntennaPorts{
120         UNKNOWN_NUMBER_OF_ANTENNA_PORTS = 0;
121         AN1 = 1;
122         AN2 = 2;
123         AN4 = 3;
124 }
125
126 message TddInfo{
127         uint32 ear_fcn = 1;
128         TransmissionBandwidth transmission_bandwidth = 2;
129         SubframeAssignment subframe_assignment = 3;
130         SpecialSubframeInfo special_subframe_info = 4;
131         AdditionalSpecialSubframeInfo additional_special_subframe_info = 5;
132         AdditionalSpecialSubframeExtensionInfo additional_special_subframe_extension_info = 6;
133 }
134
135 message AdditionalSpecialSubframeExtensionInfo{
136         AdditionalSpecialSubframePatterns.Extension additional_special_subframe_patterns_extension = 1;
137         CyclicPrefix cyclic_prefix_dl = 2;
138         CyclicPrefix cyclic_prefix_ul = 3;
139 }
140
141 message AdditionalSpecialSubframeInfo{
142         AdditionalSpecialSubframe.Patterns additional_special_subframe_patterns = 1;
143         CyclicPrefix cyclic_prefix_dl = 2;
144         CyclicPrefix cyclic_prefix_ul = 3;
145 }
146
147 message FddInfo{
148         uint32 ulear_fcn = 1;
149         uint32 dlear_fcn = 2;
150         TransmissionBandwidth ul_transmission_bandwidth = 3;
151         TransmissionBandwidth dl_transmission_bandwidth = 4;
152 }
153
154 message SpecialSubframeInfo{
155         SpecialSubframe.Patterns special_subframe_patterns = 1;
156         CyclicPrefix cyclic_prefix_dl = 2;
157         CyclicPrefix cyclic_prefix_ul = 3;
158 }
159
160 enum SubframeAssignment{
161         UNKNOWN_SUBFRAME_ASSIGNMENT = 0;
162         SA0 = 1;
163         SA1 = 2;
164         SA2 = 3;
165         SA3 = 4;
166         SA4 = 5;
167         SA5 = 6;
168         SA6 = 7;
169 }
170
171 enum CyclicPrefix{
172         UNKNOWN_CYCLIC_PREFIX = 0;
173         NORMAL = 1;
174         EXTENDED = 2;
175 }
176
177 message SpecialSubframe{
178 enum Patterns{
179         UNKNOWN = 0;
180         SSP0 = 1;
181         SSP1 = 2;
182         SSP2 = 3;
183         SSP3 = 4;
184         SSP4 = 5;
185         SSP5 = 6;
186         SSP6 = 7;
187         SSP7 = 8;
188         SSP8 = 9;
189 }
190 }
191
192 message AdditionalSpecialSubframe{ 
193         enum Patterns{
194                 UNKNOWN = 0;
195                 SSP0 = 1;
196                 SSP1 = 2;
197                 SSP2 = 3;
198                 SSP3 = 4;
199                 SSP4 = 5;
200                 SSP5 = 6;
201                 SSP6 = 7;
202                 SSP7 = 8;
203                 SSP8 = 9;
204                 SSP9 = 10;
205         }
206 }
207
208 message AdditionalSpecialSubframePatterns{
209         enum Extension{
210                 UNKNOWN = 0;
211                 SSP10 = 1;
212         }
213 }
214
215 enum TransmissionBandwidth{
216         UNKNOWN_TRANSMISSION_BANDWIDTH = 0;
217         BW6 = 1;
218         BW15 = 2;
219         BW25 = 3;
220         BW50 = 4;
221         BW75 = 5;
222         BW100 = 6;
223         BW1 = 7;
224 }
225