entities/ran_function.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 RanFunction {
  28     uint32 ran_function_id = 1;
  29     RanFunctionDefinition ran_function_definition = 2;
  30     uint32 ran_function_revision = 3;
  31 }
  32
  33 message RanFunctionDefinition {
  34     E2smGnbNrtRanFunctionDefinition e2sm_gnb_nrt_ran_function_definition = 1;
  35 }
  36
  37 message E2smGnbNrtRanFunctionDefinition {
  38     RanFunctionName ran_function_name = 1;
  39     repeated RicEventTriggerStyle ric_event_trigger_styles = 2;
  40     repeated RicReportStyle ric_report_styles = 3;
  41     repeated RicInsertStyle ric_insert_styles = 4;
  42     repeated RicControlStyle ric_control_styles = 5;
  43     repeated RicPolicyStyle ric_policy_styles = 6;
  44 }
  45
  46 message RanFunctionName {
  47     string ran_function_short_name = 1;
  48     string ran_function_e2sm_oid = 2;
  49     string ran_function_description = 3;
  50     oneof optional_ran_function_instance {
  51         uint32 ran_function_instance = 4;
  52     }
  53 }
  54
  55 message RicEventTriggerStyle {
  56     uint32 ric_event_trigger_style_type = 1;
  57     string ric_event_trigger_style_name = 2;
  58     uint32 ric_event_trigger_format_type = 3;
  59 }
  60
  61 enum RanParameterType {
  62     UNKNOWN_RAN_PARAMETER_TYPE = 0;
  63     INTEGER = 1;
  64     ENUMERATED = 2;
  65     BOOLEAN = 3;
  66     BIT_STRING = 4;
  67     OCTET_STRING = 5;
  68     PRINTABLE_STRING = 6;
  69 }
  70
  71 message RanParameterDef {
  72     uint32 ran_parameter_id = 1;
  73     string ran_parameter_name = 2;
  74     RanParameterType ran_parameter_type = 3;
  75 }
  76
  77 message RicReportStyle {
  78     uint32 ric_report_style_type = 1;
  79     string ric_report_style_name = 2;
  80     uint32 ric_report_action_format_type = 3;
  81     repeated RanParameterDef ric_report_ran_parameter_defs = 4;
  82     uint32 ric_indication_header_format_type = 5;
  83     uint32 ric_indication_message_format_type = 6;
  84 }
  85
  86
  87 message RicInsertStyle {
  88     uint32 ric_insert_style_type = 1;
  89     string ric_insert_style_name = 2;
  90     uint32 ric_insert_action_format_type = 3;
  91     repeated RanParameterDef ric_insert_ran_parameter_defs = 4;
  92     uint32 ric_indication_header_format_type = 5;
  93     uint32 ric_indication_message_format_type = 6;
  94     uint32 ric_call_process_id_format_type = 7;
  95 }
  96
  97 message RicControlStyle {
  98     uint32 ric_control_style_type = 1;
  99     string ric_control_style_name = 2;
 100     uint32 ric_control_header_format_type = 3;
 101     uint32 ric_control_message_format_type = 4;
 102     uint32 ric_call_process_id_format_type = 5;
 103 }
 104
 105 message RicPolicyStyle {
 106     uint32 ric_policy_style_type = 1;
 107     string ric_policy_style_name = 2;
 108     uint32 ric_policy_action_format_type = 3;
 109     repeated RanParameterDef ric_policy_ran_parameter_defs = 4;
 110 }