1.\"- 2.\" Copyright (c) 2012 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" This software was developed by SRI International and the University of 6.\" Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237) 7.\" ("CTSRD"), as part of the DARPA CRASH research programme. 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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd August 18, 2012 31.Dt TERASIC_MTL 4 32.Os 33.Sh NAME 34.Nm terasic_mtl 35.Nd driver for the Terasic/Cambridge Multi-Touch LCD device 36.Sh SYNOPSIS 37.Cd "device terasic_mtl" 38.Pp 39In 40.Pa /boot/device.hints : 41.Cd hint.terasic_mtl.0.at="nexus0" 42.Cd hint.terasic_mtl.0.reg_maddr=0x70400000 43.Cd hint.terasic_mtl.0.reg_msize=0x1000 44.Cd hint.terasic_mtl.0.pixel_maddr=0x70000000 45.Cd hint.terasic_mtl.0.pixel_msize=0x177000 46.Cd hint.terasic_mtl.0.text_maddr=0x70177000 47.Cd hint.terasic_mtl.0.text_msize=0x2000 48.Sh DESCRIPTION 49The 50.Nm 51device driver provides support for the Terasic Multi-Touch LCD combined as 52controlled by a University of Cambridge's IP Core. 53Three device nodes are instantiated, representing various services supported 54by the device: 55.Bl -tag -width terasic_pixelX 56.It terasic_regX 57Memory-mapped register interface, including touch screen input. 58.It terasic_pixelX 59Memory-mapped pixel-oriented frame buffer. 60.It terasic_textX 61Memory-mapped text-oriented frame buffer. 62.El 63.Pp 64.Nm 65devices are also attached to the 66.Xr syscons 4 67framework, which implements a VT-compatible terminal connected to the 68.Xr tty 4 69framework. 70.Li ttyvX 71device nodes may be added to 72.Xr ttys 5 73in order to launch 74.Xr login 1 75sessions at boot. 76.Pp 77Register, text, and pixel devices may be accessed using 78.Xr read 2 79and 80.Xr write 2 81system calls, and also memory mapped using 82.Xr mmap 2 . 83.Sh SEE ALSO 84.Xr login 1 , 85.Xr ioctl 2 , 86.Xr mmap 2 , 87.Xr poll 2 , 88.Xr read 2 , 89.Xr write 2 , 90.Xr syscons 4 , 91.Xr tty 4 , 92.Xr ttys 5 93.Sh HISTORY 94The 95.Nm 96device driver first appeared in 97.Fx 10.0 . 98.Sh AUTHORS 99The 100.Nm 101device driver and this manual page were 102developed by SRI International and the University of Cambridge Computer 103Laboratory under DARPA/AFRL contract 104.Pq FA8750-10-C-0237 105.Pq Do CTSRD Dc , 106as part of the DARPA CRASH research programme. 107This device driver was written by 108.An Robert N. M. Watson . 109.Sh BUGS 110The 111.Xr syscons 4 112attachment does not support the hardware cursor feature. 113.Pp 114A more structured interface to control registers using the 115.Xr ioctl 2 116system call, would sometimes be preferable to memory mapping. 117For touch screen input, it would be highly desirable to offer a streaming 118interface whose events can be managed using 119.Xr poll 2 120and related system calls, with the kernel performing polling rather than the 121userspace application. 122.Pp 123.Nm 124supports only a 125.Li nexus 126bus attachment, which is appropriate for system-on-chip busses such as 127Altera's Avalon bus. 128If the IP core is configured off of another bus type, then additional bus 129attachments will be required. 130