ntsimulator/yang/x-ran/xran-ald.yang

   1 module xran-ald {
   2   yang-version 1.1;
   3   namespace "urn:xran:ald:1.0";
   4   prefix "xran-ald";
   5
   6   import xran-ald-port {
   7     prefix "ap";
   8   }
   9
  10   organization "xRAN Alliance";
  11
  12   contact
  13     "www.xran.org";
  14
  15   description
  16     "This module defines the module for the ald communication.
  17
  18     Copyright 2018 the xRAN Forum.
  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 xRAN Forum 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 "2018-07-20" {
  45     description
  46       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  47
  48       This version of the model supports v01.00 of the corrsponding xRAN
  49       M-Plane Specification.";
  50     reference "XRAN-FH.MP.0-v01.00";
  51   }
  52
  53   // rpc-statements
  54   rpc ald-communication {
  55     description
  56       "Rpc to support communication between lls-CU and Antenna Line Devices";
  57
  58         input {
  59       leaf port-id {
  60             type leafref {
  61                   path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  62                 }
  63         mandatory true;
  64         description
  65           "Unique ALD port identifier reported by radio";
  66       }
  67
  68           leaf ald-req-msg {
  69             type binary {
  70                   length "0..1200";
  71                 }
  72
  73                 description
  74                   "Response message to be forwarded to ALD in type of binary-string";
  75           }
  76     }
  77
  78         output {
  79       leaf port-id {
  80             type leafref {
  81                   path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  82                 }
  83         mandatory true;
  84         description
  85           "Unique ALD port identifier reported by radio";
  86       }
  87
  88       leaf status {
  89         type enumeration {
  90           enum ACCEPTED {
  91                     description
  92                           "Operation was accepted, message was processed towards ALD and response is provided";
  93                   }
  94           enum REJECTED {
  95                     description
  96                           "Operation was rejected by RU";
  97                   }
  98         }
  99         mandatory true;
 100
 101         description
 102                   "Status of RPC handling seen from RU perspective";
 103       }
 104
 105       leaf error-message {
 106         when "../status='REJECTED'";
 107         type string;
 108
 109                 description
 110                   "Detailed error message when the status is rejected. E.g. wrong ALD port identifier was used in RPC received from Netconf Client";
 111       }
 112
 113           leaf ald-resp-msg {
 114             type binary {
 115                   length "0..1200";
 116                 }
 117
 118                 description
 119                   "Response message forwarded from ALD in type of binary-string";
 120           }
 121
 122           leaf frames-with-wrong-crc {
 123             type uint32;
 124
 125                 description
 126                   "Number of frames with incorrect CRC (FCS) received from ALD - running counter";
 127           }
 128
 129           leaf frames-without-stop-flag {
 130             type uint32;
 131
 132                 description
 133                   "Number of frames without stop flag received from ALD - running counter";
 134           }
 135
 136           leaf number-of-received-octets {
 137             type uint32;
 138
 139                 description
 140                   "Number of octets received from HDLC bus - running counter";
 141           }
 142     }
 143   }
 144 }