322 Commits

Author SHA1 Message Date
Martin Erik Werner
2424590528 c-user: Add & update ratemon get return values
Add a description of the previously missing RTEMS_NOT_DEFINED return
value for rtems_rate_monotonic_get_status().

Update the RTEMS_SUCCESSFUL return value descriptions for
rtems_rate_monotonic_get_status() and
rtems_rate_monotonic_get_statistics() which incorrectly used the same
description as rtems_rate_monotonic_period().
2020-03-06 16:37:39 +01:00
Sebastian Huber
c6c06aecbb c-user: Document task memory
Close #3835.
2020-03-05 15:32:38 +01:00
Sebastian Huber
8bd4e6a55b c-user: Document thread switch extension changes
Close #3885.
2020-03-03 13:13:17 +01:00
Sebastian Huber
ac61465d2c c-user: rtems_scheduler_map_priority_from_posix()
Close #3881.
2020-03-02 08:15:59 +01:00
Sebastian Huber
e458fedc38 c-user: rtems_scheduler_map_priority_to_posix()
Update #3881.
2020-03-02 08:15:59 +01:00
Sebastian Huber
7d05a3d801 eng: Add glossary
Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
bba4a8ce23 c-user: Add copyrights to glossary
Use the file history to derive the copyright information.

Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
9965922594 c-user: Merge parition term definitions
Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
d2acbca737 c-user: Sort glossary terms
Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
834dcf57e7 c-user: Clarify return code related terms
Remove duplicate "return code" definition.  Add all related terms and
use references.

Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
43b7eeb5b0 c-user: Use four spaces per indent level
Four spaces per indent level is used in most files.

Update #3853.
2020-03-02 08:11:42 +01:00
Sebastian Huber
732c570ad8 c-user: Canonicalize two glossary acronyms
Add :term: text roles to acronym definitions of glossary defined terms.

Update #3853.
2020-02-27 13:14:51 +01:00
Sebastian Huber
d10e3b1a7e c-user: Obsolete CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE
The CONFIGURE_HAS_OWN_INIT_TASK_TABLE and
CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE are the last *_HAS_OWN_*
configuration options.  These two options are probably unused, see also:

* https://lists.rtems.org/pipermail/users/2019-April/033129.html

* https://lists.rtems.org/pipermail/users/2019-April/033130.html

Removing them simplifies the configuration. If there is a real user need
which shows up after the removal, we can resurrect them on demand.

Using CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE would have required the
use of the undocumented CONFIGURE_POSIX_INIT_THREAD_TABLE_NAME and
CONFIGURE_POSIX_INIT_THREAD_TABLE_SIZE configuration options.

Close #3874.
2020-02-24 14:58:25 +01:00
Sebastian Huber
3738a74014 c-user: Obsolete CONFIGURE_HAS_OWN_INIT_TASK_TABLE
The CONFIGURE_HAS_OWN_INIT_TASK_TABLE and
CONFIGURE_POSIX_HAS_OWN_INIT_THREAD_TABLE are the last *_HAS_OWN_*
configuration options.  These two options are probably unused, see also:

* https://lists.rtems.org/pipermail/users/2019-April/033129.html

* https://lists.rtems.org/pipermail/users/2019-April/033130.html

Removing them simplifies the configuration. If there is a real user need
which shows up after the removal, we can resurrect them on demand.

Using CONFIGURE_HAS_OWN_INIT_TASK_TABLE would have required the use of
the undocumented CONFIGURE_INIT_TASK_TABLE and
CONFIGURE_INIT_TASK_TABLE_SIZE configuration options.

Close #3873.
2020-02-24 14:58:25 +01:00
Sebastian Huber
03facdaef8 c-user: Rework glossary
Define exactly one term per definition.  Use references for alternative
terms.  Add :term: text roles to acronym definitions of glossary defined
terms.

