include/linux/rfkill.h

   1 #ifndef __RFKILL_H
   2 #define __RFKILL_H
   3
   4 /*
   5  * Copyright (C) 2006 - 2007 Ivo van Doorn
   6  * Copyright (C) 2007 Dmitry Torokhov
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the
  20  * Free Software Foundation, Inc.,
  21  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23
  24 #include <linux/types.h>
  25 #include <linux/kernel.h>
  26 #include <linux/list.h>
  27 #include <linux/mutex.h>
  28 #include <linux/device.h>
  29 #include <linux/leds.h>
  30
  31 /**
  32  * enum rfkill_type - type of rfkill switch.
  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  */
  39 enum rfkill_type {
  40         RFKILL_TYPE_WLAN ,
  41         RFKILL_TYPE_BLUETOOTH,
  42         RFKILL_TYPE_UWB,
  43         RFKILL_TYPE_WIMAX,
  44         RFKILL_TYPE_WWAN,
  45         RFKILL_TYPE_MAX,
  46 };
  47
  48 enum rfkill_state {
  49         RFKILL_STATE_SOFT_BLOCKED = 0,  /* Radio output blocked */
  50         RFKILL_STATE_UNBLOCKED    = 1,  /* Radio output allowed */
  51         RFKILL_STATE_HARD_BLOCKED = 2,  /* Output blocked, non-overrideable */
  52 };
  53
  54 /*
  55  * These are DEPRECATED, drivers using them should be verified to
  56  * comply with the rfkill usage guidelines in Documentation/rfkill.txt
  57  * and then converted to use the new names for rfkill_state
  58  */
  59 #define RFKILL_STATE_OFF RFKILL_STATE_SOFT_BLOCKED
  60 #define RFKILL_STATE_ON  RFKILL_STATE_UNBLOCKED
  61
  62 /**
  63  * struct rfkill - rfkill control structure.
  64  * @name: Name of the switch.
  65  * @type: Radio type which the button controls, the value stored
  66  *      here should be a value from enum rfkill_type.
  67  * @state: State of the switch, "UNBLOCKED" means radio can operate.
  68  * @user_claim_unsupported: Whether the hardware supports exclusive
  69  *      RF-kill control by userspace. Set this before registering.
  70  * @user_claim: Set when the switch is controlled exlusively by userspace.
  71  * @mutex: Guards switch state transitions.  It serializes callbacks
  72  *      and also protects the state.
  73  * @data: Pointer to the RF button drivers private data which will be
  74  *      passed along when toggling radio state.
  75  * @toggle_radio(): Mandatory handler to control state of the radio.
  76  *      only RFKILL_STATE_SOFT_BLOCKED and RFKILL_STATE_UNBLOCKED are
  77  *      valid parameters.
  78  * @get_state(): handler to read current radio state from hardware,
  79  *      may be called from atomic context, should return 0 on success.
  80  *      Either this handler OR judicious use of rfkill_force_state() is
  81  *      MANDATORY for any driver capable of RFKILL_STATE_HARD_BLOCKED.
  82  * @led_trigger: A LED trigger for this button's LED.
  83  * @dev: Device structure integrating the switch into device tree.
  84  * @node: Used to place switch into list of all switches known to the
  85  *      the system.
  86  *
  87  * This structure represents a RF switch located on a network device.
  88  */
  89 struct rfkill {
  90         const char *name;
  91         enum rfkill_type type;
  92
  93         bool user_claim_unsupported;
  94         bool user_claim;
  95
  96         /* the mutex serializes callbacks and also protects
  97          * the state */
  98         struct mutex mutex;
  99         enum rfkill_state state;
 100         void *data;
 101         int (*toggle_radio)(void *data, enum rfkill_state state);
 102         int (*get_state)(void *data, enum rfkill_state *state);
 103
 104 #ifdef CONFIG_RFKILL_LEDS
 105         struct led_trigger led_trigger;
 106 #endif
 107
 108         struct device dev;
 109         struct list_head node;
 110 };
 111 #define to_rfkill(d)    container_of(d, struct rfkill, dev)
 112
 113 struct rfkill * __must_check rfkill_allocate(struct device *parent,
 114                                              enum rfkill_type type);
 115 void rfkill_free(struct rfkill *rfkill);
 116 int __must_check rfkill_register(struct rfkill *rfkill);
 117 void rfkill_unregister(struct rfkill *rfkill);
 118
 119 int rfkill_force_state(struct rfkill *rfkill, enum rfkill_state state);
 120 int rfkill_set_default(enum rfkill_type type, enum rfkill_state state);
 121
 122 /**
 123  * rfkill_state_complement - return complementar state
 124  * @state: state to return the complement of
 125  *
 126  * Returns RFKILL_STATE_SOFT_BLOCKED if @state is RFKILL_STATE_UNBLOCKED,
 127  * returns RFKILL_STATE_UNBLOCKED otherwise.
 128  */
 129 static inline enum rfkill_state rfkill_state_complement(enum rfkill_state state)
 130 {
 131         return (state == RFKILL_STATE_UNBLOCKED) ?
 132                 RFKILL_STATE_SOFT_BLOCKED : RFKILL_STATE_UNBLOCKED;
 133 }
 134
 135 /**
 136  * rfkill_get_led_name - Get the LED trigger name for the button's LED.
 137  * This function might return a NULL pointer if registering of the
 138  * LED trigger failed.
 139  * Use this as "default_trigger" for the LED.
 140  */
 141 static inline char *rfkill_get_led_name(struct rfkill *rfkill)
 142 {
 143 #ifdef CONFIG_RFKILL_LEDS
 144         return (char *)(rfkill->led_trigger.name);
 145 #else
 146         return NULL;
 147 #endif
 148 }
 149
 150 /* rfkill notification chain */
 151 #define RFKILL_STATE_CHANGED            0x0001  /* state of a normal rfkill
 152                                                    switch has changed */
 153
 154 int register_rfkill_notifier(struct notifier_block *nb);
 155 int unregister_rfkill_notifier(struct notifier_block *nb);
 156
 157 #endif /* RFKILL_H */