RoCEv2 OTG Model

control/action.yaml

@@ -68,6 +68,8 @@ components:
               x-field-uid: 2
             bgp:
               x-field-uid: 3
+            rocev2:
+              x-field-uid: 4
           x-field-uid: 1
         ipv4:
           $ref: './ipv4.yaml#/components/schemas/Action.Protocol.Ipv4'
@@ -78,6 +80,9 @@ components:
         bgp:
           $ref: './bgp.yaml#/components/schemas/Action.Protocol.Bgp'
           x-field-uid: 4
+        # rocev2:
+        #   $ref: './rocev2.yaml#/components/schemas/Action.Protocol.RoCEv2'
+        #   x-field-uid: 5
     Action.Response.Protocol:
       description: >-
         Response for actions associated with protocols on configured resources.

control/protocol.yaml

@@ -266,4 +266,50 @@ components:
             up:
               x-field-uid: 1
             down:
-              x-field-uid: 2
+              x-field-uid: 2
+    State.Protocol.RoCEv2:
+      description: >-
+        Sets state of configured RoCEv2 peers.
+      type: object
+      required:
+        - choice
+      properties:
+        choice:
+          type: string
+          x-enum:
+            peers:
+              x-field-uid: 1
+          x-field-uid: 1
+        peers:
+          $ref: '#/components/schemas/State.Protocol.RoCEv2.Peers'
+          x-field-uid: 2
+    State.Protocol.RoCEv2.Peers:
+      description: >-
+        Sets state of configured RoCEv2 peers.
+      required:
+        - state
+      properties:
+        peer_names:
+          description: >-
+            The names of RoCEv2 peers for which the state has to be applied.
+            An empty or null list will control all RoCEv2 peers.
+          type: array
+          items:
+            type: string
+          x-constraint:
+          - "/components/schemas/RoCEv2.V4Peer/properties/name"
+          - "/components/schemas/RoCEv2.V6Peer/properties/name"
+          x-field-uid: 1
+        state:
+          description: >-
+            The desired state of RoCEv2 peer.
+            If the desired state is 'up', underlying IP interface(s) would be brought up automatically (if not already up), would attempt to bring up the RoCEv2 session(s) and advertise route(s), if configured.
+            If the desired state is 'down', RoCEv2 session(s) would be brought down. 
+          type: string
+          x-field-uid: 2
+          x-enum:
+            up:
+              x-field-uid: 1
+            down:
+              x-field-uid: 2
+

control/state.yaml

@@ -91,6 +91,8 @@ components:
               x-field-uid: 5
             ospfv2:
               x-field-uid: 6
+            rocev2:
+              x-field-uid: 7
           x-field-uid: 1
         all:
           $ref: './protocol.yaml#/components/schemas/State.Protocol.All'
@@ -109,4 +111,7 @@ components:
           x-field-uid: 6
         ospfv2:
           $ref: './protocol.yaml#/components/schemas/State.Protocol.Ospfv2'
-          x-field-uid: 7
+          x-field-uid: 7
+        rocev2:
+          $ref: './protocol.yaml#/components/schemas/State.Protocol.RoCEv2'
+          x-field-uid: 8

device/device.yaml

@@ -77,6 +77,11 @@ components:
             Configuration for OSPFv2 router.
           $ref: './ospfv2/router.yaml#/components/schemas/Device.Ospfv2Router'
           x-field-uid: 10
+        rocev2:
+          description: >-
+            Configuration for RoCEv2 .
+          $ref: './rocev2/rocev2.yaml#/components/schemas/Device.RoCEv2Peer'
+          x-field-uid: 11
       required: [name]
     Protocol.Options:
       description: >-

device/rocev2/flowsettings.yaml

