blob: 265e74778d7aca81014970518caa056782595bc0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
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)
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: |
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:
- role: interface-placement
uid: header
- role: interface-ingroup
uid: group
name: rtems_io_read
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: |
is the major number of the device.
dir: null
name: major
- description: |
is the minor number of the device.
dir: null
name: minor
- description: |
is the argument passed to the device driver read entry.
dir: null
name: argument
return:
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
|
