ntsimulator/yang/o-ran/ru-fh/o-ran-ald.yang

   1 module o-ran-ald {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:ald:1.0";
   4   prefix "o-ran-ald";
   5
   6   import o-ran-ald-port {
   7     prefix "ap";
   8   }
   9
  10   organization "O-RAN Alliance";
  11
  12   contact
  13     "www.o-ran.org";
  14
  15   description
  16     "This module defines the module for the ald communication.
  17
  18     Copyright 2019 the O-RAN Alliance.
  19
  20     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  21     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  24     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30     POSSIBILITY OF SUCH DAMAGE.
  31
  32     Redistribution and use in source and binary forms, with or without
  33     modification, are permitted provided that the following conditions are met:
  34
  35     * Redistributions of source code must retain the above copyright notice,
  36     this list of conditions and the above disclaimer.
  37     * Redistributions in binary form must reproduce the above copyright notice,
  38     this list of conditions and the above disclaimer in the documentation
  39     and/or other materials provided with the distribution.
  40     * Neither the Members of the O-RAN Alliance nor the names of its
  41     contributors may be used to endorse or promote products derived from
  42     this software without specific prior written permission.";
  43
  44   revision "2019-03-07" {
  45     description
  46       "version 1.0.1
  47
  48       1) backward compatible changes to introduce groupings.";
  49
  50     reference "ORAN-WG4.M.0-v01.00";
  51   }
  52
  53   revision "2019-02-04" {
  54     description
  55       "version 1.0.0
  56
  57       1) imported model from xRAN
  58       2) changed namespace and reference from xran to o-ran";
  59
  60     reference "ORAN-WG4.M.0-v01.00";
  61   }
  62
  63   grouping ald-input {
  64     leaf port-id {
  65       type leafref {
  66         path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  67       }
  68       mandatory true;
  69       description
  70         "Unique ALD port identifier reported by radio";
  71     }
  72
  73     leaf ald-req-msg {
  74       type binary {
  75         length "0..1200";
  76       }
  77
  78       description
  79         "Response message to be forwarded to ALD in type of binary-string";
  80     }
  81   }
  82
  83   grouping ald-output {
  84     leaf port-id {
  85       type leafref {
  86         path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  87       }
  88       mandatory true;
  89       description
  90         "Unique ALD port identifier reported by radio";
  91     }
  92
  93     leaf status {
  94       type enumeration {
  95         enum ACCEPTED {
  96           description
  97             "Operation was accepted, message was processed towards ALD and response is provided";
  98         }
  99         enum REJECTED {
 100           description
 101             "Operation was rejected by O-RU";
 102         }
 103       }
 104       mandatory true;
 105
 106       description
 107         "Status of RPC handling seen from equipment perspective";
 108     }
 109
 110     leaf error-message {
 111       when "../status='REJECTED'";
 112       type string;
 113
 114       description
 115         "Detailed error message when the status is rejected. E.g. wrong ALD port identifier was used in RPC received from Netconf Client";
 116     }
 117
 118     leaf ald-resp-msg {
 119       type binary {
 120         length "0..1200";
 121       }
 122
 123       description
 124         "Response message forwarded from ALD in type of binary-string";
 125     }
 126
 127     leaf frames-with-wrong-crc {
 128       type uint32;
 129
 130       description
 131         "Number of frames with incorrect CRC (FCS) received from ALD - running counter";
 132     }
 133
 134     leaf frames-without-stop-flag {
 135       type uint32;
 136
 137       description
 138         "Number of frames without stop flag received from ALD - running counter";
 139     }
 140
 141     leaf number-of-received-octets {
 142       type uint32;
 143
 144       description
 145         "Number of octets received from HDLC bus - running counter";
 146     }
 147   }
 148   // rpc-statements
 149   rpc ald-communication {
 150     description
 151       "Rpc to support communication between O-DU and Antenna Line Devices";
 152
 153     input {
 154       uses ald-input;
 155     }
 156
 157     output {
 158       uses ald-output;
 159     }
 160   }
 161 }