#3993 closed task (fixed)
Specify the RTEMS Classic API
Reported by: | Sebastian Huber | Owned by: | Sebastian Huber |
---|---|---|---|
Priority: | normal | Milestone: | 6.1 |
Component: | rtems | Version: | 6 |
Severity: | normal | Keywords: | qualification |
Cc: | Blocked By: | #3584, #3586, #3588, #3590, #3592, #3594, #3596, #3979, #3980, #3981, #3988, #3989, #3990 | |
Blocking: |
Description (last modified by Sebastian Huber)
For the RTEMS Qualification project we need a specification of the RTEMS Classic API. This specification can be used to generate an Interface Control Document (ICD), header files with Doxygen markup and content for the RTEMS Classic API Guide. The RTEMS Classic API is mainly defined in the following header files:
- <rtems.h>
- <rtems/config.h>
- <rtems/extension.h>
- <rtems/fatal.h>
- <rtems/init.h>
- <rtems/io.h>
- <rtems/rtems/barrier.h>
- <rtems/rtems/cache.h>
- <rtems/rtems/clock.h>
- <rtems/rtems/config.h>
- <rtems/rtems/dpmem.h>
- <rtems/rtems/event.h>
- <rtems/rtems/intr.h>
- <rtems/rtems/message.h>
- <rtems/rtems/modes.h>
- <rtems/rtems/mp.h>
- <rtems/rtems/object.h>
- <rtems/rtems/options.h>
- <rtems/rtems/part.h>
- <rtems/rtems/ratemon.h>
- <rtems/rtems/region.h>
- <rtems/rtems/sem.h>
- <rtems/rtems/signal.h>
- <rtems/rtems/status.h>
- <rtems/rtems/support.h>
- <rtems/rtems/tasks.h>
- <rtems/rtems/timer.h>
- <rtems/rtems/types.h>
- <rtems/score/stack.h>
Examples for interface specification items are available here:
https://git.rtems.org/sebh/rtems-qual.git/tree/spec/if/rtems/status
You find an example for a generated header file here:
https://git.rtems.org/sebh/rtems.git/tree/cpukit/include/rtems/rtems/status.h?h=qual
The header files are generated by this script:
https://git.rtems.org/sebh/rtems-qual.git/tree/spec2rtems.py
As preliminary work, remove all RTEMS APIs deprecated in RTEMS 5.1.
Use and improve the Interface Specification How-To during the work on this ticket.
Carry out the following tasks for each header file:
- Add a interface specification item for each variable, typedef, enum, enumerator, define, macro, function, struct, and union.
- For each item analyse the change history using
git log -p --follow
to determine the copyright holders of the Doxygen markup. Use only Doxygen markup for the specification items from contributors which agreed on a dual-licensing (CC-BY-SA-4.0 OR BSD-2-Clause) in #3899. Use this information to provide copyright statements for the items. The API parts alone (e.g. function names, parameter names, type names, etc.) are not considered to be copyrightable information.
- Use the RTEMS documentation sources to document the API. Use only content from contributors which agreed on a dual-licensing (CC-BY-SA-4.0 OR BSD-2-Clause) in #3899.
- Add unspecified interface items for interfaces to the implementation, C language, compiler, user provided defines, build system provided defines, etc.
- Run the RTEMS test suite with all tests enabled and check for regressions (in particular new warnings).
- Create a commit for each header file and send it to the RTEMS mailing list for review.
Change History (108)
comment:1 Changed on 06/01/20 at 11:16:17 by Sebastian Huber
Blocked By: | 3584, 3588, 3590, 3592, 3594, 3596, 3686, 3979, 3980, 3981, 3988, 3989, 3990 added |
---|---|
Description: | modified (diff) |
comment:2 Changed on 06/01/20 at 11:17:38 by Sebastian Huber
Blocked By: | 3686 removed |
---|
comment:3 Changed on 06/01/20 at 11:19:05 by Sebastian Huber
Blocked By: | 3586 added |
---|
comment:4 Changed on 06/01/20 at 11:46:42 by Sebastian Huber
Description: | modified (diff) |
---|
comment:5 Changed on 06/04/20 at 12:32:13 by Sebastian Huber
Description: | modified (diff) |
---|---|
Owner: | set to Sebastian Huber |
Status: | assigned → accepted |
comment:6 Changed on 06/04/20 at 17:38:29 by Sebastian Huber
Description: | modified (diff) |
---|
comment:7 Changed on 09/03/20 at 05:00:43 by Sebastian Huber <sebastian.huber@…>
comment:8 Changed on 09/03/20 at 05:00:46 by Sebastian Huber <sebastian.huber@…>
comment:9 Changed on 09/03/20 at 05:00:48 by Sebastian Huber <sebastian.huber@…>
comment:10 Changed on 09/03/20 at 05:00:50 by Sebastian Huber <sebastian.huber@…>
comment:11 Changed on 09/03/20 at 05:00:52 by Sebastian Huber <sebastian.huber@…>
comment:12 Changed on 09/03/20 at 05:00:54 by Sebastian Huber <sebastian.huber@…>
comment:13 Changed on 09/03/20 at 05:00:57 by Sebastian Huber <sebastian.huber@…>
comment:14 Changed on 09/03/20 at 05:00:59 by Sebastian Huber <sebastian.huber@…>
comment:15 Changed on 09/03/20 at 05:01:01 by Sebastian Huber <sebastian.huber@…>
comment:16 Changed on 09/03/20 at 05:01:03 by Sebastian Huber <sebastian.huber@…>
comment:17 Changed on 09/03/20 at 05:01:05 by Sebastian Huber <sebastian.huber@…>
comment:18 Changed on 09/03/20 at 05:01:08 by Sebastian Huber <sebastian.huber@…>
comment:19 Changed on 09/03/20 at 05:01:10 by Sebastian Huber <sebastian.huber@…>
comment:20 Changed on 09/03/20 at 05:01:12 by Sebastian Huber <sebastian.huber@…>
comment:21 Changed on 09/03/20 at 05:01:14 by Sebastian Huber <sebastian.huber@…>
comment:22 Changed on 09/03/20 at 05:01:16 by Sebastian Huber <sebastian.huber@…>
comment:23 Changed on 09/18/20 at 16:57:09 by Sebastian Huber <sebastian.huber@…>
In 0b410b8a/rtems:
comment:25 Changed on 10/11/20 at 13:27:04 by Sebastian Huber <sebastian.huber@…>
comment:26 Changed on 10/11/20 at 14:07:39 by Sebastian Huber <sebastian.huber@…>
In 8111a6ba/rtems:
comment:27 Changed on 11/12/20 at 06:47:02 by Sebastian Huber <sebastian.huber@…>
comment:28 Changed on 11/12/20 at 06:47:04 by Sebastian Huber <sebastian.huber@…>
comment:29 Changed on 11/12/20 at 07:55:26 by Sebastian Huber <sebastian.huber@…>
In 1af94608/rtems:
comment:34 Changed on 11/12/20 at 07:55:44 by Sebastian Huber <sebastian.huber@…>
In 9b4458e7/rtems:
comment:39 Changed on 11/20/20 at 13:27:03 by Sebastian Huber <sebastian.huber@…>
comment:41 Changed on 12/01/20 at 13:46:11 by Sebastian Huber <sebastian.huber@…>
comment:42 Changed on 12/02/20 at 07:20:08 by Sebastian Huber <sebastian.huber@…>
comment:43 Changed on 12/02/20 at 07:20:10 by Sebastian Huber <sebastian.huber@…>
comment:46 Changed on 12/02/20 at 07:31:31 by Sebastian Huber <sebastian.huber@…>
comment:49 Changed on 12/03/20 at 06:25:18 by Sebastian Huber <sebastian.huber@…>
In 768327d0/rtems:
comment:50 Changed on 12/09/20 at 08:20:55 by Sebastian Huber <sebastian.huber@…>
comment:51 Changed on 12/09/20 at 08:20:57 by Sebastian Huber <sebastian.huber@…>
comment:53 Changed on 02/03/21 at 05:17:38 by Sebastian Huber <sebastian.huber@…>
In 8a95e6f8/rtems:
comment:54 Changed on 02/03/21 at 05:17:47 by Sebastian Huber <sebastian.huber@…>
In aa0060f4/rtems:
comment:55 Changed on 02/03/21 at 05:20:14 by Sebastian Huber <sebastian.huber@…>
comment:56 Changed on 02/03/21 at 05:20:16 by Sebastian Huber <sebastian.huber@…>
comment:57 Changed on 02/17/21 at 17:46:39 by Sebastian Huber <sebastian.huber@…>
comment:58 Changed on 02/17/21 at 17:46:42 by Sebastian Huber <sebastian.huber@…>
comment:59 Changed on 02/17/21 at 17:46:46 by Sebastian Huber <sebastian.huber@…>
comment:60 Changed on 02/17/21 at 17:46:48 by Sebastian Huber <sebastian.huber@…>
comment:61 Changed on 02/17/21 at 17:46:50 by Sebastian Huber <sebastian.huber@…>
comment:62 Changed on 02/17/21 at 17:46:52 by Sebastian Huber <sebastian.huber@…>
comment:63 Changed on 02/17/21 at 17:46:55 by Sebastian Huber <sebastian.huber@…>
comment:64 Changed on 02/17/21 at 17:46:57 by Sebastian Huber <sebastian.huber@…>
comment:65 Changed on 02/17/21 at 17:46:59 by Sebastian Huber <sebastian.huber@…>
comment:66 Changed on 02/17/21 at 17:47:02 by Sebastian Huber <sebastian.huber@…>
comment:67 Changed on 02/17/21 at 17:47:04 by Sebastian Huber <sebastian.huber@…>
comment:68 Changed on 02/17/21 at 19:26:45 by Sebastian Huber <sebastian.huber@…>
In 2730599c/rtems:
comment:70 Changed on 02/17/21 at 19:26:52 by Sebastian Huber <sebastian.huber@…>
In bf3b9f45/rtems:
comment:71 Changed on 02/17/21 at 19:26:55 by Sebastian Huber <sebastian.huber@…>
In 7a1828ac/rtems:
comment:76 Changed on 02/19/21 at 06:06:15 by Sebastian Huber <sebastian.huber@…>
comment:77 Changed on 02/19/21 at 06:09:24 by Sebastian Huber <sebastian.huber@…>
In 8b1b9872/rtems:
comment:78 Changed on 04/19/21 at 05:18:08 by Sebastian Huber <sebastian.huber@…>
comment:79 Changed on 04/22/21 at 05:13:44 by Sebastian Huber <sebastian.huber@…>
comment:80 Changed on 04/22/21 at 05:13:46 by Sebastian Huber <sebastian.huber@…>
comment:81 Changed on 04/22/21 at 05:13:48 by Sebastian Huber <sebastian.huber@…>
comment:82 Changed on 04/22/21 at 05:13:52 by Sebastian Huber <sebastian.huber@…>
comment:83 Changed on 04/22/21 at 05:13:54 by Sebastian Huber <sebastian.huber@…>
comment:84 Changed on 04/22/21 at 05:13:57 by Sebastian Huber <sebastian.huber@…>
comment:85 Changed on 04/22/21 at 05:13:59 by Sebastian Huber <sebastian.huber@…>
comment:88 Changed on 04/22/21 at 05:14:47 by Sebastian Huber <sebastian.huber@…>
In 0be4b882/rtems:
comment:89 Changed on 04/22/21 at 05:14:50 by Sebastian Huber <sebastian.huber@…>
In e8be0047/rtems:
comment:91 Changed on 04/23/21 at 06:32:43 by Sebastian Huber <sebastian.huber@…>
comment:92 Changed on 04/23/21 at 06:32:45 by Sebastian Huber <sebastian.huber@…>
comment:96 Changed on 04/28/21 at 07:03:03 by Sebastian Huber <sebastian.huber@…>
In b3d3186d/rtems:
comment:97 Changed on 04/28/21 at 07:03:07 by Sebastian Huber <sebastian.huber@…>
In a1679af3/rtems:
comment:98 Changed on 04/28/21 at 07:04:10 by Sebastian Huber <sebastian.huber@…>
comment:99 Changed on 04/28/21 at 07:04:13 by Sebastian Huber <sebastian.huber@…>
comment:100 Changed on 04/28/21 at 07:04:19 by Sebastian Huber <sebastian.huber@…>
comment:101 Changed on 04/28/21 at 07:04:21 by Sebastian Huber <sebastian.huber@…>
comment:102 Changed on 06/15/21 at 05:47:59 by Sebastian Huber <sebastian.huber@…>
comment:103 Changed on 06/15/21 at 08:40:28 by Sebastian Huber <sebastian.huber@…>
In 6abdd89/rtems:
comment:104 Changed on 07/27/21 at 05:43:11 by Sebastian Huber <sebastian.huber@…>
In c4eafae2/rtems:
comment:105 Changed on 08/02/21 at 05:15:51 by Sebastian Huber <sebastian.huber@…>
In d999f865/rtems:
comment:106 Changed on 01/26/22 at 13:27:56 by Sebastian Huber
Resolution: | → fixed |
---|---|
Status: | accepted → closed |
Work is done.
comment:107 Changed on 01/26/22 at 13:28:19 by Sebastian Huber
Keywords: | qualification added |
---|
comment:108 Changed on 10/04/22 at 08:39:36 by Sebastian Huber <sebastian.huber@…>
In cc43dc3e/rtems:
In 16ee8cf/rtems-docs: