module ieee802-dot1q-tsn-types {

    yang-version 1;

    namespace
      'urn:ieee:std:802.1Q:yang:ieee802-dot1q-tsn-types';

    prefix dot1q-tsn-types;

    import ietf-inet-types {
      prefix inet;
    }

    organization
      "Institute of Electrical and Electronics Engineers";

    contact
      "WG-URL: http://ieee802.org/1/
    WG-EMail: stds-802-1@ieee.org
    
    Contact: IEEE 802.1 Working Group Chair
    Postal: C/O IEEE 802.1 Working Group
           IEEE Standards Association
           445 Hoes Lane
           Piscataway
           NJ 08854
           USA
    
    E-mail: stds-802-1@ieee.org";

    description
      "Common typedefs and groupings for TSN user/network configuration in
    IEEE Std 802.1Q.
    
    Copyright (C) IEEE (2021).
    
    This version of this YANG module is part of IEEE Std 802.1Q; see the
    standard itself for full legal notices.";

    revision "2021-06-01" {
      description
        "Published as part of IEEE Std 802.1Q-2021. Second version";
      reference
        "IEEE Std 802.1Q-2021, Bridges and Bridged Networks.";

    }

    revision "2018-02-15" {
      description
        "Amendment: Stream Reservation Protocol (SRP) Enhancements and
      Performance Improvements. Initial version";
      reference
        "46.3 of IEEE Std 802.1Qcc-2018";

    }


    typedef stream-id-type {
      type string {
        pattern "";
      }
      description
        "This typedef specifies a Stream ID, a unique identifier of the
      Stream's configuration, used by protocols in the network to associate
      the user's Stream with TSN resources.
      
      The Stream ID is a string that represents two fields:
      
      MAC Address:
      
      A 48-bit IEEE 802 MAC address associated with the Talker sourcing the
      Stream to the bridged network. The entire range of MAC addresses are
      acceptable.
      
      NOTE 1The MAC address component of the StreamID can, but does not
      necessarily, have the same value as the source_address parameter of
      any frame in the actual data Stream. For example, the Stream ID can be
      assigned by a TSN CUC (see 46.1.3.3 of IEEE Std 802.1Q-2021), using a
      pool of MAC addresses that the TSN CUC maintains.
      
      NOTE 2If the MAC addresses used to construct Stream IDs are not unique
      within the network, duplicate Stream IDs can be generated, with
      unpredictable results.
      
      Unique ID:
      
      A 16-bit unique ID that is used to distinguish between multiple
      Streams within the station identified by MAC Address.
      
      The string specifies eight octets, with each octet represented as two
      hexadecimal characters. The first six octets specify the MAC Address,
      using the canonical format of IEEE Std 802, with a dash separating
      each octet. The last two octets specify the Unique ID, with the
      high-order octet, a dash, and then the low-order octet. The MAC
      Address and Unique ID are separated by colon.
      
      stream-id-type is intended for use by other modules as the type for a
      key to a list of Stream configurations (using group-talker and
      group-listener) and a list of Stream status (using group-status-stream
      and group-status-talker-listener).";
      reference
        "46.2.3.1 of IEEE Std 802.1Q-2021";

    }

    grouping group-interface-id {
      description
        "This YANG grouping specifies the identification of a distinct point
      of attachment (interface) in a station (end station or Bridge).";
      reference
        "46.2.3.3 of IEEE Std 802.1Q-2021";

      leaf mac-address {
        type string {
          pattern "";
        }
        description
          "mac-address is the EUI-48 MAC address (IEEE Std 802) of the
        interface in the station (end station or Bridge). This MAC address
        uniquely identifies the station within the local network.
        
        mac-address shall be included in an instance of a container using
        group-interface-id.
        
        NOTEThis MAC address can be discovered in the physical topology
        using protocols such as IEEE Std 802.1AB (LLDP). LLDP supports MAC
        address as a subtype for the stations Chassis ID and Port ID. If the
        station does not use MAC address for its LLDP IDs, remote management
        can be used to associate this mac-address to the values provided in
        the LLDP IDs.
        
        The string uses the hexadecimal representation specified in IEEE Std
        802 (i.e. canonical format).";
      }

      leaf interface-name {
        type string;
        description
          "interface-name is the name of the interface that is assigned
        locally by the station (end station or Bridge).
        
        interface-name may be included in an instance of a container using
        group-interface-id.
        
        IEEE Std 802 recommends that each distinct point of attachment to an
        IEEE 802 network have its own EUI MAC address. If the identified
        station follows this IEEE 802 recommendation, the mac-address leaf
        uniquely identifies the interface as well as the station, and
        interface-name is not needed.
        
        If the mac-address applies to more than one interface (distinct
        point of attachment) within the station, interface-name provides a
        locally assigned name that can help to identify the interface.
        
        When YANG is used for management of the station, interface-name is
        the interface name that serves as the key for the stations interface
        list (RFC7223).
        
        NOTE 1The TSN CNC is typically located in a different physical
        product than the station identified by this group-interface-id.
        Since the interface-name is assigned locally by the identified
        station, it is possible that the stations product will change
        interface-name in a manner that the TSN CNC cannot detect. For
        example, RFC7223 mentions that the YANG interface name can change
        when a physical attachment point is inserted or removed.
        
        NOTE 2This interface name can be discovered in the physical topology
        using protocols such as IEEE Std 802.1AB (LLDP). LLDP supports
        interface name as a subtype for its Port ID. If the station does not
        use interface name for its LLDP Port ID, remote management can be
        used to associate this interface-name to the values provided in the
        LLDP Port ID.";
      }
    }  // grouping group-interface-id

