Add support for the latest 1G/10G Chelsio adapter, T3.
[linux-2.6.git] / drivers / net / cxgb3 / cxgb3_offload.h
1 /*
2  * Copyright (c) 2006 Chelsio, Inc. All rights reserved.
3  * Copyright (c) 2006 Open Grid Computing, Inc. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 #ifndef _CXGB3_OFFLOAD_H
34 #define _CXGB3_OFFLOAD_H
35
36 #include <linux/list.h>
37 #include <linux/skbuff.h>
38
39 #include "l2t.h"
40
41 #include "t3cdev.h"
42 #include "t3_cpl.h"
43
44 struct adapter;
45
46 void cxgb3_offload_init(void);
47
48 void cxgb3_adapter_ofld(struct adapter *adapter);
49 void cxgb3_adapter_unofld(struct adapter *adapter);
50 int cxgb3_offload_activate(struct adapter *adapter);
51 void cxgb3_offload_deactivate(struct adapter *adapter);
52
53 void cxgb3_set_dummy_ops(struct t3cdev *dev);
54
55 /*
56  * Client registration.  Users of T3 driver must register themselves.
57  * The T3 driver will call the add function of every client for each T3
58  * adapter activated, passing up the t3cdev ptr.  Each client fills out an
59  * array of callback functions to process CPL messages.
60  */
61
62 void cxgb3_register_client(struct cxgb3_client *client);
63 void cxgb3_unregister_client(struct cxgb3_client *client);
64 void cxgb3_add_clients(struct t3cdev *tdev);
65 void cxgb3_remove_clients(struct t3cdev *tdev);
66
67 typedef int (*cxgb3_cpl_handler_func)(struct t3cdev *dev,
68                                       struct sk_buff *skb, void *ctx);
69
70 struct cxgb3_client {
71         char *name;
72         void (*add) (struct t3cdev *);
73         void (*remove) (struct t3cdev *);
74         cxgb3_cpl_handler_func *handlers;
75         int (*redirect)(void *ctx, struct dst_entry *old,
76                         struct dst_entry *new, struct l2t_entry *l2t);
77         struct list_head client_list;
78 };
79
80 /*
81  * TID allocation services.
82  */
83 int cxgb3_alloc_atid(struct t3cdev *dev, struct cxgb3_client *client,
84                      void *ctx);
85 int cxgb3_alloc_stid(struct t3cdev *dev, struct cxgb3_client *client,
86                      void *ctx);
87 void *cxgb3_free_atid(struct t3cdev *dev, int atid);
88 void cxgb3_free_stid(struct t3cdev *dev, int stid);
89 void cxgb3_insert_tid(struct t3cdev *dev, struct cxgb3_client *client,
90                       void *ctx, unsigned int tid);
91 void cxgb3_queue_tid_release(struct t3cdev *dev, unsigned int tid);
92 void cxgb3_remove_tid(struct t3cdev *dev, void *ctx, unsigned int tid);
93
94 struct t3c_tid_entry {
95         struct cxgb3_client *client;
96         void *ctx;
97 };
98
99 /* CPL message priority levels */
100 enum {
101         CPL_PRIORITY_DATA = 0,  /* data messages */
102         CPL_PRIORITY_SETUP = 1, /* connection setup messages */
103         CPL_PRIORITY_TEARDOWN = 0,      /* connection teardown messages */
104         CPL_PRIORITY_LISTEN = 1,        /* listen start/stop messages */
105         CPL_PRIORITY_ACK = 1,   /* RX ACK messages */
106         CPL_PRIORITY_CONTROL = 1        /* offload control messages */
107 };
108
109 /* Flags for return value of CPL message handlers */
110 enum {
111         CPL_RET_BUF_DONE = 1, /* buffer processing done, buffer may be freed */
112         CPL_RET_BAD_MSG = 2,  /* bad CPL message (e.g., unknown opcode) */
113         CPL_RET_UNKNOWN_TID = 4 /* unexpected unknown TID */
114 };
115
116 typedef int (*cpl_handler_func)(struct t3cdev *dev, struct sk_buff *skb);
117
118 /*
119  * Returns a pointer to the first byte of the CPL header in an sk_buff that
120  * contains a CPL message.
121  */
122 static inline void *cplhdr(struct sk_buff *skb)
123 {
124         return skb->data;
125 }
126
127 void t3_register_cpl_handler(unsigned int opcode, cpl_handler_func h);
128
129 union listen_entry {
130         struct t3c_tid_entry t3c_tid;
131         union listen_entry *next;
132 };
133
134 union active_open_entry {
135         struct t3c_tid_entry t3c_tid;
136         union active_open_entry *next;
137 };
138
139 /*
140  * Holds the size, base address, free list start, etc of the TID, server TID,
141  * and active-open TID tables for a offload device.
142  * The tables themselves are allocated dynamically.
143  */
144 struct tid_info {
145         struct t3c_tid_entry *tid_tab;
146         unsigned int ntids;
147         atomic_t tids_in_use;
148
149         union listen_entry *stid_tab;
150         unsigned int nstids;
151         unsigned int stid_base;
152
153         union active_open_entry *atid_tab;
154         unsigned int natids;
155         unsigned int atid_base;
156
157         /*
158          * The following members are accessed R/W so we put them in their own
159          * cache lines.
160          *
161          * XXX We could combine the atid fields above with the lock here since
162          * atids are use once (unlike other tids).  OTOH the above fields are
163          * usually in cache due to tid_tab.
164          */
165         spinlock_t atid_lock ____cacheline_aligned_in_smp;
166         union active_open_entry *afree;
167         unsigned int atids_in_use;
168
169         spinlock_t stid_lock ____cacheline_aligned;
170         union listen_entry *sfree;
171         unsigned int stids_in_use;
172 };
173
174 struct t3c_data {
175         struct list_head list_node;
176         struct t3cdev *dev;
177         unsigned int tx_max_chunk;      /* max payload for TX_DATA */
178         unsigned int max_wrs;   /* max in-flight WRs per connection */
179         unsigned int nmtus;
180         const unsigned short *mtus;
181         struct tid_info tid_maps;
182
183         struct t3c_tid_entry *tid_release_list;
184         spinlock_t tid_release_lock;
185         struct work_struct tid_release_task;
186 };
187
188 /*
189  * t3cdev -> t3c_data accessor
190  */
191 #define T3C_DATA(dev) (*(struct t3c_data **)&(dev)->l4opt)
192
193 #endif