CAM project build is explained in "documentation", hence limiting
README to build documentation alone.

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

* Enable Sphinx extensions.
* Modify section markers to align with readthedocs-sphinx-search.
* Improve readability when rendered with Sphinx.

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

* Restructure Introduction page to give an overview of CAM.
* Change diagrams used.
* Add information for developer view in "Getting Started" page.

Signed-off-by: Filipe Rinaldi <filipe.rinaldi@arm.com>
Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Rename introduction.rst to overview.rst to keep documentation style in
sync with other projects.

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

This patch introduces a command line argument "margin" to the cam-tool
analyze option to add a user-specified margin which will be added to the
"timeout" parameter calculated as a result of running the
cam-app-example in calibration mode. This allows users to fine-tune the
event alarm timeout based on deployment use cases.

Signed-off-by: Rahul Singh <rahul.singh@arm.com>

Prepend error logs with an error string to make the error log messages
more easily identifiable.

Signed-off-by: Debbie Martin <Debbie.Martin@arm.com>

The CI is currently spotting some failure on the test
"test_cam_app_multiple_stream", looking into the log the
cam-app-example fails immediately to send a stream event,
which might imply that the server is not ready yet to serve
the connections.

Increase the default delay to be waited after spawning the
cam-server.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

In the test "test_cam_app_multiple_application", the two
cam-app-example are meant to run concurrently, but since the
delay_s argument is not passed, the applications are started
with a default time offset. Correct this behavior passing a
zero delay.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

A spurious error is happening where the connect function inside
test_socket_single_client is failing with error code 111
(connection refused), it means that the server is not ready yet
to accept connections, so increase the delay before connecting.

While there, implement also a retry mechanism to improve the
robustness of the test.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Currently the function that are used with sockets (connect,
send, recv) are not giving any hint on the type of failure
when they don't succeed, debugging why the issue happened
can be difficult.

So introduce an helper macro that wraps the call and in case
of failure prints also the error inside errno variable.

Wrap every connect, send, recv with the macro.

Add some words to the dictionary to please the spellchecker.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Modify the test case "test_cam_app_multiple_application" in order
to use different UUID and so different configuration files for
each application.

To do that, add configuration files used during the test under
"test/fixture" and modify the test to deploy these files and
use a different uuid and number of streams.
Increase also the processing count to make the execution last
longer and maximize the concurrent execution of the applications.

Add a new entry in the dictionary to please the spell checker.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Some part of the repository, like the pytest tests needs
more than 4 function arguments so they can't be refactored,
hence increase the threshold for the argument count for
the structure code-climate checker.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Test the cam-service with two cam-app-example application
running concurrently, implement the test in test_static_config.py.

To do that, some changes needs to be made to the CAMComponent
and the pytest fixture functions, so add a new fixture function
to pass a second instance of the cam-app-example and modify
the CAMComponent to allow a change in the log name and to return
the process exit code through the stop method.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

The fixture function creating the CAMComponent can be
generalized and perform the same operations without
issues, so use a generic function to retrieve and use
the CAMComponent and call that function from the
fixture functions.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Currently the pytest tests don't save any log from the running
components, leading to an harder debug of it later.

So modify the CAMComponent class and the pytest fixture to save
each time one component runs, a log file, which will be placed
on a folder specific for each test.

Add missing word to the dictionary to please the spell checker
and modify the header to update the year of the changes.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Improve the CAMComponent stop() method by checking if the
process is running and using wait() after sending the
termination signal, because it is not guaranteed that the
process will stop after that.
Use kill() as last resort if the application is still
running.

While there, improve the conftest.py fixture function,
there is no need to specify an autouse function to stop
the server, while we can use the yield in its fixture
function as explained in the docs.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

Filipe Rinaldi authored Dec 04, 2023 and Vineeth Raveendran committed Jan 26, 2024

Move each file format into its own file, add more details to fields.

Signed-off-by: Filipe Rinaldi <filipe.rinaldi@arm.com>
Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Filipe Rinaldi authored Nov 29, 2023 and Vineeth Raveendran committed Jan 26, 2024

* Add missing details to some of the fields.
* Removed Cam-service specific implementation details.
* Fixed grammar.
* Re-worded some of the paragraphs.

Signed-off-by: Filipe Rinaldi <filipe.rinaldi@arm.com>
Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Filipe Rinaldi authored Dec 06, 2023 and Vineeth Raveendran committed Jan 26, 2024

Turn warnings into errors when building Sphinx documentation.

