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