[net-next-2.6.git] / include / linux / rfkill.h

#ifndef __RFKILL_H
#define __RFKILL_H

/*
 * Copyright (C) 2006 - 2007 Ivo van Doorn
 * Copyright (C) 2007 Dmitry Torokhov
 * Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, 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.
 */

#include <linux/types.h>

/* define userspace visible states */
#define RFKILL_STATE_SOFT_BLOCKED	0
#define RFKILL_STATE_UNBLOCKED		1
#define RFKILL_STATE_HARD_BLOCKED	2

/**
 * enum rfkill_type - type of rfkill switch.
 *
 * @RFKILL_TYPE_ALL: toggles all switches (userspace only)
 * @RFKILL_TYPE_WLAN: switch is on a 802.11 wireless network device.
 * @RFKILL_TYPE_BLUETOOTH: switch is on a bluetooth device.
 * @RFKILL_TYPE_UWB: switch is on a ultra wideband device.
 * @RFKILL_TYPE_WIMAX: switch is on a WiMAX device.
 * @RFKILL_TYPE_WWAN: switch is on a wireless WAN device.
 * @RFKILL_TYPE_GPS: switch is on a GPS device.
 * @NUM_RFKILL_TYPES: number of defined rfkill types
 */
enum rfkill_type {
	RFKILL_TYPE_ALL = 0,
	RFKILL_TYPE_WLAN,
	RFKILL_TYPE_BLUETOOTH,
	RFKILL_TYPE_UWB,
	RFKILL_TYPE_WIMAX,
	RFKILL_TYPE_WWAN,
	RFKILL_TYPE_GPS,
	NUM_RFKILL_TYPES,
};

/**
 * enum rfkill_operation - operation types
 * @RFKILL_OP_ADD: a device was added
 * @RFKILL_OP_DEL: a device was removed
 * @RFKILL_OP_CHANGE: a device's state changed -- userspace changes one device
 * @RFKILL_OP_CHANGE_ALL: userspace changes all devices (of a type, or all)
 */
enum rfkill_operation {
	RFKILL_OP_ADD = 0,
	RFKILL_OP_DEL,
	RFKILL_OP_CHANGE,
	RFKILL_OP_CHANGE_ALL,
};

/**
 * struct rfkill_event - events for userspace on /dev/rfkill
 * @idx: index of dev rfkill
 * @type: type of the rfkill struct
 * @op: operation code
 * @hard: hard state (0/1)
 * @soft: soft state (0/1)
 *
 * Structure used for userspace communication on /dev/rfkill,
 * used for events from the kernel and control to the kernel.
 */
struct rfkill_event {
	__u32 idx;
	__u8  type;
	__u8  op;
	__u8  soft, hard;
} __packed;

/*
 * We are planning to be backward and forward compatible with changes
 * to the event struct, by adding new, optional, members at the end.
 * When reading an event (whether the kernel from userspace or vice
 * versa) we need to accept anything that's at least as large as the
 * version 1 event size, but might be able to accept other sizes in
 * the future.
 *
 * One exception is the kernel -- we already have two event sizes in
 * that we've made the 'hard' member optional since our only option
 * is to ignore it anyway.
 */
#define RFKILL_EVENT_SIZE_V1	8

/* ioctl for turning off rfkill-input (if present) */
#define RFKILL_IOC_MAGIC	'R'
#define RFKILL_IOC_NOINPUT	1
#define RFKILL_IOCTL_NOINPUT	_IO(RFKILL_IOC_MAGIC, RFKILL_IOC_NOINPUT)

/* and that's all userspace gets */
#ifdef __KERNEL__
/* don't allow anyone to use these in the kernel */
enum rfkill_user_states {
	RFKILL_USER_STATE_SOFT_BLOCKED	= RFKILL_STATE_SOFT_BLOCKED,
	RFKILL_USER_STATE_UNBLOCKED	= RFKILL_STATE_UNBLOCKED,
	RFKILL_USER_STATE_HARD_BLOCKED	= RFKILL_STATE_HARD_BLOCKED,
};
#undef RFKILL_STATE_SOFT_BLOCKED
#undef RFKILL_STATE_UNBLOCKED
#undef RFKILL_STATE_HARD_BLOCKED

