From 97c998c2813d7cea4a067a0b8ff246cad4924bf3 Mon Sep 17 00:00:00 2001 From: Paul Vinciguerra Date: Tue, 29 Oct 2019 16:11:09 -0400 Subject: docs: devices-- add FEATURES.yaml Type: docs Change-Id: I039ba9ad5385452b202366fba0b367506a21ea4f Signed-off-by: Paul Vinciguerra --- src/vnet/devices/pipe/FEATURE.yaml | 11 +++++++++++ src/vnet/devices/pipe/pipe.api | 4 ++-- src/vnet/devices/pipe/pipe.c | 8 ++++---- 3 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 src/vnet/devices/pipe/FEATURE.yaml (limited to 'src/vnet/devices/pipe') diff --git a/src/vnet/devices/pipe/FEATURE.yaml b/src/vnet/devices/pipe/FEATURE.yaml new file mode 100644 index 00000000000..0886ec5d896 --- /dev/null +++ b/src/vnet/devices/pipe/FEATURE.yaml @@ -0,0 +1,11 @@ +name: Pipe Device +maintainer: Damjan Marion +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 2dc72a6ab66..457bc74075a 100644 --- a/src/vnet/devices/pipe/pipe.api +++ b/src/vnet/devices/pipe/pipe.api @@ -23,7 +23,7 @@ option version = "1.0.1"; 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 @@ define pipe_create_reply /** \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 89932a77668..384c2c514fb 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 @@ const static pipe_t PIPE_INVALID = { }; /** - * Various 'module' lavel variables + * Various 'module' level variables */ typedef struct pipe_main_t_ { @@ -40,7 +40,7 @@ typedef struct pipe_main_t_ 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 @@ static pipe_main_t pipe_main; /* * 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 * -- cgit 1.2.3-korg