Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
S
Software for White Rabbit PTP Core
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
32
Issues
32
List
Board
Labels
Milestones
Merge Requests
7
Merge Requests
7
CI / CD
CI / CD
Pipelines
Schedules
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
Software for White Rabbit PTP Core
Commits
dd547c21
Commit
dd547c21
authored
Nov 03, 2011
by
Tomasz Wlostowski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
ep_pfilter.c: added wishbonized Endpoint's packet classifier driver
parent
20f3af5b
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
243 additions
and
0 deletions
+243
-0
ep_pfilter.c
dev/ep_pfilter.c
+243
-0
No files found.
dev/ep_pfilter.c
0 → 100644
View file @
dd547c21
/* Endpoint Packet Filter/Classifier driver
A little explanation: The WR core needs to classify the incoming packets into
two (or more categories):
- PTP, ARP, DHCP packets, which should go to the WRCore CPU packet queue (mini-nic)
- Other packets matching user's provided pattern, which shall go to the external fabric
port - for example to Etherbone, host network controller, etc.
- packets to be dropped (used neither by the WR Core or the user application)
WR Endpoint (WR MAC) inside the WR Core therefore contains a simple microprogrammable
packet filter/classifier. The classifier processes the incoming packet, and assigns it
to one of 8 classes (an 8-bit word, where each bit corresponds to a particular class) or
eventually drops it. Hardware implementation of the unit is a simple VLIW processor with
32 single-bit registers (0 - 31). The registers are organized as follows:
- 0: don't touch (always 0)
- 1 - 22: general purpose registers
- 23: drop packet flag: if 1 at the end of the packet processing, the packet will be dropped.
- 24..31: packet class (class 0 = reg 24, class 7 = reg 31).
Program memory has 64 36-bit words. Packet filtering program is restarted every time a new packet comes.
There are 5 possible instructions:
1. CMP offset, value, mask, oper, Rd:
------------------------------------------
* Rd = Rd oper ((((uint16_t *)packet) [offset] & mask) == value)
Examples:
* CMP 3, 0xcafe, 0xffff, MOV, Rd
will compare the 3rd word of the packet (bytes 6, 7) against 0xcafe and if the words are equal,
1 will be written to Rd register.
* CMP 4, 0xbabe, 0xffff, MOV, Rd
will do the same with the 4th word and write to Rd its previous value ANDed with the result
of the comparison. Effectively, Rd now will be 1 only if bytes [6..9] of the payload contain word
0xcafebabe.
Note that the mask value is nibble-granular. Thet means you can choose a particular
set of nibbles within a word to be compared, but not an arbitrary set of bits (e.g. 0xf00f, 0xff00
and 0xf0f0 masks are ok, but 0x8001 is wrong.
2. BTST offset, bit_number, oper, Rd
------------------------------------------
* Rd = Rd oper (((uint16_t *)packet) [offset] & (1<<bit_number) ? 1 : 0)
Examples:
* BTST 3, 10, MOV, 11
will write 1 to reg 11 if the 10th bit in the 3rd word of the packet is set (and 0 if it's clear)
3. Logic opearations:
-----------------------------------------
* LOGIC2 Rd, Ra, OPER Rb - 2 argument logic (Rd = Ra OPER Rb). If the operation is MOV or NOT, Ra is
taken as the source register.
* LOGIC3 Rd, Ra, OPER Rb, OPER2, Rc - 3 argument logic Rd = (Ra OPER Rb) OPER2 Rc.
4. Misc
-----------------------------------------
FIN instruction terminates the program.
NOP executes a dummy instruction (LOGIC2 0, 0, AND, 0)
IMPORTANT:
- the program counter is advanved each time a 16-bit words of the packet arrives.
- the CPU doesn't have any interlocks to simplify the HW. That means that you can't compare a
10rd word when PC = 2. Max comparison offset is always equal to the address of the instruction.
- Code may contain up to 64 operations, but it must classify shorter packets faster than in
32 instructions (there's no flow throttling)
*/
#include <stdio.h>
#include "board.h"
#include <endpoint.h>
#include <hw/endpoint_regs.h>
#define PFILTER_MAX_CODE_SIZE 32
#define pfilter_dbg
static
volatile
struct
EP_WB
*
EP
=
(
volatile
struct
EP_WB
*
)
BASE_EP
;
static
const
uint64_t
PF_MODE_LOGIC
=
(
1ULL
<<
34
);
static
const
uint64_t
PF_MODE_CMP
=
0ULL
;
static
int
code_pos
;
static
uint64_t
code_buf
[
32
];
/* begins assembling a new packet filter program */
void
pfilter_new
()
{
code_pos
=
0
;
}
static
void
check_size
()
{
if
(
code_pos
==
PFILTER_MAX_CODE_SIZE
-
1
)
{
pfilter_dbg
(
"microcode: code too big (max size: %d)
\n
"
,
PFILTER_MAX_CODE_SIZE
);
}
}
static
void
check_reg_range
(
int
val
,
int
minval
,
int
maxval
,
char
*
name
)
{
if
(
val
<
minval
||
val
>
maxval
)
{
pfilter_dbg
(
"microcode: %s register out of range (%d to %d)"
,
name
,
minval
,
maxval
);
}
}
void
pfilter_cmp
(
int
offset
,
int
value
,
int
mask
,
pfilter_op_t
op
,
int
rd
)
{
uint64_t
ir
;
check_size
();
if
(
offset
>
code_pos
)
pfilter_dbg
(
"microcode: comparison offset is bigger than current PC. Insert some nops before comparing"
);
check_reg_range
(
rd
,
1
,
15
,
"ra/rd"
);
ir
=
(
PF_MODE_CMP
|
((
uint64_t
)
offset
<<
7
)
|
((
mask
&
0x1
)
?
(
1ULL
<<
29
)
:
0
)
|
((
mask
&
0x10
)
?
(
1ULL
<<
30
)
:
0
)
|
((
mask
&
0x100
)
?
(
1ULL
<<
31
)
:
0
)
|
((
mask
&
0x1000
)
?
(
1ULL
<<
32
)
:
0
))
|
op
|
(
rd
<<
3
);
ir
=
ir
|
((
uint64_t
)
value
&
0xffffULL
)
<<
13
;
code_buf
[
code_pos
++
]
=
ir
;
}
// rd = (packet[offset] & (1<<bit_index)) op rd
void
pfilter_btst
(
int
offset
,
int
bit_index
,
pfilter_op_t
op
,
int
rd
)
{
uint64_t
ir
;
check_size
();
if
(
offset
>
code_pos
)
pfilter_dbg
(
"microcode: comparison offset is bigger than current PC. Insert some nops before comparing"
);
check_reg_range
(
rd
,
1
,
15
,
"ra/rd"
);
check_reg_range
(
bit_index
,
0
,
15
,
"bit index"
);
ir
=
((
1ULL
<<
33
)
|
PF_MODE_CMP
|
((
uint64_t
)
offset
<<
7
)
|
((
uint64_t
)
bit_index
<<
29
)
|
(
uint64_t
)
op
|
((
uint64_t
)
rd
<<
3
));
code_buf
[
code_pos
++
]
=
ir
;
}
void
pfilter_nop
()
{
uint64_t
ir
;
check_size
();
ir
=
PF_MODE_LOGIC
;
code_buf
[
code_pos
++
]
=
ir
;
}
// rd = ra op rb
void
pfilter_logic2
(
int
rd
,
int
ra
,
pfilter_op_t
op
,
int
rb
)
{
uint64_t
ir
;
check_size
();
check_reg_range
(
ra
,
0
,
31
,
"ra"
);
check_reg_range
(
rb
,
0
,
31
,
"rb"
);
check_reg_range
(
rd
,
1
,
31
,
"rd"
);
ir
=
((
uint64_t
)
ra
<<
8
)
|
((
uint64_t
)
rb
<<
13
)
|
(((
uint64_t
)
rd
&
0xf
)
<<
3
)
|
(((
uint64_t
)
rd
&
0x10
)
?
(
1ULL
<<
7
)
:
0
)
|
(
uint64_t
)
op
;
ir
=
ir
|
PF_MODE_LOGIC
|
(
3ULL
<<
23
);
code_buf
[
code_pos
++
]
=
ir
;
}
static
void
pfilter_logic3
(
int
rd
,
int
ra
,
pfilter_op_t
op
,
int
rb
,
pfilter_op_t
op2
,
int
rc
)
{
uint64_t
ir
;
check_size
();
check_reg_range
(
ra
,
0
,
31
,
"ra"
);
check_reg_range
(
rb
,
0
,
31
,
"rb"
);
check_reg_range
(
rc
,
0
,
31
,
"rb"
);
check_reg_range
(
rd
,
1
,
31
,
"rd"
);
ir
=
(
ra
<<
8
)
|
(
rb
<<
13
)
|
(
rc
<<
18
)
|
((
rd
&
0xf
)
<<
3
)
|
((
rd
&
0x10
)
?
(
1
<<
7
)
:
0
)
|
op
;
ir
=
ir
|
PF_MODE_LOGIC
|
(
op2
<<
23
);
code_buf
[
code_pos
++
]
=
ir
;
}
/* Terminates the microcode, loads it to the endpoint and enables the pfilter */
void
pfilter_load
()
{
int
i
;
code_buf
[
code_pos
++
]
=
(
1ULL
<<
35
);
// insert FIN instruction
EP
->
PFCR0
=
0
;
// disable pfilter
for
(
i
=
0
;
i
<
code_pos
;
i
++
)
{
uint32_t
cr0
,
cr1
;
cr1
=
EP_PFCR1_MM_DATA_LSB_W
(
code_buf
[
i
]
&
0xfff
);
cr0
=
EP_PFCR0_MM_ADDR_W
(
i
)
|
EP_PFCR0_MM_DATA_MSB_W
(
code_buf
[
i
]
>>
12
)
|
EP_PFCR0_MM_WRITE_MASK
;
EP
->
PFCR1
=
cr1
;
EP
->
PFCR0
=
cr0
;
}
EP
->
PFCR0
=
EP_PFCR0_ENABLE
;
}
/* sample packet filter initialization:
- redirects broadcasts and PTP packets to the WR Core
- redirects unicasts addressed to self with ethertype 0xa0a0 to the external fabric */
void
pfilter_init_default
()
{
pfilter_new
();
pfilter_nop
();
pfilter_cmp
(
0
,
0xffff
,
0xffff
,
MOV
,
1
);
pfilter_cmp
(
1
,
0xffff
,
0xffff
,
AND
,
1
);
pfilter_cmp
(
2
,
0xffff
,
0xffff
,
AND
,
1
);
/* r1 = 1 when dst mac is broadcast */
pfilter_cmp
(
0
,
0x011b
,
0xffff
,
MOV
,
2
);
pfilter_cmp
(
1
,
0x1900
,
0xffff
,
AND
,
2
);
pfilter_cmp
(
2
,
0x0000
,
0xffff
,
AND
,
2
);
/* r2 = 1 when dst mac is PTP multicast (01:1b:19:00:00:00) */
pfilter_cmp
(
0
,
EP
->
MACH
&
0xffff
,
0xffff
,
MOV
,
3
);
pfilter_cmp
(
1
,
EP
->
MACL
>>
16
,
0xffff
,
AND
,
3
);
pfilter_cmp
(
2
,
EP
->
MACL
&
0xffff
,
0xffff
,
AND
,
3
);
/* r3 = 1 when the packet is unicast to our own MAC */
pfilter_cmp
(
6
,
0xa0a0
,
0xffff
,
MOV
,
4
);
/* r4 = 1 when ethertype = 0xa0a0 */
pfilter_cmp
(
5
,
0x88f8
,
0xffff
,
MOV
,
5
);
/* r5 = 1 when ethertype = PTPv2 */
/* Classes 0-3 go to the minic, 4-7 - to the external fabric */
// pfilter_logic3(R_CLASS(0), 2, AND, 5, OR, 3); // class 0: (PTP or broadcast)
// pfilter_logic2(R_CLASS(1), 1, AND, 6); // class 1: minibone probes
pfilter_logic2
(
30
,
3
,
AND
,
4
);
// class 7: minibone unicasts
pfilter_load
();
}
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment