Commit Graph

39 Commits

Author SHA1 Message Date
Gedare Bloom
820b061d93 cpukit/doxygen: remove stray pre-qualification comment 2025-02-07 00:42:04 +00:00
Sebastian Huber
d09d61ffe4 doxygen: Clarify system termination 2024-06-24 06:32:26 +02:00
Sebastian Huber
ab8817ca03 rtems: Add get/set interrupt priorities
Add directives to get and set the priority of an interrupt vector.

Implement the directives for the following BSP families:

* arm/lpc24xx
* arm/lpc32xx
* powerpc/mpc55xxevb
* powerpc/qoriq

Implement the directives for the following interrupt controllers:

* GICv2 and GICv3 (arm and aarch64)
* NVIC (arm)
* PLIC (riscv)

Update #5002.
2024-05-10 13:26:22 +00:00
Sebastian Huber
ae00fcabed doxygen: Fix constraints
Somehow the constraints for CONFIGURE_TICKS_PER_TIMESLICE and
CONFIGURE_EXTRA_MPCI_RECEIVE_SERVER_STACK got mixed up.

Update #4986.
2024-04-30 01:39:06 -04:00
Sebastian Huber
d62f299b34 Do not define CONFIGURE_TICKS_PER_TIMESLICE to 0
Unconditionally make a CONFIGURE_TICKS_PER_TIMESLICE value less than or equal
to zero an error.

Update #4986.
2024-03-20 10:52:16 +01:00
Zack leung
5ee87eee8a Ensure ticks per timeslice is greater than zero 2024-03-14 12:58:59 -05:00
Sebastian Huber
a901ca3989 doxygen: CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY
Document CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY.

Update #4961.
2023-12-19 08:26:46 +01:00
Sebastian Huber
11d571787d rtems: Link config options and global construction 2023-07-25 07:27:40 +02:00
Sebastian Huber
bcef89f236 Update company name
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
2023-05-20 11:05:26 +02:00
Sebastian Huber
bb465c8548 doxygen: Add Doxygen files to a group
Update #3707.
2023-02-16 08:27:09 +01:00
Sebastian Huber
c2756c1476 doxygen: Document CONFIGURE_INIT 2023-02-14 15:16:04 +01:00
Sebastian Huber
bfc823dd83 doxygen: Fix header file path 2023-02-14 15:16:04 +01:00
Sebastian Huber
fa77ad1494 doxygen: Harmonize header file references 2023-02-14 15:16:04 +01:00
Sebastian Huber
1f8b26a809 doxygen: Use @anchor for appl config options
The application configuration options are documented in
"cpukit/doxygen/appl-config.h".  Since the application configuration
option defines are also present in multiple test program sources, the
"#OPTION" references cannot be mapped to a unique definition.  Add an
anchor for each option and reference it to avoid the issues with the
multiple definitions.

Update #3994.
2023-02-14 07:42:14 +01:00
Sebastian Huber
c508a3329e doxygen: Generalize appl config constraints
Rename the constaints section of application configuration options from
"Value Constraints" in "Constraints.  Adjust the constraint wording
accordingly.  This is in line with the RTEMS Classic API Guide.

Update #3994.
2023-02-14 07:42:14 +01:00
Sebastian Huber
bcdcdd01ac doxygen: Clarify CONFIGURE_DISABLE_BSP_SETTINGS
Each BSP may optionally provide default values for some application
configuration options.  Remove the documentation of these items, since
the BSP provided defines are not application configuration options, they
are optional default values.  Clarify CONFIGURE_DISABLE_BSP_SETTINGS
accordingly and move it into the "General System Configuration" group.

Update #3994.
2023-02-14 07:42:14 +01:00
Sebastian Huber
02f5c5c660 doxygen: Use quotes for href URLs
Update #3994.
2023-02-14 07:42:14 +01:00
Sebastian Huber
c46fbb9552 config: Add CONFIGURE_RECORD_INTERRUPTS_ENABLED
This enables the tracing of interrupt entry/exit events through an
application configuration option.  The interrupt processing can be
viewed with Trace Compass using rtems-record-lttng from the RTEMS Tools.

Update #4769.
2022-12-02 10:25:44 +01:00
Sebastian Huber
45ee958552 config: Add CONFIGURE_IDLE_TASK_STORAGE_SIZE
By default, allocate the IDLE task storage areas from the RTEMS Workspace.
This avoids having to estimate the thread-local storage size in the default
configuration.

Add the application configuration option CONFIGURE_IDLE_TASK_STORAGE_SIZE to
request a static allocation of the task storage area for IDLE tasks.

