module bbf-hardware-rpf-dpu {

    yang-version 1.1;

    namespace
      "urn:bbf:yang:bbf-hardware-rpf-dpu";

    prefix bbf-hw-rpf-dpu;

    import bbf-hardware-types {
      prefix bbf-hwt;
    }
    import bbf-yang-types {
      prefix bbf-yang;
    }
    import ietf-hardware {
      prefix hw;
    }
    import ietf-inet-types {
      prefix inet;
    }
    import ietf-yang-types {
      prefix yang;
    }

    organization
      "Broadband Forum <https://www.broadband-forum.org>
     Common YANG Work Area";

    contact
      "Comments or questions about this Broadband Forum YANG module
     should be directed to <mailto:help@broadband-forum.org>.

     Editor:      Ken Kerpez, ASSIA, Inc.

     Editor:      Joey Boyd, ADTRAN

     PS Leader:   Sowrirajan Padmanabhan, Nokia

     PS Leader:   Joey Boyd, ADTRAN

     WA Director: Sven Ooghe, Nokia

     WA Director: Joey Boyd, ADTRAN";

    description
      "This module contains a collection of YANG definitions for
     supporting the Broadband Forum requirements on management of
     Reverse Power Feeding (RPF) as defined in ITU G.997.2 Annex A and
     BBF TR-159. As such, this module is specific to access network
     equipment (e.g., BBF-specified Access Nodes and FTTdp DPUs).

     Copyright (c) 2016-2020 Broadband Forum

     Redistribution and use in source and binary forms, with or
     without modification, are permitted provided that the following
     conditions are met:

     1. Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.

     2. Redistributions in binary form must reproduce the above
        copyright notice, this list of conditions and the following
        disclaimer in the documentation and/or other materials
        provided with the distribution.

     3. Neither the name of the copyright holder nor the names of its
        contributors may be used to endorse or promote products
        derived from this software without specific prior written
        permission.

     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
     CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES,
     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
     ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

     The above license is used as a license under copyright only.
     Please reference the Forum IPR Policy for patent licensing terms
     <https://www.broadband-forum.org/ipr-policy>.

     Any moral rights which are necessary to exercise under the above
     license grant are also deemed granted under this license.

     This version of this YANG module is part of TR-355a3; see
     the TR itself for full legal notices.";

    revision "2020-10-13" {
      description
        "Amendment 3.
       * Approval Date:    2020-10-13
       * Publication Date: 2020-10-13.";
      reference
        "TR-355a3: YANG Modules for FTTdp Management
        	    <https://www.broadband-forum.org/download/
        		   TR-355_Amendment-3.pdf>";

    }

    revision "2019-06-11" {
      description
        "Amendment 2.
       * Approval Date:    2019-06-11
       * Publication Date: 2019-06-11.";
      reference
        "TR-355a2: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Amendment-2.pdf>";

    }

    revision "2018-10-01" {
      description
        "Amendment 1.
       * Approval Date:    2018-10-01
       * Publication Date: 2018-10-01.";
      reference
        "TR-355a1: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Amendment-1.pdf>";

    }


    feature performance-24hr {
      description
        "Indicates that collection of 24 hour performance intervals
       is supported.";
    }

    typedef performance-15min-interval {
      type uint8 {
        range "0..96";
      }
      description
        "Defines the range of 15 minute intervals.";
    }

    typedef performance-15min-history-interval {
      type performance-15min-interval {
        range "1..96";
      }
      description
        "Defines the range of 15 minutes intervals and defines
       the position of the interval relative to the current interval
       where 1 is the most recent completed interval.";
    }

    typedef performance-24hr-interval {
      type uint8 {
        range "0..7";
      }
      description
        "Defines the range of 24 hour intervals.";
    }

    typedef performance-24hr-history-interval {
      type performance-24hr-interval {
        range "1..7";
      }
      description
        "Defines the range of 24 hour intervals and defines
       the position of the interval relative to the current interval
       where 1 is the most recent completed interval.";
    }

    typedef dpu-reconfiguration-state {
      type enumeration {
        enum "normal" {
          value 0;
          description
            "The line is in Normal mode.";
        }
        enum "bypass" {
          value 1;
          description
            "The line is in Bypass mode.";
        }
      }
      description
        "Reports the ReConfiguration State for the line. A state
       change alarm shall be raised indicating a change of the
       line's Reconfiguration State (see clause A.7.2.1.2).";
      reference
        "ITU-T G.997.2 clause A.7.4.1.3 (DPU-RCS)";

    }

