1.\" $NetBSD: btmagic.4,v 1.2 2010/10/11 15:15:57 plunky Exp $ 2.\" 3.\" Copyright (c) 2010 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Iain Hibbert. 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 October 11, 2010 31.Dt BTMAGIC 4 32.Os 33.Sh NAME 34.Nm btmagic 35.Nd Apple Magic Mouse 36.Sh SYNOPSIS 37.Cd "btmagic* at bthub?" 38.Cd "wsmouse* at btmagic?" 39.Sh DESCRIPTION 40The 41.Nm 42driver provides support for the 43.Tn Bluetooth 44.Dq Magic Mouse 45from 46.Tn Apple, Inc . 47As remote devices cannot be discovered by autoconfig, configuring 48a mouse is normally carried out with the 49.Xr btdevctl 8 50program. 51.Pp 52The Magic Mouse uses the standard 53.Tn USB 54Human Interface Device protocol to communicate, but does not provide a 55proper HID Descriptor, and requires specific initializations to enable 56the proprietary touch reports. 57.Pp 58The Magic Mouse provides basic mouse functionality with two buttons, 59and the 60.Nm 61driver additionally interprets the touch reports to emulate a middle 62mouse button when more than one firm touch is detected during a click 63event, plus horizontal and vertical scrolling for touch movements 64greater than a certain distance. 65The mouse has a base resolution of 1300dpi, which the driver scales 66by default to a less sensitive 650dpi, but this is adjustable with 67.Xr sysctl 8 68along with the pressure needed to discern a firm touch, the minimum 69distance necessary to trigger scrolling and the additional downscale 70factor applied to scroll movements. 71.Pp 72.Nm 73interfaces to the system as usual through the 74.Xr wsmouse 4 75driver, and the following properties are used during autoconfiguration: 76.Bl -tag -width ".It remote-bdaddr" 77.It vendor-id 78Must be 0x05ac. 79.It product-id 80Must be 0x030d. 81.It local-bdaddr 82Local device address. 83.It remote-bdaddr 84Remote device address. 85.It link-mode 86This optional string represents the link mode of the baseband link, and 87may be one of 88.Sq auth , 89.Sq encrypt , 90or 91.Sq secure . 92.El 93.Pp 94When the 95.Nm 96driver has configured, it will attempt to open a connection to the mouse 97and, if this fails or the connection is lost, will wait for the 98mouse to initiate connections. 99The Magic Mouse requires connections to be authenticated, and 100should accept a PIN of 101.Sq 0000 102during the pairing process. 103.Sh SEE ALSO 104.Xr bluetooth 4 , 105.Xr bthub 4 , 106.Xr wsmouse 4 , 107.Xr btdevctl 8 , 108.Xr sysctl 8 109.Sh HISTORY 110The 111.Nm 112driver was written by 113.An Iain Hibbert 114with reference to the 115.Tn Linux 116driver written by 117.An Michael Poole . 118