2 * linux/drivers/s390/net/qeth_mpc.h
4 * Linux on zSeries OSA Express and HiperSockets support
6 * Copyright 2000,2003 IBM Corporation
7 * Author(s): Utz Bacher <utz.bacher@de.ibm.com>
8 * Thomas Spatzier <tspat@de.ibm.com>
9 * Frank Pavlic <pavlic@de.ibm.com>
12 #ifndef __QETH_MPC_H__
13 #define __QETH_MPC_H__
17 #define VERSION_QETH_MPC_H "$Revision: 1.43 $"
19 extern const char *VERSION_QETH_MPC_C;
21 #define IPA_PDU_HEADER_SIZE 0x40
22 #define QETH_IPA_PDU_LEN_TOTAL(buffer) (buffer+0x0e)
23 #define QETH_IPA_PDU_LEN_PDU1(buffer) (buffer+0x26)
24 #define QETH_IPA_PDU_LEN_PDU2(buffer) (buffer+0x2a)
25 #define QETH_IPA_PDU_LEN_PDU3(buffer) (buffer+0x3a)
27 extern unsigned char IPA_PDU_HEADER[];
28 #define QETH_IPA_CMD_DEST_ADDR(buffer) (buffer+0x2c)
30 #define IPA_CMD_LENGTH (IPA_PDU_HEADER_SIZE + sizeof(struct qeth_ipa_cmd))
32 #define QETH_SEQ_NO_LENGTH 4
33 #define QETH_MPC_TOKEN_LENGTH 4
34 #define QETH_MCL_LENGTH 4
35 #define OSA_ADDR_LEN 6
37 #define QETH_TIMEOUT (10 * HZ)
38 #define QETH_IPA_TIMEOUT (45 * HZ)
39 #define QETH_IDX_COMMAND_SEQNO 0xffff0000
40 #define SR_INFO_LEN 16
42 #define QETH_CLEAR_CHANNEL_PARM -10
43 #define QETH_HALT_CHANNEL_PARM -11
45 /*****************************************************************************/
46 /* IP Assist related definitions */
47 /*****************************************************************************/
48 #define IPA_CMD_INITIATOR_HOST 0x00
49 #define IPA_CMD_INITIATOR_OSA 0x01
50 #define IPA_CMD_INITIATOR_HOST_REPLY 0x80
51 #define IPA_CMD_INITIATOR_OSA_REPLY 0x81
52 #define IPA_CMD_PRIM_VERSION_NO 0x01
54 enum qeth_card_types {
55 QETH_CARD_TYPE_UNKNOWN = 0,
56 QETH_CARD_TYPE_OSAE = 10,
57 QETH_CARD_TYPE_IQD = 1234,
58 QETH_CARD_TYPE_OSN = 11,
61 #define QETH_MPC_DIFINFO_LEN_INDICATES_LINK_TYPE 0x18
62 /* only the first two bytes are looked at in qeth_get_cardname_short */
63 enum qeth_link_types {
64 QETH_LINK_TYPE_FAST_ETH = 0x01,
65 QETH_LINK_TYPE_HSTR = 0x02,
66 QETH_LINK_TYPE_GBIT_ETH = 0x03,
67 QETH_LINK_TYPE_OSN = 0x04,
68 QETH_LINK_TYPE_10GBIT_ETH = 0x10,
69 QETH_LINK_TYPE_LANE_ETH100 = 0x81,
70 QETH_LINK_TYPE_LANE_TR = 0x82,
71 QETH_LINK_TYPE_LANE_ETH1000 = 0x83,
72 QETH_LINK_TYPE_LANE = 0x88,
73 QETH_LINK_TYPE_ATM_NATIVE = 0x90,
76 enum qeth_tr_macaddr_modes {
77 QETH_TR_MACADDR_NONCANONICAL = 0,
78 QETH_TR_MACADDR_CANONICAL = 1,
81 enum qeth_tr_broadcast_modes {
82 QETH_TR_BROADCAST_ALLRINGS = 0,
83 QETH_TR_BROADCAST_LOCAL = 1,
86 /* these values match CHECKSUM_* in include/linux/skbuff.h */
87 enum qeth_checksum_types {
88 SW_CHECKSUMMING = 0, /* TODO: set to bit flag used in IPA Command */
92 #define QETH_CHECKSUM_DEFAULT SW_CHECKSUMMING
97 #define RESET_ROUTING_FLAG 0x10 /* indicate that routing type shall be set */
98 enum qeth_routing_types {
99 NO_ROUTER = 0, /* TODO: set to bit flag used in IPA Command */
101 SECONDARY_ROUTER = 2,
102 MULTICAST_ROUTER = 3,
103 PRIMARY_CONNECTOR = 4,
104 SECONDARY_CONNECTOR = 5,
110 IPA_CMD_STARTLAN = 0x01,
111 IPA_CMD_STOPLAN = 0x02,
112 IPA_CMD_SETVMAC = 0x21,
113 IPA_CMD_DELVMAC = 0x22,
114 IPA_CMD_SETGMAC = 0x23,
115 IPA_CMD_DELGMAC = 0x24,
116 IPA_CMD_SETVLAN = 0x25,
117 IPA_CMD_DELVLAN = 0x26,
118 IPA_CMD_SETCCID = 0x41,
119 IPA_CMD_DELCCID = 0x42,
120 IPA_CMD_MODCCID = 0x43,
121 IPA_CMD_SETIP = 0xb1,
122 IPA_CMD_DELIP = 0xb7,
123 IPA_CMD_QIPASSIST = 0xb2,
124 IPA_CMD_SETASSPARMS = 0xb3,
125 IPA_CMD_SETIPM = 0xb4,
126 IPA_CMD_DELIPM = 0xb5,
127 IPA_CMD_SETRTG = 0xb6,
128 IPA_CMD_SETADAPTERPARMS = 0xb8,
129 IPA_CMD_IPFRAME = 0xb9,
130 IPA_CMD_ADD_ADDR_ENTRY = 0xc1,
131 IPA_CMD_DELETE_ADDR_ENTRY = 0xc2,
132 IPA_CMD_CREATE_ADDR = 0xc3,
133 IPA_CMD_DESTROY_ADDR = 0xc4,
134 IPA_CMD_REGISTER_LOCAL_ADDR = 0xd1,
135 IPA_CMD_UNREGISTER_LOCAL_ADDR = 0xd2,
138 enum qeth_ip_ass_cmds {
139 IPA_CMD_ASS_START = 0x0001,
140 IPA_CMD_ASS_STOP = 0x0002,
141 IPA_CMD_ASS_CONFIGURE = 0x0003,
142 IPA_CMD_ASS_ENABLE = 0x0004,
145 enum qeth_arp_process_subcmds {
146 IPA_CMD_ASS_ARP_SET_NO_ENTRIES = 0x0003,
147 IPA_CMD_ASS_ARP_QUERY_CACHE = 0x0004,
148 IPA_CMD_ASS_ARP_ADD_ENTRY = 0x0005,
149 IPA_CMD_ASS_ARP_REMOVE_ENTRY = 0x0006,
150 IPA_CMD_ASS_ARP_FLUSH_CACHE = 0x0007,
151 IPA_CMD_ASS_ARP_QUERY_INFO = 0x0104,
152 IPA_CMD_ASS_ARP_QUERY_STATS = 0x0204,
155 /* Return Codes for IPA Commands */
156 enum qeth_ipa_return_codes {
157 IPA_RC_SUCCESS = 0x0000,
158 IPA_RC_NOTSUPP = 0x0001,
159 IPA_RC_NO_ACCESS = 0x0002,
160 IPA_RC_FAILED = 0x0003,
161 IPA_RC_DATA_MISMATCH = 0xe001,
162 IPA_RC_INVALID_LAN_TYPE = 0xe003,
163 IPA_RC_INVALID_LAN_NO = 0xe004,
164 IPA_RC_IPADDR_ALREADY_REG = 0xe005,
165 IPA_RC_IPADDR_TABLE_FULL = 0xe006,
166 IPA_RC_IPADDR_ALREADY_USED = 0xe00a,
167 IPA_RC_ASSNO_NOT_SUPP = 0xe00d,
168 IPA_RC_ASSCMD_START_FAILED = 0xe00e,
169 IPA_RC_ASSCMD_PART_SUCCESS = 0xe00f,
170 IPA_RC_IPADDR_NOT_DEFINED = 0xe010,
171 IPA_RC_LAN_OFFLINE = 0xe080,
174 /* IPA function flags; each flag marks availability of respective function */
175 enum qeth_ipa_funcs {
176 IPA_ARP_PROCESSING = 0x00000001L,
177 IPA_INBOUND_CHECKSUM = 0x00000002L,
178 IPA_OUTBOUND_CHECKSUM = 0x00000004L,
179 IPA_IP_FRAGMENTATION = 0x00000008L,
180 IPA_FILTERING = 0x00000010L,
181 IPA_IPV6 = 0x00000020L,
182 IPA_MULTICASTING = 0x00000040L,
183 IPA_IP_REASSEMBLY = 0x00000080L,
184 IPA_QUERY_ARP_COUNTERS = 0x00000100L,
185 IPA_QUERY_ARP_ADDR_INFO = 0x00000200L,
186 IPA_SETADAPTERPARMS = 0x00000400L,
187 IPA_VLAN_PRIO = 0x00000800L,
188 IPA_PASSTHRU = 0x00001000L,
189 IPA_FULL_VLAN = 0x00004000L,
190 IPA_SOURCE_MAC = 0x00010000L,
191 IPA_OSA_MC_ROUTER = 0x00020000L,
192 IPA_QUERY_ARP_ASSIST = 0x00040000L,
193 IPA_INBOUND_TSO = 0x00080000L,
194 IPA_OUTBOUND_TSO = 0x00100000L,
197 /* SETIP/DELIP IPA Command: ***************************************************/
198 enum qeth_ipa_setdelip_flags {
199 QETH_IPA_SETDELIP_DEFAULT = 0x00L, /* default */
200 QETH_IPA_SETIP_VIPA_FLAG = 0x01L, /* no grat. ARP */
201 QETH_IPA_SETIP_TAKEOVER_FLAG = 0x02L, /* nofail on grat. ARP */
202 QETH_IPA_DELIP_ADDR_2_B_TAKEN_OVER = 0x20L,
203 QETH_IPA_DELIP_VIPA_FLAG = 0x40L,
204 QETH_IPA_DELIP_ADDR_NEEDS_SETIP = 0x80L,
207 /* SETADAPTER IPA Command: ****************************************************/
208 enum qeth_ipa_setadp_cmd {
209 IPA_SETADP_QUERY_COMMANDS_SUPPORTED = 0x01,
210 IPA_SETADP_ALTER_MAC_ADDRESS = 0x02,
211 IPA_SETADP_ADD_DELETE_GROUP_ADDRESS = 0x04,
212 IPA_SETADP_ADD_DELETE_FUNCTIONAL_ADDR = 0x08,
213 IPA_SETADP_SET_ADDRESSING_MODE = 0x10,
214 IPA_SETADP_SET_CONFIG_PARMS = 0x20,
215 IPA_SETADP_SET_CONFIG_PARMS_EXTENDED = 0x40,
216 IPA_SETADP_SET_BROADCAST_MODE = 0x80,
217 IPA_SETADP_SEND_OSA_MESSAGE = 0x0100,
218 IPA_SETADP_SET_SNMP_CONTROL = 0x0200,
219 IPA_SETADP_READ_SNMP_PARMS = 0x0400,
220 IPA_SETADP_WRITE_SNMP_PARMS = 0x0800,
221 IPA_SETADP_QUERY_CARD_INFO = 0x1000,
223 enum qeth_ipa_mac_ops {
224 CHANGE_ADDR_READ_MAC = 0,
225 CHANGE_ADDR_REPLACE_MAC = 1,
226 CHANGE_ADDR_ADD_MAC = 2,
227 CHANGE_ADDR_DEL_MAC = 4,
228 CHANGE_ADDR_RESET_MAC = 8,
230 enum qeth_ipa_addr_ops {
231 CHANGE_ADDR_READ_ADDR = 0,
232 CHANGE_ADDR_ADD_ADDR = 1,
233 CHANGE_ADDR_DEL_ADDR = 2,
234 CHANGE_ADDR_FLUSH_ADDR_TABLE = 4,
238 /* (SET)DELIP(M) IPA stuff ***************************************************/
239 struct qeth_ipacmd_setdelip4 {
243 } __attribute__ ((packed));
245 struct qeth_ipacmd_setdelip6 {
249 } __attribute__ ((packed));
251 struct qeth_ipacmd_setdelipm {
256 } __attribute__ ((packed));
258 struct qeth_ipacmd_layer2setdelmac {
261 } __attribute__ ((packed));
263 struct qeth_ipacmd_layer2setdelvlan {
265 } __attribute__ ((packed));
268 struct qeth_ipacmd_setassparms_hdr {
273 __u8 number_of_replies;
275 } __attribute__((packed));
277 struct qeth_arp_query_data {
282 } __attribute__((packed));
284 /* used as parameter for arp_query reply */
285 struct qeth_arp_query_info {
293 /* SETASSPARMS IPA Command: */
294 struct qeth_ipacmd_setassparms {
295 struct qeth_ipacmd_setassparms_hdr hdr;
298 struct qeth_arp_cache_entry add_arp_entry;
299 struct qeth_arp_query_data query_arp;
302 } __attribute__ ((packed));
305 /* SETRTG IPA Command: ****************************************************/
306 struct qeth_set_routing {
310 /* SETADAPTERPARMS IPA Command: *******************************************/
311 struct qeth_query_cmds_supp {
312 __u32 no_lantypes_supp;
315 __u32 supported_cmds;
317 } __attribute__ ((packed));
319 struct qeth_change_addr {
323 __u8 addr[OSA_ADDR_LEN];
324 } __attribute__ ((packed));
327 struct qeth_snmp_cmd {
335 } __attribute__ ((packed));
337 struct qeth_snmp_ureq_hdr {
342 } __attribute__ ((packed));
344 struct qeth_snmp_ureq {
345 struct qeth_snmp_ureq_hdr hdr;
346 struct qeth_snmp_cmd cmd;
347 } __attribute__((packed));
349 struct qeth_ipacmd_setadpparms_hdr {
359 } __attribute__ ((packed));
361 struct qeth_ipacmd_setadpparms {
362 struct qeth_ipacmd_setadpparms_hdr hdr;
364 struct qeth_query_cmds_supp query_cmds_supp;
365 struct qeth_change_addr change_addr;
366 struct qeth_snmp_cmd snmp;
369 } __attribute__ ((packed));
371 /* IPFRAME IPA Command: ***************************************************/
372 /* TODO: define in analogy to commands define above */
374 /* ADD_ADDR_ENTRY IPA Command: ********************************************/
375 /* TODO: define in analogy to commands define above */
377 /* DELETE_ADDR_ENTRY IPA Command: *****************************************/
378 /* TODO: define in analogy to commands define above */
380 /* CREATE_ADDR IPA Command: ***********************************************/
381 struct qeth_create_destroy_address {
383 } __attribute__ ((packed));
385 /* REGISTER_LOCAL_ADDR IPA Command: ***************************************/
386 /* TODO: define in analogy to commands define above */
388 /* UNREGISTER_LOCAL_ADDR IPA Command: *************************************/
389 /* TODO: define in analogy to commands define above */
391 /* Header for each IPA command */
392 struct qeth_ipacmd_hdr {
399 __u8 prim_version_no;
404 } __attribute__ ((packed));
406 /* The IPA command itself */
407 struct qeth_ipa_cmd {
408 struct qeth_ipacmd_hdr hdr;
410 struct qeth_ipacmd_setdelip4 setdelip4;
411 struct qeth_ipacmd_setdelip6 setdelip6;
412 struct qeth_ipacmd_setdelipm setdelipm;
413 struct qeth_ipacmd_setassparms setassparms;
414 struct qeth_ipacmd_layer2setdelmac setdelmac;
415 struct qeth_ipacmd_layer2setdelvlan setdelvlan;
416 struct qeth_create_destroy_address create_destroy_addr;
417 struct qeth_ipacmd_setadpparms setadapterparms;
418 struct qeth_set_routing setrtg;
420 } __attribute__ ((packed));
423 * special command for ARP processing.
424 * this is not included in setassparms command before, because we get
425 * problem with the size of struct qeth_ipacmd_setassparms otherwise
427 enum qeth_ipa_arp_return_codes {
428 QETH_IPA_ARP_RC_SUCCESS = 0x0000,
429 QETH_IPA_ARP_RC_FAILED = 0x0001,
430 QETH_IPA_ARP_RC_NOTSUPP = 0x0002,
431 QETH_IPA_ARP_RC_OUT_OF_RANGE = 0x0003,
432 QETH_IPA_ARP_RC_Q_NOTSUPP = 0x0004,
433 QETH_IPA_ARP_RC_Q_NO_DATA = 0x0008,
436 #define QETH_SETASS_BASE_LEN (sizeof(struct qeth_ipacmd_hdr) + \
437 sizeof(struct qeth_ipacmd_setassparms_hdr))
438 #define QETH_IPA_ARP_DATA_POS(buffer) (buffer + IPA_PDU_HEADER_SIZE + \
439 QETH_SETASS_BASE_LEN)
440 #define QETH_SETADP_BASE_LEN (sizeof(struct qeth_ipacmd_hdr) + \
441 sizeof(struct qeth_ipacmd_setadpparms_hdr))
442 #define QETH_SNMP_SETADP_CMDLENGTH 16
444 #define QETH_ARP_DATA_SIZE 3968
445 #define QETH_ARP_CMD_LEN (QETH_ARP_DATA_SIZE + 8)
446 /* Helper functions */
447 #define IS_IPA_REPLY(cmd) ((cmd->hdr.initiator == IPA_CMD_INITIATOR_HOST) || \
448 (cmd->hdr.initiator == IPA_CMD_INITIATOR_OSA_REPLY))
450 /*****************************************************************************/
451 /* END OF IP Assist related definitions */
452 /*****************************************************************************/
455 extern unsigned char WRITE_CCW[];
456 extern unsigned char READ_CCW[];
458 extern unsigned char CM_ENABLE[];
459 #define CM_ENABLE_SIZE 0x63
460 #define QETH_CM_ENABLE_ISSUER_RM_TOKEN(buffer) (buffer+0x2c)
461 #define QETH_CM_ENABLE_FILTER_TOKEN(buffer) (buffer+0x53)
462 #define QETH_CM_ENABLE_USER_DATA(buffer) (buffer+0x5b)
464 #define QETH_CM_ENABLE_RESP_FILTER_TOKEN(buffer) \
465 (PDU_ENCAPSULATION(buffer)+ 0x13)
468 extern unsigned char CM_SETUP[];
469 #define CM_SETUP_SIZE 0x64
470 #define QETH_CM_SETUP_DEST_ADDR(buffer) (buffer+0x2c)
471 #define QETH_CM_SETUP_CONNECTION_TOKEN(buffer) (buffer+0x51)
472 #define QETH_CM_SETUP_FILTER_TOKEN(buffer) (buffer+0x5a)
474 #define QETH_CM_SETUP_RESP_DEST_ADDR(buffer) \
475 (PDU_ENCAPSULATION(buffer) + 0x1a)
477 extern unsigned char ULP_ENABLE[];
478 #define ULP_ENABLE_SIZE 0x6b
479 #define QETH_ULP_ENABLE_LINKNUM(buffer) (buffer+0x61)
480 #define QETH_ULP_ENABLE_DEST_ADDR(buffer) (buffer+0x2c)
481 #define QETH_ULP_ENABLE_FILTER_TOKEN(buffer) (buffer+0x53)
482 #define QETH_ULP_ENABLE_PORTNAME_AND_LL(buffer) (buffer+0x62)
483 #define QETH_ULP_ENABLE_RESP_FILTER_TOKEN(buffer) \
484 (PDU_ENCAPSULATION(buffer) + 0x13)
485 #define QETH_ULP_ENABLE_RESP_MAX_MTU(buffer) \
486 (PDU_ENCAPSULATION(buffer)+ 0x1f)
487 #define QETH_ULP_ENABLE_RESP_DIFINFO_LEN(buffer) \
488 (PDU_ENCAPSULATION(buffer) + 0x17)
489 #define QETH_ULP_ENABLE_RESP_LINK_TYPE(buffer) \
490 (PDU_ENCAPSULATION(buffer)+ 0x2b)
491 /* Layer 2 defintions */
492 #define QETH_PROT_LAYER2 0x08
493 #define QETH_PROT_TCPIP 0x03
494 #define QETH_PROT_OSN2 0x0a
495 #define QETH_ULP_ENABLE_PROT_TYPE(buffer) (buffer+0x50)
496 #define QETH_IPA_CMD_PROT_TYPE(buffer) (buffer+0x19)
498 extern unsigned char ULP_SETUP[];
499 #define ULP_SETUP_SIZE 0x6c
500 #define QETH_ULP_SETUP_DEST_ADDR(buffer) (buffer+0x2c)
501 #define QETH_ULP_SETUP_CONNECTION_TOKEN(buffer) (buffer+0x51)
502 #define QETH_ULP_SETUP_FILTER_TOKEN(buffer) (buffer+0x5a)
503 #define QETH_ULP_SETUP_CUA(buffer) (buffer+0x68)
504 #define QETH_ULP_SETUP_REAL_DEVADDR(buffer) (buffer+0x6a)
506 #define QETH_ULP_SETUP_RESP_CONNECTION_TOKEN(buffer) \
507 (PDU_ENCAPSULATION(buffer)+0x1a)
510 extern unsigned char DM_ACT[];
511 #define DM_ACT_SIZE 0x55
512 #define QETH_DM_ACT_DEST_ADDR(buffer) (buffer+0x2c)
513 #define QETH_DM_ACT_CONNECTION_TOKEN(buffer) (buffer+0x51)
517 #define QETH_TRANSPORT_HEADER_SEQ_NO(buffer) (buffer+4)
518 #define QETH_PDU_HEADER_SEQ_NO(buffer) (buffer+0x1c)
519 #define QETH_PDU_HEADER_ACK_SEQ_NO(buffer) (buffer+0x20)
521 extern unsigned char IDX_ACTIVATE_READ[];
522 extern unsigned char IDX_ACTIVATE_WRITE[];
524 #define IDX_ACTIVATE_SIZE 0x22
525 #define QETH_IDX_ACT_ISSUER_RM_TOKEN(buffer) (buffer+0x0c)
526 #define QETH_IDX_NO_PORTNAME_REQUIRED(buffer) ((buffer)[0x0b]&0x80)
527 #define QETH_IDX_ACT_FUNC_LEVEL(buffer) (buffer+0x10)
528 #define QETH_IDX_ACT_DATASET_NAME(buffer) (buffer+0x16)
529 #define QETH_IDX_ACT_QDIO_DEV_CUA(buffer) (buffer+0x1e)
530 #define QETH_IDX_ACT_QDIO_DEV_REALADDR(buffer) (buffer+0x20)
531 #define QETH_IS_IDX_ACT_POS_REPLY(buffer) (((buffer)[0x08]&3)==2)
532 #define QETH_IDX_REPLY_LEVEL(buffer) (buffer+0x12)
534 #define PDU_ENCAPSULATION(buffer) \
535 (buffer + *(buffer + (*(buffer+0x0b)) + \
536 *(buffer + *(buffer+0x0b)+0x11) +0x07))
538 #define IS_IPA(buffer) \
540 ( *(buffer + ((*(buffer+0x0b))+4) )==0xc1) )
542 #define ADDR_FRAME_TYPE_DIX 1
543 #define ADDR_FRAME_TYPE_802_3 2
544 #define ADDR_FRAME_TYPE_TR_WITHOUT_SR 0x10
545 #define ADDR_FRAME_TYPE_TR_WITH_SR 0x20