diff options
Diffstat (limited to 'spec/rtems/io/if/read.yml')
| -rw-r--r-- | spec/rtems/io/if/read.yml | 32 |
1 files changed, 24 insertions, 8 deletions
diff --git a/spec/rtems/io/if/read.yml b/spec/rtems/io/if/read.yml index b28a1279..265e7477 100644 --- a/spec/rtems/io/if/read.yml +++ b/spec/rtems/io/if/read.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Reads from 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 read entry registered in the Device + Driver Table for the specified device major number. enabled-by: true interface-type: function links: @@ -21,18 +24,31 @@ links: - role: interface-ingroup uid: group name: rtems_io_read -notes: null +notes: | + Read operations typically require a buffer address as part of the argument + parameter block. The contents of this buffer will be replaced with data from + the device. 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 read entry. dir: null name: argument return: - return: null - return-values: [] + return: | + Other status codes may be returned by the device driver read 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 |