Blame doc/src/fpga_tools/mmlink/mmlink.md

Packit 534379
# mmlink #
Packit 534379

Packit 534379
## Synopsis  ##
Packit 534379

Packit 534379
`mmlink [-v] [-B <bus>] [-D <device>] [-F <function>] [-S <socket>] [-P <TCP port>] [-I <IP Address>]`
Packit 534379

Packit 534379

Packit 534379
## Description ##
Packit 534379
The Remote Signal Tap logic analyzer provides real-time hardware debugging for the Accelerator Function Unit (AFU). 
Packit 534379
It provides a signal trace capability that the Quartus Prime software adds to the AFU. The Remote Signal Tap logic
Packit 534379
analyzer provides access to the Remote Signal Tap part of the Port MMIO space and then runs the remote protocol.
Packit 534379

Packit 534379
## Examples  ##
Packit 534379

Packit 534379
`./mmlink  -B 0x5e -P 3333`
Packit 534379

Packit 534379
  MMLink app starts and listens for connection.
Packit 534379

Packit 534379
## Options ##
Packit 534379

Packit 534379
`-v,--version`
Packit 534379

Packit 534379
Prints version information and exits.
Packit 534379

Packit 534379
`-B,--bus` 
Packit 534379

Packit 534379
FPGA Bus number.
Packit 534379

Packit 534379
`-D,--device` 
Packit 534379

Packit 534379
FPGA Device number.
Packit 534379

Packit 534379
`-F,--function` 
Packit 534379

Packit 534379
FPGA function number.
Packit 534379

Packit 534379
`-S,--socket` 
Packit 534379

Packit 534379
FPGA socket number.
Packit 534379

Packit 534379
`-P,--port` 
Packit 534379

Packit 534379
TCP port number.
Packit 534379

Packit 534379
`-I,--ip ` 
Packit 534379

Packit 534379
IP address of FPGA system. 
Packit 534379

Packit 534379

Packit 534379
## Notes ##
Packit 534379

Packit 534379
Driver privilege:
Packit 534379

Packit 534379
Change AFU driver privilege to user:
Packit 534379

Packit 534379
```
Packit 534379
$ chmod 777 /dev/intel-fpga-port.0
Packit 534379
```
Packit 534379

Packit 534379

Packit 534379
Change locked memory size:
Packit 534379

Packit 534379
edit the file /etc/security/limits.conf
Packit 534379

Packit 534379
```
Packit 534379
$ sudo vi /etc/security/limits.conf
Packit 534379

Packit 534379
user    hard   memlock           10000
Packit 534379

Packit 534379
user    soft   memlock           10000
Packit 534379
```
Packit 534379

Packit 534379
Exit terminal and log into a new terminal.
Packit 534379

Packit 534379
Verify that the locked memory is now set: 
Packit 534379
```
Packit 534379
$ ulimit -l 10000
Packit 534379

Packit 534379
## Revision History ##
Packit 534379

Packit 534379
 | Document Version |  Intel Acceleration Stack Version  | Changes  |
Packit 534379
 | ---------------- |------------------------------------|----------|
Packit 534379
 | 2018.05.21 | 1.1 Beta. 
(Supported with Intel Quartus Prime Pro Edition 17.1.) | No changes from previous release. |
Packit 534379