xref: /OK3568_Linux_fs/kernel/drivers/infiniband/hw/usnic/usnic_vnic.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) 2013, Cisco Systems, Inc. All rights reserved.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * This software is available to you under a choice of one of two
5*4882a593Smuzhiyun  * licenses.  You may choose to be licensed under the terms of the GNU
6*4882a593Smuzhiyun  * General Public License (GPL) Version 2, available from the file
7*4882a593Smuzhiyun  * COPYING in the main directory of this source tree, or the
8*4882a593Smuzhiyun  * BSD license below:
9*4882a593Smuzhiyun  *
10*4882a593Smuzhiyun  *     Redistribution and use in source and binary forms, with or
11*4882a593Smuzhiyun  *     without modification, are permitted provided that the following
12*4882a593Smuzhiyun  *     conditions are met:
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *      - Redistributions of source code must retain the above
15*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
16*4882a593Smuzhiyun  *        disclaimer.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  *      - Redistributions in binary form must reproduce the above
19*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
20*4882a593Smuzhiyun  *        disclaimer in the documentation and/or other materials
21*4882a593Smuzhiyun  *        provided with the distribution.
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24*4882a593Smuzhiyun  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25*4882a593Smuzhiyun  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26*4882a593Smuzhiyun  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27*4882a593Smuzhiyun  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28*4882a593Smuzhiyun  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29*4882a593Smuzhiyun  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30*4882a593Smuzhiyun  * SOFTWARE.
31*4882a593Smuzhiyun  *
32*4882a593Smuzhiyun  */
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #ifndef USNIC_VNIC_H_
35*4882a593Smuzhiyun #define USNIC_VNIC_H_
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun #include <linux/pci.h>
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun #include "vnic_dev.h"
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun /*                      =USNIC_VNIC_RES_TYPE= =VNIC_RES=   =DESC= */
42*4882a593Smuzhiyun #define USNIC_VNIC_RES_TYPES \
43*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES_AT(EOL, RES_TYPE_EOL, "EOL", 0) \
44*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES(WQ, RES_TYPE_WQ, "WQ") \
45*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES(RQ, RES_TYPE_RQ, "RQ") \
46*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES(CQ, RES_TYPE_CQ, "CQ") \
47*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES(INTR, RES_TYPE_INTR_CTRL, "INT") \
48*4882a593Smuzhiyun 	DEFINE_USNIC_VNIC_RES(MAX, RES_TYPE_MAX, "MAX")\
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun #define DEFINE_USNIC_VNIC_RES_AT(usnic_vnic_res_t, vnic_res_type, desc, val) \
51*4882a593Smuzhiyun 	USNIC_VNIC_RES_TYPE_##usnic_vnic_res_t = val,
52*4882a593Smuzhiyun #define DEFINE_USNIC_VNIC_RES(usnic_vnic_res_t, vnic_res_type, desc) \
53*4882a593Smuzhiyun 	USNIC_VNIC_RES_TYPE_##usnic_vnic_res_t,
54*4882a593Smuzhiyun enum usnic_vnic_res_type {
55*4882a593Smuzhiyun 	USNIC_VNIC_RES_TYPES
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun #undef DEFINE_USNIC_VNIC_RES
58*4882a593Smuzhiyun #undef DEFINE_USNIC_VNIC_RES_AT
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun struct usnic_vnic_res {
61*4882a593Smuzhiyun 	enum usnic_vnic_res_type	type;
62*4882a593Smuzhiyun 	unsigned int			vnic_idx;
63*4882a593Smuzhiyun 	struct usnic_vnic		*vnic;
64*4882a593Smuzhiyun 	void __iomem			*ctrl;
65*4882a593Smuzhiyun 	void				*owner;
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun struct usnic_vnic_res_chunk {
69*4882a593Smuzhiyun 	enum usnic_vnic_res_type	type;
70*4882a593Smuzhiyun 	int				cnt;
71*4882a593Smuzhiyun 	int				free_cnt;
72*4882a593Smuzhiyun 	struct usnic_vnic_res		**res;
73*4882a593Smuzhiyun 	struct usnic_vnic		*vnic;
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun struct usnic_vnic_res_desc {
77*4882a593Smuzhiyun 	enum usnic_vnic_res_type	type;
78*4882a593Smuzhiyun 	uint16_t			cnt;
79*4882a593Smuzhiyun };
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun struct usnic_vnic_res_spec {
82*4882a593Smuzhiyun 	struct usnic_vnic_res_desc resources[USNIC_VNIC_RES_TYPE_MAX];
83*4882a593Smuzhiyun };
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun const char *usnic_vnic_res_type_to_str(enum usnic_vnic_res_type res_type);
86*4882a593Smuzhiyun const char *usnic_vnic_pci_name(struct usnic_vnic *vnic);
87*4882a593Smuzhiyun int usnic_vnic_dump(struct usnic_vnic *vnic, char *buf, int buf_sz,
88*4882a593Smuzhiyun 			void *hdr_obj,
89*4882a593Smuzhiyun 			int (*printtitle)(void *, char*, int),
90*4882a593Smuzhiyun 			int (*printcols)(char *, int),
91*4882a593Smuzhiyun 			int (*printrow)(void *, char *, int));
92*4882a593Smuzhiyun void usnic_vnic_res_spec_update(struct usnic_vnic_res_spec *spec,
93*4882a593Smuzhiyun 				enum usnic_vnic_res_type trgt_type,
94*4882a593Smuzhiyun 				u16 cnt);
95*4882a593Smuzhiyun int usnic_vnic_res_spec_satisfied(const struct usnic_vnic_res_spec *min_spec,
96*4882a593Smuzhiyun 					struct usnic_vnic_res_spec *res_spec);
97*4882a593Smuzhiyun int usnic_vnic_spec_dump(char *buf, int buf_sz,
98*4882a593Smuzhiyun 				struct usnic_vnic_res_spec *res_spec);
99*4882a593Smuzhiyun int usnic_vnic_check_room(struct usnic_vnic *vnic,
100*4882a593Smuzhiyun 				struct usnic_vnic_res_spec *res_spec);
101*4882a593Smuzhiyun int usnic_vnic_res_cnt(struct usnic_vnic *vnic,
102*4882a593Smuzhiyun 				enum usnic_vnic_res_type type);
103*4882a593Smuzhiyun int usnic_vnic_res_free_cnt(struct usnic_vnic *vnic,
104*4882a593Smuzhiyun 				enum usnic_vnic_res_type type);
105*4882a593Smuzhiyun struct usnic_vnic_res_chunk *
106*4882a593Smuzhiyun usnic_vnic_get_resources(struct usnic_vnic *vnic,
107*4882a593Smuzhiyun 				enum usnic_vnic_res_type type,
108*4882a593Smuzhiyun 				int cnt,
109*4882a593Smuzhiyun 				void *owner);
110*4882a593Smuzhiyun void usnic_vnic_put_resources(struct usnic_vnic_res_chunk *chunk);
111*4882a593Smuzhiyun struct pci_dev *usnic_vnic_get_pdev(struct usnic_vnic *vnic);
112*4882a593Smuzhiyun struct vnic_dev_bar *usnic_vnic_get_bar(struct usnic_vnic *vnic,
113*4882a593Smuzhiyun 				int bar_num);
114*4882a593Smuzhiyun struct usnic_vnic *usnic_vnic_alloc(struct pci_dev *pdev);
115*4882a593Smuzhiyun void usnic_vnic_free(struct usnic_vnic *vnic);
116*4882a593Smuzhiyun u16 usnic_vnic_get_index(struct usnic_vnic *vnic);
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun #endif /*!USNIC_VNIC_H_*/
119