1/*******************************************************************************
  2 *
  3 * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
  4 * Copyright(c) 2013 Intel Corporation.
  5 *
  6 * This program is free software; you can redistribute it and/or modify it
  7 * under the terms and conditions of the GNU General Public License,
  8 * version 2, as published by the Free Software Foundation.
  9 *
 10 * This program is distributed in the hope it will be useful, but WITHOUT
 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 12 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 13 * more details.
 14 *
 15 * The full GNU General Public License is included in this distribution in
 16 * the file called "COPYING".
 17 *
 18 * Contact Information:
 19 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
 20 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 21 *
 22 ******************************************************************************/
 23
 24#ifndef _I40E_LAN_HMC_H_
 25#define _I40E_LAN_HMC_H_
 26
 27/* forward-declare the HW struct for the compiler */
 28struct i40e_hw;
 29
 30/* HMC element context information */
 31
 32/* Rx queue context data */
 33struct i40e_hmc_obj_rxq {
 34	u16 head;
 35	u8  cpuid;
 36	u64 base;
 37	u16 qlen;
 38#define I40E_RXQ_CTX_DBUFF_SHIFT 7
 39	u8  dbuff;
 40#define I40E_RXQ_CTX_HBUFF_SHIFT 6
 41	u8  hbuff;
 42	u8  dtype;
 43	u8  dsize;
 44	u8  crcstrip;
 45	u8  fc_ena;
 46	u8  l2tsel;
 47	u8  hsplit_0;
 48	u8  hsplit_1;
 49	u8  showiv;
 50	u16 rxmax;
 51	u8  tphrdesc_ena;
 52	u8  tphwdesc_ena;
 53	u8  tphdata_ena;
 54	u8  tphhead_ena;
 55	u8  lrxqthresh;
 56};
 57
 58/* Tx queue context data */
 59struct i40e_hmc_obj_txq {
 60	u16 head;
 61	u8  new_context;
 62	u64 base;
 63	u8  fc_ena;
 64	u8  timesync_ena;
 65	u8  fd_ena;
 66	u8  alt_vlan_ena;
 67	u16 thead_wb;
 68	u16 cpuid;
 69	u8  head_wb_ena;
 70	u16 qlen;
 71	u8  tphrdesc_ena;
 72	u8  tphrpacket_ena;
 73	u8  tphwdesc_ena;
 74	u64 head_wb_addr;
 75	u32 crc;
 76	u16 rdylist;
 77	u8  rdylist_act;
 78};
 79
 80/* for hsplit_0 field of Rx HMC context */
 81enum i40e_hmc_obj_rx_hsplit_0 {
 82	I40E_HMC_OBJ_RX_HSPLIT_0_NO_SPLIT      = 0,
 83	I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_L2      = 1,
 84	I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_IP      = 2,
 85	I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_TCP_UDP = 4,
 86	I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_SCTP    = 8,
 87};
 88
 89/* fcoe_cntx and fcoe_filt are for debugging purpose only */
 90struct i40e_hmc_obj_fcoe_cntx {
 91	u32 rsv[32];
 92};
 93
 94struct i40e_hmc_obj_fcoe_filt {
 95	u32 rsv[8];
 96};
 97
 98/* Context sizes for LAN objects */
 99enum i40e_hmc_lan_object_size {
100	I40E_HMC_LAN_OBJ_SZ_8   = 0x3,
101	I40E_HMC_LAN_OBJ_SZ_16  = 0x4,
102	I40E_HMC_LAN_OBJ_SZ_32  = 0x5,
103	I40E_HMC_LAN_OBJ_SZ_64  = 0x6,
104	I40E_HMC_LAN_OBJ_SZ_128 = 0x7,
105	I40E_HMC_LAN_OBJ_SZ_256 = 0x8,
106	I40E_HMC_LAN_OBJ_SZ_512 = 0x9,
107};
108
109#define I40E_HMC_L2OBJ_BASE_ALIGNMENT 512
110#define I40E_HMC_OBJ_SIZE_TXQ         128
111#define I40E_HMC_OBJ_SIZE_RXQ         32
112#define I40E_HMC_OBJ_SIZE_FCOE_CNTX   128
113#define I40E_HMC_OBJ_SIZE_FCOE_FILT   64
114
115enum i40e_hmc_lan_rsrc_type {
116	I40E_HMC_LAN_FULL  = 0,
117	I40E_HMC_LAN_TX    = 1,
118	I40E_HMC_LAN_RX    = 2,
119	I40E_HMC_FCOE_CTX  = 3,
120	I40E_HMC_FCOE_FILT = 4,
121	I40E_HMC_LAN_MAX   = 5
122};
123
124enum i40e_hmc_model {
125	I40E_HMC_MODEL_DIRECT_PREFERRED = 0,
126	I40E_HMC_MODEL_DIRECT_ONLY      = 1,
127	I40E_HMC_MODEL_PAGED_ONLY       = 2,
128	I40E_HMC_MODEL_UNKNOWN,
129};
130
131struct i40e_hmc_lan_create_obj_info {
132	struct i40e_hmc_info *hmc_info;
133	u32 rsrc_type;
134	u32 start_idx;
135	u32 count;
136	enum i40e_sd_entry_type entry_type;
137	u64 direct_mode_sz;
138};
139
140struct i40e_hmc_lan_delete_obj_info {
141	struct i40e_hmc_info *hmc_info;
142	u32 rsrc_type;
143	u32 start_idx;
144	u32 count;
145};
146
147i40e_status i40e_init_lan_hmc(struct i40e_hw *hw, u32 txq_num,
148					u32 rxq_num, u32 fcoe_cntx_num,
149					u32 fcoe_filt_num);
150i40e_status i40e_configure_lan_hmc(struct i40e_hw *hw,
151					     enum i40e_hmc_model model);
152i40e_status i40e_shutdown_lan_hmc(struct i40e_hw *hw);
153
154i40e_status i40e_clear_lan_tx_queue_context(struct i40e_hw *hw,
155						      u16 queue);
156i40e_status i40e_set_lan_tx_queue_context(struct i40e_hw *hw,
157						    u16 queue,
158						    struct i40e_hmc_obj_txq *s);
159i40e_status i40e_clear_lan_rx_queue_context(struct i40e_hw *hw,
160						      u16 queue);
161i40e_status i40e_set_lan_rx_queue_context(struct i40e_hw *hw,
162						    u16 queue,
163						    struct i40e_hmc_obj_rxq *s);
164
165#endif /* _I40E_LAN_HMC_H_ */