Update #3853.
2020-02-24 14:58:25 +01:00
Sebastian Huber
61a2b3eeed c-user: Clarify filesystem configuration
Update #3875.
2020-02-24 07:32:31 +01:00
Martin Erik Werner
99527a1d4e Fix a minor "suspect" -> "subject" wording error 2020-02-23 07:16:30 +11:00
Sebastian Huber
874a5ef117 c-user: Clarify CONFIGURE_MAXIMUM_PRIORITY
Update #3875.
2020-02-20 08:56:29 +01:00
Sebastian Huber
536b2d98a2 c-user: Fix MPCI initialization prototype 2020-02-14 07:33:02 +01:00
Sebastian Huber
c95724b793 c-user: Use contents instead of content
The memory values are countable.

Update #3843.
2020-02-11 07:33:38 +01:00
Sebastian Huber
0cdd4823fc c-user: Clarify CONFIGURE_DIRTY_MEMORY
Update #3843.
2020-02-11 07:27:04 +01:00
Sebastian Huber
e57733a9bd c-user: Document CONFIGURE_DIRTY_MEMORY
Close #3843.
2020-02-10 10:29:21 +01:00
Sebastian Huber
a4b23d9ba8 c-user: Document new linker set macros
Adjust copyright.  Linker sets were introduced in 2015.

Update #2408.
Close #3865.
2020-02-06 15:18:23 +01:00
Sebastian Huber
df2dcdbabc Remove BSP_ZERO_WORKSPACE_AUTOMATICALLY
Close #3863.
2020-02-06 15:18:23 +01:00
Sebastian Huber
813ada57f7 c-user: Update system initialization chapter
Update #2408.
Update #3838.
2020-02-04 07:20:40 +01:00
Sebastian Huber
069bfacc51 c-user: Add CONFIGURE_VERBOSE_SYSTEM_INITIALIZATION
Close #3861.
2020-02-04 07:04:37 +01:00
Sebastian Huber
2e02ee051a c-user: Document rtems_object_get_local_node()
Close #3841.
2019-12-19 13:33:08 +01:00
Sebastian Huber
b12e82d3f9 c-user: Clarify CONFIGURE_MAXIMUM_SEMAPHORES
Close #3833.
2019-12-19 10:02:12 +01:00
Sebastian Huber
a6887d96ae c-user: CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
Remove use of CONFIGURE_MAXIMUM_MRSP_SEMAPHORES in example.  Fix other
configuration options.

Update #3833.
2019-12-19 10:02:12 +01:00
Sebastian Huber
da309b93de c-user: Remove Ada configuration options
Close #3845.
2019-12-19 08:57:29 +01:00
Sebastian Huber
2c58b5f996 c-user: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
Rename CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS in
CONFIGURE_MAXIMUM_FILE_DESCRIPTORS.

Close #3753.
2019-12-19 08:57:29 +01:00
Sebastian Huber
89e23dab43 c-user: CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE
Remove CONFIGURE_HAS_OWN_DEVICE_DRIVER_TABLE.

Close #3844.
2019-12-19 08:57:29 +01:00
Sebastian Huber
d954241f01 c-user: Document CONFIGURE_IMFS_ENABLE_MKFIFO
Close #3840.
2019-12-13 14:06:55 +01:00
Sebastian Huber
93d5323230 c-user: CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE
Obsolete the CONFIGURE_HAS_OWN_MULTIPROCESSING_TABLE configuration
option.

Update #3735.
2019-12-13 14:06:55 +01:00
Joel Sherrill
43e0d78453 region_manager.rst: Add docs for region get info and get free info
closes #3751.
2019-12-12 16:05:57 -06:00
Sebastian Huber
f7d56f5798 c-user: Obsolete CONFIGURE_MAXIMUM_MRSP_SEMAPHORES
Update #3833.
2019-12-11 09:11:38 +01:00
Sebastian Huber
579d6f2def c-user: CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS
Move CONFIGURE_LIBIO_MAXIMUM_FILE_DESCRIPTORS to general system
configuration.  Remove now empty "C Library Support Configuration"
section.

Update #3836.
2019-12-11 09:07:15 +01:00
Sebastian Huber
a184ff463f c-user: Move CONFIGURE_MEMORY_OVERHEAD
Move CONFIGURE_MEMORY_OVERHEAD to general system configuration.
Remove now empty "Seldom Used Configuration Parameters" section.

Update #3836.
2019-12-11 09:07:15 +01:00
Sebastian Huber
3a3271eb26 c-user: Move unlimited configuration options
Rename unlimited subsection headers.

