2 * linux/drivers/net/ehea/ehea.h
4 * eHEA ethernet device driver for IBM eServer System p
6 * (C) Copyright IBM Corp. 2006
9 * Christoph Raisch <raisch@de.ibm.com>
10 * Jan-Bernd Themann <themann@de.ibm.com>
11 * Thomas Klein <tklein@de.ibm.com>
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2, or (at your option)
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
32 #include <linux/module.h>
33 #include <linux/ethtool.h>
34 #include <linux/vmalloc.h>
35 #include <linux/if_vlan.h>
37 #include <asm/ibmebus.h>
38 #include <asm/abs_addr.h>
41 #define DRV_NAME "ehea"
42 #define DRV_VERSION "EHEA_0034"
44 #define EHEA_MSG_DEFAULT (NETIF_MSG_LINK | NETIF_MSG_TIMER \
45 | NETIF_MSG_RX_ERR | NETIF_MSG_TX_ERR)
47 #define EHEA_MAX_ENTRIES_RQ1 32767
48 #define EHEA_MAX_ENTRIES_RQ2 16383
49 #define EHEA_MAX_ENTRIES_RQ3 16383
50 #define EHEA_MAX_ENTRIES_SQ 32767
51 #define EHEA_MIN_ENTRIES_QP 127
53 #define EHEA_SMALL_QUEUES
54 #define EHEA_NUM_TX_QP 1
56 #ifdef EHEA_SMALL_QUEUES
57 #define EHEA_MAX_CQE_COUNT 1023
58 #define EHEA_DEF_ENTRIES_SQ 1023
59 #define EHEA_DEF_ENTRIES_RQ1 4095
60 #define EHEA_DEF_ENTRIES_RQ2 1023
61 #define EHEA_DEF_ENTRIES_RQ3 1023
63 #define EHEA_MAX_CQE_COUNT 4080
64 #define EHEA_DEF_ENTRIES_SQ 4080
65 #define EHEA_DEF_ENTRIES_RQ1 8160
66 #define EHEA_DEF_ENTRIES_RQ2 2040
67 #define EHEA_DEF_ENTRIES_RQ3 2040
70 #define EHEA_MAX_ENTRIES_EQ 20
77 #define EHEA_MAX_PACKET_SIZE 9022 /* for jumbo frames */
78 #define EHEA_RQ2_PKT_SIZE 1522
79 #define EHEA_L_PKT_SIZE 256 /* low latency */
81 #define EHEA_POLL_MAX_RWQE 1000
83 /* Send completion signaling */
84 #define EHEA_SIG_IV_LONG 1
86 /* Protection Domain Identifier */
87 #define EHEA_PD_ID 0xaabcdeff
89 #define EHEA_RQ2_THRESHOLD 1
90 #define EHEA_RQ3_THRESHOLD 9 /* use RQ3 threshold of 1522 bytes */
92 #define EHEA_SPEED_10G 10000
93 #define EHEA_SPEED_1G 1000
94 #define EHEA_SPEED_100M 100
95 #define EHEA_SPEED_10M 10
96 #define EHEA_SPEED_AUTONEG 0
98 /* Broadcast/Multicast registration types */
99 #define EHEA_BCMC_SCOPE_ALL 0x08
100 #define EHEA_BCMC_SCOPE_SINGLE 0x00
101 #define EHEA_BCMC_MULTICAST 0x04
102 #define EHEA_BCMC_BROADCAST 0x00
103 #define EHEA_BCMC_UNTAGGED 0x02
104 #define EHEA_BCMC_TAGGED 0x00
105 #define EHEA_BCMC_VLANID_ALL 0x01
106 #define EHEA_BCMC_VLANID_SINGLE 0x00
108 /* Use this define to kmallocate pHYP control blocks */
109 #define H_CB_ALIGNMENT 4096
111 #define EHEA_CACHE_LINE 128
114 #define EHEA_MR_MAX_TX_PAGES 20
115 #define EHEA_MR_TX_DATA_PN 3
116 #define EHEA_MR_ACC_CTRL 0x00800000
117 #define EHEA_RWQES_PER_MR_RQ2 10
118 #define EHEA_RWQES_PER_MR_RQ3 10
120 #define EHEA_WATCH_DOG_TIMEOUT 10*HZ
122 /* utility functions */
124 #define ehea_info(fmt, args...) \
125 printk(KERN_INFO DRV_NAME ": " fmt "\n", ## args)
127 #define ehea_error(fmt, args...) \
128 printk(KERN_ERR DRV_NAME ": Error in %s: " fmt "\n", __func__, ## args)
131 #define ehea_debug(fmt, args...) \
132 printk(KERN_DEBUG DRV_NAME ": " fmt, ## args)
134 #define ehea_debug(fmt, args...) do {} while (0)
137 void ehea_dump(void *adr, int len, char *msg);
139 #define EHEA_BMASK(pos, length) (((pos) << 16) + (length))
141 #define EHEA_BMASK_IBM(from, to) (((63 - to) << 16) + ((to) - (from) + 1))
143 #define EHEA_BMASK_SHIFTPOS(mask) (((mask) >> 16) & 0xffff)
145 #define EHEA_BMASK_MASK(mask) \
146 (0xffffffffffffffffULL >> ((64 - (mask)) & 0xffff))
148 #define EHEA_BMASK_SET(mask, value) \
149 ((EHEA_BMASK_MASK(mask) & ((u64)(value))) << EHEA_BMASK_SHIFTPOS(mask))
151 #define EHEA_BMASK_GET(mask, value) \
152 (EHEA_BMASK_MASK(mask) & (((u64)(value)) >> EHEA_BMASK_SHIFTPOS(mask)))
158 u8 entries[PAGE_SIZE];
162 * Generic queue in linux kernel virtual memory
165 u64 current_q_offset; /* current queue entry */
166 struct ehea_page **queue_pages; /* array of pages belonging to queue */
167 u32 qe_size; /* queue entry size */
168 u32 queue_length; /* queue length allocated in bytes */
170 u32 toggle_state; /* toggle flag - per page */
171 u32 reserved; /* 64 bit alignment */
175 * For pSeries this is a 64bit memory address where
176 * I/O memory is mapped into CPU address space
187 struct h_epa kernel; /* kernel space accessible resource,
188 set to 0 if unused */
189 struct h_epa_user user; /* user space accessible resource
190 set to 0 if unused */
200 * Queue attributes passed to ehea_create_qp()
202 struct ehea_qp_init_attr {
203 /* input parameter */
204 u32 qp_token; /* queue token */
206 u8 signalingtype; /* cqe generation flag */
207 u8 rq_count; /* num of receive queues */
208 u8 eqe_gen; /* eqe generation flag */
209 u16 max_nr_send_wqes; /* max number of send wqes */
210 u16 max_nr_rwqes_rq1; /* max number of receive wqes */
211 u16 max_nr_rwqes_rq2;
212 u16 max_nr_rwqes_rq3;
217 u8 swqe_imm_data_len; /* immediate data length for swqes */
225 /* output parameter */
227 u16 act_nr_send_wqes;
228 u16 act_nr_rwqes_rq1;
229 u16 act_nr_rwqes_rq2;
230 u16 act_nr_rwqes_rq3;
231 u8 act_wqe_size_enc_sq;
232 u8 act_wqe_size_enc_rq1;
233 u8 act_wqe_size_enc_rq2;
234 u8 act_wqe_size_enc_rq3;
246 * Event Queue attributes, passed as paramter
248 struct ehea_eq_attr {
251 u8 eqe_gen; /* generate eqe flag */
255 u32 ist1; /* Interrupt service token */
266 struct ehea_adapter *adapter;
267 struct hw_queue hw_queue;
271 struct ehea_eq_attr attr;
278 struct ehea_adapter *adapter;
279 u64 fw_handle; /* QP handle for firmware calls */
280 struct hw_queue hw_squeue;
281 struct hw_queue hw_rqueue1;
282 struct hw_queue hw_rqueue2;
283 struct hw_queue hw_rqueue3;
285 struct ehea_qp_init_attr init_attr;
289 * Completion Queue attributes
291 struct ehea_cq_attr {
292 /* input parameter */
297 /* output parameter */
306 struct ehea_adapter *adapter;
308 struct hw_queue hw_queue;
310 struct ehea_cq_attr attr;
323 * Port state information
326 int poll_max_processed;
327 int poll_receive_errors;
338 #define EHEA_IRQ_NAME_SIZE 20
343 struct ehea_q_skb_arr {
344 struct sk_buff **arr; /* skb array for queue */
345 int len; /* array length */
346 int index; /* array index */
347 int os_skbs; /* rq2/rq3 only: outstanding skbs */
353 struct ehea_port_res {
354 struct ehea_mr send_mr; /* send memory region */
355 struct ehea_mr recv_mr; /* receive memory region */
356 spinlock_t xmit_lock;
357 struct ehea_port *port;
358 char int_recv_name[EHEA_IRQ_NAME_SIZE];
359 char int_send_name[EHEA_IRQ_NAME_SIZE];
361 struct ehea_cq *send_cq;
362 struct ehea_cq *recv_cq;
363 struct ehea_eq *send_eq;
364 struct ehea_eq *recv_eq;
365 spinlock_t send_lock;
366 struct ehea_q_skb_arr rq1_skba;
367 struct ehea_q_skb_arr rq2_skba;
368 struct ehea_q_skb_arr rq3_skba;
369 struct ehea_q_skb_arr sq_skba;
370 spinlock_t netif_queue;
378 struct tasklet_struct send_comp_task;
379 spinlock_t recv_lock;
380 struct port_state p_state;
386 struct ehea_adapter {
389 struct ehea_port *port[16];
390 struct ehea_eq *neq; /* notification event queue */
391 struct workqueue_struct *ehea_wq;
392 struct tasklet_struct neq_tasklet;
394 u32 pd; /* protection domain */
395 u64 max_mc_mac; /* max number of multicast mac addresses */
399 struct ehea_mc_list {
400 struct list_head list;
404 #define EHEA_PORT_UP 1
405 #define EHEA_PORT_DOWN 0
406 #define EHEA_MAX_PORT_RES 16
408 struct ehea_adapter *adapter; /* adapter that owns this port */
409 struct net_device *netdev;
410 struct net_device_stats stats;
411 struct ehea_port_res port_res[EHEA_MAX_PORT_RES];
412 struct device_node *of_dev_node; /* Open Firmware Device Node */
413 struct ehea_mc_list *mc_list; /* Multicast MAC addresses */
414 struct vlan_group *vgrp;
415 struct ehea_eq *qp_eq;
416 struct work_struct reset_task;
417 struct semaphore port_lock;
418 char int_aff_name[EHEA_IRQ_NAME_SIZE];
419 int allmulti; /* Indicates IFF_ALLMULTI state */
420 int promisc; /* Indicates IFF_PROMISC state */
434 struct port_res_cfg {
444 void ehea_set_ethtool_ops(struct net_device *netdev);
445 int ehea_sense_port_attr(struct ehea_port *port);
446 int ehea_set_portspeed(struct ehea_port *port, u32 port_speed);
448 #endif /* __EHEA_H__ */