#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/device.h>
#include <linux/leds.h>
#include <linux/err.h>

/* this is opaque */
struct rfkill;

/**
 * struct rfkill_ops - rfkill driver methods
 *
 * @poll: poll the rfkill block state(s) -- only assign this method
 *	when you need polling. When called, simply call one of the
 *	rfkill_set{,_hw,_sw}_state family of functions. If the hw
 *	is getting unblocked you need to take into account the return
 *	value of those functions to make sure the software block is
 *	properly used.
 * @query: query the rfkill block state(s) and call exactly one of the
 *	rfkill_set{,_hw,_sw}_state family of functions. Assign this
 *	method if input events can cause hardware state changes to make
 *	the rfkill core query your driver before setting a requested
 *	block.
 * @set_block: turn the transmitter on (blocked == false) or off
 *	(blocked == true) -- ignore and return 0 when hard blocked.
 *	This callback must be assigned.
 */
struct rfkill_ops {
	void	(*poll)(struct rfkill *rfkill, void *data);
	void	(*query)(struct rfkill *rfkill, void *data);
	int	(*set_block)(void *data, bool blocked);
};

#if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE)
/**
 * rfkill_alloc - allocate rfkill structure
 * @name: name of the struct -- the string is not copied internally
 * @parent: device that has rf switch on it
 * @type: type of the switch (RFKILL_TYPE_*)
 * @ops: rfkill methods
 * @ops_data: data passed to each method
 *
 * This function should be called by the transmitter driver to allocate an
 * rfkill structure. Returns %NULL on failure.
 */
struct rfkill * __must_check rfkill_alloc(const char *name,
					  struct device *parent,
					  const enum rfkill_type type,
					  const struct rfkill_ops *ops,
					  void *ops_data);

/**
 * rfkill_register - Register a rfkill structure.
 * @rfkill: rfkill structure to be registered
 *
 * This function should be called by the transmitter driver to register
 * the rfkill structure. Before calling this function the driver needs
 * to be ready to service method calls from rfkill.
 *
 * If rfkill_init_sw_state() is not called before registration,
 * set_block() will be called to initialize the software blocked state
 * to a default value.
 *
 * If the hardware blocked state is not set before registration,
 * it is assumed to be unblocked.
 */
int __must_check rfkill_register(struct rfkill *rfkill);

/**
 * rfkill_pause_polling(struct rfkill *rfkill)
 *
 * Pause polling -- say transmitter is off for other reasons.
 * NOTE: not necessary for suspend/resume -- in that case the
 * core stops polling anyway
 */
void rfkill_pause_polling(struct rfkill *rfkill);

/**
 * rfkill_resume_polling(struct rfkill *rfkill)
 *
 * Pause polling -- say transmitter is off for other reasons.
 * NOTE: not necessary for suspend/resume -- in that case the
 * core stops polling anyway
 */
void rfkill_resume_polling(struct rfkill *rfkill);


/**
 * rfkill_unregister - Unregister a rfkill structure.
 * @rfkill: rfkill structure to be unregistered
 *
 * This function should be called by the network driver during device
 * teardown to destroy rfkill structure. Until it returns, the driver
 * needs to be able to service method calls.
 */
void rfkill_unregister(struct rfkill *rfkill);

/**
 * rfkill_destroy - free rfkill structure
 * @rfkill: rfkill structure to be destroyed
 *
 * Destroys the rfkill structure.
 */
void rfkill_destroy(struct rfkill *rfkill);

