suricata checkin based on commit id a4bce14770beee46a537eda3c3f6e8e8565d5d0a

Change-Id: I9a214fa0ee95e58fc640e50bd604dac7f42db48f

1 files changed, 38 insertions, 0 deletions

diff --git a/framework/src/suricata/contrib/tile_pcie_logd/README b/framework/src/suricata/contrib/tile_pcie_logd/README
new file mode 100644
index 00000000..32ce7a31
--- /dev/null
+++ b/framework/src/suricata/contrib/tile_pcie_logd/README
@@ -0,0 +1,38 @@
+Introduction
+------------
+
+This application allows writing files to an x86 host from a TILEncore-Gx
+PCIe card.  The file name and data are sent over PCIe using the Tilera
+Packet Queue API from an aplication running on the Tilera processor.
+
+The original purpose is to write log files from Suricata (Intrusion
+Dectection System) on the x86 host's file system.
+
+Running The Logger
+------------------
+
+To run the application, set the TILERA_ROOT environment variable to
+point to a valide Tilera MDE, then do:
+
+   make run
+
+The application should be started before the application on the Tile
+side that will be generating the log data.
+
+By default, queue number 0 is used. The --queue_index=N command line
+argument can be used to change the queue number.
+
+If more than one TILEncore-Gx PCIe card is installed, the --card=M
+argument changes to listening to card M.
+
+Caveats
+-------
+
+Due to the fact that the host driver allocates 4MB physically
+contiguous memory for the packet queue ring buffer, it is possible
+that this allocation could fail on a host whose memory has been
+considerably fragmented. If the host program exits with the following
+error, reboot the host and run the test again.
+
+Host: Failed to open '/dev/tilegxpci%d/packet_queue/t2h/0': Cannot
+allocate memory