@@ -0,0 +1,109 @@
+components:
+  schemas:
+    RoCEv2.FlowSettings:
+      description: >-
+          This section has two views, Local End and Remote End.
+           Both views have same configurations. However, the remote and local peer IP addresses are interchanged.
+            This configuration allows you to configure RDMA flow over the same QP number from same source and destination.
+             Default value for commands at Remote peer is set to None.
+              So that by default, this remote peer does not initiate any traffic flow.
+      type: object
+      properties:
+        custom_qp:
+          description: |-
+            Turn on to define QP number.
+          type: boolean
+          default: false
+          x-field-uid: 1
+        custom_qp_number:
+          description: >-
+            Configure the QP range.
+          type: integer
+          format: uint32
+          default: 2
+          minimum: 2
+          maximum: 33554431
+          x-field-uid: 2
+        dscp:
+          description: >-
+            DSCP value for this flow
+          type: integer
+          format: uint32
+          default: 24
+          minimum: 0
+          maximum: 63
+          x-field-uid: 3
+        ecn:
+          description: >-
+            This field allows to configure bits of the Traffic Class field in the IPv4 or IPv6 header to encode four different code points.
+          type: integer
+          format: uint32
+          default: 1
+          minimum: 0
+          maximum: 3
+          x-field-uid: 4
+        udp_source_port:
+          description: >-
+            UDP source port number for this flow.
+          type: integer
+          format: uint32
+          default: 49152
+          minimum: 0
+          maximum: 65535
+          x-field-uid: 5
+        rocev2_verb:
+          description: >-
+            RoCEv2 Verb, Available options are: RDMA WRITE None: The corresponding flow will not take part in traffic..
+          type: string
+          default: write
+          x-enum:
+            none:
+              x-field-uid: 1
+            write:
+              x-field-uid: 2
+            write_with_immediate:
+              x-field-uid: 3
+            send:
+              x-field-uid: 4
+            send_with_immediate:
+              x-field-uid: 5
+          x-field-uid: 6
+        immediate_data:
+          description: >-
+            Immediate Data field required for SEND/WRITE with immediate verb.
+          type: string
+          format: hex
+          default: "00000000"
+          x-field-uid: 7
+        message_size:
+          description: >-
+            The Maximum message size that is allowed to transfer depends on the MTU size and the number of VLANs configured on the interfaces.
+            For any MTU, the maximum number of segmented RDMA WRITE packets for a single WRITE MESSAGE is 65535.
+            That is, a single RDMA WRITE message can be broken into 1 WRITE FIRST, 1 WRITE LAST and (65535-2) WRITE MIDDLE messages.
+            The maximum message size that is allowed to be transferred for a given MTU is constrained by the above conditions.
+            For example, for an MTU size of 1500 bytes,
+            the common header of the RDMA WRITE MIDDLE/LAST will comprise of
+            Ethernet Header + IP Header + UDP Header + BTH Header + iCRC size + Ethernet Trailer size. This works out to be 14+20+8+12+4+4 = 62 bytes.
+            For RDMA WRITE FIRST, we need to add the RETH header size of 16 bytes to the above, which adds up to 78 bytes.
+            Then the maximum message size for 1500 MTU without VLAN becomes:
+            1500 - WRITE FIRST common header + 65534 * (1500 - WRITE LAST/MIDDLE header size) = 1500 - 78 + 65534 * (1500 - 62) = 94239314 bytes or 89 MB.
+          type: integer
+          format: uint32
+          default: 1
+          minimum: 0
+          maximum: 65535
+          x-field-uid: 8
+        message_size_unit:
+          description: >-
+            Unit of the transfer message size. Available options are Bytes, KB, MB.
+          type: string
+          default: MB
+          x-enum:
+            Byte:
+              x-field-uid: 1
+            KB:
+              x-field-uid: 2
+            MB:
+              x-field-uid: 3
+          x-field-uid: 9
+

device/rocev2/rocev2.yaml

