data-model/yang/published/o-ran/ru-fh/o-ran-ald@2021-12-01.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 "2021-12-01" {
  45     description
  46       "version 1.2.0
  47
  48       1) Typographical corrections.";
  49
  50     reference "ORAN-WG4.M.0-v01.00";
  51   }
  52
  53   revision "2019-07-03" {
  54     description
  55       "version 1.1.0
  56
  57       1) backward compatible changes to introduce groupings.";
  58
  59     reference "ORAN-WG4.M.0-v01.00";
  60   }
  61
  62   revision "2019-02-04" {
  63     description
  64       "version 1.0.0
  65
  66       1) imported model from xRAN
  67       2) changed namespace and reference from xran to o-ran";
  68
  69     reference "ORAN-WG4.M.0-v01.00";
  70   }
  71
  72   grouping ald-input {
  73     description "a grouping for ald input";
  74     leaf port-id {
  75       type leafref {
  76         path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  77       }
  78       mandatory true;
  79       description
  80         "Unique ALD port identifier reported by radio";
  81     }
  82
  83     leaf ald-req-msg {
  84       type binary {
  85         length "0..1200";
  86       }
  87
  88       description
  89         "Response message to be forwarded to ALD in type of binary-string";
  90     }
  91   }
  92
  93   grouping ald-output {
  94     description "a grouping for ald output";
  95     leaf port-id {
  96       type leafref {
  97         path "/ap:ald-ports-io/ap:ald-port/ap:port-id";
  98       }
  99       mandatory true;
 100       description
 101         "Unique ALD port identifier reported by radio";
 102     }
 103
 104     leaf status {
 105       type enumeration {
 106         enum ACCEPTED {
 107           description
 108             "Operation was accepted, message was processed towards ALD and response is provided";
 109         }
 110         enum REJECTED {
 111           description
 112             "Operation was rejected by O-RU";
 113         }
 114       }
 115       mandatory true;
 116
 117       description
 118         "Status of RPC handling seen from equipment perspective";
 119     }
 120
 121     leaf error-message {
 122       when "../status='REJECTED'";
 123       type string;
 124
 125       description
 126         "Detailed error message when the status is rejected. E.g. wrong ALD port identifier was used in RPC received from NETCONF Client";
 127     }
 128
 129     leaf ald-resp-msg {
 130       type binary {
 131         length "0..1200";
 132       }
 133
 134       description
 135         "Response message forwarded from ALD in type of binary-string";
 136     }
 137
 138     leaf frames-with-wrong-crc {
 139       type uint32;
 140
 141       description
 142         "Number of frames with incorrect CRC (FCS) received from ALD - running counter";
 143     }
 144
 145     leaf frames-without-stop-flag {
 146       type uint32;
 147
 148       description
 149         "Number of frames without stop flag received from ALD - running counter";
 150     }
 151
 152     leaf number-of-received-octets {
 153       type uint32;
 154
 155       description
 156         "Number of octets received from HDLC bus - running counter";
 157     }
 158   }
 159   // rpc-statements
 160   rpc ald-communication {
 161     description
 162       "RPC to support communication between O-DU and Antenna Line Devices";
 163
 164     input {
 165       uses ald-input;
 166     }
 167
 168     output {
 169       uses ald-output;
 170     }
 171   }
 172 }