452 Commits

Author SHA1 Message Date
Sebastian Huber
ddf2b03838 c-user: CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY
Document CONFIGURE_JFFS2_DELAYED_WRITE_TASK_PRIORITY.

Update #4961.
2023-12-19 08:30:54 +01:00
Sebastian Huber
ef49c4692b glossary: Add terms 2023-12-19 08:30:54 +01:00
Joel Sherrill
7bd117cb00 Add Regulator documentation based on V1 functionality 2023-08-09 10:40:56 -05:00
Sebastian Huber
536f0e2b02 c-user: Clarify global construction 2023-07-28 10:16:03 +02:00
Sebastian Huber
6692946100 c-user: Link task entry and global construction 2023-07-25 07:36:09 +02:00
Sebastian Huber
4b4a796d37 c-user: Add glossary terms for SPARC targets 2023-07-20 15:04:10 +02:00
Sebastian Huber
63a5c190b0 c-user: Fix typo
Updates #4772.
2023-07-20 15:04:10 +02:00
Sebastian Huber
be789ee60e c-user: Update copyright and use glossary terms
Updates #4772.
2023-07-20 11:27:35 +02:00
Kinsey Moore
981ba2de41 c-user: Update references to rtems_task_wake_after
rtems_task_wake_after takes a parameter in terms of a count of clock
ticks and not a measure in a subunit of seconds. This updates
documentation to reflect that. This also makes obvious the caveat about
the first tick wait not being a whole tick and points the user at a
replacement for better accuracy.

Updates #4772
2023-07-06 13:55:37 -05:00
Sebastian Huber
bbb8b7aa81 Update company name
The embedded brains GmbH & Co. KG is the legal successor of embedded
brains GmbH.
2023-05-20 11:12:29 +02:00
Sebastian Huber
e33eae15a7 c-user: Generate API type documentation
Close #4901.
2023-05-09 14:06:01 +02:00
Kinsey Moore
e2d2d4a124 c-user/smp: Fix item rendering 2023-03-28 09:23:12 -05:00
Kinsey Moore
fd6d862033 c-user/chains: Correct iteration example code
Casting the node returned by rtems_chain_head is incorrect. That node is
owned by the control structure and use of it post-cast could cause
memory corruption. Instead, use rtems_chain_first which returns the
node after the head node. This also corrects node->next to
rtems_chain_next(node) which makes better use of the API.
2023-03-09 09:16:12 -06:00
Sebastian Huber
248168db70 c-user: Use configuration option references 2023-02-14 16:14:47 +01:00
Sebastian Huber
79d05f58d7 c-user: Document CONFIGURE_INIT 2023-02-14 16:14:47 +01:00
Sebastian Huber
e9603bfb7c c-user: Fix header file path 2023-02-14 16:14:47 +01:00
Sebastian Huber
ee8e1fe7ac c-user: Harmonize header file references 2023-02-14 16:14:47 +01:00
Sebastian Huber
63e175f65c c-user: Remove obsolete config section
This commit already clarified that the defines of the removed section
are optional BSP provided default values and not application
configuration options:

commit cf9f2121577b11f8eab5e49c48173c46cf09c627
Author: Sebastian Huber <sebastian.huber@embedded-brains.de>
Date:   Wed Nov 17 08:46:56 2021 +0100

    c-user: Clarify BSP related configuration settings
2023-02-14 16:14:47 +01:00
Martin Erik Werner
c4df72c2f1 c-user/message/directives.rst: byes->bytes typo 2023-01-23 08:54:41 +01:00
Joel Sherrill
f48f79dcad c-user/rate-monotonic/background.rst: Correct logically inverted statement
Also corrected a spot of formatting.

Closes #4781.
2023-01-13 08:44:26 -06:00
Joel Sherrill
32de9ff259 c-user: Add Local vs Global to Key Concepts Chapter
Add multiple new index entries and cite them where RTEMS_LOCAL
and RTEMS_GLOBAL are cited.

