25 Commits

Author SHA1 Message Date
Sebastian Huber
1b2468c5c6 c-user: Remove RTEMS_MP_NOT_CONFIGURED error
Some objects can be created with a local or global scope in a
multiprocessing network. In non-multiprocessing configurations setting
the scope to local or global had no effect since such a system can be
viewed as a multiprocessing network with just one node. One and all
nodes is the same in such a network. However, if multiprocessing was
configured, creation of a global object in a single node network
resulted in an RTEMS_MP_NOT_CONFIGURED error. Remove this error
condition for symmetry to the non-multiprocessing setup. This is in line
with the task affinity behaviour in SMP systems.

Close #4005.
2020-06-18 07:13:13 +02:00
Sebastian Huber
cd2ed1ad08 c-user: Split deprecated/removed directives chapter 2020-04-15 16:50:32 +02:00
Sebastian Huber
c6c06aecbb c-user: Document task memory
Close #3835.
2020-03-05 15:32:38 +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
e52906b556 Simplify SPDX-License-Identifier comment 2019-01-11 07:22:01 +01:00
Sebastian Huber
12dccfe716 Remove superfluous "All rights reserved." 2019-01-11 07:18:56 +01:00
Sebastian Huber
4886d60aa8 Use standard format for copyright lines 2019-01-11 07:18:16 +01:00
Sebastian Huber
6a20bd2f4f c-user: Document rtems_task_exit()
Close #3533.
2018-10-04 11:05:26 +02:00
Joel Sherrill
307945504a Account for non-preemption and interrupt level not supported on SMP
Closes #3000.
2017-12-06 12:49:43 -06:00
Chris Johns
33849946ff Clean up sphinx warnings.
- Fix minor formatting issues.
- Fix reference the gloassary TLS using ':term:'.
- Make sure nothing is between an anchor and the heading where ':ref:' references
  the anchor. This meant moving all the recently added '.. index::' entries.

Update #3232.
Update #3229.
2017-11-13 13:25:18 +11:00
Chris Johns
6c5640131f c-user: Fix index locations.
Update #3229.
2017-11-12 14:34:48 +11:00
Sebastian Huber
60a6d6eae9 Change RTEMS version to 5
Update #3220.
2017-11-09 10:24:09 +01:00
Sebastian Huber
56cccd67f6 c-user: Fix task create notes 2017-09-14 10:52:44 +02:00
Sebastian Huber
90379988d6 c-user: Update scheduler/task chapter
Reflect EDF SMP scheduler changes.

Close #3059.
Close #3063.
2017-07-10 09:48:43 +02:00
Sebastian Huber
93e52865e2 c-user: Add note to rtems_task_set_scheduler() 2017-03-08 12:11:32 +01:00
Sebastian Huber
9260c986ce c-user: Update rtems_task_set_scheduler() 2017-03-07 10:37:03 +01:00
Sebastian Huber
a2389124d7 c-user: Move some task directives 2017-02-01 13:07:25 +01:00
Sebastian Huber
40a1e80e63 c-user: Task names
Update #2858.
2017-01-31 10:10:13 +01:00
Sebastian Huber
23b1c1088e c-user: Fix typo 2017-01-17 14:18:05 +01:00
Sebastian Huber
3be5dd685c Document rtems_task_get_priority()
Close #2784.
2016-12-19 14:33:05 +01:00
Sebastian Huber
c4825f4bc9 Update Task Manager chapter
Introduce "Deprecated and Removed Directives" section.

Update #2423.
2016-12-13 10:03:27 +01:00
Chris Johns
4da4a15ee1 c-user: Fix header levels. Minor fixes. 2016-11-09 11:42:30 +11:00
Chris Johns
53bb72e996 c-user: Format the directives as descriptions.
This change combined with the element list change in latex generates
a much better looking PDF.

Add a page break before each directive to like th previous versions of the
manuals.
2016-11-08 15:28:32 +11:00
Sebastian Huber
3a58bff6bf Update due to clock manager and driver changes 2016-11-03 10:59:01 +01:00
Chris Johns
72a62ad88f Rename all manuals with an _ to have a -. It helps released naming of files. 2016-11-03 16:58:08 +11:00