xref: /OK3568_Linux_fs/kernel/drivers/net/ipa/ipa_endpoint.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun 
3*4882a593Smuzhiyun /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4*4882a593Smuzhiyun  * Copyright (C) 2019-2020 Linaro Ltd.
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun #ifndef _IPA_ENDPOINT_H_
7*4882a593Smuzhiyun #define _IPA_ENDPOINT_H_
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/types.h>
10*4882a593Smuzhiyun #include <linux/workqueue.h>
11*4882a593Smuzhiyun #include <linux/if_ether.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include "gsi.h"
14*4882a593Smuzhiyun #include "ipa_reg.h"
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun struct net_device;
17*4882a593Smuzhiyun struct sk_buff;
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun struct ipa;
20*4882a593Smuzhiyun struct ipa_gsi_endpoint_data;
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun /* Non-zero granularity of counter used to implement aggregation timeout */
23*4882a593Smuzhiyun #define IPA_AGGR_GRANULARITY		500	/* microseconds */
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun #define IPA_MTU			ETH_DATA_LEN
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun enum ipa_endpoint_name {
28*4882a593Smuzhiyun 	IPA_ENDPOINT_AP_MODEM_TX	= 0,
29*4882a593Smuzhiyun 	IPA_ENDPOINT_MODEM_LAN_TX,
30*4882a593Smuzhiyun 	IPA_ENDPOINT_MODEM_COMMAND_TX,
31*4882a593Smuzhiyun 	IPA_ENDPOINT_AP_COMMAND_TX,
32*4882a593Smuzhiyun 	IPA_ENDPOINT_MODEM_AP_TX,
33*4882a593Smuzhiyun 	IPA_ENDPOINT_AP_LAN_RX,
34*4882a593Smuzhiyun 	IPA_ENDPOINT_AP_MODEM_RX,
35*4882a593Smuzhiyun 	IPA_ENDPOINT_MODEM_AP_RX,
36*4882a593Smuzhiyun 	IPA_ENDPOINT_MODEM_LAN_RX,
37*4882a593Smuzhiyun 	IPA_ENDPOINT_COUNT,	/* Number of names (not an index) */
38*4882a593Smuzhiyun };
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun #define IPA_ENDPOINT_MAX		32	/* Max supported by driver */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /**
43*4882a593Smuzhiyun  * enum ipa_replenish_flag:	RX buffer replenish flags
44*4882a593Smuzhiyun  *
45*4882a593Smuzhiyun  * @IPA_REPLENISH_ENABLED:	Whether receive buffer replenishing is enabled
46*4882a593Smuzhiyun  * @IPA_REPLENISH_ACTIVE:	Whether replenishing is underway
47*4882a593Smuzhiyun  * @IPA_REPLENISH_COUNT:	Number of defined replenish flags
48*4882a593Smuzhiyun  */
49*4882a593Smuzhiyun enum ipa_replenish_flag {
50*4882a593Smuzhiyun 	IPA_REPLENISH_ENABLED,
51*4882a593Smuzhiyun 	IPA_REPLENISH_ACTIVE,
52*4882a593Smuzhiyun 	IPA_REPLENISH_COUNT,	/* Number of flags (must be last) */
53*4882a593Smuzhiyun };
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /**
56*4882a593Smuzhiyun  * struct ipa_endpoint - IPA endpoint information
57*4882a593Smuzhiyun  * @channel_id:	EP's GSI channel
58*4882a593Smuzhiyun  * @evt_ring_id: EP's GSI channel event ring
59*4882a593Smuzhiyun  */
60*4882a593Smuzhiyun struct ipa_endpoint {
61*4882a593Smuzhiyun 	struct ipa *ipa;
62*4882a593Smuzhiyun 	enum ipa_seq_type seq_type;
63*4882a593Smuzhiyun 	enum gsi_ee_id ee_id;
64*4882a593Smuzhiyun 	u32 channel_id;
65*4882a593Smuzhiyun 	u32 endpoint_id;
66*4882a593Smuzhiyun 	bool toward_ipa;
67*4882a593Smuzhiyun 	const struct ipa_endpoint_config_data *data;
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun 	u32 trans_tre_max;	/* maximum descriptors per transaction */
70*4882a593Smuzhiyun 	u32 evt_ring_id;
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun 	/* Net device this endpoint is associated with, if any */
73*4882a593Smuzhiyun 	struct net_device *netdev;
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun 	/* Receive buffer replenishing for RX endpoints */
76*4882a593Smuzhiyun 	DECLARE_BITMAP(replenish_flags, IPA_REPLENISH_COUNT);
77*4882a593Smuzhiyun 	u32 replenish_ready;
78*4882a593Smuzhiyun 	atomic_t replenish_saved;
79*4882a593Smuzhiyun 	atomic_t replenish_backlog;
80*4882a593Smuzhiyun 	struct delayed_work replenish_work;		/* global wq */
81*4882a593Smuzhiyun };
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun void ipa_endpoint_modem_hol_block_clear_all(struct ipa *ipa);
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun void ipa_endpoint_modem_pause_all(struct ipa *ipa, bool enable);
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun int ipa_endpoint_modem_exception_reset_all(struct ipa *ipa);
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun int ipa_endpoint_skb_tx(struct ipa_endpoint *endpoint, struct sk_buff *skb);
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun void ipa_endpoint_exit_one(struct ipa_endpoint *endpoint);
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun int ipa_endpoint_enable_one(struct ipa_endpoint *endpoint);
94*4882a593Smuzhiyun void ipa_endpoint_disable_one(struct ipa_endpoint *endpoint);
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun void ipa_endpoint_suspend_one(struct ipa_endpoint *endpoint);
97*4882a593Smuzhiyun void ipa_endpoint_resume_one(struct ipa_endpoint *endpoint);
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun void ipa_endpoint_suspend(struct ipa *ipa);
100*4882a593Smuzhiyun void ipa_endpoint_resume(struct ipa *ipa);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun void ipa_endpoint_setup(struct ipa *ipa);
103*4882a593Smuzhiyun void ipa_endpoint_teardown(struct ipa *ipa);
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun int ipa_endpoint_config(struct ipa *ipa);
106*4882a593Smuzhiyun void ipa_endpoint_deconfig(struct ipa *ipa);
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun void ipa_endpoint_default_route_set(struct ipa *ipa, u32 endpoint_id);
109*4882a593Smuzhiyun void ipa_endpoint_default_route_clear(struct ipa *ipa);
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun u32 ipa_endpoint_init(struct ipa *ipa, u32 count,
112*4882a593Smuzhiyun 		      const struct ipa_gsi_endpoint_data *data);
113*4882a593Smuzhiyun void ipa_endpoint_exit(struct ipa *ipa);
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun void ipa_endpoint_trans_complete(struct ipa_endpoint *ipa,
116*4882a593Smuzhiyun 				 struct gsi_trans *trans);
117*4882a593Smuzhiyun void ipa_endpoint_trans_release(struct ipa_endpoint *ipa,
118*4882a593Smuzhiyun 				struct gsi_trans *trans);
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun #endif /* _IPA_ENDPOINT_H_ */
121