Update #3836.
2019-12-11 09:07:15 +01:00
Sebastian Huber
9d2081649a c-user: Move unlimited options to general config
Update #3836.
2019-12-11 09:07:15 +01:00
Sebastian Huber
bc9ce6526b c-user: Move basic system configuration
Move the basic system configuration to the front.  Rename it to "General
System Configuration".

Update #3836.
2019-12-11 09:07:15 +01:00
Martin Erik Werner
a62dfdeaa2 barrier: Reword "forever" -> "until [..] released" 2019-11-06 18:37:44 -06:00
Martin Erik Werner
008520ab6c barrier: Remove more semaphore leftovers
Remove another mention of options which is available for semaphore but
not for barriers.
2019-11-06 18:37:44 -06:00
Martin Erik Werner
b8715adc3f barrier: Fix cticket->ticket typo 2019-11-06 18:37:44 -06:00
Martin Erik Werner
5207248d1d barrier: Remove unfinished sentence
Remove the unfinished sentence
"Since a barrier is, by definition, never immediately [...]"
and jump directly to
"The task may wait [forever or for a timeout]"
instead.

I cannot figure out what the unfinished sentence is supposed to be -
"released"? "passed"?
2019-11-06 18:37:44 -06:00
Martin Erik Werner
473b4a56c5 barrier: Remove leftover semaphore remnants
Remove various incorrect references to "lock" and "obtain" and to an
option set which is not part of the barrier interface.

It looks like the barrier documentation was started based on a copy of
the semaphore documentation and these things are surviving remnants.

Also remove an unfinished sentence in the barrier wait description,
since the intended information is already provided in the under the NOTE
label.
2019-11-06 18:37:44 -06:00
Joel Sherrill
4e9197ae0b c-user/directive_status_codes.rst: Add RTEMS_IO_ERROR and RTEMS_INTERRUPTED 2019-11-06 18:37:44 -06:00
Sebastian Huber
dee158cd68 c-user: Document RTEMS_FATAL_SOURCE_HEAP
Close #3806.
2019-10-31 13:29:41 +01:00
Martin Erik Werner
2e711f2b4b Address several issues from compiling examples
Compiling the code from examples "code-block:: c" along with public
includes and a bsp exposed a few issues amongst a lot of false
positives. Address some of these:

* Terminate struct declarations with ';'. Mainly for pedantic
  correctness.

* Show ptrdiff_t instead of size_t for the sbrk() prototype, matching
  the current argument type in rtems.

* Replace some occurrences of unsigned16 with uint16_t.

* Fix odd type declaration, "uint8_t char*" -> "char*".

* Use appropriate helper to get chain head instead of invalid access to
  nonexistent struct member.

* Remove several excess '\' escapes.

* Use RTEMS_SELF instead of undefined SELF.

* Use rtems_task instead of void for task functions.

* Add missing stack size parameter in task creation.

* Use rtems_interrupt_level instead of undefined rtems_interrupt.

* Correct return value format for rtems_object_id_get_api()
  rtems_object_id_get_index() (enum and uint16_t) and also fix
  corresponding print formatting.

* Correct return value documentation for rtems_object_id_get_class(),
  rtems_object_id_get_node() and rtems_object_id_get_index()
  int -> uint32_t.

* Use RTEMS_SUCCESSFUL instead of undefined RTEMS_STATUS_SUCCESSFUL and
  fix return value variable name in rate monotonic examples.

* Use RTEMS_TIMEOUT instead of undefined TIMEOUT and RTEMS_PERIOD_STATUS
  instead of undefined STATUS.

* Add missing fields to ftpd configuration.

* Correct parameter types in ftpd hook prototype,
  unsigned char * -> void *.

* Fix various code-block:: attributes, c -> makefile and c -> shell.

* Add missing parenthesis in socket buffer memory calculation example.

* Remove typedef in declaration of mq_attr since it is defiend without
  typedef in reality.

* Update siginfo_t declaration to match current reality.

* Update shell user command definition example to include mode, uid and
  gid.
2019-09-03 09:48:35 +10:00
Sebastian Huber
5a51c73130 c-user: Add RTEID and ORKID references 2019-06-21 07:44:50 +02:00