2 * Copyright (c) 2010 Atheros Communications Inc.
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.
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.
20 struct ath9k_htc_priv;
22 struct ath9k_htc_tx_ctl;
24 enum ath9k_hif_transports {
28 struct ath9k_htc_hif {
29 struct list_head list;
30 const enum ath9k_hif_transports transport;
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);
41 enum htc_endpoint_id {
55 /* Htc frame hdr flags */
56 #define HTC_FLAGS_RECV_TRAILER (1 << 1)
58 struct htc_frame_hdr {
65 struct htc_ready_msg {
73 struct htc_config_pipe_msg {
79 struct htc_ep_callbacks {
81 void (*tx) (void *, struct sk_buff *, enum htc_endpoint_id, bool txok);
82 void (*rx) (void *, struct sk_buff *, enum htc_endpoint_id);
85 #define HTC_TX_QUEUE_SIZE 256
88 struct sk_buff *buf[HTC_TX_QUEUE_SIZE];
98 struct htc_ep_callbacks ep_callbacks;
99 struct htc_txq htc_txq;
107 #define HTC_MAX_CONTROL_MESSAGE_LENGTH 255
108 #define HTC_CONTROL_BUFFER_SIZE \
109 (HTC_MAX_CONTROL_MESSAGE_LENGTH + sizeof(struct htc_frame_hdr))
111 #define HTC_OP_START_WAIT BIT(0)
112 #define HTC_OP_CONFIG_PIPE_CREDITS BIT(1)
116 struct ath9k_htc_priv *drv_priv;
118 struct ath9k_htc_hif *hif;
119 struct htc_endpoint endpoint[ENDPOINT_MAX];
120 struct completion target_wait;
121 struct completion cmd_wait;
122 struct list_head list;
123 enum htc_endpoint_id conn_rsp_epid;
131 HTC_MSG_READY_ID = 1,
132 HTC_MSG_CONNECT_SERVICE_ID,
133 HTC_MSG_CONNECT_SERVICE_RESPONSE_ID,
134 HTC_MSG_SETUP_COMPLETE_ID,
135 HTC_MSG_CONFIG_PIPE_ID,
136 HTC_MSG_CONFIG_PIPE_RESPONSE_ID,
139 struct htc_service_connreq {
143 struct htc_ep_callbacks ep_callbacks;
146 /* Current service IDs */
148 enum htc_service_group_ids{
149 RSVD_SERVICE_GROUP = 0,
150 WMI_SERVICE_GROUP = 1,
152 HTC_SERVICE_GROUP_LAST = 255
155 #define MAKE_SERVICE_ID(group, index) \
156 (int)(((int)group << 8) | (int)(index))
158 /* NOTE: service ID of 0x0000 is reserved and should never be used */
159 #define HTC_CTRL_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 1)
160 #define HTC_LOOPBACK_RSVD_SVC MAKE_SERVICE_ID(RSVD_SERVICE_GROUP, 2)
162 #define WMI_CONTROL_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 0)
163 #define WMI_BEACON_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 1)
164 #define WMI_CAB_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 2)
165 #define WMI_UAPSD_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 3)
166 #define WMI_MGMT_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 4)
167 #define WMI_DATA_VO_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 5)
168 #define WMI_DATA_VI_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 6)
169 #define WMI_DATA_BE_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 7)
170 #define WMI_DATA_BK_SVC MAKE_SERVICE_ID(WMI_SERVICE_GROUP, 8)
172 struct htc_conn_svc_msg {
182 /* connect response status codes */
183 #define HTC_SERVICE_SUCCESS 0
184 #define HTC_SERVICE_NOT_FOUND 1
185 #define HTC_SERVICE_FAILED 2
186 #define HTC_SERVICE_NO_RESOURCES 3
187 #define HTC_SERVICE_NO_MORE_EP 4
189 struct htc_conn_svc_rspmsg {
199 struct htc_comp_msg {
203 int htc_init(struct htc_target *target);
204 int htc_connect_service(struct htc_target *target,
205 struct htc_service_connreq *service_connreq,
206 enum htc_endpoint_id *conn_rsp_eid);
207 int htc_send(struct htc_target *target, struct sk_buff *skb);
208 int htc_send_epid(struct htc_target *target, struct sk_buff *skb,
209 enum htc_endpoint_id epid);
210 void htc_stop(struct htc_target *target);
211 void htc_start(struct htc_target *target);
213 void ath9k_htc_rx_msg(struct htc_target *htc_handle,
214 struct sk_buff *skb, u32 len, u8 pipe_id);
215 void ath9k_htc_txcompletion_cb(struct htc_target *htc_handle,
216 struct sk_buff *skb, bool txok);
218 struct htc_target *ath9k_htc_hw_alloc(void *hif_handle,
219 struct ath9k_htc_hif *hif,
221 void ath9k_htc_hw_free(struct htc_target *htc);
222 int ath9k_htc_hw_init(struct htc_target *target,
223 struct device *dev, u16 devid, char *product,
225 void ath9k_htc_hw_deinit(struct htc_target *target, bool hot_unplug);
227 #endif /* HTC_HST_H */