4 * Setup and helper functions to access QDIO.
6 * Copyright IBM Corporation 2002, 2010
9 #define KMSG_COMPONENT "zfcp"
10 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
12 #include <linux/slab.h>
14 #include "zfcp_qdio.h"
16 #define QBUFF_PER_PAGE (PAGE_SIZE / sizeof(struct qdio_buffer))
18 static int zfcp_qdio_buffers_enqueue(struct qdio_buffer **sbal)
22 for (pos = 0; pos < QDIO_MAX_BUFFERS_PER_Q; pos += QBUFF_PER_PAGE) {
23 sbal[pos] = (struct qdio_buffer *) get_zeroed_page(GFP_KERNEL);
27 for (pos = 0; pos < QDIO_MAX_BUFFERS_PER_Q; pos++)
28 if (pos % QBUFF_PER_PAGE)
29 sbal[pos] = sbal[pos - 1] + 1;
33 static void zfcp_qdio_handler_error(struct zfcp_qdio *qdio, char *id,
34 unsigned int qdio_err)
36 struct zfcp_adapter *adapter = qdio->adapter;
38 dev_warn(&adapter->ccw_device->dev, "A QDIO problem occurred\n");
40 if (qdio_err & QDIO_ERROR_SLSB_STATE)
41 zfcp_qdio_siosl(adapter);
42 zfcp_erp_adapter_reopen(adapter,
43 ZFCP_STATUS_ADAPTER_LINK_UNPLUGGED |
44 ZFCP_STATUS_COMMON_ERP_FAILED, id, NULL);
47 static void zfcp_qdio_zero_sbals(struct qdio_buffer *sbal[], int first, int cnt)
51 for (i = first; i < first + cnt; i++) {
52 sbal_idx = i % QDIO_MAX_BUFFERS_PER_Q;
53 memset(sbal[sbal_idx], 0, sizeof(struct qdio_buffer));
57 /* this needs to be called prior to updating the queue fill level */
58 static inline void zfcp_qdio_account(struct zfcp_qdio *qdio)
60 unsigned long long now, span;
63 now = get_clock_monotonic();
64 span = (now - qdio->req_q_time) >> 12;
65 used = QDIO_MAX_BUFFERS_PER_Q - atomic_read(&qdio->req_q_free);
66 qdio->req_q_util += used * span;
67 qdio->req_q_time = now;
70 static void zfcp_qdio_int_req(struct ccw_device *cdev, unsigned int qdio_err,
71 int queue_no, int idx, int count,
74 struct zfcp_qdio *qdio = (struct zfcp_qdio *) parm;
76 if (unlikely(qdio_err)) {
77 zfcp_dbf_hba_qdio(qdio->adapter->dbf, qdio_err, idx, count);
78 zfcp_qdio_handler_error(qdio, "qdireq1", qdio_err);
82 /* cleanup all SBALs being program-owned now */
83 zfcp_qdio_zero_sbals(qdio->req_q, idx, count);
85 spin_lock_irq(&qdio->stat_lock);
86 zfcp_qdio_account(qdio);
87 spin_unlock_irq(&qdio->stat_lock);
88 atomic_add(count, &qdio->req_q_free);
89 wake_up(&qdio->req_q_wq);
92 static void zfcp_qdio_int_resp(struct ccw_device *cdev, unsigned int qdio_err,
93 int queue_no, int idx, int count,
96 struct zfcp_qdio *qdio = (struct zfcp_qdio *) parm;
97 int sbal_idx, sbal_no;
99 if (unlikely(qdio_err)) {
100 zfcp_dbf_hba_qdio(qdio->adapter->dbf, qdio_err, idx, count);
101 zfcp_qdio_handler_error(qdio, "qdires1", qdio_err);
106 * go through all SBALs from input queue currently
107 * returned by QDIO layer
109 for (sbal_no = 0; sbal_no < count; sbal_no++) {
110 sbal_idx = (idx + sbal_no) % QDIO_MAX_BUFFERS_PER_Q;
111 /* go through all SBALEs of SBAL */
112 zfcp_fsf_reqid_check(qdio, sbal_idx);
116 * put SBALs back to response queue
118 if (do_QDIO(cdev, QDIO_FLAG_SYNC_INPUT, 0, idx, count))
119 zfcp_erp_adapter_reopen(qdio->adapter, 0, "qdires2", NULL);
122 static struct qdio_buffer_element *
123 zfcp_qdio_sbal_chain(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
125 struct qdio_buffer_element *sbale;
127 /* set last entry flag in current SBALE of current SBAL */
128 sbale = zfcp_qdio_sbale_curr(qdio, q_req);
129 sbale->flags |= SBAL_FLAGS_LAST_ENTRY;
131 /* don't exceed last allowed SBAL */
132 if (q_req->sbal_last == q_req->sbal_limit)
135 /* set chaining flag in first SBALE of current SBAL */
136 sbale = zfcp_qdio_sbale_req(qdio, q_req);
137 sbale->flags |= SBAL_FLAGS0_MORE_SBALS;
139 /* calculate index of next SBAL */
141 q_req->sbal_last %= QDIO_MAX_BUFFERS_PER_Q;
143 /* keep this requests number of SBALs up-to-date */
144 q_req->sbal_number++;
145 BUG_ON(q_req->sbal_number > ZFCP_QDIO_MAX_SBALS_PER_REQ);
147 /* start at first SBALE of new SBAL */
148 q_req->sbale_curr = 0;
150 /* set storage-block type for new SBAL */
151 sbale = zfcp_qdio_sbale_curr(qdio, q_req);
152 sbale->flags |= q_req->sbtype;
157 static struct qdio_buffer_element *
158 zfcp_qdio_sbale_next(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
160 if (q_req->sbale_curr == ZFCP_QDIO_LAST_SBALE_PER_SBAL)
161 return zfcp_qdio_sbal_chain(qdio, q_req);
163 return zfcp_qdio_sbale_curr(qdio, q_req);
167 * zfcp_qdio_sbals_from_sg - fill SBALs from scatter-gather list
168 * @qdio: pointer to struct zfcp_qdio
169 * @q_req: pointer to struct zfcp_qdio_req
170 * @sg: scatter-gather list
171 * @max_sbals: upper bound for number of SBALs to be used
172 * Returns: number of bytes, or error (negativ)
174 int zfcp_qdio_sbals_from_sg(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req,
175 struct scatterlist *sg)
177 struct qdio_buffer_element *sbale;
180 /* set storage-block type for this request */
181 sbale = zfcp_qdio_sbale_req(qdio, q_req);
182 sbale->flags |= q_req->sbtype;
184 for (; sg; sg = sg_next(sg)) {
185 sbale = zfcp_qdio_sbale_next(qdio, q_req);
187 atomic_inc(&qdio->req_q_full);
188 zfcp_qdio_zero_sbals(qdio->req_q, q_req->sbal_first,
193 sbale->addr = sg_virt(sg);
194 sbale->length = sg->length;
202 static int zfcp_qdio_sbal_check(struct zfcp_qdio *qdio)
204 spin_lock_irq(&qdio->req_q_lock);
205 if (atomic_read(&qdio->req_q_free) ||
206 !(atomic_read(&qdio->adapter->status) & ZFCP_STATUS_ADAPTER_QDIOUP))
208 spin_unlock_irq(&qdio->req_q_lock);
213 * zfcp_qdio_sbal_get - get free sbal in request queue, wait if necessary
214 * @qdio: pointer to struct zfcp_qdio
216 * The req_q_lock must be held by the caller of this function, and
217 * this function may only be called from process context; it will
218 * sleep when waiting for a free sbal.
220 * Returns: 0 on success, -EIO if there is no free sbal after waiting.
222 int zfcp_qdio_sbal_get(struct zfcp_qdio *qdio)
226 spin_unlock_irq(&qdio->req_q_lock);
227 ret = wait_event_interruptible_timeout(qdio->req_q_wq,
228 zfcp_qdio_sbal_check(qdio), 5 * HZ);
230 if (!(atomic_read(&qdio->adapter->status) & ZFCP_STATUS_ADAPTER_QDIOUP))
237 atomic_inc(&qdio->req_q_full);
238 /* assume hanging outbound queue, try queue recovery */
239 zfcp_erp_adapter_reopen(qdio->adapter, 0, "qdsbg_1", NULL);
242 spin_lock_irq(&qdio->req_q_lock);
247 * zfcp_qdio_send - set PCI flag in first SBALE and send req to QDIO
248 * @qdio: pointer to struct zfcp_qdio
249 * @q_req: pointer to struct zfcp_qdio_req
250 * Returns: 0 on success, error otherwise
252 int zfcp_qdio_send(struct zfcp_qdio *qdio, struct zfcp_qdio_req *q_req)
255 u8 sbal_number = q_req->sbal_number;
257 spin_lock(&qdio->stat_lock);
258 zfcp_qdio_account(qdio);
259 spin_unlock(&qdio->stat_lock);
261 retval = do_QDIO(qdio->adapter->ccw_device, QDIO_FLAG_SYNC_OUTPUT, 0,
262 q_req->sbal_first, sbal_number);
264 if (unlikely(retval)) {
265 zfcp_qdio_zero_sbals(qdio->req_q, q_req->sbal_first,
270 /* account for transferred buffers */
271 atomic_sub(sbal_number, &qdio->req_q_free);
272 qdio->req_q_idx += sbal_number;
273 qdio->req_q_idx %= QDIO_MAX_BUFFERS_PER_Q;
279 static void zfcp_qdio_setup_init_data(struct qdio_initialize *id,
280 struct zfcp_qdio *qdio)
282 memset(id, 0, sizeof(*id));
283 id->cdev = qdio->adapter->ccw_device;
284 id->q_format = QDIO_ZFCP_QFMT;
285 memcpy(id->adapter_name, dev_name(&id->cdev->dev), 8);
286 ASCEBC(id->adapter_name, 8);
287 id->qib_rflags = QIB_RFLAGS_ENABLE_DATA_DIV;
289 id->no_output_qs = 1;
290 id->input_handler = zfcp_qdio_int_resp;
291 id->output_handler = zfcp_qdio_int_req;
292 id->int_parm = (unsigned long) qdio;
293 id->input_sbal_addr_array = (void **) (qdio->res_q);
294 id->output_sbal_addr_array = (void **) (qdio->req_q);
298 * zfcp_qdio_allocate - allocate queue memory and initialize QDIO data
299 * @adapter: pointer to struct zfcp_adapter
300 * Returns: -ENOMEM on memory allocation error or return value from
303 static int zfcp_qdio_allocate(struct zfcp_qdio *qdio)
305 struct qdio_initialize init_data;
307 if (zfcp_qdio_buffers_enqueue(qdio->req_q) ||
308 zfcp_qdio_buffers_enqueue(qdio->res_q))
311 zfcp_qdio_setup_init_data(&init_data, qdio);
313 return qdio_allocate(&init_data);
317 * zfcp_close_qdio - close qdio queues for an adapter
318 * @qdio: pointer to structure zfcp_qdio
320 void zfcp_qdio_close(struct zfcp_qdio *qdio)
322 struct zfcp_adapter *adapter = qdio->adapter;
325 if (!(atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_QDIOUP))
328 /* clear QDIOUP flag, thus do_QDIO is not called during qdio_shutdown */
329 spin_lock_irq(&qdio->req_q_lock);
330 atomic_clear_mask(ZFCP_STATUS_ADAPTER_QDIOUP, &adapter->status);
331 spin_unlock_irq(&qdio->req_q_lock);
333 wake_up(&qdio->req_q_wq);
335 qdio_shutdown(adapter->ccw_device, QDIO_FLAG_CLEANUP_USING_CLEAR);
337 /* cleanup used outbound sbals */
338 count = atomic_read(&qdio->req_q_free);
339 if (count < QDIO_MAX_BUFFERS_PER_Q) {
340 idx = (qdio->req_q_idx + count) % QDIO_MAX_BUFFERS_PER_Q;
341 count = QDIO_MAX_BUFFERS_PER_Q - count;
342 zfcp_qdio_zero_sbals(qdio->req_q, idx, count);
345 atomic_set(&qdio->req_q_free, 0);
349 * zfcp_qdio_open - prepare and initialize response queue
350 * @qdio: pointer to struct zfcp_qdio
351 * Returns: 0 on success, otherwise -EIO
353 int zfcp_qdio_open(struct zfcp_qdio *qdio)
355 struct qdio_buffer_element *sbale;
356 struct qdio_initialize init_data;
357 struct zfcp_adapter *adapter = qdio->adapter;
358 struct ccw_device *cdev = adapter->ccw_device;
359 struct qdio_ssqd_desc ssqd;
362 if (atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_QDIOUP)
365 atomic_clear_mask(ZFCP_STATUS_ADAPTER_SIOSL_ISSUED,
366 &qdio->adapter->status);
368 zfcp_qdio_setup_init_data(&init_data, qdio);
370 if (qdio_establish(&init_data))
371 goto failed_establish;
373 if (qdio_get_ssqd_desc(init_data.cdev, &ssqd))
376 if (ssqd.qdioac2 & CHSC_AC2_DATA_DIV_ENABLED)
377 atomic_set_mask(ZFCP_STATUS_ADAPTER_DATA_DIV_ENABLED,
378 &qdio->adapter->status);
380 if (qdio_activate(cdev))
383 for (cc = 0; cc < QDIO_MAX_BUFFERS_PER_Q; cc++) {
384 sbale = &(qdio->res_q[cc]->element[0]);
386 sbale->flags = SBAL_FLAGS_LAST_ENTRY;
390 if (do_QDIO(cdev, QDIO_FLAG_SYNC_INPUT, 0, 0, QDIO_MAX_BUFFERS_PER_Q))
393 /* set index of first avalable SBALS / number of available SBALS */
395 atomic_set(&qdio->req_q_free, QDIO_MAX_BUFFERS_PER_Q);
400 qdio_shutdown(cdev, QDIO_FLAG_CLEANUP_USING_CLEAR);
403 "Setting up the QDIO connection to the FCP adapter failed\n");
407 void zfcp_qdio_destroy(struct zfcp_qdio *qdio)
414 if (qdio->adapter->ccw_device)
415 qdio_free(qdio->adapter->ccw_device);
417 for (p = 0; p < QDIO_MAX_BUFFERS_PER_Q; p += QBUFF_PER_PAGE) {
418 free_page((unsigned long) qdio->req_q[p]);
419 free_page((unsigned long) qdio->res_q[p]);
425 int zfcp_qdio_setup(struct zfcp_adapter *adapter)
427 struct zfcp_qdio *qdio;
429 qdio = kzalloc(sizeof(struct zfcp_qdio), GFP_KERNEL);
433 qdio->adapter = adapter;
435 if (zfcp_qdio_allocate(qdio)) {
436 zfcp_qdio_destroy(qdio);
440 spin_lock_init(&qdio->req_q_lock);
441 spin_lock_init(&qdio->stat_lock);
443 adapter->qdio = qdio;
448 * zfcp_qdio_siosl - Trigger logging in FCP channel
449 * @adapter: The zfcp_adapter where to trigger logging
451 * Call the cio siosl function to trigger hardware logging. This
452 * wrapper function sets a flag to ensure hardware logging is only
453 * triggered once before going through qdio shutdown.
455 * The triggers are always run from qdio tasklet context, so no
456 * additional synchronization is necessary.
458 void zfcp_qdio_siosl(struct zfcp_adapter *adapter)
462 if (atomic_read(&adapter->status) & ZFCP_STATUS_ADAPTER_SIOSL_ISSUED)
465 rc = ccw_device_siosl(adapter->ccw_device);
467 atomic_set_mask(ZFCP_STATUS_ADAPTER_SIOSL_ISSUED,