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