/**
 * rfkill_set_hw_state - Set the internal rfkill hardware block state
 * @rfkill: pointer to the rfkill class to modify.
 * @state: the current hardware block state to set
 *
 * rfkill drivers that get events when the hard-blocked state changes
 * use this function to notify the rfkill core (and through that also
 * userspace) of the current state.  They should also use this after
 * resume if the state could have changed.
 *
 * You need not (but may) call this function if poll_state is assigned.
 *
 * This function can be called in any context, even from within rfkill
 * callbacks.
 *
 * The function returns the combined block state (true if transmitter
 * should be blocked) so that drivers need not keep track of the soft
 * block state -- which they might not be able to.
 */
bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);

/**
 * rfkill_set_sw_state - Set the internal rfkill software block state
 * @rfkill: pointer to the rfkill class to modify.
 * @state: the current software block state to set
 *
 * rfkill drivers that get events when the soft-blocked state changes
 * (yes, some platforms directly act on input but allow changing again)
 * use this function to notify the rfkill core (and through that also
 * userspace) of the current state.
 *
 * Drivers should also call this function after resume if the state has
 * been changed by the user.  This only makes sense for "persistent"
 * devices (see rfkill_init_sw_state()).
 *
 * This function can be called in any context, even from within rfkill
 * callbacks.
 *
 * The function returns the combined block state (true if transmitter
 * should be blocked).
 */
bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);

/**
 * rfkill_init_sw_state - Initialize persistent software block state
 * @rfkill: pointer to the rfkill class to modify.
 * @state: the current software block state to set
 *
 * rfkill drivers that preserve their software block state over power off
 * use this function to notify the rfkill core (and through that also
 * userspace) of their initial state.  It should only be used before
 * registration.
 *
 * In addition, it marks the device as "persistent", an attribute which
 * can be read by userspace.  Persistent devices are expected to preserve
 * their own state when suspended.
 */
void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);

/**
 * rfkill_set_states - Set the internal rfkill block states
 * @rfkill: pointer to the rfkill class to modify.
 * @sw: the current software block state to set
 * @hw: the current hardware block state to set
 *
 * This function can be called in any context, even from within rfkill
 * callbacks.
 */
void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);

/**
 * rfkill_blocked - query rfkill block
 *
 * @rfkill: rfkill struct to query
 */
bool rfkill_blocked(struct rfkill *rfkill);
#else /* !RFKILL */
static inline struct rfkill * __must_check
rfkill_alloc(const char *name,
	     struct device *parent,
	     const enum rfkill_type type,
	     const struct rfkill_ops *ops,
	     void *ops_data)
{
	return ERR_PTR(-ENODEV);
}

static inline int __must_check rfkill_register(struct rfkill *rfkill)
{
	if (rfkill == ERR_PTR(-ENODEV))
		return 0;
	return -EINVAL;
}

static inline void rfkill_pause_polling(struct rfkill *rfkill)
{
}

static inline void rfkill_resume_polling(struct rfkill *rfkill)
{
}

static inline void rfkill_unregister(struct rfkill *rfkill)
{
}

static inline void rfkill_destroy(struct rfkill *rfkill)
{
}

static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
{
	return blocked;
}

static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked)
{
	return blocked;
}

static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked)
{
}

static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw)
{
}

static inline bool rfkill_blocked(struct rfkill *rfkill)
{
	return false;
}
#endif /* RFKILL || RFKILL_MODULE */


#ifdef CONFIG_RFKILL_LEDS
/**
 * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
 * This function might return a NULL pointer if registering of the
 * LED trigger failed. Use this as "default_trigger" for the LED.
 */
const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);

/**
 * rfkill_set_led_trigger_name -- set the LED trigger name
 * @rfkill: rfkill struct
 * @name: LED trigger name
 *
 * This function sets the LED trigger name of the radio LED
 * trigger that rfkill creates. It is optional, but if called
 * must be called before rfkill_register() to be effective.
 */
void rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name);
#else
static inline const char *rfkill_get_led_trigger_name(struct rfkill *rfkill)
{
	return NULL;
}

static inline void
rfkill_set_led_trigger_name(struct rfkill *rfkill, const char *name)
{
}
#endif