    typedef pse-rpf-state {
      type enumeration {
        enum "pse-ukn" {
          value 0;
          description
            "Shutdown with unknown reason as initial state.
            - when for the line the Power Extractor (PE) transitions
              to 'start-up' after the PE detects loss of voltage,
              and has not received a PSE-DGL or PSE-OHP
              indication ( see clause A.6.2.2) from the Power Source
              Equipment (PSE).";
        }
        enum "pse-dgl" {
          value 1;
          description
            "Shutdown with dying gasp (normal shutdown).
            - when for the line the Power Extractor (PE) transitions
              to 'start-up' after the PE detects loss of voltage
              and has received a PSE-DGL indication (see
              clause A.6.2.2) from the Power Source Equipment (PSE).";
        }
        enum "pse-ohp" {
          value 2;
          description
            "Shutdown with dying gasp with off-hook phone.
            - when for the line the Power Extractor (PE) transitions
              to 'start-up' after the PE detects loss of voltage
              and has received a PSE-OHP indication (see
              clause A.6.2.2) from the Power Source Equipment (PSE).";
        }
        enum "pse-pwr" {
          value 3;
          description
            "Powered with unknown Power Source Equipment (PSE) powering
           method.
            - when for the line the Power Extractor (PE) transitions
              to 'normal-operations' and it is yet unknown whether the
              PSE is battery powered or mains powered.";
        }
        enum "pse-bat" {
          value 4;
          description
            "Battery powered.
            - when for the line the Power Extractor (PE) transitions
              to 'normal-operations' and the PE received an indication
              that the Power Source Equipment (PSE) is trying to start
              up the DPU while powered on battery (PRP PS field,
              see section 6.2.5.1 of [ETSI TS 101 548]);
            - when for the line the PE is in 'normal-operations' and
              the PE receives a PSE-BAT indication (see clause 6.2.2)
              from the PSE.";
        }
        enum "pse-acm" {
          value 5;
          description
            "Mains powered.
            - when for the line the Power Extractor (PE) transitions
              to 'normal-operations' and the PE received an indication
              that the Power Source Equipment (PSE) was trying to
              start up the Distribution Point Unit (DPU) while powered
              on mains (PRP PS field, see section 6.2.5.1 of [ETSI TS
              101 548]);
            - when for the line the PE is in 'normal-operations' and
              the PE receives a PSE-ACM or PSE-BBA indication (see
              clause A.6.2.2) from the PSE.";
        }
      }
      description
        "Reports the reverse power feeding state of the Power Source
       Equipment (PSE).";
      reference
        "ITU-T G.997.2 clause A.7.4.2.2 (PSE-RPF)";

    }

    identity rpf-threshold-crossing-alert {
      description
        "Base identity for Reverse Power Feeding (RPF) threshold
       crossing alerts (TCA).

       This identity is abstract and is not be used for a
       threshold crossing alert.";
    }

    identity rpf-15min-threshold-crossing-alert {
      base rpf-threshold-crossing-alert;
      description
        "A threshold crossing alert associated with performance
       counters collected over the current 15 minute interval
       for Reverse Power Feeding (RPF).

       This identity is abstract and is not be used for a
       threshold crossing alert.";
    }

    identity rpf-24hr-threshold-crossing-alert {
      base rpf-threshold-crossing-alert;
      description
        "A threshold crossing alert associated with performance
       counters collected over the current 24 hour interval
       for Reverse Power Feeding (RPF).

       This identity is abstract and is not be used for a
       threshold crossing alert.";
    }

    identity dpu-15min-extracted-energy-tca {
      base rpf-15min-threshold-crossing-alert;
      description
        "The count of the Distribution Point Unit (DPU) extracted energy
       per line at U-O interface or at Power Supply Unit (PSU) input
       in the current 15 minute interval has exceeded the configured
       threshold.";
      reference
        "ITU-T G.997.2 clause A.7.3.4 (CURR/PREV_NE_15/24_EE)";

    }

    identity dpu-24hr-extracted-energy-tca {
      base rpf-24hr-threshold-crossing-alert;
      description
        "The count of the DPU extracted energy per line at U-O interface
       or at Power Supply Unit (PSU) input in the current 24 hour
       interval has exceeded the configured threshold.";
      reference
        "ITU-T G.997.2 clause A.7.3.4 (CURR/PREV_NE_15/24_EE)";

    }

    identity pse-15min-injected-energy-tca {
      base rpf-15min-threshold-crossing-alert;
      description
        "The count of the Power Source Equipment (PSE) injected energy
       per line in the current 15 minute interval has exceeded the
       configured threshold.";
      reference
        "ITU-T G.997.2 clause A.7.3.5 (CURR/PREV_FE_15/24_IE)";

    }

    identity pse-24hr-injected-energy-tca {
      base rpf-24hr-threshold-crossing-alert;
      description
        "The count of the Power Source Equipment (PSE) injected energy
       per line in the current 24 hour interval has exceeded the
       configured threshold.";
      reference
        "ITU-T G.997.2 clause A.7.3.5 (CURR/PREV_FE_15/24_IE)";

    }

    container rpf {
      description
        "System level configuration of Reverse Power Feeding.";
      container near-end-system {
        description
          "System configuration associated with the near-end.";
        leaf dying-gasp-udp-port {
          type inet:port-number;
          description
            "The UDP port number used for dying gasp messages.";
          reference
            "BBF TR-301i2 R-21.";

        }
      }  // container near-end-system
    }  // container rpf

    notification loss-of-power-dpu-shutdown {
      description
        "This notification is sent when the Distribution Point Unit
       (DPU) is about to shutdown because the Reverse Power Feeding
       (RPF) state of the last reverse power feeding line has entered
       the 'PSE-DGL' state. In case of an actual shutdown, this
       notification may not get transmitted.";
      leaf line {
        type leafref {
          path "/hw:hardware/hw:component/hw:name";
        }
        must
          "derived-from-or-self(/hw:hardware/hw:component
            [hw:name=current()]/hw:class,'bbf-hwt:fastdsl-tp')" {
          description
            "Only hardware components which are capable of
           Reverse Power Feeding (RPF) must be referenced.";
        }
        mandatory true;
        description
          "Reference to the line which was the last reverse power
         feeding line to enter the 'PSE-DGL' state.";
      }

      leaf line-id {
        type uint32 {
          range "1..4095";
        }
        mandatory true;
        description
          "A unique numeric identifier associated with the port.";
        reference
          "TR-301i2 Figure 8-1";

      }

      leaf rpf-state {
        type pse-rpf-state;
        mandatory true;
        description
          "Reports the reverse power feeding state of the Power Source
         Equipment (PSE).";
        reference
          "ITU-T G.997.2 clause A.7.4.2.2 (PSE-RPF)";

      }
    }  // notification loss-of-power-dpu-shutdown
  }  // module bbf-hardware-rpf-dpu