module fujitsu-otn-otu-interfaces {

    yang-version 1;

    namespace
      "urn:fujitsu:params:xml:ns:yang:interface:otu";

    prefix otu;

    import ietf-interfaces {
      prefix if;
    }
    import fujitsu-entity-states {
      prefix entity-states;
    }
    import fujitsu-entity-maintenance-loopback {
      prefix fujitsu-loopback;
    }
    import fujitsu-gcc {
      prefix fujitsuGcc;
    }
    import fujitsu-otn {
      prefix otn;
    }
    import fujitsu-performance-monitoring-typedefs {
      prefix pmtypedefs;
    }
    import fujitsu-ains-keywords {
      prefix ains;
    }

    organization "Fujitsu Ltd.";

    contact
      "Fujitsu Ltd.
     
     Address: 2801 Telecom Parkway
              Richardson, Texas 75082
     
     Tel: +1-800-USE-FTAC (1-800-873-3822)
     Email: ftac@fnc.fujitsu.com
     Web: www.fujitsu.com/us/services/telecom";

    description
      "This module contains YANG definitions 
     for the OTU Interfaces of an Optical White Box (OWB).
     
     Copyright (c) 2015 Fujitsu Ltd.
     All rights reserved. ";

    revision "2018-01-09" {
      description " Added more fec types";
    }

    revision "2017-05-02" {
      description
        " Added AINS for otu container";
    }

    revision "2017-01-23" {
      description
        "Description changed for degthr.";
    }

    revision "2016-06-01" {
      description
        "Added more fec values. Added differential-decode, auto-rx, auto-tx, otu-notif";
    }

    revision "2015-05-12" {
      description "Initial revision.";
    }


    identity otu-rate-identity {
      description
        "A unique rate identification of the OTU.";
    }

    identity OTU4 {
      base otu-rate-identity;
      description "Identity for an OTU4";
    }

    identity OTU3 {
      base otu-rate-identity;
      description "Identity for an OTU3";
    }

    identity OTU2 {
      base otu-rate-identity;
      description "Identity for an OTU2";
    }

    identity OTU2e {
      base otu-rate-identity;
      description "Identity for an OTU2e";
    }

    identity OTU1 {
      base otu-rate-identity;
      description "Identity for an OTU1";
    }

    identity OTU0 {
      base otu-rate-identity;
      description "Identity for an OTU0";
    }

    identity OTUflex {
      base otu-rate-identity;
      description "Identity for an OTUflex";
    }

