1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16#ifndef _ISHTP_CLIENT_H_
17#define _ISHTP_CLIENT_H_
18
19#include <linux/types.h>
20#include "ishtp-dev.h"
21
22
23enum cl_state {
24 ISHTP_CL_INITIALIZING = 0,
25 ISHTP_CL_CONNECTING,
26 ISHTP_CL_CONNECTED,
27 ISHTP_CL_DISCONNECTING,
28 ISHTP_CL_DISCONNECTED
29};
30
31
32#define CL_DEF_RX_RING_SIZE 2
33#define CL_DEF_TX_RING_SIZE 2
34#define CL_MAX_RX_RING_SIZE 32
35#define CL_MAX_TX_RING_SIZE 32
36
37#define DMA_SLOT_SIZE 4096
38
39#define DMA_WORTH_THRESHOLD 3
40
41
42#define CL_TX_PATH_DEFAULT 0
43#define CL_TX_PATH_IPC 1
44#define CL_TX_PATH_DMA 2
45
46
47struct ishtp_cl_tx_ring {
48 struct list_head list;
49 struct ishtp_msg_data send_buf;
50};
51
52
53struct ishtp_cl {
54 struct list_head link;
55 struct ishtp_device *dev;
56 enum cl_state state;
57 int status;
58
59
60 struct ishtp_cl_device *device;
61
62
63 uint8_t host_client_id;
64 uint8_t fw_client_id;
65 uint8_t ishtp_flow_ctrl_creds;
66 uint8_t out_flow_ctrl_creds;
67
68
69 int last_tx_path;
70
71 int last_dma_acked;
72 unsigned char *last_dma_addr;
73
74 int last_ipc_acked;
75
76
77 unsigned int rx_ring_size;
78 struct ishtp_cl_rb free_rb_list;
79 spinlock_t free_list_spinlock;
80
81 struct ishtp_cl_rb in_process_list;
82 spinlock_t in_process_spinlock;
83
84
85 unsigned int tx_ring_size;
86 struct ishtp_cl_tx_ring tx_list, tx_free_list;
87 int tx_ring_free_size;
88 spinlock_t tx_list_spinlock;
89 spinlock_t tx_free_list_spinlock;
90 size_t tx_offs;
91
92
93
94
95
96
97
98
99
100 int sending;
101
102
103 spinlock_t fc_spinlock;
104
105
106 wait_queue_head_t wait_ctrl_res;
107
108
109 unsigned int err_send_msg;
110 unsigned int err_send_fc;
111
112
113 unsigned int send_msg_cnt_ipc;
114 unsigned int send_msg_cnt_dma;
115 unsigned int recv_msg_cnt_ipc;
116 unsigned int recv_msg_cnt_dma;
117 unsigned int recv_msg_num_frags;
118 unsigned int ishtp_flow_ctrl_cnt;
119 unsigned int out_flow_ctrl_cnt;
120
121
122 ktime_t ts_rx;
123 ktime_t ts_out_fc;
124 ktime_t ts_max_fc_delay;
125 void *client_data;
126};
127
128
129int ishtp_can_client_connect(struct ishtp_device *ishtp_dev, guid_t *uuid);
130int ishtp_fw_cl_by_id(struct ishtp_device *dev, uint8_t client_id);
131void ishtp_cl_send_msg(struct ishtp_device *dev, struct ishtp_cl *cl);
132void recv_ishtp_cl_msg(struct ishtp_device *dev,
133 struct ishtp_msg_hdr *ishtp_hdr);
134int ishtp_cl_read_start(struct ishtp_cl *cl);
135
136
137int ishtp_cl_alloc_rx_ring(struct ishtp_cl *cl);
138int ishtp_cl_alloc_tx_ring(struct ishtp_cl *cl);
139void ishtp_cl_free_rx_ring(struct ishtp_cl *cl);
140void ishtp_cl_free_tx_ring(struct ishtp_cl *cl);
141int ishtp_cl_get_tx_free_buffer_size(struct ishtp_cl *cl);
142int ishtp_cl_get_tx_free_rings(struct ishtp_cl *cl);
143
144
145void recv_ishtp_cl_msg_dma(struct ishtp_device *dev, void *msg,
146 struct dma_xfer_hbm *hbm);
147void ishtp_cl_alloc_dma_buf(struct ishtp_device *dev);
148void ishtp_cl_free_dma_buf(struct ishtp_device *dev);
149void *ishtp_cl_get_dma_send_buf(struct ishtp_device *dev,
150 uint32_t size);
151void ishtp_cl_release_dma_acked_mem(struct ishtp_device *dev,
152 void *msg_addr,
153 uint8_t size);
154
155
156struct ishtp_cl_rb *ishtp_io_rb_init(struct ishtp_cl *cl);
157void ishtp_io_rb_free(struct ishtp_cl_rb *priv_rb);
158int ishtp_io_rb_alloc_buf(struct ishtp_cl_rb *rb, size_t length);
159
160
161
162
163
164static inline bool ishtp_cl_cmp_id(const struct ishtp_cl *cl1,
165 const struct ishtp_cl *cl2)
166{
167 return cl1 && cl2 &&
168 (cl1->host_client_id == cl2->host_client_id) &&
169 (cl1->fw_client_id == cl2->fw_client_id);
170}
171
172
173struct ishtp_cl *ishtp_cl_allocate(struct ishtp_device *dev);
174void ishtp_cl_free(struct ishtp_cl *cl);
175int ishtp_cl_link(struct ishtp_cl *cl, int id);
176void ishtp_cl_unlink(struct ishtp_cl *cl);
177int ishtp_cl_disconnect(struct ishtp_cl *cl);
178int ishtp_cl_connect(struct ishtp_cl *cl);
179int ishtp_cl_send(struct ishtp_cl *cl, uint8_t *buf, size_t length);
180int ishtp_cl_flush_queues(struct ishtp_cl *cl);
181
182
183int ishtp_cl_io_rb_recycle(struct ishtp_cl_rb *rb);
184bool ishtp_cl_tx_empty(struct ishtp_cl *cl);
185struct ishtp_cl_rb *ishtp_cl_rx_get_rb(struct ishtp_cl *cl);
186
187#endif
188