spec: Add /if/rtems/types/*

19 files changed, 427 insertions, 0 deletions

diff --git a/spec/if/rtems/types/header.yml b/spec/if/rtems/types/header.yml
index 476f40f6..9f00af97 100644
--- a/spec/if/rtems/types/header.yml
+++ b/spec/if/rtems/types/header.yml
@@ -4,6 +4,21 @@ copyrights:
 enabled-by: true
 interface-type: header-file
 links:
+- enabled-by: true
+  role: interface-include
+  uid: /if/c/sys-cpuset
+- enabled-by: true
+  role: interface-include
+  uid: /if/c/sys-impl-timespec
+- enabled-by: true
+  role: interface-include
+  uid: /if/c/sys-impl-timeval
+- enabled-by: true
+  role: interface-include
+  uid: /if/rtems/modes/header
+- enabled-by: RTEMS_MULTIPROCESSING
+  role: interface-include
+  uid: /if/impl/mpci/header
 - role: interface-placement
   uid: /if/domains/api
 path: rtems/rtems/types.h
diff --git a/spec/if/rtems/types/id-none.yml b/spec/if/rtems/types/id-none.yml
new file mode 100644
index 00000000..076a0a87
--- /dev/null
+++ b/spec/if/rtems/types/id-none.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This is an invalid object identifier.
+copyrights:
+- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/object/id-none:/name}
+  variants: []
+description: |
+  No object can have this identifier.
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: RTEMS_ID_NONE
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/id.yml b/spec/if/rtems/types/id.yml
new file mode 100644
index 00000000..834e236f
--- /dev/null
+++ b/spec/if/rtems/types/id.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Values of this type identify an object.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/object/id:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_id
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/interval.yml b/spec/if/rtems/types/interval.yml
new file mode 100644
index 00000000..aa30294e
--- /dev/null
+++ b/spec/if/rtems/types/interval.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type is used to represent clock tick intervals.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/watchdog/interval:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_interval
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/minimum-packet-size.yml b/spec/if/rtems/types/minimum-packet-size.yml
new file mode 100644
index 00000000..78168096
--- /dev/null
+++ b/spec/if/rtems/types/minimum-packet-size.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/packet-minimum-size:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: RTEMS_MINIMUM_PACKET_SIZE
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/minimun-hetero-conversion.yml b/spec/if/rtems/types/minimun-hetero-conversion.yml
new file mode 100644
index 00000000..edeb5b0e
--- /dev/null
+++ b/spec/if/rtems/types/minimun-hetero-conversion.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/packet-minimum-hetero-conversion:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: RTEMS_MINIMUN_HETERO_CONVERSION
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mp-packet-classes.yml b/spec/if/rtems/types/mp-packet-classes.yml
new file mode 100644
index 00000000..82741de7
--- /dev/null
+++ b/spec/if/rtems/types/mp-packet-classes.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This enumerated type defines the packet classes.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2006 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/packet-classes:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mp_packet_classes
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-entry.yml b/spec/if/rtems/types/mpci-entry.yml
new file mode 100644
index 00000000..6f56d664
--- /dev/null
+++ b/spec/if/rtems/types/mpci-entry.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  Return type of every MPCI handler routine.
+copyrights:
+- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: MPCI_Entry rtems_mpci_entry
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-get-packet-entry.yml b/spec/if/rtems/types/mpci-get-packet-entry.yml
new file mode 100644
index 00000000..92ca1462
--- /dev/null
+++ b/spec/if/rtems/types/mpci-get-packet-entry.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prototype for the get packet entry point in an MPCI.
+copyrights:
+- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2006 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/get-packet-entry:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_get_packet_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-initialization-entry.yml b/spec/if/rtems/types/mpci-initialization-entry.yml
new file mode 100644
index 00000000..c36a1b2e
--- /dev/null
+++ b/spec/if/rtems/types/mpci-initialization-entry.yml
@@ -0,0 +1,21 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prototype for the initialization entry point in an
+  MPCI.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2006 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/initialization-entry:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_initialization_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-receive-packet-entry.yml b/spec/if/rtems/types/mpci-receive-packet-entry.yml
new file mode 100644
index 00000000..1aede5ff
--- /dev/null
+++ b/spec/if/rtems/types/mpci-receive-packet-entry.yml
@@ -0,0 +1,21 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prototype for the receive packet entry point in an
+  MPCI.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2006 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/receive-entry:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_receive_packet_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-return-packet-entry.yml b/spec/if/rtems/types/mpci-return-packet-entry.yml
new file mode 100644
index 00000000..bb3da501
--- /dev/null
+++ b/spec/if/rtems/types/mpci-return-packet-entry.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prototype for the return packet entry point in an MPCI.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 2006 On-Line Applications Research Corporation (OAR)
+definition:
+  default: ${/if/impl/mpci/return-packet-entry:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_return_packet_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-send-packet-entry.yml b/spec/if/rtems/types/mpci-send-packet-entry.yml
new file mode 100644
index 00000000..13f4578f
--- /dev/null
+++ b/spec/if/rtems/types/mpci-send-packet-entry.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prototype for the send packet entry point in an MPCI.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/mpci/send-entry:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_send_packet_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/mpci-table.yml b/spec/if/rtems/types/mpci-table.yml
new file mode 100644
index 00000000..b52d5f90
--- /dev/null
+++ b/spec/if/rtems/types/mpci-table.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the MPCI control.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/mpci/control:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_mpci_table
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/multiprocessing-table.yml b/spec/if/rtems/types/multiprocessing-table.yml
new file mode 100644
index 00000000..cb94a726
--- /dev/null
+++ b/spec/if/rtems/types/multiprocessing-table.yml
@@ -0,0 +1,19 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the MPCI configuration table.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/mpci/configuration-type:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_multiprocessing_table
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/name.yml b/spec/if/rtems/types/name.yml
new file mode 100644
index 00000000..b7e8ff05
--- /dev/null
+++ b/spec/if/rtems/types/name.yml
@@ -0,0 +1,22 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type is used to represent an Classic API object name.
+copyrights:
+- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/c/uint32_t:/name} rtems_name
+  variants: []
+description: |
+  It is an unsigned 32-bit integer which can be treated as a numeric value or
+  initialized using rtems_build_name() to encode four ASCII characters.  A
+  value of zero may have a special meaning in some directives.
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_name
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/no-timeout.yml b/spec/if/rtems/types/no-timeout.yml
new file mode 100644
index 00000000..35c00507
--- /dev/null
+++ b/spec/if/rtems/types/no-timeout.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: '%'
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
+definition:
+  default: |
+    ( (${interval:/name}) ${/if/impl/watchdog/no-timeout:/name} )
+  variants: []
+description: null
+enabled-by: true
+interface-type: define
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: RTEMS_NO_TIMEOUT
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/packet-prefix.yml b/spec/if/rtems/types/packet-prefix.yml
new file mode 100644
index 00000000..84e8f911
--- /dev/null
+++ b/spec/if/rtems/types/packet-prefix.yml
@@ -0,0 +1,20 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type defines the prefix found at the beginning of each MPCI packet sent
+  between nodes.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+  default: ${/if/impl/mpci/packet-prefix:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: RTEMS_MULTIPROCESSING
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_packet_prefix
+notes: null
+type: interface
diff --git a/spec/if/rtems/types/time-of-day.yml b/spec/if/rtems/types/time-of-day.yml
new file mode 100644
index 00000000..353e4330
--- /dev/null
+++ b/spec/if/rtems/types/time-of-day.yml
@@ -0,0 +1,75 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+  This type is used to represent the calendar time in the Classic API.
+copyrights:
+- Copyright (C) 2009, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+definition:
+- default:
+    brief: |
+      This member represents the year A.D.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: year
+  variants: []
+- default:
+    brief: |
+      This member represents the month of the year with values from 1 to 12.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: month
+  variants: []
+- default:
+    brief: |
+      This member represents the day of the month with values from 1 to 31.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: day
+  variants: []
+- default:
+    brief: |
+      This member represents the hour of the day with values from 0 to 23.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: hour
+  variants: []
+- default:
+    brief: |
+      This member represents the minute of the hour with values from 0 to 59.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: minute
+  variants: []
+- default:
+    brief: |
+      This member represents the second of the minute with values from 0 to 59.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: second
+  variants: []
+- default:
+    brief: |
+      This member represents the clock tick of the second with values from 0 to
+      rtems_clock_get_ticks_per_second() minus one.
+    definition: ${/if/c/uint32_t:/name} ${.:name}
+    description: null
+    kind: member
+    name: ticks
+  variants: []
+definition-kind: typedef-only
+description: null
+enabled-by: true
+interface-type: struct
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/types
+name: rtems_time_of_day
+notes: null
+type: interface