[src/trunk]: src/share/man/man4 add ssdfb(4) manual page

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

details:   https://anonhg.NetBSD.org/src/rev/fab056638f29
branches:  trunk
changeset: 997625:fab056638f29
user:      tnn <tnn%NetBSD.org@localhost>
date:      Sun Mar 17 00:35:09 2019 +0000

description:
add ssdfb(4) manual page

diffstat:

 distrib/sets/lists/man/mi |    5 +-
 share/man/man4/Makefile   |    4 +-
 share/man/man4/ssdfb.4    |  115 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 121 insertions(+), 3 deletions(-)

diffs (170 lines):

diff -r 7f586b43eec3 -r fab056638f29 distrib/sets/lists/man/mi
--- a/distrib/sets/lists/man/mi Sun Mar 17 00:30:55 2019 +0000
+++ b/distrib/sets/lists/man/mi Sun Mar 17 00:35:09 2019 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: mi,v 1.1639 2019/02/26 07:31:49 rin Exp $
+# $NetBSD: mi,v 1.1640 2019/03/17 00:35:09 tnn Exp $
 #
 # Note: don't delete entries from here - mark them as "obsolete" instead.
 #
@@ -1758,6 +1758,7 @@
 ./usr/share/man/cat4/spp.0                     man-obsolete            obsolete
 ./usr/share/man/cat4/sqphy.0                   man-sys-catman          .cat
 ./usr/share/man/cat4/ss.0                      man-sys-catman          .cat
+./usr/share/man/cat4/ssdfb.0                   man-sys-catman          .cat
 ./usr/share/man/cat4/st.0                      man-sys-catman          .cat
 ./usr/share/man/cat4/stderr.0                  man-sys-catman          .cat
 ./usr/share/man/cat4/stdin.0                   man-sys-catman          .cat
@@ -4846,6 +4847,7 @@
 ./usr/share/man/html4/spkr.html                        man-sys-htmlman         html
 ./usr/share/man/html4/sqphy.html               man-sys-htmlman         html
 ./usr/share/man/html4/ss.html                  man-sys-htmlman         html
+./usr/share/man/html4/ssdfb.html               man-sys-htmlman         html
 ./usr/share/man/html4/st.html                  man-sys-htmlman         html
 ./usr/share/man/html4/stderr.html              man-sys-htmlman         html
 ./usr/share/man/html4/stdin.html               man-sys-htmlman         html
@@ -7848,6 +7850,7 @@
 ./usr/share/man/man4/spp.4                     man-obsolete            obsolete
 ./usr/share/man/man4/sqphy.4                   man-sys-man             .man
 ./usr/share/man/man4/ss.4                      man-sys-man             .man
+./usr/share/man/man4/ssdfb.4                   man-sys-man             .man
 ./usr/share/man/man4/st.4                      man-sys-man             .man
 ./usr/share/man/man4/stderr.4                  man-sys-man             .man
 ./usr/share/man/man4/stdin.4                   man-sys-man             .man
diff -r 7f586b43eec3 -r fab056638f29 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Sun Mar 17 00:30:55 2019 +0000
+++ b/share/man/man4/Makefile   Sun Mar 17 00:35:09 2019 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.678 2019/02/23 03:10:06 kamil Exp $
+#      $NetBSD: Makefile,v 1.679 2019/03/17 00:35:09 tnn Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   aac.4 ac97.4 acardide.4 aceride.4 acphy.4 \
@@ -58,7 +58,7 @@
        scsi.4 sctp.4 sd.4 se.4 seeprom.4 sem.4 \
        ses.4 sf.4 sfb.4 sgsmix.4 shb.4 shmif.4 shpcic.4 si70xxtemp.4 \
        siisata.4 siop.4 sip.4 siside.4 sk.4 sl.4 slide.4 \
-       sm.4 smsh.4 sn.4 sony.4 spc.4 speaker.4 spif.4 sqphy.4 ss.4 \
+       sm.4 smsh.4 sn.4 sony.4 spc.4 speaker.4 spif.4 sqphy.4 ss.4 ssdfb.4 \
        st.4 ste.4 stge.4 sti.4 stpcide.4 sv.4 strip.4 \
        svwsata.4 swsensor.4 swwdog.4 sysmon.4 \
        tap.4 tc.4 tcds.4 tcp.4 tcu.4 tdvfb.4 tea5767radio.4 termios.4 tfb.4 \
diff -r 7f586b43eec3 -r fab056638f29 share/man/man4/ssdfb.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/ssdfb.4    Sun Mar 17 00:35:09 2019 +0000
@@ -0,0 +1,115 @@
+.\"    $NetBSD: ssdfb.4,v 1.1 2019/03/17 00:35:09 tnn Exp $
+.\"
+.\" Copyright (c) 2019 The NetBSD Foundation, Inc.
+.\" All rights reserved.
+.\"
+.\" This code is derived from software contributed to The NetBSD Foundation
+.\" by Tobias Nygren.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
+.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
+.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+.\" POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd March 17, 2019
+.Dt SSDFB 4
+.Os
+.Sh NAME
+.Nm ssdfb
+.Nd OLED/PLED framebuffer device driver
+.Sh SYNOPSIS
+.Cd "options FONT_VT220L8x8"
+.Cd "ssdfb* at iic? addr ?"
+.Cd "ssdfb* at iic? addr 0x3c"
+.Cd "ssdfb* at iic? addr 0x3d flags 0x102"
+.Cd "wsdisplay* at ssdfb?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides
+.Xr wsdisplay 4
+support for OLED/PLED framebuffer modules based on one
+of the following controller chips:
+.Pp
+.Bl -bullet -offset indent
+.It
+Solomon Systech Ltd SSD1306
+.It
+Sino Wealth Electronic Ltd SH1106
+.El
+.Pp
+The following products (controller + panel assemblies) are supported:
+.Bl -bullet -offset indent
+.It
+.Em 0x01 :
+Generic SSD1306 modules using default settings
+.It
+.Em 0x02 :
+Generic SH1106 modules using default settings
+.It
+.Em 0x03 :
+Adafruit Industries, LLC product 938 (128x64)
+.It
+.Em 0x04 :
+Adafruit Industries, LLC product 931 (128x32)
+.El
+.Pp
+The flags value can contain one or more of the following, bitwise OR'ed:
+.Pp
+.Bl -bullet -offset indent
+.It
+.Em 0x0?? :
+Exactly one product id from the above list
+.It
+.Em 0x100 :
+indicates that the display is mounted upside down and flips the screen
+.It
+.Em 0x200 :
+enable inverse video
+.It
+.Em 0x400 :
+forcibly attach as console
+.El
+.Sh SEE ALSO
+.Xr iic 4 ,
+.Xr wsdisplay 4
+.Sh HISTORY
+An
+.Nm
+driver first appeared in
+.Ox 6.4
+and later in
+.Nx 9.0 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver
+was written by
+.An Tobias Nygren Aq Mt tnn%NetBSD.org@localhost .
+.Pp
+It was inspired by (and shares it's name with) the
+.Ox driver written by
+.An Patrick Wildt Aq Mt patrick%blueri.se@localhost
+but does not share any code.
+.Sh BUGS
+Some modules can be reconfigured to attach via
+.Xr spi 4 ,
+typically by moving surface mount zero ohm resistors.
+This is currently not supported.