Closes #4453.
2022-12-07 12:35:19 -06:00
Sebastian Huber
47e1f6e06b Document CONFIGURE_RECORD_INTERRUPTS_ENABLED
Close #4769.
2022-12-02 10:27:30 +01:00
Joel Sherrill
aaba6e5826 c-user/*: Add trailing parentheses on methods in index which were missing it
Closes #4766.
2022-11-30 09:59:20 -06:00
Sebastian Huber
0213597d46 c-user: Adjust URL for struct timespec 2022-11-08 07:39:06 +01:00
Matt Joyce
a382919ba6 c-user/clock: Fix typo 2022-11-08 06:59:24 +01:00
Sebastian Huber
a6c426d863 c-user: INTERNAL_ERROR_IDLE_THREAD_STACK_TOO_SMALL
Document this fatal error.
2022-10-14 15:04:35 +02:00
Sebastian Huber
bb9c38dcfc c-user: INTERNAL_ERROR_NO_MEMORY_FOR_IDLE_TASK_STORAGE
Document this fatal error.
2022-10-14 15:04:35 +02:00
Sebastian Huber
36ae26d6e6 c-user: INTERNAL_ERROR_IDLE_THREAD_CREATE_FAILED
Document this fatal error.
2022-10-14 15:04:35 +02:00
Sebastian Huber
5eae93cbd1 c-user: Add CONFIGURE_IDLE_TASK_STORAGE_SIZE 2022-10-14 15:04:35 +02:00
Sebastian Huber
bd6ccadea0 c-user: Fix references 2022-10-06 13:16:09 +02:00
Sebastian Huber
6ea95ab717 c-user: INTERNAL_ERROR_RTEMS_INIT_TASK_CONSTRUCT_FAILED
Document this fatal error.
2022-10-06 09:20:50 +02:00
Sebastian Huber
2afb8219db c-user: CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE
Move CONFIGURE_MAXIMUM_THREAD_LOCAL_STORAGE_SIZE to the general configuration
options.
2022-10-06 09:20:40 +02:00
Sebastian Huber
0fc5c0336d c-user: Add application config info directives
Close #4267.
Close #4269.
2022-10-04 10:26:38 +02:00
Sebastian Huber
c98307c4f1 c-user: Add types to macros 2022-10-04 08:04:56 +02:00
Sebastian Huber
278550b2d8 c-user: Add type roles 2022-09-29 10:01:14 +02:00
Joel Sherrill
4f9e9e522f c-user/config/face.rst: New file -- add CONFIGURE_POSIX_TIMERS_FACE_BEHAVIOR
Closes #4691.
2022-09-05 09:02:06 +02:00
Sebastian Huber
cf9f212157 c-user: Clarify BSP related configuration settings 2022-08-31 11:38:37 +02:00
Sebastian Huber
657f7440f7 c-user: Update OAR copyright and reformat
These files are generated by a script.
2022-08-11 08:26:30 +02:00
Sebastian Huber
f4377b4479 c-user: Document new rtems_task_delete() behaviour
Update #4679.
2022-07-28 07:43:28 +02:00
Sebastian Huber
81fd510a5c c-user: Document task life states
Update #4679.
2022-07-28 07:43:28 +02:00
Sebastian Huber
f1eb94b143 c-user: Do not mention pseudo-interrupt priority
Update #2365.
2022-07-26 11:25:42 +02:00
Joel Sherrill
9ba26e7cb2 c-user: Update references to --enable-* configure options.
Also updated list of SMP architectures and added enough lead in
to let users know the source code was the definitive answer.
2022-05-20 08:45:16 -05:00
Sebastian Huber
0e200f3c9e c-user: Clarify scheduler of created task 2022-03-30 09:07:31 +02:00
Sebastian Huber
49f84b7de3 c-user: Improve interrupt set affinity handling
Update #3269.
2022-03-16 07:25:26 +01:00
Sebastian Huber
2f8be4b627 c-user: Document CONFIGURE_SCHEDULER_TABLE_ENTRIES
Update #4524.
2022-02-22 15:09:26 +01:00
Sebastian Huber
162925edd0 c-user: Use document internal links 2022-01-11 09:26:52 +01:00
Sebastian Huber
e77e04d2dc c-user: Clarify Clock Manager dependencies
Update #4572.
2022-01-11 09:26:52 +01:00
Sebastian Huber
786b89ac86 c-user: Clarify time formats
Update #4572.
2021-12-16 15:44:06 +01:00
Sebastian Huber
732d8bca8f c-user: Fix Clock Manager parameter descriptions
Update #4572.
2021-12-16 07:44:49 +01:00
Sebastian Huber
838b78ad5c c-user: Replace "precision" with "resolution"
Resolution is the right term for the documented property.
2021-11-23 15:21:00 +01:00