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) 2015 Intel Mobile Communications GmbH
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 COPYING.
26  *
27  * Contact Information:
28  *  Intel Linux Wireless <linuxwifi@intel.com>
29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
30  *
31  * BSD LICENSE
32  *
33  * Copyright(c) 2015 Intel Mobile Communications GmbH
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/kernel.h>
64 #include <linux/bsearch.h>
65 
66 #include "iwl-trans.h"
67 #include "iwl-drv.h"
68 
69 struct iwl_trans *iwl_trans_alloc(unsigned int priv_size,
70 				  struct device *dev,
71 				  const struct iwl_cfg *cfg,
72 				  const struct iwl_trans_ops *ops,
73 				  size_t dev_cmd_headroom)
74 {
75 	struct iwl_trans *trans;
76 #ifdef CONFIG_LOCKDEP
77 	static struct lock_class_key __key;
78 #endif
79 
80 	trans = kzalloc(sizeof(*trans) + priv_size, GFP_KERNEL);
81 	if (!trans)
82 		return NULL;
83 
84 #ifdef CONFIG_LOCKDEP
85 	lockdep_init_map(&trans->sync_cmd_lockdep_map, "sync_cmd_lockdep_map",
86 			 &__key, 0);
87 #endif
88 
89 	trans->dev = dev;
90 	trans->cfg = cfg;
91 	trans->ops = ops;
92 	trans->dev_cmd_headroom = dev_cmd_headroom;
93 	trans->num_rx_queues = 1;
94 
95 	snprintf(trans->dev_cmd_pool_name, sizeof(trans->dev_cmd_pool_name),
96 		 "iwl_cmd_pool:%s", dev_name(trans->dev));
97 	trans->dev_cmd_pool =
98 		kmem_cache_create(trans->dev_cmd_pool_name,
99 				  sizeof(struct iwl_device_cmd)
100 				  + trans->dev_cmd_headroom,
101 				  sizeof(void *),
102 				  SLAB_HWCACHE_ALIGN,
103 				  NULL);
104 	if (!trans->dev_cmd_pool)
105 		goto free;
106 
107 	return trans;
108  free:
109 	kfree(trans);
110 	return NULL;
111 }
112 
113 void iwl_trans_free(struct iwl_trans *trans)
114 {
115 	kmem_cache_destroy(trans->dev_cmd_pool);
116 	kfree(trans);
117 }
118 
119 int iwl_trans_send_cmd(struct iwl_trans *trans, struct iwl_host_cmd *cmd)
120 {
121 	int ret;
122 
123 	if (unlikely(!(cmd->flags & CMD_SEND_IN_RFKILL) &&
124 		     test_bit(STATUS_RFKILL, &trans->status)))
125 		return -ERFKILL;
126 
127 	if (unlikely(test_bit(STATUS_FW_ERROR, &trans->status)))
128 		return -EIO;
129 
130 	if (unlikely(trans->state != IWL_TRANS_FW_ALIVE)) {
131 		IWL_ERR(trans, "%s bad state = %d\n", __func__, trans->state);
132 		return -EIO;
133 	}
134 
135 	if (WARN_ON((cmd->flags & CMD_WANT_ASYNC_CALLBACK) &&
136 		    !(cmd->flags & CMD_ASYNC)))
137 		return -EINVAL;
138 
139 	if (!(cmd->flags & CMD_ASYNC))
140 		lock_map_acquire_read(&trans->sync_cmd_lockdep_map);
141 
142 	ret = trans->ops->send_cmd(trans, cmd);
143 
144 	if (!(cmd->flags & CMD_ASYNC))
145 		lock_map_release(&trans->sync_cmd_lockdep_map);
146 
147 	return ret;
148 }
149 IWL_EXPORT_SYMBOL(iwl_trans_send_cmd);
150 
151 /* Comparator for struct iwl_hcmd_names.
152  * Used in the binary search over a list of host commands.
153  *
154  * @key: command_id that we're looking for.
155  * @elt: struct iwl_hcmd_names candidate for match.
156  *
157  * @return 0 iff equal.
158  */
159 static int iwl_hcmd_names_cmp(const void *key, const void *elt)
160 {
161 	const struct iwl_hcmd_names *name = elt;
162 	u8 cmd1 = *(u8 *)key;
163 	u8 cmd2 = name->cmd_id;
164 
165 	return (cmd1 - cmd2);
166 }
167 
168 const char *iwl_get_cmd_string(struct iwl_trans *trans, u32 id)
169 {
170 	u8 grp, cmd;
171 	struct iwl_hcmd_names *ret;
172 	const struct iwl_hcmd_arr *arr;
173 	size_t size = sizeof(struct iwl_hcmd_names);
174 
175 	grp = iwl_cmd_groupid(id);
176 	cmd = iwl_cmd_opcode(id);
177 
178 	if (!trans->command_groups || grp >= trans->command_groups_size ||
179 	    !trans->command_groups[grp].arr)
180 		return "UNKNOWN";
181 
182 	arr = &trans->command_groups[grp];
183 	ret = bsearch(&cmd, arr->arr, arr->size, size, iwl_hcmd_names_cmp);
184 	if (!ret)
185 		return "UNKNOWN";
186 	return ret->cmd_name;
187 }
188 IWL_EXPORT_SYMBOL(iwl_get_cmd_string);
189 
190 int iwl_cmd_groups_verify_sorted(const struct iwl_trans_config *trans)
191 {
192 	int i, j;
193 	const struct iwl_hcmd_arr *arr;
194 
195 	for (i = 0; i < trans->command_groups_size; i++) {
196 		arr = &trans->command_groups[i];
197 		if (!arr->arr)
198 			continue;
199 		for (j = 0; j < arr->size - 1; j++)
200 			if (arr->arr[j].cmd_id > arr->arr[j + 1].cmd_id)
201 				return -1;
202 	}
203 	return 0;
204 }
205 IWL_EXPORT_SYMBOL(iwl_cmd_groups_verify_sorted);
206