Update #3835.
Update #4524.
2022-10-14 10:48:23 +02:00
Sebastian Huber
2846b17d7e config: Changeable size for IDLE stack allocator
Allow the IDLE stack allocator to change the stack size.  This can be
used by applications with a very dynamic thread-local storage size to
adjust the thread storage area of the IDLE tasks dynamically.

Update #4524.
2022-10-14 07:29:41 +02:00
Sebastian Huber
0a9ba96389 config: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Move CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE to the general configuration
options.
2022-10-06 09:17:24 +02:00
Sebastian Huber
b06ec5b6d7 config: Document CONFIGURE_POSIX_TIMERS_FACE_BEHAVIOR
Update #4691.
2022-09-05 08:57:28 +02:00
Sebastian Huber
fa65ad7f02 config: Document CONFIGURE_SCHEDULER_TABLE_ENTRIES 2022-02-22 16:10:03 +01:00
Kinsey Moore
4812a8b572 cpukit: Add signal mapping support
This adds a confdef option allowing an application to request mapping
machine exceptions to POSIX signals. This is required for some languages
such as Ada.
2021-10-29 12:40:56 -05:00
Sebastian Huber
f1723d1293 rtems: Regenerate for IDLE task allocator option
Update #4524.
2021-10-25 08:02:45 +02:00
Sebastian Huber
09063212d4 appl-config: Add missing "the" 2021-04-30 07:20:52 +02:00
Sebastian Huber
901136e7c1 appl-config: CONFIGURE_BSP_PREREQUISITE_DRIVERS
Replace copy and paste with a proper description.
2021-04-30 07:20:52 +02:00
Sebastian Huber
eefe7009bb appl-config: Reformat option constraints
If only one constraint is present, then use a single sentence, otherwise
use a list for the constraints.  Format the constraints so that the line
length limit is maintained.
2021-04-30 07:20:52 +02:00
Sebastian Huber
1de00d685d CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Ensure that CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE meets the task
storage alignment requirement.
2021-03-05 06:58:33 +01:00
Sebastian Huber
a6689fb147 Improve file header comment in generated files 2021-01-25 06:49:27 +01:00
Sebastian Huber
6e566badc7 config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
Fix the documentation.

Update #4181.
2020-11-27 09:52:42 +01:00
Sebastian Huber
657e30c135 config: CONFIGURE_INIT_TASK_CONSTRUCT_STORAGE_SIZE
In order to better support applications which use the new
rtems_task_construct() directive add the
CONFIGURE_INIT_TASK_CONSTURCT_STORAGE_SIZE configuration option.  If
this option is specified, then the Classic API initialization task is
constructed with rtems_task_construct().

Update #4181.
2020-11-26 11:10:22 +01:00
Sebastian Huber
ced1302208 Improve automatically generated warning 2020-11-12 08:54:59 +01:00
Sebastian Huber
e697baf8d7 doxygen: Add "Generated from ..." comments
Improve file header comment.

Update #3994.
2020-10-08 07:40:08 +02:00
Sebastian Huber
f48d7834b0 doxygen: Fix use of getchark() and rtems_putc() 2020-09-28 09:10:00 +02:00
Sebastian Huber
4e5327ff94 doxygen: Wrap long lines 2020-09-18 08:20:03 +02:00
Sebastian Huber
6942e5f991 rtems: Add rtems_task_construct()
In contrast to rtems_task_create() this function constructs a task with
a user-provided task storage area.  The new directive uses a
configuration structure instead of individual parameters.

Add RTEMS_TASK_STORAGE_SIZE() to calculate the recommended size of a
task storage area based on the task attributes and the size dedicated to
the task stack and thread-local storage.  This macro may allow future
extensions without breaking the API.

Add application configuration option
CONFIGURE_MINIMUM_TASKS_WITH_USER_PROVIDED_STORAGE to adjust RTEMS
Workspace size estimate.

Update #3959.
2020-09-17 17:42:25 +02:00
Sebastian Huber
c312f3110e CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Add this application configuration option.  This configuration option can be
used to reserve space for the dynamic linking of modules with thread-local
storage objects.

Add RTEMS_TASK_STORAGE_ALIGNMENT to define the minium alignment of a
thread-local storage size.

Update #4074.
2020-09-17 17:42:25 +02:00
Sebastian Huber
e812f81c89 Document application configuration options
Add a new directory for Doxygen-specific documentation content.  Add a
Doxygen only header file containing documentation of the application
configuration options.  The header file is generated from specification
items.

Close #3994.
2020-08-07 07:24:01 +02:00