diff --git a/Documentation/overview.rst b/Documentation/overview.rst index 55c07dffd20ff97c4682bf4783d8d951072b37bd..a6efbb00f22b31994927b25dabb6bcba5cb246d8 100644 --- a/Documentation/overview.rst +++ b/Documentation/overview.rst @@ -14,31 +14,34 @@ Epicardium Epicardium is based on `FreeRTOS <https://www.freertos.org/>`_. There are a number of tasks that will have been keeping card10 running. These are: -+-------------------+-------------------------------+----------+-------------------------------------------+ -| Name | ID Global | Priority | Description | -+===================+===============================+==========+===========================================+ -| `vPmicTask`_ | ``pmic_task_id`` (static) | +4 | Power Management (and Reset Button) | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vLifecycleTask`_ | ``lifecycle_task`` (static) | +3 | Control of the payload running on core 1. | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vBleTask`_ | ``ble_task_id`` (static) | +3 | Bluetooth Low Energy Stack | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vSerialTask`_ | ``serial_task_id`` | +3 | Serial Output via UART/CDC-ACM/BLE | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vApiDispatcher`_ | ``dispatcher_task_id`` | +2 | Epicardium API dispatcher | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vLedTask`_ | -/- | +1 | LED Animations | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vMAX30001Task`_ | ``max30001_task_id`` (static) | +1 | `MAX30001`_ ECG driver | -+-------------------+-------------------------------+----------+-------------------------------------------+ -| `vBhi160Task`_ | ``bhi160_task_id`` (static) | +1 | `BHI160`_ sensor fusion driver | -+-------------------+-------------------------------+----------+-------------------------------------------+ ++--------------------+-------------------------------+----------+-------------------------------------------+ +| Name | ID Global | Priority | Description | ++====================+===============================+==========+===========================================+ +| `vPmicTask`_ | ``pmic_task_id`` (static) | +4 | Power Management (and Reset Button) | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vLifecycleTask`_ | ``lifecycle_task`` (static) | +3 | Control of the payload running on core 1. | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vBleTask`_ | ``ble_task_id`` (static) | +3 | Bluetooth Low Energy Stack | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vSerialTask`_ | ``serial_task_id`` | +3 | Serial Output via UART/CDC-ACM/BLE | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vApiDispatcher`_ | ``dispatcher_task_id`` | +2 | Epicardium API dispatcher | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vInterruptsTask`_ | ``interrupts_task`` (static) | +2 | Interrupt dispatcher worker | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vLedTask`_ | -/- | +1 | LED Animations | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vMAX30001Task`_ | ``max30001_task_id`` (static) | +1 | `MAX30001`_ ECG driver | ++--------------------+-------------------------------+----------+-------------------------------------------+ +| `vBhi160Task`_ | ``bhi160_task_id`` (static) | +1 | `BHI160`_ sensor fusion driver | ++--------------------+-------------------------------+----------+-------------------------------------------+ .. _vPmicTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/pmic.c#L281 .. _vLifecycleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/lifecycle.c#L361 .. _vBleTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/ble/ble.c#L237 .. _vSerialTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/serial.c#L289 .. _vApiDispatcher: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/dispatcher.c#L25 +.. _vInterruptsTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/interrupts.c#L99 .. _vLedTask: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/personal_state.c#L58 .. _vMAX30001Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/max30001.c#L378 .. _vBhi160Task: https://git.card10.badge.events.ccc.de/card10/firmware/blob/master/epicardium/modules/bhi.c#L419