module Cisco-IOS-XR-controller-optics-cfg {

    yang-version 1;

    namespace
      "http://cisco.com/ns/yang/Cisco-IOS-XR-controller-optics-cfg";

    prefix controller-optics-cfg;

    import cisco-semver {
      prefix semver;
    }
    import Cisco-IOS-XR-ifmgr-cfg {
      prefix a1;
    }

    organization "Cisco Systems, Inc.";

    contact
      "Cisco Systems, Inc.
Customer Service

Postal: 170 West Tasman Drive
San Jose, CA 95134

Tel: +1 800 553-NETS

E-mail: cs-yang@cisco.com";

    description
      "This module contains a collection of YANG definitions
for Cisco IOS-XR controller-optics package configuration.

This YANG module augments the
  Cisco-IOS-XR-ifmgr-cfg
module with configuration data.

Copyright (c) 2013-2021 by Cisco Systems, Inc.
All rights reserved.";

    revision "2021-01-20" {
      description
        "Enteries added for two new FEC types in schema.
2020-09-18
  Transceiver disable added for OTS controller
2020-07-24
  New Cfg Model Added for optics yang for FastPoll
2020-05-06
  Entries added in FEC enum in bag and schema";
    }

    revision "2019-04-05" {
      description
        "Range increased for Optics transmit power. IosSetYangSchemaRev Cisco-IOS-XR-controller-optics-cfg";
    }

    revision "2017-09-07" {
      description
        "Fixed type translation error.";
    }

    revision "2017-05-01" {
      description
        "Fixing backward compatibility error in module.";
    }

    revision "2015-11-09" {
      description "IOS XR 6.0 revision.";
    }

    semver:module-version "1.2.0";
    semver:module-version "1.1.1";

    typedef Optics-fec {
      type enumeration {
        enum "fec-none" {
          value 0;
          description "No Fec";
        }
        enum "fec-h15" {
          value 1;
          description "Enhanced H15";
        }
        enum "fec-h25" {
          value 2;
          description "Enhanced H25";
        }
        enum "fec-h15-de" {
          value 4;
          description "Enhanced H15 DE";
        }
        enum "fec-h25-de" {
          value 8;
          description "Enhanced H25 DE";
        }
        enum "fec-not-set" {
          value 32;
          description "Disable the FEC";
        }
        enum "fec-1i7" {
          value 128;
          description "Enhanced 1I7";
        }
        enum "fec-1i4" {
          value 256;
          description "Enhanced 1I4";
        }
        enum "fec-swizzle" {
          value 512;
          description "Enhanced Swizzle";
        }
        enum "fec-hg20" {
          value 1024;
          description "Enhanced HG20";
        }
        enum "fec-hg7" {
          value 2048;
          description "Enhanced HG7";
        }
        enum "fec-sd20" {
          value 4096;
          description "SoftDecision 20";
        }
        enum "fec-sd7" {
          value 8192;
          description "SoftDecision 7";
        }
        enum "fec-sd15" {
          value 16384;
          description "SoftDecision 15";
        }
        enum "fec-sd27" {
          value 32768;
          description "SoftDecision 27";
        }
        enum "fec-sd15-de" {
          value 65536;
          description
            "SoftDecision 15 with DE";
        }
        enum "fec-staircase-de" {
          value 131072;
          description
            "Enhanced Staircase FEC with DE";
        }
        enum "fec-ofec" {
          value 262144;
          description "OFEC";
        }
        enum "fec-cfec" {
          value 524288;
          description "CFEC";
        }
        enum "fec-stndrd" {
          value 1048576;
          description "Standard";
        }
        enum "fec-cl74" {
          value 2097152;
          description "CL74";
        }
        enum "fec-cl108" {
          value 4194304;
          description "CL108";
        }
        enum "fec-all" {
          value 8388608;
          description "All";
        }
      }
      description "Optics fec";
    }

    typedef Optics-ots-ampli-control-mode {
      type enumeration {
        enum "automatic" {
          value 1;
          description
            "Automatic Amplifier Mode";
        }
        enum "manual" {
          value 2;
          description
            "Manual Amplifier Mode";
        }
      }
      description
        "Optics ots ampli control mode";
    }

    typedef Threshold {
      type enumeration {
        enum "low" {
          value 1;
          description "Low Threshold";
        }
        enum "high" {
          value 2;
          description "High Threshold";
        }
      }
      description "Threshold";
    }

    typedef Optics-dwdm-carrier-param {
      type enumeration {
        enum "itu-ch" {
          value 0;
          description
            "ITU Wave Channel Number";
        }
        enum "wavelength" {
          value 1;
          description "Wavelength in nm";
        }
        enum "frequency" {
          value 2;
          description "Frequency in Hertz";
        }
      }
      description
        "Optics dwdm carrier param";
    }

