ntsimulator/yang/x-ran/xran-ecpri-delay.yang

   1 module xran-ecpri-delay {
   2   yang-version 1.1;
   3   namespace "urn:xran:message5:1.0";
   4   prefix "xran-msg5";
   5
   6   import xran-processing-element {
   7     prefix "element";
   8   }
   9
  10   organization "xRAN Forum";
  11
  12   contact
  13     "www.xran.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 2018 the xRAN Forum.
  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 xRAN Forum 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 "2018-07-20" {
  46     description
  47       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  48
  49       This version of the model supports v01.00 of the corrsponding xRAN
  50       M-Plane Specification.";
  51     reference "XRAN-FH.MP.0-v01.00";
  52   }
  53
  54   container ecpri-delay-message {
  55     description "top level tree covering off lls-CU to RU msg5 delay measurement";
  56
  57     container ru-compensation {
  58       config false;
  59       description
  60         "leafs for ru timing compensation based on message 5 handling";
  61       leaf tcv2 {
  62         type uint32;
  63         units nanoseconds;
  64         description
  65           "a compensation value to account for expected delay from packet
  66           receipt at R2 to timestamping in the RU";
  67       }
  68       leaf tcv1 {
  69         type uint32;
  70         units nanoseconds;
  71         description
  72           "a compensation value to account for expected processing time from
  73           timestamping in the RU until actual packet transmission at R3";
  74       }
  75     }
  76
  77     leaf enable-message5 {
  78       type boolean;
  79       default false;
  80       description
  81         "whether RU's eCPRI message 5 handling is enabled.";
  82     }
  83
  84     container message5-sessions {
  85       description "session information for eCPRI message 5";
  86
  87       list session-parameters {
  88         key "session-id";
  89         description "list of MSG5 session information";
  90         leaf session-id {
  91           type uint32;
  92           description "Session ID for MSG5 responder";
  93         }
  94         leaf processing-element-name {
  95           type leafref {
  96             path "/element:processing-elements/element:ru-elements/element:name";
  97           }
  98           description "the name of the processing element used for MSG5";
  99         }
 100         container flow-state {
 101           config false;
 102           description "MSG5 flow state";
 103           leaf responses-transmitted {
 104             type uint32;
 105             description
 106               "The total number of eCPRI mesage 5 response messages transmitted by
 107               the RU.";
 108           }
 109           leaf requests-transmitted {
 110             type uint32;
 111             description
 112               "The total number of eCPRI mesage 5 request messages transmitted by
 113               the RU.";
 114           }
 115           leaf followups-transmitted {
 116             type uint32;
 117             description
 118               "The total number of eCPRI mesage 5 follow up messages transmitted by
 119               the RU.";
 120           }
 121         }
 122       }
 123     }
 124   }
 125 }