tCAMIP reference design by Search Replace function

Rev1.02　 2-Jun-2023

1       Introduction. 1

2       Hardware overview. 1

2.1      TOE10GIP. 2

2.2      TOE10GIP_FIFO.. 2

2.2.1      Initial TOE10GIP. 3

2.2.2      Receive dataIn from test PC. 4

2.2.3      Send dataOut to test PC. 5

2.3      Search Replace module. 6

2.3.1      Search Table. 6

2.3.2      Initial State Machine. 8

2.3.3      Replace Table. 9

2.3.4      tCAMIP searching process. 10

3       tCAMIP Search Replace software on Test PC. 11

3.1      Connect/Disconnect button. 12

3.2      Software Replace button. 12

3.2.1      Split all text by space. 12

3.2.2      Search Replace Loop. 12

3.2.3      Convert output array of character to output destination textbox string. 12

3.2.4      Show operation time. 12

3.3      tCAMIP Replace button. 13

3.3.1      alignEightFromText function. 13

3.3.2      toeFifoTransfer function. 13

3.3.3      trimBuffer function. 13

3.3.4      Show operation time. 14

4       Revision History. 15

 

1       Introduction

This document describes detailed reference design of tCAMIP for search/replace function via 10 Gigabit Ethernet. The contents including detailed of hardware design and software function.

The important hardware modules are “TOE10GIP_FIFO.vhd” and “SearchReplace.vhd” will be described in this document.

 

2       Hardware overview

Figure 2‑1 show reference design block diagram, that used 10 Gigabit Ethernet for communication between software on test PC and SearchReplace module in A10SoC/S10MX board.

 

 

 

Figure 2‑1 Reference design block diagram

 

 

2.1     TOE10GIP

This part is contained TOE10GIP, TenGMacPhy, and MacRegCtrl modules. Please visit our website https://dgway.com/TOE10G-IP_A_E.html for more information.

 

2.2     TOE10GIP_FIFO

TOE10GIP_FIFO module is designed for 3 operations, 1^st is initialized TOE10GIP, 2^nd is passing every 64-bit data from TOE10GIP to SearchReplace module, 3^rd is passing every 64-bit data from SearchReplace module to TOE10GIP. The signals are described as Table 2‑1

 

Table 2‑1 I/O signals

 

 

2.2.1   Initial TOE10GIP

After release RstB = ‘1’, TOE10GIP_FIFO start initial TOE10GIP by write all registers by count down rSequence as Table 2‑2. After that when Busy signal from TOE10GIP is ‘0’, it means TOE10GIP is ready to communication. Figure 2‑2 show timing diagram of register writing for initial TOE10GIP.

 

Table 2‑2 Sequence of initialized register writing

 

 

 

Figure 2‑2 Timing diagram of register writing for initial TOE10GIP

 

 

2.2.2   Receive dataIn from test PC

When TOE10GIP received packet data from test PC, the TCPRxFfRdCnt is increased to be not zero. TOE10GIP_FIFO start read data from TOE10GIP with number of TCPRxFfRdCnt. Then dataIn valid and dataInValid is active at next cycle from TCPRxFfRdEn signal. Figure 2‑3 show detailed timing diagram of Receive 8x64-bit dataIn from TOE10GIP.

 

 

 

Figure 2‑3 Timing diagram of receive 8x64-bit dataIn from TOE10GIP

 

 

2.2.3   Send dataOut to test PC

When dataOutValid and dataOut is directly connect to TCPTxFfWrEn and TCPTxFfWrData

 respectively. TOE10GIP_FIFO is designed to detect at the end of data when dataOutValid is changed from ‘1’ to ‘0’. TOE10GIP_FIFO will write data count (rFifoWrCount) to TDL register, then write 0x00000000 to CMD register of TOE10GIP for transfer data to test PC. Figure 2‑4 show detailed timing diagram of Send 8x64-bit dataOut to TOE10GIP.

 

 

 

Figure 2‑4 Timing diagram of send 8x64-bit dataOut to TOE10GIP

 

 

2.3     Search Replace module

Search Replace module is designed to search 64-bit dataIn in Search Table. When dataIn is matched in Search Table, dataOut is assigned with replace word from Replace Table. But if dataIn is not matched in Search Table (resultData=0), the dataIn is assigned to dataOut instead.

 

2.3.1   Search Table

Search Table is dual port RAM, 8K address x 9-bit width. This table is assigned to be rule table for tCAMIP.

Port A is reserved for future used.

Port B is connected with tCAMIP as shown in Table 2‑3.

ruleCount(3) is designed to generate 1 clock cycle pulse delay from ruleRdReq signal and is assigned to be ruleRdValid signal. Figure 2‑5 show timing diagram of ruleRdValid generation.

 

Table 2‑3 Port B signal mapping of search table

 

 

 

Figure 2‑5 Timing diagram of ruleRdValid generation

 

 

Each 8-byte ASCII code of search word is assigned as 8 x 9-bit rule. The “don’t care” byte is assigned as [x], 0x100 value. Table 2‑4 shows sample conversion from search word to rule table. Search Table is initialed values with file “search.mif”.

 

Table 2‑4 Sample of search word conversion to rule table memory

 

Note: All numbers are hex number.

 

2.3.2   Initial State Machine

