docs: devices-- add FEATURES.yaml
Type: docs
Change-Id: I039ba9ad5385452b202366fba0b367506a21ea4f
Signed-off-by: Paul Vinciguerra <pvinci@vinciconsulting.com>
diff --git a/src/vnet/devices/pipe/FEATURE.yaml b/src/vnet/devices/pipe/FEATURE.yaml
new file mode 100644
index 0000000..0886ec5
--- /dev/null
+++ b/src/vnet/devices/pipe/FEATURE.yaml
@@ -0,0 +1,11 @@
+name: Pipe Device
+maintainer: Damjan Marion <damarion@cisco.com>
+features:
+ - L4 checksum offload
+description: "Create a pipe device interface, which can pass packets bidirectionally in one side of the pipe to the other side of the pipe. While similar in behavior to a unix pipe, it is not a host-based pipe."
+missing:
+ - does not use hw-address
+ - does not support tagged traffic
+ - API dump filtering by sw_if_index
+state: production
+properties: [API, CLI, STATS, MULTITHREAD]
diff --git a/src/vnet/devices/pipe/pipe.api b/src/vnet/devices/pipe/pipe.api
index 2dc72a6..457bc74 100644
--- a/src/vnet/devices/pipe/pipe.api
+++ b/src/vnet/devices/pipe/pipe.api
@@ -23,7 +23,7 @@
import "vnet/interface_types.api";
-/** \brief Initialize a new pipe interface with the given paramters
+/** \brief Initialize a new pipe interface with the given parameters
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param is_specified - if non-0, a specific user_instance is being requested
@@ -55,7 +55,7 @@
/** \brief Delete pipe interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
- @param sw_if_index - interface index of existing pipe interface
+ @param sw_if_index - interface index of existing parent pipe interface
*/
autoreply define pipe_delete
{
diff --git a/src/vnet/devices/pipe/pipe.c b/src/vnet/devices/pipe/pipe.c
index 89932a7..384c2c5 100644
--- a/src/vnet/devices/pipe/pipe.c
+++ b/src/vnet/devices/pipe/pipe.c
@@ -21,7 +21,7 @@
* @file
* @brief Pipe Interfaces.
*
- * A pipe interface, like the UNIX pipe, is a pair of interfaces
+ * A pipe interface, like the UNIX pipe, is a pair of vpp interfaces
* that are joined.
*/
const static pipe_t PIPE_INVALID = {
@@ -30,7 +30,7 @@
};
/**
- * Various 'module' lavel variables
+ * Various 'module' level variables
*/
typedef struct pipe_main_t_
{
@@ -40,7 +40,7 @@
uword *instances;
/**
- * the per-swif-index array of pipes. Each end of the pipe is stored againt
+ * the per-swif-index array of pipes. Each end of the pipe is stored against
* its respective sw_if_index
*/
pipe_t *pipes;
@@ -51,7 +51,7 @@
/*
* The pipe rewrite is the same size as an ethernet header (since it
* is an ethernet interface and the DP is optimised for writing
- * sizeof(ethernet_header_t) rewrites. Hwoever, there are no MAC addresses
+ * sizeof(ethernet_header_t) rewrites. However, there are no MAC addresses
* since pipes don't have them.
*/
static u8 *