enic: remove #ident lines
[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 "enic_compat.h"
39 #include "rte_pci.h"
40 #include "vnic_resource.h"
41 #include "vnic_devcmd.h"
42
43 #ifndef VNIC_PADDR_TARGET
44 #define VNIC_PADDR_TARGET       0x0000000000000000ULL
45 #endif
46
47 #ifndef readq
48 static inline u64 readq(void __iomem *reg)
49 {
50         return ((u64)readl((char *)reg + 0x4UL) << 32) |
51                 (u64)readl(reg);
52 }
53
54 static inline void writeq(u64 val, void __iomem *reg)
55 {
56         writel(val & 0xffffffff, reg);
57         writel((u32)(val >> 32), (char *)reg + 0x4UL);
58 }
59 #endif
60
61 #undef pr_fmt
62 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
63
64 enum vnic_dev_intr_mode {
65         VNIC_DEV_INTR_MODE_UNKNOWN,
66         VNIC_DEV_INTR_MODE_INTX,
67         VNIC_DEV_INTR_MODE_MSI,
68         VNIC_DEV_INTR_MODE_MSIX,
69 };
70
71 struct vnic_dev_bar {
72         void __iomem *vaddr;
73         dma_addr_t bus_addr;
74         unsigned long len;
75 };
76
77 struct vnic_dev_ring {
78         void *descs;
79         size_t size;
80         dma_addr_t base_addr;
81         size_t base_align;
82         void *descs_unaligned;
83         size_t size_unaligned;
84         dma_addr_t base_addr_unaligned;
85         unsigned int desc_size;
86         unsigned int desc_count;
87         unsigned int desc_avail;
88 };
89
90 struct vnic_dev_iomap_info {
91         dma_addr_t bus_addr;
92         unsigned long len;
93         void __iomem *vaddr;
94 };
95
96 struct vnic_dev;
97 struct vnic_stats;
98
99 void *vnic_dev_priv(struct vnic_dev *vdev);
100 unsigned int vnic_dev_get_res_count(struct vnic_dev *vdev,
101         enum vnic_res_type type);
102 void vnic_register_cbacks(struct vnic_dev *vdev,
103         void *(*alloc_consistent)(void *priv, size_t size,
104                 dma_addr_t *dma_handle, u8 *name),
105         void (*free_consistent)(struct rte_pci_device *hwdev,
106                 size_t size, void *vaddr,
107                 dma_addr_t dma_handle));
108 void __iomem *vnic_dev_get_res(struct vnic_dev *vdev, enum vnic_res_type type,
109         unsigned int index);
110 dma_addr_t vnic_dev_get_res_bus_addr(struct vnic_dev *vdev,
111         enum vnic_res_type type, unsigned int index);
112 uint8_t vnic_dev_get_res_bar(struct vnic_dev *vdev,
113         enum vnic_res_type type);
114 uint32_t vnic_dev_get_res_offset(struct vnic_dev *vdev,
115         enum vnic_res_type type, unsigned int index);
116 unsigned long vnic_dev_get_res_type_len(struct vnic_dev *vdev,
117                                         enum vnic_res_type type);
118 unsigned int vnic_dev_desc_ring_size(struct vnic_dev_ring *ring,
119         unsigned int desc_count, unsigned int desc_size);
120 void vnic_dev_clear_desc_ring(struct vnic_dev_ring *ring);
121 void vnic_set_hdr_split_size(struct vnic_dev *vdev, u16 size);
122 u16 vnic_get_hdr_split_size(struct vnic_dev *vdev);
123 int vnic_dev_alloc_desc_ring(struct vnic_dev *vdev, struct vnic_dev_ring *ring,
124         unsigned int desc_count, unsigned int desc_size, unsigned int socket_id,
125         char *z_name);
126 void vnic_dev_free_desc_ring(struct vnic_dev *vdev,
127         struct vnic_dev_ring *ring);
128 int vnic_dev_cmd(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
129         u64 *a0, u64 *a1, int wait);
130 int vnic_dev_cmd_args(struct vnic_dev *vdev, enum vnic_devcmd_cmd cmd,
131         u64 *args, int nargs, int wait);
132 void vnic_dev_cmd_proxy_by_index_start(struct vnic_dev *vdev, u16 index);
133 void vnic_dev_cmd_proxy_by_bdf_start(struct vnic_dev *vdev, u16 bdf);
134 void vnic_dev_cmd_proxy_end(struct vnic_dev *vdev);
135 int vnic_dev_fw_info(struct vnic_dev *vdev,
136         struct vnic_devcmd_fw_info **fw_info);
137 int vnic_dev_asic_info(struct vnic_dev *vdev, u16 *asic_type, u16 *asic_rev);
138 int vnic_dev_spec(struct vnic_dev *vdev, unsigned int offset, size_t size,
139         void *value);
140 int vnic_dev_stats_clear(struct vnic_dev *vdev);
141 int vnic_dev_stats_dump(struct vnic_dev *vdev, struct vnic_stats **stats);
142 int vnic_dev_hang_notify(struct vnic_dev *vdev);
143 int vnic_dev_packet_filter(struct vnic_dev *vdev, int directed, int multicast,
144         int broadcast, int promisc, int allmulti);
145 int vnic_dev_packet_filter_all(struct vnic_dev *vdev, int directed,
146         int multicast, int broadcast, int promisc, int allmulti);
147 int vnic_dev_add_addr(struct vnic_dev *vdev, u8 *addr);
148 int vnic_dev_del_addr(struct vnic_dev *vdev, u8 *addr);
149 int vnic_dev_get_mac_addr(struct vnic_dev *vdev, u8 *mac_addr);
150 int vnic_dev_raise_intr(struct vnic_dev *vdev, u16 intr);
151 int vnic_dev_notify_set(struct vnic_dev *vdev, u16 intr);
152 void vnic_dev_set_reset_flag(struct vnic_dev *vdev, int state);
153 int vnic_dev_notify_unset(struct vnic_dev *vdev);
154 int vnic_dev_notify_setcmd(struct vnic_dev *vdev,
155         void *notify_addr, dma_addr_t notify_pa, u16 intr);
156 int vnic_dev_notify_unsetcmd(struct vnic_dev *vdev);
157 int vnic_dev_link_status(struct vnic_dev *vdev);
158 u32 vnic_dev_port_speed(struct vnic_dev *vdev);
159 u32 vnic_dev_msg_lvl(struct vnic_dev *vdev);
160 u32 vnic_dev_mtu(struct vnic_dev *vdev);
161 u32 vnic_dev_link_down_cnt(struct vnic_dev *vdev);
162 u32 vnic_dev_notify_status(struct vnic_dev *vdev);
163 u32 vnic_dev_uif(struct vnic_dev *vdev);
164 int vnic_dev_close(struct vnic_dev *vdev);
165 int vnic_dev_enable(struct vnic_dev *vdev);
166 int vnic_dev_enable_wait(struct vnic_dev *vdev);
167 int vnic_dev_disable(struct vnic_dev *vdev);
168 int vnic_dev_open(struct vnic_dev *vdev, int arg);
169 int vnic_dev_open_done(struct vnic_dev *vdev, int *done);
170 int vnic_dev_init(struct vnic_dev *vdev, int arg);
171 int vnic_dev_init_done(struct vnic_dev *vdev, int *done, int *err);
172 int vnic_dev_init_prov(struct vnic_dev *vdev, u8 *buf, u32 len);
173 int vnic_dev_deinit(struct vnic_dev *vdev);
174 void vnic_dev_intr_coal_timer_info_default(struct vnic_dev *vdev);
175 int vnic_dev_intr_coal_timer_info(struct vnic_dev *vdev);
176 int vnic_dev_soft_reset(struct vnic_dev *vdev, int arg);
177 int vnic_dev_soft_reset_done(struct vnic_dev *vdev, int *done);
178 int vnic_dev_hang_reset(struct vnic_dev *vdev, int arg);
179 int vnic_dev_hang_reset_done(struct vnic_dev *vdev, int *done);
180 void vnic_dev_set_intr_mode(struct vnic_dev *vdev,
181         enum vnic_dev_intr_mode intr_mode);
182 enum vnic_dev_intr_mode vnic_dev_get_intr_mode(struct vnic_dev *vdev);
183 u32 vnic_dev_intr_coal_timer_usec_to_hw(struct vnic_dev *vdev, u32 usec);
184 u32 vnic_dev_intr_coal_timer_hw_to_usec(struct vnic_dev *vdev, u32 hw_cycles);
185 u32 vnic_dev_get_intr_coal_timer_max(struct vnic_dev *vdev);
186 void vnic_dev_unregister(struct vnic_dev *vdev);
187 int vnic_dev_set_ig_vlan_rewrite_mode(struct vnic_dev *vdev,
188         u8 ig_vlan_rewrite_mode);
189 struct vnic_dev *vnic_dev_register(struct vnic_dev *vdev,
190         void *priv, struct rte_pci_device *pdev, struct vnic_dev_bar *bar,
191         unsigned int num_bars);
192 struct rte_pci_device *vnic_dev_get_pdev(struct vnic_dev *vdev);
193 int vnic_dev_cmd_init(struct vnic_dev *vdev, int fallback);
194 int vnic_dev_get_size(void);
195 int vnic_dev_int13(struct vnic_dev *vdev, u64 arg, u32 op);
196 int vnic_dev_perbi(struct vnic_dev *vdev, u64 arg, u32 op);
197 u32 vnic_dev_perbi_rebuild_cnt(struct vnic_dev *vdev);
198 int vnic_dev_init_prov2(struct vnic_dev *vdev, u8 *buf, u32 len);
199 int vnic_dev_enable2(struct vnic_dev *vdev, int active);
200 int vnic_dev_enable2_done(struct vnic_dev *vdev, int *status);
201 int vnic_dev_deinit_done(struct vnic_dev *vdev, int *status);
202 int vnic_dev_set_mac_addr(struct vnic_dev *vdev, u8 *mac_addr);
203 int vnic_dev_classifier(struct vnic_dev *vdev, u8 cmd, u16 *entry,
204         struct filter *data);
205 #ifdef ENIC_VXLAN
206 int vnic_dev_overlay_offload_enable_disable(struct vnic_dev *vdev,
207         u8 overlay, u8 config);
208 int vnic_dev_overlay_offload_cfg(struct vnic_dev *vdev, u8 overlay,
209         u16 vxlan_udp_port_number);
210 #endif
211 #endif /* _VNIC_DEV_H_ */