]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/block/skd_main.c
ipv4: convert dst_metrics.refcnt from atomic_t to refcount_t
[mirror_ubuntu-artful-kernel.git] / drivers / block / skd_main.c
CommitLineData
e67f86b3
AB
1/* Copyright 2012 STEC, Inc.
2 *
3 * This file is licensed under the terms of the 3-clause
4 * BSD License (http://opensource.org/licenses/BSD-3-Clause)
5 * or the GNU GPL-2.0 (http://www.gnu.org/licenses/gpl-2.0.html),
6 * at your option. Both licenses are also available in the LICENSE file
7 * distributed with this project. This file may not be copied, modified,
8 * or distributed except in accordance with those terms.
9 * Gordoni Waidhofer <gwaidhofer@stec-inc.com>
10 * Initial Driver Design!
11 * Thomas Swann <tswann@stec-inc.com>
12 * Interrupt handling.
13 * Ramprasad Chinthekindi <rchinthekindi@stec-inc.com>
14 * biomode implementation.
15 * Akhil Bhansali <abhansali@stec-inc.com>
16 * Added support for DISCARD / FLUSH and FUA.
17 */
18
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/init.h>
22#include <linux/pci.h>
23#include <linux/slab.h>
24#include <linux/spinlock.h>
25#include <linux/blkdev.h>
26#include <linux/sched.h>
27#include <linux/interrupt.h>
28#include <linux/compiler.h>
29#include <linux/workqueue.h>
30#include <linux/bitops.h>
31#include <linux/delay.h>
32#include <linux/time.h>
33#include <linux/hdreg.h>
34#include <linux/dma-mapping.h>
35#include <linux/completion.h>
36#include <linux/scatterlist.h>
37#include <linux/version.h>
38#include <linux/err.h>
e67f86b3
AB
39#include <linux/aer.h>
40#include <linux/ctype.h>
41#include <linux/wait.h>
42#include <linux/uio.h>
43#include <scsi/scsi.h>
e67f86b3
AB
44#include <scsi/sg.h>
45#include <linux/io.h>
46#include <linux/uaccess.h>
4ca90b53 47#include <asm/unaligned.h>
e67f86b3
AB
48
49#include "skd_s1120.h"
50
51static int skd_dbg_level;
52static int skd_isr_comp_limit = 4;
53
54enum {
55 STEC_LINK_2_5GTS = 0,
56 STEC_LINK_5GTS = 1,
57 STEC_LINK_8GTS = 2,
58 STEC_LINK_UNKNOWN = 0xFF
59};
60
61enum {
62 SKD_FLUSH_INITIALIZER,
63 SKD_FLUSH_ZERO_SIZE_FIRST,
64 SKD_FLUSH_DATA_SECOND,
65};
66
e67f86b3
AB
67#define SKD_ASSERT(expr) \
68 do { \
69 if (unlikely(!(expr))) { \
70 pr_err("Assertion failed! %s,%s,%s,line=%d\n", \
71 # expr, __FILE__, __func__, __LINE__); \
72 } \
73 } while (0)
74
e67f86b3
AB
75#define DRV_NAME "skd"
76#define DRV_VERSION "2.2.1"
77#define DRV_BUILD_ID "0260"
78#define PFX DRV_NAME ": "
79#define DRV_BIN_VERSION 0x100
80#define DRV_VER_COMPL "2.2.1." DRV_BUILD_ID
81
82MODULE_AUTHOR("bug-reports: support@stec-inc.com");
83MODULE_LICENSE("Dual BSD/GPL");
84
38d4a1bb 85MODULE_DESCRIPTION("STEC s1120 PCIe SSD block driver (b" DRV_BUILD_ID ")");
e67f86b3
AB
86MODULE_VERSION(DRV_VERSION "-" DRV_BUILD_ID);
87
88#define PCI_VENDOR_ID_STEC 0x1B39
89#define PCI_DEVICE_ID_S1120 0x0001
90
91#define SKD_FUA_NV (1 << 1)
92#define SKD_MINORS_PER_DEVICE 16
93
94#define SKD_MAX_QUEUE_DEPTH 200u
95
96#define SKD_PAUSE_TIMEOUT (5 * 1000)
97
98#define SKD_N_FITMSG_BYTES (512u)
99
100#define SKD_N_SPECIAL_CONTEXT 32u
101#define SKD_N_SPECIAL_FITMSG_BYTES (128u)
102
103/* SG elements are 32 bytes, so we can make this 4096 and still be under the
104 * 128KB limit. That allows 4096*4K = 16M xfer size
105 */
106#define SKD_N_SG_PER_REQ_DEFAULT 256u
107#define SKD_N_SG_PER_SPECIAL 256u
108
109#define SKD_N_COMPLETION_ENTRY 256u
110#define SKD_N_READ_CAP_BYTES (8u)
111
112#define SKD_N_INTERNAL_BYTES (512u)
113
114/* 5 bits of uniqifier, 0xF800 */
115#define SKD_ID_INCR (0x400)
116#define SKD_ID_TABLE_MASK (3u << 8u)
117#define SKD_ID_RW_REQUEST (0u << 8u)
118#define SKD_ID_INTERNAL (1u << 8u)
119#define SKD_ID_SPECIAL_REQUEST (2u << 8u)
120#define SKD_ID_FIT_MSG (3u << 8u)
121#define SKD_ID_SLOT_MASK 0x00FFu
122#define SKD_ID_SLOT_AND_TABLE_MASK 0x03FFu
123
124#define SKD_N_TIMEOUT_SLOT 4u
125#define SKD_TIMEOUT_SLOT_MASK 3u
126
127#define SKD_N_MAX_SECTORS 2048u
128
129#define SKD_MAX_RETRIES 2u
130
131#define SKD_TIMER_SECONDS(seconds) (seconds)
132#define SKD_TIMER_MINUTES(minutes) ((minutes) * (60))
133
134#define INQ_STD_NBYTES 36
e67f86b3
AB
135
136enum skd_drvr_state {
137 SKD_DRVR_STATE_LOAD,
138 SKD_DRVR_STATE_IDLE,
139 SKD_DRVR_STATE_BUSY,
140 SKD_DRVR_STATE_STARTING,
141 SKD_DRVR_STATE_ONLINE,
142 SKD_DRVR_STATE_PAUSING,
143 SKD_DRVR_STATE_PAUSED,
144 SKD_DRVR_STATE_DRAINING_TIMEOUT,
145 SKD_DRVR_STATE_RESTARTING,
146 SKD_DRVR_STATE_RESUMING,
147 SKD_DRVR_STATE_STOPPING,
148 SKD_DRVR_STATE_FAULT,
149 SKD_DRVR_STATE_DISAPPEARED,
150 SKD_DRVR_STATE_PROTOCOL_MISMATCH,
151 SKD_DRVR_STATE_BUSY_ERASE,
152 SKD_DRVR_STATE_BUSY_SANITIZE,
153 SKD_DRVR_STATE_BUSY_IMMINENT,
154 SKD_DRVR_STATE_WAIT_BOOT,
155 SKD_DRVR_STATE_SYNCING,
156};
157
158#define SKD_WAIT_BOOT_TIMO SKD_TIMER_SECONDS(90u)
159#define SKD_STARTING_TIMO SKD_TIMER_SECONDS(8u)
160#define SKD_RESTARTING_TIMO SKD_TIMER_MINUTES(4u)
161#define SKD_DRAINING_TIMO SKD_TIMER_SECONDS(6u)
162#define SKD_BUSY_TIMO SKD_TIMER_MINUTES(20u)
163#define SKD_STARTED_BUSY_TIMO SKD_TIMER_SECONDS(60u)
164#define SKD_START_WAIT_SECONDS 90u
165
166enum skd_req_state {
167 SKD_REQ_STATE_IDLE,
168 SKD_REQ_STATE_SETUP,
169 SKD_REQ_STATE_BUSY,
170 SKD_REQ_STATE_COMPLETED,
171 SKD_REQ_STATE_TIMEOUT,
172 SKD_REQ_STATE_ABORTED,
173};
174
175enum skd_fit_msg_state {
176 SKD_MSG_STATE_IDLE,
177 SKD_MSG_STATE_BUSY,
178};
179
180enum skd_check_status_action {
181 SKD_CHECK_STATUS_REPORT_GOOD,
182 SKD_CHECK_STATUS_REPORT_SMART_ALERT,
183 SKD_CHECK_STATUS_REQUEUE_REQUEST,
184 SKD_CHECK_STATUS_REPORT_ERROR,
185 SKD_CHECK_STATUS_BUSY_IMMINENT,
186};
187
188struct skd_fitmsg_context {
189 enum skd_fit_msg_state state;
190
191 struct skd_fitmsg_context *next;
192
193 u32 id;
194 u16 outstanding;
195
196 u32 length;
197 u32 offset;
198
199 u8 *msg_buf;
200 dma_addr_t mb_dma_address;
201};
202
203struct skd_request_context {
204 enum skd_req_state state;
205
206 struct skd_request_context *next;
207
208 u16 id;
209 u32 fitmsg_id;
210
211 struct request *req;
e67f86b3 212 u8 flush_cmd;
e67f86b3
AB
213
214 u32 timeout_stamp;
215 u8 sg_data_dir;
216 struct scatterlist *sg;
217 u32 n_sg;
218 u32 sg_byte_count;
219
220 struct fit_sg_descriptor *sksg_list;
221 dma_addr_t sksg_dma_address;
222
223 struct fit_completion_entry_v1 completion;
224
225 struct fit_comp_error_info err_info;
226
227};
228#define SKD_DATA_DIR_HOST_TO_CARD 1
229#define SKD_DATA_DIR_CARD_TO_HOST 2
e67f86b3
AB
230
231struct skd_special_context {
232 struct skd_request_context req;
233
234 u8 orphaned;
235
236 void *data_buf;
237 dma_addr_t db_dma_address;
238
239 u8 *msg_buf;
240 dma_addr_t mb_dma_address;
241};
242
243struct skd_sg_io {
244 fmode_t mode;
245 void __user *argp;
246
247 struct sg_io_hdr sg;
248
249 u8 cdb[16];
250
251 u32 dxfer_len;
252 u32 iovcnt;
253 struct sg_iovec *iov;
254 struct sg_iovec no_iov_iov;
255
256 struct skd_special_context *skspcl;
257};
258
259typedef enum skd_irq_type {
260 SKD_IRQ_LEGACY,
261 SKD_IRQ_MSI,
262 SKD_IRQ_MSIX
263} skd_irq_type_t;
264
265#define SKD_MAX_BARS 2
266
267struct skd_device {
268 volatile void __iomem *mem_map[SKD_MAX_BARS];
269 resource_size_t mem_phys[SKD_MAX_BARS];
270 u32 mem_size[SKD_MAX_BARS];
271
e67f86b3
AB
272 struct skd_msix_entry *msix_entries;
273
274 struct pci_dev *pdev;
275 int pcie_error_reporting_is_enabled;
276
277 spinlock_t lock;
278 struct gendisk *disk;
279 struct request_queue *queue;
280 struct device *class_dev;
281 int gendisk_on;
282 int sync_done;
283
284 atomic_t device_count;
285 u32 devno;
286 u32 major;
287 char name[32];
288 char isr_name[30];
289
290 enum skd_drvr_state state;
291 u32 drive_state;
292
293 u32 in_flight;
294 u32 cur_max_queue_depth;
295 u32 queue_low_water_mark;
296 u32 dev_max_queue_depth;
297
298 u32 num_fitmsg_context;
299 u32 num_req_context;
300
301 u32 timeout_slot[SKD_N_TIMEOUT_SLOT];
302 u32 timeout_stamp;
303 struct skd_fitmsg_context *skmsg_free_list;
304 struct skd_fitmsg_context *skmsg_table;
305
306 struct skd_request_context *skreq_free_list;
307 struct skd_request_context *skreq_table;
308
309 struct skd_special_context *skspcl_free_list;
310 struct skd_special_context *skspcl_table;
311
312 struct skd_special_context internal_skspcl;
313 u32 read_cap_blocksize;
314 u32 read_cap_last_lba;
315 int read_cap_is_valid;
316 int inquiry_is_valid;
317 u8 inq_serial_num[13]; /*12 chars plus null term */
318 u8 id_str[80]; /* holds a composite name (pci + sernum) */
319
320 u8 skcomp_cycle;
321 u32 skcomp_ix;
322 struct fit_completion_entry_v1 *skcomp_table;
323 struct fit_comp_error_info *skerr_table;
324 dma_addr_t cq_dma_address;
325
326 wait_queue_head_t waitq;
327
328 struct timer_list timer;
329 u32 timer_countdown;
330 u32 timer_substate;
331
332 int n_special;
333 int sgs_per_request;
334 u32 last_mtd;
335
336 u32 proto_ver;
337
338 int dbg_level;
339 u32 connect_time_stamp;
340 int connect_retries;
341#define SKD_MAX_CONNECT_RETRIES 16
342 u32 drive_jiffies;
343
344 u32 timo_slot;
345
e67f86b3 346
38d4a1bb 347 struct work_struct completion_worker;
e67f86b3
AB
348};
349
350#define SKD_WRITEL(DEV, VAL, OFF) skd_reg_write32(DEV, VAL, OFF)
351#define SKD_READL(DEV, OFF) skd_reg_read32(DEV, OFF)
352#define SKD_WRITEQ(DEV, VAL, OFF) skd_reg_write64(DEV, VAL, OFF)
353
354static inline u32 skd_reg_read32(struct skd_device *skdev, u32 offset)
355{
356 u32 val;
357
358 if (likely(skdev->dbg_level < 2))
359 return readl(skdev->mem_map[1] + offset);
360 else {
361 barrier();
362 val = readl(skdev->mem_map[1] + offset);
363 barrier();
2e44b427 364 pr_debug("%s:%s:%d offset %x = %x\n",
365 skdev->name, __func__, __LINE__, offset, val);
e67f86b3
AB
366 return val;
367 }
368
369}
370
371static inline void skd_reg_write32(struct skd_device *skdev, u32 val,
372 u32 offset)
373{
374 if (likely(skdev->dbg_level < 2)) {
375 writel(val, skdev->mem_map[1] + offset);
376 barrier();
e67f86b3
AB
377 } else {
378 barrier();
379 writel(val, skdev->mem_map[1] + offset);
380 barrier();
2e44b427 381 pr_debug("%s:%s:%d offset %x = %x\n",
382 skdev->name, __func__, __LINE__, offset, val);
e67f86b3
AB
383 }
384}
385
386static inline void skd_reg_write64(struct skd_device *skdev, u64 val,
387 u32 offset)
388{
389 if (likely(skdev->dbg_level < 2)) {
390 writeq(val, skdev->mem_map[1] + offset);
391 barrier();
e67f86b3
AB
392 } else {
393 barrier();
394 writeq(val, skdev->mem_map[1] + offset);
395 barrier();
2e44b427 396 pr_debug("%s:%s:%d offset %x = %016llx\n",
397 skdev->name, __func__, __LINE__, offset, val);
e67f86b3
AB
398 }
399}
400
401
402#define SKD_IRQ_DEFAULT SKD_IRQ_MSI
403static int skd_isr_type = SKD_IRQ_DEFAULT;
404
405module_param(skd_isr_type, int, 0444);
406MODULE_PARM_DESC(skd_isr_type, "Interrupt type capability."
407 " (0==legacy, 1==MSI, 2==MSI-X, default==1)");
408
409#define SKD_MAX_REQ_PER_MSG_DEFAULT 1
410static int skd_max_req_per_msg = SKD_MAX_REQ_PER_MSG_DEFAULT;
411
412module_param(skd_max_req_per_msg, int, 0444);
413MODULE_PARM_DESC(skd_max_req_per_msg,
414 "Maximum SCSI requests packed in a single message."
415 " (1-14, default==1)");
416
417#define SKD_MAX_QUEUE_DEPTH_DEFAULT 64
418#define SKD_MAX_QUEUE_DEPTH_DEFAULT_STR "64"
419static int skd_max_queue_depth = SKD_MAX_QUEUE_DEPTH_DEFAULT;
420
421module_param(skd_max_queue_depth, int, 0444);
422MODULE_PARM_DESC(skd_max_queue_depth,
423 "Maximum SCSI requests issued to s1120."
424 " (1-200, default==" SKD_MAX_QUEUE_DEPTH_DEFAULT_STR ")");
425
426static int skd_sgs_per_request = SKD_N_SG_PER_REQ_DEFAULT;
427module_param(skd_sgs_per_request, int, 0444);
428MODULE_PARM_DESC(skd_sgs_per_request,
429 "Maximum SG elements per block request."
430 " (1-4096, default==256)");
431
432static int skd_max_pass_thru = SKD_N_SPECIAL_CONTEXT;
433module_param(skd_max_pass_thru, int, 0444);
434MODULE_PARM_DESC(skd_max_pass_thru,
435 "Maximum SCSI pass-thru at a time." " (1-50, default==32)");
436
437module_param(skd_dbg_level, int, 0444);
438MODULE_PARM_DESC(skd_dbg_level, "s1120 debug level (0,1,2)");
439
440module_param(skd_isr_comp_limit, int, 0444);
441MODULE_PARM_DESC(skd_isr_comp_limit, "s1120 isr comp limit (0=none) default=4");
442
e67f86b3
AB
443/* Major device number dynamically assigned. */
444static u32 skd_major;
445
e67f86b3
AB
446static void skd_destruct(struct skd_device *skdev);
447static const struct block_device_operations skd_blockdev_ops;
448static void skd_send_fitmsg(struct skd_device *skdev,
449 struct skd_fitmsg_context *skmsg);
450static void skd_send_special_fitmsg(struct skd_device *skdev,
451 struct skd_special_context *skspcl);
452static void skd_request_fn(struct request_queue *rq);
453static void skd_end_request(struct skd_device *skdev,
2a842aca
CH
454 struct skd_request_context *skreq, blk_status_t status);
455static bool skd_preop_sg_list(struct skd_device *skdev,
e67f86b3
AB
456 struct skd_request_context *skreq);
457static void skd_postop_sg_list(struct skd_device *skdev,
458 struct skd_request_context *skreq);
459
460static void skd_restart_device(struct skd_device *skdev);
461static int skd_quiesce_dev(struct skd_device *skdev);
462static int skd_unquiesce_dev(struct skd_device *skdev);
463static void skd_release_special(struct skd_device *skdev,
464 struct skd_special_context *skspcl);
465static void skd_disable_interrupts(struct skd_device *skdev);
466static void skd_isr_fwstate(struct skd_device *skdev);
467static void skd_recover_requests(struct skd_device *skdev, int requeue);
468static void skd_soft_reset(struct skd_device *skdev);
469
470static const char *skd_name(struct skd_device *skdev);
471const char *skd_drive_state_to_str(int state);
472const char *skd_skdev_state_to_str(enum skd_drvr_state state);
473static void skd_log_skdev(struct skd_device *skdev, const char *event);
474static void skd_log_skmsg(struct skd_device *skdev,
475 struct skd_fitmsg_context *skmsg, const char *event);
476static void skd_log_skreq(struct skd_device *skdev,
477 struct skd_request_context *skreq, const char *event);
478
e67f86b3
AB
479/*
480 *****************************************************************************
481 * READ/WRITE REQUESTS
482 *****************************************************************************
483 */
fcd37eb3 484static void skd_fail_all_pending(struct skd_device *skdev)
e67f86b3
AB
485{
486 struct request_queue *q = skdev->queue;
487 struct request *req;
488
489 for (;; ) {
490 req = blk_peek_request(q);
491 if (req == NULL)
492 break;
493 blk_start_request(req);
2a842aca 494 __blk_end_request_all(req, BLK_STS_IOERR);
e67f86b3
AB
495 }
496}
497
e67f86b3
AB
498static void
499skd_prep_rw_cdb(struct skd_scsi_request *scsi_req,
500 int data_dir, unsigned lba,
501 unsigned count)
502{
503 if (data_dir == READ)
504 scsi_req->cdb[0] = 0x28;
505 else
506 scsi_req->cdb[0] = 0x2a;
507
508 scsi_req->cdb[1] = 0;
509 scsi_req->cdb[2] = (lba & 0xff000000) >> 24;
510 scsi_req->cdb[3] = (lba & 0xff0000) >> 16;
511 scsi_req->cdb[4] = (lba & 0xff00) >> 8;
512 scsi_req->cdb[5] = (lba & 0xff);
513 scsi_req->cdb[6] = 0;
514 scsi_req->cdb[7] = (count & 0xff00) >> 8;
515 scsi_req->cdb[8] = count & 0xff;
516 scsi_req->cdb[9] = 0;
517}
518
519static void
520skd_prep_zerosize_flush_cdb(struct skd_scsi_request *scsi_req,
38d4a1bb 521 struct skd_request_context *skreq)
e67f86b3
AB
522{
523 skreq->flush_cmd = 1;
524
525 scsi_req->cdb[0] = 0x35;
526 scsi_req->cdb[1] = 0;
527 scsi_req->cdb[2] = 0;
528 scsi_req->cdb[3] = 0;
529 scsi_req->cdb[4] = 0;
530 scsi_req->cdb[5] = 0;
531 scsi_req->cdb[6] = 0;
532 scsi_req->cdb[7] = 0;
533 scsi_req->cdb[8] = 0;
534 scsi_req->cdb[9] = 0;
535}
536
e67f86b3
AB
537static void skd_request_fn_not_online(struct request_queue *q);
538
539static void skd_request_fn(struct request_queue *q)
540{
541 struct skd_device *skdev = q->queuedata;
542 struct skd_fitmsg_context *skmsg = NULL;
543 struct fit_msg_hdr *fmh = NULL;
544 struct skd_request_context *skreq;
545 struct request *req = NULL;
e67f86b3 546 struct skd_scsi_request *scsi_req;
e67f86b3 547 unsigned long io_flags;
e67f86b3
AB
548 u32 lba;
549 u32 count;
550 int data_dir;
551 u32 be_lba;
552 u32 be_count;
553 u64 be_dmaa;
554 u64 cmdctxt;
555 u32 timo_slot;
556 void *cmd_ptr;
557 int flush, fua;
558
559 if (skdev->state != SKD_DRVR_STATE_ONLINE) {
560 skd_request_fn_not_online(q);
561 return;
562 }
563
6a5ec65b 564 if (blk_queue_stopped(skdev->queue)) {
e67f86b3
AB
565 if (skdev->skmsg_free_list == NULL ||
566 skdev->skreq_free_list == NULL ||
567 skdev->in_flight >= skdev->queue_low_water_mark)
568 /* There is still some kind of shortage */
569 return;
570
6a5ec65b 571 queue_flag_clear(QUEUE_FLAG_STOPPED, skdev->queue);
e67f86b3
AB
572 }
573
574 /*
575 * Stop conditions:
576 * - There are no more native requests
577 * - There are already the maximum number of requests in progress
578 * - There are no more skd_request_context entries
579 * - There are no more FIT msg buffers
580 */
581 for (;; ) {
582
583 flush = fua = 0;
584
fcd37eb3 585 req = blk_peek_request(q);
e67f86b3 586
fcd37eb3
JA
587 /* Are there any native requests to start? */
588 if (req == NULL)
589 break;
e67f86b3 590
fcd37eb3
JA
591 lba = (u32)blk_rq_pos(req);
592 count = blk_rq_sectors(req);
593 data_dir = rq_data_dir(req);
594 io_flags = req->cmd_flags;
e67f86b3 595
3a5e02ce 596 if (req_op(req) == REQ_OP_FLUSH)
fcd37eb3 597 flush++;
e67f86b3 598
fcd37eb3
JA
599 if (io_flags & REQ_FUA)
600 fua++;
e67f86b3 601
fcd37eb3
JA
602 pr_debug("%s:%s:%d new req=%p lba=%u(0x%x) "
603 "count=%u(0x%x) dir=%d\n",
604 skdev->name, __func__, __LINE__,
605 req, lba, lba, count, count, data_dir);
e67f86b3 606
38d4a1bb 607 /* At this point we know there is a request */
e67f86b3
AB
608
609 /* Are too many requets already in progress? */
610 if (skdev->in_flight >= skdev->cur_max_queue_depth) {
2e44b427 611 pr_debug("%s:%s:%d qdepth %d, limit %d\n",
612 skdev->name, __func__, __LINE__,
613 skdev->in_flight, skdev->cur_max_queue_depth);
e67f86b3
AB
614 break;
615 }
616
617 /* Is a skd_request_context available? */
618 skreq = skdev->skreq_free_list;
619 if (skreq == NULL) {
2e44b427 620 pr_debug("%s:%s:%d Out of req=%p\n",
621 skdev->name, __func__, __LINE__, q);
e67f86b3
AB
622 break;
623 }
624 SKD_ASSERT(skreq->state == SKD_REQ_STATE_IDLE);
625 SKD_ASSERT((skreq->id & SKD_ID_INCR) == 0);
626
627 /* Now we check to see if we can get a fit msg */
628 if (skmsg == NULL) {
629 if (skdev->skmsg_free_list == NULL) {
2e44b427 630 pr_debug("%s:%s:%d Out of msg\n",
631 skdev->name, __func__, __LINE__);
e67f86b3
AB
632 break;
633 }
634 }
635
636 skreq->flush_cmd = 0;
637 skreq->n_sg = 0;
638 skreq->sg_byte_count = 0;
e67f86b3
AB
639
640 /*
38d4a1bb 641 * OK to now dequeue request from q.
e67f86b3
AB
642 *
643 * At this point we are comitted to either start or reject
644 * the native request. Note that skd_request_context is
645 * available but is still at the head of the free list.
646 */
fcd37eb3
JA
647 blk_start_request(req);
648 skreq->req = req;
649 skreq->fitmsg_id = 0;
e67f86b3
AB
650
651 /* Either a FIT msg is in progress or we have to start one. */
652 if (skmsg == NULL) {
653 /* Are there any FIT msg buffers available? */
654 skmsg = skdev->skmsg_free_list;
655 if (skmsg == NULL) {
2e44b427 656 pr_debug("%s:%s:%d Out of msg skdev=%p\n",
657 skdev->name, __func__, __LINE__,
658 skdev);
e67f86b3
AB
659 break;
660 }
661 SKD_ASSERT(skmsg->state == SKD_MSG_STATE_IDLE);
662 SKD_ASSERT((skmsg->id & SKD_ID_INCR) == 0);
663
664 skdev->skmsg_free_list = skmsg->next;
665
666 skmsg->state = SKD_MSG_STATE_BUSY;
667 skmsg->id += SKD_ID_INCR;
668
669 /* Initialize the FIT msg header */
670 fmh = (struct fit_msg_hdr *)skmsg->msg_buf;
671 memset(fmh, 0, sizeof(*fmh));
672 fmh->protocol_id = FIT_PROTOCOL_ID_SOFIT;
673 skmsg->length = sizeof(*fmh);
674 }
675
676 skreq->fitmsg_id = skmsg->id;
677
678 /*
679 * Note that a FIT msg may have just been started
680 * but contains no SoFIT requests yet.
681 */
682
683 /*
684 * Transcode the request, checking as we go. The outcome of
685 * the transcoding is represented by the error variable.
686 */
687 cmd_ptr = &skmsg->msg_buf[skmsg->length];
688 memset(cmd_ptr, 0, 32);
689
690 be_lba = cpu_to_be32(lba);
691 be_count = cpu_to_be32(count);
692 be_dmaa = cpu_to_be64((u64)skreq->sksg_dma_address);
693 cmdctxt = skreq->id + SKD_ID_INCR;
694
695 scsi_req = cmd_ptr;
696 scsi_req->hdr.tag = cmdctxt;
697 scsi_req->hdr.sg_list_dma_address = be_dmaa;
698
699 if (data_dir == READ)
700 skreq->sg_data_dir = SKD_DATA_DIR_CARD_TO_HOST;
701 else
702 skreq->sg_data_dir = SKD_DATA_DIR_HOST_TO_CARD;
703
49bdedb3 704 if (flush == SKD_FLUSH_ZERO_SIZE_FIRST) {
e67f86b3
AB
705 skd_prep_zerosize_flush_cdb(scsi_req, skreq);
706 SKD_ASSERT(skreq->flush_cmd == 1);
707
708 } else {
709 skd_prep_rw_cdb(scsi_req, data_dir, lba, count);
710 }
711
712 if (fua)
713 scsi_req->cdb[1] |= SKD_FUA_NV;
714
fcd37eb3 715 if (!req->bio)
e67f86b3
AB
716 goto skip_sg;
717
2a842aca 718 if (!skd_preop_sg_list(skdev, skreq)) {
e67f86b3
AB
719 /*
720 * Complete the native request with error.
721 * Note that the request context is still at the
722 * head of the free list, and that the SoFIT request
723 * was encoded into the FIT msg buffer but the FIT
724 * msg length has not been updated. In short, the
725 * only resource that has been allocated but might
726 * not be used is that the FIT msg could be empty.
727 */
2e44b427 728 pr_debug("%s:%s:%d error Out\n",
729 skdev->name, __func__, __LINE__);
2a842aca 730 skd_end_request(skdev, skreq, BLK_STS_RESOURCE);
e67f86b3
AB
731 continue;
732 }
733
734skip_sg:
735 scsi_req->hdr.sg_list_len_bytes =
736 cpu_to_be32(skreq->sg_byte_count);
737
738 /* Complete resource allocations. */
739 skdev->skreq_free_list = skreq->next;
740 skreq->state = SKD_REQ_STATE_BUSY;
741 skreq->id += SKD_ID_INCR;
742
743 skmsg->length += sizeof(struct skd_scsi_request);
744 fmh->num_protocol_cmds_coalesced++;
745
746 /*
747 * Update the active request counts.
748 * Capture the timeout timestamp.
749 */
750 skreq->timeout_stamp = skdev->timeout_stamp;
751 timo_slot = skreq->timeout_stamp & SKD_TIMEOUT_SLOT_MASK;
752 skdev->timeout_slot[timo_slot]++;
753 skdev->in_flight++;
2e44b427 754 pr_debug("%s:%s:%d req=0x%x busy=%d\n",
755 skdev->name, __func__, __LINE__,
756 skreq->id, skdev->in_flight);
e67f86b3
AB
757
758 /*
759 * If the FIT msg buffer is full send it.
760 */
761 if (skmsg->length >= SKD_N_FITMSG_BYTES ||
762 fmh->num_protocol_cmds_coalesced >= skd_max_req_per_msg) {
763 skd_send_fitmsg(skdev, skmsg);
764 skmsg = NULL;
765 fmh = NULL;
766 }
767 }
768
769 /*
770 * Is a FIT msg in progress? If it is empty put the buffer back
771 * on the free list. If it is non-empty send what we got.
772 * This minimizes latency when there are fewer requests than
773 * what fits in a FIT msg.
774 */
775 if (skmsg != NULL) {
776 /* Bigger than just a FIT msg header? */
777 if (skmsg->length > sizeof(struct fit_msg_hdr)) {
2e44b427 778 pr_debug("%s:%s:%d sending msg=%p, len %d\n",
779 skdev->name, __func__, __LINE__,
780 skmsg, skmsg->length);
e67f86b3
AB
781 skd_send_fitmsg(skdev, skmsg);
782 } else {
783 /*
784 * The FIT msg is empty. It means we got started
785 * on the msg, but the requests were rejected.
786 */
787 skmsg->state = SKD_MSG_STATE_IDLE;
788 skmsg->id += SKD_ID_INCR;
789 skmsg->next = skdev->skmsg_free_list;
790 skdev->skmsg_free_list = skmsg;
791 }
792 skmsg = NULL;
793 fmh = NULL;
794 }
795
796 /*
797 * If req is non-NULL it means there is something to do but
798 * we are out of a resource.
799 */
fcd37eb3 800 if (req)
6a5ec65b 801 blk_stop_queue(skdev->queue);
e67f86b3
AB
802}
803
38d4a1bb 804static void skd_end_request(struct skd_device *skdev,
2a842aca 805 struct skd_request_context *skreq, blk_status_t error)
e67f86b3 806{
e67f86b3
AB
807 if (unlikely(error)) {
808 struct request *req = skreq->req;
809 char *cmd = (rq_data_dir(req) == READ) ? "read" : "write";
810 u32 lba = (u32)blk_rq_pos(req);
811 u32 count = blk_rq_sectors(req);
812
813 pr_err("(%s): Error cmd=%s sect=%u count=%u id=0x%x\n",
814 skd_name(skdev), cmd, lba, count, skreq->id);
815 } else
2e44b427 816 pr_debug("%s:%s:%d id=0x%x error=%d\n",
817 skdev->name, __func__, __LINE__, skreq->id, error);
e67f86b3
AB
818
819 __blk_end_request_all(skreq->req, error);
820}
821
2a842aca 822static bool skd_preop_sg_list(struct skd_device *skdev,
38d4a1bb 823 struct skd_request_context *skreq)
e67f86b3
AB
824{
825 struct request *req = skreq->req;
826 int writing = skreq->sg_data_dir == SKD_DATA_DIR_HOST_TO_CARD;
827 int pci_dir = writing ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE;
828 struct scatterlist *sg = &skreq->sg[0];
829 int n_sg;
830 int i;
831
832 skreq->sg_byte_count = 0;
833
834 /* SKD_ASSERT(skreq->sg_data_dir == SKD_DATA_DIR_HOST_TO_CARD ||
835 skreq->sg_data_dir == SKD_DATA_DIR_CARD_TO_HOST); */
836
837 n_sg = blk_rq_map_sg(skdev->queue, req, sg);
838 if (n_sg <= 0)
2a842aca 839 return false;
e67f86b3
AB
840
841 /*
842 * Map scatterlist to PCI bus addresses.
843 * Note PCI might change the number of entries.
844 */
845 n_sg = pci_map_sg(skdev->pdev, sg, n_sg, pci_dir);
846 if (n_sg <= 0)
2a842aca 847 return false;
e67f86b3
AB
848
849 SKD_ASSERT(n_sg <= skdev->sgs_per_request);
850
851 skreq->n_sg = n_sg;
852
853 for (i = 0; i < n_sg; i++) {
854 struct fit_sg_descriptor *sgd = &skreq->sksg_list[i];
855 u32 cnt = sg_dma_len(&sg[i]);
856 uint64_t dma_addr = sg_dma_address(&sg[i]);
857
858 sgd->control = FIT_SGD_CONTROL_NOT_LAST;
859 sgd->byte_count = cnt;
860 skreq->sg_byte_count += cnt;
861 sgd->host_side_addr = dma_addr;
862 sgd->dev_side_addr = 0;
863 }
864
865 skreq->sksg_list[n_sg - 1].next_desc_ptr = 0LL;
866 skreq->sksg_list[n_sg - 1].control = FIT_SGD_CONTROL_LAST;
867
868 if (unlikely(skdev->dbg_level > 1)) {
2e44b427 869 pr_debug("%s:%s:%d skreq=%x sksg_list=%p sksg_dma=%llx\n",
870 skdev->name, __func__, __LINE__,
871 skreq->id, skreq->sksg_list, skreq->sksg_dma_address);
e67f86b3
AB
872 for (i = 0; i < n_sg; i++) {
873 struct fit_sg_descriptor *sgd = &skreq->sksg_list[i];
2e44b427 874 pr_debug("%s:%s:%d sg[%d] count=%u ctrl=0x%x "
875 "addr=0x%llx next=0x%llx\n",
876 skdev->name, __func__, __LINE__,
877 i, sgd->byte_count, sgd->control,
878 sgd->host_side_addr, sgd->next_desc_ptr);
e67f86b3
AB
879 }
880 }
881
2a842aca 882 return true;
e67f86b3
AB
883}
884
fcd37eb3 885static void skd_postop_sg_list(struct skd_device *skdev,
38d4a1bb 886 struct skd_request_context *skreq)
e67f86b3
AB
887{
888 int writing = skreq->sg_data_dir == SKD_DATA_DIR_HOST_TO_CARD;
889 int pci_dir = writing ? PCI_DMA_TODEVICE : PCI_DMA_FROMDEVICE;
890
891 /*
892 * restore the next ptr for next IO request so we
893 * don't have to set it every time.
894 */
895 skreq->sksg_list[skreq->n_sg - 1].next_desc_ptr =
896 skreq->sksg_dma_address +
897 ((skreq->n_sg) * sizeof(struct fit_sg_descriptor));
898 pci_unmap_sg(skdev->pdev, &skreq->sg[0], skreq->n_sg, pci_dir);
899}
900
e67f86b3
AB
901static void skd_request_fn_not_online(struct request_queue *q)
902{
903 struct skd_device *skdev = q->queuedata;
904 int error;
905
906 SKD_ASSERT(skdev->state != SKD_DRVR_STATE_ONLINE);
907
908 skd_log_skdev(skdev, "req_not_online");
909 switch (skdev->state) {
910 case SKD_DRVR_STATE_PAUSING:
911 case SKD_DRVR_STATE_PAUSED:
912 case SKD_DRVR_STATE_STARTING:
913 case SKD_DRVR_STATE_RESTARTING:
914 case SKD_DRVR_STATE_WAIT_BOOT:
915 /* In case of starting, we haven't started the queue,
916 * so we can't get here... but requests are
917 * possibly hanging out waiting for us because we
918 * reported the dev/skd0 already. They'll wait
919 * forever if connect doesn't complete.
920 * What to do??? delay dev/skd0 ??
921 */
922 case SKD_DRVR_STATE_BUSY:
923 case SKD_DRVR_STATE_BUSY_IMMINENT:
924 case SKD_DRVR_STATE_BUSY_ERASE:
925 case SKD_DRVR_STATE_DRAINING_TIMEOUT:
926 return;
927
928 case SKD_DRVR_STATE_BUSY_SANITIZE:
929 case SKD_DRVR_STATE_STOPPING:
930 case SKD_DRVR_STATE_SYNCING:
931 case SKD_DRVR_STATE_FAULT:
932 case SKD_DRVR_STATE_DISAPPEARED:
933 default:
934 error = -EIO;
935 break;
936 }
937
938 /* If we get here, terminate all pending block requeusts
939 * with EIO and any scsi pass thru with appropriate sense
940 */
941
942 skd_fail_all_pending(skdev);
943}
944
945/*
946 *****************************************************************************
947 * TIMER
948 *****************************************************************************
949 */
950
951static void skd_timer_tick_not_online(struct skd_device *skdev);
952
953static void skd_timer_tick(ulong arg)
954{
955 struct skd_device *skdev = (struct skd_device *)arg;
956
957 u32 timo_slot;
958 u32 overdue_timestamp;
959 unsigned long reqflags;
960 u32 state;
961
962 if (skdev->state == SKD_DRVR_STATE_FAULT)
963 /* The driver has declared fault, and we want it to
964 * stay that way until driver is reloaded.
965 */
966 return;
967
968 spin_lock_irqsave(&skdev->lock, reqflags);
969
970 state = SKD_READL(skdev, FIT_STATUS);
971 state &= FIT_SR_DRIVE_STATE_MASK;
972 if (state != skdev->drive_state)
973 skd_isr_fwstate(skdev);
974
975 if (skdev->state != SKD_DRVR_STATE_ONLINE) {
976 skd_timer_tick_not_online(skdev);
977 goto timer_func_out;
978 }
979 skdev->timeout_stamp++;
980 timo_slot = skdev->timeout_stamp & SKD_TIMEOUT_SLOT_MASK;
981
982 /*
983 * All requests that happened during the previous use of
984 * this slot should be done by now. The previous use was
985 * over 7 seconds ago.
986 */
987 if (skdev->timeout_slot[timo_slot] == 0)
988 goto timer_func_out;
989
990 /* Something is overdue */
991 overdue_timestamp = skdev->timeout_stamp - SKD_N_TIMEOUT_SLOT;
992
2e44b427 993 pr_debug("%s:%s:%d found %d timeouts, draining busy=%d\n",
994 skdev->name, __func__, __LINE__,
995 skdev->timeout_slot[timo_slot], skdev->in_flight);
e67f86b3
AB
996 pr_err("(%s): Overdue IOs (%d), busy %d\n",
997 skd_name(skdev), skdev->timeout_slot[timo_slot],
998 skdev->in_flight);
999
1000 skdev->timer_countdown = SKD_DRAINING_TIMO;
1001 skdev->state = SKD_DRVR_STATE_DRAINING_TIMEOUT;
1002 skdev->timo_slot = timo_slot;
6a5ec65b 1003 blk_stop_queue(skdev->queue);
e67f86b3
AB
1004
1005timer_func_out:
1006 mod_timer(&skdev->timer, (jiffies + HZ));
1007
1008 spin_unlock_irqrestore(&skdev->lock, reqflags);
1009}
1010
1011static void skd_timer_tick_not_online(struct skd_device *skdev)
1012{
1013 switch (skdev->state) {
1014 case SKD_DRVR_STATE_IDLE:
1015 case SKD_DRVR_STATE_LOAD:
1016 break;
1017 case SKD_DRVR_STATE_BUSY_SANITIZE:
2e44b427 1018 pr_debug("%s:%s:%d drive busy sanitize[%x], driver[%x]\n",
1019 skdev->name, __func__, __LINE__,
1020 skdev->drive_state, skdev->state);
e67f86b3
AB
1021 /* If we've been in sanitize for 3 seconds, we figure we're not
1022 * going to get anymore completions, so recover requests now
1023 */
1024 if (skdev->timer_countdown > 0) {
1025 skdev->timer_countdown--;
1026 return;
1027 }
1028 skd_recover_requests(skdev, 0);
1029 break;
1030
1031 case SKD_DRVR_STATE_BUSY:
1032 case SKD_DRVR_STATE_BUSY_IMMINENT:
1033 case SKD_DRVR_STATE_BUSY_ERASE:
2e44b427 1034 pr_debug("%s:%s:%d busy[%x], countdown=%d\n",
1035 skdev->name, __func__, __LINE__,
1036 skdev->state, skdev->timer_countdown);
e67f86b3
AB
1037 if (skdev->timer_countdown > 0) {
1038 skdev->timer_countdown--;
1039 return;
1040 }
2e44b427 1041 pr_debug("%s:%s:%d busy[%x], timedout=%d, restarting device.",
1042 skdev->name, __func__, __LINE__,
1043 skdev->state, skdev->timer_countdown);
e67f86b3
AB
1044 skd_restart_device(skdev);
1045 break;
1046
1047 case SKD_DRVR_STATE_WAIT_BOOT:
1048 case SKD_DRVR_STATE_STARTING:
1049 if (skdev->timer_countdown > 0) {
1050 skdev->timer_countdown--;
1051 return;
1052 }
1053 /* For now, we fault the drive. Could attempt resets to
1054 * revcover at some point. */
1055 skdev->state = SKD_DRVR_STATE_FAULT;
1056
1057 pr_err("(%s): DriveFault Connect Timeout (%x)\n",
1058 skd_name(skdev), skdev->drive_state);
1059
1060 /*start the queue so we can respond with error to requests */
1061 /* wakeup anyone waiting for startup complete */
6a5ec65b 1062 blk_start_queue(skdev->queue);
e67f86b3
AB
1063 skdev->gendisk_on = -1;
1064 wake_up_interruptible(&skdev->waitq);
1065 break;
1066
1067 case SKD_DRVR_STATE_ONLINE:
1068 /* shouldn't get here. */
1069 break;
1070
1071 case SKD_DRVR_STATE_PAUSING:
1072 case SKD_DRVR_STATE_PAUSED:
1073 break;
1074
1075 case SKD_DRVR_STATE_DRAINING_TIMEOUT:
2e44b427 1076 pr_debug("%s:%s:%d "
1077 "draining busy [%d] tick[%d] qdb[%d] tmls[%d]\n",
1078 skdev->name, __func__, __LINE__,
1079 skdev->timo_slot,
1080 skdev->timer_countdown,
1081 skdev->in_flight,
1082 skdev->timeout_slot[skdev->timo_slot]);
e67f86b3
AB
1083 /* if the slot has cleared we can let the I/O continue */
1084 if (skdev->timeout_slot[skdev->timo_slot] == 0) {
2e44b427 1085 pr_debug("%s:%s:%d Slot drained, starting queue.\n",
1086 skdev->name, __func__, __LINE__);
e67f86b3 1087 skdev->state = SKD_DRVR_STATE_ONLINE;
6a5ec65b 1088 blk_start_queue(skdev->queue);
e67f86b3
AB
1089 return;
1090 }
1091 if (skdev->timer_countdown > 0) {
1092 skdev->timer_countdown--;
1093 return;
1094 }
1095 skd_restart_device(skdev);
1096 break;
1097
1098 case SKD_DRVR_STATE_RESTARTING:
1099 if (skdev->timer_countdown > 0) {
1100 skdev->timer_countdown--;
1101 return;
1102 }
1103 /* For now, we fault the drive. Could attempt resets to
1104 * revcover at some point. */
1105 skdev->state = SKD_DRVR_STATE_FAULT;
1106 pr_err("(%s): DriveFault Reconnect Timeout (%x)\n",
1107 skd_name(skdev), skdev->drive_state);
1108
1109 /*
1110 * Recovering does two things:
1111 * 1. completes IO with error
1112 * 2. reclaims dma resources
1113 * When is it safe to recover requests?
1114 * - if the drive state is faulted
1115 * - if the state is still soft reset after out timeout
1116 * - if the drive registers are dead (state = FF)
1117 * If it is "unsafe", we still need to recover, so we will
1118 * disable pci bus mastering and disable our interrupts.
1119 */
1120
1121 if ((skdev->drive_state == FIT_SR_DRIVE_SOFT_RESET) ||
1122 (skdev->drive_state == FIT_SR_DRIVE_FAULT) ||
1123 (skdev->drive_state == FIT_SR_DRIVE_STATE_MASK))
1124 /* It never came out of soft reset. Try to
1125 * recover the requests and then let them
1126 * fail. This is to mitigate hung processes. */
1127 skd_recover_requests(skdev, 0);
1128 else {
1129 pr_err("(%s): Disable BusMaster (%x)\n",
1130 skd_name(skdev), skdev->drive_state);
1131 pci_disable_device(skdev->pdev);
1132 skd_disable_interrupts(skdev);
1133 skd_recover_requests(skdev, 0);
1134 }
1135
1136 /*start the queue so we can respond with error to requests */
1137 /* wakeup anyone waiting for startup complete */
6a5ec65b 1138 blk_start_queue(skdev->queue);
e67f86b3
AB
1139 skdev->gendisk_on = -1;
1140 wake_up_interruptible(&skdev->waitq);
1141 break;
1142
1143 case SKD_DRVR_STATE_RESUMING:
1144 case SKD_DRVR_STATE_STOPPING:
1145 case SKD_DRVR_STATE_SYNCING:
1146 case SKD_DRVR_STATE_FAULT:
1147 case SKD_DRVR_STATE_DISAPPEARED:
1148 default:
1149 break;
1150 }
1151}
1152
1153static int skd_start_timer(struct skd_device *skdev)
1154{
1155 int rc;
1156
1157 init_timer(&skdev->timer);
1158 setup_timer(&skdev->timer, skd_timer_tick, (ulong)skdev);
1159
1160 rc = mod_timer(&skdev->timer, (jiffies + HZ));
1161 if (rc)
1162 pr_err("%s: failed to start timer %d\n",
1163 __func__, rc);
1164 return rc;
1165}
1166
1167static void skd_kill_timer(struct skd_device *skdev)
1168{
1169 del_timer_sync(&skdev->timer);
1170}
1171
1172/*
1173 *****************************************************************************
1174 * IOCTL
1175 *****************************************************************************
1176 */
1177static int skd_ioctl_sg_io(struct skd_device *skdev,
1178 fmode_t mode, void __user *argp);
1179static int skd_sg_io_get_and_check_args(struct skd_device *skdev,
1180 struct skd_sg_io *sksgio);
1181static int skd_sg_io_obtain_skspcl(struct skd_device *skdev,
1182 struct skd_sg_io *sksgio);
1183static int skd_sg_io_prep_buffering(struct skd_device *skdev,
1184 struct skd_sg_io *sksgio);
1185static int skd_sg_io_copy_buffer(struct skd_device *skdev,
1186 struct skd_sg_io *sksgio, int dxfer_dir);
1187static int skd_sg_io_send_fitmsg(struct skd_device *skdev,
1188 struct skd_sg_io *sksgio);
1189static int skd_sg_io_await(struct skd_device *skdev, struct skd_sg_io *sksgio);
1190static int skd_sg_io_release_skspcl(struct skd_device *skdev,
1191 struct skd_sg_io *sksgio);
1192static int skd_sg_io_put_status(struct skd_device *skdev,
1193 struct skd_sg_io *sksgio);
1194
1195static void skd_complete_special(struct skd_device *skdev,
1196 volatile struct fit_completion_entry_v1
1197 *skcomp,
1198 volatile struct fit_comp_error_info *skerr,
1199 struct skd_special_context *skspcl);
1200
1201static int skd_bdev_ioctl(struct block_device *bdev, fmode_t mode,
1202 uint cmd_in, ulong arg)
1203{
3719fa86
CH
1204 static const int sg_version_num = 30527;
1205 int rc = 0, timeout;
e67f86b3
AB
1206 struct gendisk *disk = bdev->bd_disk;
1207 struct skd_device *skdev = disk->private_data;
3719fa86 1208 int __user *p = (int __user *)arg;
e67f86b3 1209
2e44b427 1210 pr_debug("%s:%s:%d %s: CMD[%s] ioctl mode 0x%x, cmd 0x%x arg %0lx\n",
1211 skdev->name, __func__, __LINE__,
1212 disk->disk_name, current->comm, mode, cmd_in, arg);
e67f86b3
AB
1213
1214 if (!capable(CAP_SYS_ADMIN))
1215 return -EPERM;
1216
1217 switch (cmd_in) {
1218 case SG_SET_TIMEOUT:
3719fa86
CH
1219 rc = get_user(timeout, p);
1220 if (!rc)
1221 disk->queue->sg_timeout = clock_t_to_jiffies(timeout);
1222 break;
e67f86b3 1223 case SG_GET_TIMEOUT:
3719fa86
CH
1224 rc = jiffies_to_clock_t(disk->queue->sg_timeout);
1225 break;
e67f86b3 1226 case SG_GET_VERSION_NUM:
3719fa86 1227 rc = put_user(sg_version_num, p);
e67f86b3
AB
1228 break;
1229 case SG_IO:
3719fa86 1230 rc = skd_ioctl_sg_io(skdev, mode, (void __user *)arg);
e67f86b3
AB
1231 break;
1232
1233 default:
1234 rc = -ENOTTY;
1235 break;
1236 }
1237
2e44b427 1238 pr_debug("%s:%s:%d %s: completion rc %d\n",
1239 skdev->name, __func__, __LINE__, disk->disk_name, rc);
e67f86b3
AB
1240 return rc;
1241}
1242
1243static int skd_ioctl_sg_io(struct skd_device *skdev, fmode_t mode,
1244 void __user *argp)
1245{
1246 int rc;
1247 struct skd_sg_io sksgio;
1248
1249 memset(&sksgio, 0, sizeof(sksgio));
1250 sksgio.mode = mode;
1251 sksgio.argp = argp;
1252 sksgio.iov = &sksgio.no_iov_iov;
1253
1254 switch (skdev->state) {
1255 case SKD_DRVR_STATE_ONLINE:
1256 case SKD_DRVR_STATE_BUSY_IMMINENT:
1257 break;
1258
1259 default:
2e44b427 1260 pr_debug("%s:%s:%d drive not online\n",
1261 skdev->name, __func__, __LINE__);
e67f86b3
AB
1262 rc = -ENXIO;
1263 goto out;
1264 }
1265
f721bb0d
AB
1266 rc = skd_sg_io_get_and_check_args(skdev, &sksgio);
1267 if (rc)
1268 goto out;
1269
1270 rc = skd_sg_io_obtain_skspcl(skdev, &sksgio);
1271 if (rc)
1272 goto out;
1273
1274 rc = skd_sg_io_prep_buffering(skdev, &sksgio);
1275 if (rc)
1276 goto out;
1277
1278 rc = skd_sg_io_copy_buffer(skdev, &sksgio, SG_DXFER_TO_DEV);
1279 if (rc)
e67f86b3
AB
1280 goto out;
1281
f721bb0d
AB
1282 rc = skd_sg_io_send_fitmsg(skdev, &sksgio);
1283 if (rc)
e67f86b3
AB
1284 goto out;
1285
f721bb0d
AB
1286 rc = skd_sg_io_await(skdev, &sksgio);
1287 if (rc)
1288 goto out;
1289
1290 rc = skd_sg_io_copy_buffer(skdev, &sksgio, SG_DXFER_FROM_DEV);
1291 if (rc)
1292 goto out;
1293
1294 rc = skd_sg_io_put_status(skdev, &sksgio);
1295 if (rc)
e67f86b3
AB
1296 goto out;
1297
1298 rc = 0;
1299
1300out:
1301 skd_sg_io_release_skspcl(skdev, &sksgio);
1302
1303 if (sksgio.iov != NULL && sksgio.iov != &sksgio.no_iov_iov)
1304 kfree(sksgio.iov);
1305 return rc;
1306}
1307
1308static int skd_sg_io_get_and_check_args(struct skd_device *skdev,
1309 struct skd_sg_io *sksgio)
1310{
1311 struct sg_io_hdr *sgp = &sksgio->sg;
1312 int i, acc;
1313
1314 if (!access_ok(VERIFY_WRITE, sksgio->argp, sizeof(sg_io_hdr_t))) {
2e44b427 1315 pr_debug("%s:%s:%d access sg failed %p\n",
1316 skdev->name, __func__, __LINE__, sksgio->argp);
e67f86b3
AB
1317 return -EFAULT;
1318 }
1319
1320 if (__copy_from_user(sgp, sksgio->argp, sizeof(sg_io_hdr_t))) {
2e44b427 1321 pr_debug("%s:%s:%d copy_from_user sg failed %p\n",
1322 skdev->name, __func__, __LINE__, sksgio->argp);
e67f86b3
AB
1323 return -EFAULT;
1324 }
1325
1326 if (sgp->interface_id != SG_INTERFACE_ID_ORIG) {
2e44b427 1327 pr_debug("%s:%s:%d interface_id invalid 0x%x\n",
1328 skdev->name, __func__, __LINE__, sgp->interface_id);
e67f86b3
AB
1329 return -EINVAL;
1330 }
1331
1332 if (sgp->cmd_len > sizeof(sksgio->cdb)) {
2e44b427 1333 pr_debug("%s:%s:%d cmd_len invalid %d\n",
1334 skdev->name, __func__, __LINE__, sgp->cmd_len);
e67f86b3
AB
1335 return -EINVAL;
1336 }
1337
1338 if (sgp->iovec_count > 256) {
2e44b427 1339 pr_debug("%s:%s:%d iovec_count invalid %d\n",
1340 skdev->name, __func__, __LINE__, sgp->iovec_count);
e67f86b3
AB
1341 return -EINVAL;
1342 }
1343
1344 if (sgp->dxfer_len > (PAGE_SIZE * SKD_N_SG_PER_SPECIAL)) {
2e44b427 1345 pr_debug("%s:%s:%d dxfer_len invalid %d\n",
1346 skdev->name, __func__, __LINE__, sgp->dxfer_len);
e67f86b3
AB
1347 return -EINVAL;
1348 }
1349
1350 switch (sgp->dxfer_direction) {
1351 case SG_DXFER_NONE:
1352 acc = -1;
1353 break;
1354
1355 case SG_DXFER_TO_DEV:
1356 acc = VERIFY_READ;
1357 break;
1358
1359 case SG_DXFER_FROM_DEV:
1360 case SG_DXFER_TO_FROM_DEV:
1361 acc = VERIFY_WRITE;
1362 break;
1363
1364 default:
2e44b427 1365 pr_debug("%s:%s:%d dxfer_dir invalid %d\n",
1366 skdev->name, __func__, __LINE__, sgp->dxfer_direction);
e67f86b3
AB
1367 return -EINVAL;
1368 }
1369
1370 if (copy_from_user(sksgio->cdb, sgp->cmdp, sgp->cmd_len)) {
2e44b427 1371 pr_debug("%s:%s:%d copy_from_user cmdp failed %p\n",
1372 skdev->name, __func__, __LINE__, sgp->cmdp);
e67f86b3
AB
1373 return -EFAULT;
1374 }
1375
1376 if (sgp->mx_sb_len != 0) {
1377 if (!access_ok(VERIFY_WRITE, sgp->sbp, sgp->mx_sb_len)) {
2e44b427 1378 pr_debug("%s:%s:%d access sbp failed %p\n",
1379 skdev->name, __func__, __LINE__, sgp->sbp);
e67f86b3
AB
1380 return -EFAULT;
1381 }
1382 }
1383
1384 if (sgp->iovec_count == 0) {
1385 sksgio->iov[0].iov_base = sgp->dxferp;
1386 sksgio->iov[0].iov_len = sgp->dxfer_len;
1387 sksgio->iovcnt = 1;
1388 sksgio->dxfer_len = sgp->dxfer_len;
1389 } else {
1390 struct sg_iovec *iov;
1391 uint nbytes = sizeof(*iov) * sgp->iovec_count;
1392 size_t iov_data_len;
1393
1394 iov = kmalloc(nbytes, GFP_KERNEL);
1395 if (iov == NULL) {
2e44b427 1396 pr_debug("%s:%s:%d alloc iovec failed %d\n",
1397 skdev->name, __func__, __LINE__,
1398 sgp->iovec_count);
e67f86b3
AB
1399 return -ENOMEM;
1400 }
1401 sksgio->iov = iov;
1402 sksgio->iovcnt = sgp->iovec_count;
1403
1404 if (copy_from_user(iov, sgp->dxferp, nbytes)) {
2e44b427 1405 pr_debug("%s:%s:%d copy_from_user iovec failed %p\n",
1406 skdev->name, __func__, __LINE__, sgp->dxferp);
e67f86b3
AB
1407 return -EFAULT;
1408 }
1409
1410 /*
1411 * Sum up the vecs, making sure they don't overflow
1412 */
1413 iov_data_len = 0;
1414 for (i = 0; i < sgp->iovec_count; i++) {
1415 if (iov_data_len + iov[i].iov_len < iov_data_len)
1416 return -EINVAL;
1417 iov_data_len += iov[i].iov_len;
1418 }
1419
1420 /* SG_IO howto says that the shorter of the two wins */
1421 if (sgp->dxfer_len < iov_data_len) {
1422 sksgio->iovcnt = iov_shorten((struct iovec *)iov,
1423 sgp->iovec_count,
1424 sgp->dxfer_len);
1425 sksgio->dxfer_len = sgp->dxfer_len;
1426 } else
1427 sksgio->dxfer_len = iov_data_len;
1428 }
1429
1430 if (sgp->dxfer_direction != SG_DXFER_NONE) {
1431 struct sg_iovec *iov = sksgio->iov;
1432 for (i = 0; i < sksgio->iovcnt; i++, iov++) {
1433 if (!access_ok(acc, iov->iov_base, iov->iov_len)) {
2e44b427 1434 pr_debug("%s:%s:%d access data failed %p/%d\n",
1435 skdev->name, __func__, __LINE__,
1436 iov->iov_base, (int)iov->iov_len);
e67f86b3
AB
1437 return -EFAULT;
1438 }
1439 }
1440 }
1441
1442 return 0;
1443}
1444
1445static int skd_sg_io_obtain_skspcl(struct skd_device *skdev,
1446 struct skd_sg_io *sksgio)
1447{
1448 struct skd_special_context *skspcl = NULL;
1449 int rc;
1450
38d4a1bb 1451 for (;;) {
e67f86b3
AB
1452 ulong flags;
1453
1454 spin_lock_irqsave(&skdev->lock, flags);
1455 skspcl = skdev->skspcl_free_list;
1456 if (skspcl != NULL) {
1457 skdev->skspcl_free_list =
1458 (struct skd_special_context *)skspcl->req.next;
1459 skspcl->req.id += SKD_ID_INCR;
1460 skspcl->req.state = SKD_REQ_STATE_SETUP;
1461 skspcl->orphaned = 0;
1462 skspcl->req.n_sg = 0;
1463 }
1464 spin_unlock_irqrestore(&skdev->lock, flags);
1465
1466 if (skspcl != NULL) {
1467 rc = 0;
1468 break;
1469 }
1470
2e44b427 1471 pr_debug("%s:%s:%d blocking\n",
1472 skdev->name, __func__, __LINE__);
e67f86b3
AB
1473
1474 rc = wait_event_interruptible_timeout(
1475 skdev->waitq,
1476 (skdev->skspcl_free_list != NULL),
1477 msecs_to_jiffies(sksgio->sg.timeout));
1478
2e44b427 1479 pr_debug("%s:%s:%d unblocking, rc=%d\n",
1480 skdev->name, __func__, __LINE__, rc);
e67f86b3
AB
1481
1482 if (rc <= 0) {
1483 if (rc == 0)
1484 rc = -ETIMEDOUT;
1485 else
1486 rc = -EINTR;
1487 break;
1488 }
1489 /*
1490 * If we get here rc > 0 meaning the timeout to
1491 * wait_event_interruptible_timeout() had time left, hence the
1492 * sought event -- non-empty free list -- happened.
1493 * Retry the allocation.
1494 */
1495 }
1496 sksgio->skspcl = skspcl;
1497
1498 return rc;
1499}
1500
1501static int skd_skreq_prep_buffering(struct skd_device *skdev,
1502 struct skd_request_context *skreq,
1503 u32 dxfer_len)
1504{
1505 u32 resid = dxfer_len;
1506
1507 /*
1508 * The DMA engine must have aligned addresses and byte counts.
1509 */
1510 resid += (-resid) & 3;
1511 skreq->sg_byte_count = resid;
1512
1513 skreq->n_sg = 0;
1514
1515 while (resid > 0) {
1516 u32 nbytes = PAGE_SIZE;
1517 u32 ix = skreq->n_sg;
1518 struct scatterlist *sg = &skreq->sg[ix];
1519 struct fit_sg_descriptor *sksg = &skreq->sksg_list[ix];
1520 struct page *page;
1521
1522 if (nbytes > resid)
1523 nbytes = resid;
1524
1525 page = alloc_page(GFP_KERNEL);
1526 if (page == NULL)
1527 return -ENOMEM;
1528
1529 sg_set_page(sg, page, nbytes, 0);
1530
1531 /* TODO: This should be going through a pci_???()
1532 * routine to do proper mapping. */
1533 sksg->control = FIT_SGD_CONTROL_NOT_LAST;
1534 sksg->byte_count = nbytes;
1535
1536 sksg->host_side_addr = sg_phys(sg);
1537
1538 sksg->dev_side_addr = 0;
1539 sksg->next_desc_ptr = skreq->sksg_dma_address +
1540 (ix + 1) * sizeof(*sksg);
1541
1542 skreq->n_sg++;
1543 resid -= nbytes;
1544 }
1545
1546 if (skreq->n_sg > 0) {
1547 u32 ix = skreq->n_sg - 1;
1548 struct fit_sg_descriptor *sksg = &skreq->sksg_list[ix];
1549
1550 sksg->control = FIT_SGD_CONTROL_LAST;
1551 sksg->next_desc_ptr = 0;
1552 }
1553
1554 if (unlikely(skdev->dbg_level > 1)) {
1555 u32 i;
1556
2e44b427 1557 pr_debug("%s:%s:%d skreq=%x sksg_list=%p sksg_dma=%llx\n",
1558 skdev->name, __func__, __LINE__,
1559 skreq->id, skreq->sksg_list, skreq->sksg_dma_address);
e67f86b3
AB
1560 for (i = 0; i < skreq->n_sg; i++) {
1561 struct fit_sg_descriptor *sgd = &skreq->sksg_list[i];
1562
2e44b427 1563 pr_debug("%s:%s:%d sg[%d] count=%u ctrl=0x%x "
1564 "addr=0x%llx next=0x%llx\n",
1565 skdev->name, __func__, __LINE__,
1566 i, sgd->byte_count, sgd->control,
1567 sgd->host_side_addr, sgd->next_desc_ptr);
e67f86b3
AB
1568 }
1569 }
1570
1571 return 0;
1572}
1573
1574static int skd_sg_io_prep_buffering(struct skd_device *skdev,
1575 struct skd_sg_io *sksgio)
1576{
1577 struct skd_special_context *skspcl = sksgio->skspcl;
1578 struct skd_request_context *skreq = &skspcl->req;
1579 u32 dxfer_len = sksgio->dxfer_len;
1580 int rc;
1581
1582 rc = skd_skreq_prep_buffering(skdev, skreq, dxfer_len);
1583 /*
1584 * Eventually, errors or not, skd_release_special() is called
1585 * to recover allocations including partial allocations.
1586 */
1587 return rc;
1588}
1589
1590static int skd_sg_io_copy_buffer(struct skd_device *skdev,
1591 struct skd_sg_io *sksgio, int dxfer_dir)
1592{
1593 struct skd_special_context *skspcl = sksgio->skspcl;
1594 u32 iov_ix = 0;
1595 struct sg_iovec curiov;
1596 u32 sksg_ix = 0;
1597 u8 *bufp = NULL;
1598 u32 buf_len = 0;
1599 u32 resid = sksgio->dxfer_len;
1600 int rc;
1601
1602 curiov.iov_len = 0;
1603 curiov.iov_base = NULL;
1604
1605 if (dxfer_dir != sksgio->sg.dxfer_direction) {
1606 if (dxfer_dir != SG_DXFER_TO_DEV ||
1607 sksgio->sg.dxfer_direction != SG_DXFER_TO_FROM_DEV)
1608 return 0;
1609 }
1610
1611 while (resid > 0) {
1612 u32 nbytes = PAGE_SIZE;
1613
1614 if (curiov.iov_len == 0) {
1615 curiov = sksgio->iov[iov_ix++];
1616 continue;
1617 }
1618
1619 if (buf_len == 0) {
1620 struct page *page;
1621 page = sg_page(&skspcl->req.sg[sksg_ix++]);
1622 bufp = page_address(page);
1623 buf_len = PAGE_SIZE;
1624 }
1625
1626 nbytes = min_t(u32, nbytes, resid);
1627 nbytes = min_t(u32, nbytes, curiov.iov_len);
1628 nbytes = min_t(u32, nbytes, buf_len);
1629
1630 if (dxfer_dir == SG_DXFER_TO_DEV)
1631 rc = __copy_from_user(bufp, curiov.iov_base, nbytes);
1632 else
1633 rc = __copy_to_user(curiov.iov_base, bufp, nbytes);
1634
1635 if (rc)
1636 return -EFAULT;
1637
1638 resid -= nbytes;
1639 curiov.iov_len -= nbytes;
1640 curiov.iov_base += nbytes;
1641 buf_len -= nbytes;
1642 }
1643
1644 return 0;
1645}
1646
1647static int skd_sg_io_send_fitmsg(struct skd_device *skdev,
1648 struct skd_sg_io *sksgio)
1649{
1650 struct skd_special_context *skspcl = sksgio->skspcl;
1651 struct fit_msg_hdr *fmh = (struct fit_msg_hdr *)skspcl->msg_buf;
1652 struct skd_scsi_request *scsi_req = (struct skd_scsi_request *)&fmh[1];
1653
1654 memset(skspcl->msg_buf, 0, SKD_N_SPECIAL_FITMSG_BYTES);
1655
1656 /* Initialize the FIT msg header */
1657 fmh->protocol_id = FIT_PROTOCOL_ID_SOFIT;
1658 fmh->num_protocol_cmds_coalesced = 1;
1659
1660 /* Initialize the SCSI request */
1661 if (sksgio->sg.dxfer_direction != SG_DXFER_NONE)
1662 scsi_req->hdr.sg_list_dma_address =
1663 cpu_to_be64(skspcl->req.sksg_dma_address);
1664 scsi_req->hdr.tag = skspcl->req.id;
1665 scsi_req->hdr.sg_list_len_bytes =
1666 cpu_to_be32(skspcl->req.sg_byte_count);
1667 memcpy(scsi_req->cdb, sksgio->cdb, sizeof(scsi_req->cdb));
1668
1669 skspcl->req.state = SKD_REQ_STATE_BUSY;
1670 skd_send_special_fitmsg(skdev, skspcl);
1671
1672 return 0;
1673}
1674
1675static int skd_sg_io_await(struct skd_device *skdev, struct skd_sg_io *sksgio)
1676{
1677 unsigned long flags;
1678 int rc;
1679
1680 rc = wait_event_interruptible_timeout(skdev->waitq,
1681 (sksgio->skspcl->req.state !=
1682 SKD_REQ_STATE_BUSY),
1683 msecs_to_jiffies(sksgio->sg.
1684 timeout));
1685
1686 spin_lock_irqsave(&skdev->lock, flags);
1687
1688 if (sksgio->skspcl->req.state == SKD_REQ_STATE_ABORTED) {
2e44b427 1689 pr_debug("%s:%s:%d skspcl %p aborted\n",
1690 skdev->name, __func__, __LINE__, sksgio->skspcl);
e67f86b3
AB
1691
1692 /* Build check cond, sense and let command finish. */
1693 /* For a timeout, we must fabricate completion and sense
1694 * data to complete the command */
1695 sksgio->skspcl->req.completion.status =
1696 SAM_STAT_CHECK_CONDITION;
1697
1698 memset(&sksgio->skspcl->req.err_info, 0,
1699 sizeof(sksgio->skspcl->req.err_info));
1700 sksgio->skspcl->req.err_info.type = 0x70;
1701 sksgio->skspcl->req.err_info.key = ABORTED_COMMAND;
1702 sksgio->skspcl->req.err_info.code = 0x44;
1703 sksgio->skspcl->req.err_info.qual = 0;
1704 rc = 0;
1705 } else if (sksgio->skspcl->req.state != SKD_REQ_STATE_BUSY)
1706 /* No longer on the adapter. We finish. */
1707 rc = 0;
1708 else {
1709 /* Something's gone wrong. Still busy. Timeout or
1710 * user interrupted (control-C). Mark as an orphan
1711 * so it will be disposed when completed. */
1712 sksgio->skspcl->orphaned = 1;
1713 sksgio->skspcl = NULL;
1714 if (rc == 0) {
2e44b427 1715 pr_debug("%s:%s:%d timed out %p (%u ms)\n",
1716 skdev->name, __func__, __LINE__,
1717 sksgio, sksgio->sg.timeout);
e67f86b3
AB
1718 rc = -ETIMEDOUT;
1719 } else {
2e44b427 1720 pr_debug("%s:%s:%d cntlc %p\n",
1721 skdev->name, __func__, __LINE__, sksgio);
e67f86b3
AB
1722 rc = -EINTR;
1723 }
1724 }
1725
1726 spin_unlock_irqrestore(&skdev->lock, flags);
1727
1728 return rc;
1729}
1730
1731static int skd_sg_io_put_status(struct skd_device *skdev,
1732 struct skd_sg_io *sksgio)
1733{
1734 struct sg_io_hdr *sgp = &sksgio->sg;
1735 struct skd_special_context *skspcl = sksgio->skspcl;
1736 int resid = 0;
1737
1738 u32 nb = be32_to_cpu(skspcl->req.completion.num_returned_bytes);
1739
1740 sgp->status = skspcl->req.completion.status;
1741 resid = sksgio->dxfer_len - nb;
1742
1743 sgp->masked_status = sgp->status & STATUS_MASK;
1744 sgp->msg_status = 0;
1745 sgp->host_status = 0;
1746 sgp->driver_status = 0;
1747 sgp->resid = resid;
1748 if (sgp->masked_status || sgp->host_status || sgp->driver_status)
1749 sgp->info |= SG_INFO_CHECK;
1750
2e44b427 1751 pr_debug("%s:%s:%d status %x masked %x resid 0x%x\n",
1752 skdev->name, __func__, __LINE__,
1753 sgp->status, sgp->masked_status, sgp->resid);
e67f86b3
AB
1754
1755 if (sgp->masked_status == SAM_STAT_CHECK_CONDITION) {
1756 if (sgp->mx_sb_len > 0) {
1757 struct fit_comp_error_info *ei = &skspcl->req.err_info;
1758 u32 nbytes = sizeof(*ei);
1759
1760 nbytes = min_t(u32, nbytes, sgp->mx_sb_len);
1761
1762 sgp->sb_len_wr = nbytes;
1763
1764 if (__copy_to_user(sgp->sbp, ei, nbytes)) {
2e44b427 1765 pr_debug("%s:%s:%d copy_to_user sense failed %p\n",
1766 skdev->name, __func__, __LINE__,
1767 sgp->sbp);
e67f86b3
AB
1768 return -EFAULT;
1769 }
1770 }
1771 }
1772
1773 if (__copy_to_user(sksgio->argp, sgp, sizeof(sg_io_hdr_t))) {
2e44b427 1774 pr_debug("%s:%s:%d copy_to_user sg failed %p\n",
1775 skdev->name, __func__, __LINE__, sksgio->argp);
e67f86b3
AB
1776 return -EFAULT;
1777 }
1778
1779 return 0;
1780}
1781
1782static int skd_sg_io_release_skspcl(struct skd_device *skdev,
1783 struct skd_sg_io *sksgio)
1784{
1785 struct skd_special_context *skspcl = sksgio->skspcl;
1786
1787 if (skspcl != NULL) {
1788 ulong flags;
1789
1790 sksgio->skspcl = NULL;
1791
1792 spin_lock_irqsave(&skdev->lock, flags);
1793 skd_release_special(skdev, skspcl);
1794 spin_unlock_irqrestore(&skdev->lock, flags);
1795 }
1796
1797 return 0;
1798}
1799
1800/*
1801 *****************************************************************************
1802 * INTERNAL REQUESTS -- generated by driver itself
1803 *****************************************************************************
1804 */
1805
1806static int skd_format_internal_skspcl(struct skd_device *skdev)
1807{
1808 struct skd_special_context *skspcl = &skdev->internal_skspcl;
1809 struct fit_sg_descriptor *sgd = &skspcl->req.sksg_list[0];
1810 struct fit_msg_hdr *fmh;
1811 uint64_t dma_address;
1812 struct skd_scsi_request *scsi;
1813
1814 fmh = (struct fit_msg_hdr *)&skspcl->msg_buf[0];
1815 fmh->protocol_id = FIT_PROTOCOL_ID_SOFIT;
1816 fmh->num_protocol_cmds_coalesced = 1;
1817
1818 scsi = (struct skd_scsi_request *)&skspcl->msg_buf[64];
1819 memset(scsi, 0, sizeof(*scsi));
1820 dma_address = skspcl->req.sksg_dma_address;
1821 scsi->hdr.sg_list_dma_address = cpu_to_be64(dma_address);
1822 sgd->control = FIT_SGD_CONTROL_LAST;
1823 sgd->byte_count = 0;
1824 sgd->host_side_addr = skspcl->db_dma_address;
1825 sgd->dev_side_addr = 0;
1826 sgd->next_desc_ptr = 0LL;
1827
1828 return 1;
1829}
1830
1831#define WR_BUF_SIZE SKD_N_INTERNAL_BYTES
1832
1833static void skd_send_internal_skspcl(struct skd_device *skdev,
1834 struct skd_special_context *skspcl,
1835 u8 opcode)
1836{
1837 struct fit_sg_descriptor *sgd = &skspcl->req.sksg_list[0];
1838 struct skd_scsi_request *scsi;
1839 unsigned char *buf = skspcl->data_buf;
1840 int i;
1841
1842 if (skspcl->req.state != SKD_REQ_STATE_IDLE)
1843 /*
1844 * A refresh is already in progress.
1845 * Just wait for it to finish.
1846 */
1847 return;
1848
1849 SKD_ASSERT((skspcl->req.id & SKD_ID_INCR) == 0);
1850 skspcl->req.state = SKD_REQ_STATE_BUSY;
1851 skspcl->req.id += SKD_ID_INCR;
1852
1853 scsi = (struct skd_scsi_request *)&skspcl->msg_buf[64];
1854 scsi->hdr.tag = skspcl->req.id;
1855
1856 memset(scsi->cdb, 0, sizeof(scsi->cdb));
1857
1858 switch (opcode) {
1859 case TEST_UNIT_READY:
1860 scsi->cdb[0] = TEST_UNIT_READY;
1861 sgd->byte_count = 0;
1862 scsi->hdr.sg_list_len_bytes = 0;
1863 break;
1864
1865 case READ_CAPACITY:
1866 scsi->cdb[0] = READ_CAPACITY;
1867 sgd->byte_count = SKD_N_READ_CAP_BYTES;
1868 scsi->hdr.sg_list_len_bytes = cpu_to_be32(sgd->byte_count);
1869 break;
1870
1871 case INQUIRY:
1872 scsi->cdb[0] = INQUIRY;
1873 scsi->cdb[1] = 0x01; /* evpd */
1874 scsi->cdb[2] = 0x80; /* serial number page */
1875 scsi->cdb[4] = 0x10;
1876 sgd->byte_count = 16;
1877 scsi->hdr.sg_list_len_bytes = cpu_to_be32(sgd->byte_count);
1878 break;
1879
1880 case SYNCHRONIZE_CACHE:
1881 scsi->cdb[0] = SYNCHRONIZE_CACHE;
1882 sgd->byte_count = 0;
1883 scsi->hdr.sg_list_len_bytes = 0;
1884 break;
1885
1886 case WRITE_BUFFER:
1887 scsi->cdb[0] = WRITE_BUFFER;
1888 scsi->cdb[1] = 0x02;
1889 scsi->cdb[7] = (WR_BUF_SIZE & 0xFF00) >> 8;
1890 scsi->cdb[8] = WR_BUF_SIZE & 0xFF;
1891 sgd->byte_count = WR_BUF_SIZE;
1892 scsi->hdr.sg_list_len_bytes = cpu_to_be32(sgd->byte_count);
1893 /* fill incrementing byte pattern */
1894 for (i = 0; i < sgd->byte_count; i++)
1895 buf[i] = i & 0xFF;
1896 break;
1897
1898 case READ_BUFFER:
1899 scsi->cdb[0] = READ_BUFFER;
1900 scsi->cdb[1] = 0x02;
1901 scsi->cdb[7] = (WR_BUF_SIZE & 0xFF00) >> 8;
1902 scsi->cdb[8] = WR_BUF_SIZE & 0xFF;
1903 sgd->byte_count = WR_BUF_SIZE;
1904 scsi->hdr.sg_list_len_bytes = cpu_to_be32(sgd->byte_count);
1905 memset(skspcl->data_buf, 0, sgd->byte_count);
1906 break;
1907
1908 default:
1909 SKD_ASSERT("Don't know what to send");
1910 return;
1911
1912 }
1913 skd_send_special_fitmsg(skdev, skspcl);
1914}
1915
1916static void skd_refresh_device_data(struct skd_device *skdev)
1917{
1918 struct skd_special_context *skspcl = &skdev->internal_skspcl;
1919
1920 skd_send_internal_skspcl(skdev, skspcl, TEST_UNIT_READY);
1921}
1922
1923static int skd_chk_read_buf(struct skd_device *skdev,
1924 struct skd_special_context *skspcl)
1925{
1926 unsigned char *buf = skspcl->data_buf;
1927 int i;
1928
1929 /* check for incrementing byte pattern */
1930 for (i = 0; i < WR_BUF_SIZE; i++)
1931 if (buf[i] != (i & 0xFF))
1932 return 1;
1933
1934 return 0;
1935}
1936
1937static void skd_log_check_status(struct skd_device *skdev, u8 status, u8 key,
1938 u8 code, u8 qual, u8 fruc)
1939{
1940 /* If the check condition is of special interest, log a message */
1941 if ((status == SAM_STAT_CHECK_CONDITION) && (key == 0x02)
1942 && (code == 0x04) && (qual == 0x06)) {
1943 pr_err("(%s): *** LOST_WRITE_DATA ERROR *** key/asc/"
1944 "ascq/fruc %02x/%02x/%02x/%02x\n",
1945 skd_name(skdev), key, code, qual, fruc);
1946 }
1947}
1948
1949static void skd_complete_internal(struct skd_device *skdev,
1950 volatile struct fit_completion_entry_v1
1951 *skcomp,
1952 volatile struct fit_comp_error_info *skerr,
1953 struct skd_special_context *skspcl)
1954{
1955 u8 *buf = skspcl->data_buf;
1956 u8 status;
1957 int i;
1958 struct skd_scsi_request *scsi =
1959 (struct skd_scsi_request *)&skspcl->msg_buf[64];
1960
1961 SKD_ASSERT(skspcl == &skdev->internal_skspcl);
1962
2e44b427 1963 pr_debug("%s:%s:%d complete internal %x\n",
1964 skdev->name, __func__, __LINE__, scsi->cdb[0]);
e67f86b3
AB
1965
1966 skspcl->req.completion = *skcomp;
1967 skspcl->req.state = SKD_REQ_STATE_IDLE;
1968 skspcl->req.id += SKD_ID_INCR;
1969
1970 status = skspcl->req.completion.status;
1971
1972 skd_log_check_status(skdev, status, skerr->key, skerr->code,
1973 skerr->qual, skerr->fruc);
1974
1975 switch (scsi->cdb[0]) {
1976 case TEST_UNIT_READY:
1977 if (status == SAM_STAT_GOOD)
1978 skd_send_internal_skspcl(skdev, skspcl, WRITE_BUFFER);
1979 else if ((status == SAM_STAT_CHECK_CONDITION) &&
1980 (skerr->key == MEDIUM_ERROR))
1981 skd_send_internal_skspcl(skdev, skspcl, WRITE_BUFFER);
1982 else {
1983 if (skdev->state == SKD_DRVR_STATE_STOPPING) {
2e44b427 1984 pr_debug("%s:%s:%d TUR failed, don't send anymore state 0x%x\n",
1985 skdev->name, __func__, __LINE__,
1986 skdev->state);
e67f86b3
AB
1987 return;
1988 }
2e44b427 1989 pr_debug("%s:%s:%d **** TUR failed, retry skerr\n",
1990 skdev->name, __func__, __LINE__);
e67f86b3
AB
1991 skd_send_internal_skspcl(skdev, skspcl, 0x00);
1992 }
1993 break;
1994
1995 case WRITE_BUFFER:
1996 if (status == SAM_STAT_GOOD)
1997 skd_send_internal_skspcl(skdev, skspcl, READ_BUFFER);
1998 else {
1999 if (skdev->state == SKD_DRVR_STATE_STOPPING) {
2e44b427 2000 pr_debug("%s:%s:%d write buffer failed, don't send anymore state 0x%x\n",
2001 skdev->name, __func__, __LINE__,
2002 skdev->state);
e67f86b3
AB
2003 return;
2004 }
2e44b427 2005 pr_debug("%s:%s:%d **** write buffer failed, retry skerr\n",
2006 skdev->name, __func__, __LINE__);
e67f86b3
AB
2007 skd_send_internal_skspcl(skdev, skspcl, 0x00);
2008 }
2009 break;
2010
2011 case READ_BUFFER:
2012 if (status == SAM_STAT_GOOD) {
2013 if (skd_chk_read_buf(skdev, skspcl) == 0)
2014 skd_send_internal_skspcl(skdev, skspcl,
2015 READ_CAPACITY);
2016 else {
2017 pr_err(
2018 "(%s):*** W/R Buffer mismatch %d ***\n",
2019 skd_name(skdev), skdev->connect_retries);
2020 if (skdev->connect_retries <
2021 SKD_MAX_CONNECT_RETRIES) {
2022 skdev->connect_retries++;
2023 skd_soft_reset(skdev);
2024 } else {
2025 pr_err(
2026 "(%s): W/R Buffer Connect Error\n",
2027 skd_name(skdev));
2028 return;
2029 }
2030 }
2031
2032 } else {
2033 if (skdev->state == SKD_DRVR_STATE_STOPPING) {
2e44b427 2034 pr_debug("%s:%s:%d "
2035 "read buffer failed, don't send anymore state 0x%x\n",
2036 skdev->name, __func__, __LINE__,
2037 skdev->state);
e67f86b3
AB
2038 return;
2039 }
2e44b427 2040 pr_debug("%s:%s:%d "
2041 "**** read buffer failed, retry skerr\n",
2042 skdev->name, __func__, __LINE__);
e67f86b3
AB
2043 skd_send_internal_skspcl(skdev, skspcl, 0x00);
2044 }
2045 break;
2046
2047 case READ_CAPACITY:
2048 skdev->read_cap_is_valid = 0;
2049 if (status == SAM_STAT_GOOD) {
2050 skdev->read_cap_last_lba =
2051 (buf[0] << 24) | (buf[1] << 16) |
2052 (buf[2] << 8) | buf[3];
2053 skdev->read_cap_blocksize =
2054 (buf[4] << 24) | (buf[5] << 16) |
2055 (buf[6] << 8) | buf[7];
2056
2e44b427 2057 pr_debug("%s:%s:%d last lba %d, bs %d\n",
2058 skdev->name, __func__, __LINE__,
2059 skdev->read_cap_last_lba,
2060 skdev->read_cap_blocksize);
e67f86b3
AB
2061
2062 set_capacity(skdev->disk, skdev->read_cap_last_lba + 1);
2063
2064 skdev->read_cap_is_valid = 1;
2065
2066 skd_send_internal_skspcl(skdev, skspcl, INQUIRY);
2067 } else if ((status == SAM_STAT_CHECK_CONDITION) &&
2068 (skerr->key == MEDIUM_ERROR)) {
2069 skdev->read_cap_last_lba = ~0;
2070 set_capacity(skdev->disk, skdev->read_cap_last_lba + 1);
2e44b427 2071 pr_debug("%s:%s:%d "
2072 "**** MEDIUM ERROR caused READCAP to fail, ignore failure and continue to inquiry\n",
2073 skdev->name, __func__, __LINE__);
e67f86b3
AB
2074 skd_send_internal_skspcl(skdev, skspcl, INQUIRY);
2075 } else {
2e44b427 2076 pr_debug("%s:%s:%d **** READCAP failed, retry TUR\n",
2077 skdev->name, __func__, __LINE__);
e67f86b3
AB
2078 skd_send_internal_skspcl(skdev, skspcl,
2079 TEST_UNIT_READY);
2080 }
2081 break;
2082
2083 case INQUIRY:
2084 skdev->inquiry_is_valid = 0;
2085 if (status == SAM_STAT_GOOD) {
2086 skdev->inquiry_is_valid = 1;
2087
2088 for (i = 0; i < 12; i++)
2089 skdev->inq_serial_num[i] = buf[i + 4];
2090 skdev->inq_serial_num[12] = 0;
2091 }
2092
2093 if (skd_unquiesce_dev(skdev) < 0)
2e44b427 2094 pr_debug("%s:%s:%d **** failed, to ONLINE device\n",
2095 skdev->name, __func__, __LINE__);
e67f86b3
AB
2096 /* connection is complete */
2097 skdev->connect_retries = 0;
2098 break;
2099
2100 case SYNCHRONIZE_CACHE:
2101 if (status == SAM_STAT_GOOD)
2102 skdev->sync_done = 1;
2103 else
2104 skdev->sync_done = -1;
2105 wake_up_interruptible(&skdev->waitq);
2106 break;
2107
2108 default:
2109 SKD_ASSERT("we didn't send this");
2110 }
2111}
2112
2113/*
2114 *****************************************************************************
2115 * FIT MESSAGES
2116 *****************************************************************************
2117 */
2118
2119static void skd_send_fitmsg(struct skd_device *skdev,
2120 struct skd_fitmsg_context *skmsg)
2121{
2122 u64 qcmd;
2123 struct fit_msg_hdr *fmh;
2124
2e44b427 2125 pr_debug("%s:%s:%d dma address 0x%llx, busy=%d\n",
2126 skdev->name, __func__, __LINE__,
2127 skmsg->mb_dma_address, skdev->in_flight);
2128 pr_debug("%s:%s:%d msg_buf 0x%p, offset %x\n",
2129 skdev->name, __func__, __LINE__,
2130 skmsg->msg_buf, skmsg->offset);
e67f86b3
AB
2131
2132 qcmd = skmsg->mb_dma_address;
2133 qcmd |= FIT_QCMD_QID_NORMAL;
2134
2135 fmh = (struct fit_msg_hdr *)skmsg->msg_buf;
2136 skmsg->outstanding = fmh->num_protocol_cmds_coalesced;
2137
2138 if (unlikely(skdev->dbg_level > 1)) {
2139 u8 *bp = (u8 *)skmsg->msg_buf;
2140 int i;
2141 for (i = 0; i < skmsg->length; i += 8) {
8e1de26c
AS
2142 pr_debug("%s:%s:%d msg[%2d] %8ph\n",
2143 skdev->name, __func__, __LINE__, i, &bp[i]);
e67f86b3
AB
2144 if (i == 0)
2145 i = 64 - 8;
2146 }
2147 }
2148
2149 if (skmsg->length > 256)
2150 qcmd |= FIT_QCMD_MSGSIZE_512;
2151 else if (skmsg->length > 128)
2152 qcmd |= FIT_QCMD_MSGSIZE_256;
2153 else if (skmsg->length > 64)
2154 qcmd |= FIT_QCMD_MSGSIZE_128;
2155 else
2156 /*
2157 * This makes no sense because the FIT msg header is
2158 * 64 bytes. If the msg is only 64 bytes long it has
2159 * no payload.
2160 */
2161 qcmd |= FIT_QCMD_MSGSIZE_64;
2162
9ab951fe
BVA
2163 /* Make sure skd_msg_buf is written before the doorbell is triggered. */
2164 smp_wmb();
2165
e67f86b3 2166 SKD_WRITEQ(skdev, qcmd, FIT_Q_COMMAND);
e67f86b3
AB
2167}
2168
2169static void skd_send_special_fitmsg(struct skd_device *skdev,
2170 struct skd_special_context *skspcl)
2171{
2172 u64 qcmd;
2173
2174 if (unlikely(skdev->dbg_level > 1)) {
2175 u8 *bp = (u8 *)skspcl->msg_buf;
2176 int i;
2177
2178 for (i = 0; i < SKD_N_SPECIAL_FITMSG_BYTES; i += 8) {
8e1de26c
AS
2179 pr_debug("%s:%s:%d spcl[%2d] %8ph\n",
2180 skdev->name, __func__, __LINE__, i, &bp[i]);
e67f86b3
AB
2181 if (i == 0)
2182 i = 64 - 8;
2183 }
2184
2e44b427 2185 pr_debug("%s:%s:%d skspcl=%p id=%04x sksg_list=%p sksg_dma=%llx\n",
2186 skdev->name, __func__, __LINE__,
2187 skspcl, skspcl->req.id, skspcl->req.sksg_list,
2188 skspcl->req.sksg_dma_address);
e67f86b3
AB
2189 for (i = 0; i < skspcl->req.n_sg; i++) {
2190 struct fit_sg_descriptor *sgd =
2191 &skspcl->req.sksg_list[i];
2192
2e44b427 2193 pr_debug("%s:%s:%d sg[%d] count=%u ctrl=0x%x "
2194 "addr=0x%llx next=0x%llx\n",
2195 skdev->name, __func__, __LINE__,
2196 i, sgd->byte_count, sgd->control,
2197 sgd->host_side_addr, sgd->next_desc_ptr);
e67f86b3
AB
2198 }
2199 }
2200
2201 /*
2202 * Special FIT msgs are always 128 bytes: a 64-byte FIT hdr
2203 * and one 64-byte SSDI command.
2204 */
2205 qcmd = skspcl->mb_dma_address;
2206 qcmd |= FIT_QCMD_QID_NORMAL + FIT_QCMD_MSGSIZE_128;
2207
9ab951fe
BVA
2208 /* Make sure skd_msg_buf is written before the doorbell is triggered. */
2209 smp_wmb();
2210
e67f86b3
AB
2211 SKD_WRITEQ(skdev, qcmd, FIT_Q_COMMAND);
2212}
2213
2214/*
2215 *****************************************************************************
2216 * COMPLETION QUEUE
2217 *****************************************************************************
2218 */
2219
2220static void skd_complete_other(struct skd_device *skdev,
2221 volatile struct fit_completion_entry_v1 *skcomp,
2222 volatile struct fit_comp_error_info *skerr);
2223
e67f86b3
AB
2224struct sns_info {
2225 u8 type;
2226 u8 stat;
2227 u8 key;
2228 u8 asc;
2229 u8 ascq;
2230 u8 mask;
2231 enum skd_check_status_action action;
2232};
2233
2234static struct sns_info skd_chkstat_table[] = {
2235 /* Good */
2236 { 0x70, 0x02, RECOVERED_ERROR, 0, 0, 0x1c,
2237 SKD_CHECK_STATUS_REPORT_GOOD },
2238
2239 /* Smart alerts */
2240 { 0x70, 0x02, NO_SENSE, 0x0B, 0x00, 0x1E, /* warnings */
2241 SKD_CHECK_STATUS_REPORT_SMART_ALERT },
2242 { 0x70, 0x02, NO_SENSE, 0x5D, 0x00, 0x1E, /* thresholds */
2243 SKD_CHECK_STATUS_REPORT_SMART_ALERT },
2244 { 0x70, 0x02, RECOVERED_ERROR, 0x0B, 0x01, 0x1F, /* temperature over trigger */
2245 SKD_CHECK_STATUS_REPORT_SMART_ALERT },
2246
2247 /* Retry (with limits) */
2248 { 0x70, 0x02, 0x0B, 0, 0, 0x1C, /* This one is for DMA ERROR */
2249 SKD_CHECK_STATUS_REQUEUE_REQUEST },
2250 { 0x70, 0x02, 0x06, 0x0B, 0x00, 0x1E, /* warnings */
2251 SKD_CHECK_STATUS_REQUEUE_REQUEST },
2252 { 0x70, 0x02, 0x06, 0x5D, 0x00, 0x1E, /* thresholds */
2253 SKD_CHECK_STATUS_REQUEUE_REQUEST },
2254 { 0x70, 0x02, 0x06, 0x80, 0x30, 0x1F, /* backup power */
2255 SKD_CHECK_STATUS_REQUEUE_REQUEST },
2256
2257 /* Busy (or about to be) */
2258 { 0x70, 0x02, 0x06, 0x3f, 0x01, 0x1F, /* fw changed */
2259 SKD_CHECK_STATUS_BUSY_IMMINENT },
2260};
2261
2262/*
2263 * Look up status and sense data to decide how to handle the error
2264 * from the device.
2265 * mask says which fields must match e.g., mask=0x18 means check
2266 * type and stat, ignore key, asc, ascq.
2267 */
2268
38d4a1bb
MS
2269static enum skd_check_status_action
2270skd_check_status(struct skd_device *skdev,
2271 u8 cmp_status, volatile struct fit_comp_error_info *skerr)
e67f86b3
AB
2272{
2273 int i, n;
2274
2275 pr_err("(%s): key/asc/ascq/fruc %02x/%02x/%02x/%02x\n",
2276 skd_name(skdev), skerr->key, skerr->code, skerr->qual,
2277 skerr->fruc);
2278
2e44b427 2279 pr_debug("%s:%s:%d stat: t=%02x stat=%02x k=%02x c=%02x q=%02x fruc=%02x\n",
2280 skdev->name, __func__, __LINE__, skerr->type, cmp_status,
2281 skerr->key, skerr->code, skerr->qual, skerr->fruc);
e67f86b3
AB
2282
2283 /* Does the info match an entry in the good category? */
2284 n = sizeof(skd_chkstat_table) / sizeof(skd_chkstat_table[0]);
2285 for (i = 0; i < n; i++) {
2286 struct sns_info *sns = &skd_chkstat_table[i];
2287
2288 if (sns->mask & 0x10)
2289 if (skerr->type != sns->type)
2290 continue;
2291
2292 if (sns->mask & 0x08)
2293 if (cmp_status != sns->stat)
2294 continue;
2295
2296 if (sns->mask & 0x04)
2297 if (skerr->key != sns->key)
2298 continue;
2299
2300 if (sns->mask & 0x02)
2301 if (skerr->code != sns->asc)
2302 continue;
2303
2304 if (sns->mask & 0x01)
2305 if (skerr->qual != sns->ascq)
2306 continue;
2307
2308 if (sns->action == SKD_CHECK_STATUS_REPORT_SMART_ALERT) {
2309 pr_err("(%s): SMART Alert: sense key/asc/ascq "
2310 "%02x/%02x/%02x\n",
2311 skd_name(skdev), skerr->key,
2312 skerr->code, skerr->qual);
2313 }
2314 return sns->action;
2315 }
2316
2317 /* No other match, so nonzero status means error,
2318 * zero status means good
2319 */
2320 if (cmp_status) {
2e44b427 2321 pr_debug("%s:%s:%d status check: error\n",
2322 skdev->name, __func__, __LINE__);
e67f86b3
AB
2323 return SKD_CHECK_STATUS_REPORT_ERROR;
2324 }
2325
2e44b427 2326 pr_debug("%s:%s:%d status check good default\n",
2327 skdev->name, __func__, __LINE__);
e67f86b3
AB
2328 return SKD_CHECK_STATUS_REPORT_GOOD;
2329}
2330
2331static void skd_resolve_req_exception(struct skd_device *skdev,
2332 struct skd_request_context *skreq)
2333{
2334 u8 cmp_status = skreq->completion.status;
2335
2336 switch (skd_check_status(skdev, cmp_status, &skreq->err_info)) {
2337 case SKD_CHECK_STATUS_REPORT_GOOD:
2338 case SKD_CHECK_STATUS_REPORT_SMART_ALERT:
2a842aca 2339 skd_end_request(skdev, skreq, BLK_STS_OK);
e67f86b3
AB
2340 break;
2341
2342 case SKD_CHECK_STATUS_BUSY_IMMINENT:
2343 skd_log_skreq(skdev, skreq, "retry(busy)");
38d4a1bb 2344 blk_requeue_request(skdev->queue, skreq->req);
e67f86b3
AB
2345 pr_info("(%s) drive BUSY imminent\n", skd_name(skdev));
2346 skdev->state = SKD_DRVR_STATE_BUSY_IMMINENT;
2347 skdev->timer_countdown = SKD_TIMER_MINUTES(20);
2348 skd_quiesce_dev(skdev);
2349 break;
2350
2351 case SKD_CHECK_STATUS_REQUEUE_REQUEST:
fcd37eb3
JA
2352 if ((unsigned long) ++skreq->req->special < SKD_MAX_RETRIES) {
2353 skd_log_skreq(skdev, skreq, "retry");
38d4a1bb 2354 blk_requeue_request(skdev->queue, skreq->req);
fcd37eb3 2355 break;
e67f86b3
AB
2356 }
2357 /* fall through to report error */
2358
2359 case SKD_CHECK_STATUS_REPORT_ERROR:
2360 default:
2a842aca 2361 skd_end_request(skdev, skreq, BLK_STS_IOERR);
e67f86b3
AB
2362 break;
2363 }
2364}
2365
e67f86b3
AB
2366/* assume spinlock is already held */
2367static void skd_release_skreq(struct skd_device *skdev,
2368 struct skd_request_context *skreq)
2369{
2370 u32 msg_slot;
2371 struct skd_fitmsg_context *skmsg;
2372
2373 u32 timo_slot;
2374
2375 /*
2376 * Reclaim the FIT msg buffer if this is
2377 * the first of the requests it carried to
2378 * be completed. The FIT msg buffer used to
2379 * send this request cannot be reused until
2380 * we are sure the s1120 card has copied
2381 * it to its memory. The FIT msg might have
2382 * contained several requests. As soon as
2383 * any of them are completed we know that
2384 * the entire FIT msg was transferred.
2385 * Only the first completed request will
2386 * match the FIT msg buffer id. The FIT
2387 * msg buffer id is immediately updated.
2388 * When subsequent requests complete the FIT
2389 * msg buffer id won't match, so we know
2390 * quite cheaply that it is already done.
2391 */
2392 msg_slot = skreq->fitmsg_id & SKD_ID_SLOT_MASK;
2393 SKD_ASSERT(msg_slot < skdev->num_fitmsg_context);
2394
2395 skmsg = &skdev->skmsg_table[msg_slot];
2396 if (skmsg->id == skreq->fitmsg_id) {
2397 SKD_ASSERT(skmsg->state == SKD_MSG_STATE_BUSY);
2398 SKD_ASSERT(skmsg->outstanding > 0);
2399 skmsg->outstanding--;
2400 if (skmsg->outstanding == 0) {
2401 skmsg->state = SKD_MSG_STATE_IDLE;
2402 skmsg->id += SKD_ID_INCR;
2403 skmsg->next = skdev->skmsg_free_list;
2404 skdev->skmsg_free_list = skmsg;
2405 }
2406 }
2407
2408 /*
2409 * Decrease the number of active requests.
2410 * Also decrements the count in the timeout slot.
2411 */
2412 SKD_ASSERT(skdev->in_flight > 0);
2413 skdev->in_flight -= 1;
2414
2415 timo_slot = skreq->timeout_stamp & SKD_TIMEOUT_SLOT_MASK;
2416 SKD_ASSERT(skdev->timeout_slot[timo_slot] > 0);
2417 skdev->timeout_slot[timo_slot] -= 1;
2418
2419 /*
2420 * Reset backpointer
2421 */
fcd37eb3 2422 skreq->req = NULL;
e67f86b3
AB
2423
2424 /*
2425 * Reclaim the skd_request_context
2426 */
2427 skreq->state = SKD_REQ_STATE_IDLE;
2428 skreq->id += SKD_ID_INCR;
2429 skreq->next = skdev->skreq_free_list;
2430 skdev->skreq_free_list = skreq;
2431}
2432
2433#define DRIVER_INQ_EVPD_PAGE_CODE 0xDA
2434
2435static void skd_do_inq_page_00(struct skd_device *skdev,
2436 volatile struct fit_completion_entry_v1 *skcomp,
2437 volatile struct fit_comp_error_info *skerr,
2438 uint8_t *cdb, uint8_t *buf)
2439{
2440 uint16_t insert_pt, max_bytes, drive_pages, drive_bytes, new_size;
2441
2442 /* Caller requested "supported pages". The driver needs to insert
2443 * its page.
2444 */
2e44b427 2445 pr_debug("%s:%s:%d skd_do_driver_inquiry: modify supported pages.\n",
2446 skdev->name, __func__, __LINE__);
e67f86b3
AB
2447
2448 /* If the device rejected the request because the CDB was
2449 * improperly formed, then just leave.
2450 */
2451 if (skcomp->status == SAM_STAT_CHECK_CONDITION &&
2452 skerr->key == ILLEGAL_REQUEST && skerr->code == 0x24)
2453 return;
2454
2455 /* Get the amount of space the caller allocated */
2456 max_bytes = (cdb[3] << 8) | cdb[4];
2457
2458 /* Get the number of pages actually returned by the device */
2459 drive_pages = (buf[2] << 8) | buf[3];
2460 drive_bytes = drive_pages + 4;
2461 new_size = drive_pages + 1;
2462
2463 /* Supported pages must be in numerical order, so find where
2464 * the driver page needs to be inserted into the list of
2465 * pages returned by the device.
2466 */
2467 for (insert_pt = 4; insert_pt < drive_bytes; insert_pt++) {
2468 if (buf[insert_pt] == DRIVER_INQ_EVPD_PAGE_CODE)
2469 return; /* Device using this page code. abort */
2470 else if (buf[insert_pt] > DRIVER_INQ_EVPD_PAGE_CODE)
2471 break;
2472 }
2473
2474 if (insert_pt < max_bytes) {
2475 uint16_t u;
2476
2477 /* Shift everything up one byte to make room. */
2478 for (u = new_size + 3; u > insert_pt; u--)
2479 buf[u] = buf[u - 1];
2480 buf[insert_pt] = DRIVER_INQ_EVPD_PAGE_CODE;
2481
2482 /* SCSI byte order increment of num_returned_bytes by 1 */
2483 skcomp->num_returned_bytes =
2484 be32_to_cpu(skcomp->num_returned_bytes) + 1;
2485 skcomp->num_returned_bytes =
2486 be32_to_cpu(skcomp->num_returned_bytes);
2487 }
2488
2489 /* update page length field to reflect the driver's page too */
2490 buf[2] = (uint8_t)((new_size >> 8) & 0xFF);
2491 buf[3] = (uint8_t)((new_size >> 0) & 0xFF);
2492}
2493
2494static void skd_get_link_info(struct pci_dev *pdev, u8 *speed, u8 *width)
2495{
2496 int pcie_reg;
2497 u16 pci_bus_speed;
2498 u8 pci_lanes;
2499
2500 pcie_reg = pci_find_capability(pdev, PCI_CAP_ID_EXP);
2501 if (pcie_reg) {
2502 u16 linksta;
2503 pci_read_config_word(pdev, pcie_reg + PCI_EXP_LNKSTA, &linksta);
2504
2505 pci_bus_speed = linksta & 0xF;
2506 pci_lanes = (linksta & 0x3F0) >> 4;
2507 } else {
2508 *speed = STEC_LINK_UNKNOWN;
2509 *width = 0xFF;
2510 return;
2511 }
2512
2513 switch (pci_bus_speed) {
2514 case 1:
2515 *speed = STEC_LINK_2_5GTS;
2516 break;
2517 case 2:
2518 *speed = STEC_LINK_5GTS;
2519 break;
2520 case 3:
2521 *speed = STEC_LINK_8GTS;
2522 break;
2523 default:
2524 *speed = STEC_LINK_UNKNOWN;
2525 break;
2526 }
2527
2528 if (pci_lanes <= 0x20)
2529 *width = pci_lanes;
2530 else
2531 *width = 0xFF;
2532}
2533
2534static void skd_do_inq_page_da(struct skd_device *skdev,
2535 volatile struct fit_completion_entry_v1 *skcomp,
2536 volatile struct fit_comp_error_info *skerr,
2537 uint8_t *cdb, uint8_t *buf)
2538{
fec23f63 2539 struct pci_dev *pdev = skdev->pdev;
e67f86b3
AB
2540 unsigned max_bytes;
2541 struct driver_inquiry_data inq;
2542 u16 val;
2543
2e44b427 2544 pr_debug("%s:%s:%d skd_do_driver_inquiry: return driver page\n",
2545 skdev->name, __func__, __LINE__);
e67f86b3
AB
2546
2547 memset(&inq, 0, sizeof(inq));
2548
2549 inq.page_code = DRIVER_INQ_EVPD_PAGE_CODE;
2550
fec23f63
BZ
2551 skd_get_link_info(pdev, &inq.pcie_link_speed, &inq.pcie_link_lanes);
2552 inq.pcie_bus_number = cpu_to_be16(pdev->bus->number);
2553 inq.pcie_device_number = PCI_SLOT(pdev->devfn);
2554 inq.pcie_function_number = PCI_FUNC(pdev->devfn);
e67f86b3 2555
fec23f63
BZ
2556 pci_read_config_word(pdev, PCI_VENDOR_ID, &val);
2557 inq.pcie_vendor_id = cpu_to_be16(val);
e67f86b3 2558
fec23f63
BZ
2559 pci_read_config_word(pdev, PCI_DEVICE_ID, &val);
2560 inq.pcie_device_id = cpu_to_be16(val);
e67f86b3 2561
fec23f63
BZ
2562 pci_read_config_word(pdev, PCI_SUBSYSTEM_VENDOR_ID, &val);
2563 inq.pcie_subsystem_vendor_id = cpu_to_be16(val);
e67f86b3 2564
fec23f63
BZ
2565 pci_read_config_word(pdev, PCI_SUBSYSTEM_ID, &val);
2566 inq.pcie_subsystem_device_id = cpu_to_be16(val);
e67f86b3
AB
2567
2568 /* Driver version, fixed lenth, padded with spaces on the right */
2569 inq.driver_version_length = sizeof(inq.driver_version);
2570 memset(&inq.driver_version, ' ', sizeof(inq.driver_version));
2571 memcpy(inq.driver_version, DRV_VER_COMPL,
2572 min(sizeof(inq.driver_version), strlen(DRV_VER_COMPL)));
2573
2574 inq.page_length = cpu_to_be16((sizeof(inq) - 4));
2575
2576 /* Clear the error set by the device */
2577 skcomp->status = SAM_STAT_GOOD;
2578 memset((void *)skerr, 0, sizeof(*skerr));
2579
2580 /* copy response into output buffer */
2581 max_bytes = (cdb[3] << 8) | cdb[4];
2582 memcpy(buf, &inq, min_t(unsigned, max_bytes, sizeof(inq)));
2583
2584 skcomp->num_returned_bytes =
2585 be32_to_cpu(min_t(uint16_t, max_bytes, sizeof(inq)));
2586}
2587
2588static void skd_do_driver_inq(struct skd_device *skdev,
2589 volatile struct fit_completion_entry_v1 *skcomp,
2590 volatile struct fit_comp_error_info *skerr,
2591 uint8_t *cdb, uint8_t *buf)
2592{
2593 if (!buf)
2594 return;
2595 else if (cdb[0] != INQUIRY)
2596 return; /* Not an INQUIRY */
2597 else if ((cdb[1] & 1) == 0)
2598 return; /* EVPD not set */
2599 else if (cdb[2] == 0)
2600 /* Need to add driver's page to supported pages list */
2601 skd_do_inq_page_00(skdev, skcomp, skerr, cdb, buf);
2602 else if (cdb[2] == DRIVER_INQ_EVPD_PAGE_CODE)
2603 /* Caller requested driver's page */
2604 skd_do_inq_page_da(skdev, skcomp, skerr, cdb, buf);
2605}
2606
2607static unsigned char *skd_sg_1st_page_ptr(struct scatterlist *sg)
2608{
2609 if (!sg)
2610 return NULL;
2611 if (!sg_page(sg))
2612 return NULL;
2613 return sg_virt(sg);
2614}
2615
2616static void skd_process_scsi_inq(struct skd_device *skdev,
2617 volatile struct fit_completion_entry_v1
2618 *skcomp,
2619 volatile struct fit_comp_error_info *skerr,
2620 struct skd_special_context *skspcl)
2621{
2622 uint8_t *buf;
2623 struct fit_msg_hdr *fmh = (struct fit_msg_hdr *)skspcl->msg_buf;
2624 struct skd_scsi_request *scsi_req = (struct skd_scsi_request *)&fmh[1];
2625
2626 dma_sync_sg_for_cpu(skdev->class_dev, skspcl->req.sg, skspcl->req.n_sg,
2627 skspcl->req.sg_data_dir);
2628 buf = skd_sg_1st_page_ptr(skspcl->req.sg);
2629
2630 if (buf)
2631 skd_do_driver_inq(skdev, skcomp, skerr, scsi_req->cdb, buf);
2632}
2633
2634
2635static int skd_isr_completion_posted(struct skd_device *skdev,
2636 int limit, int *enqueued)
2637{
2638 volatile struct fit_completion_entry_v1 *skcmp = NULL;
2639 volatile struct fit_comp_error_info *skerr;
2640 u16 req_id;
2641 u32 req_slot;
2642 struct skd_request_context *skreq;
2643 u16 cmp_cntxt = 0;
2644 u8 cmp_status = 0;
2645 u8 cmp_cycle = 0;
2646 u32 cmp_bytes = 0;
2647 int rc = 0;
2648 int processed = 0;
e67f86b3
AB
2649
2650 for (;; ) {
2651 SKD_ASSERT(skdev->skcomp_ix < SKD_N_COMPLETION_ENTRY);
2652
2653 skcmp = &skdev->skcomp_table[skdev->skcomp_ix];
2654 cmp_cycle = skcmp->cycle;
2655 cmp_cntxt = skcmp->tag;
2656 cmp_status = skcmp->status;
2657 cmp_bytes = be32_to_cpu(skcmp->num_returned_bytes);
2658
2659 skerr = &skdev->skerr_table[skdev->skcomp_ix];
2660
2e44b427 2661 pr_debug("%s:%s:%d "
2662 "cycle=%d ix=%d got cycle=%d cmdctxt=0x%x stat=%d "
2663 "busy=%d rbytes=0x%x proto=%d\n",
2664 skdev->name, __func__, __LINE__, skdev->skcomp_cycle,
2665 skdev->skcomp_ix, cmp_cycle, cmp_cntxt, cmp_status,
2666 skdev->in_flight, cmp_bytes, skdev->proto_ver);
e67f86b3
AB
2667
2668 if (cmp_cycle != skdev->skcomp_cycle) {
2e44b427 2669 pr_debug("%s:%s:%d end of completions\n",
2670 skdev->name, __func__, __LINE__);
e67f86b3
AB
2671 break;
2672 }
2673 /*
2674 * Update the completion queue head index and possibly
2675 * the completion cycle count. 8-bit wrap-around.
2676 */
2677 skdev->skcomp_ix++;
2678 if (skdev->skcomp_ix >= SKD_N_COMPLETION_ENTRY) {
2679 skdev->skcomp_ix = 0;
2680 skdev->skcomp_cycle++;
2681 }
2682
2683 /*
2684 * The command context is a unique 32-bit ID. The low order
2685 * bits help locate the request. The request is usually a
2686 * r/w request (see skd_start() above) or a special request.
2687 */
2688 req_id = cmp_cntxt;
2689 req_slot = req_id & SKD_ID_SLOT_AND_TABLE_MASK;
2690
2691 /* Is this other than a r/w request? */
2692 if (req_slot >= skdev->num_req_context) {
2693 /*
2694 * This is not a completion for a r/w request.
2695 */
2696 skd_complete_other(skdev, skcmp, skerr);
2697 continue;
2698 }
2699
2700 skreq = &skdev->skreq_table[req_slot];
2701
2702 /*
2703 * Make sure the request ID for the slot matches.
2704 */
2705 if (skreq->id != req_id) {
2e44b427 2706 pr_debug("%s:%s:%d mismatch comp_id=0x%x req_id=0x%x\n",
2707 skdev->name, __func__, __LINE__,
2708 req_id, skreq->id);
e67f86b3
AB
2709 {
2710 u16 new_id = cmp_cntxt;
2711 pr_err("(%s): Completion mismatch "
2712 "comp_id=0x%04x skreq=0x%04x new=0x%04x\n",
2713 skd_name(skdev), req_id,
2714 skreq->id, new_id);
2715
2716 continue;
2717 }
2718 }
2719
2720 SKD_ASSERT(skreq->state == SKD_REQ_STATE_BUSY);
2721
2722 if (skreq->state == SKD_REQ_STATE_ABORTED) {
2e44b427 2723 pr_debug("%s:%s:%d reclaim req %p id=%04x\n",
2724 skdev->name, __func__, __LINE__,
2725 skreq, skreq->id);
e67f86b3
AB
2726 /* a previously timed out command can
2727 * now be cleaned up */
2728 skd_release_skreq(skdev, skreq);
2729 continue;
2730 }
2731
2732 skreq->completion = *skcmp;
2733 if (unlikely(cmp_status == SAM_STAT_CHECK_CONDITION)) {
2734 skreq->err_info = *skerr;
2735 skd_log_check_status(skdev, cmp_status, skerr->key,
2736 skerr->code, skerr->qual,
2737 skerr->fruc);
2738 }
2739 /* Release DMA resources for the request. */
2740 if (skreq->n_sg > 0)
2741 skd_postop_sg_list(skdev, skreq);
2742
fcd37eb3 2743 if (!skreq->req) {
2e44b427 2744 pr_debug("%s:%s:%d NULL backptr skdreq %p, "
2745 "req=0x%x req_id=0x%x\n",
2746 skdev->name, __func__, __LINE__,
2747 skreq, skreq->id, req_id);
e67f86b3
AB
2748 } else {
2749 /*
2750 * Capture the outcome and post it back to the
2751 * native request.
2752 */
fcd37eb3 2753 if (likely(cmp_status == SAM_STAT_GOOD))
2a842aca 2754 skd_end_request(skdev, skreq, BLK_STS_OK);
fcd37eb3 2755 else
e67f86b3 2756 skd_resolve_req_exception(skdev, skreq);
e67f86b3
AB
2757 }
2758
2759 /*
2760 * Release the skreq, its FIT msg (if one), timeout slot,
2761 * and queue depth.
2762 */
2763 skd_release_skreq(skdev, skreq);
2764
2765 /* skd_isr_comp_limit equal zero means no limit */
2766 if (limit) {
2767 if (++processed >= limit) {
2768 rc = 1;
2769 break;
2770 }
2771 }
2772 }
2773
2774 if ((skdev->state == SKD_DRVR_STATE_PAUSING)
2775 && (skdev->in_flight) == 0) {
2776 skdev->state = SKD_DRVR_STATE_PAUSED;
2777 wake_up_interruptible(&skdev->waitq);
2778 }
2779
2780 return rc;
2781}
2782
2783static void skd_complete_other(struct skd_device *skdev,
2784 volatile struct fit_completion_entry_v1 *skcomp,
2785 volatile struct fit_comp_error_info *skerr)
2786{
2787 u32 req_id = 0;
2788 u32 req_table;
2789 u32 req_slot;
2790 struct skd_special_context *skspcl;
2791
2792 req_id = skcomp->tag;
2793 req_table = req_id & SKD_ID_TABLE_MASK;
2794 req_slot = req_id & SKD_ID_SLOT_MASK;
2795
2e44b427 2796 pr_debug("%s:%s:%d table=0x%x id=0x%x slot=%d\n",
2797 skdev->name, __func__, __LINE__,
2798 req_table, req_id, req_slot);
e67f86b3
AB
2799
2800 /*
2801 * Based on the request id, determine how to dispatch this completion.
2802 * This swich/case is finding the good cases and forwarding the
2803 * completion entry. Errors are reported below the switch.
2804 */
2805 switch (req_table) {
2806 case SKD_ID_RW_REQUEST:
2807 /*
2808 * The caller, skd_completion_posted_isr() above,
2809 * handles r/w requests. The only way we get here
2810 * is if the req_slot is out of bounds.
2811 */
2812 break;
2813
2814 case SKD_ID_SPECIAL_REQUEST:
2815 /*
2816 * Make sure the req_slot is in bounds and that the id
2817 * matches.
2818 */
2819 if (req_slot < skdev->n_special) {
2820 skspcl = &skdev->skspcl_table[req_slot];
2821 if (skspcl->req.id == req_id &&
2822 skspcl->req.state == SKD_REQ_STATE_BUSY) {
2823 skd_complete_special(skdev,
2824 skcomp, skerr, skspcl);
2825 return;
2826 }
2827 }
2828 break;
2829
2830 case SKD_ID_INTERNAL:
2831 if (req_slot == 0) {
2832 skspcl = &skdev->internal_skspcl;
2833 if (skspcl->req.id == req_id &&
2834 skspcl->req.state == SKD_REQ_STATE_BUSY) {
2835 skd_complete_internal(skdev,
2836 skcomp, skerr, skspcl);
2837 return;
2838 }
2839 }
2840 break;
2841
2842 case SKD_ID_FIT_MSG:
2843 /*
2844 * These id's should never appear in a completion record.
2845 */
2846 break;
2847
2848 default:
2849 /*
2850 * These id's should never appear anywhere;
2851 */
2852 break;
2853 }
2854
2855 /*
2856 * If we get here it is a bad or stale id.
2857 */
2858}
2859
2860static void skd_complete_special(struct skd_device *skdev,
2861 volatile struct fit_completion_entry_v1
2862 *skcomp,
2863 volatile struct fit_comp_error_info *skerr,
2864 struct skd_special_context *skspcl)
2865{
2e44b427 2866 pr_debug("%s:%s:%d completing special request %p\n",
2867 skdev->name, __func__, __LINE__, skspcl);
e67f86b3
AB
2868 if (skspcl->orphaned) {
2869 /* Discard orphaned request */
2870 /* ?: Can this release directly or does it need
2871 * to use a worker? */
2e44b427 2872 pr_debug("%s:%s:%d release orphaned %p\n",
2873 skdev->name, __func__, __LINE__, skspcl);
e67f86b3
AB
2874 skd_release_special(skdev, skspcl);
2875 return;
2876 }
2877
2878 skd_process_scsi_inq(skdev, skcomp, skerr, skspcl);
2879
2880 skspcl->req.state = SKD_REQ_STATE_COMPLETED;
2881 skspcl->req.completion = *skcomp;
2882 skspcl->req.err_info = *skerr;
2883
2884 skd_log_check_status(skdev, skspcl->req.completion.status, skerr->key,
2885 skerr->code, skerr->qual, skerr->fruc);
2886
2887 wake_up_interruptible(&skdev->waitq);
2888}
2889
2890/* assume spinlock is already held */
2891static void skd_release_special(struct skd_device *skdev,
2892 struct skd_special_context *skspcl)
2893{
2894 int i, was_depleted;
2895
2896 for (i = 0; i < skspcl->req.n_sg; i++) {
e67f86b3
AB
2897 struct page *page = sg_page(&skspcl->req.sg[i]);
2898 __free_page(page);
2899 }
2900
2901 was_depleted = (skdev->skspcl_free_list == NULL);
2902
2903 skspcl->req.state = SKD_REQ_STATE_IDLE;
2904 skspcl->req.id += SKD_ID_INCR;
2905 skspcl->req.next =
2906 (struct skd_request_context *)skdev->skspcl_free_list;
2907 skdev->skspcl_free_list = (struct skd_special_context *)skspcl;
2908
2909 if (was_depleted) {
2e44b427 2910 pr_debug("%s:%s:%d skspcl was depleted\n",
2911 skdev->name, __func__, __LINE__);
e67f86b3
AB
2912 /* Free list was depleted. Their might be waiters. */
2913 wake_up_interruptible(&skdev->waitq);
2914 }
2915}
2916
2917static void skd_reset_skcomp(struct skd_device *skdev)
2918{
2919 u32 nbytes;
2920 struct fit_completion_entry_v1 *skcomp;
2921
2922 nbytes = sizeof(*skcomp) * SKD_N_COMPLETION_ENTRY;
2923 nbytes += sizeof(struct fit_comp_error_info) * SKD_N_COMPLETION_ENTRY;
2924
2925 memset(skdev->skcomp_table, 0, nbytes);
2926
2927 skdev->skcomp_ix = 0;
2928 skdev->skcomp_cycle = 1;
2929}
2930
2931/*
2932 *****************************************************************************
2933 * INTERRUPTS
2934 *****************************************************************************
2935 */
2936static void skd_completion_worker(struct work_struct *work)
2937{
2938 struct skd_device *skdev =
2939 container_of(work, struct skd_device, completion_worker);
2940 unsigned long flags;
2941 int flush_enqueued = 0;
2942
2943 spin_lock_irqsave(&skdev->lock, flags);
2944
2945 /*
2946 * pass in limit=0, which means no limit..
2947 * process everything in compq
2948 */
2949 skd_isr_completion_posted(skdev, 0, &flush_enqueued);
2950 skd_request_fn(skdev->queue);
2951
2952 spin_unlock_irqrestore(&skdev->lock, flags);
2953}
2954
2955static void skd_isr_msg_from_dev(struct skd_device *skdev);
2956
41c9499b
AB
2957static irqreturn_t
2958skd_isr(int irq, void *ptr)
e67f86b3
AB
2959{
2960 struct skd_device *skdev;
2961 u32 intstat;
2962 u32 ack;
2963 int rc = 0;
2964 int deferred = 0;
2965 int flush_enqueued = 0;
2966
2967 skdev = (struct skd_device *)ptr;
2968 spin_lock(&skdev->lock);
2969
2970 for (;; ) {
2971 intstat = SKD_READL(skdev, FIT_INT_STATUS_HOST);
2972
2973 ack = FIT_INT_DEF_MASK;
2974 ack &= intstat;
2975
2e44b427 2976 pr_debug("%s:%s:%d intstat=0x%x ack=0x%x\n",
2977 skdev->name, __func__, __LINE__, intstat, ack);
e67f86b3
AB
2978
2979 /* As long as there is an int pending on device, keep
2980 * running loop. When none, get out, but if we've never
2981 * done any processing, call completion handler?
2982 */
2983 if (ack == 0) {
2984 /* No interrupts on device, but run the completion
2985 * processor anyway?
2986 */
2987 if (rc == 0)
2988 if (likely (skdev->state
2989 == SKD_DRVR_STATE_ONLINE))
2990 deferred = 1;
2991 break;
2992 }
2993
2994 rc = IRQ_HANDLED;
2995
2996 SKD_WRITEL(skdev, ack, FIT_INT_STATUS_HOST);
2997
2998 if (likely((skdev->state != SKD_DRVR_STATE_LOAD) &&
2999 (skdev->state != SKD_DRVR_STATE_STOPPING))) {
3000 if (intstat & FIT_ISH_COMPLETION_POSTED) {
3001 /*
3002 * If we have already deferred completion
3003 * processing, don't bother running it again
3004 */
3005 if (deferred == 0)
3006 deferred =
3007 skd_isr_completion_posted(skdev,
3008 skd_isr_comp_limit, &flush_enqueued);
3009 }
3010
3011 if (intstat & FIT_ISH_FW_STATE_CHANGE) {
3012 skd_isr_fwstate(skdev);
3013 if (skdev->state == SKD_DRVR_STATE_FAULT ||
3014 skdev->state ==
3015 SKD_DRVR_STATE_DISAPPEARED) {
3016 spin_unlock(&skdev->lock);
3017 return rc;
3018 }
3019 }
3020
3021 if (intstat & FIT_ISH_MSG_FROM_DEV)
3022 skd_isr_msg_from_dev(skdev);
3023 }
3024 }
3025
3026 if (unlikely(flush_enqueued))
3027 skd_request_fn(skdev->queue);
3028
3029 if (deferred)
3030 schedule_work(&skdev->completion_worker);
3031 else if (!flush_enqueued)
3032 skd_request_fn(skdev->queue);
3033
3034 spin_unlock(&skdev->lock);
3035
3036 return rc;
3037}
3038
e67f86b3
AB
3039static void skd_drive_fault(struct skd_device *skdev)
3040{
3041 skdev->state = SKD_DRVR_STATE_FAULT;
3042 pr_err("(%s): Drive FAULT\n", skd_name(skdev));
3043}
3044
3045static void skd_drive_disappeared(struct skd_device *skdev)
3046{
3047 skdev->state = SKD_DRVR_STATE_DISAPPEARED;
3048 pr_err("(%s): Drive DISAPPEARED\n", skd_name(skdev));
3049}
3050
3051static void skd_isr_fwstate(struct skd_device *skdev)
3052{
3053 u32 sense;
3054 u32 state;
3055 u32 mtd;
3056 int prev_driver_state = skdev->state;
3057
3058 sense = SKD_READL(skdev, FIT_STATUS);
3059 state = sense & FIT_SR_DRIVE_STATE_MASK;
3060
3061 pr_err("(%s): s1120 state %s(%d)=>%s(%d)\n",
3062 skd_name(skdev),
3063 skd_drive_state_to_str(skdev->drive_state), skdev->drive_state,
3064 skd_drive_state_to_str(state), state);
3065
3066 skdev->drive_state = state;
3067
3068 switch (skdev->drive_state) {
3069 case FIT_SR_DRIVE_INIT:
3070 if (skdev->state == SKD_DRVR_STATE_PROTOCOL_MISMATCH) {
3071 skd_disable_interrupts(skdev);
3072 break;
3073 }
3074 if (skdev->state == SKD_DRVR_STATE_RESTARTING)
3075 skd_recover_requests(skdev, 0);
3076 if (skdev->state == SKD_DRVR_STATE_WAIT_BOOT) {
3077 skdev->timer_countdown = SKD_STARTING_TIMO;
3078 skdev->state = SKD_DRVR_STATE_STARTING;
3079 skd_soft_reset(skdev);
3080 break;
3081 }
3082 mtd = FIT_MXD_CONS(FIT_MTD_FITFW_INIT, 0, 0);
3083 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3084 skdev->last_mtd = mtd;
3085 break;
3086
3087 case FIT_SR_DRIVE_ONLINE:
3088 skdev->cur_max_queue_depth = skd_max_queue_depth;
3089 if (skdev->cur_max_queue_depth > skdev->dev_max_queue_depth)
3090 skdev->cur_max_queue_depth = skdev->dev_max_queue_depth;
3091
3092 skdev->queue_low_water_mark =
3093 skdev->cur_max_queue_depth * 2 / 3 + 1;
3094 if (skdev->queue_low_water_mark < 1)
3095 skdev->queue_low_water_mark = 1;
3096 pr_info(
3097 "(%s): Queue depth limit=%d dev=%d lowat=%d\n",
3098 skd_name(skdev),
3099 skdev->cur_max_queue_depth,
3100 skdev->dev_max_queue_depth, skdev->queue_low_water_mark);
3101
3102 skd_refresh_device_data(skdev);
3103 break;
3104
3105 case FIT_SR_DRIVE_BUSY:
3106 skdev->state = SKD_DRVR_STATE_BUSY;
3107 skdev->timer_countdown = SKD_BUSY_TIMO;
3108 skd_quiesce_dev(skdev);
3109 break;
3110 case FIT_SR_DRIVE_BUSY_SANITIZE:
3111 /* set timer for 3 seconds, we'll abort any unfinished
3112 * commands after that expires
3113 */
3114 skdev->state = SKD_DRVR_STATE_BUSY_SANITIZE;
3115 skdev->timer_countdown = SKD_TIMER_SECONDS(3);
6a5ec65b 3116 blk_start_queue(skdev->queue);
e67f86b3
AB
3117 break;
3118 case FIT_SR_DRIVE_BUSY_ERASE:
3119 skdev->state = SKD_DRVR_STATE_BUSY_ERASE;
3120 skdev->timer_countdown = SKD_BUSY_TIMO;
3121 break;
3122 case FIT_SR_DRIVE_OFFLINE:
3123 skdev->state = SKD_DRVR_STATE_IDLE;
3124 break;
3125 case FIT_SR_DRIVE_SOFT_RESET:
3126 switch (skdev->state) {
3127 case SKD_DRVR_STATE_STARTING:
3128 case SKD_DRVR_STATE_RESTARTING:
3129 /* Expected by a caller of skd_soft_reset() */
3130 break;
3131 default:
3132 skdev->state = SKD_DRVR_STATE_RESTARTING;
3133 break;
3134 }
3135 break;
3136 case FIT_SR_DRIVE_FW_BOOTING:
2e44b427 3137 pr_debug("%s:%s:%d ISR FIT_SR_DRIVE_FW_BOOTING %s\n",
3138 skdev->name, __func__, __LINE__, skdev->name);
e67f86b3
AB
3139 skdev->state = SKD_DRVR_STATE_WAIT_BOOT;
3140 skdev->timer_countdown = SKD_WAIT_BOOT_TIMO;
3141 break;
3142
3143 case FIT_SR_DRIVE_DEGRADED:
3144 case FIT_SR_PCIE_LINK_DOWN:
3145 case FIT_SR_DRIVE_NEED_FW_DOWNLOAD:
3146 break;
3147
3148 case FIT_SR_DRIVE_FAULT:
3149 skd_drive_fault(skdev);
3150 skd_recover_requests(skdev, 0);
6a5ec65b 3151 blk_start_queue(skdev->queue);
e67f86b3
AB
3152 break;
3153
3154 /* PCIe bus returned all Fs? */
3155 case 0xFF:
3156 pr_info("(%s): state=0x%x sense=0x%x\n",
3157 skd_name(skdev), state, sense);
3158 skd_drive_disappeared(skdev);
3159 skd_recover_requests(skdev, 0);
6a5ec65b 3160 blk_start_queue(skdev->queue);
e67f86b3
AB
3161 break;
3162 default:
3163 /*
3164 * Uknown FW State. Wait for a state we recognize.
3165 */
3166 break;
3167 }
3168 pr_err("(%s): Driver state %s(%d)=>%s(%d)\n",
3169 skd_name(skdev),
3170 skd_skdev_state_to_str(prev_driver_state), prev_driver_state,
3171 skd_skdev_state_to_str(skdev->state), skdev->state);
3172}
3173
3174static void skd_recover_requests(struct skd_device *skdev, int requeue)
3175{
3176 int i;
3177
3178 for (i = 0; i < skdev->num_req_context; i++) {
3179 struct skd_request_context *skreq = &skdev->skreq_table[i];
3180
3181 if (skreq->state == SKD_REQ_STATE_BUSY) {
3182 skd_log_skreq(skdev, skreq, "recover");
3183
3184 SKD_ASSERT((skreq->id & SKD_ID_INCR) != 0);
fcd37eb3 3185 SKD_ASSERT(skreq->req != NULL);
e67f86b3
AB
3186
3187 /* Release DMA resources for the request. */
3188 if (skreq->n_sg > 0)
3189 skd_postop_sg_list(skdev, skreq);
3190
fcd37eb3
JA
3191 if (requeue &&
3192 (unsigned long) ++skreq->req->special <
3193 SKD_MAX_RETRIES)
38d4a1bb 3194 blk_requeue_request(skdev->queue, skreq->req);
fcd37eb3 3195 else
2a842aca 3196 skd_end_request(skdev, skreq, BLK_STS_IOERR);
e67f86b3 3197
fcd37eb3 3198 skreq->req = NULL;
e67f86b3
AB
3199
3200 skreq->state = SKD_REQ_STATE_IDLE;
3201 skreq->id += SKD_ID_INCR;
e67f86b3
AB
3202 }
3203 if (i > 0)
3204 skreq[-1].next = skreq;
3205 skreq->next = NULL;
3206 }
3207 skdev->skreq_free_list = skdev->skreq_table;
3208
3209 for (i = 0; i < skdev->num_fitmsg_context; i++) {
3210 struct skd_fitmsg_context *skmsg = &skdev->skmsg_table[i];
3211
3212 if (skmsg->state == SKD_MSG_STATE_BUSY) {
3213 skd_log_skmsg(skdev, skmsg, "salvaged");
3214 SKD_ASSERT((skmsg->id & SKD_ID_INCR) != 0);
3215 skmsg->state = SKD_MSG_STATE_IDLE;
3216 skmsg->id += SKD_ID_INCR;
3217 }
3218 if (i > 0)
3219 skmsg[-1].next = skmsg;
3220 skmsg->next = NULL;
3221 }
3222 skdev->skmsg_free_list = skdev->skmsg_table;
3223
3224 for (i = 0; i < skdev->n_special; i++) {
3225 struct skd_special_context *skspcl = &skdev->skspcl_table[i];
3226
3227 /* If orphaned, reclaim it because it has already been reported
3228 * to the process as an error (it was just waiting for
3229 * a completion that didn't come, and now it will never come)
3230 * If busy, change to a state that will cause it to error
3231 * out in the wait routine and let it do the normal
3232 * reporting and reclaiming
3233 */
3234 if (skspcl->req.state == SKD_REQ_STATE_BUSY) {
3235 if (skspcl->orphaned) {
2e44b427 3236 pr_debug("%s:%s:%d orphaned %p\n",
3237 skdev->name, __func__, __LINE__,
3238 skspcl);
e67f86b3
AB
3239 skd_release_special(skdev, skspcl);
3240 } else {
2e44b427 3241 pr_debug("%s:%s:%d not orphaned %p\n",
3242 skdev->name, __func__, __LINE__,
3243 skspcl);
e67f86b3
AB
3244 skspcl->req.state = SKD_REQ_STATE_ABORTED;
3245 }
3246 }
3247 }
3248 skdev->skspcl_free_list = skdev->skspcl_table;
3249
3250 for (i = 0; i < SKD_N_TIMEOUT_SLOT; i++)
3251 skdev->timeout_slot[i] = 0;
3252
3253 skdev->in_flight = 0;
3254}
3255
3256static void skd_isr_msg_from_dev(struct skd_device *skdev)
3257{
3258 u32 mfd;
3259 u32 mtd;
3260 u32 data;
3261
3262 mfd = SKD_READL(skdev, FIT_MSG_FROM_DEVICE);
3263
2e44b427 3264 pr_debug("%s:%s:%d mfd=0x%x last_mtd=0x%x\n",
3265 skdev->name, __func__, __LINE__, mfd, skdev->last_mtd);
e67f86b3
AB
3266
3267 /* ignore any mtd that is an ack for something we didn't send */
3268 if (FIT_MXD_TYPE(mfd) != FIT_MXD_TYPE(skdev->last_mtd))
3269 return;
3270
3271 switch (FIT_MXD_TYPE(mfd)) {
3272 case FIT_MTD_FITFW_INIT:
3273 skdev->proto_ver = FIT_PROTOCOL_MAJOR_VER(mfd);
3274
3275 if (skdev->proto_ver != FIT_PROTOCOL_VERSION_1) {
3276 pr_err("(%s): protocol mismatch\n",
3277 skdev->name);
3278 pr_err("(%s): got=%d support=%d\n",
3279 skdev->name, skdev->proto_ver,
3280 FIT_PROTOCOL_VERSION_1);
3281 pr_err("(%s): please upgrade driver\n",
3282 skdev->name);
3283 skdev->state = SKD_DRVR_STATE_PROTOCOL_MISMATCH;
3284 skd_soft_reset(skdev);
3285 break;
3286 }
3287 mtd = FIT_MXD_CONS(FIT_MTD_GET_CMDQ_DEPTH, 0, 0);
3288 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3289 skdev->last_mtd = mtd;
3290 break;
3291
3292 case FIT_MTD_GET_CMDQ_DEPTH:
3293 skdev->dev_max_queue_depth = FIT_MXD_DATA(mfd);
3294 mtd = FIT_MXD_CONS(FIT_MTD_SET_COMPQ_DEPTH, 0,
3295 SKD_N_COMPLETION_ENTRY);
3296 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3297 skdev->last_mtd = mtd;
3298 break;
3299
3300 case FIT_MTD_SET_COMPQ_DEPTH:
3301 SKD_WRITEQ(skdev, skdev->cq_dma_address, FIT_MSG_TO_DEVICE_ARG);
3302 mtd = FIT_MXD_CONS(FIT_MTD_SET_COMPQ_ADDR, 0, 0);
3303 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3304 skdev->last_mtd = mtd;
3305 break;
3306
3307 case FIT_MTD_SET_COMPQ_ADDR:
3308 skd_reset_skcomp(skdev);
3309 mtd = FIT_MXD_CONS(FIT_MTD_CMD_LOG_HOST_ID, 0, skdev->devno);
3310 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3311 skdev->last_mtd = mtd;
3312 break;
3313
3314 case FIT_MTD_CMD_LOG_HOST_ID:
3315 skdev->connect_time_stamp = get_seconds();
3316 data = skdev->connect_time_stamp & 0xFFFF;
3317 mtd = FIT_MXD_CONS(FIT_MTD_CMD_LOG_TIME_STAMP_LO, 0, data);
3318 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3319 skdev->last_mtd = mtd;
3320 break;
3321
3322 case FIT_MTD_CMD_LOG_TIME_STAMP_LO:
3323 skdev->drive_jiffies = FIT_MXD_DATA(mfd);
3324 data = (skdev->connect_time_stamp >> 16) & 0xFFFF;
3325 mtd = FIT_MXD_CONS(FIT_MTD_CMD_LOG_TIME_STAMP_HI, 0, data);
3326 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3327 skdev->last_mtd = mtd;
3328 break;
3329
3330 case FIT_MTD_CMD_LOG_TIME_STAMP_HI:
3331 skdev->drive_jiffies |= (FIT_MXD_DATA(mfd) << 16);
3332 mtd = FIT_MXD_CONS(FIT_MTD_ARM_QUEUE, 0, 0);
3333 SKD_WRITEL(skdev, mtd, FIT_MSG_TO_DEVICE);
3334 skdev->last_mtd = mtd;
3335
3336 pr_err("(%s): Time sync driver=0x%x device=0x%x\n",
3337 skd_name(skdev),
3338 skdev->connect_time_stamp, skdev->drive_jiffies);
3339 break;
3340
3341 case FIT_MTD_ARM_QUEUE:
3342 skdev->last_mtd = 0;
3343 /*
3344 * State should be, or soon will be, FIT_SR_DRIVE_ONLINE.
3345 */
3346 break;
3347
3348 default:
3349 break;
3350 }
3351}
3352
3353static void skd_disable_interrupts(struct skd_device *skdev)
3354{
3355 u32 sense;
3356
3357 sense = SKD_READL(skdev, FIT_CONTROL);
3358 sense &= ~FIT_CR_ENABLE_INTERRUPTS;
3359 SKD_WRITEL(skdev, sense, FIT_CONTROL);
2e44b427 3360 pr_debug("%s:%s:%d sense 0x%x\n",
3361 skdev->name, __func__, __LINE__, sense);
e67f86b3
AB
3362
3363 /* Note that the 1s is written. A 1-bit means
3364 * disable, a 0 means enable.
3365 */
3366 SKD_WRITEL(skdev, ~0, FIT_INT_MASK_HOST);
3367}
3368
3369static void skd_enable_interrupts(struct skd_device *skdev)
3370{
3371 u32 val;
3372
3373 /* unmask interrupts first */
3374 val = FIT_ISH_FW_STATE_CHANGE +
3375 FIT_ISH_COMPLETION_POSTED + FIT_ISH_MSG_FROM_DEV;
3376
3377 /* Note that the compliment of mask is written. A 1-bit means
3378 * disable, a 0 means enable. */
3379 SKD_WRITEL(skdev, ~val, FIT_INT_MASK_HOST);
2e44b427 3380 pr_debug("%s:%s:%d interrupt mask=0x%x\n",
3381 skdev->name, __func__, __LINE__, ~val);
e67f86b3
AB
3382
3383 val = SKD_READL(skdev, FIT_CONTROL);
3384 val |= FIT_CR_ENABLE_INTERRUPTS;
2e44b427 3385 pr_debug("%s:%s:%d control=0x%x\n",
3386 skdev->name, __func__, __LINE__, val);
e67f86b3
AB
3387 SKD_WRITEL(skdev, val, FIT_CONTROL);
3388}
3389
3390/*
3391 *****************************************************************************
3392 * START, STOP, RESTART, QUIESCE, UNQUIESCE
3393 *****************************************************************************
3394 */
3395
3396static void skd_soft_reset(struct skd_device *skdev)
3397{
3398 u32 val;
3399
3400 val = SKD_READL(skdev, FIT_CONTROL);
3401 val |= (FIT_CR_SOFT_RESET);
2e44b427 3402 pr_debug("%s:%s:%d control=0x%x\n",
3403 skdev->name, __func__, __LINE__, val);
e67f86b3
AB
3404 SKD_WRITEL(skdev, val, FIT_CONTROL);
3405}
3406
3407static void skd_start_device(struct skd_device *skdev)
3408{
3409 unsigned long flags;
3410 u32 sense;
3411 u32 state;
3412
3413 spin_lock_irqsave(&skdev->lock, flags);
3414
3415 /* ack all ghost interrupts */
3416 SKD_WRITEL(skdev, FIT_INT_DEF_MASK, FIT_INT_STATUS_HOST);
3417
3418 sense = SKD_READL(skdev, FIT_STATUS);
3419
2e44b427 3420 pr_debug("%s:%s:%d initial status=0x%x\n",
3421 skdev->name, __func__, __LINE__, sense);
e67f86b3
AB
3422
3423 state = sense & FIT_SR_DRIVE_STATE_MASK;
3424 skdev->drive_state = state;
3425 skdev->last_mtd = 0;
3426
3427 skdev->state = SKD_DRVR_STATE_STARTING;
3428 skdev->timer_countdown = SKD_STARTING_TIMO;
3429
3430 skd_enable_interrupts(skdev);
3431
3432 switch (skdev->drive_state) {
3433 case FIT_SR_DRIVE_OFFLINE:
3434 pr_err("(%s): Drive offline...\n", skd_name(skdev));
3435 break;
3436
3437 case FIT_SR_DRIVE_FW_BOOTING:
2e44b427 3438 pr_debug("%s:%s:%d FIT_SR_DRIVE_FW_BOOTING %s\n",
3439 skdev->name, __func__, __LINE__, skdev->name);
e67f86b3
AB
3440 skdev->state = SKD_DRVR_STATE_WAIT_BOOT;
3441 skdev->timer_countdown = SKD_WAIT_BOOT_TIMO;
3442 break;
3443
3444 case FIT_SR_DRIVE_BUSY_SANITIZE:
3445 pr_info("(%s): Start: BUSY_SANITIZE\n",
3446 skd_name(skdev));
3447 skdev->state = SKD_DRVR_STATE_BUSY_SANITIZE;
3448 skdev->timer_countdown = SKD_STARTED_BUSY_TIMO;
3449 break;
3450
3451 case FIT_SR_DRIVE_BUSY_ERASE:
3452 pr_info("(%s): Start: BUSY_ERASE\n", skd_name(skdev));
3453 skdev->state = SKD_DRVR_STATE_BUSY_ERASE;
3454 skdev->timer_countdown = SKD_STARTED_BUSY_TIMO;
3455 break;
3456
3457 case FIT_SR_DRIVE_INIT:
3458 case FIT_SR_DRIVE_ONLINE:
3459 skd_soft_reset(skdev);
3460 break;
3461
3462 case FIT_SR_DRIVE_BUSY:
3463 pr_err("(%s): Drive Busy...\n", skd_name(skdev));
3464 skdev->state = SKD_DRVR_STATE_BUSY;
3465 skdev->timer_countdown = SKD_STARTED_BUSY_TIMO;
3466 break;
3467
3468 case FIT_SR_DRIVE_SOFT_RESET:
3469 pr_err("(%s) drive soft reset in prog\n",
3470 skd_name(skdev));
3471 break;
3472
3473 case FIT_SR_DRIVE_FAULT:
3474 /* Fault state is bad...soft reset won't do it...
3475 * Hard reset, maybe, but does it work on device?
3476 * For now, just fault so the system doesn't hang.
3477 */
3478 skd_drive_fault(skdev);
3479 /*start the queue so we can respond with error to requests */
2e44b427 3480 pr_debug("%s:%s:%d starting %s queue\n",
3481 skdev->name, __func__, __LINE__, skdev->name);
6a5ec65b 3482 blk_start_queue(skdev->queue);
e67f86b3
AB
3483 skdev->gendisk_on = -1;
3484 wake_up_interruptible(&skdev->waitq);
3485 break;
3486
3487 case 0xFF:
3488 /* Most likely the device isn't there or isn't responding
3489 * to the BAR1 addresses. */
3490 skd_drive_disappeared(skdev);
3491 /*start the queue so we can respond with error to requests */
2e44b427 3492 pr_debug("%s:%s:%d starting %s queue to error-out reqs\n",
3493 skdev->name, __func__, __LINE__, skdev->name);
6a5ec65b 3494 blk_start_queue(skdev->queue);
e67f86b3
AB
3495 skdev->gendisk_on = -1;
3496 wake_up_interruptible(&skdev->waitq);
3497 break;
3498
3499 default:
3500 pr_err("(%s) Start: unknown state %x\n",
3501 skd_name(skdev), skdev->drive_state);
3502 break;
3503 }
3504
3505 state = SKD_READL(skdev, FIT_CONTROL);
2e44b427 3506 pr_debug("%s:%s:%d FIT Control Status=0x%x\n",
3507 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3508
3509 state = SKD_READL(skdev, FIT_INT_STATUS_HOST);
2e44b427 3510 pr_debug("%s:%s:%d Intr Status=0x%x\n",
3511 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3512
3513 state = SKD_READL(skdev, FIT_INT_MASK_HOST);
2e44b427 3514 pr_debug("%s:%s:%d Intr Mask=0x%x\n",
3515 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3516
3517 state = SKD_READL(skdev, FIT_MSG_FROM_DEVICE);
2e44b427 3518 pr_debug("%s:%s:%d Msg from Dev=0x%x\n",
3519 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3520
3521 state = SKD_READL(skdev, FIT_HW_VERSION);
2e44b427 3522 pr_debug("%s:%s:%d HW version=0x%x\n",
3523 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3524
3525 spin_unlock_irqrestore(&skdev->lock, flags);
3526}
3527
3528static void skd_stop_device(struct skd_device *skdev)
3529{
3530 unsigned long flags;
3531 struct skd_special_context *skspcl = &skdev->internal_skspcl;
3532 u32 dev_state;
3533 int i;
3534
3535 spin_lock_irqsave(&skdev->lock, flags);
3536
3537 if (skdev->state != SKD_DRVR_STATE_ONLINE) {
3538 pr_err("(%s): skd_stop_device not online no sync\n",
3539 skd_name(skdev));
3540 goto stop_out;
3541 }
3542
3543 if (skspcl->req.state != SKD_REQ_STATE_IDLE) {
3544 pr_err("(%s): skd_stop_device no special\n",
3545 skd_name(skdev));
3546 goto stop_out;
3547 }
3548
3549 skdev->state = SKD_DRVR_STATE_SYNCING;
3550 skdev->sync_done = 0;
3551
3552 skd_send_internal_skspcl(skdev, skspcl, SYNCHRONIZE_CACHE);
3553
3554 spin_unlock_irqrestore(&skdev->lock, flags);
3555
3556 wait_event_interruptible_timeout(skdev->waitq,
3557 (skdev->sync_done), (10 * HZ));
3558
3559 spin_lock_irqsave(&skdev->lock, flags);
3560
3561 switch (skdev->sync_done) {
3562 case 0:
3563 pr_err("(%s): skd_stop_device no sync\n",
3564 skd_name(skdev));
3565 break;
3566 case 1:
3567 pr_err("(%s): skd_stop_device sync done\n",
3568 skd_name(skdev));
3569 break;
3570 default:
3571 pr_err("(%s): skd_stop_device sync error\n",
3572 skd_name(skdev));
3573 }
3574
3575stop_out:
3576 skdev->state = SKD_DRVR_STATE_STOPPING;
3577 spin_unlock_irqrestore(&skdev->lock, flags);
3578
3579 skd_kill_timer(skdev);
3580
3581 spin_lock_irqsave(&skdev->lock, flags);
3582 skd_disable_interrupts(skdev);
3583
3584 /* ensure all ints on device are cleared */
3585 /* soft reset the device to unload with a clean slate */
3586 SKD_WRITEL(skdev, FIT_INT_DEF_MASK, FIT_INT_STATUS_HOST);
3587 SKD_WRITEL(skdev, FIT_CR_SOFT_RESET, FIT_CONTROL);
3588
3589 spin_unlock_irqrestore(&skdev->lock, flags);
3590
3591 /* poll every 100ms, 1 second timeout */
3592 for (i = 0; i < 10; i++) {
3593 dev_state =
3594 SKD_READL(skdev, FIT_STATUS) & FIT_SR_DRIVE_STATE_MASK;
3595 if (dev_state == FIT_SR_DRIVE_INIT)
3596 break;
3597 set_current_state(TASK_INTERRUPTIBLE);
3598 schedule_timeout(msecs_to_jiffies(100));
3599 }
3600
3601 if (dev_state != FIT_SR_DRIVE_INIT)
3602 pr_err("(%s): skd_stop_device state error 0x%02x\n",
3603 skd_name(skdev), dev_state);
3604}
3605
3606/* assume spinlock is held */
3607static void skd_restart_device(struct skd_device *skdev)
3608{
3609 u32 state;
3610
3611 /* ack all ghost interrupts */
3612 SKD_WRITEL(skdev, FIT_INT_DEF_MASK, FIT_INT_STATUS_HOST);
3613
3614 state = SKD_READL(skdev, FIT_STATUS);
3615
2e44b427 3616 pr_debug("%s:%s:%d drive status=0x%x\n",
3617 skdev->name, __func__, __LINE__, state);
e67f86b3
AB
3618
3619 state &= FIT_SR_DRIVE_STATE_MASK;
3620 skdev->drive_state = state;
3621 skdev->last_mtd = 0;
3622
3623 skdev->state = SKD_DRVR_STATE_RESTARTING;
3624 skdev->timer_countdown = SKD_RESTARTING_TIMO;
3625
3626 skd_soft_reset(skdev);
3627}
3628
3629/* assume spinlock is held */
3630static int skd_quiesce_dev(struct skd_device *skdev)
3631{
3632 int rc = 0;
3633
3634 switch (skdev->state) {
3635 case SKD_DRVR_STATE_BUSY:
3636 case SKD_DRVR_STATE_BUSY_IMMINENT:
2e44b427 3637 pr_debug("%s:%s:%d stopping %s queue\n",
3638 skdev->name, __func__, __LINE__, skdev->name);
6a5ec65b 3639 blk_stop_queue(skdev->queue);
e67f86b3
AB
3640 break;
3641 case SKD_DRVR_STATE_ONLINE:
3642 case SKD_DRVR_STATE_STOPPING:
3643 case SKD_DRVR_STATE_SYNCING:
3644 case SKD_DRVR_STATE_PAUSING:
3645 case SKD_DRVR_STATE_PAUSED:
3646 case SKD_DRVR_STATE_STARTING:
3647 case SKD_DRVR_STATE_RESTARTING:
3648 case SKD_DRVR_STATE_RESUMING:
3649 default:
3650 rc = -EINVAL;
2e44b427 3651 pr_debug("%s:%s:%d state [%d] not implemented\n",
3652 skdev->name, __func__, __LINE__, skdev->state);
e67f86b3
AB
3653 }
3654 return rc;
3655}
3656
3657/* assume spinlock is held */
3658static int skd_unquiesce_dev(struct skd_device *skdev)
3659{
3660 int prev_driver_state = skdev->state;
3661
3662 skd_log_skdev(skdev, "unquiesce");
3663 if (skdev->state == SKD_DRVR_STATE_ONLINE) {
2e44b427 3664 pr_debug("%s:%s:%d **** device already ONLINE\n",
3665 skdev->name, __func__, __LINE__);
e67f86b3
AB
3666 return 0;
3667 }
3668 if (skdev->drive_state != FIT_SR_DRIVE_ONLINE) {
3669 /*
3670 * If there has been an state change to other than
3671 * ONLINE, we will rely on controller state change
3672 * to come back online and restart the queue.
3673 * The BUSY state means that driver is ready to
3674 * continue normal processing but waiting for controller
3675 * to become available.
3676 */
3677 skdev->state = SKD_DRVR_STATE_BUSY;
2e44b427 3678 pr_debug("%s:%s:%d drive BUSY state\n",
3679 skdev->name, __func__, __LINE__);
e67f86b3
AB
3680 return 0;
3681 }
3682
3683 /*
3684 * Drive has just come online, driver is either in startup,
3685 * paused performing a task, or bust waiting for hardware.
3686 */
3687 switch (skdev->state) {
3688 case SKD_DRVR_STATE_PAUSED:
3689 case SKD_DRVR_STATE_BUSY:
3690 case SKD_DRVR_STATE_BUSY_IMMINENT:
3691 case SKD_DRVR_STATE_BUSY_ERASE:
3692 case SKD_DRVR_STATE_STARTING:
3693 case SKD_DRVR_STATE_RESTARTING:
3694 case SKD_DRVR_STATE_FAULT:
3695 case SKD_DRVR_STATE_IDLE:
3696 case SKD_DRVR_STATE_LOAD:
3697 skdev->state = SKD_DRVR_STATE_ONLINE;
3698 pr_err("(%s): Driver state %s(%d)=>%s(%d)\n",
3699 skd_name(skdev),
3700 skd_skdev_state_to_str(prev_driver_state),
3701 prev_driver_state, skd_skdev_state_to_str(skdev->state),
3702 skdev->state);
2e44b427 3703 pr_debug("%s:%s:%d **** device ONLINE...starting block queue\n",
3704 skdev->name, __func__, __LINE__);
3705 pr_debug("%s:%s:%d starting %s queue\n",
3706 skdev->name, __func__, __LINE__, skdev->name);
e67f86b3 3707 pr_info("(%s): STEC s1120 ONLINE\n", skd_name(skdev));
6a5ec65b 3708 blk_start_queue(skdev->queue);
e67f86b3
AB
3709 skdev->gendisk_on = 1;
3710 wake_up_interruptible(&skdev->waitq);
3711 break;
3712
3713 case SKD_DRVR_STATE_DISAPPEARED:
3714 default:
2e44b427 3715 pr_debug("%s:%s:%d **** driver state %d, not implemented \n",
3716 skdev->name, __func__, __LINE__,
3717 skdev->state);
e67f86b3
AB
3718 return -EBUSY;
3719 }
3720 return 0;
3721}
3722
3723/*
3724 *****************************************************************************
3725 * PCIe MSI/MSI-X INTERRUPT HANDLERS
3726 *****************************************************************************
3727 */
3728
3729static irqreturn_t skd_reserved_isr(int irq, void *skd_host_data)
3730{
3731 struct skd_device *skdev = skd_host_data;
3732 unsigned long flags;
3733
3734 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 3735 pr_debug("%s:%s:%d MSIX = 0x%x\n",
3736 skdev->name, __func__, __LINE__,
3737 SKD_READL(skdev, FIT_INT_STATUS_HOST));
e67f86b3
AB
3738 pr_err("(%s): MSIX reserved irq %d = 0x%x\n", skd_name(skdev),
3739 irq, SKD_READL(skdev, FIT_INT_STATUS_HOST));
3740 SKD_WRITEL(skdev, FIT_INT_RESERVED_MASK, FIT_INT_STATUS_HOST);
3741 spin_unlock_irqrestore(&skdev->lock, flags);
3742 return IRQ_HANDLED;
3743}
3744
3745static irqreturn_t skd_statec_isr(int irq, void *skd_host_data)
3746{
3747 struct skd_device *skdev = skd_host_data;
3748 unsigned long flags;
3749
3750 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 3751 pr_debug("%s:%s:%d MSIX = 0x%x\n",
3752 skdev->name, __func__, __LINE__,
3753 SKD_READL(skdev, FIT_INT_STATUS_HOST));
e67f86b3
AB
3754 SKD_WRITEL(skdev, FIT_ISH_FW_STATE_CHANGE, FIT_INT_STATUS_HOST);
3755 skd_isr_fwstate(skdev);
3756 spin_unlock_irqrestore(&skdev->lock, flags);
3757 return IRQ_HANDLED;
3758}
3759
3760static irqreturn_t skd_comp_q(int irq, void *skd_host_data)
3761{
3762 struct skd_device *skdev = skd_host_data;
3763 unsigned long flags;
3764 int flush_enqueued = 0;
3765 int deferred;
3766
3767 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 3768 pr_debug("%s:%s:%d MSIX = 0x%x\n",
3769 skdev->name, __func__, __LINE__,
3770 SKD_READL(skdev, FIT_INT_STATUS_HOST));
e67f86b3
AB
3771 SKD_WRITEL(skdev, FIT_ISH_COMPLETION_POSTED, FIT_INT_STATUS_HOST);
3772 deferred = skd_isr_completion_posted(skdev, skd_isr_comp_limit,
3773 &flush_enqueued);
e67f86b3
AB
3774 if (flush_enqueued)
3775 skd_request_fn(skdev->queue);
3776
3777 if (deferred)
3778 schedule_work(&skdev->completion_worker);
3779 else if (!flush_enqueued)
3780 skd_request_fn(skdev->queue);
3781
3782 spin_unlock_irqrestore(&skdev->lock, flags);
3783
3784 return IRQ_HANDLED;
3785}
3786
3787static irqreturn_t skd_msg_isr(int irq, void *skd_host_data)
3788{
3789 struct skd_device *skdev = skd_host_data;
3790 unsigned long flags;
3791
3792 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 3793 pr_debug("%s:%s:%d MSIX = 0x%x\n",
3794 skdev->name, __func__, __LINE__,
3795 SKD_READL(skdev, FIT_INT_STATUS_HOST));
e67f86b3
AB
3796 SKD_WRITEL(skdev, FIT_ISH_MSG_FROM_DEV, FIT_INT_STATUS_HOST);
3797 skd_isr_msg_from_dev(skdev);
3798 spin_unlock_irqrestore(&skdev->lock, flags);
3799 return IRQ_HANDLED;
3800}
3801
3802static irqreturn_t skd_qfull_isr(int irq, void *skd_host_data)
3803{
3804 struct skd_device *skdev = skd_host_data;
3805 unsigned long flags;
3806
3807 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 3808 pr_debug("%s:%s:%d MSIX = 0x%x\n",
3809 skdev->name, __func__, __LINE__,
3810 SKD_READL(skdev, FIT_INT_STATUS_HOST));
e67f86b3
AB
3811 SKD_WRITEL(skdev, FIT_INT_QUEUE_FULL, FIT_INT_STATUS_HOST);
3812 spin_unlock_irqrestore(&skdev->lock, flags);
3813 return IRQ_HANDLED;
3814}
3815
3816/*
3817 *****************************************************************************
3818 * PCIe MSI/MSI-X SETUP
3819 *****************************************************************************
3820 */
3821
3822struct skd_msix_entry {
e67f86b3
AB
3823 char isr_name[30];
3824};
3825
3826struct skd_init_msix_entry {
3827 const char *name;
3828 irq_handler_t handler;
3829};
3830
3831#define SKD_MAX_MSIX_COUNT 13
3832#define SKD_MIN_MSIX_COUNT 7
3833#define SKD_BASE_MSIX_IRQ 4
3834
3835static struct skd_init_msix_entry msix_entries[SKD_MAX_MSIX_COUNT] = {
3836 { "(DMA 0)", skd_reserved_isr },
3837 { "(DMA 1)", skd_reserved_isr },
3838 { "(DMA 2)", skd_reserved_isr },
3839 { "(DMA 3)", skd_reserved_isr },
3840 { "(State Change)", skd_statec_isr },
3841 { "(COMPL_Q)", skd_comp_q },
3842 { "(MSG)", skd_msg_isr },
3843 { "(Reserved)", skd_reserved_isr },
3844 { "(Reserved)", skd_reserved_isr },
3845 { "(Queue Full 0)", skd_qfull_isr },
3846 { "(Queue Full 1)", skd_qfull_isr },
3847 { "(Queue Full 2)", skd_qfull_isr },
3848 { "(Queue Full 3)", skd_qfull_isr },
3849};
3850
e67f86b3
AB
3851static int skd_acquire_msix(struct skd_device *skdev)
3852{
a9df8625 3853 int i, rc;
46817769 3854 struct pci_dev *pdev = skdev->pdev;
e67f86b3 3855
180b0ae7
CH
3856 rc = pci_alloc_irq_vectors(pdev, SKD_MAX_MSIX_COUNT, SKD_MAX_MSIX_COUNT,
3857 PCI_IRQ_MSIX);
3858 if (rc < 0) {
a9df8625
AG
3859 pr_err("(%s): failed to enable MSI-X %d\n",
3860 skd_name(skdev), rc);
3bc8492f 3861 goto out;
e67f86b3 3862 }
46817769 3863
180b0ae7
CH
3864 skdev->msix_entries = kcalloc(SKD_MAX_MSIX_COUNT,
3865 sizeof(struct skd_msix_entry), GFP_KERNEL);
e67f86b3
AB
3866 if (!skdev->msix_entries) {
3867 rc = -ENOMEM;
e67f86b3
AB
3868 pr_err("(%s): msix table allocation error\n",
3869 skd_name(skdev));
3bc8492f 3870 goto out;
e67f86b3
AB
3871 }
3872
e67f86b3 3873 /* Enable MSI-X vectors for the base queue */
180b0ae7
CH
3874 for (i = 0; i < SKD_MAX_MSIX_COUNT; i++) {
3875 struct skd_msix_entry *qentry = &skdev->msix_entries[i];
3876
e67f86b3
AB
3877 snprintf(qentry->isr_name, sizeof(qentry->isr_name),
3878 "%s%d-msix %s", DRV_NAME, skdev->devno,
3879 msix_entries[i].name);
180b0ae7
CH
3880
3881 rc = devm_request_irq(&skdev->pdev->dev,
3882 pci_irq_vector(skdev->pdev, i),
3883 msix_entries[i].handler, 0,
3884 qentry->isr_name, skdev);
e67f86b3
AB
3885 if (rc) {
3886 pr_err("(%s): Unable to register(%d) MSI-X "
3887 "handler %d: %s\n",
3888 skd_name(skdev), rc, i, qentry->isr_name);
3889 goto msix_out;
e67f86b3
AB
3890 }
3891 }
180b0ae7 3892
2e44b427 3893 pr_debug("%s:%s:%d %s: <%s> msix %d irq(s) enabled\n",
3894 skdev->name, __func__, __LINE__,
180b0ae7 3895 pci_name(pdev), skdev->name, SKD_MAX_MSIX_COUNT);
e67f86b3
AB
3896 return 0;
3897
3898msix_out:
180b0ae7
CH
3899 while (--i >= 0)
3900 devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i), skdev);
3bc8492f 3901out:
180b0ae7
CH
3902 kfree(skdev->msix_entries);
3903 skdev->msix_entries = NULL;
e67f86b3
AB
3904 return rc;
3905}
3906
3907static int skd_acquire_irq(struct skd_device *skdev)
3908{
180b0ae7
CH
3909 struct pci_dev *pdev = skdev->pdev;
3910 unsigned int irq_flag = PCI_IRQ_LEGACY;
e67f86b3 3911 int rc;
e67f86b3 3912
180b0ae7 3913 if (skd_isr_type == SKD_IRQ_MSIX) {
e67f86b3
AB
3914 rc = skd_acquire_msix(skdev);
3915 if (!rc)
180b0ae7
CH
3916 return 0;
3917
3918 pr_err("(%s): failed to enable MSI-X, re-trying with MSI %d\n",
3919 skd_name(skdev), rc);
e67f86b3 3920 }
180b0ae7
CH
3921
3922 snprintf(skdev->isr_name, sizeof(skdev->isr_name), "%s%d", DRV_NAME,
3923 skdev->devno);
3924
3925 if (skd_isr_type != SKD_IRQ_LEGACY)
3926 irq_flag |= PCI_IRQ_MSI;
3927 rc = pci_alloc_irq_vectors(pdev, 1, 1, irq_flag);
3928 if (rc < 0) {
3929 pr_err("(%s): failed to allocate the MSI interrupt %d\n",
3930 skd_name(skdev), rc);
3931 return rc;
3932 }
3933
3934 rc = devm_request_irq(&pdev->dev, pdev->irq, skd_isr,
3935 pdev->msi_enabled ? 0 : IRQF_SHARED,
3936 skdev->isr_name, skdev);
3937 if (rc) {
3938 pci_free_irq_vectors(pdev);
3939 pr_err("(%s): failed to allocate interrupt %d\n",
3940 skd_name(skdev), rc);
3941 return rc;
3942 }
3943
3944 return 0;
e67f86b3
AB
3945}
3946
3947static void skd_release_irq(struct skd_device *skdev)
3948{
180b0ae7
CH
3949 struct pci_dev *pdev = skdev->pdev;
3950
3951 if (skdev->msix_entries) {
3952 int i;
3953
3954 for (i = 0; i < SKD_MAX_MSIX_COUNT; i++) {
3955 devm_free_irq(&pdev->dev, pci_irq_vector(pdev, i),
3956 skdev);
3957 }
3958
3959 kfree(skdev->msix_entries);
3960 skdev->msix_entries = NULL;
3961 } else {
3962 devm_free_irq(&pdev->dev, pdev->irq, skdev);
e67f86b3 3963 }
180b0ae7
CH
3964
3965 pci_free_irq_vectors(pdev);
e67f86b3
AB
3966}
3967
3968/*
3969 *****************************************************************************
3970 * CONSTRUCT
3971 *****************************************************************************
3972 */
3973
e67f86b3
AB
3974static int skd_cons_skcomp(struct skd_device *skdev)
3975{
3976 int rc = 0;
3977 struct fit_completion_entry_v1 *skcomp;
3978 u32 nbytes;
3979
3980 nbytes = sizeof(*skcomp) * SKD_N_COMPLETION_ENTRY;
3981 nbytes += sizeof(struct fit_comp_error_info) * SKD_N_COMPLETION_ENTRY;
3982
2e44b427 3983 pr_debug("%s:%s:%d comp pci_alloc, total bytes %d entries %d\n",
3984 skdev->name, __func__, __LINE__,
3985 nbytes, SKD_N_COMPLETION_ENTRY);
e67f86b3 3986
a5bbf616
JP
3987 skcomp = pci_zalloc_consistent(skdev->pdev, nbytes,
3988 &skdev->cq_dma_address);
e67f86b3
AB
3989
3990 if (skcomp == NULL) {
3991 rc = -ENOMEM;
3992 goto err_out;
3993 }
3994
e67f86b3
AB
3995 skdev->skcomp_table = skcomp;
3996 skdev->skerr_table = (struct fit_comp_error_info *)((char *)skcomp +
3997 sizeof(*skcomp) *
3998 SKD_N_COMPLETION_ENTRY);
3999
4000err_out:
4001 return rc;
4002}
4003
4004static int skd_cons_skmsg(struct skd_device *skdev)
4005{
4006 int rc = 0;
4007 u32 i;
4008
2e44b427 4009 pr_debug("%s:%s:%d skmsg_table kzalloc, struct %lu, count %u total %lu\n",
4010 skdev->name, __func__, __LINE__,
4011 sizeof(struct skd_fitmsg_context),
4012 skdev->num_fitmsg_context,
4013 sizeof(struct skd_fitmsg_context) * skdev->num_fitmsg_context);
e67f86b3
AB
4014
4015 skdev->skmsg_table = kzalloc(sizeof(struct skd_fitmsg_context)
4016 *skdev->num_fitmsg_context, GFP_KERNEL);
4017 if (skdev->skmsg_table == NULL) {
4018 rc = -ENOMEM;
4019 goto err_out;
4020 }
4021
4022 for (i = 0; i < skdev->num_fitmsg_context; i++) {
4023 struct skd_fitmsg_context *skmsg;
4024
4025 skmsg = &skdev->skmsg_table[i];
4026
4027 skmsg->id = i + SKD_ID_FIT_MSG;
4028
4029 skmsg->state = SKD_MSG_STATE_IDLE;
4030 skmsg->msg_buf = pci_alloc_consistent(skdev->pdev,
4031 SKD_N_FITMSG_BYTES + 64,
4032 &skmsg->mb_dma_address);
4033
4034 if (skmsg->msg_buf == NULL) {
4035 rc = -ENOMEM;
4036 goto err_out;
4037 }
4038
4039 skmsg->offset = (u32)((u64)skmsg->msg_buf &
4040 (~FIT_QCMD_BASE_ADDRESS_MASK));
4041 skmsg->msg_buf += ~FIT_QCMD_BASE_ADDRESS_MASK;
4042 skmsg->msg_buf = (u8 *)((u64)skmsg->msg_buf &
4043 FIT_QCMD_BASE_ADDRESS_MASK);
4044 skmsg->mb_dma_address += ~FIT_QCMD_BASE_ADDRESS_MASK;
4045 skmsg->mb_dma_address &= FIT_QCMD_BASE_ADDRESS_MASK;
4046 memset(skmsg->msg_buf, 0, SKD_N_FITMSG_BYTES);
4047
4048 skmsg->next = &skmsg[1];
4049 }
4050
4051 /* Free list is in order starting with the 0th entry. */
4052 skdev->skmsg_table[i - 1].next = NULL;
4053 skdev->skmsg_free_list = skdev->skmsg_table;
4054
4055err_out:
4056 return rc;
4057}
4058
542d7b00
BZ
4059static struct fit_sg_descriptor *skd_cons_sg_list(struct skd_device *skdev,
4060 u32 n_sg,
4061 dma_addr_t *ret_dma_addr)
4062{
4063 struct fit_sg_descriptor *sg_list;
4064 u32 nbytes;
4065
4066 nbytes = sizeof(*sg_list) * n_sg;
4067
4068 sg_list = pci_alloc_consistent(skdev->pdev, nbytes, ret_dma_addr);
4069
4070 if (sg_list != NULL) {
4071 uint64_t dma_address = *ret_dma_addr;
4072 u32 i;
4073
4074 memset(sg_list, 0, nbytes);
4075
4076 for (i = 0; i < n_sg - 1; i++) {
4077 uint64_t ndp_off;
4078 ndp_off = (i + 1) * sizeof(struct fit_sg_descriptor);
4079
4080 sg_list[i].next_desc_ptr = dma_address + ndp_off;
4081 }
4082 sg_list[i].next_desc_ptr = 0LL;
4083 }
4084
4085 return sg_list;
4086}
4087
e67f86b3
AB
4088static int skd_cons_skreq(struct skd_device *skdev)
4089{
4090 int rc = 0;
4091 u32 i;
4092
2e44b427 4093 pr_debug("%s:%s:%d skreq_table kzalloc, struct %lu, count %u total %lu\n",
4094 skdev->name, __func__, __LINE__,
4095 sizeof(struct skd_request_context),
4096 skdev->num_req_context,
4097 sizeof(struct skd_request_context) * skdev->num_req_context);
e67f86b3
AB
4098
4099 skdev->skreq_table = kzalloc(sizeof(struct skd_request_context)
4100 * skdev->num_req_context, GFP_KERNEL);
4101 if (skdev->skreq_table == NULL) {
4102 rc = -ENOMEM;
4103 goto err_out;
4104 }
4105
2e44b427 4106 pr_debug("%s:%s:%d alloc sg_table sg_per_req %u scatlist %lu total %lu\n",
4107 skdev->name, __func__, __LINE__,
4108 skdev->sgs_per_request, sizeof(struct scatterlist),
4109 skdev->sgs_per_request * sizeof(struct scatterlist));
e67f86b3
AB
4110
4111 for (i = 0; i < skdev->num_req_context; i++) {
4112 struct skd_request_context *skreq;
4113
4114 skreq = &skdev->skreq_table[i];
4115
4116 skreq->id = i + SKD_ID_RW_REQUEST;
4117 skreq->state = SKD_REQ_STATE_IDLE;
4118
4119 skreq->sg = kzalloc(sizeof(struct scatterlist) *
4120 skdev->sgs_per_request, GFP_KERNEL);
4121 if (skreq->sg == NULL) {
4122 rc = -ENOMEM;
4123 goto err_out;
4124 }
4125 sg_init_table(skreq->sg, skdev->sgs_per_request);
4126
4127 skreq->sksg_list = skd_cons_sg_list(skdev,
4128 skdev->sgs_per_request,
4129 &skreq->sksg_dma_address);
4130
4131 if (skreq->sksg_list == NULL) {
4132 rc = -ENOMEM;
4133 goto err_out;
4134 }
4135
4136 skreq->next = &skreq[1];
4137 }
4138
4139 /* Free list is in order starting with the 0th entry. */
4140 skdev->skreq_table[i - 1].next = NULL;
4141 skdev->skreq_free_list = skdev->skreq_table;
4142
4143err_out:
4144 return rc;
4145}
4146
4147static int skd_cons_skspcl(struct skd_device *skdev)
4148{
4149 int rc = 0;
4150 u32 i, nbytes;
4151
2e44b427 4152 pr_debug("%s:%s:%d skspcl_table kzalloc, struct %lu, count %u total %lu\n",
4153 skdev->name, __func__, __LINE__,
4154 sizeof(struct skd_special_context),
4155 skdev->n_special,
4156 sizeof(struct skd_special_context) * skdev->n_special);
e67f86b3
AB
4157
4158 skdev->skspcl_table = kzalloc(sizeof(struct skd_special_context)
4159 * skdev->n_special, GFP_KERNEL);
4160 if (skdev->skspcl_table == NULL) {
4161 rc = -ENOMEM;
4162 goto err_out;
4163 }
4164
4165 for (i = 0; i < skdev->n_special; i++) {
4166 struct skd_special_context *skspcl;
4167
4168 skspcl = &skdev->skspcl_table[i];
4169
4170 skspcl->req.id = i + SKD_ID_SPECIAL_REQUEST;
4171 skspcl->req.state = SKD_REQ_STATE_IDLE;
4172
4173 skspcl->req.next = &skspcl[1].req;
4174
4175 nbytes = SKD_N_SPECIAL_FITMSG_BYTES;
4176
a5bbf616
JP
4177 skspcl->msg_buf =
4178 pci_zalloc_consistent(skdev->pdev, nbytes,
4179 &skspcl->mb_dma_address);
e67f86b3
AB
4180 if (skspcl->msg_buf == NULL) {
4181 rc = -ENOMEM;
4182 goto err_out;
4183 }
4184
e67f86b3
AB
4185 skspcl->req.sg = kzalloc(sizeof(struct scatterlist) *
4186 SKD_N_SG_PER_SPECIAL, GFP_KERNEL);
4187 if (skspcl->req.sg == NULL) {
4188 rc = -ENOMEM;
4189 goto err_out;
4190 }
4191
4192 skspcl->req.sksg_list = skd_cons_sg_list(skdev,
4193 SKD_N_SG_PER_SPECIAL,
4194 &skspcl->req.
4195 sksg_dma_address);
4196 if (skspcl->req.sksg_list == NULL) {
4197 rc = -ENOMEM;
4198 goto err_out;
4199 }
4200 }
4201
4202 /* Free list is in order starting with the 0th entry. */
4203 skdev->skspcl_table[i - 1].req.next = NULL;
4204 skdev->skspcl_free_list = skdev->skspcl_table;
4205
4206 return rc;
4207
4208err_out:
4209 return rc;
4210}
4211
4212static int skd_cons_sksb(struct skd_device *skdev)
4213{
4214 int rc = 0;
4215 struct skd_special_context *skspcl;
4216 u32 nbytes;
4217
4218 skspcl = &skdev->internal_skspcl;
4219
4220 skspcl->req.id = 0 + SKD_ID_INTERNAL;
4221 skspcl->req.state = SKD_REQ_STATE_IDLE;
4222
4223 nbytes = SKD_N_INTERNAL_BYTES;
4224
a5bbf616
JP
4225 skspcl->data_buf = pci_zalloc_consistent(skdev->pdev, nbytes,
4226 &skspcl->db_dma_address);
e67f86b3
AB
4227 if (skspcl->data_buf == NULL) {
4228 rc = -ENOMEM;
4229 goto err_out;
4230 }
4231
e67f86b3 4232 nbytes = SKD_N_SPECIAL_FITMSG_BYTES;
a5bbf616
JP
4233 skspcl->msg_buf = pci_zalloc_consistent(skdev->pdev, nbytes,
4234 &skspcl->mb_dma_address);
e67f86b3
AB
4235 if (skspcl->msg_buf == NULL) {
4236 rc = -ENOMEM;
4237 goto err_out;
4238 }
4239
e67f86b3
AB
4240 skspcl->req.sksg_list = skd_cons_sg_list(skdev, 1,
4241 &skspcl->req.sksg_dma_address);
4242 if (skspcl->req.sksg_list == NULL) {
4243 rc = -ENOMEM;
4244 goto err_out;
4245 }
4246
4247 if (!skd_format_internal_skspcl(skdev)) {
4248 rc = -EINVAL;
4249 goto err_out;
4250 }
4251
4252err_out:
4253 return rc;
4254}
4255
e67f86b3
AB
4256static int skd_cons_disk(struct skd_device *skdev)
4257{
4258 int rc = 0;
4259 struct gendisk *disk;
4260 struct request_queue *q;
4261 unsigned long flags;
4262
4263 disk = alloc_disk(SKD_MINORS_PER_DEVICE);
4264 if (!disk) {
4265 rc = -ENOMEM;
4266 goto err_out;
4267 }
4268
4269 skdev->disk = disk;
4270 sprintf(disk->disk_name, DRV_NAME "%u", skdev->devno);
4271
4272 disk->major = skdev->major;
4273 disk->first_minor = skdev->devno * SKD_MINORS_PER_DEVICE;
4274 disk->fops = &skd_blockdev_ops;
4275 disk->private_data = skdev;
4276
fcd37eb3 4277 q = blk_init_queue(skd_request_fn, &skdev->lock);
e67f86b3
AB
4278 if (!q) {
4279 rc = -ENOMEM;
4280 goto err_out;
4281 }
8fc45044 4282 blk_queue_bounce_limit(q, BLK_BOUNCE_HIGH);
e67f86b3
AB
4283
4284 skdev->queue = q;
4285 disk->queue = q;
4286 q->queuedata = skdev;
4287
6975f732 4288 blk_queue_write_cache(q, true, true);
e67f86b3
AB
4289 blk_queue_max_segments(q, skdev->sgs_per_request);
4290 blk_queue_max_hw_sectors(q, SKD_N_MAX_SECTORS);
4291
4292 /* set sysfs ptimal_io_size to 8K */
4293 blk_queue_io_opt(q, 8192);
4294
e67f86b3 4295 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, q);
b277da0a 4296 queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, q);
e67f86b3
AB
4297
4298 spin_lock_irqsave(&skdev->lock, flags);
2e44b427 4299 pr_debug("%s:%s:%d stopping %s queue\n",
4300 skdev->name, __func__, __LINE__, skdev->name);
6a5ec65b 4301 blk_stop_queue(skdev->queue);
e67f86b3
AB
4302 spin_unlock_irqrestore(&skdev->lock, flags);
4303
4304err_out:
4305 return rc;
4306}
4307
542d7b00
BZ
4308#define SKD_N_DEV_TABLE 16u
4309static u32 skd_next_devno;
e67f86b3 4310
542d7b00 4311static struct skd_device *skd_construct(struct pci_dev *pdev)
e67f86b3 4312{
542d7b00
BZ
4313 struct skd_device *skdev;
4314 int blk_major = skd_major;
4315 int rc;
e67f86b3 4316
542d7b00 4317 skdev = kzalloc(sizeof(*skdev), GFP_KERNEL);
e67f86b3 4318
542d7b00
BZ
4319 if (!skdev) {
4320 pr_err(PFX "(%s): memory alloc failure\n",
4321 pci_name(pdev));
4322 return NULL;
4323 }
e67f86b3 4324
542d7b00
BZ
4325 skdev->state = SKD_DRVR_STATE_LOAD;
4326 skdev->pdev = pdev;
4327 skdev->devno = skd_next_devno++;
4328 skdev->major = blk_major;
542d7b00
BZ
4329 sprintf(skdev->name, DRV_NAME "%d", skdev->devno);
4330 skdev->dev_max_queue_depth = 0;
e67f86b3 4331
542d7b00
BZ
4332 skdev->num_req_context = skd_max_queue_depth;
4333 skdev->num_fitmsg_context = skd_max_queue_depth;
4334 skdev->n_special = skd_max_pass_thru;
4335 skdev->cur_max_queue_depth = 1;
4336 skdev->queue_low_water_mark = 1;
4337 skdev->proto_ver = 99;
4338 skdev->sgs_per_request = skd_sgs_per_request;
4339 skdev->dbg_level = skd_dbg_level;
e67f86b3 4340
542d7b00 4341 atomic_set(&skdev->device_count, 0);
e67f86b3 4342
542d7b00
BZ
4343 spin_lock_init(&skdev->lock);
4344
4345 INIT_WORK(&skdev->completion_worker, skd_completion_worker);
e67f86b3 4346
2e44b427 4347 pr_debug("%s:%s:%d skcomp\n", skdev->name, __func__, __LINE__);
542d7b00
BZ
4348 rc = skd_cons_skcomp(skdev);
4349 if (rc < 0)
4350 goto err_out;
e67f86b3 4351
542d7b00
BZ
4352 pr_debug("%s:%s:%d skmsg\n", skdev->name, __func__, __LINE__);
4353 rc = skd_cons_skmsg(skdev);
4354 if (rc < 0)
4355 goto err_out;
4356
4357 pr_debug("%s:%s:%d skreq\n", skdev->name, __func__, __LINE__);
4358 rc = skd_cons_skreq(skdev);
4359 if (rc < 0)
4360 goto err_out;
4361
4362 pr_debug("%s:%s:%d skspcl\n", skdev->name, __func__, __LINE__);
4363 rc = skd_cons_skspcl(skdev);
4364 if (rc < 0)
4365 goto err_out;
4366
4367 pr_debug("%s:%s:%d sksb\n", skdev->name, __func__, __LINE__);
4368 rc = skd_cons_sksb(skdev);
4369 if (rc < 0)
4370 goto err_out;
4371
4372 pr_debug("%s:%s:%d disk\n", skdev->name, __func__, __LINE__);
4373 rc = skd_cons_disk(skdev);
4374 if (rc < 0)
4375 goto err_out;
4376
4377 pr_debug("%s:%s:%d VICTORY\n", skdev->name, __func__, __LINE__);
4378 return skdev;
4379
4380err_out:
4381 pr_debug("%s:%s:%d construct failed\n",
4382 skdev->name, __func__, __LINE__);
4383 skd_destruct(skdev);
4384 return NULL;
e67f86b3
AB
4385}
4386
542d7b00
BZ
4387/*
4388 *****************************************************************************
4389 * DESTRUCT (FREE)
4390 *****************************************************************************
4391 */
4392
e67f86b3
AB
4393static void skd_free_skcomp(struct skd_device *skdev)
4394{
4395 if (skdev->skcomp_table != NULL) {
4396 u32 nbytes;
4397
4398 nbytes = sizeof(skdev->skcomp_table[0]) *
4399 SKD_N_COMPLETION_ENTRY;
4400 pci_free_consistent(skdev->pdev, nbytes,
4401 skdev->skcomp_table, skdev->cq_dma_address);
4402 }
4403
4404 skdev->skcomp_table = NULL;
4405 skdev->cq_dma_address = 0;
4406}
4407
4408static void skd_free_skmsg(struct skd_device *skdev)
4409{
4410 u32 i;
4411
4412 if (skdev->skmsg_table == NULL)
4413 return;
4414
4415 for (i = 0; i < skdev->num_fitmsg_context; i++) {
4416 struct skd_fitmsg_context *skmsg;
4417
4418 skmsg = &skdev->skmsg_table[i];
4419
4420 if (skmsg->msg_buf != NULL) {
4421 skmsg->msg_buf += skmsg->offset;
4422 skmsg->mb_dma_address += skmsg->offset;
4423 pci_free_consistent(skdev->pdev, SKD_N_FITMSG_BYTES,
4424 skmsg->msg_buf,
4425 skmsg->mb_dma_address);
4426 }
4427 skmsg->msg_buf = NULL;
4428 skmsg->mb_dma_address = 0;
4429 }
4430
4431 kfree(skdev->skmsg_table);
4432 skdev->skmsg_table = NULL;
4433}
4434
542d7b00
BZ
4435static void skd_free_sg_list(struct skd_device *skdev,
4436 struct fit_sg_descriptor *sg_list,
4437 u32 n_sg, dma_addr_t dma_addr)
4438{
4439 if (sg_list != NULL) {
4440 u32 nbytes;
4441
4442 nbytes = sizeof(*sg_list) * n_sg;
4443
4444 pci_free_consistent(skdev->pdev, nbytes, sg_list, dma_addr);
4445 }
4446}
4447
e67f86b3
AB
4448static void skd_free_skreq(struct skd_device *skdev)
4449{
4450 u32 i;
4451
4452 if (skdev->skreq_table == NULL)
4453 return;
4454
4455 for (i = 0; i < skdev->num_req_context; i++) {
4456 struct skd_request_context *skreq;
4457
4458 skreq = &skdev->skreq_table[i];
4459
4460 skd_free_sg_list(skdev, skreq->sksg_list,
4461 skdev->sgs_per_request,
4462 skreq->sksg_dma_address);
4463
4464 skreq->sksg_list = NULL;
4465 skreq->sksg_dma_address = 0;
4466
4467 kfree(skreq->sg);
4468 }
4469
4470 kfree(skdev->skreq_table);
4471 skdev->skreq_table = NULL;
4472}
4473
4474static void skd_free_skspcl(struct skd_device *skdev)
4475{
4476 u32 i;
4477 u32 nbytes;
4478
4479 if (skdev->skspcl_table == NULL)
4480 return;
4481
4482 for (i = 0; i < skdev->n_special; i++) {
4483 struct skd_special_context *skspcl;
4484
4485 skspcl = &skdev->skspcl_table[i];
4486
4487 if (skspcl->msg_buf != NULL) {
4488 nbytes = SKD_N_SPECIAL_FITMSG_BYTES;
4489 pci_free_consistent(skdev->pdev, nbytes,
4490 skspcl->msg_buf,
4491 skspcl->mb_dma_address);
4492 }
4493
4494 skspcl->msg_buf = NULL;
4495 skspcl->mb_dma_address = 0;
4496
4497 skd_free_sg_list(skdev, skspcl->req.sksg_list,
4498 SKD_N_SG_PER_SPECIAL,
4499 skspcl->req.sksg_dma_address);
4500
4501 skspcl->req.sksg_list = NULL;
4502 skspcl->req.sksg_dma_address = 0;
4503
4504 kfree(skspcl->req.sg);
4505 }
4506
4507 kfree(skdev->skspcl_table);
4508 skdev->skspcl_table = NULL;
4509}
4510
4511static void skd_free_sksb(struct skd_device *skdev)
4512{
4513 struct skd_special_context *skspcl;
4514 u32 nbytes;
4515
4516 skspcl = &skdev->internal_skspcl;
4517
4518 if (skspcl->data_buf != NULL) {
4519 nbytes = SKD_N_INTERNAL_BYTES;
4520
4521 pci_free_consistent(skdev->pdev, nbytes,
4522 skspcl->data_buf, skspcl->db_dma_address);
4523 }
4524
4525 skspcl->data_buf = NULL;
4526 skspcl->db_dma_address = 0;
4527
4528 if (skspcl->msg_buf != NULL) {
4529 nbytes = SKD_N_SPECIAL_FITMSG_BYTES;
4530 pci_free_consistent(skdev->pdev, nbytes,
4531 skspcl->msg_buf, skspcl->mb_dma_address);
4532 }
4533
4534 skspcl->msg_buf = NULL;
4535 skspcl->mb_dma_address = 0;
4536
4537 skd_free_sg_list(skdev, skspcl->req.sksg_list, 1,
4538 skspcl->req.sksg_dma_address);
4539
4540 skspcl->req.sksg_list = NULL;
4541 skspcl->req.sksg_dma_address = 0;
4542}
4543
e67f86b3
AB
4544static void skd_free_disk(struct skd_device *skdev)
4545{
4546 struct gendisk *disk = skdev->disk;
4547
f4278337
BVA
4548 if (disk && (disk->flags & GENHD_FL_UP))
4549 del_gendisk(disk);
4550
4551 if (skdev->queue) {
4552 blk_cleanup_queue(skdev->queue);
4553 skdev->queue = NULL;
4554 disk->queue = NULL;
e67f86b3 4555 }
f4278337
BVA
4556
4557 put_disk(disk);
e67f86b3
AB
4558 skdev->disk = NULL;
4559}
4560
542d7b00
BZ
4561static void skd_destruct(struct skd_device *skdev)
4562{
4563 if (skdev == NULL)
4564 return;
4565
4566
4567 pr_debug("%s:%s:%d disk\n", skdev->name, __func__, __LINE__);
4568 skd_free_disk(skdev);
4569
4570 pr_debug("%s:%s:%d sksb\n", skdev->name, __func__, __LINE__);
4571 skd_free_sksb(skdev);
4572
4573 pr_debug("%s:%s:%d skspcl\n", skdev->name, __func__, __LINE__);
4574 skd_free_skspcl(skdev);
4575
4576 pr_debug("%s:%s:%d skreq\n", skdev->name, __func__, __LINE__);
4577 skd_free_skreq(skdev);
4578
4579 pr_debug("%s:%s:%d skmsg\n", skdev->name, __func__, __LINE__);
4580 skd_free_skmsg(skdev);
e67f86b3 4581
542d7b00
BZ
4582 pr_debug("%s:%s:%d skcomp\n", skdev->name, __func__, __LINE__);
4583 skd_free_skcomp(skdev);
4584
4585 pr_debug("%s:%s:%d skdev\n", skdev->name, __func__, __LINE__);
4586 kfree(skdev);
4587}
e67f86b3
AB
4588
4589/*
4590 *****************************************************************************
4591 * BLOCK DEVICE (BDEV) GLUE
4592 *****************************************************************************
4593 */
4594
4595static int skd_bdev_getgeo(struct block_device *bdev, struct hd_geometry *geo)
4596{
4597 struct skd_device *skdev;
4598 u64 capacity;
4599
4600 skdev = bdev->bd_disk->private_data;
4601
2e44b427 4602 pr_debug("%s:%s:%d %s: CMD[%s] getgeo device\n",
4603 skdev->name, __func__, __LINE__,
4604 bdev->bd_disk->disk_name, current->comm);
e67f86b3
AB
4605
4606 if (skdev->read_cap_is_valid) {
4607 capacity = get_capacity(skdev->disk);
4608 geo->heads = 64;
4609 geo->sectors = 255;
4610 geo->cylinders = (capacity) / (255 * 64);
4611
4612 return 0;
4613 }
4614 return -EIO;
4615}
4616
0d52c756 4617static int skd_bdev_attach(struct device *parent, struct skd_device *skdev)
e67f86b3 4618{
2e44b427 4619 pr_debug("%s:%s:%d add_disk\n", skdev->name, __func__, __LINE__);
0d52c756 4620 device_add_disk(parent, skdev->disk);
e67f86b3
AB
4621 return 0;
4622}
4623
4624static const struct block_device_operations skd_blockdev_ops = {
4625 .owner = THIS_MODULE,
4626 .ioctl = skd_bdev_ioctl,
4627 .getgeo = skd_bdev_getgeo,
4628};
4629
4630
4631/*
4632 *****************************************************************************
4633 * PCIe DRIVER GLUE
4634 *****************************************************************************
4635 */
4636
9baa3c34 4637static const struct pci_device_id skd_pci_tbl[] = {
e67f86b3
AB
4638 { PCI_VENDOR_ID_STEC, PCI_DEVICE_ID_S1120,
4639 PCI_ANY_ID, PCI_ANY_ID, 0, 0, },
4640 { 0 } /* terminate list */
4641};
4642
4643MODULE_DEVICE_TABLE(pci, skd_pci_tbl);
4644
4645static char *skd_pci_info(struct skd_device *skdev, char *str)
4646{
4647 int pcie_reg;
4648
4649 strcpy(str, "PCIe (");
4650 pcie_reg = pci_find_capability(skdev->pdev, PCI_CAP_ID_EXP);
4651
4652 if (pcie_reg) {
4653
4654 char lwstr[6];
4655 uint16_t pcie_lstat, lspeed, lwidth;
4656
4657 pcie_reg += 0x12;
4658 pci_read_config_word(skdev->pdev, pcie_reg, &pcie_lstat);
4659 lspeed = pcie_lstat & (0xF);
4660 lwidth = (pcie_lstat & 0x3F0) >> 4;
4661
4662 if (lspeed == 1)
4663 strcat(str, "2.5GT/s ");
4664 else if (lspeed == 2)
4665 strcat(str, "5.0GT/s ");
4666 else
4667 strcat(str, "<unknown> ");
4668 snprintf(lwstr, sizeof(lwstr), "%dX)", lwidth);
4669 strcat(str, lwstr);
4670 }
4671 return str;
4672}
4673
4674static int skd_pci_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
4675{
4676 int i;
4677 int rc = 0;
4678 char pci_str[32];
4679 struct skd_device *skdev;
4680
4681 pr_info("STEC s1120 Driver(%s) version %s-b%s\n",
4682 DRV_NAME, DRV_VERSION, DRV_BUILD_ID);
4683 pr_info("(skd?:??:[%s]): vendor=%04X device=%04x\n",
4684 pci_name(pdev), pdev->vendor, pdev->device);
4685
4686 rc = pci_enable_device(pdev);
4687 if (rc)
4688 return rc;
4689 rc = pci_request_regions(pdev, DRV_NAME);
4690 if (rc)
4691 goto err_out;
4692 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
4693 if (!rc) {
4694 if (pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64))) {
4695
4696 pr_err("(%s): consistent DMA mask error %d\n",
4697 pci_name(pdev), rc);
4698 }
4699 } else {
4700 (rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(32)));
4701 if (rc) {
4702
4703 pr_err("(%s): DMA mask error %d\n",
4704 pci_name(pdev), rc);
4705 goto err_out_regions;
4706 }
4707 }
4708
b8df6647
BZ
4709 if (!skd_major) {
4710 rc = register_blkdev(0, DRV_NAME);
4711 if (rc < 0)
4712 goto err_out_regions;
4713 BUG_ON(!rc);
4714 skd_major = rc;
4715 }
4716
e67f86b3 4717 skdev = skd_construct(pdev);
1762b57f
WY
4718 if (skdev == NULL) {
4719 rc = -ENOMEM;
e67f86b3 4720 goto err_out_regions;
1762b57f 4721 }
e67f86b3
AB
4722
4723 skd_pci_info(skdev, pci_str);
4724 pr_info("(%s): %s 64bit\n", skd_name(skdev), pci_str);
4725
4726 pci_set_master(pdev);
4727 rc = pci_enable_pcie_error_reporting(pdev);
4728 if (rc) {
4729 pr_err(
4730 "(%s): bad enable of PCIe error reporting rc=%d\n",
4731 skd_name(skdev), rc);
4732 skdev->pcie_error_reporting_is_enabled = 0;
4733 } else
4734 skdev->pcie_error_reporting_is_enabled = 1;
4735
4736
4737 pci_set_drvdata(pdev, skdev);
ebedd16d 4738
e67f86b3
AB
4739 for (i = 0; i < SKD_MAX_BARS; i++) {
4740 skdev->mem_phys[i] = pci_resource_start(pdev, i);
4741 skdev->mem_size[i] = (u32)pci_resource_len(pdev, i);
4742 skdev->mem_map[i] = ioremap(skdev->mem_phys[i],
4743 skdev->mem_size[i]);
4744 if (!skdev->mem_map[i]) {
4745 pr_err("(%s): Unable to map adapter memory!\n",
4746 skd_name(skdev));
4747 rc = -ENODEV;
4748 goto err_out_iounmap;
4749 }
2e44b427 4750 pr_debug("%s:%s:%d mem_map=%p, phyd=%016llx, size=%d\n",
4751 skdev->name, __func__, __LINE__,
4752 skdev->mem_map[i],
4753 (uint64_t)skdev->mem_phys[i], skdev->mem_size[i]);
e67f86b3
AB
4754 }
4755
4756 rc = skd_acquire_irq(skdev);
4757 if (rc) {
4758 pr_err("(%s): interrupt resource error %d\n",
4759 skd_name(skdev), rc);
4760 goto err_out_iounmap;
4761 }
4762
4763 rc = skd_start_timer(skdev);
4764 if (rc)
4765 goto err_out_timer;
4766
4767 init_waitqueue_head(&skdev->waitq);
4768
4769 skd_start_device(skdev);
4770
4771 rc = wait_event_interruptible_timeout(skdev->waitq,
4772 (skdev->gendisk_on),
4773 (SKD_START_WAIT_SECONDS * HZ));
4774 if (skdev->gendisk_on > 0) {
4775 /* device came on-line after reset */
0d52c756 4776 skd_bdev_attach(&pdev->dev, skdev);
e67f86b3
AB
4777 rc = 0;
4778 } else {
4779 /* we timed out, something is wrong with the device,
4780 don't add the disk structure */
4781 pr_err(
4782 "(%s): error: waiting for s1120 timed out %d!\n",
4783 skd_name(skdev), rc);
4784 /* in case of no error; we timeout with ENXIO */
4785 if (!rc)
4786 rc = -ENXIO;
4787 goto err_out_timer;
4788 }
4789
4790
4791#ifdef SKD_VMK_POLL_HANDLER
4792 if (skdev->irq_type == SKD_IRQ_MSIX) {
4793 /* MSIX completion handler is being used for coredump */
4794 vmklnx_scsi_register_poll_handler(skdev->scsi_host,
4795 skdev->msix_entries[5].vector,
4796 skd_comp_q, skdev);
4797 } else {
4798 vmklnx_scsi_register_poll_handler(skdev->scsi_host,
4799 skdev->pdev->irq, skd_isr,
4800 skdev);
4801 }
4802#endif /* SKD_VMK_POLL_HANDLER */
4803
4804 return rc;
4805
4806err_out_timer:
4807 skd_stop_device(skdev);
4808 skd_release_irq(skdev);
4809
4810err_out_iounmap:
4811 for (i = 0; i < SKD_MAX_BARS; i++)
4812 if (skdev->mem_map[i])
4813 iounmap(skdev->mem_map[i]);
4814
4815 if (skdev->pcie_error_reporting_is_enabled)
4816 pci_disable_pcie_error_reporting(pdev);
4817
4818 skd_destruct(skdev);
4819
4820err_out_regions:
4821 pci_release_regions(pdev);
4822
4823err_out:
4824 pci_disable_device(pdev);
4825 pci_set_drvdata(pdev, NULL);
4826 return rc;
4827}
4828
4829static void skd_pci_remove(struct pci_dev *pdev)
4830{
4831 int i;
4832 struct skd_device *skdev;
4833
4834 skdev = pci_get_drvdata(pdev);
4835 if (!skdev) {
4836 pr_err("%s: no device data for PCI\n", pci_name(pdev));
4837 return;
4838 }
4839 skd_stop_device(skdev);
4840 skd_release_irq(skdev);
4841
4842 for (i = 0; i < SKD_MAX_BARS; i++)
4843 if (skdev->mem_map[i])
4844 iounmap((u32 *)skdev->mem_map[i]);
4845
4846 if (skdev->pcie_error_reporting_is_enabled)
4847 pci_disable_pcie_error_reporting(pdev);
4848
4849 skd_destruct(skdev);
4850
4851 pci_release_regions(pdev);
4852 pci_disable_device(pdev);
4853 pci_set_drvdata(pdev, NULL);
4854
4855 return;
4856}
4857
4858static int skd_pci_suspend(struct pci_dev *pdev, pm_message_t state)
4859{
4860 int i;
4861 struct skd_device *skdev;
4862
4863 skdev = pci_get_drvdata(pdev);
4864 if (!skdev) {
4865 pr_err("%s: no device data for PCI\n", pci_name(pdev));
4866 return -EIO;
4867 }
4868
4869 skd_stop_device(skdev);
4870
4871 skd_release_irq(skdev);
4872
4873 for (i = 0; i < SKD_MAX_BARS; i++)
4874 if (skdev->mem_map[i])
4875 iounmap((u32 *)skdev->mem_map[i]);
4876
4877 if (skdev->pcie_error_reporting_is_enabled)
4878 pci_disable_pcie_error_reporting(pdev);
4879
4880 pci_release_regions(pdev);
4881 pci_save_state(pdev);
4882 pci_disable_device(pdev);
4883 pci_set_power_state(pdev, pci_choose_state(pdev, state));
4884 return 0;
4885}
4886
4887static int skd_pci_resume(struct pci_dev *pdev)
4888{
4889 int i;
4890 int rc = 0;
4891 struct skd_device *skdev;
4892
4893 skdev = pci_get_drvdata(pdev);
4894 if (!skdev) {
4895 pr_err("%s: no device data for PCI\n", pci_name(pdev));
4896 return -1;
4897 }
4898
4899 pci_set_power_state(pdev, PCI_D0);
4900 pci_enable_wake(pdev, PCI_D0, 0);
4901 pci_restore_state(pdev);
4902
4903 rc = pci_enable_device(pdev);
4904 if (rc)
4905 return rc;
4906 rc = pci_request_regions(pdev, DRV_NAME);
4907 if (rc)
4908 goto err_out;
4909 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(64));
4910 if (!rc) {
4911 if (pci_set_consistent_dma_mask(pdev, DMA_BIT_MASK(64))) {
4912
4913 pr_err("(%s): consistent DMA mask error %d\n",
4914 pci_name(pdev), rc);
4915 }
4916 } else {
4917 rc = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
4918 if (rc) {
4919
4920 pr_err("(%s): DMA mask error %d\n",
4921 pci_name(pdev), rc);
4922 goto err_out_regions;
4923 }
4924 }
4925
4926 pci_set_master(pdev);
4927 rc = pci_enable_pcie_error_reporting(pdev);
4928 if (rc) {
4929 pr_err("(%s): bad enable of PCIe error reporting rc=%d\n",
4930 skdev->name, rc);
4931 skdev->pcie_error_reporting_is_enabled = 0;
4932 } else
4933 skdev->pcie_error_reporting_is_enabled = 1;
4934
4935 for (i = 0; i < SKD_MAX_BARS; i++) {
4936
4937 skdev->mem_phys[i] = pci_resource_start(pdev, i);
4938 skdev->mem_size[i] = (u32)pci_resource_len(pdev, i);
4939 skdev->mem_map[i] = ioremap(skdev->mem_phys[i],
4940 skdev->mem_size[i]);
4941 if (!skdev->mem_map[i]) {
4942 pr_err("(%s): Unable to map adapter memory!\n",
4943 skd_name(skdev));
4944 rc = -ENODEV;
4945 goto err_out_iounmap;
4946 }
2e44b427 4947 pr_debug("%s:%s:%d mem_map=%p, phyd=%016llx, size=%d\n",
4948 skdev->name, __func__, __LINE__,
4949 skdev->mem_map[i],
4950 (uint64_t)skdev->mem_phys[i], skdev->mem_size[i]);
e67f86b3
AB
4951 }
4952 rc = skd_acquire_irq(skdev);
4953 if (rc) {
4954
4955 pr_err("(%s): interrupt resource error %d\n",
4956 pci_name(pdev), rc);
4957 goto err_out_iounmap;
4958 }
4959
4960 rc = skd_start_timer(skdev);
4961 if (rc)
4962 goto err_out_timer;
4963
4964 init_waitqueue_head(&skdev->waitq);
4965
4966 skd_start_device(skdev);
4967
4968 return rc;
4969
4970err_out_timer:
4971 skd_stop_device(skdev);
4972 skd_release_irq(skdev);
4973
4974err_out_iounmap:
4975 for (i = 0; i < SKD_MAX_BARS; i++)
4976 if (skdev->mem_map[i])
4977 iounmap(skdev->mem_map[i]);
4978
4979 if (skdev->pcie_error_reporting_is_enabled)
4980 pci_disable_pcie_error_reporting(pdev);
4981
4982err_out_regions:
4983 pci_release_regions(pdev);
4984
4985err_out:
4986 pci_disable_device(pdev);
4987 return rc;
4988}
4989
4990static void skd_pci_shutdown(struct pci_dev *pdev)
4991{
4992 struct skd_device *skdev;
4993
4994 pr_err("skd_pci_shutdown called\n");
4995
4996 skdev = pci_get_drvdata(pdev);
4997 if (!skdev) {
4998 pr_err("%s: no device data for PCI\n", pci_name(pdev));
4999 return;
5000 }
5001
5002 pr_err("%s: calling stop\n", skd_name(skdev));
5003 skd_stop_device(skdev);
5004}
5005
5006static struct pci_driver skd_driver = {
5007 .name = DRV_NAME,
5008 .id_table = skd_pci_tbl,
5009 .probe = skd_pci_probe,
5010 .remove = skd_pci_remove,
5011 .suspend = skd_pci_suspend,
5012 .resume = skd_pci_resume,
5013 .shutdown = skd_pci_shutdown,
5014};
5015
5016/*
5017 *****************************************************************************
5018 * LOGGING SUPPORT
5019 *****************************************************************************
5020 */
5021
5022static const char *skd_name(struct skd_device *skdev)
5023{
5024 memset(skdev->id_str, 0, sizeof(skdev->id_str));
5025
5026 if (skdev->inquiry_is_valid)
5027 snprintf(skdev->id_str, sizeof(skdev->id_str), "%s:%s:[%s]",
5028 skdev->name, skdev->inq_serial_num,
5029 pci_name(skdev->pdev));
5030 else
5031 snprintf(skdev->id_str, sizeof(skdev->id_str), "%s:??:[%s]",
5032 skdev->name, pci_name(skdev->pdev));
5033
5034 return skdev->id_str;
5035}
5036
5037const char *skd_drive_state_to_str(int state)
5038{
5039 switch (state) {
5040 case FIT_SR_DRIVE_OFFLINE:
5041 return "OFFLINE";
5042 case FIT_SR_DRIVE_INIT:
5043 return "INIT";
5044 case FIT_SR_DRIVE_ONLINE:
5045 return "ONLINE";
5046 case FIT_SR_DRIVE_BUSY:
5047 return "BUSY";
5048 case FIT_SR_DRIVE_FAULT:
5049 return "FAULT";
5050 case FIT_SR_DRIVE_DEGRADED:
5051 return "DEGRADED";
5052 case FIT_SR_PCIE_LINK_DOWN:
5053 return "INK_DOWN";
5054 case FIT_SR_DRIVE_SOFT_RESET:
5055 return "SOFT_RESET";
5056 case FIT_SR_DRIVE_NEED_FW_DOWNLOAD:
5057 return "NEED_FW";
5058 case FIT_SR_DRIVE_INIT_FAULT:
5059 return "INIT_FAULT";
5060 case FIT_SR_DRIVE_BUSY_SANITIZE:
5061 return "BUSY_SANITIZE";
5062 case FIT_SR_DRIVE_BUSY_ERASE:
5063 return "BUSY_ERASE";
5064 case FIT_SR_DRIVE_FW_BOOTING:
5065 return "FW_BOOTING";
5066 default:
5067 return "???";
5068 }
5069}
5070
5071const char *skd_skdev_state_to_str(enum skd_drvr_state state)
5072{
5073 switch (state) {
5074 case SKD_DRVR_STATE_LOAD:
5075 return "LOAD";
5076 case SKD_DRVR_STATE_IDLE:
5077 return "IDLE";
5078 case SKD_DRVR_STATE_BUSY:
5079 return "BUSY";
5080 case SKD_DRVR_STATE_STARTING:
5081 return "STARTING";
5082 case SKD_DRVR_STATE_ONLINE:
5083 return "ONLINE";
5084 case SKD_DRVR_STATE_PAUSING:
5085 return "PAUSING";
5086 case SKD_DRVR_STATE_PAUSED:
5087 return "PAUSED";
5088 case SKD_DRVR_STATE_DRAINING_TIMEOUT:
5089 return "DRAINING_TIMEOUT";
5090 case SKD_DRVR_STATE_RESTARTING:
5091 return "RESTARTING";
5092 case SKD_DRVR_STATE_RESUMING:
5093 return "RESUMING";
5094 case SKD_DRVR_STATE_STOPPING:
5095 return "STOPPING";
5096 case SKD_DRVR_STATE_SYNCING:
5097 return "SYNCING";
5098 case SKD_DRVR_STATE_FAULT:
5099 return "FAULT";
5100 case SKD_DRVR_STATE_DISAPPEARED:
5101 return "DISAPPEARED";
5102 case SKD_DRVR_STATE_BUSY_ERASE:
5103 return "BUSY_ERASE";
5104 case SKD_DRVR_STATE_BUSY_SANITIZE:
5105 return "BUSY_SANITIZE";
5106 case SKD_DRVR_STATE_BUSY_IMMINENT:
5107 return "BUSY_IMMINENT";
5108 case SKD_DRVR_STATE_WAIT_BOOT:
5109 return "WAIT_BOOT";
5110
5111 default:
5112 return "???";
5113 }
5114}
5115
a26ba7fa 5116static const char *skd_skmsg_state_to_str(enum skd_fit_msg_state state)
e67f86b3
AB
5117{
5118 switch (state) {
5119 case SKD_MSG_STATE_IDLE:
5120 return "IDLE";
5121 case SKD_MSG_STATE_BUSY:
5122 return "BUSY";
5123 default:
5124 return "???";
5125 }
5126}
5127
a26ba7fa 5128static const char *skd_skreq_state_to_str(enum skd_req_state state)
e67f86b3
AB
5129{
5130 switch (state) {
5131 case SKD_REQ_STATE_IDLE:
5132 return "IDLE";
5133 case SKD_REQ_STATE_SETUP:
5134 return "SETUP";
5135 case SKD_REQ_STATE_BUSY:
5136 return "BUSY";
5137 case SKD_REQ_STATE_COMPLETED:
5138 return "COMPLETED";
5139 case SKD_REQ_STATE_TIMEOUT:
5140 return "TIMEOUT";
5141 case SKD_REQ_STATE_ABORTED:
5142 return "ABORTED";
5143 default:
5144 return "???";
5145 }
5146}
5147
5148static void skd_log_skdev(struct skd_device *skdev, const char *event)
5149{
2e44b427 5150 pr_debug("%s:%s:%d (%s) skdev=%p event='%s'\n",
5151 skdev->name, __func__, __LINE__, skdev->name, skdev, event);
5152 pr_debug("%s:%s:%d drive_state=%s(%d) driver_state=%s(%d)\n",
5153 skdev->name, __func__, __LINE__,
5154 skd_drive_state_to_str(skdev->drive_state), skdev->drive_state,
5155 skd_skdev_state_to_str(skdev->state), skdev->state);
5156 pr_debug("%s:%s:%d busy=%d limit=%d dev=%d lowat=%d\n",
5157 skdev->name, __func__, __LINE__,
5158 skdev->in_flight, skdev->cur_max_queue_depth,
5159 skdev->dev_max_queue_depth, skdev->queue_low_water_mark);
5160 pr_debug("%s:%s:%d timestamp=0x%x cycle=%d cycle_ix=%d\n",
5161 skdev->name, __func__, __LINE__,
5162 skdev->timeout_stamp, skdev->skcomp_cycle, skdev->skcomp_ix);
e67f86b3
AB
5163}
5164
5165static void skd_log_skmsg(struct skd_device *skdev,
5166 struct skd_fitmsg_context *skmsg, const char *event)
5167{
2e44b427 5168 pr_debug("%s:%s:%d (%s) skmsg=%p event='%s'\n",
5169 skdev->name, __func__, __LINE__, skdev->name, skmsg, event);
5170 pr_debug("%s:%s:%d state=%s(%d) id=0x%04x length=%d\n",
5171 skdev->name, __func__, __LINE__,
5172 skd_skmsg_state_to_str(skmsg->state), skmsg->state,
5173 skmsg->id, skmsg->length);
e67f86b3
AB
5174}
5175
5176static void skd_log_skreq(struct skd_device *skdev,
5177 struct skd_request_context *skreq, const char *event)
5178{
2e44b427 5179 pr_debug("%s:%s:%d (%s) skreq=%p event='%s'\n",
5180 skdev->name, __func__, __LINE__, skdev->name, skreq, event);
5181 pr_debug("%s:%s:%d state=%s(%d) id=0x%04x fitmsg=0x%04x\n",
5182 skdev->name, __func__, __LINE__,
5183 skd_skreq_state_to_str(skreq->state), skreq->state,
5184 skreq->id, skreq->fitmsg_id);
5185 pr_debug("%s:%s:%d timo=0x%x sg_dir=%d n_sg=%d\n",
5186 skdev->name, __func__, __LINE__,
5187 skreq->timeout_stamp, skreq->sg_data_dir, skreq->n_sg);
e67f86b3 5188
fcd37eb3
JA
5189 if (skreq->req != NULL) {
5190 struct request *req = skreq->req;
5191 u32 lba = (u32)blk_rq_pos(req);
5192 u32 count = blk_rq_sectors(req);
e67f86b3 5193
fcd37eb3
JA
5194 pr_debug("%s:%s:%d "
5195 "req=%p lba=%u(0x%x) count=%u(0x%x) dir=%d\n",
5196 skdev->name, __func__, __LINE__,
5197 req, lba, lba, count, count,
5198 (int)rq_data_dir(req));
5199 } else
5200 pr_debug("%s:%s:%d req=NULL\n",
5201 skdev->name, __func__, __LINE__);
e67f86b3
AB
5202}
5203
5204/*
5205 *****************************************************************************
5206 * MODULE GLUE
5207 *****************************************************************************
5208 */
5209
5210static int __init skd_init(void)
5211{
e67f86b3
AB
5212 pr_info(PFX " v%s-b%s loaded\n", DRV_VERSION, DRV_BUILD_ID);
5213
5214 switch (skd_isr_type) {
5215 case SKD_IRQ_LEGACY:
5216 case SKD_IRQ_MSI:
5217 case SKD_IRQ_MSIX:
5218 break;
5219 default:
fbed149a 5220 pr_err(PFX "skd_isr_type %d invalid, re-set to %d\n",
e67f86b3
AB
5221 skd_isr_type, SKD_IRQ_DEFAULT);
5222 skd_isr_type = SKD_IRQ_DEFAULT;
5223 }
5224
fbed149a
BZ
5225 if (skd_max_queue_depth < 1 ||
5226 skd_max_queue_depth > SKD_MAX_QUEUE_DEPTH) {
5227 pr_err(PFX "skd_max_queue_depth %d invalid, re-set to %d\n",
e67f86b3
AB
5228 skd_max_queue_depth, SKD_MAX_QUEUE_DEPTH_DEFAULT);
5229 skd_max_queue_depth = SKD_MAX_QUEUE_DEPTH_DEFAULT;
5230 }
5231
5232 if (skd_max_req_per_msg < 1 || skd_max_req_per_msg > 14) {
fbed149a 5233 pr_err(PFX "skd_max_req_per_msg %d invalid, re-set to %d\n",
e67f86b3
AB
5234 skd_max_req_per_msg, SKD_MAX_REQ_PER_MSG_DEFAULT);
5235 skd_max_req_per_msg = SKD_MAX_REQ_PER_MSG_DEFAULT;
5236 }
5237
5238 if (skd_sgs_per_request < 1 || skd_sgs_per_request > 4096) {
fbed149a 5239 pr_err(PFX "skd_sg_per_request %d invalid, re-set to %d\n",
e67f86b3
AB
5240 skd_sgs_per_request, SKD_N_SG_PER_REQ_DEFAULT);
5241 skd_sgs_per_request = SKD_N_SG_PER_REQ_DEFAULT;
5242 }
5243
5244 if (skd_dbg_level < 0 || skd_dbg_level > 2) {
fbed149a 5245 pr_err(PFX "skd_dbg_level %d invalid, re-set to %d\n",
e67f86b3
AB
5246 skd_dbg_level, 0);
5247 skd_dbg_level = 0;
5248 }
5249
5250 if (skd_isr_comp_limit < 0) {
fbed149a 5251 pr_err(PFX "skd_isr_comp_limit %d invalid, set to %d\n",
e67f86b3
AB
5252 skd_isr_comp_limit, 0);
5253 skd_isr_comp_limit = 0;
5254 }
5255
5256 if (skd_max_pass_thru < 1 || skd_max_pass_thru > 50) {
fbed149a 5257 pr_err(PFX "skd_max_pass_thru %d invalid, re-set to %d\n",
e67f86b3
AB
5258 skd_max_pass_thru, SKD_N_SPECIAL_CONTEXT);
5259 skd_max_pass_thru = SKD_N_SPECIAL_CONTEXT;
5260 }
5261
b8df6647 5262 return pci_register_driver(&skd_driver);
e67f86b3
AB
5263}
5264
5265static void __exit skd_exit(void)
5266{
5267 pr_info(PFX " v%s-b%s unloading\n", DRV_VERSION, DRV_BUILD_ID);
5268
e67f86b3 5269 pci_unregister_driver(&skd_driver);
b8df6647
BZ
5270
5271 if (skd_major)
5272 unregister_blkdev(skd_major, DRV_NAME);
e67f86b3
AB
5273}
5274
e67f86b3
AB
5275module_init(skd_init);
5276module_exit(skd_exit);