This reference design is provided simple state machine to initialize tCAMIP. Figure 2‑6 show timing diagram of Initial State Machine to generate ruleInit signal and check ruleBusy and ruleStatusCode signals. Operation of initialization is described as below.

·       When RstB is active (‘0’), rState is set to stIdle.

·       When RstB is released (‘1’), rState is changed to stInitStart.

·       At stInitStart, rState is changed to stWaitReady when ruleBusy is active from tCAMIP.

·       At stWaitReady, rState is changed to stInitCompleted when ruleBusy is released to zero and ruleStatusCode is 0001b (initial completed).

o   In case that ruleBusy is released to zero but ruleStatusCode is not 0001b, it means tCAMIP initialization is not success. rState is changed to stIdle for restart initial process again.

 

 

Figure 2‑6 Timing diagram of Initial State Machine

 

2.3.3   Replace Table

Replace Table is dual port RAM, 1K address x 64-bit width. This table is assigned with replace word. The relation between search word, replace word and memory data is shown as in

Table 2‑6. Replace Table is initialed values with file “replace.mif”

According to resultData from tCAMIP is mapping with Rule No., then address of replace word can be calculated by resultData minus 1 (rep_address_b <= resultData – 1). The detailed of signals assignment is shown as below.

Port A is reserved for user logics.

Port B is connected with signals as shown in Table 2‑5.

 

Table 2‑5 Port B signal mapping of replace table

 

Table 2‑6 Sample of search word conversion to rule table memory

 

 

2.3.4   tCAMIP searching process

Figure 2‑7 shows timing diagram of searching data path. The detailed operation of searching process is described as below.

After tCAMIP initialization is completed by initial process on topic 2.3.2, In every clock cycle, dataIn will be searching by tCAMIP and set resultData as matched Rule No. by latency 7 clock cycles.

rep_address_b (resultData – 1) from tCAMIP is used for address of Replace Table, then rep_q_b is out from Replace Table after 2 clock cycles because Replace Table memory is generated with both registers of input address port and output port.

rSearchMatch(0) is set to ‘1’ when resultData from tCAMIP is zero (not match). Then rSearchMatch(1) is one clock cycle delay from rSearchMatch(0).

To control timing of input dataIn and rep_q_b in the same clock cycle, dataIn8 is 9 clock cycles delay from dataIn signals, then dataIn8 and rep_q_b is valid in the same clock cycle.

rLongWord is set to be ‘1’ when previous cycle of dataIn8[63:56] (last byte of word) is 0x20 (space bar character).

Then dataOut is register output multiplexer that is assigned with rep_q_b when rLongWord=’0’ and rSearchMatch(1)=’1’, else is assigned with dataIn8.

 

 

 

Figure 2‑7 Timing diagram of searching data path

 

 

3       tCAMIP Search Replace software on Test PC

Main function is separated into 3 parts, 1^st is connect/disconnect button with A10SoC/S10MX board. 2^nd is Software Replace button. 3^rd is tCAMIP Replace button. The user interface is shown as Figure 3‑1

Software Replace button and tCAMIP Replace button is designed with the same function by search and replace words from input source text to show replace words in output destination text.

 

 

 

Figure 3‑1 tCAMIP Search Replace software

 

 

3.1     Connect/Disconnect button

When user click connect button, software will open connection to A10SoC/S10MX board at IP=192.168.7.80 port=60000.

In the other hand, disconnect button is used to disconnect from A10SoC/S10MX board.

 

3.2     Software Replace button

This button called softSearchReplace function where is designed to search and replace word by “replaceTable” dictionary. The software operation can be explained in 4 parts as below.

 

3.2.1   Split all text by space

The first step, software will split string from input source text into array of strings by below syntax.

 

3.2.2   Search Replace Loop

For loop with number of split words, is used to search each word. In case that split word is not found in replaceTable dictionary, split word is concatenated in output array of characters. In another case that split word is found in replaceTable dictionary, replace word is concatenated in output array of characters.instead.

 

3.2.3   Convert output array of character to output destination textbox string

When loop is finished, output array of character is converted to string type and show into output destination textbox string as below syntax.

 

3.2.4   Show operation time.

At the end of this function will show popup message for text size and operation time.

 

 

3.3     tCAMIP Replace button

This button called tCAMIPSearchReplace function where is designed to search and replace word by using tCAMIP on A10SoC/S10MX do instead of software. The software operation can be explained in 4 parts as below.

 

3.3.1   alignEightFromText function

According to TOE10GIP need to data alignment with 64-bit data, this function is designed to add ‘space’ character (ASCII = 0x20) between each word to align with 64-bit data.

 

Table 3‑1 alignEightFromText function

 

3.3.2   toeFifoTransfer function

According to tCAMIP will do search replace function in this reference design. So toeFifoTransfer is designed to transmit/receive 64-bit aligned buffer data to/from A10SoC/S10MX board.

 

Table 3‑2 toeFifoTransfer function

 

3.3.3   trimBuffer function

According topic 3.3.1, software adds ‘space’ to input source text to align with 64-bit data. So trimBuffer function is designed to remove the additional ‘space’ from receive buffer, then convert from array of byte to be string type.

 

Table 3‑3 trimBuffer function

 

3.3.4   Show operation time.

At the end of this function will show popup message for text size and operation time.

 

 

4       Revision History