#endif /* __KERNEL__ */

#endif /* RFKILL_H */
Commit	Line	Data
cf4328cd ID	1	#ifndef __RFKILL_H
	2	#define __RFKILL_H
	3
	4	/*
fe242cfd	5	* Copyright (C) 2006 - 2007 Ivo van Doorn
cf4328cd	6	* Copyright (C) 2007 Dmitry Torokhov
19d337df	7	* Copyright 2009 Johannes Berg <johannes@sipsolutions.net>
cf4328cd	8	*
8bc11b49 JB	9	* Permission to use, copy, modify, and/or distribute this software for any
	10	* purpose with or without fee is hereby granted, provided that the above
	11	* copyright notice and this permission notice appear in all copies.
cf4328cd	12	*
8bc11b49 JB	13	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	14	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	15	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
	16	* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	17	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
	18	* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
	19	* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
cf4328cd ID	20	*/
cf4328cd ID	21
c64fb016	22	#include <linux/types.h>
19d337df JB	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
cf4328cd ID	29	/**
cf4328cd ID	30	* enum rfkill_type - type of rfkill switch.
19d337df	31	*
c64fb016	32	* @RFKILL_TYPE_ALL: toggles all switches (userspace only)
19d337df JB	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.
0878c350	38	* @RFKILL_TYPE_GPS: switch is on a GPS device.
19d337df	39	* @NUM_RFKILL_TYPES: number of defined rfkill types
cf4328cd ID	40	*/
cf4328cd ID	41	enum rfkill_type {
c64fb016	42	RFKILL_TYPE_ALL = 0,
19d337df	43	RFKILL_TYPE_WLAN,
234a0ca6	44	RFKILL_TYPE_BLUETOOTH,
e0665486	45	RFKILL_TYPE_UWB,
303d9bf6	46	RFKILL_TYPE_WIMAX,
477576a0	47	RFKILL_TYPE_WWAN,
3ad20149	48	RFKILL_TYPE_GPS,
19d337df	49	NUM_RFKILL_TYPES,
cf4328cd ID	50	};
cf4328cd ID	51
c64fb016 JB	52	/**
	53	* enum rfkill_operation - operation types
	54	* @RFKILL_OP_ADD: a device was added
	55	* @RFKILL_OP_DEL: a device was removed
	56	* @RFKILL_OP_CHANGE: a device's state changed -- userspace changes one device
	57	* @RFKILL_OP_CHANGE_ALL: userspace changes all devices (of a type, or all)
	58	*/
	59	enum rfkill_operation {
	60	RFKILL_OP_ADD = 0,
	61	RFKILL_OP_DEL,
	62	RFKILL_OP_CHANGE,
	63	RFKILL_OP_CHANGE_ALL,
	64	};
	65
	66	/**
	67	* struct rfkill_event - events for userspace on /dev/rfkill
	68	* @idx: index of dev rfkill
	69	* @type: type of the rfkill struct
	70	* @op: operation code
	71	* @hard: hard state (0/1)
	72	* @soft: soft state (0/1)
	73	*
	74	* Structure used for userspace communication on /dev/rfkill,
	75	* used for events from the kernel and control to the kernel.
	76	*/
	77	struct rfkill_event {
	78	__u32 idx;
	79	__u8 type;
	80	__u8 op;
	81	__u8 soft, hard;
	82	} __packed;
	83
1be491fc JB	84	/*
	85	* We are planning to be backward and forward compatible with changes
	86	* to the event struct, by adding new, optional, members at the end.
	87	* When reading an event (whether the kernel from userspace or vice
	88	* versa) we need to accept anything that's at least as large as the
	89	* version 1 event size, but might be able to accept other sizes in
	90	* the future.
	91	*
	92	* One exception is the kernel -- we already have two event sizes in
	93	* that we've made the 'hard' member optional since our only option
	94	* is to ignore it anyway.
	95	*/
	96	#define RFKILL_EVENT_SIZE_V1 8
	97
