data-model/yang/published/o-ran/ru-fh/o-ran-common-identity-refs@2022-08-15.yang

   1 module o-ran-common-identity-refs {
   2   yang-version 1.1;
   3   namespace "urn:o-ran:wg1identityref:1.0";
   4   prefix "o-ran-iref";
   5
   6   import iana-hardware {
   7     prefix ianahw;
   8   }
   9
  10   organization "O-RAN Alliance";
  11
  12   contact
  13     "www.o-ran.org";
  14
  15   description
  16     "This module defines a set of re-usable identity references, that can be
  17     re-used across O-RAN working groups.
  18
  19     Copyright 2020 the O-RAN Alliance.
  20
  21     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 'AS IS'
  22     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24     ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  25     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31     POSSIBILITY OF SUCH DAMAGE.
  32
  33     Redistribution and use in source and binary forms, with or without
  34     modification, are permitted provided that the following conditions are met:
  35
  36     * Redistributions of source code must retain the above copyright notice,
  37     this list of conditions and the above disclaimer.
  38     * Redistributions in binary form must reproduce the above copyright notice,
  39     this list of conditions and the above disclaimer in the documentation
  40     and/or other materials provided with the distribution.
  41     * Neither the Members of the O-RAN Alliance nor the names of its
  42     contributors may be used to endorse or promote products derived from
  43     this software without specific prior written permission.";
  44
  45   revision "2022-08-15" {
  46     description
  47       "version 1.1.0
  48
  49       1) style guide corrections";
  50
  51     reference "ORAN-WG1.IM.0-v01.00";
  52   }
  53
  54   revision "2020-11-01" {
  55     description
  56       "version 1.0.0
  57
  58       1) initial verstion.";
  59
  60     reference "ORAN-WG1.IM.0-v01.00";
  61   }
  62
  63   // O-RAN functional identity types
  64
  65   identity o-ran-function-base {
  66     description
  67       "Base identity from which all O-RAN defined functions are derived.
  68
  69       This identity is abstract and MUST NOT be used as a value.";
  70   }
  71
  72   identity o-ru-function {
  73     base "o-ran-function-base";
  74     description
  75       "an identity corresponding to an O-RAN O-RU Function.
  76
  77       This identity is abstract and MUST NOT be used as a value.";
  78   }
  79
  80   identity o-du-function {
  81     base "o-ran-function-base";
  82     description
  83       "an identity corresponding to all O-RAN O-DU Functions.
  84
  85       This identity is abstract and MUST NOT be used as a value.";
  86   }
  87
  88   identity o-cu-function {
  89     base "o-ran-function-base";
  90     description
  91       "an identity corresponding to all O-RAN O-CU Functions.
  92
  93       This identity is abstract and MUST NOT be used as a value.";
  94   }
  95
  96   identity o-cu-up-function {
  97     base "o-cu-function";
  98     description
  99       "an identity corresponding to an O-RAN O-CU UP Function.
 100
 101       This identity is abstract and MUST NOT be used as a value.";
 102   }
 103
 104   identity o-cu-cp-function {
 105     base "o-cu-function";
 106     description
 107       "an identity corresponding to an O-RAN O-CU CP Function.
 108
 109       This identity is abstract and MUST NOT be used as a value.";
 110   }
 111
 112   // O-RAN radio technology identity types
 113
 114   identity o-ran-radio-technology-base {
 115     description
 116       "Base identity for O-RAN defined radio technology types.
 117
 118       This identity is abstract and MUST NOT be used as a value.";
 119   }
 120
 121   identity new-radio-technology {
 122     base "o-ran-radio-technology-base";
 123     description
 124       "An identity corresponding to new radio technology.
 125
 126       This identity is abstract and MUST NOT be used as a value.";
 127   }
 128
 129   identity lte-technology {
 130     base "o-ran-radio-technology-base";
 131     description
 132       "An identity corresponding to lte technology.
 133
 134       This identity is abstract and MUST NOT be used as a value.";
 135   }
 136
 137   identity nb-iot {
 138     base "lte-technology";
 139     description
 140       "An identity corresponding to nb-iot technology.
 141
 142       This identity is abstract and MUST NOT be used as a value.";
 143   }
 144
 145   // O-RAN Transport technology identity types
 146
 147   identity o-ran-transport-technology-base {
 148     description
 149       "Base identity from which all O-RAN defined transport technology identities are derived.
 150
 151       This identity is abstract and MUST NOT be used as a value.";
 152   }
 153
 154   // O-RAN Fronthaul transport identity types
 155
 156   identity o-ran-fronthaul-transport-base {
 157     description
 158       "Base identity from which all O-RAN defined fronthaul transports are derived.
 159
 160       This identity is abstract and MUST NOT be used as a value.";
 161   }
 162
 163   identity ethernet-fronthaul-transport {
 164     base "o-ran-fronthaul-transport-base";
 165     description
 166       "an identity corresponding to fronthaul transport using ethernet based flows.
 167
 168       This identity is abstract and MUST NOT be used as a value.";
 169   }
 170
 171   // Hardware component identity types
 172
 173   identity o-ran-module {
 174     base ianahw:module;
 175     description
 176       "Any O-RAN module that represents a self-contained sub-system.
 177
 178       This identity is abstract and MUST NOT be used as a value.";
 179   }
 180
 181   identity o-ran-hardware-class {
 182     base ianahw:hardware-class;
 183     description
 184       "This identity corresponding to a generic O-RAN hardware class.
 185
 186       This identity is abstract and MUST NOT be used as a value.";
 187   }
 188
 189   identity fpga {
 190     base o-ran-hardware-class;
 191     description
 192       "Represent an FPGA.
 193
 194       This identity is abstract and MUST NOT be used as a value.";
 195   }
 196
 197 }