    notification otu-notif {
      leaf name {
        type leafref {
          path "/if:interfaces/if:interface/if:name";
        }
      }

      container otu {
        leaf ains {
          type ains-state;
          default "disabled";
        }

        leaf vstimer {
          when "../ains = 'enabled'";
          type vstimer;
        }

        leaf ACTVST {
          when "../ains = 'enabled'";
          type string;
          config false;
        }

        leaf actual-vstimer {
          type string {
            pattern
              "([0-4][0-8])-([0-5][0-9])";
          }
          config false;
          description
            "The amount of time a valid state timer has been running uninterrupted.
           This timer is in the format <hh>-<mm>.";
        }

        leaf rate {
          type identityref {
            base otu-rate-identity;
          }
          description
            "rate identity of the OTU. 'identityref' is used
to allow to extend for future higher rates";
        }

        leaf oper-status {
          type oper-status;
          description
            "The current operational state of the interface.

This leaf has the same semantics as ifOperStatus.";
        }

        leaf admin-status {
          type admin-status;
          default "down";
          description
            "The desired state of the interface.

This leaf has the same read semantics as ifAdminStatus.";
        }

        choice standard {
          default "itu";
          description
            "choice between ANSI Trail Trace Identifier and
ITU-T Trail Trace Identifer (SAPI, DAPI, OperatorSpecific)";
          container tti-itu {
            description
              "ITU-T Trail Trace Identifer (SAPI, DAPI, OperatorSpecific)";
            container tx-tti {
              description
                "Transmitted Trail Trace Identifier";
              leaf sapi {
                type itu-otn-tti-sapi;
                description
                  "Source Access Point Identifier";
              }

              leaf dapi {
                type itu-otn-tti-dapi;
                description
                  "Destination Access Point Identifier";
              }

              leaf op-spec {
                type itu-otn-tti-op-spec;
                description
                  "TTI Operator Spec";
              }
            }  // container tx-tti

            container rx-tti {
              config false;
              description
                "Received Trail Trace Identifier";
              leaf sapi {
                type itu-otn-oper-tti-sapi;
                description
                  "Source Access Point Identifier";
              }

              leaf dapi {
                type itu-otn-oper-tti-dapi;
                description
                  "Destination Access Point Identifier";
              }

              leaf op-spec {
                type itu-otn-oper-tti-op-spec;
                description
                  "TTI Operator Spec";
              }
            }  // container rx-tti

            container exp-tti {
              description
                "Expected Trail Trace Identifier";
              leaf sapi {
                type itu-otn-tti-sapi;
                description
                  "Source Access Point Identifier";
              }

              leaf dapi {
                type itu-otn-tti-dapi;
                description
                  "Destination Access Point Identifier";
              }

              leaf op-spec {
                type itu-otn-tti-op-spec;
                description
                  "TTI Operator Spec";
              }
            }  // container exp-tti

            leaf tim-det-mode {
              type itu-tim-det-mode;
              description
                "TIM detection mode";
            }

            leaf tim-act-enabled {
              type boolean;
              description
                "Enables TTI Mismatch consequent actions.";
            }
          }  // container tti-itu
          container tti-ansi {
            description
              "ANSI Trail Trace Identifer";
            container tx-tti {
              description
                "Transmitted Trail Trace Identifier";
              leaf tti {
                type ansi-otn-tti;
                description
                  "Trail Trace Identifier";
              }
            }  // container tx-tti

            container rx-tti {
              config false;
              description
                "Received Trail Trace Identifier";
              leaf tti {
                type ansi-otn-tti;
                description
                  "Trail Trace Identifier";
              }
            }  // container rx-tti

            container exp-tti {
              description
                "Expected Trail Trace Identifier";
              leaf tti {
                type ansi-otn-tti;
                description
                  "Trail Trace Identifier";
              }
            }  // container exp-tti

            leaf tim-act-enabled {
              type boolean;
              description
                "Enables TTI Mismatch consequent actions.";
            }
          }  // container tti-ansi
        }  // choice standard

        leaf direction {
          type enumeration {
            enum "uni-rx" {
              value 0;
              description
                "unidirectional receive only";
            }
            enum "uni-tx" {
              value 1;
              description
                "unidirectional transmit only";
            }
            enum "bi" {
              value 2;
              description "bidirectional";
            }
          }
          description
            "direction of interface";
        }

        leaf degthr {
          type int16 {
            range "-9..2";
          }
          default "0";
          description
            "DEGTHR:Degraded defect one-second Errored Block Count threshold
DEGTHR specifies the exponent part X of 10^X [%].";
        }

        leaf degm {
          type int8 {
            range "2..10";
          }
          default "10";
          description
            "DEGM:Degraded defect consecutive one-second monitoring intervals";
        }

        leaf circuit-id {
          type string {
            length "0..45";
          }
          description
            "circuit identifier/user label";
        }

        leaf fec {
          type enumeration {
            enum "off" {
              value 0;
              description "fec off";
            }
            enum "rsfec" {
              value 1;
              description "rsfec";
            }
            enum "sdfeca1" {
              value 2;
              description "Clariphy SDFEC";
            }
            enum "efec" {
              value 3;
              description "G.975.1 I.4";
            }
            enum "ufec" {
              value 4;
              description "G.975.1 I.7";
            }
            enum "sdfec" {
              value 5;
              description
                "Soft Decision FEC";
            }
            enum "sdfecb1" {
              value 6;
              description "SDFEC with SCFEC";
            }
            enum "scfec" {
              value 7;
              description "Stair case FEC";
            }
            enum "hgsdfec" {
              value 8;
              description
                "SDFEC 16% with RSFEC";
            }
            enum "hgsdfec2" {
              value 9;
              description
                "SDFEC 23% with RSFEC";
            }
          }
          description
            "Forward Error Correction";
        }

        leaf differential-decode {
          type enumeration {
            enum "off" {
              value 0;
              description
                "differntial decode off";
            }
            enum "on" {
              value 1;
              description
                "differntial decode on";
            }
          }
          description "Differential Decode";
        }

        leaf auto-rx {
          type boolean;
          description
            "enable/disable generation of transient condition when
the value of the TTI changes.";
        }

        leaf auto-tx {
          type boolean;
          description
            "enable/disable automatic population of outgoing TTI";
        }

        container pm {
          description
            "Performance Monitoring Info";
          list pm-threshold {
            key "pm-name pm-location pm-direction";
            description
              "List of PMs thresholds for the parent entity.";
            leaf pm-name {
              type pm-identity;
            }

            leaf pm-location {
              type pm-location;
            }

            leaf pm-direction {
              type pm-direction;
            }

            leaf pm-type {
              type pm-type;
            }

            container pm-th-metered {
              when "../pm-type = 'metered'";
              leaf pm-th-type {
                type enumeration {
                  enum "auto" {
                    value 0;
                    description
                      "HW autoprovisioned";
                  }
                  enum "user" {
                    value 1;
                    description
                      "User-provisioned";
                  }
                }
                default "auto";
              }

              leaf pm-th-low {
                when
                  "../pm-th-type = 'user'";
                type pm-data-type;
                mandatory true;
              }

              leaf pm-th-high {
                when
                  "../pm-th-type = 'user'";
                type pm-data-type;
                mandatory true;
              }
            }  // container pm-th-metered

            container pm-th-binned {
              when "../pm-type = 'binned'";
              list pm-time-periods {
                key "pm-time-period";
                leaf pm-time-period {
                  type pm-time-period;
                }

                leaf pm-value {
                  type pm-data-type;
                  mandatory true;
                }
              }  // list pm-time-periods
            }  // container pm-th-binned
          }  // list pm-threshold

          list pm-oper-range {
            key "pm-name pm-location pm-direction";
            config false;
            ordered-by user;
            leaf pm-name {
              type pm-identity;
            }

            leaf pm-location {
              type pm-location;
            }

            leaf pm-direction {
              type pm-direction;
            }

            leaf pm-alarm-low {
              type pm-data-type;
              description
                "PM Alarm Detect Low";
            }

            leaf pm-alarm-high {
              type pm-data-type;
              description
                "PM Alarm Detect High";
            }

            leaf pm-capability-min {
              type pm-data-type;
              description
                "PM Operating Range Low";
            }

            leaf pm-capability-max {
              type pm-data-type;
              description
                "PM Operating Range High";
            }

            leaf pm-warning-low {
              type pm-data-type;
              description "PM Threshold Low";
            }

            leaf pm-warning-high {
              type pm-data-type;
              description
                "PM Threshold High";
            }
          }  // list pm-oper-range
        }  // container pm
      }  // container otu
    }  // notification otu-notif
  }  // module fujitsu-otn-otu-interfaces