[HICN-93] Added documentation in the README.md about cli commands, configuration file and binary api.

Added simple example with two vpp forwarders, client and server ping application

Change-Id: I170500cd23c9a08b18ac902307a60e7558eb4ea0
Signed-off-by: Alberto Compagno <acompagn+fdio@cisco.com>

2 files changed, 6 insertions, 12 deletions

diff --git a/hicn-plugin/src/cli.c b/hicn-plugin/src/cli.c
index b03d6a29c..12a65495a 100644
--- a/hicn-plugin/src/cli.c
+++ b/hicn-plugin/src/cli.c
@@ -1197,7 +1197,7 @@ VLIB_CLI_COMMAND(hicn_cli_node_ctl_command, static)=
 VLIB_CLI_COMMAND(hicn_cli_fib_set_command, static)=
 {
 	.path = "hicn fib",
-        .short_help = "hicn fib {{add | delete } prefix <prefix> face <faceid> }"
+        .short_help = "hicn fib {{add | delete } prefix <prefix> face <facei_d> }"
         " | set strategy <strategy_id> prefix <prefix>",
         .function = hicn_cli_fib_set_command_fn,
 };
@@ -1207,7 +1207,7 @@ VLIB_CLI_COMMAND(hicn_cli_show_command, static)=
 {
 	.path = "hicn show",
         .short_help = "hicn show "
-        "[detail] [internal]"
+        "[internal]"
         "[strategies]",
         .function = hicn_cli_show_command_fn,
 };
@@ -1216,7 +1216,7 @@ VLIB_CLI_COMMAND(hicn_cli_show_command, static)=
 VLIB_CLI_COMMAND(hicn_cli_punting_command, static)=
 {
 	.path = "hicn punting",
-        .short_help = "hicn punting {add|delete} prefix <ip_address/mask> intfc <interface> {type ip | type <udp4|udp6> src_port <port> dst_port <port>}",
+        .short_help = "hicn punting {add|delete} prefix <prefix> intfc <sw_if> {type ip | type <udp4|udp6> src_port <port> dst_port <port>}",
         .function = hicn_cli_punting_command_fn,
 };
 
@@ -1231,7 +1231,7 @@ VLIB_CLI_COMMAND(hicn_cli_mapme_command, static)=
 VLIB_CLI_COMMAND(hicn_cli_pgen_client_set_command, static)=
 {
 	.path = "hicn pgen client",
-        .short_help = "hicn pgen client fwd <ip|hicn> src <addr> n_ifaces <n_ifaces> name <addr/subnet> lifetime <interest-lifetime> intfc <data in-interface> max_seq <max sequence number> n_flows <number of flows>",
+        .short_help = "hicn pgen client fwd <ip|hicn> src <src_addr> n_ifaces <n_ifaces> name <prefix> lifetime <interest-lifetime> intfc <data in-interface> max_seq <max sequence number> n_flows <number of flows>",
         .long_help = "Run hicn in packet-gen client mode\n",
         .function = hicn_cli_pgen_client_set_command_fn,
 };
@@ -1240,7 +1240,7 @@ VLIB_CLI_COMMAND(hicn_cli_pgen_client_set_command, static)=
 VLIB_CLI_COMMAND(hicn_cli_pgen_server_set_command, static)=
 {
 	.path = "hicn pgen server",
-        .short_help = "hicn pgen server fwd <ip|hicn> name <addr/subnet> intfc <interest in-interface> size <payload_size>",
+        .short_help = "hicn pgen server fwd <ip|hicn> name <prefix> intfc <interest in-interface> size <payload_size>",
         .long_help = "Run hicn in packet-gen server mode\n",
         .function = hicn_cli_pgen_server_set_command_fn,
 };
diff --git a/hicn-plugin/src/faces/ip/face_ip_cli.c b/hicn-plugin/src/faces/ip/face_ip_cli.c
index 1558c82cb..534ae7f63 100644
--- a/hicn-plugin/src/faces/ip/face_ip_cli.c
+++ b/hicn-plugin/src/faces/ip/face_ip_cli.c
@@ -34,8 +34,6 @@ hicn_face_ip_cli_set_command_fn (vlib_main_t * vm,
   ip46_address_t local_addr;
   ip46_address_t remote_addr;
   hicn_face_id_t face_id = HICN_FACE_NULL;
-  int app_face = 0;
-  u32 cs_reserved = HICN_PARAM_FACE_DFT_CS_RESERVED;
   int ret = HICN_ERROR_NONE;
   int sw_if;
   int face_op = HICN_FACE_NONE;
@@ -74,10 +72,6 @@ hicn_face_ip_cli_set_command_fn (vlib_main_t * vm,
 					format_unformat_error, line_input);
 	    }
 	}
-      else if (unformat (line_input, "app_face %d", &app_face))
-	{
-	  if (unformat (line_input, "cs_size %d", &cs_reserved));
-	}
       else
 	{
 	  return clib_error_return (0, "%s '%U'",
@@ -144,7 +138,7 @@ hicn_face_ip_cli_set_command_fn (vlib_main_t * vm,
 VLIB_CLI_COMMAND (hicn_face_ip_cli_set_command, static) =
 {
   .path = "hicn face ip",
-  .short_help = "hicn face ip {add local <local_address> remote <remote_address> intfc <sw_if>} {app_face <0/1>} {cs_size <size_in_packets>} | {del id <face_id>}",
+  .short_help = "hicn face ip {add local <src_address> remote <dst_address> intfc <sw_if>} | {del id <face_id>}",
   .function = hicn_face_ip_cli_set_command_fn,
 };
 /* *INDENT-ON* */