Print this page
12315 errors in section 7i of the manual
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man7i/fbio.7i
+++ new/usr/src/man/man7i/fbio.7i
1 1 .\" Copyright (c) 2003, Sun Microsystems, Inc.
2 2 .\" Copyright (c) 2017, Joyent, Inc.
3 3 .\" The contents of this file are subject to the terms of the
4 4 .\" Common Development and Distribution License (the "License").
5 5 .\" You may not use this file except in compliance with the License.
6 6 .\"
↓ open down ↓ |
6 lines elided |
↑ open up ↑ |
7 7 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
8 8 .\" or http://www.opensolaris.org/os/licensing.
9 9 .\" See the License for the specific language governing permissions
10 10 .\" and limitations under the License.
11 11 .\"
12 12 .\" When distributing Covered Code, include this CDDL HEADER in each
13 13 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
14 14 .\" If applicable, add the following below this CDDL HEADER, with the fields
15 15 .\" enclosed by brackets "[]" replaced with your own identifying
16 16 .\" information: Portions Copyright [yyyy] [name of copyright owner]
17 -.Dd October 22, 2017
17 +.Dd February 17, 2020
18 18 .Dt FBIO 7I
19 19 .Os
20 20 .Sh NAME
21 21 .Nm fbio
22 22 .Nd frame buffer control operations
23 23 .Sh DESCRIPTION
24 24 The frame buffers provided with this release support the same general interface
25 25 that is defined by
26 26 .In sys/fbio.h .
27 27 Each responds to an
28 28 .Dv FBIOGTYPE
29 29 .Xr ioctl 2
30 30 request which returns information in a
31 31 .Vt fbtype
32 32 structure.
33 33 .Pp
34 34 Each device has an
35 35 .\" FBTYPE isn't macro, enum, or type, just used to describe a number of
36 36 .\" CPP-macros of the form #define FBTYPE_xxxx
37 37 .Sy FBTYPE
38 38 which is used by higher-level software to
39 39 determine how to perform graphics functions.
40 40 Each device is used by opening it, doing an
41 41 .Dv FBIOGTYPE
42 42 .Xr ioctl 2
43 43 to see which frame buffer type is
44 44 present, and thereby selecting the appropriate device-management routines.
45 45 .Pp
46 46 .Dv FBIOGINFO
47 47 returns information specific to the GS accelerator.
48 48 .Pp
49 49 .Dv FBIOSVIDEO
50 50 and
51 51 .Dv FBIOGVIDEO
52 52 are general-purpose
53 53 .Xr ioctl 2
54 54 requests for controlling possible video features of frame buffers.
55 55 These
56 56 .Xr ioctl 2
57 57 requests either set or return the value of a flags integer.
58 58 At this point, only the
59 59 .Dv FBVIDEO_ON
60 60 option is available, controlled by
61 61 .Dv FBIOSVIDEO .
62 62 .Dv FBIOGVIDEO
63 63 returns the current video state.
64 64 .Pp
65 65 The
66 66 .Dv FBIOSATTR
67 67 and
68 68 .Dv FBIOGATTR
69 69 .Xr ioctl 2
70 70 requests allow access to special features of newer frame buffers.
71 71 They use the
72 72 .Vt fbsattr
73 73 and
74 74 .Vt fbgattr
75 75 structures.
76 76 .Pp
77 77 Some color frame buffers support the
78 78 .Dv FBIOPUTCMAP
79 79 and
80 80 .Dv FBIOGETCMAP
81 81 .Xr ioctl 2
82 82 requests, which provide access to the colormap.
83 83 They use the
84 84 .Vt fbcmap
85 85 structure.
86 86 .Pp
87 87 Also, some framebuffers with multiple colormaps will either encode the colormap
88 88 identifier in the high-order bits of the
89 89 .Dq index
90 90 field in the
91 91 .Vt fbcmap
92 92 structure, or use the
93 93 .Dv FBIOPUTCMAPI
94 94 and
95 95 .Dv FBIOGETCMAPI
96 96 .Xr ioctl 2
97 97 requests.
98 98 .Pp
99 99 .Dv FBIOVERTICAL
100 100 is used to wait for the start of the next vertical retrace
101 101 period.
102 102 .Pp
103 103 .Dv FBIOVRTOFFSET
104 104 Returns the offset to a read-only
105 105 .Dq Em vertical retrace page
106 106 for those framebuffers that support it.
107 107 This vertical retrace page may be mapped into user space with
108 108 .Xr mmap 2 .
109 109 The first word of the vertical
110 110 retrace page (type
111 111 .Vt "unsigned int" )
112 112 is a counter that is incremented every time there is a vertical retrace.
113 113 The user process can use this counter in a variety of ways.
114 114 .Pp
115 115 .Dv FBIOMONINFO
116 116 returns a
117 117 .Vt mon_info
118 118 structure which contains information about
119 119 the monitor attached to the framebuffer, if available.
120 120 .Pp
121 121 .Dv FBIOSCURSOR ,
122 122 .Dv FBIOGCURSOR ,
123 123 .Dv FBIOSCURPOS
124 124 and
125 125 .Dv FBIOGCURPOS
126 126 are used to control the hardware cursor for those framebuffers that have this
127 127 feature.
128 128 .Dv FBIOGCURMAX
129 129 returns the maximum sized cursor supported by the framebuffer.
↓ open down ↓ |
102 lines elided |
↑ open up ↑ |
130 130 Attempts to create a cursor larger than this will fail.
131 131 .Pp
132 132 Finally
133 133 .Dv FBIOSDEVINFO
134 134 and
135 135 .Dv FBIOGDEVINFO
136 136 are used to transfer
137 137 variable-length, device-specific information into and out of framebuffers.
138 138 .Sh SEE ALSO
139 139 .Xr ioctl 2 ,
140 -.Xr mmap 2 ,
141 -.Xr cgsix 7D
140 +.Xr mmap 2
142 141 .Sh BUGS
143 142 The
144 143 .Dv FBIOSATTR
145 144 and
146 145 .Dv FBIOGATTR
147 146 .Xr ioctl 2
148 147 requests are only
149 148 supported by frame buffers which emulate older frame buffer types.
150 149 If a frame buffer emulates another frame buffer,
151 150 .Dv FBIOGTYPE
152 151 returns the emulated type.
153 152 To get the real type, use
154 153 .Dv FBIOGATTR .
155 154 .Pp
156 155 The
157 156 .Dv FBIOGCURPOS
158 157 ioctl was incorrectly defined in previous operating
159 158 systems, and older code running in binary compatibility mode may get incorrect
160 159 results.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX