mlxsw: documentation: Add resources ABI documentation
authorArkadi Sharshevsky <arkadis@mellanox.com>
Mon, 15 Jan 2018 07:59:12 +0000 (08:59 +0100)
committerDavid S. Miller <davem@davemloft.net>
Tue, 16 Jan 2018 19:15:35 +0000 (14:15 -0500)
Add resources ABI documentation.

Signed-off-by: Arkadi Sharhsevsky <arkadis@mellanox.com>
Signed-off-by: Jiri Pirko <jiri@mellanox.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Documentation/ABI/testing/devlink-resource-mlxsw [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/devlink-resource-mlxsw b/Documentation/ABI/testing/devlink-resource-mlxsw
new file mode 100644 (file)
index 0000000..259ed29
--- /dev/null
@@ -0,0 +1,33 @@
+What:          /kvd/
+Date:          08-Jan-2018
+KernelVersion: v4.16
+Contact:       mlxsw@mellanox.com
+Description:   The main database in the Spectrum device is a centralized
+               KVD database used for many of the tables used to configure
+               the chip including L2 FDB, L3 LPM, ECMP and more. The KVD
+               is divided into two sections, the first is hash-based table
+               and the second is a linear access table. The division
+               between the linear and hash-based sections is static and
+               require reload before the changes take effect.
+
+What:          /kvd/linear
+Date:          08-Jan-2018
+KernelVersion: v4.16
+Contact:       mlxsw@mellanox.com
+Description:   The linear section of the KVD is managed by software as a
+               flat memory accessed using an index.
+
+What:          /kvd/hash_single
+Date:          08-Jan-2018
+KernelVersion: v4.16
+Contact:       mlxsw@mellanox.com
+Description:   The hash based section of the KVD is managed by the switch
+               device. Used in case the key size is smaller or equal to
+               64bit.
+
+What:          /kvd/hash_double
+Date:          08-Jan-2018
+KernelVersion: v4.16
+Contact:       mlxsw@mellanox.com
+Description:   The hash based section of the KVD is managed by the switch
+               device. Used in case the key is larger than 64 bit.