[deliverable/linux.git] / drivers / net / wireless / iwlwifi / iwl-notif-wait.c

/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
#include <linux/sched.h>
#include <linux/export.h>

#include "iwl-notif-wait.h"


void iwl_notification_wait_init(struct iwl_notif_wait_data *notif_wait)
{
	spin_lock_init(&notif_wait->notif_wait_lock);
	INIT_LIST_HEAD(&notif_wait->notif_waits);
	init_waitqueue_head(&notif_wait->notif_waitq);
}
EXPORT_SYMBOL_GPL(iwl_notification_wait_init);

void iwl_notification_wait_notify(struct iwl_notif_wait_data *notif_wait,
				  struct iwl_rx_packet *pkt)
{
	bool triggered = false;

	if (!list_empty(&notif_wait->notif_waits)) {
		struct iwl_notification_wait *w;

		spin_lock(&notif_wait->notif_wait_lock);
		list_for_each_entry(w, &notif_wait->notif_waits, list) {
			int i;
			bool found = false;

			/*
			 * If it already finished (triggered) or has been
			 * aborted then don't evaluate it again to avoid races,
			 * Otherwise the function could be called again even
			 * though it returned true before
			 */
			if (w->triggered || w->aborted)
				continue;

			for (i = 0; i < w->n_cmds; i++) {
				if (w->cmds[i] == pkt->hdr.cmd) {
					found = true;
					break;
				}
			}
			if (!found)
				continue;

			if (!w->fn || w->fn(notif_wait, pkt, w->fn_data)) {
				w->triggered = true;
				triggered = true;
			}
		}
		spin_unlock(&notif_wait->notif_wait_lock);

	}

	if (triggered)
		wake_up_all(&notif_wait->notif_waitq);
}
EXPORT_SYMBOL_GPL(iwl_notification_wait_notify);

void iwl_abort_notification_waits(struct iwl_notif_wait_data *notif_wait)
{
	unsigned long flags;
	struct iwl_notification_wait *wait_entry;

	spin_lock_irqsave(&notif_wait->notif_wait_lock, flags);
	list_for_each_entry(wait_entry, &notif_wait->notif_waits, list)
		wait_entry->aborted = true;
	spin_unlock_irqrestore(&notif_wait->notif_wait_lock, flags);

	wake_up_all(&notif_wait->notif_waitq);
}
EXPORT_SYMBOL_GPL(iwl_abort_notification_waits);

void
iwl_init_notification_wait(struct iwl_notif_wait_data *notif_wait,
			   struct iwl_notification_wait *wait_entry,
			   const u8 *cmds, int n_cmds,
			   bool (*fn)(struct iwl_notif_wait_data *notif_wait,
				      struct iwl_rx_packet *pkt, void *data),
			   void *fn_data)
{
	if (WARN_ON(n_cmds > MAX_NOTIF_CMDS))
		n_cmds = MAX_NOTIF_CMDS;

	wait_entry->fn = fn;
	wait_entry->fn_data = fn_data;
	wait_entry->n_cmds = n_cmds;
	memcpy(wait_entry->cmds, cmds, n_cmds);
	wait_entry->triggered = false;
	wait_entry->aborted = false;

	spin_lock_bh(&notif_wait->notif_wait_lock);
	list_add(&wait_entry->list, &notif_wait->notif_waits);
	spin_unlock_bh(&notif_wait->notif_wait_lock);
}
EXPORT_SYMBOL_GPL(iwl_init_notification_wait);

int iwl_wait_notification(struct iwl_notif_wait_data *notif_wait,
			  struct iwl_notification_wait *wait_entry,
			  unsigned long timeout)
{
	int ret;

	ret = wait_event_timeout(notif_wait->notif_waitq,
				 wait_entry->triggered || wait_entry->aborted,
				 timeout);

	spin_lock_bh(&notif_wait->notif_wait_lock);
	list_del(&wait_entry->list);
	spin_unlock_bh(&notif_wait->notif_wait_lock);

	if (wait_entry->aborted)
		return -EIO;

	/* return value is always >= 0 */
	if (ret <= 0)
		return -ETIMEDOUT;
	return 0;
}
EXPORT_SYMBOL_GPL(iwl_wait_notification);

