aboutsummaryrefslogtreecommitdiff
path: root/src/apple.c
blob: 8e00a84524c08115bb71c67a3f80c04481f64d94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
/*
 * Copyright © 2011 Red Hat, Inc.
 *
 * Permission to use, copy, modify, distribute, and sell this software
 * and its documentation for any purpose is hereby granted without
 * fee, provided that the above copyright notice appear in all copies
 * and that both that copyright notice and this permission notice
 * appear in supporting documentation, and that the name of Red Hat
 * not be used in advertising or publicity pertaining to distribution
 * of the software without specific, written prior permission.  Red
 * Hat makes no representations about the suitability of this software
 * for any purpose.  It is provided "as is" without express or implied
 * warranty.
 *
 * THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
 * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * Authors:
 * Peter Hutterer (peter.hutterer@redhat.com)
 */
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
 
#include <evdev.h>
#include <evdev-properties.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
 
#include <exevents.h>
#include <xf86.h>
#include <xf86Xinput.h>
#include <X11/Xatom.h>
 
/* Apple-specific controls.
 *
 * On Apple keyboards, the multimedia function keys are overlaid with the F
 * keys. F1 is also BrightnessDown, F10 is Mute, etc. The kernel provides a
 * tweak to enable/disable this.
 *
 * /sys/module/hid_apple/parameters/fnmode
 *     0 .. keyboard sends Fx keys, fn is disabled
 *     1 .. keyboard sends multimedia keys, fn sends Fx keys
 *     2 .. keyboard sends Fx keys, fn sends multimedia keys
 *
 * We only handle 1 and 2, don't care about 0. If fnmode is found to be on
 * 0, we force it to 2 instead.
 */
 
/* In this file: fkeymode refers to the evdev-specific enums and parameters,
 * fnmode refers to the fnmode parameter exposed by the kernel. fnmode is
 * apple-specific */
#define FNMODE_PATH "/sys/module/hid_apple/parameters/fnmode"
 
/* Taken from the kernel */
#define USB_VENDOR_ID_APPLE                             0x05ac
#define USB_DEVICE_ID_APPLE_ALU_MINI_ANSI               0x021d
#define USB_DEVICE_ID_APPLE_ALU_MINI_ISO                0x021e
#define USB_DEVICE_ID_APPLE_ALU_MINI_JIS                0x021f
#define USB_DEVICE_ID_APPLE_ALU_ANSI                    0x0220
#define USB_DEVICE_ID_APPLE_ALU_ISO                     0x0221
#define USB_DEVICE_ID_APPLE_ALU_JIS                     0x0222
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI           0x022c
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO            0x022d
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS            0x022e
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI      0x0239
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO       0x023a
#define USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS       0x023b
 
static int EvdevAppleGetProperty (DeviceIntPtr dev, Atom property);
static int EvdevAppleSetProperty(DeviceIntPtr dev, Atom atom,
                      XIPropertyValuePtr val, BOOL checkonly);
 
static Atom prop_fkeymode;
static Bool fnmode_readonly; /* set if we can only read fnmode */
 
struct product_table
{
    unsigned int vendor;
    unsigned int product;
} apple_keyboard_table[] = {
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ANSI},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_ISO},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_MINI_JIS},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ANSI},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_ISO},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_JIS},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_ISO},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_JIS},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO},
    { USB_VENDOR_ID_APPLE, USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_JIS},
    { 00}
};
 
/**
 * @return TRUE if the device matches a product in the given product table,
 *         FALSE otherwise
 */
static Bool product_check(const struct product_table *t, int vendor, int product)
{
    while (t->vendor)
    {
        if (vendor == t->vendor && product == t->product)
            return TRUE;
        t++;
    }
 
    return FALSE;
}
 
/**
 * @return 0 on success, -1 otherwise (check errno)
 */
static int
set_fnmode(enum fkeymode fkeymode)
{
    int fd;
    char mode;
    int bytes_written;
 
    if (fkeymode == FKEYMODE_UNKNOWN)
    {
        errno = EINVAL; /* silly you */
        return -1;
    }
 
    fd = open(FNMODE_PATH, O_WRONLY);
    if (fd < 0)
        return -1;
 
    mode = (fkeymode == FKEYMODE_FKEYS) ? '2' : '1';
 
    bytes_written = write(fd, &mode, 1);
    close(fd);
 
    return (bytes_written == 1) ? 0 : -1;
}
 
/**
 * Get the current value of fnmode. If fnmode is found to be on 0, we set it
 * to 2 in the process. Yes, quite daring, I know. I live on the edge.
 *
 * @return The current setting of fnmode or FKEYMODE_UNKNOWN on error (check
 * errno)
 */
