1/*
2 *  linux/drivers/net/ehea/ehea_phyp.h
3 *
4 *  eHEA ethernet device driver for IBM eServer System p
5 *
6 *  (C) Copyright IBM Corp. 2006
7 *
8 *  Authors:
9 *       Christoph Raisch <raisch@de.ibm.com>
10 *       Jan-Bernd Themann <themann@de.ibm.com>
11 *       Thomas Klein <tklein@de.ibm.com>
12 *
13 *
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)
17 * any later version.
18 *
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.
23 *
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.
27 */
28
29#ifndef __EHEA_PHYP_H__
30#define __EHEA_PHYP_H__
31
32#include <linux/delay.h>
33#include <asm/hvcall.h>
34#include "ehea.h"
35#include "ehea_hw.h"
36#include "ehea_hcall.h"
37
38/* Some abbreviations used here:
39 *
40 * hcp_*  - structures, variables and functions releated to Hypervisor Calls
41 */
42
43static inline u32 get_longbusy_msecs(int long_busy_ret_code)
44{
45	switch (long_busy_ret_code) {
46	case H_LONG_BUSY_ORDER_1_MSEC:
47		return 1;
48	case H_LONG_BUSY_ORDER_10_MSEC:
49		return 10;
50	case H_LONG_BUSY_ORDER_100_MSEC:
51		return 100;
52	case H_LONG_BUSY_ORDER_1_SEC:
53		return 1000;
54	case H_LONG_BUSY_ORDER_10_SEC:
55		return 10000;
56	case H_LONG_BUSY_ORDER_100_SEC:
57		return 100000;
58	default:
59		return 1;
60	}
61}
62
63/* Notification Event Queue (NEQ) Entry bit masks */
64#define NEQE_EVENT_CODE		EHEA_BMASK_IBM(2, 7)
65#define NEQE_PORTNUM  		EHEA_BMASK_IBM(32, 47)
66#define NEQE_PORT_UP		EHEA_BMASK_IBM(16, 16)
67#define NEQE_EXTSWITCH_PORT_UP	EHEA_BMASK_IBM(17, 17)
68#define NEQE_EXTSWITCH_PRIMARY	EHEA_BMASK_IBM(18, 18)
69#define NEQE_PLID		EHEA_BMASK_IBM(16, 47)
70
71/* Notification Event Codes */
72#define EHEA_EC_PORTSTATE_CHG	0x30
73#define EHEA_EC_ADAPTER_MALFUNC	0x32
74#define EHEA_EC_PORT_MALFUNC	0x33
75
76/* Notification Event Log Register (NELR) bit masks */
77#define NELR_PORT_MALFUNC	EHEA_BMASK_IBM(61, 61)
78#define NELR_ADAPTER_MALFUNC	EHEA_BMASK_IBM(62, 62)
79#define NELR_PORTSTATE_CHG	EHEA_BMASK_IBM(63, 63)
80
81static inline void hcp_epas_ctor(struct h_epas *epas, u64 paddr_kernel,
82				 u64 paddr_user)
83{
84	/* To support 64k pages we must round to 64k page boundary */
85	epas->kernel.addr = ioremap((paddr_kernel & PAGE_MASK), PAGE_SIZE) +
86			    (paddr_kernel & ~PAGE_MASK);
87	epas->user.addr = paddr_user;
88}
89
90static inline void hcp_epas_dtor(struct h_epas *epas)
91{
92	if (epas->kernel.addr)
93		iounmap((void __iomem*)((u64)epas->kernel.addr & PAGE_MASK));
94
95	epas->user.addr = 0;
96	epas->kernel.addr = 0;
97}
98
99struct hcp_modify_qp_cb0 {
100	u64 qp_ctl_reg;		/* 00 */
101	u32 max_swqe;		/* 02 */
102	u32 max_rwqe;		/* 03 */
103	u32 port_nb;		/* 04 */
104	u32 reserved0;		/* 05 */
105	u64 qp_aer;		/* 06 */
106	u64 qp_tenure;		/* 08 */
107};
108
109/* Hcall Query/Modify Queue Pair Control Block 0 Selection Mask Bits */
110#define H_QPCB0_ALL             EHEA_BMASK_IBM(0, 5)
111#define H_QPCB0_QP_CTL_REG      EHEA_BMASK_IBM(0, 0)
112#define H_QPCB0_MAX_SWQE        EHEA_BMASK_IBM(1, 1)
113#define H_QPCB0_MAX_RWQE        EHEA_BMASK_IBM(2, 2)
114#define H_QPCB0_PORT_NB         EHEA_BMASK_IBM(3, 3)
115#define H_QPCB0_QP_AER          EHEA_BMASK_IBM(4, 4)
116#define H_QPCB0_QP_TENURE       EHEA_BMASK_IBM(5, 5)
117
118/* Queue Pair Control Register Status Bits */
119#define H_QP_CR_ENABLED		    0x8000000000000000ULL /* QP enabled */
120							  /* QP States: */
121#define H_QP_CR_STATE_RESET	    0x0000010000000000ULL /*  Reset */
122#define H_QP_CR_STATE_INITIALIZED   0x0000020000000000ULL /*  Initialized */
123#define H_QP_CR_STATE_RDY2RCV	    0x0000030000000000ULL /*  Ready to recv */
124#define H_QP_CR_STATE_RDY2SND	    0x0000050000000000ULL /*  Ready to send */
125#define H_QP_CR_STATE_ERROR	    0x0000800000000000ULL /*  Error */
126
127struct hcp_modify_qp_cb1 {
128	u32 qpn;		/* 00 */
129	u32 qp_asyn_ev_eq_nb;	/* 01 */
130	u64 sq_cq_handle;	/* 02 */
131	u64 rq_cq_handle;	/* 04 */
132	/* sgel = scatter gather element */
133	u32 sgel_nb_sq;		/* 06 */
134	u32 sgel_nb_rq1;	/* 07 */
135	u32 sgel_nb_rq2;	/* 08 */
136	u32 sgel_nb_rq3;	/* 09 */
137};
138
139/* Hcall Query/Modify Queue Pair Control Block 1 Selection Mask Bits */
140#define H_QPCB1_ALL             EHEA_BMASK_IBM(0, 7)
141#define H_QPCB1_QPN             EHEA_BMASK_IBM(0, 0)
142#define H_QPCB1_ASYN_EV_EQ_NB   EHEA_BMASK_IBM(1, 1)
143#define H_QPCB1_SQ_CQ_HANDLE    EHEA_BMASK_IBM(2, 2)
144#define H_QPCB1_RQ_CQ_HANDLE    EHEA_BMASK_IBM(3, 3)
145#define H_QPCB1_SGEL_NB_SQ      EHEA_BMASK_IBM(4, 4)
146#define H_QPCB1_SGEL_NB_RQ1     EHEA_BMASK_IBM(5, 5)
147#define H_QPCB1_SGEL_NB_RQ2     EHEA_BMASK_IBM(6, 6)
148#define H_QPCB1_SGEL_NB_RQ3     EHEA_BMASK_IBM(7, 7)
149
150struct hcp_query_ehea {
151	u32 cur_num_qps;		/* 00 */
152	u32 cur_num_cqs;		/* 01 */
153	u32 cur_num_eqs;		/* 02 */
154	u32 cur_num_mrs;		/* 03 */
155	u32 auth_level;			/* 04 */
156	u32 max_num_qps;		/* 05 */
157	u32 max_num_cqs;		/* 06 */
158	u32 max_num_eqs;		/* 07 */
159	u32 max_num_mrs;		/* 08 */
160	u32 reserved0;			/* 09 */
161	u32 int_clock_freq;		/* 10 */
162	u32 max_num_pds;		/* 11 */
163	u32 max_num_addr_handles;	/* 12 */
164	u32 max_num_cqes;		/* 13 */
165	u32 max_num_wqes;		/* 14 */
166	u32 max_num_sgel_rq1wqe;	/* 15 */
167	u32 max_num_sgel_rq2wqe;	/* 16 */
168	u32 max_num_sgel_rq3wqe;	/* 17 */
169	u32 mr_page_size;		/* 18 */
170	u32 reserved1;			/* 19 */
171	u64 max_mr_size;		/* 20 */
172	u64 reserved2;			/* 22 */
173	u32 num_ports;			/* 24 */
174	u32 reserved3;			/* 25 */
175	u32 reserved4;			/* 26 */
176	u32 reserved5;			/* 27 */
177	u64 max_mc_mac;			/* 28 */
178	u64 ehea_cap;			/* 30 */
179	u32 max_isn_per_eq;		/* 32 */
180	u32 max_num_neq;		/* 33 */
181	u64 max_num_vlan_ids;		/* 34 */
182	u32 max_num_port_group;		/* 36 */
183	u32 max_num_phys_port;		/* 37 */
184
185};
186
187/* Hcall Query/Modify Port Control Block defines */
188#define H_PORT_CB0	 0
189#define H_PORT_CB1	 1
190#define H_PORT_CB2	 2
191#define H_PORT_CB3	 3
192#define H_PORT_CB4	 4
193#define H_PORT_CB5	 5
194#define H_PORT_CB6	 6
195#define H_PORT_CB7	 7
196
197struct hcp_ehea_port_cb0 {
198	u64 port_mac_addr;
199	u64 port_rc;
200	u64 reserved0;
201	u32 port_op_state;
202	u32 port_speed;
203	u32 ext_swport_op_state;
204	u32 neg_tpf_prpf;
205	u32 num_default_qps;
206	u32 reserved1;
207	u64 default_qpn_arr[16];
208};
209
210/* Hcall Query/Modify Port Control Block 0 Selection Mask Bits */
211#define H_PORT_CB0_ALL		EHEA_BMASK_IBM(0, 7)    /* Set all bits */
212#define H_PORT_CB0_MAC		EHEA_BMASK_IBM(0, 0)    /* MAC address */
213#define H_PORT_CB0_PRC		EHEA_BMASK_IBM(1, 1)    /* Port Recv Control */
214#define H_PORT_CB0_DEFQPNARRAY	EHEA_BMASK_IBM(7, 7)    /* Default QPN Array */
215
216/*  Hcall Query Port: Returned port speed values */
217#define H_SPEED_10M_H	1	/*  10 Mbps, Half Duplex */
218#define H_SPEED_10M_F	2	/*  10 Mbps, Full Duplex */
219#define H_SPEED_100M_H	3	/* 100 Mbps, Half Duplex */
220#define H_SPEED_100M_F	4	/* 100 Mbps, Full Duplex */
221#define H_SPEED_1G_F	6	/*   1 Gbps, Full Duplex */
222#define H_SPEED_10G_F	8	/*  10 Gbps, Full Duplex */
223
224/* Port Receive Control Status Bits */
225#define PXLY_RC_VALID           EHEA_BMASK_IBM(49, 49)
226#define PXLY_RC_VLAN_XTRACT     EHEA_BMASK_IBM(50, 50)
227#define PXLY_RC_TCP_6_TUPLE     EHEA_BMASK_IBM(51, 51)
228#define PXLY_RC_UDP_6_TUPLE     EHEA_BMASK_IBM(52, 52)
229#define PXLY_RC_TCP_3_TUPLE     EHEA_BMASK_IBM(53, 53)
230#define PXLY_RC_TCP_2_TUPLE     EHEA_BMASK_IBM(54, 54)
231#define PXLY_RC_LLC_SNAP        EHEA_BMASK_IBM(55, 55)
232#define PXLY_RC_JUMBO_FRAME     EHEA_BMASK_IBM(56, 56)
233#define PXLY_RC_FRAG_IP_PKT     EHEA_BMASK_IBM(57, 57)
234#define PXLY_RC_TCP_UDP_CHKSUM  EHEA_BMASK_IBM(58, 58)
235#define PXLY_RC_IP_CHKSUM       EHEA_BMASK_IBM(59, 59)
236#define PXLY_RC_MAC_FILTER      EHEA_BMASK_IBM(60, 60)
237#define PXLY_RC_UNTAG_FILTER    EHEA_BMASK_IBM(61, 61)
238#define PXLY_RC_VLAN_TAG_FILTER EHEA_BMASK_IBM(62, 63)
239
240#define PXLY_RC_VLAN_FILTER     2
241#define PXLY_RC_VLAN_PERM       0
242
243
244#define H_PORT_CB1_ALL          0x8000000000000000ULL
245
246struct hcp_ehea_port_cb1 {
247	u64 vlan_filter[64];
248};
249
250#define H_PORT_CB2_ALL          0xFFE0000000000000ULL
251
252struct hcp_ehea_port_cb2 {
253	u64 rxo;
254	u64 rxucp;
255	u64 rxufd;
256	u64 rxuerr;
257	u64 rxftl;
258	u64 rxmcp;
259	u64 rxbcp;
260	u64 txo;
261	u64 txucp;
262	u64 txmcp;
263	u64 txbcp;
264};
265
266struct hcp_ehea_port_cb3 {
267	u64 vlan_bc_filter[64];
268	u64 vlan_mc_filter[64];
269	u64 vlan_un_filter[64];
270	u64 port_mac_hash_array[64];
271};
272
273#define H_PORT_CB4_ALL          0xF000000000000000ULL
274#define H_PORT_CB4_JUMBO        0x1000000000000000ULL
275#define H_PORT_CB4_SPEED        0x8000000000000000ULL
276
277struct hcp_ehea_port_cb4 {
278	u32 port_speed;
279	u32 pause_frame;
280	u32 ens_port_op_state;
281	u32 jumbo_frame;
282	u32 ens_port_wrap;
283};
284
285/* Hcall Query/Modify Port Control Block 5 Selection Mask Bits */
286#define H_PORT_CB5_RCU		0x0001000000000000ULL
287#define PXS_RCU			EHEA_BMASK_IBM(61, 63)
288
289struct hcp_ehea_port_cb5 {
290	u64 prc;	        /* 00 */
291	u64 uaa;		/* 01 */
292	u64 macvc;		/* 02 */
293	u64 xpcsc;		/* 03 */
294	u64 xpcsp;		/* 04 */
295	u64 pcsid;		/* 05 */
296	u64 xpcsst;		/* 06 */
297	u64 pthlb;		/* 07 */
298	u64 pthrb;		/* 08 */
299	u64 pqu;		/* 09 */
300	u64 pqd;		/* 10 */
301	u64 prt;		/* 11 */
302	u64 wsth;		/* 12 */
303	u64 rcb;		/* 13 */
304	u64 rcm;		/* 14 */
305	u64 rcu;		/* 15 */
306	u64 macc;		/* 16 */
307	u64 pc;			/* 17 */
308	u64 pst;		/* 18 */
309	u64 ducqpn;		/* 19 */
310	u64 mcqpn;		/* 20 */
311	u64 mma;		/* 21 */
312	u64 pmc0h;		/* 22 */
313	u64 pmc0l;		/* 23 */
314	u64 lbc;		/* 24 */
315};
316
317#define H_PORT_CB6_ALL  0xFFFFFE7FFFFF8000ULL
318
319struct hcp_ehea_port_cb6 {
320	u64 rxo;		/* 00 */
321	u64 rx64;		/* 01 */
322	u64 rx65;		/* 02 */
323	u64 rx128;		/* 03 */
324	u64 rx256;		/* 04 */
325	u64 rx512;		/* 05 */
326	u64 rx1024;		/* 06 */
327	u64 rxbfcs;		/* 07 */
328	u64 rxime;		/* 08 */
329	u64 rxrle;		/* 09 */
330	u64 rxorle;		/* 10 */
331	u64 rxftl;		/* 11 */
332	u64 rxjab;		/* 12 */
333	u64 rxse;		/* 13 */
334	u64 rxce;		/* 14 */
335	u64 rxrf;		/* 15 */
336	u64 rxfrag;		/* 16 */
337	u64 rxuoc;		/* 17 */
338	u64 rxcpf;		/* 18 */
339	u64 rxsb;		/* 19 */
340	u64 rxfd;		/* 20 */
341	u64 rxoerr;		/* 21 */
342	u64 rxaln;		/* 22 */
343	u64 ducqpn;		/* 23 */
344	u64 reserved0;		/* 24 */
345	u64 rxmcp;		/* 25 */
346	u64 rxbcp;		/* 26 */
347	u64 txmcp;		/* 27 */
348	u64 txbcp;		/* 28 */
349	u64 txo;		/* 29 */
350	u64 tx64;		/* 30 */
351	u64 tx65;		/* 31 */
352	u64 tx128;		/* 32 */
353	u64 tx256;		/* 33 */
354	u64 tx512;		/* 34 */
355	u64 tx1024;		/* 35 */
356	u64 txbfcs;		/* 36 */
357	u64 txcpf;		/* 37 */
358	u64 txlf;		/* 38 */
359	u64 txrf;		/* 39 */
360	u64 txime;		/* 40 */
361	u64 txsc;		/* 41 */
362	u64 txmc;		/* 42 */
363	u64 txsqe;		/* 43 */
364	u64 txdef;		/* 44 */
365	u64 txlcol;		/* 45 */
366	u64 txexcol;		/* 46 */
367	u64 txcse;		/* 47 */
368	u64 txbor;		/* 48 */
369};
370
371#define H_PORT_CB7_DUCQPN 0x8000000000000000ULL
372
373struct hcp_ehea_port_cb7 {
374	u64 def_uc_qpn;
375};
376
377u64 ehea_h_query_ehea_qp(const u64 adapter_handle,
378			 const u8 qp_category,
379			 const u64 qp_handle, const u64 sel_mask,
380			 void *cb_addr);
381
382u64 ehea_h_modify_ehea_qp(const u64 adapter_handle,
383			  const u8 cat,
384			  const u64 qp_handle,
385			  const u64 sel_mask,
386			  void *cb_addr,
387			  u64 * inv_attr_id,
388			  u64 * proc_mask, u16 * out_swr, u16 * out_rwr);
389
390u64 ehea_h_alloc_resource_eq(const u64 adapter_handle,
391			     struct ehea_eq_attr *eq_attr, u64 * eq_handle);
392
393u64 ehea_h_alloc_resource_cq(const u64 adapter_handle,
394			     struct ehea_cq_attr *cq_attr,
395			     u64 * cq_handle, struct h_epas *epas);
396
397u64 ehea_h_alloc_resource_qp(const u64 adapter_handle,
398			     struct ehea_qp_init_attr *init_attr,
399			     const u32 pd,
400			     u64 * qp_handle, struct h_epas *h_epas);
401
402#define H_REG_RPAGE_PAGE_SIZE          EHEA_BMASK_IBM(48,55)
403#define H_REG_RPAGE_QT                 EHEA_BMASK_IBM(62,63)
404
405u64 ehea_h_register_rpage(const u64 adapter_handle,
406			  const u8 pagesize,
407			  const u8 queue_type,
408			  const u64 resource_handle,
409			  const u64 log_pageaddr, u64 count);
410
411#define H_DISABLE_GET_EHEA_WQE_P  1
412#define H_DISABLE_GET_SQ_WQE_P    2
413#define H_DISABLE_GET_RQC         3
414
415u64 ehea_h_disable_and_get_hea(const u64 adapter_handle, const u64 qp_handle);
416
417#define FORCE_FREE 1
418#define NORMAL_FREE 0
419
420u64 ehea_h_free_resource(const u64 adapter_handle, const u64 res_handle,
421			 u64 force_bit);
422
423u64 ehea_h_alloc_resource_mr(const u64 adapter_handle, const u64 vaddr,
424			     const u64 length, const u32 access_ctrl,
425			     const u32 pd, u64 * mr_handle, u32 * lkey);
426
427u64 ehea_h_register_rpage_mr(const u64 adapter_handle, const u64 mr_handle,
428			     const u8 pagesize, const u8 queue_type,
429			     const u64 log_pageaddr, const u64 count);
430
431u64 ehea_h_register_smr(const u64 adapter_handle, const u64 orig_mr_handle,
432			const u64 vaddr_in, const u32 access_ctrl, const u32 pd,
433			struct ehea_mr *mr);
434
435u64 ehea_h_query_ehea(const u64 adapter_handle, void *cb_addr);
436
437/* output param R5 */
438#define H_MEHEAPORT_CAT		EHEA_BMASK_IBM(40,47)
439#define H_MEHEAPORT_PN		EHEA_BMASK_IBM(48,63)
440
441u64 ehea_h_query_ehea_port(const u64 adapter_handle, const u16 port_num,
442			   const u8 cb_cat, const u64 select_mask,
443			   void *cb_addr);
444
445u64 ehea_h_modify_ehea_port(const u64 adapter_handle, const u16 port_num,
446			    const u8 cb_cat, const u64 select_mask,
447			    void *cb_addr);
448
449#define H_REGBCMC_PN            EHEA_BMASK_IBM(48, 63)
450#define H_REGBCMC_REGTYPE       EHEA_BMASK_IBM(61, 63)
451#define H_REGBCMC_MACADDR       EHEA_BMASK_IBM(16, 63)
452#define H_REGBCMC_VLANID        EHEA_BMASK_IBM(52, 63)
453
454u64 ehea_h_reg_dereg_bcmc(const u64 adapter_handle, const u16 port_num,
455			  const u8 reg_type, const u64 mc_mac_addr,
456			  const u16 vlan_id, const u32 hcall_id);
457
458u64 ehea_h_reset_events(const u64 adapter_handle, const u64 neq_handle,
459			const u64 event_mask);
460
461u64 ehea_h_error_data(const u64 adapter_handle, const u64 ressource_handle,
462		      void *rblock);
463
464#endif	/* __EHEA_PHYP_H__ */
465