data-model/yang/published/o-ran/ru-fh/o-ran-ald-port@2021-12-01.yang

   1 module o-ran-ald-port {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:ald-port:1.0";
   4   prefix "o-ran-ald-port";
   5
   6   organization "O-RAN Alliance";
   7
   8   contact
   9     "www.o-ran.org";
  10
  11   description
  12     "This module defines the input state and output configuration for
  13     the Antenna Line Device capability.
  14
  15     Copyright 2021 the O-RAN Alliance.
  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 O-RAN Alliance 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 "2021-12-01" {
  42     description
  43       "version 1.3.0
  44
  45       1) Typographical corrections for british english.";
  46
  47     reference "ORAN-WG4.M.0-v01.00";
  48   }
  49
  50   revision "2021-03-22" {
  51     description
  52       "version 1.2.0
  53
  54       1) typographical corrections in descriptions.";
  55
  56     reference "ORAN-WG4.M.0-v01.00";
  57   }
  58
  59   revision "2019-07-03" {
  60     description
  61       "version 1.1.0
  62
  63       1) backward compatible changes to introduce groupings.";
  64
  65     reference "ORAN-WG4.M.0-v01.00";
  66   }
  67
  68   revision "2019-02-04" {
  69     description
  70       "version 1.0.0
  71
  72       1) imported model from xRAN
  73       2) changed namespace and reference from xran to o-ran";
  74
  75     reference "ORAN-WG4.M.0-v01.00";
  76   }
  77
  78
  79   feature OVERCURRENT-SUPPORTED {
  80     description
  81       "This feature indicates that the equipment supports the over-current notification
  82       capability.";
  83   }
  84
  85 // Groupings
  86
  87   grouping aldport-group {
  88     description "a port grouping ";
  89     leaf over-current-supported {
  90       type boolean;
  91       config false;
  92       description
  93         "Set to TRUE when the equipment supports over-current notifications";
  94     }
  95
  96     list ald-port {
  97       key "name";
  98
  99       config false;
 100
 101       description
 102         "Leaf nodes describing ALD Port";
 103       leaf name {
 104         type string {
 105           length "1..255";
 106         }
 107         description
 108           "A name that is unique that identifies a ald port instance.
 109           This name may be used in fault management to refer to a fault source
 110           or affected object";
 111       }
 112
 113       leaf port-id {
 114         type uint8;
 115             config false;
 116             mandatory true;
 117
 118             description
 119           "A number which identifies an ALD Port.
 120           The number of the Physical ALD port connector in the module.
 121           If the module supports 2 ALD Port connectors, use 0 and 1.";
 122       }
 123
 124       leaf dc-control-support{
 125         type boolean;
 126         config false;
 127             mandatory true;
 128
 129             description
 130           "It is shown that on/off in the DC power supply is possible.
 131           In case of False, power supply is always on.";
 132       }
 133
 134       leaf dc-enabled-status {
 135         when "../dc-control-support = 'true'";
 136         type boolean;
 137         default false;
 138         description
 139           "Status of DC voltage enabled on antenna line.
 140           Valid only in case dc-control-support is true.";
 141       }
 142
 143       leaf supported-connector{
 144         type enumeration {
 145               enum ANTENNA_CONNECTOR {
 146                 description
 147                     "This ALD port is related to antenna connector";
 148               }
 149               enum RS485_PORT {
 150                 description
 151                     "This ALD port is related to RS485 port";
 152               }
 153             }
 154         config false;
 155             mandatory true;
 156
 157             description
 158           "Informs about the connectors of Module which ALDs are connected to.
 159           This value is depending on HW design.";
 160       }
 161     }
 162
 163     list ald-port-dc-control {
 164       key "name";
 165
 166       description
 167         "Container needed to manage DC on ALD ports";
 168
 169       leaf name {
 170         type leafref {
 171           path "/ald-ports-io/ald-port/name";
 172           require-instance false;
 173         }
 174         mandatory true;
 175
 176         description
 177           "Name derived from unmodifiable list ald-port";
 178       }
 179
 180       leaf dc-enabled{
 181         type boolean;
 182
 183         description
 184           "If dc-control-support is true case, this leaf is effective.
 185           If dc-control-support is not true this leaf makes no action
 186           In case of true, the power supply shall be turned on.";
 187       }
 188     }
 189   }
 190
 191   grouping overcurrent-group {
 192     description "overcurrent group";
 193     container overload-condition {
 194       description
 195         "Container used in notification";
 196
 197       leaf-list overloaded-ports {
 198         type leafref {
 199           path "/ald-ports-io/ald-port/name";
 200         }
 201         description
 202           "List of overloaded ports";
 203       }
 204     }
 205   }
 206
 207   grouping dc-enabled-group {
 208     description "dc enabled group";
 209     list ald-port {
 210       key name;
 211       description
 212         "list of ald-ports that has its dc-enabled-status changed";
 213       leaf name{
 214         type leafref {
 215           path "/ald-ports-io/ald-port/name";
 216         }
 217         description "Name of port which has changed";
 218       }
 219       leaf dc-enabled-status{
 220         type leafref {
 221           path "/ald-ports-io/ald-port/dc-enabled-status";
 222         }
 223         description "New status of dc-enabled-status";
 224       }
 225     }
 226   }
 227
 228 // Top Level Container
 229
 230   container ald-ports-io {
 231     description
 232       "ALD port information.
 233        ALD port of the equipment that can be used to connect External Equipment (Antenna Line Devices).
 234        Communication uses AISG over HDLC.
 235        Physical connection depends on connector type offered by the port (RS-485 or antenna line)
 236        Note: Single instance of ALD Port can point to more than one antenna line devices.";
 237
 238     uses aldport-group;
 239   }
 240
 241   notification overcurrent-report {
 242     if-feature OVERCURRENT-SUPPORTED;
 243
 244     description
 245       "The equipment is able to report overcurrent condition about Port.
 246       This function is depending on HW design.
 247       The notification depend on power consumption which connected ALD devices and module.";
 248
 249     uses overcurrent-group;
 250   }
 251
 252   notification dc-enabled-status-change {
 253     description
 254       "The equipment is able to report the change of 'dc-enabled-status' of the ald-port.
 255       This is applicable when the leaf 'dc-control-support' of the ald-pot is 'TRUE'.";
 256
 257     uses dc-enabled-group;
 258   }
 259 }