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