1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *	Copyright IBM Corp. 2001, 2007
4  *	Authors:	Fritz Elfert (felfert@millenux.com)
5  *			Peter Tiedemann (ptiedem@de.ibm.com)
6  */
7 
8 #ifndef _CTCM_MAIN_H_
9 #define _CTCM_MAIN_H_
10 
11 #include <asm/ccwdev.h>
12 #include <asm/ccwgroup.h>
13 
14 #include <linux/skbuff.h>
15 #include <linux/netdevice.h>
16 
17 #include "fsm.h"
18 #include "ctcm_dbug.h"
19 #include "ctcm_mpc.h"
20 
21 #define CTC_DRIVER_NAME	"ctcm"
22 #define CTC_DEVICE_NAME	"ctc"
23 #define MPC_DEVICE_NAME	"mpc"
24 #define CTC_DEVICE_GENE CTC_DEVICE_NAME "%d"
25 #define MPC_DEVICE_GENE	MPC_DEVICE_NAME "%d"
26 
27 #define CHANNEL_FLAGS_READ	0
28 #define CHANNEL_FLAGS_WRITE	1
29 #define CHANNEL_FLAGS_INUSE	2
30 #define CHANNEL_FLAGS_BUFSIZE_CHANGED	4
31 #define CHANNEL_FLAGS_FAILED	8
32 #define CHANNEL_FLAGS_WAITIRQ	16
33 #define CHANNEL_FLAGS_RWMASK	1
34 #define CHANNEL_DIRECTION(f) (f & CHANNEL_FLAGS_RWMASK)
35 
36 #define LOG_FLAG_ILLEGALPKT	1
37 #define LOG_FLAG_ILLEGALSIZE	2
38 #define LOG_FLAG_OVERRUN	4
39 #define LOG_FLAG_NOMEM		8
40 
41 #define ctcm_pr_debug(fmt, arg...) printk(KERN_DEBUG fmt, ##arg)
42 
43 #define CTCM_PR_DEBUG(fmt, arg...) \
44 	do { \
45 		if (do_debug) \
46 			printk(KERN_DEBUG fmt, ##arg); \
47 	} while (0)
48 
49 #define	CTCM_PR_DBGDATA(fmt, arg...) \
50 	do { \
51 		if (do_debug_data) \
52 			printk(KERN_DEBUG fmt, ##arg); \
53 	} while (0)
54 
55 #define	CTCM_D3_DUMP(buf, len) \
56 	do { \
57 		if (do_debug_data) \
58 			ctcmpc_dumpit(buf, len); \
59 	} while (0)
60 
61 #define	CTCM_CCW_DUMP(buf, len) \
62 	do { \
63 		if (do_debug_ccw) \
64 			ctcmpc_dumpit(buf, len); \
65 	} while (0)
66 
67 /**
68  * Enum for classifying detected devices
69  */
70 enum ctcm_channel_types {
71 	/* Device is not a channel  */
72 	ctcm_channel_type_none,
73 
74 	/* Device is a CTC/A */
75 	ctcm_channel_type_parallel,
76 
77 	/* Device is a FICON channel */
78 	ctcm_channel_type_ficon,
79 
80 	/* Device is a ESCON channel */
81 	ctcm_channel_type_escon
82 };
83 
84 /*
85  * CCW commands, used in this driver.
86  */
87 #define CCW_CMD_WRITE		0x01
88 #define CCW_CMD_READ		0x02
89 #define CCW_CMD_NOOP		0x03
90 #define CCW_CMD_TIC             0x08
91 #define CCW_CMD_SENSE_CMD	0x14
92 #define CCW_CMD_WRITE_CTL	0x17
93 #define CCW_CMD_SET_EXTENDED	0xc3
94 #define CCW_CMD_PREPARE		0xe3
95 
96 #define CTCM_PROTO_S390		0
97 #define CTCM_PROTO_LINUX	1
98 #define CTCM_PROTO_LINUX_TTY	2
99 #define CTCM_PROTO_OS390	3
100 #define CTCM_PROTO_MPC		4
101 #define CTCM_PROTO_MAX		4
102 
103 #define CTCM_STATSIZE_LIMIT	64
104 #define CTCM_BUFSIZE_LIMIT	65535
105 #define CTCM_BUFSIZE_DEFAULT	32768
106 #define MPC_BUFSIZE_DEFAULT	CTCM_BUFSIZE_LIMIT
107 
108 #define CTCM_TIME_1_SEC		1000
109 #define CTCM_TIME_5_SEC		5000
110 #define CTCM_TIME_10_SEC	10000
111 
112 #define CTCM_INITIAL_BLOCKLEN	2
113 
114 #define CTCM_READ		0
115 #define CTCM_WRITE		1
116 
117 #define CTCM_ID_SIZE		20+3
118 
119 struct ctcm_profile {
120 	unsigned long maxmulti;
121 	unsigned long maxcqueue;
122 	unsigned long doios_single;
123 	unsigned long doios_multi;
124 	unsigned long txlen;
125 	unsigned long tx_time;
126 	unsigned long send_stamp;
127 };
128 
129 /*
130  * Definition of one channel
131  */
132 struct channel {
133 	struct channel *next;
134 	char id[CTCM_ID_SIZE];
135 	struct ccw_device *cdev;
136 	/*
137 	 * Type of this channel.
138 	 * CTC/A or Escon for valid channels.
139 	 */
140 	enum ctcm_channel_types type;
141 	/*
142 	 * Misc. flags. See CHANNEL_FLAGS_... below
143 	 */
144 	__u32 flags;
145 	__u16 protocol;		/* protocol of this channel (4 = MPC) */
146 	/*
147 	 * I/O and irq related stuff
148 	 */
149 	struct ccw1 *ccw;
150 	struct irb *irb;
151 	/*
152 	 * RX/TX buffer size
153 	 */
154 	int max_bufsize;
155 	struct sk_buff *trans_skb;	/* transmit/receive buffer */
156 	struct sk_buff_head io_queue;	/* universal I/O queue */
157 	struct tasklet_struct ch_tasklet;	/* MPC ONLY */
158 	/*
159 	 * TX queue for collecting skb's during busy.
160 	 */
161 	struct sk_buff_head collect_queue;
162 	/*
163 	 * Amount of data in collect_queue.
164 	 */
165 	int collect_len;
166 	/*
167 	 * spinlock for collect_queue and collect_len
168 	 */
169 	spinlock_t collect_lock;
170 	/*
171 	 * Timer for detecting unresposive
172 	 * I/O operations.
173 	 */
174 	fsm_timer timer;
175 	/* MPC ONLY section begin */
176 	__u32	th_seq_num;	/* SNA TH seq number */
177 	__u8	th_seg;
178 	__u32	pdu_seq;
179 	struct sk_buff		*xid_skb;
180 	char			*xid_skb_data;
181 	struct th_header	*xid_th;
182 	struct xid2		*xid;
183 	char			*xid_id;
184 	struct th_header	*rcvd_xid_th;
185 	struct xid2		*rcvd_xid;
186 	char			*rcvd_xid_id;
187 	__u8			in_mpcgroup;
188 	fsm_timer		sweep_timer;
189 	struct sk_buff_head	sweep_queue;
190 	struct th_header	*discontact_th;
191 	struct tasklet_struct	ch_disc_tasklet;
192 	/* MPC ONLY section end */
193 
194 	int retry;		/* retry counter for misc. operations */
195 	fsm_instance *fsm;	/* finite state machine of this channel */
196 	struct net_device *netdev;	/* corresponding net_device */
197 	struct ctcm_profile prof;
198 	__u8 *trans_skb_data;
199 	__u16 logflags;
200 	__u8  sense_rc; /* last unit check sense code report control */
201 };
202 
203 struct ctcm_priv {
204 	struct net_device_stats	stats;
205 	unsigned long	tbusy;
206 
207 	/* The MPC group struct of this interface */
208 	struct	mpc_group	*mpcg;	/* MPC only */
209 	struct	xid2		*xid;	/* MPC only */
210 
211 	/* The finite state machine of this interface */
212 	fsm_instance *fsm;
213 
214 	/* The protocol of this device */
215 	__u16 protocol;
216 
217 	/* Timer for restarting after I/O Errors */
218 	fsm_timer	restart_timer;
219 
220 	int buffer_size;	/* ctc only */
221 
222 	struct channel *channel[2];
223 };
224 
225 int ctcm_open(struct net_device *dev);
226 int ctcm_close(struct net_device *dev);
227 
228 extern const struct attribute_group *ctcm_attr_groups[];
229 
230 /*
231  * Compatibility macros for busy handling
232  * of network devices.
233  */
ctcm_clear_busy_do(struct net_device * dev)234 static inline void ctcm_clear_busy_do(struct net_device *dev)
235 {
236 	clear_bit(0, &(((struct ctcm_priv *)dev->ml_priv)->tbusy));
237 	netif_wake_queue(dev);
238 }
239 
ctcm_clear_busy(struct net_device * dev)240 static inline void ctcm_clear_busy(struct net_device *dev)
241 {
242 	struct mpc_group *grp;
243 	grp = ((struct ctcm_priv *)dev->ml_priv)->mpcg;
244 
245 	if (!(grp && grp->in_sweep))
246 		ctcm_clear_busy_do(dev);
247 }
248 
249 
ctcm_test_and_set_busy(struct net_device * dev)250 static inline int ctcm_test_and_set_busy(struct net_device *dev)
251 {
252 	netif_stop_queue(dev);
253 	return test_and_set_bit(0,
254 			&(((struct ctcm_priv *)dev->ml_priv)->tbusy));
255 }
256 
257 extern int loglevel;
258 extern struct channel *channels;
259 
260 void ctcm_unpack_skb(struct channel *ch, struct sk_buff *pskb);
261 
262 /*
263  * Functions related to setup and device detection.
264  */
265 
ctcm_less_than(char * id1,char * id2)266 static inline int ctcm_less_than(char *id1, char *id2)
267 {
268 	unsigned long dev1, dev2;
269 
270 	id1 = id1 + 5;
271 	id2 = id2 + 5;
272 
273 	dev1 = simple_strtoul(id1, &id1, 16);
274 	dev2 = simple_strtoul(id2, &id2, 16);
275 
276 	return (dev1 < dev2);
277 }
278 
279 int ctcm_ch_alloc_buffer(struct channel *ch);
280 
ctcm_checkalloc_buffer(struct channel * ch)281 static inline int ctcm_checkalloc_buffer(struct channel *ch)
282 {
283 	if (ch->trans_skb == NULL)
284 		return ctcm_ch_alloc_buffer(ch);
285 	if (ch->flags & CHANNEL_FLAGS_BUFSIZE_CHANGED) {
286 		dev_kfree_skb(ch->trans_skb);
287 		return ctcm_ch_alloc_buffer(ch);
288 	}
289 	return 0;
290 }
291 
292 struct mpc_group *ctcmpc_init_mpc_group(struct ctcm_priv *priv);
293 
294 /* test if protocol attribute (of struct ctcm_priv or struct channel)
295  * has MPC protocol setting. Type is not checked
296  */
297 #define IS_MPC(p) ((p)->protocol == CTCM_PROTO_MPC)
298 
299 /* test if struct ctcm_priv of struct net_device has MPC protocol setting */
300 #define IS_MPCDEV(dev) IS_MPC((struct ctcm_priv *)dev->ml_priv)
301 
302 /*
303  * Definition of our link level header.
304  */
305 struct ll_header {
306 	__u16 length;
307 	__u16 type;
308 	__u16 unused;
309 };
310 #define LL_HEADER_LENGTH (sizeof(struct ll_header))
311 
312 #endif
313