xref: /OK3568_Linux_fs/kernel/drivers/net/ethernet/netronome/nfp/ccm.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
2*4882a593Smuzhiyun /* Copyright (C) 2016-2019 Netronome Systems, Inc. */
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun #ifndef NFP_CCM_H
5*4882a593Smuzhiyun #define NFP_CCM_H 1
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/bitmap.h>
8*4882a593Smuzhiyun #include <linux/skbuff.h>
9*4882a593Smuzhiyun #include <linux/wait.h>
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun struct nfp_app;
12*4882a593Smuzhiyun struct nfp_net;
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun /* Firmware ABI */
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun enum nfp_ccm_type {
17*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_ALLOC	= 1,
18*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_FREE	= 2,
19*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_LOOKUP	= 3,
20*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_UPDATE	= 4,
21*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_DELETE	= 5,
22*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_GETNEXT	= 6,
23*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_MAP_GETFIRST	= 7,
24*4882a593Smuzhiyun 	NFP_CCM_TYPE_BPF_BPF_EVENT	= 8,
25*4882a593Smuzhiyun 	NFP_CCM_TYPE_CRYPTO_RESET	= 9,
26*4882a593Smuzhiyun 	NFP_CCM_TYPE_CRYPTO_ADD		= 10,
27*4882a593Smuzhiyun 	NFP_CCM_TYPE_CRYPTO_DEL		= 11,
28*4882a593Smuzhiyun 	NFP_CCM_TYPE_CRYPTO_UPDATE	= 12,
29*4882a593Smuzhiyun 	NFP_CCM_TYPE_CRYPTO_RESYNC	= 13,
30*4882a593Smuzhiyun 	__NFP_CCM_TYPE_MAX,
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #define NFP_CCM_ABI_VERSION		1
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define NFP_CCM_TYPE_REPLY_BIT		7
36*4882a593Smuzhiyun #define __NFP_CCM_REPLY(req)		(BIT(NFP_CCM_TYPE_REPLY_BIT) | (req))
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun struct nfp_ccm_hdr {
39*4882a593Smuzhiyun 	union {
40*4882a593Smuzhiyun 		struct {
41*4882a593Smuzhiyun 			u8 type;
42*4882a593Smuzhiyun 			u8 ver;
43*4882a593Smuzhiyun 			__be16 tag;
44*4882a593Smuzhiyun 		};
45*4882a593Smuzhiyun 		__be32 raw;
46*4882a593Smuzhiyun 	};
47*4882a593Smuzhiyun };
48*4882a593Smuzhiyun 
nfp_ccm_get_type(struct sk_buff * skb)49*4882a593Smuzhiyun static inline u8 nfp_ccm_get_type(struct sk_buff *skb)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun 	struct nfp_ccm_hdr *hdr;
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun 	hdr = (struct nfp_ccm_hdr *)skb->data;
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	return hdr->type;
56*4882a593Smuzhiyun }
57*4882a593Smuzhiyun 
__nfp_ccm_get_tag(struct sk_buff * skb)58*4882a593Smuzhiyun static inline __be16 __nfp_ccm_get_tag(struct sk_buff *skb)
59*4882a593Smuzhiyun {
60*4882a593Smuzhiyun 	struct nfp_ccm_hdr *hdr;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	hdr = (struct nfp_ccm_hdr *)skb->data;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	return hdr->tag;
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun 
nfp_ccm_get_tag(struct sk_buff * skb)67*4882a593Smuzhiyun static inline unsigned int nfp_ccm_get_tag(struct sk_buff *skb)
68*4882a593Smuzhiyun {
69*4882a593Smuzhiyun 	return be16_to_cpu(__nfp_ccm_get_tag(skb));
70*4882a593Smuzhiyun }
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun #define NFP_NET_MBOX_TLV_TYPE		GENMASK(31, 16)
73*4882a593Smuzhiyun #define NFP_NET_MBOX_TLV_LEN		GENMASK(15, 0)
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun enum nfp_ccm_mbox_tlv_type {
76*4882a593Smuzhiyun 	NFP_NET_MBOX_TLV_TYPE_UNKNOWN	= 0,
77*4882a593Smuzhiyun 	NFP_NET_MBOX_TLV_TYPE_END	= 1,
78*4882a593Smuzhiyun 	NFP_NET_MBOX_TLV_TYPE_MSG	= 2,
79*4882a593Smuzhiyun 	NFP_NET_MBOX_TLV_TYPE_MSG_NOSUP	= 3,
80*4882a593Smuzhiyun 	NFP_NET_MBOX_TLV_TYPE_RESV	= 4,
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun /* Implementation */
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun /**
86*4882a593Smuzhiyun  * struct nfp_ccm - common control message handling
87*4882a593Smuzhiyun  * @app:		APP handle
88*4882a593Smuzhiyun  *
89*4882a593Smuzhiyun  * @tag_allocator:	bitmap of control message tags in use
90*4882a593Smuzhiyun  * @tag_alloc_next:	next tag bit to allocate
91*4882a593Smuzhiyun  * @tag_alloc_last:	next tag bit to be freed
92*4882a593Smuzhiyun  *
93*4882a593Smuzhiyun  * @replies:		received cmsg replies waiting to be consumed
94*4882a593Smuzhiyun  * @wq:			work queue for waiting for cmsg replies
95*4882a593Smuzhiyun  */
96*4882a593Smuzhiyun struct nfp_ccm {
97*4882a593Smuzhiyun 	struct nfp_app *app;
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun 	DECLARE_BITMAP(tag_allocator, U16_MAX + 1);
100*4882a593Smuzhiyun 	u16 tag_alloc_next;
101*4882a593Smuzhiyun 	u16 tag_alloc_last;
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun 	struct sk_buff_head replies;
104*4882a593Smuzhiyun 	wait_queue_head_t wq;
105*4882a593Smuzhiyun };
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun int nfp_ccm_init(struct nfp_ccm *ccm, struct nfp_app *app);
108*4882a593Smuzhiyun void nfp_ccm_clean(struct nfp_ccm *ccm);
109*4882a593Smuzhiyun void nfp_ccm_rx(struct nfp_ccm *ccm, struct sk_buff *skb);
110*4882a593Smuzhiyun struct sk_buff *
111*4882a593Smuzhiyun nfp_ccm_communicate(struct nfp_ccm *ccm, struct sk_buff *skb,
112*4882a593Smuzhiyun 		    enum nfp_ccm_type type, unsigned int reply_size);
113*4882a593Smuzhiyun 
114*4882a593Smuzhiyun int nfp_ccm_mbox_alloc(struct nfp_net *nn);
115*4882a593Smuzhiyun void nfp_ccm_mbox_free(struct nfp_net *nn);
116*4882a593Smuzhiyun int nfp_ccm_mbox_init(struct nfp_net *nn);
117*4882a593Smuzhiyun void nfp_ccm_mbox_clean(struct nfp_net *nn);
118*4882a593Smuzhiyun bool nfp_ccm_mbox_fits(struct nfp_net *nn, unsigned int size);
119*4882a593Smuzhiyun struct sk_buff *
120*4882a593Smuzhiyun nfp_ccm_mbox_msg_alloc(struct nfp_net *nn, unsigned int req_size,
121*4882a593Smuzhiyun 		       unsigned int reply_size, gfp_t flags);
122*4882a593Smuzhiyun int __nfp_ccm_mbox_communicate(struct nfp_net *nn, struct sk_buff *skb,
123*4882a593Smuzhiyun 			       enum nfp_ccm_type type,
124*4882a593Smuzhiyun 			       unsigned int reply_size,
125*4882a593Smuzhiyun 			       unsigned int max_reply_size, bool critical);
126*4882a593Smuzhiyun int nfp_ccm_mbox_communicate(struct nfp_net *nn, struct sk_buff *skb,
127*4882a593Smuzhiyun 			     enum nfp_ccm_type type,
128*4882a593Smuzhiyun 			     unsigned int reply_size,
129*4882a593Smuzhiyun 			     unsigned int max_reply_size);
130*4882a593Smuzhiyun int nfp_ccm_mbox_post(struct nfp_net *nn, struct sk_buff *skb,
131*4882a593Smuzhiyun 		      enum nfp_ccm_type type, unsigned int max_reply_size);
132*4882a593Smuzhiyun #endif
133