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>
 64
 65#include "iwl-notif-wait.h"
 66
 67
 68void iwl_notification_wait_init(struct iwl_notif_wait_data *notif_wait)
 69{
 70	spin_lock_init(&notif_wait->notif_wait_lock);
 71	INIT_LIST_HEAD(&notif_wait->notif_waits);
 72	init_waitqueue_head(&notif_wait->notif_waitq);
 73}
 74
 75void iwl_notification_wait_notify(struct iwl_notif_wait_data *notif_wait,
 76				  struct iwl_rx_packet *pkt)
 77{
 78	bool triggered = false;
 79
 80	if (!list_empty(&notif_wait->notif_waits)) {
 81		struct iwl_notification_wait *w;
 82
 83		spin_lock(&notif_wait->notif_wait_lock);
 84		list_for_each_entry(w, &notif_wait->notif_waits, list) {
 85			int i;
 86			bool found = false;
 87
 88			/*
 89			 * If it already finished (triggered) or has been
 90			 * aborted then don't evaluate it again to avoid races,
 91			 * Otherwise the function could be called again even
 92			 * though it returned true before
 93			 */
 94			if (w->triggered || w->aborted)
 95				continue;
 96
 97			for (i = 0; i < w->n_cmds; i++) {
 98				if (w->cmds[i] == pkt->hdr.cmd) {
 99					found = true;
100					break;
101				}
102			}
103			if (!found)
104				continue;
105
106			if (!w->fn || w->fn(notif_wait, pkt, w->fn_data)) {
107				w->triggered = true;
108				triggered = true;
109			}
110		}
111		spin_unlock(&notif_wait->notif_wait_lock);
112
113	}
114
115	if (triggered)
116		wake_up_all(&notif_wait->notif_waitq);
117}
118
119void iwl_abort_notification_waits(struct iwl_notif_wait_data *notif_wait)
120{
121	unsigned long flags;
122	struct iwl_notification_wait *wait_entry;
123
124	spin_lock_irqsave(&notif_wait->notif_wait_lock, flags);
125	list_for_each_entry(wait_entry, &notif_wait->notif_waits, list)
126		wait_entry->aborted = true;
127	spin_unlock_irqrestore(&notif_wait->notif_wait_lock, flags);
128
129	wake_up_all(&notif_wait->notif_waitq);
130}
131
132
133void
134iwl_init_notification_wait(struct iwl_notif_wait_data *notif_wait,
135			   struct iwl_notification_wait *wait_entry,
136			   const u8 *cmds, int n_cmds,
137			   bool (*fn)(struct iwl_notif_wait_data *notif_wait,
138				      struct iwl_rx_packet *pkt, void *data),
139			   void *fn_data)
140{
141	if (WARN_ON(n_cmds > MAX_NOTIF_CMDS))
142		n_cmds = MAX_NOTIF_CMDS;
143
144	wait_entry->fn = fn;
145	wait_entry->fn_data = fn_data;
146	wait_entry->n_cmds = n_cmds;
147	memcpy(wait_entry->cmds, cmds, n_cmds);
148	wait_entry->triggered = false;
149	wait_entry->aborted = false;
150
151	spin_lock_bh(&notif_wait->notif_wait_lock);
152	list_add(&wait_entry->list, &notif_wait->notif_waits);
153	spin_unlock_bh(&notif_wait->notif_wait_lock);
154}
155
156int iwl_wait_notification(struct iwl_notif_wait_data *notif_wait,
157			  struct iwl_notification_wait *wait_entry,
158			  unsigned long timeout)
159{
160	int ret;
161
162	ret = wait_event_timeout(notif_wait->notif_waitq,
163				 wait_entry->triggered || wait_entry->aborted,
164				 timeout);
165
166	spin_lock_bh(&notif_wait->notif_wait_lock);
167	list_del(&wait_entry->list);
168	spin_unlock_bh(&notif_wait->notif_wait_lock);
169
170	if (wait_entry->aborted)
171		return -EIO;
172
173	/* return value is always >= 0 */
174	if (ret <= 0)
175		return -ETIMEDOUT;
176	return 0;
177}
178
179void iwl_remove_notification(struct iwl_notif_wait_data *notif_wait,
180			     struct iwl_notification_wait *wait_entry)
181{
182	spin_lock_bh(&notif_wait->notif_wait_lock);
183	list_del(&wait_entry->list);
184	spin_unlock_bh(&notif_wait->notif_wait_lock);
185}