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