void iwl_remove_notification(struct iwl_notif_wait_data *notif_wait,
			     struct iwl_notification_wait *wait_entry)
{
	spin_lock_bh(&notif_wait->notif_wait_lock);
	list_del(&wait_entry->list);
	spin_unlock_bh(&notif_wait->notif_wait_lock);
}
EXPORT_SYMBOL_GPL(iwl_remove_notification);
Commit	Line	Data
4bd14dd5 JB	1	/******************************************************************************
	2	*
	3	* This file is provided under a dual BSD/GPLv2 license. When using or
	4	* redistributing this file, you may do so under either license.
	5	*
	6	* GPL LICENSE SUMMARY
	7	*
	8	* Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
	9	*
	10	* This program is free software; you can redistribute it and/or modify
	11	* it under the terms of version 2 of the GNU General Public License as
	12	* published by the Free Software Foundation.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
	22	* USA
	23	*
	24	* The full GNU General Public License is included in this distribution
	25	* in the file called LICENSE.GPL.
	26	*
	27	* Contact Information:
	28	* Intel Linux Wireless <ilw@linux.intel.com>
	29	* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
	30	*
	31	* BSD LICENSE
	32	*
	33	* Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
	34	* All rights reserved.
	35	*
	36	* Redistribution and use in source and binary forms, with or without
	37	* modification, are permitted provided that the following conditions
	38	* are met:
	39	*
	40	* * Redistributions of source code must retain the above copyright
	41	* notice, this list of conditions and the following disclaimer.
	42	* * Redistributions in binary form must reproduce the above copyright
	43	* notice, this list of conditions and the following disclaimer in
	44	* the documentation and/or other materials provided with the
	45	* distribution.
	46	* * Neither the name Intel Corporation nor the names of its
	47	* contributors may be used to endorse or promote products derived
	48	* from this software without specific prior written permission.
	49	*
	50	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	51	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	52	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	53	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	54	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	55	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	56	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	57	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	58	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	59	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	60	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	61	*
	62	*****************************************************************************/
	63	#include <linux/sched.h>
ac91f910	64	#include <linux/export.h>
4bd14dd5 JB	65
	66	#include "iwl-notif-wait.h"
	67
	68
	69	void iwl_notification_wait_init(struct iwl_notif_wait_data *notif_wait)
	70	{
	71	spin_lock_init(&notif_wait->notif_wait_lock);
	72	INIT_LIST_HEAD(&notif_wait->notif_waits);
	73	init_waitqueue_head(&notif_wait->notif_waitq);
	74	}
ac91f910	75	EXPORT_SYMBOL_GPL(iwl_notification_wait_init);
4bd14dd5 JB	76
	77	void iwl_notification_wait_notify(struct iwl_notif_wait_data *notif_wait,
	78	struct iwl_rx_packet *pkt)
	79	{
db662d47 JB	80	bool triggered = false;
db662d47 JB	81
4bd14dd5 JB	82	if (!list_empty(&notif_wait->notif_waits)) {
	83	struct iwl_notification_wait *w;
	84
	85	spin_lock(&notif_wait->notif_wait_lock);
	86	list_for_each_entry(w, &notif_wait->notif_waits, list) {
db662d47 JB	87	int i;
	88	bool found = false;
	89
	90	/*
	91	* If it already finished (triggered) or has been
	92	* aborted then don't evaluate it again to avoid races,
	93	* Otherwise the function could be called again even
	94	* though it returned true before
	95	*/
	96	if (w->triggered \|\| w->aborted)
	97	continue;
	98
	99	for (i = 0; i < w->n_cmds; i++) {
	100	if (w->cmds[i] == pkt->hdr.cmd) {
	101	found = true;
	102	break;
	103	}
	104	}
	105	if (!found)
4bd14dd5	106	continue;
db662d47 JB	107
	108	if (!w->fn \|\| w->fn(notif_wait, pkt, w->fn_data)) {
	109	w->triggered = true;
	110	triggered = true;
	111	}
4bd14dd5 JB	112	}
	113	spin_unlock(&notif_wait->notif_wait_lock);
	114
4bd14dd5	115	}
db662d47 JB	116
	117	if (triggered)
	118	wake_up_all(&notif_wait->notif_waitq);
4bd14dd5	119	}
ac91f910	120	EXPORT_SYMBOL_GPL(iwl_notification_wait_notify);
4bd14dd5 JB	121
	122	void iwl_abort_notification_waits(struct iwl_notif_wait_data *notif_wait)
	123	{
	124	unsigned long flags;
	125	struct iwl_notification_wait *wait_entry;
	126
	127	spin_lock_irqsave(&notif_wait->notif_wait_lock, flags);
	128	list_for_each_entry(wait_entry, &notif_wait->notif_waits, list)
	129	wait_entry->aborted = true;
	130	spin_unlock_irqrestore(&notif_wait->notif_wait_lock, flags);
	131
	132	wake_up_all(&notif_wait->notif_waitq);
	133	}
