VPP-305: Documentation for vnet/vnet/unix

[vpp.git] / vnet / vnet / unix / tapcli.h

diff --git a/vnet/vnet/unix/tapcli.h b/vnet/vnet/unix/tapcli.h
index 1f5f4c3..fcd82db 100644 (file)
--- a/vnet/vnet/unix/tapcli.h
+++ b/vnet/vnet/unix/tapcli.h
@@ -14,11 +14,30 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * @file
+ * @brief TAPCLI definitions
+ */
 
 #ifndef __included_tapcli_h__
 #define __included_tapcli_h__
 
+/** TAP CLI errors */
+#define foreach_tapcli_error                           \
+  /* Must be first. */                                  \
+ _(NONE, "no error")                                    \
+ _(READ, "read error")                                  \
+ _(BUFFER_ALLOC, "buffer allocation error")             \
+ _(UNKNOWN, "unknown error")
+
+typedef enum {
+#define _(sym,str) TAPCLI_ERROR_##sym,
+  foreach_tapcli_error
+#undef _
+   TAPCLI_N_ERROR,
+ } tapcli_error_t;
 
+/** TAP CLI interface details struct */
 typedef struct {
   u32 sw_if_index;
   u8 dev_name[64];
@@ -26,4 +45,8 @@ typedef struct {
 
 int vnet_tap_dump_ifs (tapcli_interface_details_t **out_tapids);
 
+#define TAP_MTU_MIN 68
+#define TAP_MTU_MAX 65535
+#define TAP_MTU_DEFAULT 1500
+
 #endif /* __included_tapcli_h__ */