@@ -0,0 +1,84 @@
+components:
+  schemas:
+    Device.RoCEv2Peer:
+      description: >-
+        Configuration for one or more IPv4 or IPv6 RoCEv2 Peers.
+      type: object
+      properties:
+        ipv4_interfaces:
+          description: >-
+            This contains an array of references to IPv4 interfaces,  each of which
+            will have list of peers to different destinations.   
+          type: array
+          items:
+            $ref: './rocev2ipv4.yaml#/components/schemas/RoCEv2.V4Interface'
+          x-field-uid: 1
+        ipv6_interfaces:
+          description: >-
+            This contains an array of references to IPv6 interfaces,  each of which
+            will have list of peers to different destinations.
+          type: array
+          items:
+            $ref: './rocev2ipv6.yaml#/components/schemas/RoCEv2.V6Interface'
+          x-field-uid: 2
+    Device.RoCEv2:
+      description: >-
+        Configuration for RoCEv2 peer settings.
+      type: object
+      properties:
+        num_of_qps:
+          description: >-
+            Maximum number of QP per Endpoint.
+          type: integer
+          x-field-uid: 1
+        remote_end_point_ip_address:
+          description: >-
+            Specify the IP address of External NIC i.e Remote End Point IP Address.
+          type: string
+          x-field-uid: 2
+        ib_mtu:
+          description: >-
+            InfiniBand protocol Maximum Transmission Unit (MTU) defines several fix size MTU: 256, 512, 1024, 2048 or 4096 bytes.
+            RDMA write message will have payload size same as configured IB MTU. You can configure custom size also.
+          type: integer
+          #default: 1024
+          format: uint32
+          minimum: 0
+          maximum: 14000
+          x-field-uid: 3
+        traffic_burst_mode:
+          description: >-
+            Traffic Burst Mode to applied in RoCEv2 Traffic , Continuous or Fixed.
+          type: string
+          x-enum:
+            Continuous:
+              x-field-uid: 1
+            Fixed:
+              x-field-uid: 2
+          x-field-uid: 4
+        traffic_burst_count:
+          description: >-
+            Burst Count to applied in RoCEv2 Traffic item.
+          type: integer
+          #default: 1024
+          format: uint32
+          minimum: 0
+          maximum: 16777216
+          x-field-uid: 5
+        name:
+          description: >-
+            The name of RoCEv2 Peer
+          type: string
+          x-field-uid: 6
+        flow_settings:
+          type: array
+          description: >-
+            This section has two views, Local End and Remote End.
+            Both views have same configurations. However, the remote and local peer IP addresses are interchanged.
+            This configuration allows you to configure RDMA flow over the same QP number from same source and destination.
+            Default value for commands at Remote peer is set to None.
+            So that by default, this remote peer does not initiate any traffic flow.
+          items:
+            $ref: './flowsettings.yaml#/components/schemas/RoCEv2.FlowSettings'
+          x-field-uid: 7
+

device/rocev2/rocev2ipv4.yaml

@@ -0,0 +1,51 @@
+components:
+  schemas:
+    RoCEv2.V4Peer:
+      description: >-
+        Configuration for RoCEv2 IPv4 peers.
+      type: object
+      required: [num_of_qps, remote_end_point_ip_address, ib_mtu]
+      properties:
+        num_of_qps:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/num_of_qps
+          x-field-uid: 1
+        remote_end_point_ip_address:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/remote_end_point_ip_address
+          x-field-uid: 2
+        ib_mtu:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/ib_mtu
+          x-field-uid: 3
+        traffic_burst_mode:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/traffic_burst_mode
+          x-field-uid: 4
+        traffic_burst_count:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/traffic_burst_count
+          x-field-uid: 5
+        name:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/name
+          x-field-uid: 6
+        flow_settings:
+          x-include: ./rocev2.yaml#/components/schemas/Device.RoCEv2/properties/flow_settings
+          x-field-uid: 7
+
+
+    RoCEv2.V4Interface:
+      description: >-
+        Configuration for RoCEv2 IPv4 peers.
+      type: object
+      required: [ipv4_name]
+      properties:
+        ipv4_name:
+          description: >-
+            The unique name of the IPv4, used as the source IP for this list of RoCEv2 peers.
+          type: string
+          x-constraint:
+          - '/components/schemas/Device.Ipv4/properties/name'
+          x-field-uid: 1
+        peers:
+          description: >-
+            This contains the list of RoCEv2 peers configured on this interface.
+          type: array
+          items:
+            $ref: './rocev2ipv4.yaml#/components/schemas/RoCEv2.V4Peer'
+          x-field-uid: 2