1 /*
2 * Wireless Host Controller (WHC) private header.
3 *
4 * Copyright (C) 2007 Cambridge Silicon Radio Ltd.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18 * 02110-1301, USA.
19 */
20 #ifndef __WHCD_H
21 #define __WHCD_H
22
23 #include <linux/uwb/whci.h>
24 #include <linux/uwb/umc.h>
25 #include <linux/workqueue.h>
26
27 #include "whci-hc.h"
28
29 /* Generic command timeout. */
30 #define WHC_GENCMD_TIMEOUT_MS 100
31
32 struct whc_dbg;
33
34 struct whc {
35 struct wusbhc wusbhc;
36 struct umc_dev *umc;
37
38 resource_size_t base_phys;
39 void __iomem *base;
40 int irq;
41
42 u8 n_devices;
43 u8 n_keys;
44 u8 n_mmc_ies;
45
46 u64 *pz_list;
47 struct dn_buf_entry *dn_buf;
48 struct di_buf_entry *di_buf;
49 dma_addr_t pz_list_dma;
50 dma_addr_t dn_buf_dma;
51 dma_addr_t di_buf_dma;
52
53 spinlock_t lock;
54 struct mutex mutex;
55
56 void * gen_cmd_buf;
57 dma_addr_t gen_cmd_buf_dma;
58 wait_queue_head_t cmd_wq;
59
60 struct workqueue_struct *workqueue;
61 struct work_struct dn_work;
62
63 struct dma_pool *qset_pool;
64
65 struct list_head async_list;
66 struct list_head async_removed_list;
67 wait_queue_head_t async_list_wq;
68 struct work_struct async_work;
69
70 struct list_head periodic_list[5];
71 struct list_head periodic_removed_list;
72 wait_queue_head_t periodic_list_wq;
73 struct work_struct periodic_work;
74
75 struct whc_dbg *dbg;
76 };
77
78 #define wusbhc_to_whc(w) (container_of((w), struct whc, wusbhc))
79
80 /**
81 * struct whc_std - a software TD.
82 * @urb: the URB this sTD is for.
83 * @offset: start of the URB's data for this TD.
84 * @len: the length of data in the associated TD.
85 * @ntds_remaining: number of TDs (starting from this one) in this transfer.
86 *
87 * Queued URBs may require more TDs than are available in a qset so we
88 * use a list of these "software TDs" (sTDs) to hold per-TD data.
89 */
90 struct whc_std {
91 struct urb *urb;
92 size_t len;
93 int ntds_remaining;
94 struct whc_qtd *qtd;
95
96 struct list_head list_node;
97 int num_pointers;
98 dma_addr_t dma_addr;
99 struct whc_page_list_entry *pl_virt;
100 };
101
102 /**
103 * struct whc_urb - per URB host controller structure.
104 * @urb: the URB this struct is for.
105 * @qset: the qset associated to the URB.
106 * @dequeue_work: the work to remove the URB when dequeued.
107 * @is_async: the URB belongs to async sheduler or not.
108 * @status: the status to be returned when calling wusbhc_giveback_urb.
109 */
110 struct whc_urb {
111 struct urb *urb;
112 struct whc_qset *qset;
113 struct work_struct dequeue_work;
114 bool is_async;
115 int status;
116 };
117
118 /**
119 * whc_std_last - is this sTD the URB's last?
120 * @std: the sTD to check.
121 */
whc_std_last(struct whc_std * std)122 static inline bool whc_std_last(struct whc_std *std)
123 {
124 return std->ntds_remaining <= 1;
125 }
126
127 enum whc_update {
128 WHC_UPDATE_ADDED = 0x01,
129 WHC_UPDATE_REMOVED = 0x02,
130 WHC_UPDATE_UPDATED = 0x04,
131 };
132
133 /* init.c */
134 int whc_init(struct whc *whc);
135 void whc_clean_up(struct whc *whc);
136
137 /* hw.c */
138 void whc_write_wusbcmd(struct whc *whc, u32 mask, u32 val);
139 int whc_do_gencmd(struct whc *whc, u32 cmd, u32 params, void *addr, size_t len);
140 void whc_hw_error(struct whc *whc, const char *reason);
141
142 /* wusb.c */
143 int whc_wusbhc_start(struct wusbhc *wusbhc);
144 void whc_wusbhc_stop(struct wusbhc *wusbhc, int delay);
145 int whc_mmcie_add(struct wusbhc *wusbhc, u8 interval, u8 repeat_cnt,
146 u8 handle, struct wuie_hdr *wuie);
147 int whc_mmcie_rm(struct wusbhc *wusbhc, u8 handle);
148 int whc_bwa_set(struct wusbhc *wusbhc, s8 stream_index, const struct uwb_mas_bm *mas_bm);
149 int whc_dev_info_set(struct wusbhc *wusbhc, struct wusb_dev *wusb_dev);
150 int whc_set_num_dnts(struct wusbhc *wusbhc, u8 interval, u8 slots);
151 int whc_set_ptk(struct wusbhc *wusbhc, u8 port_idx, u32 tkid,
152 const void *ptk, size_t key_size);
153 int whc_set_gtk(struct wusbhc *wusbhc, u32 tkid,
154 const void *gtk, size_t key_size);
155 int whc_set_cluster_id(struct whc *whc, u8 bcid);
156
157 /* int.c */
158 irqreturn_t whc_int_handler(struct usb_hcd *hcd);
159 void whc_dn_work(struct work_struct *work);
160
161 /* asl.c */
162 void asl_start(struct whc *whc);
163 void asl_stop(struct whc *whc);
164 int asl_init(struct whc *whc);
165 void asl_clean_up(struct whc *whc);
166 int asl_urb_enqueue(struct whc *whc, struct urb *urb, gfp_t mem_flags);
167 int asl_urb_dequeue(struct whc *whc, struct urb *urb, int status);
168 void asl_qset_delete(struct whc *whc, struct whc_qset *qset);
169 void scan_async_work(struct work_struct *work);
170
171 /* pzl.c */
172 int pzl_init(struct whc *whc);
173 void pzl_clean_up(struct whc *whc);
174 void pzl_start(struct whc *whc);
175 void pzl_stop(struct whc *whc);
176 int pzl_urb_enqueue(struct whc *whc, struct urb *urb, gfp_t mem_flags);
177 int pzl_urb_dequeue(struct whc *whc, struct urb *urb, int status);
178 void pzl_qset_delete(struct whc *whc, struct whc_qset *qset);
179 void scan_periodic_work(struct work_struct *work);
180
181 /* qset.c */
182 struct whc_qset *qset_alloc(struct whc *whc, gfp_t mem_flags);
183 void qset_free(struct whc *whc, struct whc_qset *qset);
184 struct whc_qset *get_qset(struct whc *whc, struct urb *urb, gfp_t mem_flags);
185 void qset_delete(struct whc *whc, struct whc_qset *qset);
186 void qset_clear(struct whc *whc, struct whc_qset *qset);
187 int qset_add_urb(struct whc *whc, struct whc_qset *qset, struct urb *urb,
188 gfp_t mem_flags);
189 void qset_free_std(struct whc *whc, struct whc_std *std);
190 void qset_remove_urb(struct whc *whc, struct whc_qset *qset,
191 struct urb *urb, int status);
192 void process_halted_qtd(struct whc *whc, struct whc_qset *qset,
193 struct whc_qtd *qtd);
194 void process_inactive_qtd(struct whc *whc, struct whc_qset *qset,
195 struct whc_qtd *qtd);
196 enum whc_update qset_add_qtds(struct whc *whc, struct whc_qset *qset);
197 void qset_remove_complete(struct whc *whc, struct whc_qset *qset);
198 void pzl_update(struct whc *whc, uint32_t wusbcmd);
199 void asl_update(struct whc *whc, uint32_t wusbcmd);
200
201 /* debug.c */
202 void whc_dbg_init(struct whc *whc);
203 void whc_dbg_clean_up(struct whc *whc);
204
205 #endif /* #ifndef __WHCD_H */
206