diff options
Diffstat (limited to 'spec/rtems/io')
23 files changed, 610 insertions, 0 deletions
diff --git a/spec/rtems/io/if/close.yml b/spec/rtems/io/if/close.yml new file mode 100644 index 00000000..0321a932 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/control.yml b/spec/rtems/io/if/control.yml new file mode 100644 index 00000000..09608139 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/device-driver-entry.yml b/spec/rtems/io/if/device-driver-entry.yml new file mode 100644 index 00000000..a3ba8c60 --- /dev/null +++ b/spec/rtems/io/if/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: group +name: rtems_device_driver_entry +notes: null +type: interface diff --git a/spec/rtems/io/if/device-driver.yml b/spec/rtems/io/if/device-driver.yml new file mode 100644 index 00000000..7ed1cdb0 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_device_driver +notes: null +type: interface diff --git a/spec/rtems/io/if/device-major-number.yml b/spec/rtems/io/if/device-major-number.yml new file mode 100644 index 00000000..f49bbc6b --- /dev/null +++ b/spec/rtems/io/if/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: ${/c/if/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_device_major_number +notes: null +type: interface diff --git a/spec/rtems/io/if/device-minor-number.yml b/spec/rtems/io/if/device-minor-number.yml new file mode 100644 index 00000000..dde18153 --- /dev/null +++ b/spec/rtems/io/if/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: ${/c/if/uint32_t:/name} ${.:/name} + variants: [] +description: null +enabled-by: true +interface-type: typedef +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_device_minor_number +notes: null +type: interface diff --git a/spec/rtems/io/if/driver-address-table.yml b/spec/rtems/io/if/driver-address-table.yml new file mode 100644 index 00000000..503ed033 --- /dev/null +++ b/spec/rtems/io/if/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: group +name: rtems_driver_address_table +notes: null +type: interface diff --git a/spec/rtems/io/if/driver-error.yml b/spec/rtems/io/if/driver-error.yml new file mode 100644 index 00000000..e9d1f0aa --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/getchark.yml b/spec/rtems/io/if/getchark.yml new file mode 100644 index 00000000..312942a7 --- /dev/null +++ b/spec/rtems/io/if/getchark.yml @@ -0,0 +1,9 @@ +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: unspecified-function +links: [] +name: rtems_putc +reference: null +type: interface diff --git a/spec/rtems/io/if/group.yml b/spec/rtems/io/if/group.yml new file mode 100644 index 00000000..181f251a --- /dev/null +++ b/spec/rtems/io/if/group.yml @@ -0,0 +1,21 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: | + The Input/Output Interface Manager provides a well-defined mechanism for + accessing device drivers and a structured methodology for organizing device + drivers. +copyrights: +- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de) +- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR) +description: null +enabled-by: true +identifier: RTEMSAPIClassicIO +interface-type: group +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: ../../if/group +name: Input/Output Interface Manager +text: | + The Classic API shall provide an interface to the Input/Output Interface Manager. +type: interface diff --git a/spec/rtems/io/if/header.yml b/spec/rtems/io/if/header.yml new file mode 100644 index 00000000..70a8d08e --- /dev/null +++ b/spec/rtems/io/if/header.yml @@ -0,0 +1,12 @@ +SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause +brief: This header file defines the IO Manager 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/io.h +prefix: cpukit/include +type: interface diff --git a/spec/rtems/io/if/initialize.yml b/spec/rtems/io/if/initialize.yml new file mode 100644 index 00000000..61250511 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/mount.yml b/spec/rtems/io/if/mount.yml new file mode 100644 index 00000000..ee4d6ba1 --- /dev/null +++ b/spec/rtems/io/if/mount.yml @@ -0,0 +1,9 @@ +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: unspecified-function +links: [] +name: mount +reference: null +type: interface diff --git a/spec/rtems/io/if/open.yml b/spec/rtems/io/if/open.yml new file mode 100644 index 00000000..6ec33a03 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/printer.yml b/spec/rtems/io/if/printer.yml new file mode 100644 index 00000000..118f0686 --- /dev/null +++ b/spec/rtems/io/if/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/rtems/io/if/printk.yml b/spec/rtems/io/if/printk.yml new file mode 100644 index 00000000..f8ed543d --- /dev/null +++ b/spec/rtems/io/if/printk.yml @@ -0,0 +1,9 @@ +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: unspecified-function +links: [] +name: printk +reference: null +type: interface diff --git a/spec/rtems/io/if/putc.yml b/spec/rtems/io/if/putc.yml new file mode 100644 index 00000000..d49990be --- /dev/null +++ b/spec/rtems/io/if/putc.yml @@ -0,0 +1,9 @@ +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: unspecified-function +links: [] +name: getchark +reference: null +type: interface diff --git a/spec/rtems/io/if/read.yml b/spec/rtems/io/if/read.yml new file mode 100644 index 00000000..b28a1279 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/register-driver.yml b/spec/rtems/io/if/register-driver.yml new file mode 100644 index 00000000..a51ec9c5 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/register-name.yml b/spec/rtems/io/if/register-name.yml new file mode 100644 index 00000000..0b086407 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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/rtems/io/if/unmount.yml b/spec/rtems/io/if/unmount.yml new file mode 100644 index 00000000..fa548907 --- /dev/null +++ b/spec/rtems/io/if/unmount.yml @@ -0,0 +1,9 @@ +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: unspecified-function +links: [] +name: unmount +reference: null +type: interface diff --git a/spec/rtems/io/if/unregister-driver.yml b/spec/rtems/io/if/unregister-driver.yml new file mode 100644 index 00000000..0f7cf261 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +name: rtems_io_unregister_driver +notes: null +params: +- description: '%' + dir: null + name: major +return: + return: null + return-values: [] +type: interface diff --git a/spec/rtems/io/if/write.yml b/spec/rtems/io/if/write.yml new file mode 100644 index 00000000..0cd9c278 --- /dev/null +++ b/spec/rtems/io/if/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/if/code:/name} + variants: [] +description: null +enabled-by: true +interface-type: function +links: +- role: interface-placement + uid: header +- role: interface-ingroup + uid: group +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 |