New upstream version 17.11-rc3
[deb_dpdk.git] / drivers / net / enic / base / vnic_dev.h
1 /*
2  * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
4  *
5  * Copyright (c) 2014, Cisco Systems, Inc.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  */
34
35 #ifndef _VNIC_DEV_H_
36 #define _VNIC_DEV_H_
37
38 #include <rte_pci.h>
39 #include <rte_bus_pci.h>
40
41 #include "enic_compat.h"
42 #include "vnic_resource.h"
43 #include "vnic_devcmd.h"
44
45 #ifndef VNIC_PADDR_TARGET
46 #define VNIC_PADDR_TARGET       0x0000000000000000ULL
47 #endif
48
49 #ifndef readq
50 static inline u64 readq(void __iomem *reg)
51 {
52         return ((u64)readl((char *)reg + 0x4UL) << 32) |
53                 (u64)readl(reg);
54 }
55
56 static inline void writeq(u64 val, void __iomem *reg)
57 {
58         writel(val & 0xffffffff, reg);
59         writel((u32)(val >> 32), (char *)reg + 0x4UL);
60 }
61 #endif
62
63 #undef pr_fmt
64 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
65
66 enum vnic_dev_intr_mode {
67         VNIC_DEV_INTR_MODE_UNKNOWN,
68         VNIC_DEV_INTR_MODE_INTX,
69         VNIC_DEV_INTR_MODE_MSI,
70         VNIC_DEV_INTR_MODE_MSIX,
71 };
72
73 struct vnic_dev_bar {
74         void __iomem *vaddr;
75         dma_addr_t bus_addr;
76         unsigned long len;
77 };
78
79 struct vnic_dev_ring {
80         void *descs;
81         size_t size;
82         dma_addr_t base_addr;
83         size_t base_align;
84         void *descs_unaligned;
85         size_t size_unaligned;
86         dma_addr_t base_addr_unaligned;
87         unsigned int desc_size;
88         unsigned int desc_count;
89         unsigned int desc_avail;
90 };
91
92 struct vnic_dev_iomap_info {
93         dma_addr_t bus_addr;
94         unsigned long len;
95         void __iomem *vaddr;
96 };
97
98 struct vnic_dev;
99 struct vnic_stats;
100
101 void *vnic_dev_priv(struct vnic_dev *vdev);
102 unsigned int vnic_dev_get_res_count(struct vnic_dev *vdev,
103         enum vnic_res_type type);
104 void vnic_register_cbacks(struct vnic_dev *vdev,
105         void *(*alloc_consistent)(void *priv, size_t size,
106                 dma_addr_t *dma_handle, u8 *name),
107         void (*free_consistent)(void *priv,
108                 size_t size, void *vaddr,
109                 dma_addr_t dma_handle));
110 void __iomem *vnic_dev_get_res(struct vnic_dev *vdev, enum vnic_res_type type,
111         unsigned int index);
112 dma_addr_t vnic_dev_get_res_bus_addr(struct vnic_dev *vdev,
113         enum vnic_res_type type, unsigned int index);
114 uint8_t vnic_dev_get_res_bar(struct vnic_dev *vdev,
115         enum vnic_res_type type);
116 uint32_t vnic_dev_get_res_offset(struct vnic_dev *vdev,
117         enum vnic_res_type type, unsigned int index);
118 unsigned long vnic_dev_get_res_type_len(struct vnic_dev *vdev,
119                                         enum vnic_res_type type);
120 unsigned int vnic_dev_desc_ring_size(struct vnic_dev_ring *ring,
121         unsigned int desc_count, unsigned int desc_size);
122 void vnic_dev_clear_desc_ring(struct vnic_dev_ring *ring);
123 void vnic_set_hdr_split_size(struct vnic_dev *vdev, u16 size);
124 u16 vnic_get_hdr_split_size(struct vnic_dev *vdev);
125 int vnic_dev_alloc_desc_ring(struct vnic_dev *vdev, struct vnic_dev_ring *ring,
126         unsigned int desc_count, unsigned int desc_size, unsigned int socket_id,
127         char *z_name);
128 void vnic_dev_free_desc_ring(struct vnic_dev *vdev,
129         struct vnic_dev_ring *ring);
130 int vnic_dev_cmd(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
131         u64 *a0, u64 *a1, int wait);
132 int vnic_dev_cmd_args(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
133         u64 *args, int nargs, int wait);
134 void vnic_dev_cmd_proxy_by_index_start(struct vnic_dev *vdev, u16 index);
135 void vnic_dev_cmd_proxy_by_bdf_start(struct vnic_dev *vdev, u16 bdf);
136 void vnic_dev_cmd_proxy_end(struct vnic_dev *vdev);
137 int vnic_dev_fw_info(struct vnic_dev *vdev,
138         struct vnic_devcmd_fw_info **fw_info);
139 int vnic_dev_capable_adv_filters(struct vnic_dev *vdev);
140 int vnic_dev_capable(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd);
141 int vnic_dev_capable_filter_mode(struct vnic_dev *vdev, u32 *mode,
142                                  u8 *filter_tags);
143 int vnic_dev_asic_info(struct vnic_dev *vdev, u16 *asic_type, u16 *asic_rev);
144 int vnic_dev_spec(struct vnic_dev *vdev, unsigned int offset, size_t size,
145         void *value);
146 int vnic_dev_stats_clear(struct vnic_dev *vdev);
147 int vnic_dev_stats_dump(struct vnic_dev *vdev, struct vnic_stats **stats);
148 int vnic_dev_hang_notify(struct vnic_dev *vdev);
149 int vnic_dev_packet_filter(struct vnic_dev *vdev, int directed, int multicast,
150         int broadcast, int promisc, int allmulti);
151 int vnic_dev_packet_filter_all(struct vnic_dev *vdev, int directed,
152         int multicast, int broadcast, int promisc, int allmulti);
153 int vnic_dev_add_addr(struct vnic_dev *vdev, u8 *addr);
154 int vnic_dev_del_addr(struct vnic_dev *vdev, u8 *addr);
155 int vnic_dev_get_mac_addr(struct vnic_dev *vdev, u8 *mac_addr);
156 int vnic_dev_raise_intr(struct vnic_dev *vdev, u16 intr);
157 int vnic_dev_notify_set(struct vnic_dev *vdev, u16 intr);
158 void vnic_dev_set_reset_flag(struct vnic_dev *vdev, int state);
159 int vnic_dev_notify_unset(struct vnic_dev *vdev);
160 int vnic_dev_notify_setcmd(struct vnic_dev *vdev,
161         void *notify_addr, dma_addr_t notify_pa, u16 intr);
162 int vnic_dev_notify_unsetcmd(struct vnic_dev *vdev);
163 int vnic_dev_link_status(struct vnic_dev *vdev);
164 u32 vnic_dev_port_speed(struct vnic_dev *vdev);
165 u32 vnic_dev_msg_lvl(struct vnic_dev *vdev);
166 u32 vnic_dev_mtu(struct vnic_dev *vdev);
167 u32 vnic_dev_link_down_cnt(struct vnic_dev *vdev);
168 u32 vnic_dev_notify_status(struct vnic_dev *vdev);
169 u32 vnic_dev_uif(struct vnic_dev *vdev);
170 int vnic_dev_close(struct vnic_dev *vdev);
171 int vnic_dev_enable(struct vnic_dev *vdev);
172 int vnic_dev_enable_wait(struct vnic_dev *vdev);
173 int vnic_dev_disable(struct vnic_dev *vdev);
174 int vnic_dev_open(struct vnic_dev *vdev, int arg);
175 int vnic_dev_open_done(struct vnic_dev *vdev, int *done);
176 int vnic_dev_init(struct vnic_dev *vdev, int arg);
177 int vnic_dev_init_done(struct vnic_dev *vdev, int *done, int *err);
178 int vnic_dev_init_prov(struct vnic_dev *vdev, u8 *buf, u32 len);
179 int vnic_dev_deinit(struct vnic_dev *vdev);
180 void vnic_dev_intr_coal_timer_info_default(struct vnic_dev *vdev);
181 int vnic_dev_intr_coal_timer_info(struct vnic_dev *vdev);
182 int vnic_dev_soft_reset(struct vnic_dev *vdev, int arg);
183 int vnic_dev_soft_reset_done(struct vnic_dev *vdev, int *done);
184 int vnic_dev_hang_reset(struct vnic_dev *vdev, int arg);
185 int vnic_dev_hang_reset_done(struct vnic_dev *vdev, int *done);
186 void vnic_dev_set_intr_mode(struct vnic_dev *vdev,
187         enum vnic_dev_intr_mode intr_mode);
188 enum vnic_dev_intr_mode vnic_dev_get_intr_mode(struct vnic_dev *vdev);
189 u32 vnic_dev_intr_coal_timer_usec_to_hw(struct vnic_dev *vdev, u32 usec);
190 u32 vnic_dev_intr_coal_timer_hw_to_usec(struct vnic_dev *vdev, u32 hw_cycles);
191 u32 vnic_dev_get_intr_coal_timer_max(struct vnic_dev *vdev);
192 void vnic_dev_unregister(struct vnic_dev *vdev);
193 int vnic_dev_set_ig_vlan_rewrite_mode(struct vnic_dev *vdev,
194         u8 ig_vlan_rewrite_mode);
195 struct vnic_dev *vnic_dev_register(struct vnic_dev *vdev,
196         void *priv, struct rte_pci_device *pdev, struct vnic_dev_bar *bar,
197         unsigned int num_bars);
198 struct rte_pci_device *vnic_dev_get_pdev(struct vnic_dev *vdev);
199 int vnic_dev_cmd_init(struct vnic_dev *vdev, int fallback);
200 int vnic_dev_get_size(void);
201 int vnic_dev_int13(struct vnic_dev *vdev, u64 arg, u32 op);
202 int vnic_dev_perbi(struct vnic_dev *vdev, u64 arg, u32 op);
203 u32 vnic_dev_perbi_rebuild_cnt(struct vnic_dev *vdev);
204 int vnic_dev_init_prov2(struct vnic_dev *vdev, u8 *buf, u32 len);
205 int vnic_dev_enable2(struct vnic_dev *vdev, int active);
206 int vnic_dev_enable2_done(struct vnic_dev *vdev, int *status);
207 int vnic_dev_deinit_done(struct vnic_dev *vdev, int *status);
208 int vnic_dev_set_mac_addr(struct vnic_dev *vdev, u8 *mac_addr);
209 int vnic_dev_classifier(struct vnic_dev *vdev, u8 cmd, u16 *entry,
210         struct filter_v2 *data, struct filter_action_v2 *action_v2);
211 #ifdef ENIC_VXLAN
212 int vnic_dev_overlay_offload_enable_disable(struct vnic_dev *vdev,
213         u8 overlay, u8 config);
214 int vnic_dev_overlay_offload_cfg(struct vnic_dev *vdev, u8 overlay,
215         u16 vxlan_udp_port_number);
216 #endif
217 #endif /* _VNIC_DEV_H_ */