1.\" $NetBSD: ssdfb.4,v 1.4 2019/11/02 14:47:35 tnn Exp $ 2.\" 3.\" Copyright (c) 2019 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Tobias Nygren. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd November 2, 2019 31.Dt SSDFB 4 32.Os 33.Sh NAME 34.Nm ssdfb 35.Nd OLED/PLED framebuffer device driver 36.Sh SYNOPSIS 37.Cd "options FONT_SPLEEN5x8" 38.Cd "ssdfb* at iic? addr ?" 39.Cd "ssdfb* at iic? addr 0x3c" 40.Cd "ssdfb* at iic? addr 0x3d flags 0x102" 41.Cd "ssdfb* at spi? slave ? flags 0x105" 42.Cd "wsdisplay* at ssdfb?" 43.Sh DESCRIPTION 44The 45.Nm 46driver provides 47.Xr wsdisplay 4 48support for OLED/PLED framebuffer modules based on one 49of the following controller chips: 50.Bl -bullet -offset indent 51.It 52Solomon Systech Ltd SSD1306 53.It 54Sino Wealth Electronic Ltd SH1106 55.It 56Solomon Systech Ltd SSD1322 57.El 58.Pp 59The following products (controller + panel assemblies) are supported: 60.Bl -bullet -offset indent 61.It 62.Em 0x01 : 63Generic SSD1306 modules using default settings 64.It 65.Em 0x02 : 66Generic SH1106 modules using default settings 67.It 68.Em 0x03 : 69Adafruit Industries, LLC product 938 (128x64) 70.It 71.Em 0x04 : 72Adafruit Industries, LLC product 931 (128x32) 73.It 74.Em 0x05 : 75Generic SSD1322 modules using default settings 76.El 77.Pp 78The flags value can contain one or more of the following, bitwise OR'ed: 79.Bl -bullet -offset indent 80.It 81.Em 0x0?? : 82Exactly one product id from the above list 83.It 84.Em 0x100 : 85indicates that the display is mounted upside down and flips the screen 86.It 87.Em 0x200 : 88enable inverse video 89.It 90.Em 0x400 : 91forcibly attach as console 92.El 93.Sh SEE ALSO 94.Xr iic 4 , 95.Xr wsdisplay 4 96.Sh HISTORY 97An 98.Nm 99driver first appeared in 100.Ox 6.4 101and later in 102.Nx 9.0 . 103.Sh AUTHORS 104.An -nosplit 105The 106.Nm 107driver 108was written by 109.An Tobias Nygren Aq Mt tnn@NetBSD.org . 110.Pp 111It was inspired by (and shares its name with) the 112.Ox 113driver written by 114.An Patrick Wildt Aq Mt patrick@blueri.se 115but does not share any code. 116.Sh BUGS 117The "4-wire SPI" MCU interface which requires an auxiliary 118.Xr gpio 4 119pin for the D/C# signal is currently not supported. 120