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

   1 module xran-ald-port {
   2   yang-version 1.1;
   3   namespace "urn:xran:ald-port:1.0";
   4   prefix "xran-ald-port";
   5
   6   organization "xRAN Forum";
   7
   8   contact
   9     "www.xran.org";
  10
  11   description
  12     "This module defines the input state and output configuration for
  13     the xRAN Radio Unit Antenna Line Device capability.
  14
  15     Copyright 2018 the xRAN Forum.
  16
  17     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  18     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  21     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27     POSSIBILITY OF SUCH DAMAGE.
  28
  29     Redistribution and use in source and binary forms, with or without
  30     modification, are permitted provided that the following conditions are met:
  31
  32     * Redistributions of source code must retain the above copyright notice,
  33     this list of conditions and the above disclaimer.
  34     * Redistributions in binary form must reproduce the above copyright notice,
  35     this list of conditions and the above disclaimer in the documentation
  36     and/or other materials provided with the distribution.
  37     * Neither the Members of the xRAN Forum nor the names of its
  38     contributors may be used to endorse or promote products derived from
  39     this software without specific prior written permission.";
  40
  41   revision "2018-07-20" {
  42     description
  43       "version 1.0.0 - First release of the xRAN YANG M-Plane models.
  44
  45       This version of the model supports v01.00 of the corrsponding xRAN
  46       M-Plane Specification.";
  47     reference "XRAN-FH.MP.0-v01.00";
  48   }
  49
  50   feature OVERCURRENT-SUPPORTED {
  51     description
  52       "This feature indicates that the RU supports the over-current notification
  53       capability.";
  54   }
  55
  56   container ald-ports-io {
  57     description
  58       "ALD port information.
  59        ALD port of the RU that can be used to connect External Equipment (Antenna Line Devices).
  60        Communication uses AISG over HDLC.
  61        Physical connection depends on connector type offered by the port (RS-485 or antenna line)
  62        Note: Single instance of ALD Port can point to more than one antenna line devices.";
  63
  64     leaf over-current-supported {
  65       type boolean;
  66       default false;
  67       description
  68             "Set to TRUE when the RU supports over curent notifications";
  69     }
  70
  71     list ald-port {
  72       key "name";
  73       description
  74         "Leaf nodes describing ALD Port";
  75       leaf name {
  76         type string {
  77           length "1..255";
  78         }
  79         description
  80           "A name that is unique across the RU that identifies a ald port instance.
  81           This name may be used in fault management to refer to a fault source
  82           or affected object";
  83       }
  84
  85       leaf port-id {
  86         type uint8;
  87                     config false;
  88                     mandatory true;
  89
  90                     description
  91           "A number which identifies an ALD Port.
  92           The number of the Physical ALD port connector in the module.
  93           If the module supports 2 ALD Port connectors, use 0 and 1.";
  94       }
  95
  96       leaf dc-control-support{
  97         type boolean;
  98         config false;
  99                     mandatory true;
 100
 101                     description
 102           "It is shown that on/off in the DC power supply is possible.
 103           In case of False, power supply is always on.";
 104       }
 105
 106       leaf dc-enabled{
 107                     when "./../dc-control-support = 'true'";
 108         type boolean;
 109
 110                     description
 111           "If dc-control-support is true case, this leaf is effective.
 112           In case of true, the power supply is turned on.";
 113       }
 114
 115       leaf supported-connector{
 116         type enumeration {
 117                       enum ANTENNA_CONNECTOR {
 118                         description
 119                                 "This ald port is related to antenna connector";
 120                       }
 121                       enum RS485_PORT {
 122                         description
 123                                 "This ald port is related to RS485 port";
 124                       }
 125                     }
 126         config false;
 127                     mandatory true;
 128
 129                     description
 130           "Informs about the connectors of Module which ALDs are connected to.
 131           This value is depending on HW design.";
 132       }
 133     }
 134   }
 135
 136   notification overcurrent-report {
 137     if-feature OVERCURRENT-SUPPORTED;
 138
 139           description
 140       "The RU is able to report overcurrent condition about Port.
 141       This function is depending on HW design.
 142       The notification depend on power consumption which connected ALD devices and module.";
 143
 144           container overload-condition {
 145       description
 146               "Container used in notification";
 147
 148             leaf-list overloaded-ports {
 149         type leafref {
 150           path "/ald-ports-io/ald-port/name";
 151         }
 152
 153         description
 154                       "List of overloaded ports";
 155       }
 156     }
 157   }
 158 }