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.35 $"
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 -1
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_HYDRA 0x01
50 #define IPA_CMD_PRIM_VERSION_NO 0x01
52 enum qeth_card_types {
53 QETH_CARD_TYPE_UNKNOWN = 0,
54 QETH_CARD_TYPE_OSAE = 10,
55 QETH_CARD_TYPE_IQD = 1234,
58 #define QETH_MPC_DIFINFO_LEN_INDICATES_LINK_TYPE 0x18
59 /* only the first two bytes are looked at in qeth_get_cardname_short */
60 enum qeth_link_types {
61 QETH_LINK_TYPE_FAST_ETH = 0x01,
62 QETH_LINK_TYPE_HSTR = 0x02,
63 QETH_LINK_TYPE_GBIT_ETH = 0x03,
64 QETH_LINK_TYPE_10GBIT_ETH = 0x10,
65 QETH_LINK_TYPE_LANE_ETH100 = 0x81,
66 QETH_LINK_TYPE_LANE_TR = 0x82,
67 QETH_LINK_TYPE_LANE_ETH1000 = 0x83,
68 QETH_LINK_TYPE_LANE = 0x88,
69 QETH_LINK_TYPE_ATM_NATIVE = 0x90,
72 enum qeth_tr_macaddr_modes {
73 QETH_TR_MACADDR_NONCANONICAL = 0,
74 QETH_TR_MACADDR_CANONICAL = 1,
77 enum qeth_tr_broadcast_modes {
78 QETH_TR_BROADCAST_ALLRINGS = 0,
79 QETH_TR_BROADCAST_LOCAL = 1,
82 /* these values match CHECKSUM_* in include/linux/skbuff.h */
83 enum qeth_checksum_types {
84 SW_CHECKSUMMING = 0, /* TODO: set to bit flag used in IPA Command */
88 #define QETH_CHECKSUM_DEFAULT SW_CHECKSUMMING
93 #define RESET_ROUTING_FLAG 0x10 /* indicate that routing type shall be set */
94 enum qeth_routing_types {
95 NO_ROUTER = 0, /* TODO: set to bit flag used in IPA Command */
99 PRIMARY_CONNECTOR = 4,
100 SECONDARY_CONNECTOR = 5,
106 IPA_CMD_STARTLAN = 0x01,
107 IPA_CMD_STOPLAN = 0x02,
108 IPA_CMD_SETIP = 0xb1,
109 IPA_CMD_DELIP = 0xb7,
110 IPA_CMD_QIPASSIST = 0xb2,
111 IPA_CMD_SETASSPARMS = 0xb3,
112 IPA_CMD_SETIPM = 0xb4,
113 IPA_CMD_DELIPM = 0xb5,
114 IPA_CMD_SETRTG = 0xb6,
115 IPA_CMD_SETADAPTERPARMS = 0xb8,
116 IPA_CMD_IPFRAME = 0xb9,
117 IPA_CMD_ADD_ADDR_ENTRY = 0xc1,
118 IPA_CMD_DELETE_ADDR_ENTRY = 0xc2,
119 IPA_CMD_CREATE_ADDR = 0xc3,
120 IPA_CMD_DESTROY_ADDR = 0xc4,
121 IPA_CMD_REGISTER_LOCAL_ADDR = 0xd1,
122 IPA_CMD_UNREGISTER_LOCAL_ADDR = 0xd2,
125 enum qeth_ip_ass_cmds {
126 IPA_CMD_ASS_START = 0x0001,
127 IPA_CMD_ASS_STOP = 0x0002,
128 IPA_CMD_ASS_CONFIGURE = 0x0003,
129 IPA_CMD_ASS_ENABLE = 0x0004,
132 enum qeth_arp_process_subcmds {
133 IPA_CMD_ASS_ARP_SET_NO_ENTRIES = 0x0003,
134 IPA_CMD_ASS_ARP_QUERY_CACHE = 0x0004,
135 IPA_CMD_ASS_ARP_ADD_ENTRY = 0x0005,
136 IPA_CMD_ASS_ARP_REMOVE_ENTRY = 0x0006,
137 IPA_CMD_ASS_ARP_FLUSH_CACHE = 0x0007,
138 IPA_CMD_ASS_ARP_QUERY_INFO = 0x0104,
139 IPA_CMD_ASS_ARP_QUERY_STATS = 0x0204,
142 /* Return Codes for IPA Commands */
143 enum qeth_ipa_return_codes {
144 IPA_RC_SUCCESS = 0x0000,
145 IPA_RC_NOTSUPP = 0x0001,
146 IPA_RC_NO_ACCESS = 0x0002,
147 IPA_RC_FAILED = 0x0003,
148 IPA_RC_DATA_MISMATCH = 0xe001,
149 IPA_RC_INVALID_LAN_TYPE = 0xe003,
150 IPA_RC_INVALID_LAN_NO = 0xe004,
151 IPA_RC_IPADDR_ALREADY_REG = 0xe005,
152 IPA_RC_IPADDR_TABLE_FULL = 0xe006,
153 IPA_RC_IPADDR_ALREADY_USED = 0xe00a,
154 IPA_RC_ASSNO_NOT_SUPP = 0xe00d,
155 IPA_RC_ASSCMD_START_FAILED = 0xe00e,
156 IPA_RC_ASSCMD_PART_SUCCESS = 0xe00f,
157 IPA_RC_IPADDR_NOT_DEFINED = 0xe010,
158 IPA_RC_LAN_OFFLINE = 0xe080,
161 /* IPA function flags; each flag marks availability of respective function */
162 enum qeth_ipa_funcs {
163 IPA_ARP_PROCESSING = 0x00000001L,
164 IPA_INBOUND_CHECKSUM = 0x00000002L,
165 IPA_OUTBOUND_CHECKSUM = 0x00000004L,
166 IPA_IP_FRAGMENTATION = 0x00000008L,
167 IPA_FILTERING = 0x00000010L,
168 IPA_IPV6 = 0x00000020L,
169 IPA_MULTICASTING = 0x00000040L,
170 IPA_IP_REASSEMBLY = 0x00000080L,
171 IPA_QUERY_ARP_COUNTERS = 0x00000100L,
172 IPA_QUERY_ARP_ADDR_INFO = 0x00000200L,
173 IPA_SETADAPTERPARMS = 0x00000400L,
174 IPA_VLAN_PRIO = 0x00000800L,
175 IPA_PASSTHRU = 0x00001000L,
176 IPA_FULL_VLAN = 0x00004000L,
177 IPA_SOURCE_MAC = 0x00010000L,
178 IPA_OSA_MC_ROUTER = 0x00020000L,
181 /* SETIP/DELIP IPA Command: ***************************************************/
182 enum qeth_ipa_setdelip_flags {
183 QETH_IPA_SETDELIP_DEFAULT = 0x00L, /* default */
184 QETH_IPA_SETIP_VIPA_FLAG = 0x01L, /* no grat. ARP */
185 QETH_IPA_SETIP_TAKEOVER_FLAG = 0x02L, /* nofail on grat. ARP */
186 QETH_IPA_DELIP_ADDR_2_B_TAKEN_OVER = 0x20L,
187 QETH_IPA_DELIP_VIPA_FLAG = 0x40L,
188 QETH_IPA_DELIP_ADDR_NEEDS_SETIP = 0x80L,
191 /* SETADAPTER IPA Command: ****************************************************/
192 enum qeth_ipa_setadp_cmd {
193 IPA_SETADP_QUERY_COMMANDS_SUPPORTED = 0x01,
194 IPA_SETADP_ALTER_MAC_ADDRESS = 0x02,
195 IPA_SETADP_ADD_DELETE_GROUP_ADDRESS = 0x04,
196 IPA_SETADP_ADD_DELETE_FUNCTIONAL_ADDR = 0x08,
197 IPA_SETADP_SET_ADDRESSING_MODE = 0x10,
198 IPA_SETADP_SET_CONFIG_PARMS = 0x20,
199 IPA_SETADP_SET_CONFIG_PARMS_EXTENDED = 0x40,
200 IPA_SETADP_SET_BROADCAST_MODE = 0x80,
201 IPA_SETADP_SEND_OSA_MESSAGE = 0x0100,
202 IPA_SETADP_SET_SNMP_CONTROL = 0x0200,
203 IPA_SETADP_READ_SNMP_PARMS = 0x0400,
204 IPA_SETADP_WRITE_SNMP_PARMS = 0x0800,
205 IPA_SETADP_QUERY_CARD_INFO = 0x1000,
207 enum qeth_ipa_mac_ops {
208 CHANGE_ADDR_READ_MAC = 0,
209 CHANGE_ADDR_REPLACE_MAC = 1,
210 CHANGE_ADDR_ADD_MAC = 2,
211 CHANGE_ADDR_DEL_MAC = 4,
212 CHANGE_ADDR_RESET_MAC = 8,
214 enum qeth_ipa_addr_ops {
215 CHANGE_ADDR_READ_ADDR = 0,
216 CHANGE_ADDR_ADD_ADDR = 1,
217 CHANGE_ADDR_DEL_ADDR = 2,
218 CHANGE_ADDR_FLUSH_ADDR_TABLE = 4,
222 /* (SET)DELIP(M) IPA stuff ***************************************************/
223 struct qeth_ipacmd_setdelip4 {
227 } __attribute__ ((packed));
229 struct qeth_ipacmd_setdelip6 {
233 } __attribute__ ((packed));
235 struct qeth_ipacmd_setdelipm {
240 } __attribute__ ((packed));
242 struct qeth_ipacmd_setassparms_hdr {
247 __u8 number_of_replies;
249 } __attribute__((packed));
251 struct qeth_arp_query_data {
256 } __attribute__((packed));
258 /* used as parameter for arp_query reply */
259 struct qeth_arp_query_info {
267 /* SETASSPARMS IPA Command: */
268 struct qeth_ipacmd_setassparms {
269 struct qeth_ipacmd_setassparms_hdr hdr;
272 struct qeth_arp_cache_entry add_arp_entry;
273 struct qeth_arp_query_data query_arp;
276 } __attribute__ ((packed));
279 /* SETRTG IPA Command: ****************************************************/
280 struct qeth_set_routing {
284 /* SETADAPTERPARMS IPA Command: *******************************************/
285 struct qeth_query_cmds_supp {
286 __u32 no_lantypes_supp;
289 __u32 supported_cmds;
291 } __attribute__ ((packed));
293 struct qeth_change_addr {
297 __u8 addr[OSA_ADDR_LEN];
298 } __attribute__ ((packed));
301 struct qeth_snmp_cmd {
309 } __attribute__ ((packed));
311 struct qeth_snmp_ureq_hdr {
316 } __attribute__ ((packed));
318 struct qeth_snmp_ureq {
319 struct qeth_snmp_ureq_hdr hdr;
320 struct qeth_snmp_cmd cmd;
321 } __attribute__((packed));
323 struct qeth_ipacmd_setadpparms_hdr {
333 } __attribute__ ((packed));
335 struct qeth_ipacmd_setadpparms {
336 struct qeth_ipacmd_setadpparms_hdr hdr;
338 struct qeth_query_cmds_supp query_cmds_supp;
339 struct qeth_change_addr change_addr;
340 struct qeth_snmp_cmd snmp;
343 } __attribute__ ((packed));
345 /* IPFRAME IPA Command: ***************************************************/
346 /* TODO: define in analogy to commands define above */
348 /* ADD_ADDR_ENTRY IPA Command: ********************************************/
349 /* TODO: define in analogy to commands define above */
351 /* DELETE_ADDR_ENTRY IPA Command: *****************************************/
352 /* TODO: define in analogy to commands define above */
354 /* CREATE_ADDR IPA Command: ***********************************************/
355 struct qeth_create_destroy_address {
357 } __attribute__ ((packed));
359 /* REGISTER_LOCAL_ADDR IPA Command: ***************************************/
360 /* TODO: define in analogy to commands define above */
362 /* UNREGISTER_LOCAL_ADDR IPA Command: *************************************/
363 /* TODO: define in analogy to commands define above */
365 /* Header for each IPA command */
366 struct qeth_ipacmd_hdr {
373 __u8 prim_version_no;
378 } __attribute__ ((packed));
380 /* The IPA command itself */
381 struct qeth_ipa_cmd {
382 struct qeth_ipacmd_hdr hdr;
384 struct qeth_ipacmd_setdelip4 setdelip4;
385 struct qeth_ipacmd_setdelip6 setdelip6;
386 struct qeth_ipacmd_setdelipm setdelipm;
387 struct qeth_ipacmd_setassparms setassparms;
388 struct qeth_create_destroy_address create_destroy_addr;
389 struct qeth_ipacmd_setadpparms setadapterparms;
390 struct qeth_set_routing setrtg;
392 } __attribute__ ((packed));
395 * special command for ARP processing.
396 * this is not included in setassparms command before, because we get
397 * problem with the size of struct qeth_ipacmd_setassparms otherwise
399 enum qeth_ipa_arp_return_codes {
400 QETH_IPA_ARP_RC_SUCCESS = 0x0000,
401 QETH_IPA_ARP_RC_FAILED = 0x0001,
402 QETH_IPA_ARP_RC_NOTSUPP = 0x0002,
403 QETH_IPA_ARP_RC_OUT_OF_RANGE = 0x0003,
404 QETH_IPA_ARP_RC_Q_NOTSUPP = 0x0004,
405 QETH_IPA_ARP_RC_Q_NO_DATA = 0x0008,
408 #define QETH_SETASS_BASE_LEN (sizeof(struct qeth_ipacmd_hdr) + \
409 sizeof(struct qeth_ipacmd_setassparms_hdr))
410 #define QETH_IPA_ARP_DATA_POS(buffer) (buffer + IPA_PDU_HEADER_SIZE + \
411 QETH_SETASS_BASE_LEN)
412 #define QETH_SETADP_BASE_LEN (sizeof(struct qeth_ipacmd_hdr) + \
413 sizeof(struct qeth_ipacmd_setadpparms_hdr))
414 #define QETH_SNMP_SETADP_CMDLENGTH 16
416 #define QETH_ARP_DATA_SIZE 3968
417 #define QETH_ARP_CMD_LEN (QETH_ARP_DATA_SIZE + 8)
418 /* Helper functions */
419 #define IS_IPA_REPLY(cmd) (cmd->hdr.initiator == IPA_CMD_INITIATOR_HOST)
421 /*****************************************************************************/
422 /* END OF IP Assist related definitions */
423 /*****************************************************************************/
426 extern unsigned char WRITE_CCW[];
427 extern unsigned char READ_CCW[];
429 extern unsigned char CM_ENABLE[];
430 #define CM_ENABLE_SIZE 0x63
431 #define QETH_CM_ENABLE_ISSUER_RM_TOKEN(buffer) (buffer+0x2c)
432 #define QETH_CM_ENABLE_FILTER_TOKEN(buffer) (buffer+0x53)
433 #define QETH_CM_ENABLE_USER_DATA(buffer) (buffer+0x5b)
435 #define QETH_CM_ENABLE_RESP_FILTER_TOKEN(buffer) \
436 (PDU_ENCAPSULATION(buffer)+ 0x13)
439 extern unsigned char CM_SETUP[];
440 #define CM_SETUP_SIZE 0x64
441 #define QETH_CM_SETUP_DEST_ADDR(buffer) (buffer+0x2c)
442 #define QETH_CM_SETUP_CONNECTION_TOKEN(buffer) (buffer+0x51)
443 #define QETH_CM_SETUP_FILTER_TOKEN(buffer) (buffer+0x5a)
445 #define QETH_CM_SETUP_RESP_DEST_ADDR(buffer) \
446 (PDU_ENCAPSULATION(buffer) + 0x1a)
448 extern unsigned char ULP_ENABLE[];
449 #define ULP_ENABLE_SIZE 0x6b
450 #define QETH_ULP_ENABLE_LINKNUM(buffer) (buffer+0x61)
451 #define QETH_ULP_ENABLE_DEST_ADDR(buffer) (buffer+0x2c)
452 #define QETH_ULP_ENABLE_FILTER_TOKEN(buffer) (buffer+0x53)
453 #define QETH_ULP_ENABLE_PORTNAME_AND_LL(buffer) (buffer+0x62)
454 #define QETH_ULP_ENABLE_RESP_FILTER_TOKEN(buffer) \
455 (PDU_ENCAPSULATION(buffer) + 0x13)
456 #define QETH_ULP_ENABLE_RESP_MAX_MTU(buffer) \
457 (PDU_ENCAPSULATION(buffer)+ 0x1f)
458 #define QETH_ULP_ENABLE_RESP_DIFINFO_LEN(buffer) \
459 (PDU_ENCAPSULATION(buffer) + 0x17)
460 #define QETH_ULP_ENABLE_RESP_LINK_TYPE(buffer) \
461 (PDU_ENCAPSULATION(buffer)+ 0x2b)
463 extern unsigned char ULP_SETUP[];
464 #define ULP_SETUP_SIZE 0x6c
465 #define QETH_ULP_SETUP_DEST_ADDR(buffer) (buffer+0x2c)
466 #define QETH_ULP_SETUP_CONNECTION_TOKEN(buffer) (buffer+0x51)
467 #define QETH_ULP_SETUP_FILTER_TOKEN(buffer) (buffer+0x5a)
468 #define QETH_ULP_SETUP_CUA(buffer) (buffer+0x68)
469 #define QETH_ULP_SETUP_REAL_DEVADDR(buffer) (buffer+0x6a)
471 #define QETH_ULP_SETUP_RESP_CONNECTION_TOKEN(buffer) \
472 (PDU_ENCAPSULATION(buffer)+0x1a)
475 extern unsigned char DM_ACT[];
476 #define DM_ACT_SIZE 0x55
477 #define QETH_DM_ACT_DEST_ADDR(buffer) (buffer+0x2c)
478 #define QETH_DM_ACT_CONNECTION_TOKEN(buffer) (buffer+0x51)
482 #define QETH_TRANSPORT_HEADER_SEQ_NO(buffer) (buffer+4)
483 #define QETH_PDU_HEADER_SEQ_NO(buffer) (buffer+0x1c)
484 #define QETH_PDU_HEADER_ACK_SEQ_NO(buffer) (buffer+0x20)
486 extern unsigned char IDX_ACTIVATE_READ[];
487 extern unsigned char IDX_ACTIVATE_WRITE[];
489 #define IDX_ACTIVATE_SIZE 0x22
490 #define QETH_IDX_ACT_ISSUER_RM_TOKEN(buffer) (buffer+0x0c)
491 #define QETH_IDX_NO_PORTNAME_REQUIRED(buffer) ((buffer)[0x0b]&0x80)
492 #define QETH_IDX_ACT_FUNC_LEVEL(buffer) (buffer+0x10)
493 #define QETH_IDX_ACT_DATASET_NAME(buffer) (buffer+0x16)
494 #define QETH_IDX_ACT_QDIO_DEV_CUA(buffer) (buffer+0x1e)
495 #define QETH_IDX_ACT_QDIO_DEV_REALADDR(buffer) (buffer+0x20)
496 #define QETH_IS_IDX_ACT_POS_REPLY(buffer) (((buffer)[0x08]&3)==2)
497 #define QETH_IDX_REPLY_LEVEL(buffer) (buffer+0x12)
499 #define PDU_ENCAPSULATION(buffer) \
500 (buffer + *(buffer + (*(buffer+0x0b)) + \
501 *(buffer + *(buffer+0x0b)+0x11) +0x07))
503 #define IS_IPA(buffer) \
505 ( *(buffer + ((*(buffer+0x0b))+4) )==0xc1) )
507 #define ADDR_FRAME_TYPE_DIX 1
508 #define ADDR_FRAME_TYPE_802_3 2
509 #define ADDR_FRAME_TYPE_TR_WITHOUT_SR 0x10
510 #define ADDR_FRAME_TYPE_TR_WITH_SR 0x20