epca.c: reformat comments and coding style improvements
[linux-2.6/openmoko-kernel.git] / drivers / net / mlx4 / cmd.c
blobdb49051b97b168b7a004e52c865bef94311ce56a
1 /*
2 * Copyright (c) 2004, 2005 Topspin Communications. All rights reserved.
3 * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
4 * Copyright (c) 2005, 2006, 2007 Cisco Systems, Inc. All rights reserved.
6 * This software is available to you under a choice of one of two
7 * licenses. You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
16 * - Redistributions of source code must retain the above
17 * copyright notice, this list of conditions and the following
18 * disclaimer.
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * SOFTWARE.
35 #include <linux/sched.h>
36 #include <linux/pci.h>
37 #include <linux/errno.h>
39 #include <linux/mlx4/cmd.h>
41 #include <asm/io.h>
43 #include "mlx4.h"
45 #define CMD_POLL_TOKEN 0xffff
47 enum {
48 /* command completed successfully: */
49 CMD_STAT_OK = 0x00,
50 /* Internal error (such as a bus error) occurred while processing command: */
51 CMD_STAT_INTERNAL_ERR = 0x01,
52 /* Operation/command not supported or opcode modifier not supported: */
53 CMD_STAT_BAD_OP = 0x02,
54 /* Parameter not supported or parameter out of range: */
55 CMD_STAT_BAD_PARAM = 0x03,
56 /* System not enabled or bad system state: */
57 CMD_STAT_BAD_SYS_STATE = 0x04,
58 /* Attempt to access reserved or unallocaterd resource: */
59 CMD_STAT_BAD_RESOURCE = 0x05,
60 /* Requested resource is currently executing a command, or is otherwise busy: */
61 CMD_STAT_RESOURCE_BUSY = 0x06,
62 /* Required capability exceeds device limits: */
63 CMD_STAT_EXCEED_LIM = 0x08,
64 /* Resource is not in the appropriate state or ownership: */
65 CMD_STAT_BAD_RES_STATE = 0x09,
66 /* Index out of range: */
67 CMD_STAT_BAD_INDEX = 0x0a,
68 /* FW image corrupted: */
69 CMD_STAT_BAD_NVMEM = 0x0b,
70 /* Attempt to modify a QP/EE which is not in the presumed state: */
71 CMD_STAT_BAD_QP_STATE = 0x10,
72 /* Bad segment parameters (Address/Size): */
73 CMD_STAT_BAD_SEG_PARAM = 0x20,
74 /* Memory Region has Memory Windows bound to: */
75 CMD_STAT_REG_BOUND = 0x21,
76 /* HCA local attached memory not present: */
77 CMD_STAT_LAM_NOT_PRE = 0x22,
78 /* Bad management packet (silently discarded): */
79 CMD_STAT_BAD_PKT = 0x30,
80 /* More outstanding CQEs in CQ than new CQ size: */
81 CMD_STAT_BAD_SIZE = 0x40
84 enum {
85 HCR_IN_PARAM_OFFSET = 0x00,
86 HCR_IN_MODIFIER_OFFSET = 0x08,
87 HCR_OUT_PARAM_OFFSET = 0x0c,
88 HCR_TOKEN_OFFSET = 0x14,
89 HCR_STATUS_OFFSET = 0x18,
91 HCR_OPMOD_SHIFT = 12,
92 HCR_T_BIT = 21,
93 HCR_E_BIT = 22,
94 HCR_GO_BIT = 23
97 enum {
98 GO_BIT_TIMEOUT_MSECS = 10000
101 struct mlx4_cmd_context {
102 struct completion done;
103 int result;
104 int next;
105 u64 out_param;
106 u16 token;
109 static int mlx4_status_to_errno(u8 status) {
110 static const int trans_table[] = {
111 [CMD_STAT_INTERNAL_ERR] = -EIO,
112 [CMD_STAT_BAD_OP] = -EPERM,
113 [CMD_STAT_BAD_PARAM] = -EINVAL,
114 [CMD_STAT_BAD_SYS_STATE] = -ENXIO,
115 [CMD_STAT_BAD_RESOURCE] = -EBADF,
116 [CMD_STAT_RESOURCE_BUSY] = -EBUSY,
117 [CMD_STAT_EXCEED_LIM] = -ENOMEM,
118 [CMD_STAT_BAD_RES_STATE] = -EBADF,
119 [CMD_STAT_BAD_INDEX] = -EBADF,
120 [CMD_STAT_BAD_NVMEM] = -EFAULT,
121 [CMD_STAT_BAD_QP_STATE] = -EINVAL,
122 [CMD_STAT_BAD_SEG_PARAM] = -EFAULT,
123 [CMD_STAT_REG_BOUND] = -EBUSY,
124 [CMD_STAT_LAM_NOT_PRE] = -EAGAIN,
125 [CMD_STAT_BAD_PKT] = -EINVAL,
126 [CMD_STAT_BAD_SIZE] = -ENOMEM,
129 if (status >= ARRAY_SIZE(trans_table) ||
130 (status != CMD_STAT_OK && trans_table[status] == 0))
131 return -EIO;
133 return trans_table[status];
136 static int cmd_pending(struct mlx4_dev *dev)
138 u32 status = readl(mlx4_priv(dev)->cmd.hcr + HCR_STATUS_OFFSET);
140 return (status & swab32(1 << HCR_GO_BIT)) ||
141 (mlx4_priv(dev)->cmd.toggle ==
142 !!(status & swab32(1 << HCR_T_BIT)));
145 static int mlx4_cmd_post(struct mlx4_dev *dev, u64 in_param, u64 out_param,
146 u32 in_modifier, u8 op_modifier, u16 op, u16 token,
147 int event)
149 struct mlx4_cmd *cmd = &mlx4_priv(dev)->cmd;
150 u32 __iomem *hcr = cmd->hcr;
151 int ret = -EAGAIN;
152 unsigned long end;
154 mutex_lock(&cmd->hcr_mutex);
156 end = jiffies;
157 if (event)
158 end += msecs_to_jiffies(GO_BIT_TIMEOUT_MSECS);
160 while (cmd_pending(dev)) {
161 if (time_after_eq(jiffies, end))
162 goto out;
163 cond_resched();
167 * We use writel (instead of something like memcpy_toio)
168 * because writes of less than 32 bits to the HCR don't work
169 * (and some architectures such as ia64 implement memcpy_toio
170 * in terms of writeb).
172 __raw_writel((__force u32) cpu_to_be32(in_param >> 32), hcr + 0);
173 __raw_writel((__force u32) cpu_to_be32(in_param & 0xfffffffful), hcr + 1);
174 __raw_writel((__force u32) cpu_to_be32(in_modifier), hcr + 2);
175 __raw_writel((__force u32) cpu_to_be32(out_param >> 32), hcr + 3);
176 __raw_writel((__force u32) cpu_to_be32(out_param & 0xfffffffful), hcr + 4);
177 __raw_writel((__force u32) cpu_to_be32(token << 16), hcr + 5);
179 /* __raw_writel may not order writes. */
180 wmb();
182 __raw_writel((__force u32) cpu_to_be32((1 << HCR_GO_BIT) |
183 (cmd->toggle << HCR_T_BIT) |
184 (event ? (1 << HCR_E_BIT) : 0) |
185 (op_modifier << HCR_OPMOD_SHIFT) |
186 op), hcr + 6);
189 * Make sure that our HCR writes don't get mixed in with
190 * writes from another CPU starting a FW command.
192 mmiowb();
194 cmd->toggle = cmd->toggle ^ 1;
196 ret = 0;
198 out:
199 mutex_unlock(&cmd->hcr_mutex);
200 return ret;
203 static int mlx4_cmd_poll(struct mlx4_dev *dev, u64 in_param, u64 *out_param,
204 int out_is_imm, u32 in_modifier, u8 op_modifier,
205 u16 op, unsigned long timeout)
207 struct mlx4_priv *priv = mlx4_priv(dev);
208 void __iomem *hcr = priv->cmd.hcr;
209 int err = 0;
210 unsigned long end;
212 down(&priv->cmd.poll_sem);
214 err = mlx4_cmd_post(dev, in_param, out_param ? *out_param : 0,
215 in_modifier, op_modifier, op, CMD_POLL_TOKEN, 0);
216 if (err)
217 goto out;
219 end = msecs_to_jiffies(timeout) + jiffies;
220 while (cmd_pending(dev) && time_before(jiffies, end))
221 cond_resched();
223 if (cmd_pending(dev)) {
224 err = -ETIMEDOUT;
225 goto out;
228 if (out_is_imm)
229 *out_param =
230 (u64) be32_to_cpu((__force __be32)
231 __raw_readl(hcr + HCR_OUT_PARAM_OFFSET)) << 32 |
232 (u64) be32_to_cpu((__force __be32)
233 __raw_readl(hcr + HCR_OUT_PARAM_OFFSET + 4));
235 err = mlx4_status_to_errno(be32_to_cpu((__force __be32)
236 __raw_readl(hcr + HCR_STATUS_OFFSET)) >> 24);
238 out:
239 up(&priv->cmd.poll_sem);
240 return err;
243 void mlx4_cmd_event(struct mlx4_dev *dev, u16 token, u8 status, u64 out_param)
245 struct mlx4_priv *priv = mlx4_priv(dev);
246 struct mlx4_cmd_context *context =
247 &priv->cmd.context[token & priv->cmd.token_mask];
249 /* previously timed out command completing at long last */
250 if (token != context->token)
251 return;
253 context->result = mlx4_status_to_errno(status);
254 context->out_param = out_param;
256 complete(&context->done);
259 static int mlx4_cmd_wait(struct mlx4_dev *dev, u64 in_param, u64 *out_param,
260 int out_is_imm, u32 in_modifier, u8 op_modifier,
261 u16 op, unsigned long timeout)
263 struct mlx4_cmd *cmd = &mlx4_priv(dev)->cmd;
264 struct mlx4_cmd_context *context;
265 int err = 0;
267 down(&cmd->event_sem);
269 spin_lock(&cmd->context_lock);
270 BUG_ON(cmd->free_head < 0);
271 context = &cmd->context[cmd->free_head];
272 context->token += cmd->token_mask + 1;
273 cmd->free_head = context->next;
274 spin_unlock(&cmd->context_lock);
276 init_completion(&context->done);
278 mlx4_cmd_post(dev, in_param, out_param ? *out_param : 0,
279 in_modifier, op_modifier, op, context->token, 1);
281 if (!wait_for_completion_timeout(&context->done, msecs_to_jiffies(timeout))) {
282 err = -EBUSY;
283 goto out;
286 err = context->result;
287 if (err)
288 goto out;
290 if (out_is_imm)
291 *out_param = context->out_param;
293 out:
294 spin_lock(&cmd->context_lock);
295 context->next = cmd->free_head;
296 cmd->free_head = context - cmd->context;
297 spin_unlock(&cmd->context_lock);
299 up(&cmd->event_sem);
300 return err;
303 int __mlx4_cmd(struct mlx4_dev *dev, u64 in_param, u64 *out_param,
304 int out_is_imm, u32 in_modifier, u8 op_modifier,
305 u16 op, unsigned long timeout)
307 if (mlx4_priv(dev)->cmd.use_events)
308 return mlx4_cmd_wait(dev, in_param, out_param, out_is_imm,
309 in_modifier, op_modifier, op, timeout);
310 else
311 return mlx4_cmd_poll(dev, in_param, out_param, out_is_imm,
312 in_modifier, op_modifier, op, timeout);
314 EXPORT_SYMBOL_GPL(__mlx4_cmd);
316 int mlx4_cmd_init(struct mlx4_dev *dev)
318 struct mlx4_priv *priv = mlx4_priv(dev);
320 mutex_init(&priv->cmd.hcr_mutex);
321 sema_init(&priv->cmd.poll_sem, 1);
322 priv->cmd.use_events = 0;
323 priv->cmd.toggle = 1;
325 priv->cmd.hcr = ioremap(pci_resource_start(dev->pdev, 0) + MLX4_HCR_BASE,
326 MLX4_HCR_SIZE);
327 if (!priv->cmd.hcr) {
328 mlx4_err(dev, "Couldn't map command register.");
329 return -ENOMEM;
332 priv->cmd.pool = pci_pool_create("mlx4_cmd", dev->pdev,
333 MLX4_MAILBOX_SIZE,
334 MLX4_MAILBOX_SIZE, 0);
335 if (!priv->cmd.pool) {
336 iounmap(priv->cmd.hcr);
337 return -ENOMEM;
340 return 0;
343 void mlx4_cmd_cleanup(struct mlx4_dev *dev)
345 struct mlx4_priv *priv = mlx4_priv(dev);
347 pci_pool_destroy(priv->cmd.pool);
348 iounmap(priv->cmd.hcr);
352 * Switch to using events to issue FW commands (can only be called
353 * after event queue for command events has been initialized).
355 int mlx4_cmd_use_events(struct mlx4_dev *dev)
357 struct mlx4_priv *priv = mlx4_priv(dev);
358 int i;
360 priv->cmd.context = kmalloc(priv->cmd.max_cmds *
361 sizeof (struct mlx4_cmd_context),
362 GFP_KERNEL);
363 if (!priv->cmd.context)
364 return -ENOMEM;
366 for (i = 0; i < priv->cmd.max_cmds; ++i) {
367 priv->cmd.context[i].token = i;
368 priv->cmd.context[i].next = i + 1;
371 priv->cmd.context[priv->cmd.max_cmds - 1].next = -1;
372 priv->cmd.free_head = 0;
374 sema_init(&priv->cmd.event_sem, priv->cmd.max_cmds);
375 spin_lock_init(&priv->cmd.context_lock);
377 for (priv->cmd.token_mask = 1;
378 priv->cmd.token_mask < priv->cmd.max_cmds;
379 priv->cmd.token_mask <<= 1)
380 ; /* nothing */
381 --priv->cmd.token_mask;
383 priv->cmd.use_events = 1;
385 down(&priv->cmd.poll_sem);
387 return 0;
391 * Switch back to polling (used when shutting down the device)
393 void mlx4_cmd_use_polling(struct mlx4_dev *dev)
395 struct mlx4_priv *priv = mlx4_priv(dev);
396 int i;
398 priv->cmd.use_events = 0;
400 for (i = 0; i < priv->cmd.max_cmds; ++i)
401 down(&priv->cmd.event_sem);
403 kfree(priv->cmd.context);
405 up(&priv->cmd.poll_sem);
408 struct mlx4_cmd_mailbox *mlx4_alloc_cmd_mailbox(struct mlx4_dev *dev)
410 struct mlx4_cmd_mailbox *mailbox;
412 mailbox = kmalloc(sizeof *mailbox, GFP_KERNEL);
413 if (!mailbox)
414 return ERR_PTR(-ENOMEM);
416 mailbox->buf = pci_pool_alloc(mlx4_priv(dev)->cmd.pool, GFP_KERNEL,
417 &mailbox->dma);
418 if (!mailbox->buf) {
419 kfree(mailbox);
420 return ERR_PTR(-ENOMEM);
423 return mailbox;
425 EXPORT_SYMBOL_GPL(mlx4_alloc_cmd_mailbox);
427 void mlx4_free_cmd_mailbox(struct mlx4_dev *dev, struct mlx4_cmd_mailbox *mailbox)
429 if (!mailbox)
430 return;
432 pci_pool_free(mlx4_priv(dev)->cmd.pool, mailbox->buf, mailbox->dma);
433 kfree(mailbox);
435 EXPORT_SYMBOL_GPL(mlx4_free_cmd_mailbox);