spec: Add /if/rtems/io/*

17 files changed, 543 insertions, 0 deletions

diff --git a/spec/if/rtems/io/close.yml b/spec/if/rtems/io/close.yml
new file mode 100644
index 00000000..724617f0
--- /dev/null
+++ b/spec/if/rtems/io/close.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_close
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/control.yml b/spec/if/rtems/io/control.yml
new file mode 100644
index 00000000..37222d3c
--- /dev/null
+++ b/spec/if/rtems/io/control.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_control
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/device-driver-entry.yml b/spec/if/rtems/io/device-driver-entry.yml
new file mode 100644
index 00000000..87f6e6a9
--- /dev/null
+++ b/spec/if/rtems/io/device-driver-entry.yml
@@ -0,0 +1,24 @@
+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: |
+    ${device-driver:/name} ( *${.:/name} )(
+      ${device-major-number:/name},
+      ${device-minor-number:/name},
+      void *
+    );
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_device_driver_entry
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/device-driver.yml b/spec/if/rtems/io/device-driver.yml
new file mode 100644
index 00000000..9e78c330
--- /dev/null
+++ b/spec/if/rtems/io/device-driver.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: ${../status/code:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_device_driver
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/device-major-number.yml b/spec/if/rtems/io/device-major-number.yml
new file mode 100644
index 00000000..e02224d3
--- /dev/null
+++ b/spec/if/rtems/io/device-major-number.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/c/uint32_t:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_device_major_number
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/device-minor-number.yml b/spec/if/rtems/io/device-minor-number.yml
new file mode 100644
index 00000000..c2cf2f2c
--- /dev/null
+++ b/spec/if/rtems/io/device-minor-number.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/c/uint32_t:/name} ${.:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: typedef
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_device_minor_number
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/driver-address-table.yml b/spec/if/rtems/io/driver-address-table.yml
new file mode 100644
index 00000000..5675c2b6
--- /dev/null
+++ b/spec/if/rtems/io/driver-address-table.yml
@@ -0,0 +1,66 @@
+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:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: initialization_entry
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: open_entry
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: close_entry
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: read_entry
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: write_entry
+  variants: []
+- default:
+    brief: |
+      This member is
+    definition: rtems_device_driver_entry ${.:name}
+    description: '%'
+    kind: member
+    name: control_entry
+  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/io
+name: rtems_driver_address_table
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/driver-error.yml b/spec/if/rtems/io/driver-error.yml
new file mode 100644
index 00000000..fb092ebb
--- /dev/null
+++ b/spec/if/rtems/io/driver-error.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_driver_io_error
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: arg
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/header.yml b/spec/if/rtems/io/header.yml
new file mode 100644
index 00000000..18bea8e2
--- /dev/null
+++ b/spec/if/rtems/io/header.yml
@@ -0,0 +1,11 @@
+SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
+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/domains/api
+path: rtems/io.h
+prefix: cpukit/include
+type: interface
diff --git a/spec/if/rtems/io/initialize.yml b/spec/if/rtems/io/initialize.yml
new file mode 100644
index 00000000..fcded359
--- /dev/null
+++ b/spec/if/rtems/io/initialize.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_initialize
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/open.yml b/spec/if/rtems/io/open.yml
new file mode 100644
index 00000000..cdc5725d
--- /dev/null
+++ b/spec/if/rtems/io/open.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_open
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/printer.yml b/spec/if/rtems/io/printer.yml
new file mode 100644
index 00000000..118f0686
--- /dev/null
+++ b/spec/if/rtems/io/printer.yml
@@ -0,0 +1,13 @@
+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)
+definition: []
+definition-kind: struct-only
+description: null
+enabled-by: true
+interface-type: struct
+links: []
+name: rtems_printer
+notes: null
+type: interface
diff --git a/spec/if/rtems/io/read.yml b/spec/if/rtems/io/read.yml
new file mode 100644
index 00000000..9a424ee9
--- /dev/null
+++ b/spec/if/rtems/io/read.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_read
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/register-driver.yml b/spec/if/rtems/io/register-driver.yml
new file mode 100644
index 00000000..48e1f141
--- /dev/null
+++ b/spec/if/rtems/io/register-driver.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - const rtems_driver_address_table *${.:/params[1]/name}
+    - ${device-major-number:/name} *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_register_driver
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: driver_table
+- description: '%'
+  dir: null
+  name: registered_major
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/register-name.yml b/spec/if/rtems/io/register-name.yml
new file mode 100644
index 00000000..69c342d0
--- /dev/null
+++ b/spec/if/rtems/io/register-name.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - const char *${.:/params[0]/name}
+    - ${device-major-number:/name} ${.:/params[1]/name}
+    - ${device-minor-number:/name} ${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_register_name
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: device_name
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/unregister-driver.yml b/spec/if/rtems/io/unregister-driver.yml
new file mode 100644
index 00000000..abecee4b
--- /dev/null
+++ b/spec/if/rtems/io/unregister-driver.yml
@@ -0,0 +1,30 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_unregister_driver
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+return:
+  return: null
+  return-values: []
+type: interface
diff --git a/spec/if/rtems/io/write.yml b/spec/if/rtems/io/write.yml
new file mode 100644
index 00000000..72045094
--- /dev/null
+++ b/spec/if/rtems/io/write.yml
@@ -0,0 +1,38 @@
+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:
+    body: null
+    params:
+    - ${device-major-number:/name} ${.:/params[0]/name}
+    - ${device-minor-number:/name} ${.:/params[1]/name}
+    - void *${.:/params[2]/name}
+    return: ${../status/code:/name}
+  variants: []
+description: null
+enabled-by: true
+interface-type: function
+links:
+- role: interface-placement
+  uid: header
+- role: interface-ingroup
+  uid: /groups/api/classic/io
+name: rtems_io_write
+notes: null
+params:
+- description: '%'
+  dir: null
+  name: major
+- description: '%'
+  dir: null
+  name: minor
+- description: '%'
+  dir: null
+  name: argument
+return:
+  return: null
+  return-values: []
+type: interface