diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-26 15:43:02 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-09-29 16:26:14 +0200 |
| commit | 15264e100b9b5f9c902974b1a5dedf5f2f3cbf85 (patch) | |
| tree | 54a04bfbf735001db30a38a4a52d642f5f821554 /spec/rtems/io/if/control.yml | |
| parent | spec: Use rtems_message_queue_construct() (diff) | |
| download | rtems-central-15264e100b9b5f9c902974b1a5dedf5f2f3cbf85.tar.bz2 | |
spec: Review IO Manager
Diffstat (limited to 'spec/rtems/io/if/control.yml')
| -rw-r--r-- | spec/rtems/io/if/control.yml | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/spec/rtems/io/if/control.yml b/spec/rtems/io/if/control.yml index 09608139..c9a0de26 100644 --- a/spec/rtems/io/if/control.yml +++ b/spec/rtems/io/if/control.yml @@ -1,5 +1,6 @@ SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause -brief: '%' +brief: | + Controls 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 I/O control entry registered in the + Device Driver Table for the specified device major number. enabled-by: true interface-type: function links: @@ -21,18 +24,34 @@ links: - role: interface-ingroup uid: group name: rtems_io_control -notes: null +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 for a floppy disk driver may cause a seek operation. 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 I/O control entry. dir: null name: argument return: - return: null - return-values: [] + return: | + Other status codes may be returned by the device driver I/O control + entry. + 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 |