2 * CXL Flash Device Driver
4 * Written by: Manoj N. Kumar <manoj@linux.vnet.ibm.com>, IBM Corporation
5 * Matthew R. Ochs <mrochs@linux.vnet.ibm.com>, IBM Corporation
7 * Copyright (C) 2015 IBM Corporation
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
15 #ifndef _CXLFLASH_COMMON_H
16 #define _CXLFLASH_COMMON_H
18 #include <linux/async.h>
19 #include <linux/irq_poll.h>
20 #include <linux/list.h>
21 #include <linux/rwsem.h>
22 #include <linux/types.h>
23 #include <scsi/scsi.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_device.h>
27 extern const struct file_operations cxlflash_cxl_fops
;
29 #define MAX_CONTEXT CXLFLASH_MAX_CONTEXT /* num contexts per afu */
30 #define MAX_FC_PORTS CXLFLASH_MAX_FC_PORTS /* max ports per AFU */
31 #define LEGACY_FC_PORTS 2 /* legacy ports per AFU */
33 #define CHAN2PORTBANK(_x) ((_x) >> ilog2(CXLFLASH_NUM_FC_PORTS_PER_BANK))
34 #define CHAN2BANKPORT(_x) ((_x) & (CXLFLASH_NUM_FC_PORTS_PER_BANK - 1))
36 #define CHAN2PORTMASK(_x) (1 << (_x)) /* channel to port mask */
37 #define PORTMASK2CHAN(_x) (ilog2((_x))) /* port mask to channel */
38 #define PORTNUM2CHAN(_x) ((_x) - 1) /* port number to channel */
40 #define CXLFLASH_BLOCK_SIZE 4096 /* 4K blocks */
41 #define CXLFLASH_MAX_XFER_SIZE 16777216 /* 16MB transfer */
42 #define CXLFLASH_MAX_SECTORS (CXLFLASH_MAX_XFER_SIZE/512) /* SCSI wants
49 #define MAX_RHT_PER_CONTEXT (PAGE_SIZE / sizeof(struct sisl_rht_entry))
51 /* AFU command retry limit */
52 #define MC_RETRY_CNT 5 /* Sufficient for SCSI and certain AFU errors */
54 /* Command management definitions */
55 #define CXLFLASH_MAX_CMDS 256
56 #define CXLFLASH_MAX_CMDS_PER_LUN CXLFLASH_MAX_CMDS
58 /* RRQ for master issued cmds */
59 #define NUM_RRQ_ENTRY CXLFLASH_MAX_CMDS
61 /* SQ for master issued cmds */
62 #define NUM_SQ_ENTRY CXLFLASH_MAX_CMDS
64 /* Hardware queue definitions */
65 #define CXLFLASH_DEF_HWQS 1
66 #define CXLFLASH_MAX_HWQS 8
70 static inline void check_sizes(void)
72 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_NUM_FC_PORTS_PER_BANK
);
73 BUILD_BUG_ON_NOT_POWER_OF_2(CXLFLASH_MAX_CMDS
);
76 /* AFU defines a fixed size of 4K for command buffers (borrow 4K page define) */
77 #define CMD_BUFSIZE SIZE_4K
79 enum cxlflash_lr_state
{
85 enum cxlflash_init_state
{
93 STATE_PROBING
, /* Initial state during probe */
94 STATE_PROBED
, /* Temporary state, probe completed but EEH occurred */
95 STATE_NORMAL
, /* Normal running state, everything good */
96 STATE_RESET
, /* Reset state, trying to reset/recover */
97 STATE_FAILTERM
/* Failed/terminating state, error out users/threads */
100 enum cxlflash_hwq_mode
{
101 HWQ_MODE_RR
, /* Roundrobin (default) */
102 HWQ_MODE_TAG
, /* Distribute based on block MQ tag */
103 HWQ_MODE_CPU
, /* CPU affinity */
108 * Each context has its own set of resource handles that is visible
109 * only from that context.
112 struct cxlflash_cfg
{
116 struct pci_device_id
*dev_id
;
117 struct Scsi_Host
*host
;
120 ulong cxlflash_regs_pci
;
122 struct work_struct work_q
;
123 enum cxlflash_init_state init_state
;
124 enum cxlflash_lr_state lr_state
;
126 atomic_t scan_host_needed
;
128 struct cxl_afu
*cxl_afu
;
130 atomic_t recovery_threads
;
131 struct mutex ctx_recovery_mutex
;
132 struct mutex ctx_tbl_list_mutex
;
133 struct rw_semaphore ioctl_rwsem
;
134 struct ctx_info
*ctx_tbl
[MAX_CONTEXT
];
135 struct list_head ctx_err_recovery
; /* contexts w/ recovery pending */
136 struct file_operations cxl_fops
;
138 /* Parameters that are LUN table related */
139 int last_lun_index
[MAX_FC_PORTS
];
140 int promote_lun_index
;
141 struct list_head lluns
; /* list of llun_info structs */
143 wait_queue_head_t tmf_waitq
;
144 spinlock_t tmf_slock
;
146 wait_queue_head_t reset_waitq
;
147 enum cxlflash_state state
;
148 async_cookie_t async_reset_cookie
;
152 struct sisl_ioarcb rcb
; /* IOARCB (cache line aligned) */
153 struct sisl_ioasa sa
; /* IOASA must follow IOARCB */
155 struct scsi_cmnd
*scp
;
156 struct completion cevent
;
157 struct list_head queue
;
163 struct list_head list
; /* Pending commands link */
165 /* As per the SISLITE spec the IOARCB EA has to be 16-byte aligned.
166 * However for performance reasons the IOARCB/IOASA should be
167 * cache line aligned.
169 } __aligned(cache_line_size());
171 static inline struct afu_cmd
*sc_to_afuc(struct scsi_cmnd
*sc
)
173 return PTR_ALIGN(scsi_cmd_priv(sc
), __alignof__(struct afu_cmd
));
176 static inline struct afu_cmd
*sc_to_afucz(struct scsi_cmnd
*sc
)
178 struct afu_cmd
*afuc
= sc_to_afuc(sc
);
180 memset(afuc
, 0, sizeof(*afuc
));
181 INIT_LIST_HEAD(&afuc
->queue
);
186 /* Stuff requiring alignment go first. */
187 struct sisl_ioarcb sq
[NUM_SQ_ENTRY
]; /* 16K SQ */
188 u64 rrq_entry
[NUM_RRQ_ENTRY
]; /* 2K RRQ */
190 /* Beware of alignment till here. Preferably introduce new
191 * fields after this point
194 struct cxl_context
*ctx
;
195 struct cxl_ioctl_start_work work
;
196 struct sisl_host_map __iomem
*host_map
; /* MC host map */
197 struct sisl_ctrl_map __iomem
*ctrl_map
; /* MC control map */
198 ctx_hndl_t ctx_hndl
; /* master's context handle */
199 u32 index
; /* Index of this hwq */
200 struct list_head pending_cmds
; /* Commands pending completion */
202 atomic_t hsq_credits
;
203 spinlock_t hsq_slock
; /* Hardware send queue lock */
204 struct sisl_ioarcb
*hsq_start
;
205 struct sisl_ioarcb
*hsq_end
;
206 struct sisl_ioarcb
*hsq_curr
;
207 spinlock_t hrrq_slock
;
215 struct irq_poll irqpoll
;
216 } __aligned(cache_line_size());
219 struct hwq hwqs
[CXLFLASH_MAX_HWQS
];
220 int (*send_cmd
)(struct afu
*, struct afu_cmd
*);
221 int (*context_reset
)(struct hwq
*);
224 struct cxlflash_afu_map __iomem
*afu_map
; /* entire MMIO map */
226 atomic_t cmds_active
; /* Number of currently active AFU commands */
228 u32 internal_lun
; /* User-desired LUN mode for this AFU */
230 u32 num_hwqs
; /* Number of hardware queues */
231 u32 desired_hwqs
; /* Desired h/w queues, effective on AFU reset */
232 enum cxlflash_hwq_mode hwq_mode
; /* Steering mode for h/w queues */
233 u32 hwq_rr_count
; /* Count to distribute traffic for roundrobin */
236 u64 interface_version
;
239 struct cxlflash_cfg
*parent
; /* Pointer back to parent cxlflash_cfg */
242 static inline struct hwq
*get_hwq(struct afu
*afu
, u32 index
)
244 WARN_ON(index
>= CXLFLASH_MAX_HWQS
);
246 return &afu
->hwqs
[index
];
249 static inline bool afu_is_irqpoll_enabled(struct afu
*afu
)
251 return !!afu
->irqpoll_weight
;
254 static inline bool afu_is_cmd_mode(struct afu
*afu
, u64 cmd_mode
)
256 u64 afu_cap
= afu
->interface_version
>> SISL_INTVER_CAP_SHIFT
;
258 return afu_cap
& cmd_mode
;
261 static inline bool afu_is_sq_cmd_mode(struct afu
*afu
)
263 return afu_is_cmd_mode(afu
, SISL_INTVER_CAP_SQ_CMD_MODE
);
266 static inline bool afu_is_ioarrin_cmd_mode(struct afu
*afu
)
268 return afu_is_cmd_mode(afu
, SISL_INTVER_CAP_IOARRIN_CMD_MODE
);
271 static inline u64
lun_to_lunid(u64 lun
)
275 int_to_scsilun(lun
, (struct scsi_lun
*)&lun_id
);
276 return be64_to_cpu(lun_id
);
279 static inline struct fc_port_bank __iomem
*get_fc_port_bank(
280 struct cxlflash_cfg
*cfg
, int i
)
282 struct afu
*afu
= cfg
->afu
;
284 return &afu
->afu_map
->global
.bank
[CHAN2PORTBANK(i
)];
287 static inline __be64 __iomem
*get_fc_port_regs(struct cxlflash_cfg
*cfg
, int i
)
289 struct fc_port_bank __iomem
*fcpb
= get_fc_port_bank(cfg
, i
);
291 return &fcpb
->fc_port_regs
[CHAN2BANKPORT(i
)][0];
294 static inline __be64 __iomem
*get_fc_port_luns(struct cxlflash_cfg
*cfg
, int i
)
296 struct fc_port_bank __iomem
*fcpb
= get_fc_port_bank(cfg
, i
);
298 return &fcpb
->fc_port_luns
[CHAN2BANKPORT(i
)][0];
301 int cxlflash_afu_sync(struct afu
*afu
, ctx_hndl_t c
, res_hndl_t r
, u8 mode
);
302 void cxlflash_list_init(void);
303 void cxlflash_term_global_luns(void);
304 void cxlflash_free_errpage(void);
305 int cxlflash_ioctl(struct scsi_device
*sdev
, int cmd
, void __user
*arg
);
306 void cxlflash_stop_term_user_contexts(struct cxlflash_cfg
*cfg
);
307 int cxlflash_mark_contexts_error(struct cxlflash_cfg
*cfg
);
308 void cxlflash_term_local_luns(struct cxlflash_cfg
*cfg
);
309 void cxlflash_restore_luntable(struct cxlflash_cfg
*cfg
);
311 #endif /* ifndef _CXLFLASH_COMMON_H */