summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-28 08:11:11 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-09-28 08:11:11 +0200
commit322caa7c6527028d7b3e3fa866ddd526e8455977 (patch)
treec8177eb51b23eb6d11698e3c4b796a8740e0b61c
parentspec: Add appl config opts to API domain (diff)
downloadrtems-central-322caa7c6527028d7b3e3fa866ddd526e8455977.tar.bz2
spec: Place all interfaces in a header
-rw-r--r--spec/rtems/io/if/getchark.yml4
-rw-r--r--spec/rtems/io/if/header-2.yml12
-rw-r--r--spec/rtems/io/if/header-3.yml12
-rw-r--r--spec/rtems/io/if/header-4.yml13
-rw-r--r--spec/rtems/io/if/mount.yml4
-rw-r--r--spec/rtems/io/if/printer.yml4
-rw-r--r--spec/rtems/io/if/printk.yml4
-rw-r--r--spec/rtems/io/if/putc.yml6
-rw-r--r--spec/rtems/io/if/unmount.yml4
9 files changed, 56 insertions, 7 deletions
diff --git a/spec/rtems/io/if/getchark.yml b/spec/rtems/io/if/getchark.yml
index 312942a7..ac3f6961 100644
--- a/spec/rtems/io/if/getchark.yml
+++ b/spec/rtems/io/if/getchark.yml
@@ -3,7 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+ uid: header-3
name: rtems_putc
reference: null
type: interface
diff --git a/spec/rtems/io/if/header-2.yml b/spec/rtems/io/if/header-2.yml
new file mode 100644
index 00000000..862551d0
--- /dev/null
+++ b/spec/rtems/io/if/header-2.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the IO library API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+ uid: /if/domain
+path: rtems/libio.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/header-3.yml b/spec/rtems/io/if/header-3.yml
new file mode 100644
index 00000000..c4c8dcd3
--- /dev/null
+++ b/spec/rtems/io/if/header-3.yml
@@ -0,0 +1,12 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: This header file defines the polled character IO driver API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+ uid: /if/domain
+path: rtems/bspIo.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/header-4.yml b/spec/rtems/io/if/header-4.yml
new file mode 100644
index 00000000..94e0c488
--- /dev/null
+++ b/spec/rtems/io/if/header-4.yml
@@ -0,0 +1,13 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+brief: |
+ This header file defines the kernel print API.
+copyrights:
+- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+enabled-by: true
+interface-type: header-file
+links:
+- role: interface-placement
+ uid: /if/domain
+path: rtems/print.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/rtems/io/if/mount.yml b/spec/rtems/io/if/mount.yml
index ee4d6ba1..672bb916 100644
--- a/spec/rtems/io/if/mount.yml
+++ b/spec/rtems/io/if/mount.yml
@@ -3,7 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+ uid: header-2
name: mount
reference: null
type: interface
diff --git a/spec/rtems/io/if/printer.yml b/spec/rtems/io/if/printer.yml
index 118f0686..1ec04cf5 100644
--- a/spec/rtems/io/if/printer.yml
+++ b/spec/rtems/io/if/printer.yml
@@ -7,7 +7,9 @@ definition-kind: struct-only
description: null
enabled-by: true
interface-type: struct
-links: []
+links:
+- role: interface-placement
+ uid: header-4
name: rtems_printer
notes: null
type: interface
diff --git a/spec/rtems/io/if/printk.yml b/spec/rtems/io/if/printk.yml
index f8ed543d..b5ca73fe 100644
--- a/spec/rtems/io/if/printk.yml
+++ b/spec/rtems/io/if/printk.yml
@@ -3,7 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+ uid: header-3
name: printk
reference: null
type: interface
diff --git a/spec/rtems/io/if/putc.yml b/spec/rtems/io/if/putc.yml
index d49990be..ac3f6961 100644
--- a/spec/rtems/io/if/putc.yml
+++ b/spec/rtems/io/if/putc.yml
@@ -3,7 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-type: unspecified-function
-links: []
-name: getchark
+links:
+- role: interface-placement
+ uid: header-3
+name: rtems_putc
reference: null
type: interface
diff --git a/spec/rtems/io/if/unmount.yml b/spec/rtems/io/if/unmount.yml
index fa548907..53a50633 100644
--- a/spec/rtems/io/if/unmount.yml
+++ b/spec/rtems/io/if/unmount.yml
@@ -3,7 +3,9 @@ copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
enabled-by: true
interface-type: unspecified-function
-links: []
+links:
+- role: interface-placement
+ uid: header-2
name: unmount
reference: null
type: interface