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