ac91f910	134	EXPORT_SYMBOL_GPL(iwl_abort_notification_waits);
4bd14dd5 JB	135
	136	void
	137	iwl_init_notification_wait(struct iwl_notif_wait_data *notif_wait,
	138	struct iwl_notification_wait *wait_entry,
db662d47 JB	139	const u8 *cmds, int n_cmds,
db662d47 JB	140	bool (fn)(struct iwl_notif_wait_data notif_wait,
4bd14dd5 JB	141	struct iwl_rx_packet pkt, void data),
	142	void *fn_data)
	143	{
db662d47 JB	144	if (WARN_ON(n_cmds > MAX_NOTIF_CMDS))
	145	n_cmds = MAX_NOTIF_CMDS;
	146
4bd14dd5 JB	147	wait_entry->fn = fn;
4bd14dd5 JB	148	wait_entry->fn_data = fn_data;
db662d47 JB	149	wait_entry->n_cmds = n_cmds;
db662d47 JB	150	memcpy(wait_entry->cmds, cmds, n_cmds);
4bd14dd5 JB	151	wait_entry->triggered = false;
	152	wait_entry->aborted = false;
	153
	154	spin_lock_bh(&notif_wait->notif_wait_lock);
	155	list_add(&wait_entry->list, &notif_wait->notif_waits);
	156	spin_unlock_bh(&notif_wait->notif_wait_lock);
	157	}
ac91f910	158	EXPORT_SYMBOL_GPL(iwl_init_notification_wait);
4bd14dd5 JB	159
	160	int iwl_wait_notification(struct iwl_notif_wait_data *notif_wait,
	161	struct iwl_notification_wait *wait_entry,
	162	unsigned long timeout)
	163	{
	164	int ret;
	165
	166	ret = wait_event_timeout(notif_wait->notif_waitq,
	167	wait_entry->triggered \|\| wait_entry->aborted,
	168	timeout);
	169
	170	spin_lock_bh(&notif_wait->notif_wait_lock);
	171	list_del(&wait_entry->list);
	172	spin_unlock_bh(&notif_wait->notif_wait_lock);
	173
	174	if (wait_entry->aborted)
	175	return -EIO;
	176
	177	/* return value is always >= 0 */
	178	if (ret <= 0)
	179	return -ETIMEDOUT;
	180	return 0;
	181	}
ac91f910	182	EXPORT_SYMBOL_GPL(iwl_wait_notification);
4bd14dd5 JB	183
	184	void iwl_remove_notification(struct iwl_notif_wait_data *notif_wait,
	185	struct iwl_notification_wait *wait_entry)
	186	{
	187	spin_lock_bh(&notif_wait->notif_wait_lock);
	188	list_del(&wait_entry->list);
	189	spin_unlock_bh(&notif_wait->notif_wait_lock);
	190	}
ac91f910	191	EXPORT_SYMBOL_GPL(iwl_remove_notification);