static enum fkeymode
get_fnmode(void)
{
    int fd;
    char retvalue;
 
    fd = open(FNMODE_PATH, O_RDWR);
    if (fd < 0 && errno == EACCES)
    {
        fnmode_readonly = TRUE;
        fd = open(FNMODE_PATH, O_RDONLY);
    }
 
    if (fd < 0)
        goto err;
 
    if (read(fd, &retvalue, 1) != 1)
        goto err;
 
    if (retvalue != '0' && retvalue != '1' && retvalue != '2')
    {
        xf86Msg(X_ERROR, "Invalid fnmode value: %c\n", retvalue);
        errno = EINVAL;
        goto err;
    }
 
    close(fd);
 
    /* we don't want 0, switch to 2 */
    if (retvalue == '0')
    {
        if (fnmode_readonly)
            xf86Msg(X_WARNING, "fnmode is disabled and read-only. Fn key will"
                    "not toggle to multimedia keys.\n");
        else
            set_fnmode(FKEYMODE_FKEYS);
    }
 
 
    return retvalue == '1' ? FKEYMODE_MMKEYS : FKEYMODE_FKEYS;
 
err:
    if (fd >= 0)
        close(fd);
    return FKEYMODE_UNKNOWN;
}
 
/**
 * Set the property value to fkeymode. If the property doesn't exist,
 * initialize it.
 */
static void set_fkeymode_property(InputInfoPtr pInfo, enum fkeymode fkeymode)
{
    DeviceIntPtr dev = pInfo->dev;
    BOOL init = FALSE;
    char data;
 
    switch(fkeymode)
    {
        case FKEYMODE_FKEYS: data = 0break;
        case FKEYMODE_MMKEYS: data = 1break;
        case FKEYMODE_UNKNOWN:
            xf86IDrvMsg(pInfo, X_ERROR, "Failed to get fnmode (%s)\n", strerror(errno));
            return;
    }
 
    if (!prop_fkeymode) {
        init = TRUE;
        prop_fkeymode = MakeAtom(EVDEV_PROP_FUNCTION_KEYS, strlen(EVDEV_PROP_FUNCTION_KEYS), TRUE);
    }
 
    /* Don't send an event if we're initializing the property */
    XIChangeDeviceProperty(dev, prop_fkeymode, XA_INTEGER, 8,
                           PropModeReplace, 1, &data, !init);
 
    if (init)
    {
        XISetDevicePropertyDeletable(dev, prop_fkeymode, FALSE);
        XIRegisterPropertyHandler(dev, EvdevAppleSetProperty, EvdevAppleGetProperty, NULL);
    }
}
 
 
/**
 * Called when a client reads the property state.
 * Update with current kernel state, it may have changed behind our back.
 */
static int
EvdevAppleGetProperty (DeviceIntPtr dev, Atom property)
{
    if (property == prop_fkeymode)
    {
        InputInfoPtr pInfo  = dev->public.devicePrivate;
        EvdevPtr     pEvdev = pInfo->private;
        enum fkeymode fkeymode;
 
        fkeymode = get_fnmode();
        if (fkeymode != pEvdev->fkeymode) {
            /* set internal copy first, so we don't write to the file in
             * SetProperty handler */
            pEvdev->fkeymode = fkeymode;
            set_fkeymode_property(pInfo, fkeymode);
        }
    }
    return Success;
}
 
static int
EvdevAppleSetProperty(DeviceIntPtr dev, Atom atom,
                      XIPropertyValuePtr val, BOOL checkonly)
{
    InputInfoPtr pInfo  = dev->public.devicePrivate;
    EvdevPtr pEvdev = pInfo->private;
 
    if (atom == prop_fkeymode)
    {
        CARD8 v = *(CARD8*)val->data;
 
        if (val->format != 8 || val->type != XA_INTEGER)
            return BadMatch;
 
        if (fnmode_readonly)
            return BadAccess;
 
        if (v > 1)
            return BadValue;
 
        if (!checkonly)
        {
            if ((!v && pEvdev->fkeymode != FKEYMODE_FKEYS) ||
                (v && pEvdev->fkeymode != FKEYMODE_MMKEYS))
            {
                pEvdev->fkeymode = v ? FKEYMODE_MMKEYS : FKEYMODE_FKEYS;
                set_fnmode(pEvdev->fkeymode);
            }
        }
    }
 
    return Success;
}
 
void
EvdevAppleInitProperty(DeviceIntPtr dev)
{
    InputInfoPtr pInfo  = dev->public.devicePrivate;
    EvdevPtr     pEvdev = pInfo->private;
    enum fkeymode fkeymode;
 
    if (!product_check(apple_keyboard_table,
                       pEvdev->id_vendor, pEvdev->id_product))
        return;
 
    fkeymode = get_fnmode();
    pEvdev->fkeymode = fkeymode;
    set_fkeymode_property(pInfo, fkeymode);
}