blob: 058757f7a7339b104f9f44ebd77569cf20f35ef6 [file] [log] [blame]
David Howells607ca462012-10-13 10:46:48 +01001/*
2 * Copyright (C) 2006 - 2007 Ivo van Doorn
3 * Copyright (C) 2007 Dmitry Torokhov
4 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18#ifndef _UAPI__RFKILL_H
19#define _UAPI__RFKILL_H
20
21
22#include <linux/types.h>
23
24/* define userspace visible states */
25#define RFKILL_STATE_SOFT_BLOCKED 0
26#define RFKILL_STATE_UNBLOCKED 1
27#define RFKILL_STATE_HARD_BLOCKED 2
28
29/**
30 * enum rfkill_type - type of rfkill switch.
31 *
32 * @RFKILL_TYPE_ALL: toggles all switches (requests only - not a switch type)
33 * @RFKILL_TYPE_WLAN: switch is on a 802.11 wireless network device.
34 * @RFKILL_TYPE_BLUETOOTH: switch is on a bluetooth device.
35 * @RFKILL_TYPE_UWB: switch is on a ultra wideband device.
36 * @RFKILL_TYPE_WIMAX: switch is on a WiMAX device.
37 * @RFKILL_TYPE_WWAN: switch is on a wireless WAN device.
38 * @RFKILL_TYPE_GPS: switch is on a GPS device.
39 * @RFKILL_TYPE_FM: switch is on a FM radio device.
Samuel Ortiz44b3dec2013-04-11 11:51:36 +020040 * @RFKILL_TYPE_NFC: switch is on an NFC device.
David Howells607ca462012-10-13 10:46:48 +010041 * @NUM_RFKILL_TYPES: number of defined rfkill types
42 */
43enum rfkill_type {
44 RFKILL_TYPE_ALL = 0,
45 RFKILL_TYPE_WLAN,
46 RFKILL_TYPE_BLUETOOTH,
47 RFKILL_TYPE_UWB,
48 RFKILL_TYPE_WIMAX,
49 RFKILL_TYPE_WWAN,
50 RFKILL_TYPE_GPS,
51 RFKILL_TYPE_FM,
Samuel Ortiz44b3dec2013-04-11 11:51:36 +020052 RFKILL_TYPE_NFC,
David Howells607ca462012-10-13 10:46:48 +010053 NUM_RFKILL_TYPES,
54};
55
56/**
57 * enum rfkill_operation - operation types
58 * @RFKILL_OP_ADD: a device was added
59 * @RFKILL_OP_DEL: a device was removed
60 * @RFKILL_OP_CHANGE: a device's state changed -- userspace changes one device
61 * @RFKILL_OP_CHANGE_ALL: userspace changes all devices (of a type, or all)
62 */
63enum rfkill_operation {
64 RFKILL_OP_ADD = 0,
65 RFKILL_OP_DEL,
66 RFKILL_OP_CHANGE,
67 RFKILL_OP_CHANGE_ALL,
68};
69
70/**
71 * struct rfkill_event - events for userspace on /dev/rfkill
72 * @idx: index of dev rfkill
73 * @type: type of the rfkill struct
74 * @op: operation code
75 * @hard: hard state (0/1)
76 * @soft: soft state (0/1)
77 *
78 * Structure used for userspace communication on /dev/rfkill,
79 * used for events from the kernel and control to the kernel.
80 */
81struct rfkill_event {
82 __u32 idx;
83 __u8 type;
84 __u8 op;
85 __u8 soft, hard;
86} __attribute__((packed));
87
88/*
89 * We are planning to be backward and forward compatible with changes
90 * to the event struct, by adding new, optional, members at the end.
91 * When reading an event (whether the kernel from userspace or vice
92 * versa) we need to accept anything that's at least as large as the
93 * version 1 event size, but might be able to accept other sizes in
94 * the future.
95 *
96 * One exception is the kernel -- we already have two event sizes in
97 * that we've made the 'hard' member optional since our only option
98 * is to ignore it anyway.
99 */
100#define RFKILL_EVENT_SIZE_V1 8
101
102/* ioctl for turning off rfkill-input (if present) */
103#define RFKILL_IOC_MAGIC 'R'
104#define RFKILL_IOC_NOINPUT 1
105#define RFKILL_IOCTL_NOINPUT _IO(RFKILL_IOC_MAGIC, RFKILL_IOC_NOINPUT)
106
107/* and that's all userspace gets */
108
109#endif /* _UAPI__RFKILL_H */