c64fb016 JB	98	/* ioctl for turning off rfkill-input (if present) */
	99	#define RFKILL_IOC_MAGIC 'R'
	100	#define RFKILL_IOC_NOINPUT 1
	101	#define RFKILL_IOCTL_NOINPUT _IO(RFKILL_IOC_MAGIC, RFKILL_IOC_NOINPUT)
	102
	103	/* and that's all userspace gets */
	104	#ifdef __KERNEL__
	105	/* don't allow anyone to use these in the kernel */
	106	enum rfkill_user_states {
	107	RFKILL_USER_STATE_SOFT_BLOCKED = RFKILL_STATE_SOFT_BLOCKED,
	108	RFKILL_USER_STATE_UNBLOCKED = RFKILL_STATE_UNBLOCKED,
	109	RFKILL_USER_STATE_HARD_BLOCKED = RFKILL_STATE_HARD_BLOCKED,
	110	};
	111	#undef RFKILL_STATE_SOFT_BLOCKED
	112	#undef RFKILL_STATE_UNBLOCKED
	113	#undef RFKILL_STATE_HARD_BLOCKED
	114
c64fb016 JB	115	#include <linux/kernel.h>
	116	#include <linux/list.h>
	117	#include <linux/mutex.h>
	118	#include <linux/device.h>
	119	#include <linux/leds.h>
1506e30b	120	#include <linux/err.h>
c64fb016	121
19d337df JB	122	/* this is opaque */
	123	struct rfkill;
	124
	125	/**
	126	* struct rfkill_ops - rfkill driver methods
	127	*
	128	* @poll: poll the rfkill block state(s) -- only assign this method
	129	* when you need polling. When called, simply call one of the
	130	* rfkill_set{,_hw,_sw}_state family of functions. If the hw
	131	* is getting unblocked you need to take into account the return
	132	* value of those functions to make sure the software block is
	133	* properly used.
	134	* @query: query the rfkill block state(s) and call exactly one of the
	135	* rfkill_set{,_hw,_sw}_state family of functions. Assign this
	136	* method if input events can cause hardware state changes to make
	137	* the rfkill core query your driver before setting a requested
	138	* block.
	139	* @set_block: turn the transmitter on (blocked == false) or off
c64fb016	140	* (blocked == true) -- ignore and return 0 when hard blocked.
19d337df JB	141	* This callback must be assigned.
	142	*/
	143	struct rfkill_ops {
	144	void (poll)(struct rfkill rfkill, void *data);
	145	void (query)(struct rfkill rfkill, void *data);
	146	int (set_block)(void data, bool blocked);
cf4328cd ID	147	};
cf4328cd ID	148
19d337df	149	#if defined(CONFIG_RFKILL) \|\| defined(CONFIG_RFKILL_MODULE)
cf4328cd	150	/**
19d337df JB	151	* rfkill_alloc - allocate rfkill structure
	152	* @name: name of the struct -- the string is not copied internally
	153	* @parent: device that has rf switch on it
	154	* @type: type of the switch (RFKILL_TYPE_*)
	155	* @ops: rfkill methods
	156	* @ops_data: data passed to each method
	157	*
	158	* This function should be called by the transmitter driver to allocate an
	159	* rfkill structure. Returns %NULL on failure.
cf4328cd	160	*/
19d337df JB	161	struct rfkill * __must_check rfkill_alloc(const char *name,
	162	struct device *parent,
	163	const enum rfkill_type type,
	164	const struct rfkill_ops *ops,
	165	void *ops_data);
