Skip to content

M
Mock Turtle
Commit 6b2ce74a authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc: improve documentation 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent ea38881f
Hide whitespace changes
Inline Side-by-side
Showing with 19 additions and 0 deletions
doc/software/linux-library.rst
View file @ 6b2ce74a
......@@ -95,6 +95,8 @@ close it with :c:func:`trtl_close`.
.. doxygenfunction:: trtl_close
.. doxygenstruct:: trtl_dev
.. _`sw:lnx:lib:cpu`:
Mock Turtle Cores Management
......@@ -161,6 +163,11 @@ host message queue, different users can have different filters.
.. doxygenfunction:: trtl_hmq_filter_clean
.. doxygenenum:: trtl_msg_filter_operation_type
.. doxygenstruct:: trtl_msg_filter
:members:
Then, there are the functions to exchange messages with firmwares
running on Mock Turtle. This API offers a minimum set of function
to allow users to send/receive synchronous/asynchronous messages.
......@@ -170,6 +177,9 @@ Any processing on the payload is left to the user. This is the rule
for most messages, anyway Mock Turtle offers a set of special messages
which are completely handled by Mock Turtle.
.. doxygenstruct:: polltrtl
:members:
.. doxygenfunction:: trtl_msg_poll
.. doxygenfunction:: trtl_msg_sync
......@@ -214,6 +224,8 @@ to read and write: :c:func:`trtl_smem_write()`, :c:func:`trtl_smem_write()`.
.. doxygenfunction:: trtl_smem_write
.. doxygenenum:: trtl_smem_modifier
Utilities
=========
......@@ -236,3 +248,5 @@ This library offers a set of handlers.
.. doxygenfunction:: trtl_print_message
.. doxygenfunction:: trtl_hmq_fd
.. doxygenenum:: trtl_error_number
software/lib/libmockturtle.h
View file @ 6b2ce74a
......@@ -23,6 +23,11 @@ extern "C" {
extern const unsigned int trtl_default_timeout_ms;
/**
* @struct trtl_dev
* It is obfuscated structure type. This becasue the user should not
* modify it but just use it as a token to access the library API.
*/
struct trtl_dev;
......
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