vlib: deprecate i2c and cj

i2c follows its only use case - the original 82599 driver - into
extras/deprecated.

cj is/was an emergency debug tool unused in several years. Move to
extras/deprecated/vlib

Type: refactor

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: Ib55b65373f62630db295c562974bd8f2456c3107

4 files changed, 661 insertions, 0 deletions

diff --git a/extras/deprecated/vlib/i2c.c b/extras/deprecated/vlib/i2c.c
new file mode 100644
index 00000000000..97f5bb21cc7
--- /dev/null
+++ b/extras/deprecated/vlib/i2c.c
@@ -0,0 +1,231 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <vlib/vlib.h>
+#include <vlib/i2c.h>
+
+static inline void
+i2c_delay (i2c_bus_t * b, f64 timeout)
+{
+  vlib_main_t *vm = vlib_get_main ();
+  vlib_time_wait (vm, timeout);
+}
+
+static void
+i2c_wait_for_scl (i2c_bus_t * b)
+{
+  f64 t = 0;
+
+  while (t < b->hold_time)
+    {
+      int sda, scl;
+      i2c_delay (b, b->rise_fall_time);
+      b->get_bits (b, &scl, &sda);
+
+      if (scl)
+	return;
+
+      t += b->rise_fall_time;
+    }
+  b->timeout = 1;
+}
+
+static void
+i2c_start (i2c_bus_t * b)
+{
+  b->timeout = 0;
+
+  b->put_bits (b, 1, 1);
+  i2c_wait_for_scl (b);
+
+  if (vlib_i2c_bus_timed_out (b))
+    return;
+
+  b->put_bits (b, 1, 0);
+  i2c_delay (b, b->hold_time);
+  b->put_bits (b, 0, 0);
+  i2c_delay (b, b->hold_time);
+}
+
+static void
+i2c_stop (i2c_bus_t * b)
+{
+  b->put_bits (b, 0, 0);
+  i2c_delay (b, b->rise_fall_time);
+
+  b->put_bits (b, 1, 0);
+  i2c_delay (b, b->hold_time);
+
+  b->put_bits (b, 1, 1);
+  i2c_delay (b, b->hold_time);
+}
+
+static void
+i2c_write_bit (i2c_bus_t * b, int sda)
+{
+  b->put_bits (b, 0, sda);
+  i2c_delay (b, b->rise_fall_time);
+
+  b->put_bits (b, 1, sda);
+  i2c_wait_for_scl (b);
+  i2c_delay (b, b->hold_time);
+
+  b->put_bits (b, 0, sda);
+  i2c_delay (b, b->rise_fall_time);
+}
+
+static void
+i2c_read_bit (i2c_bus_t * b, int *sda)
+{
+  int scl;
+
+  b->put_bits (b, 1, 1);
+  i2c_wait_for_scl (b);
+  i2c_delay (b, b->hold_time);
+
+  b->get_bits (b, &scl, sda);
+
+  b->put_bits (b, 0, 1);
+  i2c_delay (b, b->rise_fall_time);
+}
+
+static void
+i2c_write_byte (i2c_bus_t * b, u8 data)
+{
+  int i, sda;
+
+  for (i = 7; i >= 0; i--)
+    {
+      i2c_write_bit (b, (data >> i) & 1);
+      if (b->timeout)
+	return;
+    }
+
+  b->put_bits (b, 0, 1);
+  i2c_delay (b, b->rise_fall_time);
+
+  i2c_read_bit (b, &sda);
+
+  if (sda)
+    b->timeout = 1;
+}
+
+
+static void
+i2c_read_byte (i2c_bus_t * b, u8 * data, int ack)
+{
+  int i, sda;
+
+  *data = 0;
+
+  b->put_bits (b, 0, 1);
+  i2c_delay (b, b->rise_fall_time);
+
+  for (i = 7; i >= 0; i--)
+    {
+      i2c_read_bit (b, &sda);
+      if (b->timeout)
+	return;
+
+      *data |= (sda != 0) << i;
+    }
+
+  i2c_write_bit (b, ack == 0);
+}
+
+
+void
+vlib_i2c_init (i2c_bus_t * b)
+{
+  f64 tick;
+  if (!b->clock)
+    b->clock = 400000;
+
+  tick = 1.0 / b->clock;
+
+  /* Spend 40% of time in low and high states */
+  if (!b->hold_time)
+    b->hold_time = 0.4 * tick;
+
+  /* Spend 10% of time waiting for rise and fall */
+  if (!b->rise_fall_time)
+    b->rise_fall_time = 0.1 * tick;
+}
+
+void
+vlib_i2c_xfer (i2c_bus_t * bus, i2c_msg_t * msgs)
+{
+  i2c_msg_t *msg;
+  int i;
+
+  vec_foreach (msg, msgs)
+  {
+    i2c_start (bus);
+    i2c_write_byte (bus,
+		    (msg->addr << 1) + (msg->flags == I2C_MSG_FLAG_READ));
+
+    if (msg->flags & I2C_MSG_FLAG_READ)
+      for (i = 0; i < msg->len; i++)
+	{
+	  i2c_read_byte (bus, &msg->buffer[i], /* ack */ i + 1 != msg->len);
+	  if (bus->timeout)
+	    goto done;
+	}
+
+    else
+      for (i = 0; i < msg->len; i++)
+	{
+	  i2c_write_byte (bus, msg->buffer[i]);
+	  if (bus->timeout)
+	    goto done;
+	}
+  }
+
+done:
+  i2c_stop (bus);
+}
+
+void
+vlib_i2c_read_eeprom (i2c_bus_t * bus, u8 i2c_addr, u16 start_addr,
+		      u16 length, u8 * data)
+{
+  i2c_msg_t *msg = 0;
+  u8 start_address[1];
+
+  vec_validate (msg, 1);
+
+  start_address[0] = start_addr;
+  msg[0].addr = i2c_addr;
+  msg[0].flags = I2C_MSG_FLAG_WRITE;
+  msg[0].buffer = (u8 *) & start_address;
+  msg[0].len = 1;
+
+  msg[1].addr = i2c_addr;
+  msg[1].flags = I2C_MSG_FLAG_READ;
+  msg[1].buffer = data;
+  msg[1].len = length;
+
+  vlib_i2c_xfer (bus, msg);
+
+  vec_free (msg);
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/extras/deprecated/vlib/i2c.h b/extras/deprecated/vlib/i2c.h
new file mode 100644
index 00000000000..b79bdc75b81
--- /dev/null
+++ b/extras/deprecated/vlib/i2c.h
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2016 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef included_vlib_i2c_h
+#define included_vlib_i2c_h
+
+#include <vppinfra/types.h>
+
+
+#define I2C_MSG_FLAG_WRITE  0
+#define I2C_MSG_FLAG_READ   1
+
+typedef struct
+{
+  u8 addr;
+  u8 flags;
+  u16 len;
+  u8 *buffer;
+} i2c_msg_t;
+
+typedef struct i2c_bus_t
+{
+  void (*put_bits) (struct i2c_bus_t * b, int scl, int sda);
+  void (*get_bits) (struct i2c_bus_t * b, int *scl, int *sda);
+
+  int timeout;
+  u32 clock;
+  f64 hold_time;
+  f64 rise_fall_time;
+
+  /* Private data */
+  uword private_data;
+
+} i2c_bus_t;
+
+void vlib_i2c_init (i2c_bus_t * bus);
+void vlib_i2c_xfer (i2c_bus_t * bus, i2c_msg_t * msgs);
+void vlib_i2c_read_eeprom (i2c_bus_t * bus, u8 i2c_addr, u16 start_addr,
+			   u16 length, u8 * data);
+
+static inline int
+vlib_i2c_bus_timed_out (i2c_bus_t * bus)
+{
+  return bus->timeout;
+}
+
+#endif /* included_vlib_i2c_h */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/extras/deprecated/vlib/unix/cj.c b/extras/deprecated/vlib/unix/cj.c
new file mode 100644
index 00000000000..e163e1ae017
--- /dev/null
+++ b/extras/deprecated/vlib/unix/cj.c
@@ -0,0 +1,284 @@
+/*
+ *------------------------------------------------------------------
+ * cj.c
+ *
+ * Copyright (c) 2013 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *------------------------------------------------------------------
+ */
+
+/**
+ * @file
+ * Circular journal diagnostic mechanism.
+ *
+ * The @c cj thread-safe circular log buffer scheme is occasionally useful
+ * when chasing bugs. Calls to it should not be checked in.
+ */
+/*? %%clicmd:group_label Circular Journal %% ?*/
+/*? %%syscfg:group_label Circular Journal %% ?*/
+
+#include <stdio.h>
+#include <vlib/vlib.h>
+
+#include <vlib/unix/cj.h>
+
+cj_main_t cj_main;
+
+void
+cj_log (u32 type, void *data0, void *data1)
+{
+  u64 new_tail;
+  cj_main_t *cjm = &cj_main;
+  cj_record_t *r;
+
+  if (cjm->enable == 0)
+    return;
+
+  new_tail = clib_atomic_add_fetch (&cjm->tail, 1);
+
+  r = (cj_record_t *) & (cjm->records[new_tail & (cjm->num_records - 1)]);
+  r->time = vlib_time_now (cjm->vlib_main);
+  r->thread_index = vlib_get_thread_index ();
+  r->type = type;
+  r->data[0] = pointer_to_uword (data0);
+  r->data[1] = pointer_to_uword (data1);
+}
+
+void
+cj_stop (void)
+{
+  cj_main_t *cjm = &cj_main;
+
+  cjm->enable = 0;
+}
+
+
+clib_error_t *
+cj_init (vlib_main_t * vm)
+{
+  cj_main_t *cjm = &cj_main;
+
+  cjm->vlib_main = vm;
+  return 0;
+}
+
+VLIB_INIT_FUNCTION (cj_init);
+
+static clib_error_t *
+cj_config (vlib_main_t * vm, unformat_input_t * input)
+{
+  cj_main_t *cjm = &cj_main;
+  int matched = 0;
+  int enable = 0;
+
+  while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (input, "records %d", &cjm->num_records))
+	matched = 1;
+      else if (unformat (input, "on"))
+	enable = 1;
+      else
+	return clib_error_return (0, "cj_config: unknown input '%U'",
+				  format_unformat_error, input);
+    }
+
+  if (matched == 0)
+    return 0;
+
+  cjm->num_records = max_pow2 (cjm->num_records);
+  vec_validate (cjm->records, cjm->num_records - 1);
+  clib_memset (cjm->records, 0xff, cjm->num_records * sizeof (cj_record_t));
+  cjm->tail = ~0;
+  cjm->enable = enable;
+
+  return 0;
+}
+
+/*?
+ * Configure the circular journal diagnostic mechanism. This is only useful
+ * if you, the developer, have written code to make use of the circular
+ * journal.
+ *
+ * @cfgcmd{records, &lt;number&gt;}
+ * Configure the number of records to allocate for the circular journal.
+ *
+ * @cfgcmd{on}
+ * Enable the collection of records in the circular journal at the
+ * earliest opportunity.
+?*/
+VLIB_CONFIG_FUNCTION (cj_config, "cj");
+
+void
+cj_enable_disable (int is_enable)
+{
+  cj_main_t *cjm = &cj_main;
+
+  if (cjm->num_records)
+    cjm->enable = is_enable;
+  else
+    vlib_cli_output (cjm->vlib_main, "CJ not configured...");
+}
+
+static inline void
+cj_dump_one_record (cj_record_t * r)
+{
+  fprintf (stderr, "[%d]: %10.6f T%02d %llx %llx\n",
+	   r->thread_index, r->time, r->type,
+	   (long long unsigned int) r->data[0],
+	   (long long unsigned int) r->data[1]);
+}
+
+static void
+cj_dump_internal (u8 filter0_enable, u64 filter0,
+		  u8 filter1_enable, u64 filter1)
+{
+  cj_main_t *cjm = &cj_main;
+  cj_record_t *r;
+  u32 i, index;
+
+  if (cjm->num_records == 0)
+    {
+      fprintf (stderr, "CJ not configured...\n");
+      return;
+    }
+
+  if (cjm->tail == (u64) ~ 0)
+    {
+      fprintf (stderr, "No data collected...\n");
+      return;
+    }
+
+  /* Has the trace wrapped? */
+  index = (cjm->tail + 1) & (cjm->num_records - 1);
+  r = &(cjm->records[index]);
+
+  if (r->thread_index != (u32) ~ 0)
+    {
+      /* Yes, dump from tail + 1 to the end */
+      for (i = index; i < cjm->num_records; i++)
+	{
+	  if (filter0_enable && (r->data[0] != filter0))
+	    goto skip;
+	  if (filter1_enable && (r->data[1] != filter1))
+	    goto skip;
+	  cj_dump_one_record (r);
+	skip:
+	  r++;
+	}
+    }
+  /* dump from the beginning through the final tail */
+  r = cjm->records;
+  for (i = 0; i < index; i++)
+    {
+      if (filter0_enable && (r->data[0] != filter0))
+	goto skip2;
+      if (filter1_enable && (r->data[1] != filter1))
+	goto skip2;
+      cj_dump_one_record (r);
+    skip2:
+      r++;
+    }
+}
+
+void
+cj_dump (void)
+{
+  cj_dump_internal (0, 0, 0, 0);
+}
+
+void
+cj_dump_filter_data0 (u64 filter0)
+{
+  cj_dump_internal (1 /* enable f0 */ , filter0, 0, 0);
+}
+
+void
+cj_dump_filter_data1 (u64 filter1)
+{
+  cj_dump_internal (0, 0, 1 /* enable f1 */ , filter1);
+}
+
+void
+cj_dump_filter_data12 (u64 filter0, u64 filter1)
+{
+  cj_dump_internal (1, filter0, 1, filter1);
+}
+
+static clib_error_t *
+cj_command_fn (vlib_main_t * vm,
+	       unformat_input_t * input, vlib_cli_command_t * cmd)
+{
+  int is_enable = -1;
+  int is_dump = -1;
+  unformat_input_t _line_input, *line_input = &_line_input;
+  clib_error_t *error = NULL;
+
+  /* Get a line of input. */
+  if (!unformat_user (input, unformat_line_input, line_input))
+    return clib_error_return (0, "expected enable | disable | dump");
+
+  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (line_input, "enable") || unformat (line_input, "on"))
+	is_enable = 1;
+      else if (unformat (line_input, "disable")
+	       || unformat (line_input, "off"))
+	is_enable = 0;
+      else if (unformat (line_input, "dump"))
+	is_dump = 1;
+      else
+	{
+	  error = clib_error_return (0, "unknown input `%U'",
+				     format_unformat_error, line_input);
+	  goto done;
+	}
+    }
+
+  if (is_enable >= 0)
+    cj_enable_disable (is_enable);
+
+  if (is_dump > 0)
+    cj_dump ();
+
+done:
+  unformat_free (line_input);
+  return error;
+}
+
+/*?
+ * Enable, disable the collection of diagnostic data into a
+ * circular journal or dump the circular journal diagnostic data.
+ * This is only useful if you, the developer, have written code to make
+ * use of the circular journal.
+ *
+ * When dumping the data it is formatted and sent to @c stderr of the
+ * VPP process; when running VPP in <code>unix interactive</code> mode
+ * this is typically the same place as the Debug CLI.
+?*/
+
+/* *INDENT-OFF* */
+VLIB_CLI_COMMAND (cj_command,static) = {
+  .path = "cj",
+  .short_help = "cj <enable | disable | dump>",
+  .function = cj_command_fn,
+};
+/* *INDENT-ON* */
+
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/extras/deprecated/vlib/unix/cj.h b/extras/deprecated/vlib/unix/cj.h
new file mode 100644
index 00000000000..d0a1d46ee99
--- /dev/null
+++ b/extras/deprecated/vlib/unix/cj.h
@@ -0,0 +1,79 @@
+/*
+ *------------------------------------------------------------------
+ * cj.h
+ *
+ * Copyright (c) 2013 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *------------------------------------------------------------------
+ */
+
+#ifndef __included_cj_h__
+#define __included_cj_h__
+
+typedef struct
+{
+  f64 time;
+  u32 thread_index;
+  u32 type;
+  u64 data[2];
+} cj_record_t;
+
+typedef struct
+{
+  volatile u64 tail;
+  cj_record_t *records;
+  u32 num_records;
+  volatile u32 enable;
+
+  vlib_main_t *vlib_main;
+} cj_main_t;
+
+void cj_log (u32 type, void *data0, void *data1);
+
+/*
+ * Supply in application main, so we can log from any library...
+ * Declare a weak reference in the library, off you go.
+ */
+
+#define DECLARE_CJ_GLOBAL_LOG                                   \
+void cj_global_log (unsigned type, void * data0, void * data1)  \
+  __attribute__ ((weak));                                       \
+                                                                \
+unsigned __cj_type;                                             \
+void * __cj_data0;                                              \
+void * __cj_data1;                                              \
+                                                                \
+void                                                            \
+cj_global_log (unsigned type, void * data0, void * data1)       \
+{                                                               \
+  __cj_type = type;                                             \
+  __cj_data0 = data0;                                           \
+  __cj_data1 = data1;                                           \
+}
+
+#define CJ_GLOBAL_LOG_PROTOTYPE
+void
+cj_global_log (unsigned type, void *data0, void *data1)
+__attribute__ ((weak));
+
+void cj_stop (void);
+
+#endif /* __included_cj_h__ */
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */