Commit | Line | Data |
---|---|---|
fb9987d0 S |
1 | /* |
2 | * Copyright (c) 2010 Atheros Communications Inc. | |
3 | * | |
4 | * Permission to use, copy, modify, and/or distribute this software for any | |
5 | * purpose with or without fee is hereby granted, provided that the above | |
6 | * copyright notice and this permission notice appear in all copies. | |
7 | * | |
8 | * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
9 | * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
10 | * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
11 | * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
12 | * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
13 | * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
14 | * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
15 | */ | |
16 | ||
17 | #ifndef HTC_HST_H | |
18 | #define HTC_HST_H | |
19 | ||
20 | struct ath9k_htc_priv; | |
21 | struct htc_target; | |
22 | struct ath9k_htc_tx_ctl; | |
23 | ||
24 | enum ath9k_hif_transports { | |
25 | ATH9K_HIF_USB, | |
26 | }; | |
27 | ||
28 | struct ath9k_htc_hif { | |
29 | struct list_head list; | |
30 | const enum ath9k_hif_transports transport; | |
31 | const char *name; | |
32 | ||
33 | u8 control_dl_pipe; | |
34 | u8 control_ul_pipe; | |
35 | ||
36 | void (*start) (void *hif_handle, u8 pipe); | |
37 | void (*stop) (void *hif_handle, u8 pipe); | |
38 | int (*send) (void *hif_handle, u8 pipe, struct sk_buff *buf, | |
39 | struct ath9k_htc_tx_ctl *tx_ctl); | |
40 | }; | |
41 | ||
42 | enum htc_endpoint_id { | |
43 | ENDPOINT_UNUSED = -1, | |
44 | ENDPOINT0 = 0, | |
45 | ENDPOINT1 = 1, | |
46 | ENDPOINT2 = 2, | |
47 | ENDPOINT3 = 3, | |
48 | ENDPOINT4 = 4, | |
49 | ENDPOINT5 = 5, | |
50 | ENDPOINT6 = 6, | |
51 | ENDPOINT7 = 7, | |
52 | ENDPOINT8 = 8, | |
53 | ENDPOINT_MAX = 22 | |
54 | }; | |
55 | ||
56 | /* Htc frame hdr flags */ | |
57 | #define HTC_FLAGS_RECV_TRAILER (1 << 1) | |
58 | ||
59 | struct htc_frame_hdr { | |
60 | u8 endpoint_id; | |
61 | u8 flags; | |
7f1f5a00 | 62 | __be16 payload_len; |
fb9987d0 S |
63 | u8 control[4]; |
64 | } __packed; | |
65 | ||
66 | struct htc_ready_msg { | |
7f1f5a00 S |
67 | __be16 message_id; |
68 | __be16 credits; | |
69 | __be16 credit_size; | |
fb9987d0 S |
70 | u8 max_endpoints; |
71 | u8 pad; | |
72 | } __packed; | |
73 | ||
74 | struct htc_config_pipe_msg { | |
7f1f5a00 | 75 | __be16 message_id; |
fb9987d0 S |
76 | u8 pipe_id; |
77 | u8 credits; | |
78 | } __packed; | |
79 | ||
80 | struct htc_packet { | |
81 | void *pktcontext; | |
82 | u8 *buf; | |
83 | u8 *buf_payload; | |
84 | u32 buflen; | |
85 | u32 payload_len; | |
86 | ||
87 | int endpoint; | |
88 | int status; | |
89 | ||
90 | void *context; | |
91 | u32 reserved; | |
92 | }; | |
93 | ||
94 | struct htc_ep_callbacks { | |
95 | void *priv; | |
96 | void (*tx) (void *, struct sk_buff *, enum htc_endpoint_id, bool txok); | |
97 | void (*rx) (void *, struct sk_buff *, enum htc_endpoint_id); | |
98 | }; | |
99 | ||
100 | #define HTC_TX_QUEUE_SIZE 256 | |
101 | ||
102 | struct htc_txq { | |
103 | struct sk_buff *buf[HTC_TX_QUEUE_SIZE]; | |
104 | u32 txqdepth; | |
105 | u16 txbuf_cnt; | |
106 | u16 txq_head; | |
107 | u16 txq_tail; | |
108 | }; | |
109 | ||
110 | struct htc_endpoint { | |
111 | u16 service_id; | |
112 | ||
113 | struct htc_ep_callbacks ep_callbacks; | |
114 | struct htc_txq htc_txq; | |
115 | u32 max_txqdepth; | |
116 | int max_msglen; | |
117 | ||
118 | u8 ul_pipeid; | |
119 | u8 dl_pipeid; | |
120 | }; | |
121 | ||
122 | #define HTC_MAX_CONTROL_MESSAGE_LENGTH 255 | |
123 | #define HTC_CONTROL_BUFFER_SIZE \ | |
124 | (HTC_MAX_CONTROL_MESSAGE_LENGTH + sizeof(struct htc_frame_hdr)) | |
125 | ||
fb9987d0 S |
126 | struct htc_control_buf { |
127 | struct htc_packet htc_pkt; | |
128 | u8 buf[HTC_CONTROL_BUFFER_SIZE]; | |
129 | }; | |
130 | ||
131 | #define HTC_OP_START_WAIT BIT(0) | |
132 | #define HTC_OP_CONFIG_PIPE_CREDITS BIT(1) | |
133 | ||
134 | struct htc_target { | |
135 | void *hif_dev; | |
136 | struct ath9k_htc_priv *drv_priv; | |
137 | struct device *dev; | |
138 | struct ath9k_htc_hif *hif; | |
8116daf2 | 139 | struct htc_endpoint endpoint[ENDPOINT_MAX]; |
fb9987d0 S |
140 | struct completion target_wait; |
141 | struct completion cmd_wait; | |
142 | struct list_head list; | |
143 | enum htc_endpoint_id conn_rsp_epid; | |
144 | u16 credits; | |
145 | u16 credit_size; | |
146 | u8 htc_flags; | |
d8c49ffb | 147 | atomic_t tgt_ready; |
fb9987d0 S |
148 | }; |
149 | ||
150 | enum htc_msg_id { | |
151 | HTC_MSG_READY_ID = 1, | |
152 | HTC_MSG_CONNECT_SERVICE_ID, | |
153 | HTC_MSG_CONNECT_SERVICE_RESPONSE_ID, | |
154 | HTC_MSG_SETUP_COMPLETE_ID, | |
155 | HTC_MSG_CONFIG_PIPE_ID, | |
156 | HTC_MSG_CONFIG_PIPE_RESPONSE_ID, | |
157 | }; | |
158 | ||
159 | struct htc_service_connreq { | |
160 | u16 service_id; | |
161 | u16 con_flags; | |
162 | u32 max_send_qdepth; | |
163 | struct htc_ep_callbacks ep_callbacks; | |
164 | }; | |
165 | ||
166 | /* Current service IDs */ | |
167 | ||
168 | enum htc_service_group_ids{ | |
169 | RSVD_SERVICE_GROUP = 0, | |
170 | WMI_SERVICE_GROUP = 1, | |
171 | ||
172 | HTC_SERVICE_GROUP_LAST = 255 | |
173 | }; | |
174 | ||
175 | #define MAKE_SERVICE_ID(group, index) \ | |
176 | (int)(((int)group << 8) | (int)(index)) | |
177 | ||
178 | /* NOTE: service ID of 0x0000 is reserved and should never be used */ | |
179 | #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1) | |
180 | #define HTC_LOOPBACK_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 2) | |
181 | ||
182 | #define WMI_CONTROL_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0) | |
183 | #define WMI_BEACON_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1) | |
184 | #define WMI_CAB_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2) | |
185 | #define WMI_UAPSD_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3) | |
186 | #define WMI_MGMT_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4) | |
187 | #define WMI_DATA_VO_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 5) | |
188 | #define WMI_DATA_VI_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 6) | |
189 | #define WMI_DATA_BE_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 7) | |
190 | #define WMI_DATA_BK_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 8) | |
191 | ||
192 | struct htc_conn_svc_msg { | |
7f1f5a00 S |
193 | __be16 msg_id; |
194 | __be16 service_id; | |
195 | __be16 con_flags; | |
fb9987d0 S |
196 | u8 dl_pipeid; |
197 | u8 ul_pipeid; | |
198 | u8 svc_meta_len; | |
199 | u8 pad; | |
200 | } __packed; | |
201 | ||
202 | /* connect response status codes */ | |
203 | #define HTC_SERVICE_SUCCESS 0 | |
204 | #define HTC_SERVICE_NOT_FOUND 1 | |
205 | #define HTC_SERVICE_FAILED 2 | |
206 | #define HTC_SERVICE_NO_RESOURCES 3 | |
207 | #define HTC_SERVICE_NO_MORE_EP 4 | |
208 | ||
209 | struct htc_conn_svc_rspmsg { | |
7f1f5a00 S |
210 | __be16 msg_id; |
211 | __be16 service_id; | |
fb9987d0 S |
212 | u8 status; |
213 | u8 endpoint_id; | |
7f1f5a00 | 214 | __be16 max_msg_len; |
fb9987d0 S |
215 | u8 svc_meta_len; |
216 | u8 pad; | |
217 | } __packed; | |
218 | ||
219 | struct htc_comp_msg { | |
7f1f5a00 | 220 | __be16 msg_id; |
fb9987d0 S |
221 | } __packed; |
222 | ||
223 | int htc_init(struct htc_target *target); | |
224 | int htc_connect_service(struct htc_target *target, | |
225 | struct htc_service_connreq *service_connreq, | |
226 | enum htc_endpoint_id *conn_rsp_eid); | |
227 | int htc_send(struct htc_target *target, struct sk_buff *skb, | |
228 | enum htc_endpoint_id eid, struct ath9k_htc_tx_ctl *tx_ctl); | |
229 | void htc_stop(struct htc_target *target); | |
230 | void htc_start(struct htc_target *target); | |
231 | ||
232 | void ath9k_htc_rx_msg(struct htc_target *htc_handle, | |
233 | struct sk_buff *skb, u32 len, u8 pipe_id); | |
234 | void ath9k_htc_txcompletion_cb(struct htc_target *htc_handle, | |
235 | struct sk_buff *skb, bool txok); | |
236 | ||
47fce026 SM |
237 | struct htc_target *ath9k_htc_hw_alloc(void *hif_handle, |
238 | struct ath9k_htc_hif *hif, | |
239 | struct device *dev); | |
fb9987d0 | 240 | void ath9k_htc_hw_free(struct htc_target *htc); |
47fce026 | 241 | int ath9k_htc_hw_init(struct htc_target *target, |
21cb9879 | 242 | struct device *dev, u16 devid, char *product); |
fb9987d0 S |
243 | void ath9k_htc_hw_deinit(struct htc_target *target, bool hot_unplug); |
244 | ||
245 | #endif /* HTC_HST_H */ |