Skip to content

M
Mock Turtle
Commit 43d0a913 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc:tools: add few line about how to see available Mock Turtle devices 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent 527f619f
Show whitespace changes
Inline Side-by-side
Showing with 36 additions and 12 deletions
doc/tools/mockturtle-buffer.rst
View file @ 43d0a913
...@@ -6,3 +6,6 @@ Mock Turtle Buffer ...@@ -6,3 +6,6 @@ Mock Turtle Buffer
The Mock Turtle buffer application (*mockturtle-buffer*) allows the The Mock Turtle buffer application (*mockturtle-buffer*) allows the
user to read/write the buffers that a firmware exports. The tool only user to read/write the buffers that a firmware exports. The tool only
works with firmware developed using :ref:`sw:fw:frm`. works with firmware developed using :ref:`sw:fw:frm`.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-cpu-restart.rst
View file @ 43d0a913
...@@ -7,3 +7,6 @@ Mock Turtle CPU Restart ...@@ -7,3 +7,6 @@ Mock Turtle CPU Restart
The Mock Turtle CPU Restart application (*mockturtle-cpu-restart*) is The Mock Turtle CPU Restart application (*mockturtle-cpu-restart*) is
used to restart a soft-CPU. This will stop the firmware execution and used to restart a soft-CPU. This will stop the firmware execution and
start it again from the ``main()`` function. start it again from the ``main()`` function.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-firmware-loader.rst
View file @ 43d0a913
.. _`tools:mockturtle-firmware-loader`: .. _`tools:mockturtle-firmware-loader`:
============================== ===========================
Mock Turtle Firmware Loader Mock Turtle Firmware Loader
============================== ===========================
The Mock Turtle Loader application (*mockturtle-firmware-loader*) allows The Mock Turtle Loader application (*mockturtle-firmware-loader*) allows
the user to load a firmware in a soft-CPU. It gives also the possibility the user to load a firmware in a soft-CPU. It gives also the possibility
to dump the RAM content from a soft-CPU. to dump the RAM content from a soft-CPU.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-gdbserver.rst
View file @ 43d0a913
...@@ -14,3 +14,6 @@ starting the *mockturtle-gdbserver*::: ...@@ -14,3 +14,6 @@ starting the *mockturtle-gdbserver*:::
mount -t debugfs none /sys/kernel/debug mount -t debugfs none /sys/kernel/debug
Please refer to the application help message for more information. Please refer to the application help message for more information.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-messages.rst
View file @ 43d0a913
.. _`tools:mockturtle-messages`: .. _`tools:mockturtle-messages`:
====================== ====================
Mock Turtle Messages Mock Turtle Messages
====================== ====================
The Mock Turtle Messages application (*mockturtle-messages*) can be used The Mock Turtle Messages application (*mockturtle-messages*) can be used
to sniff the traffic over a HMQ or to access the serial console of a to sniff the traffic over a HMQ or to access the serial console of a
soft-CPU. soft-CPU.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-ping.rst
View file @ 43d0a913
.. _tools:mockturtle-ping: .. _tools:mockturtle-ping:
================= ================
Mock Turtle Ping Mock Turtle Ping
================= ================
The purpose of the Mock Turtle Ping application (*mockturtle-ping*) is The purpose of the Mock Turtle Ping application (*mockturtle-ping*) is
to be able to verify that a firmware is running. In addition, the to be able to verify that a firmware is running. In addition, the
mockturtle-ping application provides information about the firmware mockturtle-ping application provides information about the firmware
version running on a Mock Turtle soft-CPU. The tool only works with version running on a Mock Turtle soft-CPU. The tool only works with
firmware developed using :ref:`sw:fw:frm`. firmware developed using :ref:`sw:fw:frm`.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-smem.rst
View file @ 43d0a913
.. _tools:mockturtle-smem: .. _tools:mockturtle-smem:
============================= =========================
Mock Turtle Shared Memory Mock Turtle Shared Memory
============================= =========================
The Mock Turtle Shared Memory application (*mockturtle-smem*) provides The Mock Turtle Shared Memory application (*mockturtle-smem*) provides
access to the Mock Turtle shared memory. The user can read/write any location of access to the Mock Turtle shared memory. The user can read/write any location
the shared memory using different access modes. of the shared memory using different access modes.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
doc/tools/mockturtle-variable.rst
View file @ 43d0a913
.. _`tools:mockturtle-variable`: .. _`tools:mockturtle-variable`:
===================== ====================
Mock Turtle Variable Mock Turtle Variable
===================== ====================
The Mock Turtle variable application (*mockturtle-variable*) allows the The Mock Turtle variable application (*mockturtle-variable*) allows the
user to read/write the variables that a firmware exports. The tool only user to read/write the variables that a firmware exports. The tool only
works with firmware developed using :ref:`sw:fw:frm`. works with firmware developed using :ref:`sw:fw:frm`.
You can get the list of available Mock Turtle devices that you can access
with the command ``lsmockturtle``.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment