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