module ieee802-ethernet-pon {

    yang-version 1.1;

    namespace
      "urn:ieee:std:802.3:yang:ieee802-ethernet-pon";

    prefix ieee802-eth-pon;

    import ieee802-types {
      prefix ieee;
      reference
        "IEEE 802 types";


    }
    import ietf-yang-types {
      prefix yang;
      reference
        "IETF RFC 6991";


    }
    import ietf-interfaces {
      prefix if;
      reference
        "IETF RFC 8343";


    }
    import ieee802-ethernet-interface {
      prefix ieee802-eth-if;
    }

    organization
      "IEEE 802.3 Ethernet Working Group
     Web URL: http://www.ieee802.org/3/";

    contact
      "Web URL: http://www.ieee802.org/3/";

    description
      "This module contains a collection of YANG definitions for
     managing the Multi Point Control Protocol for
     Ethernet PON (EPON),as defined in IEEE Std 802.3, Clause 64
     and Clause 77.

     This YANG module augments the 'ethernet' module.";

    revision "2025-04-17" {
      description
        "Updates under IEEE Std 802.3.2-202x, Draft D3.3";
      reference
        "IEEE Std 802.3-2022, unless dated explicitly";

    }


    feature trx-power-level-reporting-supported {
      description
        "This object indicates the support for optical transceiver
       power level monitoring and reporting capability.
       When 'true', the given interface supports the optical power
       level monitoring and reporting function. Otherwise,
       the value is 'false'.";
    }

    feature fec-supported {
      description
        "This object indicates the support of operation of the
       optional FEC sublayer of the 1G-EPON PHY specified in
       IEEE Std 802.3, 65.2. The value of 'unknown' is reported in
       the initialization, for non FEC support state or type not
       yet known. The value of 'not supported' is reported when the
       sublayer is not supported. The value of 'supported' is
       reported when the sublayer is supported. This object is
       applicable for an OLT, with the same value for all logical
       links, and for an ONU.";
      reference
        "IEEE Std 802.3, 30.5.1.1.15";

    }

    identity state-change-action-type {
      description
        "Type of interface state change requested.";
    }

    identity power-down {
      base state-change-action-type;
      description
        "Power down the EPON logical interface.
       Power-down actions are applicable for the OLT and ONU.  A
       power down of a specific logical interface affects only
       the logical interface (and not the physical interface).
       the logical interface will be unavailable while the
       power-down occurs and data may be lost. Other logical
       interface are unaffected by power-down.

       This action is relevant when the admin state is active.";
    }

    identity power-up {
      base state-change-action-type;
      description
        "Exit EPON logical interface power-down state.";
    }

    identity reset-action-type {
      description
        "Type of reset action requested.";
    }

    identity reset-interface {
      base reset-action-type;
      description
        "Reset the EPON logical interface. Resetting an interface
       can lead an interruption of service for the users connected
       to the respective EPON interface.

       This object is applicable for an OLT and an ONU. At the
       OLT, it has a distinct value for each logical interface.
       A reset for a specific logical interface resets only
       this logical interface and not the physical interface.

       Thus, a logical link that is malfunctioning can be
       reset without affecting the operation of other logical
       interfaces.

       The reset can cause Discontinuities in the values of the
       counters of the interface, similar to re-initialization
       of the management system.";
    }

    identity register-type {
      description
        "Type of registration requested.";
    }

    identity register {
      base register-type;
      description
        "Register indicates a request to register an LLID.
       This action applies to an OLT or ONU logical interface.";
    }

    identity reregister {
      base register-type;
      description
        "Re-register indicates an request to re-register an LLID.
       This action applies to an OLT or ONU logical interface.";
    }

    identity deregister {
      base register-type;
      description
        "De-register indicates an request to de-register an LLID.
       This action applies to an OLT or ONU logical interface.
       Deregister may result in an interruption of service to
       users connected to the respective EPON interface.";
    }

    typedef mpcp-supported {
      type boolean;
      description
        "This object indicates that the given interface supports
       MPCP, i.e., it is an Ethernet PON (EPON) interface.";
    }

    typedef mpcp-llid {
      type uint64 {
        range "0 .. 32767";
      }
      description
        "Logical Link Identifiers (LLIDs) are used to identify a
       single MAC from a number of MACs which may be present in the
       EPON OLT or ONU. LLIDs between the value of 0x07FFE
       and 0x7FFF are assigned for ONU discovery and registration.
       Other LLIDs are dynamically assigned by the OLT during the
       registration process. For a complete description of how the
       LLID is used in an EPON device, see IEEE Std 802.3,
       Clause 65 for 1G-EPON and Clause 76 for 10G-EPON.";
      reference
        "IEEE Std 802.3, 65.1.3.3 for 1G-EPON and
        76.2.6.1.3 for 10G-EPON";

    }

    typedef mpcp-maximum-queue-count-per-report {
      type uint8 {
        range "0..7";
      }
      default "0";
      description
        "Defines the maximum number of queues (0-7) in the REPORT
       MPCPDU as defined in IEEE Std 802.3, Clause 64 and
       Clause 77.";
    }

    typedef mpcp-llid-count {
      type uint64 {
        range "0 .. 32767";
      }
      description
        "Indicates the number of registered LLIDs. The initialization
       value is 0. This is applicable for an OLT with the same
       value for all logical interfaces and for an ONU.";
      reference
        "IEEE Std 802.3, 65.1.3.3 for 1G-EPON and
           76.2.6.1.3 for 10G-EPON";

    }