cf4328cd	166
19d337df JB	167	/**
	168	* rfkill_register - Register a rfkill structure.
	169	* @rfkill: rfkill structure to be registered
	170	*
	171	* This function should be called by the transmitter driver to register
b3fa1329 AJ	172	* the rfkill structure. Before calling this function the driver needs
	173	* to be ready to service method calls from rfkill.
	174	*
06d5caf4 AJ	175	* If rfkill_init_sw_state() is not called before registration,
	176	* set_block() will be called to initialize the software blocked state
	177	* to a default value.
b3fa1329 AJ	178	*
	179	* If the hardware blocked state is not set before registration,
	180	* it is assumed to be unblocked.
19d337df JB	181	*/
19d337df JB	182	int __must_check rfkill_register(struct rfkill *rfkill);
135900c1	183
19d337df JB	184	/**
	185	* rfkill_pause_polling(struct rfkill *rfkill)
	186	*
	187	* Pause polling -- say transmitter is off for other reasons.
	188	* NOTE: not necessary for suspend/resume -- in that case the
	189	* core stops polling anyway
	190	*/
	191	void rfkill_pause_polling(struct rfkill *rfkill);
cf4328cd	192
19d337df JB	193	/**
	194	* rfkill_resume_polling(struct rfkill *rfkill)
	195	*
	196	* Pause polling -- say transmitter is off for other reasons.
	197	* NOTE: not necessary for suspend/resume -- in that case the
	198	* core stops polling anyway
	199	*/
	200	void rfkill_resume_polling(struct rfkill *rfkill);
	201
	202
	203	/**
	204	* rfkill_unregister - Unregister a rfkill structure.
	205	* @rfkill: rfkill structure to be unregistered
	206	*
	207	* This function should be called by the network driver during device
	208	* teardown to destroy rfkill structure. Until it returns, the driver
	209	* needs to be able to service method calls.
	210	*/
cf4328cd ID	211	void rfkill_unregister(struct rfkill *rfkill);
cf4328cd ID	212
19d337df JB	213	/**
	214	* rfkill_destroy - free rfkill structure
	215	* @rfkill: rfkill structure to be destroyed
	216	*
	217	* Destroys the rfkill structure.
	218	*/
	219	void rfkill_destroy(struct rfkill *rfkill);
	220
	221	/**
	222	* rfkill_set_hw_state - Set the internal rfkill hardware block state
	223	* @rfkill: pointer to the rfkill class to modify.
	224	* @state: the current hardware block state to set
	225	*
	226	* rfkill drivers that get events when the hard-blocked state changes
	227	* use this function to notify the rfkill core (and through that also
908209c1	228	* userspace) of the current state. They should also use this after
19d337df JB	229	* resume if the state could have changed.
	230	*
	231	* You need not (but may) call this function if poll_state is assigned.
	232	*
	233	* This function can be called in any context, even from within rfkill
	234	* callbacks.
	235	*
	236	* The function returns the combined block state (true if transmitter
	237	* should be blocked) so that drivers need not keep track of the soft
	238	* block state -- which they might not be able to.
	239	*/
e56f0975	240	bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
19d337df JB	241
	242	/**
	243	* rfkill_set_sw_state - Set the internal rfkill software block state
	244	* @rfkill: pointer to the rfkill class to modify.
	245	* @state: the current software block state to set
	246	*
	247	* rfkill drivers that get events when the soft-blocked state changes
	248	* (yes, some platforms directly act on input but allow changing again)
	249	* use this function to notify the rfkill core (and through that also
06d5caf4 AJ	250	* userspace) of the current state.
	251	*
	252	* Drivers should also call this function after resume if the state has
	253	* been changed by the user. This only makes sense for "persistent"
	254	* devices (see rfkill_init_sw_state()).
19d337df JB	255	*
	256	* This function can be called in any context, even from within rfkill
	257	* callbacks.
	258	*
	259	* The function returns the combined block state (true if transmitter
	260	* should be blocked).
	261	*/
	262	bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
	263
06d5caf4 AJ	264	/**
	265	* rfkill_init_sw_state - Initialize persistent software block state
	266	* @rfkill: pointer to the rfkill class to modify.
	267	* @state: the current software block state to set
	268	*
	269	* rfkill drivers that preserve their software block state over power off
	270	* use this function to notify the rfkill core (and through that also
	271	* userspace) of their initial state. It should only be used before
	272	* registration.
	273	*
464902e8 AJ	274	* In addition, it marks the device as "persistent", an attribute which
	275	* can be read by userspace. Persistent devices are expected to preserve
	276	* their own state when suspended.
06d5caf4 AJ	277	*/
	278	void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked);
	279
