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 (2022).

This version of this YANG module is part of IEEE Std 802.1Q; see the
standard itself for full legal notices.";

    revision "2024-03-21" {
      description
        "TO BE Published as part of IEEE Std 802.1Q-2022-Revision.
Deprecated stream-id-type, added stream-id-type-upper.";
      reference
        "IEEE Std 802.1Q-2022-Revision, Bridges and Bridged Networks.
        Maintenance Task Group database item 0312.";

    }

    revision "2022-10-29" {
      description
        "Published as part of IEEE Std 802.1Q-2022. Second version";
      reference
        "IEEE Std 802.1Q-2022, 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
          '[0-9a-fA-F]{2}(-[0-9a-fA-F]{2}){5}:[0-9a-fA-F]{2}-[0-9a-fA-F]{2}';
      }
      status deprecated;
      description
        "This typedef is deprecated. Use stream-id-type-upper instead.

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 1: The 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-2022), using a pool of MAC addresses that the TSN CUC
maintains.

NOTE 2: If 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-2022";

    }

    typedef stream-id-type-upper {
      type string {
        pattern
          '[0-9A-F]{2}(-[0-9A-F]{2}){5}:[0-9A-F]{2}-[0-9A-F]{2}';
      }
      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 1: The 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-2022), using a pool of MAC addresses that the TSN CUC
maintains.

NOTE 2: If 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. Only upper
case characters are allowed to be used for the hexadecimal
characters.

stream-id-type-upper 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-2022";

    }
  }  // module ieee802-dot1q-tsn-types