    typedef mpcp-admin-state {
      type enumeration {
        enum "enabled" {
          value 0;
          description
            "When selecting the value of 'enabled', the MultiPoint
           Control Protocol sublayer on the OLT / ONU is enabled.";
        }
        enum "disabled" {
          value 1;
          description
            "When selecting the value of 'disabled', the MultiPoint
           Control Protocol sublayer on the OLT / ONU is
           disabled.";
        }
      }
      description
        "Enumeration of valid administrative states for a
       MultiPoint MAC Control sublayer on the OLT or ONU.";
      reference
        "IEEE Std 802.3, 30.3.5.2.1";

    }

    typedef mpcp-mode {
      type enumeration {
        enum "olt" {
          value 0;
          description "MPCP mode: olt";
        }
        enum "onu" {
          value 1;
          description "MPCP mode: onu";
        }
      }
      description
        "Enumeration of valid MPCP modes for EPON interfaces.";
      reference
        "IEEE Std 802.3, 30.3.5.1.3";

    }

    typedef mpcp-logical-link-state {
      type enumeration {
        enum "unregistered" {
          value 0;
          description
            "MPCP registration state: logical link is
           NOT registered.";
        }
        enum "registering" {
          value 1;
          description
            "MPCP registration state: logical link is currently in
           the process of registering.";
        }
        enum "registered" {
          value 2;
          description
            "MPCP registration state: logical link is currently
           registered.";
        }
      }
      description
        "Enumeration of valid MPCP registration states for EPON
       interfaces.";
      reference
        "IEEE Std 802.3, 30.3.5.1.6";

    }

    typedef mpcp-logical-link-admin-state {
      type enumeration {
        enum "reset" {
          value 0;
          description
            "When read, the value of 'reset' indicates that the given
           logical link on the OLT / ONU has been reset.";
        }
        enum "operate" {
          value 1;
          description
            "When read, the value of 'operate' indicates that the
           given logical link on the OLT / ONU has moved into
           operating mode.";
        }
        enum "unknown" {
          value 2;
          description
            "When read, the value of 'unknown' indicates that the
           status of the given logical link on the OLT / ONU is
           currently not known.";
        }
        enum "registered" {
          value 3;
          description
            "When read, the value of 'registered' indicates that the
           given logical link on the OLT / ONU has been
           registered.";
        }
        enum "deregistered" {
          value 4;
          description
            "When read, the value of 'deregistered' indicates that the
           given logical link on the OLT / ONU has been
           deregistered.";
        }
        enum "reregistered" {
          value 5;
          description
            "When read, the value of 'reregistered' indicates that the
           given logical link on the OLT / ONU has been
           reregistered.";
        }
      }
      description
        "Enumeration of valid administrative states for a logical
       link on the OLT or ONU.";
    }

    typedef ompe-mode {
      type enumeration {
        enum "unknown" {
          value 0;
          description
            "omp-emulation mode: unknown = system is initializing";
        }
        enum "olt" {
          value 1;
          description
            "omp-emulation mode: olt";
        }
        enum "onu" {
          value 2;
          description
            "omp-emulation mode: onu";
        }
      }
      description
        "Enumeration of valid OMP-Emulation modes for EPON
       interfaces.";
      reference
        "IEEE Std 802.3, 30.3.7.1.2";

    }

    typedef fec-capability {
      type enumeration {
        enum "unknown" {
          value 0;
          description
            "FEC capability: unknown = system is initializing.";
        }
        enum "supported" {
          value 1;
          description
            "FEC capability: supported.";
        }
        enum "NotSupported" {
          value 2;
          description
            "FEC capability: not supported.";
        }
      }
      description
        "Enumeration of valid FEC capability values for EPON
       interfaces with enabled MPCP.";
      reference
        "IEEE Std 802.3, 30.5.1.1.15";

    }

    typedef fec-mode {
      type enumeration {
        enum "unknown" {
          value 0;
          description
            "FEC mode: unknown = system is initializing.";
        }
        enum "disabled" {
          value 1;
          description
            "FEC mode: disabled = FEC is disabled for the given
           logical link (both Tx and Rx directions).";
        }
        enum "enabled-Tx-Rx" {
          value 2;
          description
            "FEC mode: enabled-Tx-Rx = FEC is enabled for the given
           logical link in both Tx and Rx directions.";
        }
        enum "enabled-Tx-only" {
          value 3;
          description
            "FEC mode: enabled-Tx-only = FEC is enabled for
           the given logical link but only in Tx direction.";
        }
        enum "enabled-Rx-only" {
          value 4;
          description
            "FEC mode: enabled-Rx-only = FEC is enabled for
           the given logical link but only in Rx direction.";
        }
      }
      description
        "Enumeration of valid FEC modes for EPON interfaces.";
      reference
        "IEEE Std 802.3, 30.5.1.1.16";

    }

    typedef power-level {
      type int32;
      units "0.1 dBm";
      description
        "Power level reflects the value of power, as measured at the
       optical transceiver, expressed in units of 0.1 dBm.";
    }

    typedef trx-admin-state {
      type enumeration {
        enum "enabled" {
          value 0;
          description
            "When read as 'enabled', the transmitter is enabled and
           operating under the control of the logical control
           protocol. When set to 'enabled', the transmitter is
           enabled to operate under the control of the logical
           control protocol.";
        }
        enum "disabled" {
          value 1;
          description
            "When read as 'disabled', the transmitter is currently
           disabled (not transmitting). When set to 'disabled',
           the transmitter is expected to be disabled
           (to stop transmitting).";
        }
      }
      description
        "Enumeration of valid administrative states for an optical
       transceiver.";
      reference
        "IEEE Std 802.3.1, dot3ExtPkgOptIfTransmitEnable";

    }
  }  // module ieee802-ethernet-pon