summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2020-10-05 16:27:09 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2020-10-08 08:23:26 +0200
commit4c8dea2c32cf6e2e43acf491f989b669ad7cd683 (patch)
tree21287f873251f5ffd4753222313883eba4214123
parentspec: Add index entries for IO Manager (diff)
downloadrtems-central-4c8dea2c32cf6e2e43acf491f989b669ad7cd683.tar.bz2
spec: Review IO Manager
-rw-r--r--spec/rtems/io/if/control.yml2
-rw-r--r--spec/rtems/io/if/device-driver-entry.yml2
-rw-r--r--spec/rtems/io/if/driver-address-table.yml2
-rw-r--r--spec/rtems/io/if/group.yml6
-rw-r--r--spec/rtems/io/if/initialize.yml2
-rw-r--r--spec/rtems/io/if/open.yml2
-rw-r--r--spec/rtems/io/if/read.yml2
-rw-r--r--spec/rtems/io/if/register-driver.yml9
-rw-r--r--spec/rtems/io/if/write.yml2
9 files changed, 14 insertions, 15 deletions
diff --git a/spec/rtems/io/if/control.yml b/spec/rtems/io/if/control.yml
index 546e2565..0536a083 100644
--- a/spec/rtems/io/if/control.yml
+++ b/spec/rtems/io/if/control.yml
@@ -31,7 +31,7 @@ notes: |
The exact functionality of the driver entry called by this directive is
driver dependent. It should not be assumed that the control entries of two
device drivers are compatible. For example, an RS-232 driver I/O control
- operation may change the baud rate of a serial line, while an I/O control
+ operation may change the baud of a serial line, while an I/O control
operation for a floppy disk driver may cause a seek operation.
params:
- description: |
diff --git a/spec/rtems/io/if/device-driver-entry.yml b/spec/rtems/io/if/device-driver-entry.yml
index c273c1c3..a5ec7e34 100644
--- a/spec/rtems/io/if/device-driver-entry.yml
+++ b/spec/rtems/io/if/device-driver-entry.yml
@@ -10,7 +10,7 @@ definition:
${device-major-number:/name},
${device-minor-number:/name},
void *
- );
+ )
variants: []
description: null
enabled-by: true
diff --git a/spec/rtems/io/if/driver-address-table.yml b/spec/rtems/io/if/driver-address-table.yml
index 782b48f3..283f90a5 100644
--- a/spec/rtems/io/if/driver-address-table.yml
+++ b/spec/rtems/io/if/driver-address-table.yml
@@ -10,7 +10,7 @@ definition:
This member is the device driver initialization entry.
definition: ${device-driver-entry:/name} ${.:name}
description: |
- This entry is called by ${initialize:/name}
+ This entry is called by ${initialize:/name}.
kind: member
name: initialization_entry
variants: []
diff --git a/spec/rtems/io/if/group.yml b/spec/rtems/io/if/group.yml
index 7fec465a..00bf7308 100644
--- a/spec/rtems/io/if/group.yml
+++ b/spec/rtems/io/if/group.yml
@@ -1,6 +1,6 @@
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
brief: |
- The Input/Output Interface Manager provides a well-defined mechanism for
+ The Input/Output (I/O) Manager provides a well-defined mechanism for
accessing device drivers and a structured methodology for organizing device
drivers.
copyrights:
@@ -34,7 +34,7 @@ links:
uid: write
- role: documentation-order
uid: control
-name: Input/Output Interface Manager
+name: I/O Manager
text: |
- The Classic API shall provide an interface to the Input/Output Interface Manager.
+ The Classic API shall provide an interface to the I/O Manager.
type: interface
diff --git a/spec/rtems/io/if/initialize.yml b/spec/rtems/io/if/initialize.yml
index f92747a0..3b29b54b 100644
--- a/spec/rtems/io/if/initialize.yml
+++ b/spec/rtems/io/if/initialize.yml
@@ -50,7 +50,7 @@ params:
return:
return: |
Other status codes may be returned by the device driver initialization
- routine.
+ entry.
return-values:
- description: |
The requested operation was successful.
diff --git a/spec/rtems/io/if/open.yml b/spec/rtems/io/if/open.yml
index 73876665..09602a12 100644
--- a/spec/rtems/io/if/open.yml
+++ b/spec/rtems/io/if/open.yml
@@ -44,7 +44,7 @@ params:
name: argument
return:
return: |
- Other status codes may be returned by the device driver open routine.
+ Other status codes may be returned by the device driver open entry.
return-values:
- description: |
The requested operation was successful.
diff --git a/spec/rtems/io/if/read.yml b/spec/rtems/io/if/read.yml
index dd7e14b1..a12aaa67 100644
--- a/spec/rtems/io/if/read.yml
+++ b/spec/rtems/io/if/read.yml
@@ -45,7 +45,7 @@ params:
name: argument
return:
return: |
- Other status codes may be returned by the device driver read routine.
+ Other status codes may be returned by the device driver read entry.
return-values:
- description: |
The requested operation was successful.
diff --git a/spec/rtems/io/if/register-driver.yml b/spec/rtems/io/if/register-driver.yml
index b6fd5b2c..bad20320 100644
--- a/spec/rtems/io/if/register-driver.yml
+++ b/spec/rtems/io/if/register-driver.yml
@@ -29,8 +29,8 @@ notes: |
If the device major number equals zero a device major number will be
obtained. The device major number of the registered driver will be returned.
- After a successful registration ${initialize:/name} routine will be called to
- initialize the device.
+ After a successful registration, the ${initialize:/name} directive will be
+ called to initialize the device.
params:
- description: |
is the device major number. Use a value of zero to let the system obtain a
@@ -49,8 +49,7 @@ params:
name: registered_major
return:
return: |
- Other status codes may be returned by the device driver initialization
- routine.
+ Other status codes may be returned by ${initialize:/name}.
return-values:
- description: |
The requested operation was successful.
@@ -69,7 +68,7 @@ return:
The system was unable to obtain a device major number.
value: ${../../status/if/too-many:/name}
- description: |
- The device major number was in use.
+ The device major number was already in use.
value: ${../../status/if/resource-in-use:/name}
- description: |
The directive was called from interrupt context.
diff --git a/spec/rtems/io/if/write.yml b/spec/rtems/io/if/write.yml
index a4c1902d..c49a0acf 100644
--- a/spec/rtems/io/if/write.yml
+++ b/spec/rtems/io/if/write.yml
@@ -44,7 +44,7 @@ params:
name: argument
return:
return: |
- Other status codes may be returned by the device driver write routine.
+ Other status codes may be returned by the device driver write entry.
return-values:
- description: |
The requested operation was successful.