[src/trunk]: src/share/man/man4 Document WSDISPLAYIO_SETVERSION, WSKBDIO_SETV...

[abs <abs%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/1bf04e314369
branches:  trunk
changeset: 779416:1bf04e314369
user:      abs <abs%NetBSD.org@localhost>
date:      Sun May 27 10:45:49 2012 +0000

description:
Document WSDISPLAYIO_SETVERSION, WSKBDIO_SETVERSION and WSMOUSEIO_SETVERSION
ioctls(). Also at least enumerate the WSKBDIO_ ioctls().

diffstat:

 share/man/man4/wsdisplay.4 |  14 +++++++++++++-
 share/man/man4/wskbd.4     |  37 ++++++++++++++++++++++++++++++++++++-
 share/man/man4/wsmouse.4   |  17 +++++++++++++++--
 3 files changed, 64 insertions(+), 4 deletions(-)

diffs (124 lines):

diff -r d9caef4f75ad -r 1bf04e314369 share/man/man4/wsdisplay.4
--- a/share/man/man4/wsdisplay.4        Sun May 27 02:35:43 2012 +0000
+++ b/share/man/man4/wsdisplay.4        Sun May 27 10:45:49 2012 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: wsdisplay.4,v 1.38 2011/06/30 22:13:02 wiz Exp $
+.\" $NetBSD: wsdisplay.4,v 1.39 2012/05/27 10:45:49 abs Exp $
 .\"
 .\" Copyright (c) 1999 Matthias Drochner.
 .\" Copyright (c) 2002 Ben Harris.
@@ -561,6 +561,18 @@
 Otherwise the EDID block will be written into the buffer pointed
 at by edid_data and data_size will be set to the number of bytes
 written.
+.It Dv WSDISPLAYIO_SETVERSION Pq Li "int"
+Set the wscons_event protocol version.
+The default is 0 for binary compatibility. The latest version is
+always available as WSDISPLAYIO_EVENT_VERSION, and is currently 1.
+All new code should use a call similar to the below to ensure the
+correct version is returned.
+.Bd -literal -offset indent
+int ver = WSDISPLAY_EVENT_VERSION;
+if (ioctl(fd, WSDISPLAYIO_SETVERSION, &ver) == -1)
+    err(EXIT_FAILURE, "cannot set version");
+.Ed
+.El
 .El
 .Sh FILES
 .Bl -item
diff -r d9caef4f75ad -r 1bf04e314369 share/man/man4/wskbd.4
--- a/share/man/man4/wskbd.4    Sun May 27 02:35:43 2012 +0000
+++ b/share/man/man4/wskbd.4    Sun May 27 10:45:49 2012 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: wskbd.4,v 1.14 2011/03/06 17:39:05 wiz Exp $
+.\" $NetBSD: wskbd.4,v 1.15 2012/05/27 10:45:49 abs Exp $
 .\"
 .\" Copyright (c) 1999
 .\"    Matthias Drochner.  All rights reserved.
@@ -114,6 +114,41 @@
 (The console device selection in early system startup is not influenced.)
 This way, the console device can be connected to a known
 wskbd device instance.
+.Ss Ioctls
+The following
+.Xr ioctl 2
+calls are provided by the
+.Nm
+driver or by devices which use it.
+Their definitions are found in
+.Pa dev/wscons/wsconsio.h .
+.Bl -tag -width Dv
+.It Dv WSKBDIO_GTYPE
+Get the keyboard type.
+.It Dv WSKBDIO_COMPLEXBELL, WSKBDIO_SETBELL, WSKBDIO_GETBELL, WSKBDIO_SETDEFAULTBELL, WSKBDIO_GETDEFAULTBELL Pq Li "struct wsmouse_repeat"
+Get and set keyboard bell settings.
+.It Dv WSKBDIO_SETKEYREPEAT, WSKBDIO_GETKEYREPEAT, WSKBDIO_SETDEFAULTKEYREPEAT, WSKBDIO_GETDEFAULTKEYREPEAT Pq Li "struct wskbd_keyrepeat_data"
+Get and set keyboard autorepeat settings.
+.It Dv WSKBDIO_SETLEDS, WSKBDIO_GETLEDS Pq Li "int"
+Get and set keyboard LED settings.
+.It Dv WSKBDIO_GETMAP, WSKBDIO_SETMAP Pq Li "struct wskbd_map_data"
+Get and set keyboard keymapping settings.
+.It Dv WSKBDIO_GETENCODING, WSKBDIO_SETENCODING Pq Li "kbd_t"
+Get and set keyboard encoding settings.
+.It Dv WSKBDIO_GETKEYCLICK, WSKBDIO_SETKEYCLICK Pq Li "int"
+Get and set keyboard keyclick settings.
+.It Dv WSKBDIO_SETVERSION Pq Li "int"
+Set the wscons_event protocol version.
+The default is 0 for binary compatibility. The latest version is
+always available as WSKBD_EVENT_VERSION, and is currently 1.
+All new code should use a call similar to the below to ensure the
+correct version is returned.
+.Bd -literal -offset indent
+int ver = WSKBD_EVENT_VERSION;
+if (ioctl(fd, WSKBDIO_SETVERSION, &ver) == -1)
+    err(EXIT_FAILURE, "cannot set version");
+.Ed
+.El
 .Sh FILES
 .Bl -item
 .It
diff -r d9caef4f75ad -r 1bf04e314369 share/man/man4/wsmouse.4
--- a/share/man/man4/wsmouse.4  Sun May 27 02:35:43 2012 +0000
+++ b/share/man/man4/wsmouse.4  Sun May 27 10:45:49 2012 +0000
@@ -1,4 +1,4 @@
-.\" $NetBSD: wsmouse.4,v 1.20 2012/01/17 08:23:40 wiz Exp $
+.\" $NetBSD: wsmouse.4,v 1.21 2012/05/27 10:45:49 abs Exp $
 .\"
 .\" Copyright (c) 1999
 .\"    Matthias Drochner.  All rights reserved.
@@ -27,7 +27,7 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd January 17, 2012
+.Dd May 24, 2012
 .Dt WSMOUSE 4
 .Os
 .Sh NAME
@@ -48,6 +48,8 @@
 (Apple ADB mouse)
 .Cd "wsmouse*  at btms? mux 0"
 (Bluetooth mouse)
+.Cd "wsmouse*   at lkms? mux 0"
+(DEC VSXXX serial mice)
 .Sh DESCRIPTION
 The
 .Nm
@@ -111,6 +113,17 @@
 See
 .Dv WSMOUSEIO_GETREPEAT
 above for more details.
+.It Dv WSMOUSEIO_SETVERSION Pq Li "int"
+Set the wscons_event protocol version.
+The default is 0 for binary compatibility. The latest version is
+always available as WSMOUSE_EVENT_VERSION, and is currently 1.
+All new code should use a call similar to the below to ensure the
+correct version is returned.
+.Bd -literal -offset indent
+int ver = WSMOUSE_EVENT_VERSION;
+if (ioctl(fd, WSMOUSEIO_SETVERSION, &ver) == -1)
+    err(EXIT_FAILURE, "cannot set version");
+.Ed
 .El
 .Sh FILES
 .Bl -item