    grouping group-ieee802-mac-addresses {
      description
        "This YANG grouping specifies the pair of IEEE 802 MAC addresses for
      Stream identification.
      
      The use of these fields for Stream identification corresponds to the
      managed objects for Stream identification in IEEE Std 802.1CB. If
      inconsistency arises between this specification and IEEE Std 802.1CB,
      IEEE Std 802.1CB takes precedence.";
      reference
        "46.2.3.4.1 of IEEE Std 802.1Q-2021";

      leaf destination-mac-address {
        type string {
          pattern "";
        }
        description
          "Destination MAC address.
        
        An address of all 1's specifies that the destination MAC address is
        ignored for purposes of Stream identification.
        
        The string uses the hexadecimal representation specified in IEEE Std
        802 (i.e. canonical format).";
      }

      leaf source-mac-address {
        type string {
          pattern "";
        }
        description
          "Source MAC address.
        
        An address of all 1's specifies that the source MAC address is
        ignored for purposes of Stream identification.
        
        The string uses the hexadecimal representation specified in IEEE Std
        802 (i.e. canonical format).";
      }
    }  // grouping group-ieee802-mac-addresses

    grouping group-ieee802-vlan-tag {
      description
        "This YANG grouping specifies a customer VLAN Tag (C-TAG of clause
         9) for Stream identification.
      
      The Drop Eligible Indicator (DEI) field is not relevant from the
      perspective of a TSN Talker/Listener.
      
      The use of these fields for Stream identification corresponds to the
      managed objects for Stream identification in IEEE Std 802.1CB. If
      inconsistency arises between this specification and IEEE Std 802.1CB,
      IEEE Std 802.1CB takes precedence.";
      reference
        "46.2.3.4.2 of IEEE Std 802.1Q-2021";

      leaf priority-code-point {
        type uint8 {
          range "0 .. 7";
        }
        description
          "Priority Code Point (PCP) field.
        
        The priority-code-point is not used to identify the Stream, but it
        does identify a traffic class (queue) in Bridges.";
      }

      leaf vlan-id {
        type uint16 {
          range "0 .. 4095";
        }
        description
          "VLAN ID (VID) field.
        
        If only the priority-code-point is known, the vlan-id is specified
        as 0.";
      }
    }  // grouping group-ieee802-vlan-tag

    grouping group-ipv4-tuple {
      description
        "This YANG grouping specifies parameters to identify an IPv4 (RFC791)
      Stream.
      
      The use of these fields for Stream identification corresponds to the
      managed objects for Stream identification in IEEE Std 802.1CB. If
      inconsistency arises between this specification and IEEE Std 802.1CB,
      IEEE Std 802.1CB takes precedence.";
      reference
        "46.2.3.4.3 of IEEE Std 802.1Q-2021";

      leaf source-ip-address {
        type inet:ipv4-address;
        description
          "Source IPv4 address.
        
        An address of all 0's specifies that the IP source address is
        ignored for purposes of Stream identification.";
      }

      leaf destination-ip-address {
        type inet:ipv4-address;
        description
          "Destination IPv4 address.";
      }

      leaf dscp {
        type uint8;
        description
          "Differentiated services code point, DSCP (RFC2474).
        
        A value of 64 decimal specifies that the DSCP is ignored for
        purposes of Stream identification.";
      }

      leaf protocol {
        type uint16;
        description
          "IPv4 Protocol (e.g. UDP).
        
        The special value of all 1s (FFFF hex) represents None, meaning that
        protocol, source-port, and destination-port are ignored for purposes
        of Stream identification.
        
        For any value other than all 1s, the lower octet is used to match
        IPv4 Protocol.";
      }

      leaf source-port {
        type uint16;
        description
          "This matches the source port of the protocol.";
      }

      leaf destination-port {
        type uint16;
        description
          "This matches the destination port of the protocol.";
      }
    }  // grouping group-ipv4-tuple

    grouping group-ipv6-tuple {
      description
        "This YANG grouping specifies parameters to identify an IPv6 (RFC8200)
      Stream.
      
      The use of these fields for Stream identification corresponds to the
      managed objects for Stream identification in IEEE Std 802.1CB. If
      inconsistency arises between this specification and IEEE Std 802.1CB,
      IEEE Std 802.1CB takes precedence.";
      reference
        "46.2.3.4.4 of IEEE Std 802.1Q-2021";

      leaf source-ip-address {
        type inet:ipv6-address;
        description
          "Source IPv6 address.
        
        An address of all 0's specifies that the IP source address is
        ignored for purposes of Stream identification.";
      }

      leaf destination-ip-address {
        type inet:ipv6-address;
        description
          "Destination IPv6 address.";
      }

      leaf dscp {
        type uint8;
        description
          "Differentiated services code point, DSCP (RFC2474).
        
        A value of 64 decimal specifies that the DSCP is ignored for
        purposes of Stream identification.";
      }

      leaf protocol {
        type uint16;
        description
          "IPv6 Next Header (e.g. UDP).
        
        The special value of all 1s (FFFF hex) represents None, meaning that
        protocol, source-port, and destination-port are ignored for purposes
        of Stream identification.
        
        For any value other than all 1s, the lower octet is used to match
        IPv6 Next Header.";
      }

      leaf source-port {
        type uint16;
        description
          "This matches the source port of the protocol.";
      }

      leaf destination-port {
        type uint16;
        description
          "This matches the destination port of the protocol.";
      }
    }  // grouping group-ipv6-tuple

    grouping group-user-to-network-requirements {
      description
        "This YANG grouping specifies specifies user requirements for the
      Stream, such as latency and redundancy.
      
      The network (e.g. CNC) will merge all user-to-network-requirements for
      a Stream to ensure that all requirements are met.";
      reference
        "46.2.3.6 of IEEE Std 802.1Q-2021";

      leaf num-seamless-trees {
        type uint8;
        default "1";
        description
          "num-seamless-trees specifies the number of trees that the network
        will configure to deliver seamless redundancy for the Stream.
        
        The value zero is interpreted as one (i.e. no seamless redundancy).
        
        This requirement is provided from the Talker only. Listeners shall
        set this leaf to one.
        
        From each Talker to a single Listener, the network configures a path
        that relays Stream data through Bridges. If the Talker has more than
        one Listener, the network configures a tree of multiple paths.
        
        num-seamless-trees specifies the number of maximally disjoint trees
        that the network shall configure from the Talker to all Listeners.
        Each tree is disjoint from other trees, in that the network
        evaluates the physical topology to avoid sharing the same Bridge and
        links in each trees paths. This computation of disjoint trees is
        maximal, in that shared Bridges and links are avoided to the maximum
        extent allowed by the physical topology. For example, if a single
        link exists from a Bridge to a Listener, and num-seamless-trees is
        3, then all 3 trees will share that link to the Listener.
        
        When num-seamless-trees is greater than one, the transfer of the
        Streams data frames shall use a seamless redundancy standard, such
        as IEEE Std 802.1CB. When a link shared by multiple trees diverges
        to multiple disjoint links, the seamless redundancy standard
        replicates (i.e. forwards a distinct copy of each data frame to the
        disjoint trees). When disjoint trees converge to a single link, the
        seamless redundancy standard eliminates the duplicate copies of each
        data frame. Assuming that other sources of frame loss are mitigated
        (e.g. congestion), failure of a link or Bridge in one disjoint tree
        does not result in frame loss as long as at least one remaining
        disjoint tree is operational.
        
        If the Talker sets this leaf to one, the network may make use of
        redundancy standards that are not seamless (i.e. failure of link
        results in lost frames), such as MSTP and IS-IS.
        
        If the Talker sets this leaf to greater than one, and seamless
        redundancy is not possible in the current network (no disjoint
        paths, or no seamless redundancy standard in Bridges),
        group-status-stream.status-info.failure-code is non-zero (46.2.4.1
        of IEEE Std 802.1Q-2021).
        
        If group-user-to-network-requirements is not provided by the Talker
        or Listener, the network shall use the default value of one for this
        leaf.";
        reference
          "46.2.3.6.1 of IEEE Std 802.1Q-2021";

      }

      leaf max-latency {
        type uint32;
        default "0";
        description
          "Maximum latency from Talker to Listener(s) for a single frame of
        the Stream.
        
        max-latency is specified as an integer number of nanoseconds.
        
        Latency shall use the definition of 3.102, with additional context
        as follows: The Known reference point in the frame is the message
        timestamp point specified in IEEE Std 802.1AS for various media
        (i.e. start of the frame). The first point is in the Talker, at the
        reference plane marking the boundary between the network media and
        PHY (see IEEE Std 802.1AS). The second point is in the Listener, at
        the reference plane marking the boundary between the network media
        and PHY.
        
        When this requirement is specified by the Talker, it must be
        satisfied for all Listeners.
        
        When this requirement is specified by the Listener, it must be
        satisfied for this Listener only.
        
        If group-user-to-network-requirements is not provided by the Talker
        or Listener, the network shall use the default value of zero for
        this leaf.
        
        The special value of zero represents usage of the initial value of
        group-status-talker-listener.accumulated-latency as the maximum
        latency requirement. This effectively locks-down the initial latency
        that the network calculates after successful configuration of the
        Stream, such that any subsequent increase in latency beyond that
        value causes the Stream to fail.
        
        The assumption for when the first point occurs in the Talker depends
        on the presence of the time-aware container in the Talkers
        traffic-specification.
        
        When time-aware is not present:
        
        The Talker is assumed to transmit at an arbitrary time (not
        scheduled).
        
        When time-aware is present:
        
        The first point is assumed to occur at the start of
        traffic-specification.interval, as if the Talkers offsets
        (earliest-transmit-offset and latest-transmit-offset) are both zero.
        The Talkers offsets are not typically zero, but use of the start of
        interval for purposes of max-latency allows the Listener(s) to
        schedule their application independently from the Talkers offset
        configuration.
        
        The Listener determines max-latency based on its scheduling of a
        read function in the application. Nevertheless, the time from frame
        reception (i.e. second point) to execution of the read function is
        in the user scope, and therefore not included in max-latency.
        
        max-latency can be set to a value greater than the Talkers interval,
        in order to specify a longer latency requirement. For example, if
        the Talkers interval is 500 microsec, and max-latency is 700
        microsec, the Listener receives the frame no later than 200 microsec
        into the interval that follows the Talkers interval.";
        reference
          "46.2.3.6.2 of IEEE Std 802.1Q-2021";

      }
    }  // grouping group-user-to-network-requirements

    grouping group-interface-capabilities {
      description
        "This YANG grouping specifies the network capabilities of all
      interfaces (Ports) contained in end-station-interfaces.
      
      The network may provide configuration of these capabilities in
      group-status-talker-listener.interface-configuration.
      
      NOTEIf an end station contains multiple interfaces with different
      network capabilities, each interface should be specified as a distinct
      Talker or Listener (i.e. one entry in end-station-interfaces). Use of
      multiple entries in end-station-interfaces is intended for network
      capabilities that span multiple interfaces (e.g. seamless redundancy).";
      reference
        "46.2.3.7 of IEEE Std 802.1Q-2021";

      leaf vlan-tag-capable {
        type boolean;
        default "false";
        description
          "When vlan-tag-capable is true, the interface supports the ability
        to tag/untag frames using a Customer VLAN Tag (C-TAG of clause 9)
        provided by the network.
        
        For a Talker, the networks tag replaces the tag specified by the
        data-frame-specification. If the data-frame-specification is
        untagged (no group-ieee802-vlan-tag), the networks tag is inserted
        in the frame as it passes through the interface.
        
        For a Listener, the users tag from the data-frame-specification
        replaces the networks tag as the frame passes through the interface.
        If the data-frame-specification is untagged (no
        group-ieee802-vlan-tag), the networks tag is removed from the frame
        as it passes through the interface.
        
        If the end station supports more than one interface (i.e. more than
        one entry in end-station-interfaces), vlan-tag-capable of true means
        that a distinct VLAN tag can be applied to each interface. The list
        of VLAN tag (one for each interface) can be provided by the network
        in interface-configuration.interface-list (ieee802-vlan-tag choice).
        
        When vlan-tag-capable is false, the interface does not support the
        capability to tag/untag frames using a Customer VLAN Tag (C-TAG of
        clause 9) provided by the network.
        
        If interface-capabilities is not provided by the Talker or Listener,
        the network shall use the default value of false for this leaf.";
        reference
          "46.2.3.7.1 of IEEE Std 802.1Q-2021";

      }

      leaf-list cb-stream-iden-type-list {
        type uint32;
        description
          "cb-stream-iden-type-list provides a list of the supported Stream
        Identification types as specified in IEEE Std 802.1CB.
        
        Each Stream Identification type is provided as a 32-bit unsigned
        integer. The upper three octets contain the OUI/CID, and the lowest
        octet contains the type number.
        
        NOTEIf the Talker/Listener end system supports IEEE Std 802.1CB,
        Null Stream identification is required, and that Stream
        Identification type is included in this list. If the Talker/Listener
        end system does not support IEEE Std 802.1CB, this list is empty.
        
        If the end station supports more than one interface (i.e. more than
        one interface-id in end-station-interfaces, an empty
        cb-stream-iden-type-list means that the end station is capable of
        transferring the Stream on any one of its interfaces (not all). When
        this is specified, the network shall decide which interface is best
        used for TSN purposes, and communicate that decision by returning a
        single interface in interface-configuration.interface-list. The
        Talker/Listener uses this interface alone for the Stream.
        
        If interface-capabilities is not provided within group-talker or
        group-listener, the network shall use an empty list as the default
        value for this element.";
        reference
          "46.2.3.7.2 of IEEE Std 802.1Q-2021";

      }

      leaf-list cb-sequence-type-list {
        type uint32;
        description
          "cb-sequence-type-list provides a list of the supported Sequence
        Encode/Decode types as specified in IEEE Std 802.1CB.
        
        Each sequence type is provided as a 32-bit unsigned integer. The
        upper three octets contain the OUI/CID, and the lowest octet
        contains the type number.
        
        If interface-capabilities is not provided within group-talker or
        group-listener, the network shall use an empty list as the default
        value for this element.";
        reference
          "46.2.3.7.3 of IEEE Std 802.1Q-2021";

      }
    }  // grouping group-interface-capabilities

    grouping group-interface-configuration {
      description
        "This YANG grouping provides configuration of interfaces in the
      Talker/Listener. This configuration assists the network in meeting the
      Streams requirements. The interface-configuration meets the
      capabilities of the interface as provided in interface-capabilities.";
      reference
        "46.2.5.3 of IEEE Std 802.1Q-2021";

      list interface-list {
        key "mac-address interface-name";
        description
          "A distinct configuration is provided for each interface in the
        Talker/Listener (even if multiple interfaces use the same
        configuration). Each entry in this interface-list consists of an
        interface identification (group-interface-id), followed by a list of
        configuration values for that interface (config-list).
        
        If interface-configuration is not provided within
        group-status-talker-listener, the network shall assume zero entries
        as the default (no interface configuration).
        
        Since the interface-name leaf is optional, empty string can be used
        for its key value.";
        uses group-interface-id;

        list config-list {
          key "index";
          description
            "List of configuration values for the interface.";
          leaf index {
            type uint8;
            description
              "This index is provided in order to provide a unique key per
            list entry. The value of index for each entry shall be unique
            (but not necessarily contiguous).";
          }

          choice config-value {
            description
              "One of the following choices is provided for each configuration
            value. Each container name acts as the case name for the choice.";
            container ieee802-mac-addresses {
              description
                "Source and destination MAC addresses that apply to the
              network side of the user/network boundary.
              
              NOTE 1On the userside, the MAC addresses correspond to the
              ieee802-mac-addresses of data-frame-specification.
              
              NOTE 2The source MAC address of the network is typically the
              same as the user. The destination MAC address can be
              different. For example, the user can use an individual
              address, but the network can use a group (multicast) address.
              
              This configuration value is not provided unless IEEE Std
              802.1CB is supported, and a value for Active Destination MAC
              and VLAN Stream identification is provided in
              cb-stream-iden-type-list of interface-capabilities.";
              reference
                "46.2.5.3.1 of IEEE Std 802.1Q-2021";

              uses group-ieee802-mac-addresses;
            }  // container ieee802-mac-addresses
            container ieee802-vlan-tag {
              description
                "Customer VLAN Tag (C-TAG of clause 9) that applies to the
              network side of the user/network boundary.
              
              NOTEOn the user side, the VLAN tag corresponds to the
              ieee802-vlan-tag of data-frame-specification (including
              untagged if this field is not provided).
              
              If the user provides a VLAN ID in the ieee802-vlan-tag of
              data-frame-specification, the Streams data frames are assumed
              to be limited to the active topology for that VLAN ID.
              Therefore, if the network uses a different VLAN ID in this
              config-value, the network shall ensure that the replacement
              VLAN ID is limited to the equivalent active topology.
              
              This configuration value is not provided unless
              vlan-tag-capable of interface-capabilities is true.";
              reference
                "46.2.5.3.2 of IEEE Std 802.1Q-2021";

              uses group-ieee802-vlan-tag;
            }  // container ieee802-vlan-tag
            container ipv4-tuple {
              description
                "IPv4 identification that applies to the network side of the
              user/network boundary.
              
              This configuration value is not provided unless IEEE Std
              802.1CB is supported, and a value for IP Stream identification
              is provided in cb-stream-iden-type-list of
              interface-capabilities.";
              reference
                "46.2.5.3.3 of IEEE Std 802.1Q-2021";

              uses group-ipv4-tuple;
            }  // container ipv4-tuple
            container ipv6-tuple {
              description
                "IPv6 identification that applies to the network side of the
              user/network boundary.
              
              This configuration value is not provided unless IEEE Std
              802.1CB is supported, and a value for IP Stream identification
              is provided in cb-stream-iden-type-list of
              interface-capabilities.";
              reference
                "46.2.5.3.4 of IEEE Std 802.1Q-2021";

              uses group-ipv6-tuple;
            }  // container ipv6-tuple
            leaf time-aware-offset {
              type uint32;
              description
                "If the time-aware container is present in the
              traffic-specification of the Talker, this config-value shall
              be provided by the network to the Talker.
              
              If the time-aware container is not present in the
              traffic-specification of the Talker, this config-value shall
              not be provided by the network.
              
              This config-value shall not be provided to Listeners, as it is
              not applicable.
              
              time-aware-offset specifies the offset that the Talker shall
              use for transmit. The network returns a value between
              earliest-transmit-offset and latest-transmit-offset of the
              Talkers traffic-specification. The value is expressed as
              nanoseconds after the start of the Talkers interval.";
              reference
                "46.2.5.3.5 of IEEE Std 802.1Q-2021";

            }
          }  // choice config-value
        }  // list config-list
      }  // list interface-list
    }  // grouping group-interface-configuration

    grouping group-talker {
      description
        "This YANG grouping specifies: - Talkers behavior for Stream (how/when
      transmitted) - Talkers requirements from the network - TSN
      capabilities of the Talkers interface(s)
      
      In the fully centralized model of TSN configuration, this grouping
      originates from the CUC, and is delivered to the CNC.";
      reference
        "46.2.3 of IEEE Std 802.1Q-2021";

      container stream-rank {
        description
          "Rank of this Stream's configuration relative to other Streams in
        the network. This rank is used to determine success/failure of
        Stream resource configuration, and it is unrelated to the Streams
        data.";
        reference
          "46.2.3.2 of IEEE Std 802.1Q-2021";

        leaf rank {
          type uint8;
          description
            "The Rank is used by the network to decide which Streams can and
          cannot exist when TSN resources reach their limit. If a Bridges
          Port becomes oversubscribed (e.g. network reconfiguration, IEEE
          802.11 bandwidth reduction), the Rank is used to help determine
          which Streams can be dropped (i.e. removed from Bridge
          configuration).
          
          The only valid values for Rank shall be zero and one. The
          configuration of a Stream with Rank zero is more important than
          the configuration of a Stream with Rank one. The Rank value of
          zero is intended for emergency traffic, and the Rank value of one
          is intended for non-emergency traffic.
          
          NOTEIt is expected that higher layer applications and protocols
          can use the Rank to indicate the relative importance of Streams
          based on user preferences. Those user preferences are expressed by
          means beyond the scope of this standard. When multiple
          applications exist in a network (e.g. audio/video along with
          industrial control), it can be challenging for the varied
          applications and vendors to agree on multiple Rank values. To
          mitigate such challenges, this Rank uses a simple concept of
          emergency (zero) and non-emergency (one) that can be applied over
          all applications. For example, in a network that carries audio
          Streams for fire safety announcements, all applications are likely
          to agree that those Streams use Rank of zero.";
          reference
            "46.2.3.2.1 of IEEE Std 802.1Q-2021";

        }
      }  // container stream-rank

      list end-station-interfaces {
        key "mac-address interface-name";
        min-elements 1;
        description
          "List of identifiers, one for each physical interface (distinct
        point of attachment) in the end station acting as a Talker.
        
        Although many end stations contain a single interface, this list
        allows for multiple interfaces. Some TSN features allow a single
        Stream to span multiple interfaces (e.g. seamless redundancy).
        
        Each entry of end-station-interfaces is used by the CNC to locate
        the Talker in the topology.
        
        Since the interface-name leaf is optional, empty string can be used
        for its key value.";
        reference
          "46.2.3.3 of IEEE Std 802.1Q-2021";

        uses group-interface-id;
      }  // list end-station-interfaces

      list data-frame-specification {
        key "index";
        min-elements 1;
        description
          "data-frame-specification specifies the frame that carries the
        Talkers Stream data. The network uses the specification to identify
        this Streams frames as TSN, in order to apply the required TSN
        configuration.
        
        The specification is based on the users knowledge of the frame,
        without any network specifics. In other words, this specifies the
        frame that the Talker would use in the absence of TSN.
        
        The specification is provided as a list of fields that the user
        knows. The list is ordered from start of frame to end of header. For
        example, if the Talker uses a VLAN-tagged Ethernet frame (not IP),
        the list consists of ieee802-mac-addresses followed by
        ieee802-vlan-tag. For example, if the Talker uses a UDP/IPv4 packet
        without knowledge of the Ethernet header, the list consists of
        ipv4-tuple.
        
        This list is optional, and its absence indicates that Stream
        transformation is performed in the Talker and Listeners of this
        Stream (46.2.2 of IEEE Std 802.1Q-2021).";
        reference
          "46.2.3.4 of IEEE Std 802.1Q-2021";

        leaf index {
          type uint8;
          description
            "This index is provided in order to provide a unique key per list
          entry. The value of index for each entry shall be unique (but not
          necessarily contiguous).";
        }

        choice field {
          description
            "One of the following choices is provided for each field that the
          user knows. Each container name acts as the case name for the
          choice.";
          container ieee802-mac-addresses {
            description
              "IEEE 802 MAC addresses.";
            uses group-ieee802-mac-addresses;
          }  // container ieee802-mac-addresses
          container ieee802-vlan-tag {
            description "IEEE 802.1 CTAG";
            uses group-ieee802-vlan-tag;
          }  // container ieee802-vlan-tag
          container ipv4-tuple {
            description
              "IPv4 packet identification";
            uses group-ipv4-tuple;
          }  // container ipv4-tuple
          container ipv6-tuple {
            description
              "IPv6 packet identification";
            uses group-ipv6-tuple;
          }  // container ipv6-tuple
        }  // choice field
      }  // list data-frame-specification

      container traffic-specification {
        description
          "This traffic-specification specifies how the Talker transmits
        frames for the Stream. This is effectively the Talkers promise to
        the network. The network uses this traffic spec to allocate
        resources and adjust queue parameters in Bridges.";
        reference
          "46.2.3.5 of IEEE Std 802.1Q-2021";

        container interval {
          description
            "This interval specifies the period of time in which the traffic
          specification cannot be exceeded. The traffic specification is
          specified by max-frames-per-interval and max-frame-size.
          
          The interval is a rational number of seconds, defined by an
          integer numerator and an integer denominator.
          
          If the time-aware container is not present, the interval specifies
          a sliding window of time. The Talkers transmission is not
          synchronized to a time on the network, and therefore the traffic
          specification cannot be exceeded during any interval in time.
          
          If the time-aware container is present, the interval specifies a
          window of time that is aligned with the time epoch that is
          synchronized on the network. For example, if IEEE Std 802.1AS-2011
          is used with the PTP timescale, the first interval begins at 1
          January 00:00:00 TAI. If CurrentTime represents the current time,
          then the start of the next interval (StartOfNextInterval) is:
          StartOfNextInterval = N * interval where N is the smallest integer
          for which the relation StartOfNextInterval >= CurrentTime would be
          TRUE.";
          reference
            "46.2.3.5.1 of IEEE Std 802.1Q-2021";

          leaf numerator {
            type uint32;
            description
              "intervals numerator.";
          }

          leaf denominator {
            type uint32;
            description
              "intervals denominator.";
          }
        }  // container interval

        leaf max-frames-per-interval {
          type uint16;
          description
            "max-frames-per-interval specifies the maximum number of frames
          that the Talker can transmit in one interval.";
          reference
            "46.2.3.5.2 of IEEE Std 802.1Q-2021";

        }

        leaf max-frame-size {
          type uint16;
          description
            "max-frame-size specifies maximum frame size that the Talker will
          transmit, excluding any overhead for media-specific framing (e.g.,
          preamble, IEEE 802.3 header, Priority/VID tag, CRC, interframe
          gap). As the Talker or Bridge determines the amount of bandwidth
          to reserve on the egress Port (interface), it will calculate the
          media-specific framing overhead on that Port and add it to the
          number specified in the max-frame-size leaf.";
          reference
            "46.2.3.5.3 of IEEE Std 802.1Q-2021";

        }

        leaf transmission-selection {
          type uint8;
          description
            "transmission-selection specifies the algorithm that the Talker
          uses to transmit this Streams traffic class. This algorithm is
          often referred to as the shaper for the traffic class.
          
          The value for this leaf uses Table 8-5 (Transmission selection
          algorithm identifiers) of 8.6.8 of IEEE Std 802.1Q-2021. If no
          algorithm is known, the value zero (strict priority) can be used.
          
          The Talkers shaping and scheduling of the Stream is considered to
          be on the user side of the user/network boundary, and this leaf
          specifies the Talkers behavior to the network.";
          reference
            "46.2.3.5.4 of IEEE Std 802.1Q-2021";

        }

        container time-aware {
          presence
            "Specifies that the Talkers traffic is synchronized to aknown"
              + "time on the network (e.g. using IEEE Std 802.1AS)";
          description
            "The time-aware container provides leafs to specify the Talkers
          time-aware transmit to the network.
          
          The Talker and Listeners of a Stream are assumed to coordinate
          using user (application) mechanisms, such that each Listener is
          aware that its Talker transmits in a time-aware manner.
          
          If max-frames-per-interval is greater than one, the Talker shall
          transmit multiple frames as a burst within the interval, with the
          minimum inter-frame gap allowed by the media.
          
          NOTE: Although scheduled traffic (8.6.8.4 of IEEE Std 802.1Q-2021)
          specifies a valid implementation of a time-aware Talker, the
          time-aware container is intended to support alternate
          implementations of scheduling.";
          reference
            "46.2.3.5 of IEEE Std 802.1Q-2021";

          leaf earliest-transmit-offset {
            type uint32;
            description
              "earliest-transmit-offset specifies the earliest offset within
            the interval at which the Talker is capable of starting transmit
            of its frames. As part of
            group-status-talker-listener.interface-configuration, the
            network will return a specific time-aware-offset to the Talker
            (within the earliest/latest range), which the Talker uses to
            schedule its transmit.
            
            earliest-transmit-offset is specified as an integer number of
            nanoseconds.
            
            The Talkers transmit offsets include earliest-transmit-offset,
            latest-transmit-offset, and the time-aware-offset returned to
            the Talker. Each of the Talkers offsets is specified at the
            point when the message timestamp point of the first frame of the
            Stream passes the reference plane marking the boundary between
            the network media and PHY. The message timestamp point is
            specified by IEEE Std 802.1AS for various media.";
            reference
              "46.2.3.5.5 of IEEE Std 802.1Q-2021";

          }

          leaf latest-transmit-offset {
            type uint32;
            description
              "latest-transmit-offset specifies the latest offset within the
            interval at which the Talker is capable of starting transmit
            ofits frames. As part of
            group-status-talker-listener.interface-configuration, the
            network will return a specific time-aware-offset to the Talker
            within the earliest/latest range), which the Talker uses to
            schedule its transmit.
            
            latest-transmit-offset is specified as an integer number of
            nanoseconds.";
            reference
              "46.2.3.5.6 of IEEE Std 802.1Q-2021";

          }

          leaf jitter {
            type uint32;
            description
              "The jitter leaf specifies the maximum difference in time
            between the Talkers transmit offsets, and the ideal synchronized
            network time (e.g. IEEE 802.1AS time). Jitter is specified as an
            unsigned integer number of nanoseconds.
            
            The maximum difference means sooner or later than the ideal
            (e.g. transmit +/- 500 nanoseconds relative to IEEE 802.1AS time
            results in jitter of 500).
            
            The ideal synchronized network time refers to time at the source
            (e.g. IEEE 802.1AS grandmaster). The jitter does not include
            inaccuracies as time is propagated from the time source to the
            Talker, because those inaccuracies are assumed to be known by
            the network, and time synchronization is a network technology.
            The jitter leaf is intended to specify inaccuracies in the
            Talkers implementation. For example, if the Talkers IEEE 802.1AS
            time is +/- 812 nanoseconds relative to the grandmaster, and the
            Talker schedules using a 100 microsecond timer tick driven by
            IEEE 802.1AS time, Jitter is 50000 (not 50812).
            
            The Talkers transmit offsets include earliest-transmit-offset,
            latest-transmit-offset, and the time-aware-offset returned to
            the Talker in
            group-status-talker-listener.interface-configuration.";
            reference
              "46.2.3.5.7 of IEEE Std 802.1Q-2021";

          }
        }  // container time-aware
      }  // container traffic-specification

      container user-to-network-requirements {
        description
          "user-to-network-requirements specifies user requirements for the
        Stream, such as latency and redundancy. The network (CNC) will merge
        all user-to-network-requirements for a Stream to ensure that all
        requirements are met.";
        reference
          "46.2.3.6 of IEEE Std 802.1Q-2021";

        uses group-user-to-network-requirements;
      }  // container user-to-network-requirements

      container interface-capabilities {
        description
          "interface-capabilities specifies the network capabilities of all
        interfaces (Ports) contained in end-station-interfaces.
        
        The network may provide configuration of these capabilities in
        group-status-talker-listener.interface-configuration.
        
        NOTEIf an end station contains multiple interfaces with different
        network capabilities, each interface should be specified as a
        distinct Talker or Listener (i.e. one entry in
        end-station-interfaces). Use of multiple entries in
        end-station-interfaces is intended for network capabilities that
        span multiple interfaces (e.g. seamless redundancy).";
        reference
          "46.2.3.7 of IEEE Std 802.1Q-2021";

        uses group-interface-capabilities;
      }  // container interface-capabilities
    }  // grouping group-talker

    grouping group-listener {
      description
        "This YANG grouping specifies: - Listeners requirements from the
      network - TSN capabilities of the Listeners interface(s)
      
      In the fully centralized model of TSN configuration, this grouping
      originates from the CUC, and is delivered to the CNC.";
      reference
        "46.2.4 of IEEE Std 802.1Q-2021";

      list end-station-interfaces {
        key "mac-address interface-name";
        min-elements 1;
        description
          "List of identifiers, one for each physical interface (distinct
        point of attachment) in the end station acting as a Listener.
        
        Although many end stations contain a single interface, this list
        allows for multiple interfaces. Some TSN features allow a single
        Stream to span multiple interfaces (e.g. seamless redundancy).
        
        Each entry of end-station-interfaces is used by the CNC to locate
        the Listener in the topology.
        
        Since the interface-name leaf is optional, empty string can be used
        for its key value.";
        reference
          "46.2.3.3 of IEEE Std 802.1Q-2021";

        uses group-interface-id;
      }  // list end-station-interfaces

      container user-to-network-requirements {
        description
          "user-to-network-requirements specifies user requirements for the
        Stream, such as latency and redundancy. The network (CNC) will merge
        all user-to-network-requirements for a Stream to ensure that all
        requirements are met.";
        reference
          "46.2.3.6 of IEEE Std 802.1Q-2021";

        uses group-user-to-network-requirements;
      }  // container user-to-network-requirements

      container interface-capabilities {
        description
          "interface-capabilities specifies the network capabilities of all
        interfaces (Ports) contained in end-station-interfaces.
        
        The network may provide configuration of these capabilities in
        group-status-talker-listener.interface-configuration.
        
        NOTEIf an end station contains multiple interfaces with different
        network capabilities, each interface should be specified as a
        distinct Talker or Listener (i.e. one entry in
        end-station-interfaces). Use of multiple entries in
        end-station-interfaces is intended for network capabilities that
        span multiple interfaces (e.g. seamless redundancy).";
        reference
          "46.2.3.7 of IEEE Std 802.1Q-2021";

        uses group-interface-capabilities;
      }  // container interface-capabilities
    }  // grouping group-listener

    grouping group-status-stream {
      description
        "This YANG grouping provides the status of a Streams configuration
      from the network to each user. The status in this grouping applies to
      the entire Stream (Talker and all Listeners).
      
      In the fully centralized model of TSN configuration, this grouping
      originates from the CNC, and is delivered to the CUC.
      
      The group-status-stream and group-status-talker-listener groupings are
      intended to be used by other modules within a list of status (state)
      for each Stream, with each list entry using: - leaf of type
      stream-id-type, used as key to the list - container using
      group-status-stream - container for Talker, using
      group-status-talker-listener - list for Listeners, using
      group-status-talker-listener";
      reference
        "46.2.5 of IEEE Std 802.1Q-2021";

      container status-info {
        description
          "status-info provides information regarding the status of a Streams
        configuration in the network.";
        reference
          "46.2.5.1 of IEEE Std 802.1Q-2021";

        leaf talker-status {
          type enumeration {
            enum "none" {
              value 0;
              description
                "No Talker detected.";
            }
            enum "ready" {
              value 1;
              description
                "Talker ready (configured).";
            }
            enum "failed" {
              value 2;
              description "Talker failed.";
            }
          }
          description
            "This is an enumeration for the status of the Streams Talker.";
          reference
            "46.2.5.1.1 of IEEE Std 802.1Q-2021";

        }

        leaf listener-status {
          type enumeration {
            enum "none" {
              value 0;
              description
                "No Listener detected.";
            }
            enum "ready" {
              value 1;
              description
                "All Listeners ready (configured).";
            }
            enum "partial-failed" {
              value 2;
              description
                "One or more Listeners ready, and one or more Listeners
              failed. If Talker is ready, Stream can be used.";
            }
            enum "failed" {
              value 3;
              description
                "All Listeners failed";
            }
          }
          description
            "This is an enumeration for the status of the Streams Listener(s).";
          reference
            "46.2.5.1.2 of IEEE Std 802.1Q-2021";

        }

        leaf failure-code {
          type uint8;
          description
            "If the Stream encounters a failure (talker-status is failed, or
          listener-status is failed, or listener-status is partial-failed),
          failure-code provides a non-zero code that specifies the problem.
          Table 46-15 of IEEE Std 802.1Q-2021 describes each code.)";
          reference
            "46.2.5.1.3 of IEEE Std 802.1Q-2021";

        }
      }  // container status-info

      list failed-interfaces {
        key "mac-address interface-name";
        description
          "When a failure occurs in network configuration (i.e. non-zero
        failure-code in status-info), failed-interfaces provides a list of
        one or more physical interfaces (distinct points of attachement) in
        the failed end station or Bridge. Each identifier is sufficient to
        locate the interface in the physical topology.
        
        The failed-interfaces list is optional.
        
        Since the interface-name leaf is optional, empty string can be used
        for its key value.";
        reference
          "46.2.5.4 of IEEE Std 802.1Q-2021";

        uses group-interface-id;
      }  // list failed-interfaces
    }  // grouping group-status-stream

    grouping group-status-talker-listener {
      description
        "This YANG grouping provides the status for a specific Talker or
      Listener.
      
      In the fully centralized model of TSN configuration, this grouping
      originates from the CNC, and is delivered to the CUC.";
      reference
        "46.2.5 of IEEE Std 802.1Q-2021";

      leaf accumulated-latency {
        type uint32;
        description
          "accumulated-latency provides the worst-case maximum latency that a
        single frame of the Stream can encounter along its current path(s).
        
        When provided to a Listener, accumulated-latency is the worst-case
        maximum latency for that Listener only.
        
        When provided to a Talker, accumulated-latency is the worst-case
        maximum latency for all Listeners (worst path).
        
        accumulated-latency is specified as an integer number of
        nanoseconds.
        
        accumulated-latency uses the same definition for latency as
        user-to-network-requirements.max-latency.
        
        For successful status-info, the network returns a value less than or
        equal to user-to-network-requirements.max-latency.
        
        If the time-aware container is present in the traffic-specification
        of the Talker, the value is expressed as nanoseconds after the start
        of the Talkers traffic-specification.interval.
        
        If the time-aware container is not present in the
        traffic-specification of the Talker, the value is expressed as
        nanoseconds after the Talkers transmit of any frame in the Stream,
        at any arbitrary time.
        
        If user-to-network-requirements.num-seamless-trees is one,
        accumulated-latency shall provide the worst-case maximum latency for
        the current path from Talker to each Listener. If the path is
        changed (e.g. by a spanning tree protocol), accumulated-latency
        changes accordingly.
        
        If user-to-network-requirements.num-seamless-trees is greater than
        one, accumulated-latency shall provide the worst-case maximum
        latency for all paths configured from the Talker to each Listener.";
        reference
          "46.2.5.2 of IEEE Std 802.1Q-2021";

      }

      container interface-configuration {
        description
          "interface-configuration provides configuration of interfaces in the
        Talker/Listener. This configuration assists the network in meeting
        the Streams requirements. The interface-configuration meets the
        capabilities of the interface as provided in interface-capabilities.";
        reference
          "46.2.5.3 of IEEE Std 802.1Q-2021";

        uses group-interface-configuration;
      }  // container interface-configuration
    }  // grouping group-status-talker-listener
  }  // module ieee802-dot1q-tsn-types