19d337df JB	280	/**
	281	* rfkill_set_states - Set the internal rfkill block states
	282	* @rfkill: pointer to the rfkill class to modify.
	283	* @sw: the current software block state to set
	284	* @hw: the current hardware block state to set
	285	*
	286	* This function can be called in any context, even from within rfkill
	287	* callbacks.
	288	*/
	289	void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
801e49af	290
6081162e JB	291	/**
	292	* rfkill_blocked - query rfkill block
	293	*
	294	* @rfkill: rfkill struct to query
	295	*/
	296	bool rfkill_blocked(struct rfkill *rfkill);
19d337df JB	297	#else /* !RFKILL */
	298	static inline struct rfkill * __must_check
	299	rfkill_alloc(const char *name,
	300	struct device *parent,
	301	const enum rfkill_type type,
	302	const struct rfkill_ops *ops,
	303	void *ops_data)
	304	{
	305	return ERR_PTR(-ENODEV);
	306	}
	307
	308	static inline int __must_check rfkill_register(struct rfkill *rfkill)
	309	{
	310	if (rfkill == ERR_PTR(-ENODEV))
	311	return 0;
	312	return -EINVAL;
	313	}
	314
	315	static inline void rfkill_pause_polling(struct rfkill *rfkill)
	316	{
	317	}
	318
	319	static inline void rfkill_resume_polling(struct rfkill *rfkill)
	320	{
	321	}
	322
	323	static inline void rfkill_unregister(struct rfkill *rfkill)
	324	{
	325	}
	326
	327	static inline void rfkill_destroy(struct rfkill *rfkill)
	328	{
	329	}
	330
	331	static inline bool rfkill_set_hw_state(struct rfkill *rfkill, bool blocked)
	332	{
	333	return blocked;
	334	}
	335
	336	static inline bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked)
	337	{
	338	return blocked;
	339	}
	340
06d5caf4 AJ	341	static inline void rfkill_init_sw_state(struct rfkill *rfkill, bool blocked)
	342	{
	343	}
	344
19d337df JB	345	static inline void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw)
	346	{
	347	}
	348
6081162e JB	349	static inline bool rfkill_blocked(struct rfkill *rfkill)
	350	{
	351	return false;
	352	}
19d337df JB	353	#endif /* RFKILL \|\| RFKILL_MODULE */
19d337df JB	354
5005657c	355
19d337df	356	#ifdef CONFIG_RFKILL_LEDS
135900c1	357	/**
19d337df	358	* rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
135900c1	359	* This function might return a NULL pointer if registering of the
19d337df	360	* LED trigger failed. Use this as "default_trigger" for the LED.
135900c1	361	*/
19d337df JB	362	const char rfkill_get_led_trigger_name(struct rfkill rfkill);
	363
	364	/**
	365	* rfkill_set_led_trigger_name -- set the LED trigger name
	366	* @rfkill: rfkill struct
	367	* @name: LED trigger name
	368	*
	369	* This function sets the LED trigger name of the radio LED
	370	* trigger that rfkill creates. It is optional, but if called
	371	* must be called before rfkill_register() to be effective.
	372	*/
	373	void rfkill_set_led_trigger_name(struct rfkill rfkill, const char name);
135900c1	374	#else
19d337df JB	375	static inline const char rfkill_get_led_trigger_name(struct rfkill rfkill)
19d337df JB	376	{
135900c1	377	return NULL;
135900c1 MB	378	}
135900c1 MB	379
19d337df JB	380	static inline void
	381	rfkill_set_led_trigger_name(struct rfkill rfkill, const char name)
	382	{
	383	}
	384	#endif
	385
	386	#endif /* __KERNEL__ */
	387
cf4328cd	388	#endif /* RFKILL_H */