ntsimulator/yang/o-ran-ecpri-delay.yang

   1 module o-ran-ecpri-delay {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:message5:1.0";
   4   prefix "o-ran-msg5";
   5
   6   import o-ran-processing-element {
   7     prefix "element";
   8   }
   9
  10   organization "O-RAN Alliance";
  11
  12   contact
  13     "www.o-ran.org";
  14
  15   description
  16     "This module is an optional module for supporting eCPRI message 5 handling
  17     used for eCPRI based delay measurements.
  18
  19     Copyright 2019 the O-RAN Alliance.
  20
  21     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  22     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31     POSSIBILITY OF SUCH DAMAGE.
  32
  33     Redistribution and use in source and binary forms, with or without
  34     modification, are permitted provided that the following conditions are met:
  35
  36     * Redistributions of source code must retain the above copyright notice,
  37     this list of conditions and the above disclaimer.
  38     * Redistributions in binary form must reproduce the above copyright notice,
  39     this list of conditions and the above disclaimer in the documentation
  40     and/or other materials provided with the distribution.
  41     * Neither the Members of the O-RAN Alliance nor the names of its
  42     contributors may be used to endorse or promote products derived from
  43     this software without specific prior written permission.";
  44
  45   revision "2019-02-04" {
  46     description
  47       "version 1.0.0
  48
  49       1) imported model from xRAN
  50       2) changed namespace and reference from xran to o-ran";
  51
  52     reference "ORAN-WG4.M.0-v01.00";
  53   }
  54
  55 // groupings
  56
  57   grouping msg5-group {
  58
  59     container ru-compensation {
  60       config false;
  61       description
  62         "leafs for ru timing compensation based on message 5 handling";
  63       leaf tcv2 {
  64         type uint32;
  65         units nanoseconds;
  66         description
  67           "a compensation value to account for expected delay from packet
  68           receipt at R2 to timestamping in the O-RU";
  69       }
  70       leaf tcv1 {
  71         type uint32;
  72         units nanoseconds;
  73         description
  74           "a compensation value to account for expected processing time from
  75           timestamping in the O-RU until actual packet transmission at R3";
  76       }
  77     }
  78
  79     leaf enable-message5 {
  80       type boolean;
  81       default false;
  82       description
  83         "whether O-RU's eCPRI message 5 handling is enabled.";
  84     }
  85
  86     container message5-sessions {
  87       description "session information for eCPRI message 5";
  88
  89       list session-parameters {
  90         key "session-id";
  91         description "list of MSG5 session information";
  92         leaf session-id {
  93           type uint32;
  94           description "Session ID for MSG5 responder";
  95         }
  96         leaf processing-element-name {
  97           type leafref {
  98             path "/element:processing-elements/element:ru-elements/element:name";
  99           }
 100           description "the name of the processing element used for MSG5";
 101         }
 102         container flow-state {
 103           config false;
 104           description "MSG5 flow state";
 105           leaf responses-transmitted {
 106             type uint32;
 107             description
 108               "The total number of eCPRI mesage 5 response messages transmitted by
 109               the O-RU.";
 110           }
 111           leaf requests-transmitted {
 112             type uint32;
 113             description
 114               "The total number of eCPRI mesage 5 request messages transmitted by
 115               the O-RU.";
 116           }
 117           leaf followups-transmitted {
 118             type uint32;
 119             description
 120               "The total number of eCPRI mesage 5 follow up messages transmitted by
 121               the O-RU.";
 122           }
 123         }
 124       }
 125     }
 126   }
 127
 128 // top level container
 129
 130   container ecpri-delay-message {
 131     description "top level tree covering off O-DU to O-RU msg5 delay measurement";
 132
 133     uses msg5-group;
 134   }
 135 }