    typedef Optics-ots-safety-control-mode {
      type enumeration {
        enum "auto" {
          value 1;
          description
            "Automatic Safety Control Mode";
        }
        enum "disabled" {
          value 2;
          description
            "Disable Safety Control Mode";
        }
      }
      description
        "Optics ots safety control mode";
    }

    typedef Optics-modulation {
      type enumeration {
        enum "none" {
          value 0;
          description "No Modulation Type";
        }
        enum "bpsk" {
          value 1;
          description "ModType BPSK";
        }
        enum "qpsk" {
          value 2;
          description "ModType QPSK";
        }
        enum "8qam" {
          value 3;
          description "ModType 8QAM";
        }
        enum "16qam" {
          value 4;
          description "ModType 16QAM";
        }
        enum "32qam" {
          value 5;
          description "ModType 32QAM";
        }
        enum "64qam" {
          value 6;
          description "ModType 64QAM";
        }
        enum "bpsk-qspk" {
          value 7;
          description "ModType BPSK_QPSK";
        }
        enum "qpsk-8qam" {
          value 8;
          description "ModType QPSK_8QAM";
        }
        enum "8qam-16qam" {
          value 9;
          description "ModType 8QAM_16QAM";
        }
        enum "16qam-32qam" {
          value 10;
          description "ModType 16QAM_32QAM";
        }
        enum "32qam-64qam" {
          value 11;
          description "ModType 32QAM_64QAM";
        }
      }
      description "Optics modulation";
    }

    typedef Optics-ots-ampli-gain-range {
      type enumeration {
        enum "normal" {
          value 1;
          description
            "Normal Amplifier Gain Range";
        }
        enum "extended" {
          value 2;
          description
            "Extended Amplifier Gain Range";
        }
      }
      description
        "Optics ots ampli gain range";
    }

    typedef Optics-dwdm-carrier-grid {
      type enumeration {
        enum "50g-hz-grid" {
          value 0;
          description "50GHz Grid";
        }
        enum "100mhz-grid" {
          value 1;
          description "100MHz Grid";
        }
      }
      description "Optics dwdm carrier grid";
    }

    typedef Optics-loopback {
      type enumeration {
        enum "none" {
          value 0;
          description "No Loopback";
        }
        enum "internal" {
          value 1;
          description "Internal Loopback";
        }
        enum "line" {
          value 2;
          description "Line Loopback";
        }
      }
      description "Optics loopback";
    }

    augment /a1:interface-configurations/a1:interface-configuration {
      description
        "This augment extends the configuration data of
'Cisco-IOS-XR-ifmgr-cfg'";
      container optics {
        description
          "Optics controller configuration";
        container rx-thresholds {
          description
            "Configure Rx threshold";
          list rx-threshold {
            key "rx-threshold-type";
            description
              "Optics RX Low or high threshold configuration";
            leaf rx-threshold-type {
              type Threshold;
              description
                "Low or high rx threshold";
            }

            leaf rx-threshold {
              type int32 {
                range "-400..300";
              }
              mandatory true;
              description
                "Select power level (in units of 0.1dBm)";
            }
          }  // list rx-threshold
        }  // container rx-thresholds

        container rx-voa {
          description "Rx-voa configuration";
          leaf target-power {
            type int32 {
              range "-190..30";
            }
            description
              "Receive Target Power in 0.1 dbm";
          }

          leaf fixed-ratio {
            type int32 {
              range "100..1700";
            }
            description
              "Receive Ratio of Optical Attenuation in 0.01
db";
          }
        }  // container rx-voa

        container optics-network-srlgs {
          description
            "Configure Network srlgs";
          list optics-network-srlg {
            key "set-id";
            description
              "Configure network srlg sets";
            leaf set-id {
              type uint32 {
                range "1..17";
              }
              description "Set index";
            }

            leaf srlg1 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }

            leaf srlg2 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }

            leaf srlg3 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }

            leaf srlg4 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }

