summaryrefslogtreecommitdiffstats
path: root/spec/rtems/io/if/initialize.yml
diff options
context:
space:
mode:
Diffstat (limited to 'spec/rtems/io/if/initialize.yml')
-rw-r--r--spec/rtems/io/if/initialize.yml37
1 files changed, 29 insertions, 8 deletions
diff --git a/spec/rtems/io/if/initialize.yml b/spec/rtems/io/if/initialize.yml
index 61250511..3e61ccfe 100644
--- a/spec/rtems/io/if/initialize.yml
+++ b/spec/rtems/io/if/initialize.yml
@@ -1,5 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: '%'
+brief: |
+ Initializes the device specified by device major and minor number.
copyrights:
- Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
- Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -12,7 +13,9 @@ definition:
- void *${.:/params[2]/name}
return: ${../../status/if/code:/name}
variants: []
-description: null
+description: |
+ This directive calls the device driver initialization entry registered in the
+ Device Driver Table for the specified device major number.
enabled-by: true
interface-type: function
links:
@@ -21,18 +24,36 @@ links:
- role: interface-ingroup
uid: group
name: rtems_io_initialize
-notes: null
+notes: |
+ This directive is automatically invoked for each device driver defined by the
+ application configuration during the system initialization and via the
+ {register-driver:/name} directive.
+
+ A device driver initialization entry is responsible for initializing all
+ hardware and data structures associated with a device. If necessary, it can
+ allocate memory to be used during other operations.
params:
-- description: '%'
+- description: |
+ is the major number of the device.
dir: null
name: major
-- description: '%'
+- description: |
+ is the minor number of the device.
dir: null
name: minor
-- description: '%'
+- description: |
+ is the argument passed to the device driver initialization entry.
dir: null
name: argument
return:
- return: null
- return-values: []
+ return: |
+ Other status codes may be returned by the device driver initialization
+ routine.
+ return-values:
+ - description: |
+ The requested operation was successful.
+ value: ${../../status/if/successful:/name}
+ - description: |
+ The device major number was invalid.
+ value: ${../../status/if/invalid-number:/name}
type: interface