Signed-off-by: Filipe Rinaldi <filipe.rinaldi@arm.com>
Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Currently the tests are creating and deleting a temporary folder in
the same path of the test, it is not a common practice to perform
write operation from the test environment on the test source
structure and it is a limitation for example when the tests are
read from a readonly filesystem.

To overcome this issue, pytest exposes a special framework called
'tmp_path_factory' which is used to create and manage temporary
folders, the framework also keeps 3 history copies of them and
manages the rotation. More info about that in the pytest docs.

So use tmp_path_factory in a test fixture that exposes a variable
called 'test_dir' that generates a folder named after the test,
use such variable in the tests that needs to write on a temporary
folder and while there, remove unused import and list them
alphabetically.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

This commit also removes the `CONFIG_DISK_RAM_VOLUME_SIZE=100` setting
from the `prj.conf` file. The change is necessitated by the deprecation
of the `CONFIG_DISK_RAM_VOLUME_SIZE` option in 3.5.0 version of Zephyr.

Users are recommended to provide ram disk configuration via devicetree.

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

Currently the cam-app-example doesn't set a failure exit code
when one of the stream fails, fix that setting a proper failure
code.

Fixing this bug revealed that the test
'test_cam_app_invalid_event_logic' that is supposed to trigger an
error on the stream was using the wrong logic to test the app exit
code, update it to assert that the app fails.

Signed-off-by: Luca Fancellu <luca.fancellu@arm.com>

CAM service now use cmdline to enable fault exit feature, modify
integration test to align with that.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

At previous we enable the fault exit feature via CMAKE parameter
at build time. To align with other service parameters, add a new
cmdline option to control the exit action when fault happens. By
default this parameter is false.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

In the multi-system deployment, it is not guaranteed that timestamps
from the cam-service must precede the local time. In such cases, there
is the probability of causing invalid timestamps. Hence removing the
timestamp comparison.

Signed-off-by: Vineeth Raveendran <vineeth.raveendran@arm.com>

The assert in Zephyr is an empty Macro if debug mode is disabled,
so the function in assert should be moved out, or it will miss
the chance to run.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

Use CLOCK_REALTIME as the clock type for all cam components.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

In the multi-system deployment, it is not guaranteed that timestamps
from the application must precede the local time of the service. In
such cases, there is the probability of causing invalid timestamps.
Remove the comparison of message timestamp with local time in service
to avoid such failure.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

The connection parameter in cam_service_cfg can not be modified via
command line, and we can always access CONFIG_CAM_SERVICE_MAX_CONN
to get the maximum support connections, so remove this parameter
from cam_service_cfg.

Same reason for removing it from cam_socket_cfg struct.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

* Move the GitLab CI settings to a specialized repository, the relative
code in this repository will be removed.
* Move the docker files to the root directory.

Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>

The code comments at the top of the python code file is the
command/tool description. Move these comments into "argparse" help
fields to provide these information to users.

Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>

Add CAM building on fvp_baser_aemv8r_smp board on GitLab CI:
* Add a Zephyr image based on Zephyr official docker image and install
  the Zephyr source code.
* Build CAM project on fvp_baser_aemv8r_smp board.

Signed-off-by: Jiacheng Tang <jiacheng.tang@arm.com>

Add Kconfig for Zephyr to set parameters of cam-service on Zephyr.

Also add checkment of the defined count of threads, mutex locks
and timers on Zephyr to avoid runtime error.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

If deploy_ctx is not initialized, the default value is indeterminate,
that may cause runtime error at stream processing, so we need to
initialize deploy_ctx before using.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

Zephyr does not support SIGEV_THREAD notification method in timer,
use SIGEV_SIGNAL instead to avoid runtime error.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

1. Define a top level array of thread stack memory regions on Zephyr.
   The count of threads is CAM_SERVICE_MAX_CONN + 1 which means one
   dispatcher thread and CAM_SERVICE_MAX_CONN stream connection
   process threads.
2. Define a non-null pthread attribute while creating new thread on
   Zephyr.

Signed-off-by: Hongda Deng <hongda.deng@arm.com>

Mount FAT file system to a RAM disk.

Signed-off-by: Yanqin Wei <yanqin.wei@arm.com>

Support Zephyr build for cam-service.

Signed-off-by: Yanqin Wei <yanqin.wei@arm.com>

Use Zephyr supported IP address convert function for Zephyr OS.

Signed-off-by: Yanqin Wei <yanqin.wei@arm.com>