            leaf srlg5 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }

            leaf srlg6 {
              type uint32 {
                range "0..4294967294";
              }
              description "none";
            }
          }  // list optics-network-srlg
        }  // container optics-network-srlgs

        container optics-dwdm-carrier {
          presence
            "Indicates a optics-dwdm-carrier node is configured.";
          description
            "Configure optics DWDM Carrier";
          leaf grid-type {
            type Optics-dwdm-carrier-grid;
            mandatory true;
            description
              "DWDM Channel Grid Type";
          }

          leaf param-type {
            type Optics-dwdm-carrier-param;
            mandatory true;
            description
              "DWDM Channel Parameter Type ITU-Channel or
Frequency or Wavelength";
          }

          leaf param-value {
            type uint32 {
              range "1..1961000";
            }
            mandatory true;
            description
              "Type ITU-Channel Range 1-100, Frequency Range
19115-19610, Wavelength Range 1528773-1568362,
100MHz Frequency Range 1861000-1961000";
          }
        }  // container optics-dwdm-carrier

        container optics-lanes {
          description "Optics lanes";
          list optics-lane {
            key "index";
            description "Lane";
            leaf description {
              type string {
                length "1..255";
              }
              description
                "Configure description for this Lane";
            }

            leaf index {
              type uint32;
              description "Lane Number";
            }
          }  // list optics-lane
        }  // container optics-lanes

        container tx-thresholds {
          description
            "Configure Tx threshold";
          list tx-threshold {
            key "tx-threshold-type";
            description
              "Optics TX Low or high threshold configuration";
            leaf tx-threshold-type {
              type Threshold;
              description
                "Low or high tx threshold";
            }

            leaf tx-threshold {
              type int32 {
                range "-400..300";
              }
              mandatory true;
              description
                "Select power level (in units of 0.1dBm)";
            }
          }  // list tx-threshold
        }  // container tx-thresholds

        container transceiver {
          description "Transceiver";
          leaf disable {
            type empty;
            description
              "Disable the transceiver module, treating it as
not inserted.  When the configuration is
removed, the transceiver module on that port,
if present, would be initialized as if it is
just inserted";
          }
        }  // container transceiver

        container submarine-params {
          description
            "Proprietary Submarine Parameters";
          list submarine-param {
            key "param-type";
            description
              "Proprietary Submarine Parameters";
            leaf param-type {
              type uint32 {
                range "1..10";
              }
              description
                "Proprietary submarine parameter type";
            }

            leaf param-value {
              type uint32 {
                range "0..4294967295";
              }
              mandatory true;
              description
                "Proprietary submarine parameter value";
            }
          }  // list submarine-param
        }  // container submarine-params

        leaf optics-transmit-power {
          type int32 {
            range "-190..50";
          }
          description
            "Select power level (in units of 0.1dBm)";
        }

        leaf optics-ots-rx-enable {
          type boolean;
          description
            "Select Rx Enable as True or False";
        }

        leaf nleq-comp-mode {
          type uint32 {
            range "1..4";
          }
          description
            "Select non linear effect compenstation mode";
        }

        leaf optics-ots-rx-low-threshold-psd {
          type uint32 {
            range "0..800000";
          }
          description
            "Rx Low threshold Psd value in units of 0.001
nW/MHz";
        }

        leaf filter-roll-off-factor {
          type string {
            length "5";
          }
          description
            "RRC Filter Roll-Off factor in increments of 0
.001";
        }

        leaf optics-ots-channel-power-max-delta {
          type int32 {
            range "-500..300";
          }
          description
            "Configure max delta among all measured channel
powers ";
        }

        leaf optics-loopback {
          type Optics-loopback;
          default "none";
          description
            "Configure optics loopback mode ";
        }

        leaf optics-ots-osri {
          type boolean;
          description
            "Configure Optical safety remote interlock
(OSRI)";
        }

        leaf optics-ots-amplifier-gain-degrade-high-threshold {
          type uint32 {
            range "0..500";
          }
          description
            "Select Amplifier Gain Degrade High Threshold(in
units of 0.1dBm)";
        }

        leaf optics-ots-rx-voa-attenuation {
          type uint32 {
            range "0..200";
          }
          description
            "Select RX Voa Attenuation Setpoint(in units of
0.1dBm)";
        }

        leaf optics-fastpoll {
          type boolean;
          default "true";
          description
            "Select Fastpoll as Enable or Disable";
        }

        leaf optics-fec {
          type Optics-fec;
          default "fec-none";
          description
            "Fec H15 , Fec H25 , Fec NOTSET , Fec  1I7 , Fec
1I4 , Fec SWIZZLE , Fec HG20 , Fec HG7 , Fec
SD20 , Fec SD7, Fec SD15 , Fec SD27 , Fec
SD15-DE , Fec STAIRCASE-DE , Fec OFEC , Fec
CFEC , Fec STNDRD";
        }

        leaf optics-dgd-high-threshold {
          type uint32 {
            range "0..18000";
          }
          description
            "Select DGD high threshold(in units of 0.1ps)";
        }

        leaf optics-ots-amplifier-channel-power {
          type int32 {
            range "-500..300";
          }
          description
            "Select Amplifier Channel Power(in units of 0
.1dBm)";
        }

        leaf optics-ots-amplifier-control-mode {
          type Optics-ots-ampli-control-mode;
          description
            "Configure amplifier working mode";
        }

        leaf optics-ots-rx-low-threshold-delta {
          type uint32 {
            range "0..300";
          }
          description
            "Rx Low threshold delta value in units of 0.1dB";
        }

        leaf cpr-ext-win-mode {
          type uint32 {
            range "1..9";
          }
          description
            "Select carrier phase recovery extended window
mode";
        }

        leaf cross-pol-weight-mode {
          type uint32 {
            range "1..7";
          }
          description
            "Select carrier phase recovery cross
polarization weight mode";
        }

        leaf optics-ots-amplifier-gain {
          type uint32 {
            range "0..500";
          }
          description
            "Select Amplifier Gain value(in units of 0.1dBm)";
        }

        leaf optics-ots-amplifier-gain-range {
          type Optics-ots-ampli-gain-range;
          description
            "Normal or extended Ampli Gain Range";
        }

        leaf optics-ots-safety-control-mode {
          type Optics-ots-safety-control-mode;
          description
            "Configure safety Control Mode";
        }

        leaf optics-cd-min {
          type int32 {
            range "-350000..350000";
          }
          description
            "Select min chromatic dispersion (in units of
ps/nm)";
        }

        leaf optics-ots-amplifier-channel-psd {
          type uint32 {
            range "0..800000";
          }
          description
            "Select Amplifier Channel Psd(in units of 0.001
nW/MHz)";
        }

        leaf optics-ots-tx-voa-attenuation {
          type uint32 {
            range "0..200";
          }
          description
            "Select TX Voa Attenuation Setpoint(in units of
0.1dBm)";
        }

        leaf optics-ots-tx-enable {
          type boolean;
          description
            "Select Tx Enable as True or False";
        }

        leaf optics-ots-amplifier-tilt {
          type int32 {
            range "-50..50";
          }
          description
            "Select Amplifier Tilt value(in units of 0.1dB)";
        }

        leaf optics-transmit-shutdown {
          type boolean;
          description
            "Configure optics transmit laser shutdown ";
        }

        leaf optics-baud-rate {
          type string {
            length "1..20";
          }
          description
            "BaudRate(Max Length 10)";
        }

        leaf optics-performance-monitoring {
          type boolean;
          default "true";
          description
            "Select Performance Monitoring as Enable or
Disable";
        }

        leaf optics-cd-max {
          type int32 {
            range "-350000..350000";
          }
          description
            "Select max chromatic dispersion (in units of
ps/nm)";
        }

        leaf optics-modulation {
          type Optics-modulation;
          description
            "BPSK,QPSK,8QAM,16QAM,32QAM,64QAM,BPSK-QPSK
,QPSK-8QAM,8QAM-16QAM,16QAM-32QAM,32QAM-64QAM";
        }

        leaf cpr-win-mode {
          type uint32 {
            range "1..4";
          }
          description
            "Select carrier phase recovery window mode";
        }

        leaf optics-bits-per-symbol {
          type string {
            length "1..20";
          }
          description
            "BitsPerSymbol(Max Length 9)";
        }

        leaf enh-sop-tol-mode {
          type uint32 {
            range "1..3";
          }
          description
            "Select enhanced SOP tolerance mode";
        }

        leaf cross-pol-gain-mode {
          type uint32 {
            range "1..15";
          }
          description
            "Select carrier phase recovery cross
polarization gain mode";
        }

        leaf optics-lbc-high-threshold {
          type uint32 {
            range "0..100";
          }
          description
            "Select power level (in units of percentage)";
        }

        leaf optics-cd-high-threshold {
          type int32 {
            range "-350000..350000";
          }
          description
            "Select chromatic dispersion high threshold(in
units of ps/nm)";
        }

        leaf optics-osnr-low-threshold {
          type uint32 {
            range "0..4000";
          }
          description
            "Select OSNR low threshold(in units of 0.01db)";
        }

        leaf optics-ots-amplifier-gain-degrade-low-threshold {
          type uint32 {
            range "0..500";
          }
          description
            "Select Amplifier Gain Degrade Low Threshold(in
units of 0.1dBm)";
        }

        leaf optics-cd-low-threshold {
          type int32 {
            range "-350000..350000";
          }
          description
            "Select chromatic dispersion low threshold(in
units of ps/nm)";
        }

        leaf enh-colorless-mode {
          type uint32 {
            range "1..3";
          }
          description
            "Select enhanced colorless mode";
        }
      }  // container optics
    }
  }  // module Cisco-IOS-XR-controller-optics-cfg