?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Merge tag 'block-5.11-2021-01-10' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / drivers / scsi / esp_scsi.h
blob446a3d18c02246c4a14a726f6e31dc7805ca8a76
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* esp_scsi.h: Defines and structures for the ESP driver.
3 *
4 * Copyright (C) 2007 David S. Miller (davem@davemloft.net)
5 */
6
7 #ifndef _ESP_SCSI_H
8 #define _ESP_SCSI_H
9
10 /* Access Description Offset */
11 #define ESP_TCLOW 0x00UL /* rw Low bits transfer count 0x00 */
12 #define ESP_TCMED 0x01UL /* rw Mid bits transfer count 0x04 */
13 #define ESP_FDATA 0x02UL /* rw FIFO data bits 0x08 */
14 #define ESP_CMD 0x03UL /* rw SCSI command bits 0x0c */
15 #define ESP_STATUS 0x04UL /* ro ESP status register 0x10 */
16 #define ESP_BUSID ESP_STATUS /* wo BusID for sel/resel 0x10 */
17 #define ESP_INTRPT 0x05UL /* ro Kind of interrupt 0x14 */
18 #define ESP_TIMEO ESP_INTRPT /* wo Timeout for sel/resel 0x14 */
19 #define ESP_SSTEP 0x06UL /* ro Sequence step register 0x18 */
20 #define ESP_STP ESP_SSTEP /* wo Transfer period/sync 0x18 */
21 #define ESP_FFLAGS 0x07UL /* ro Bits current FIFO info 0x1c */
22 #define ESP_SOFF ESP_FFLAGS /* wo Sync offset 0x1c */
23 #define ESP_CFG1 0x08UL /* rw First cfg register 0x20 */
24 #define ESP_CFACT 0x09UL /* wo Clock conv factor 0x24 */
25 #define ESP_STATUS2 ESP_CFACT /* ro HME status2 register 0x24 */
26 #define ESP_CTEST 0x0aUL /* wo Chip test register 0x28 */
27 #define ESP_CFG2 0x0bUL /* rw Second cfg register 0x2c */
28 #define ESP_CFG3 0x0cUL /* rw Third cfg register 0x30 */
29 #define ESP_CFG4 0x0dUL /* rw Fourth cfg register 0x34 */
30 #define ESP_TCHI 0x0eUL /* rw High bits transf count 0x38 */
31 #define ESP_UID ESP_TCHI /* ro Unique ID code 0x38 */
32 #define FAS_RLO ESP_TCHI /* rw HME extended counter 0x38 */
33 #define ESP_FGRND 0x0fUL /* rw Data base for fifo 0x3c */
34 #define FAS_RHI ESP_FGRND /* rw HME extended counter 0x3c */
35
36 #define SBUS_ESP_REG_SIZE 0x40UL
37
38 /* Bitfield meanings for the above registers. */
39
40 /* ESP config reg 1, read-write, found on all ESP chips */
41 #define ESP_CONFIG1_ID 0x07 /* My BUS ID bits */
42 #define ESP_CONFIG1_CHTEST 0x08 /* Enable ESP chip tests */
43 #define ESP_CONFIG1_PENABLE 0x10 /* Enable parity checks */
44 #define ESP_CONFIG1_PARTEST 0x20 /* Parity test mode enabled? */
45 #define ESP_CONFIG1_SRRDISAB 0x40 /* Disable SCSI reset reports */
46 #define ESP_CONFIG1_SLCABLE 0x80 /* Enable slow cable mode */
47
48 /* ESP config reg 2, read-write, found only on esp100a+esp200+esp236 chips */
49 #define ESP_CONFIG2_DMAPARITY 0x01 /* enable DMA Parity (200,236) */
50 #define ESP_CONFIG2_REGPARITY 0x02 /* enable reg Parity (200,236) */
51 #define ESP_CONFIG2_BADPARITY 0x04 /* Bad parity target abort */
52 #define ESP_CONFIG2_SCSI2ENAB 0x08 /* Enable SCSI-2 features (tgtmode) */
53 #define ESP_CONFIG2_HI 0x10 /* High Impedance DREQ ??? */
54 #define ESP_CONFIG2_HMEFENAB 0x10 /* HME features enable */
55 #define ESP_CONFIG2_BCM 0x20 /* Enable byte-ctrl (236) */
56 #define ESP_CONFIG2_DISPINT 0x20 /* Disable pause irq (hme) */
57 #define ESP_CONFIG2_FENAB 0x40 /* Enable features (fas100,216) */
58 #define ESP_CONFIG2_SPL 0x40 /* Enable status-phase latch (236) */
59 #define ESP_CONFIG2_MKDONE 0x40 /* HME magic feature */
60 #define ESP_CONFIG2_HME32 0x80 /* HME 32 extended */
61 #define ESP_CONFIG2_MAGIC 0xe0 /* Invalid bits... */
62
63 /* ESP config register 3 read-write, found only esp236+fas236+fas100a+hme chips */
64 #define ESP_CONFIG3_FCLOCK 0x01 /* FAST SCSI clock rate (esp100a/hme) */
65 #define ESP_CONFIG3_TEM 0x01 /* Enable thresh-8 mode (esp/fas236) */
66 #define ESP_CONFIG3_FAST 0x02 /* Enable FAST SCSI (esp100a/hme) */
67 #define ESP_CONFIG3_ADMA 0x02 /* Enable alternate-dma (esp/fas236) */
68 #define ESP_CONFIG3_TENB 0x04 /* group2 SCSI2 support (esp100a/hme) */
69 #define ESP_CONFIG3_SRB 0x04 /* Save residual byte (esp/fas236) */
70 #define ESP_CONFIG3_TMS 0x08 /* Three-byte msg's ok (esp100a/hme) */
71 #define ESP_CONFIG3_FCLK 0x08 /* Fast SCSI clock rate (esp/fas236) */
72 #define ESP_CONFIG3_IDMSG 0x10 /* ID message checking (esp100a/hme) */
73 #define ESP_CONFIG3_FSCSI 0x10 /* Enable FAST SCSI (esp/fas236) */
74 #define ESP_CONFIG3_GTM 0x20 /* group2 SCSI2 support (esp/fas236) */
75 #define ESP_CONFIG3_IDBIT3 0x20 /* Bit 3 of HME SCSI-ID (hme) */
76 #define ESP_CONFIG3_TBMS 0x40 /* Three-byte msg's ok (esp/fas236) */
77 #define ESP_CONFIG3_EWIDE 0x40 /* Enable Wide-SCSI (hme) */
78 #define ESP_CONFIG3_IMS 0x80 /* ID msg chk'ng (esp/fas236) */
79 #define ESP_CONFIG3_OBPUSH 0x80 /* Push odd-byte to dma (hme) */
80
81 /* ESP config register 4 read-write */
82 #define ESP_CONFIG4_BBTE 0x01 /* Back-to-back transfers (fsc) */
83 #define ESP_CONGIG4_TEST 0x02 /* Transfer counter test mode (fsc) */
84 #define ESP_CONFIG4_RADE 0x04 /* Active negation (am53c974/fsc) */
85 #define ESP_CONFIG4_RAE 0x08 /* Act. negation REQ/ACK (am53c974) */
86 #define ESP_CONFIG4_PWD 0x20 /* Reduced power feature (am53c974) */
87 #define ESP_CONFIG4_GE0 0x40 /* Glitch eater bit 0 (am53c974) */
88 #define ESP_CONFIG4_GE1 0x80 /* Glitch eater bit 1 (am53c974) */
89
90 #define ESP_CONFIG_GE_12NS (0)
91 #define ESP_CONFIG_GE_25NS (ESP_CONFIG_GE1)
92 #define ESP_CONFIG_GE_35NS (ESP_CONFIG_GE0)
93 #define ESP_CONFIG_GE_0NS (ESP_CONFIG_GE0 | ESP_CONFIG_GE1)
94
95 /* ESP command register read-write */
96 /* Group 1 commands: These may be sent at any point in time to the ESP
97 * chip. None of them can generate interrupts 'cept
98 * the "SCSI bus reset" command if you have not disabled
99 * SCSI reset interrupts in the config1 ESP register.
100 */
101 #define ESP_CMD_NULL 0x00 /* Null command, ie. a nop */
102 #define ESP_CMD_FLUSH 0x01 /* FIFO Flush */
103 #define ESP_CMD_RC 0x02 /* Chip reset */
104 #define ESP_CMD_RS 0x03 /* SCSI bus reset */
105
106 /* Group 2 commands: ESP must be an initiator and connected to a target
107 * for these commands to work.
108 */
109 #define ESP_CMD_TI 0x10 /* Transfer Information */
110 #define ESP_CMD_ICCSEQ 0x11 /* Initiator cmd complete sequence */
111 #define ESP_CMD_MOK 0x12 /* Message okie-dokie */
112 #define ESP_CMD_TPAD 0x18 /* Transfer Pad */
113 #define ESP_CMD_SATN 0x1a /* Set ATN */
114 #define ESP_CMD_RATN 0x1b /* De-assert ATN */
115
116 /* Group 3 commands: ESP must be in the MSGOUT or MSGIN state and be connected
117 * to a target as the initiator for these commands to work.
118 */
119 #define ESP_CMD_SMSG 0x20 /* Send message */
120 #define ESP_CMD_SSTAT 0x21 /* Send status */
121 #define ESP_CMD_SDATA 0x22 /* Send data */
122 #define ESP_CMD_DSEQ 0x23 /* Discontinue Sequence */
123 #define ESP_CMD_TSEQ 0x24 /* Terminate Sequence */
124 #define ESP_CMD_TCCSEQ 0x25 /* Target cmd cmplt sequence */
125 #define ESP_CMD_DCNCT 0x27 /* Disconnect */
126 #define ESP_CMD_RMSG 0x28 /* Receive Message */
127 #define ESP_CMD_RCMD 0x29 /* Receive Command */
128 #define ESP_CMD_RDATA 0x2a /* Receive Data */
129 #define ESP_CMD_RCSEQ 0x2b /* Receive cmd sequence */
130
131 /* Group 4 commands: The ESP must be in the disconnected state and must
132 * not be connected to any targets as initiator for
133 * these commands to work.
134 */
135 #define ESP_CMD_RSEL 0x40 /* Reselect */
136 #define ESP_CMD_SEL 0x41 /* Select w/o ATN */
137 #define ESP_CMD_SELA 0x42 /* Select w/ATN */
138 #define ESP_CMD_SELAS 0x43 /* Select w/ATN & STOP */
139 #define ESP_CMD_ESEL 0x44 /* Enable selection */
140 #define ESP_CMD_DSEL 0x45 /* Disable selections */
141 #define ESP_CMD_SA3 0x46 /* Select w/ATN3 */
142 #define ESP_CMD_RSEL3 0x47 /* Reselect3 */
143
144 /* This bit enables the ESP's DMA on the SBus */
145 #define ESP_CMD_DMA 0x80 /* Do DMA? */
146
147 /* ESP status register read-only */
148 #define ESP_STAT_PIO 0x01 /* IO phase bit */
149 #define ESP_STAT_PCD 0x02 /* CD phase bit */
150 #define ESP_STAT_PMSG 0x04 /* MSG phase bit */
151 #define ESP_STAT_PMASK 0x07 /* Mask of phase bits */
152 #define ESP_STAT_TDONE 0x08 /* Transfer Completed */
153 #define ESP_STAT_TCNT 0x10 /* Transfer Counter Is Zero */
154 #define ESP_STAT_PERR 0x20 /* Parity error */
155 #define ESP_STAT_SPAM 0x40 /* Real bad error */
156 /* This indicates the 'interrupt pending' condition on esp236, it is a reserved
157 * bit on other revs of the ESP.
158 */
159 #define ESP_STAT_INTR 0x80 /* Interrupt */
160
161 /* The status register can be masked with ESP_STAT_PMASK and compared
162 * with the following values to determine the current phase the ESP
163 * (at least thinks it) is in. For our purposes we also add our own
164 * software 'done' bit for our phase management engine.
165 */
166 #define ESP_DOP (0) /* Data Out */
167 #define ESP_DIP (ESP_STAT_PIO) /* Data In */
168 #define ESP_CMDP (ESP_STAT_PCD) /* Command */
169 #define ESP_STATP (ESP_STAT_PCD|ESP_STAT_PIO) /* Status */
170 #define ESP_MOP (ESP_STAT_PMSG|ESP_STAT_PCD) /* Message Out */
171 #define ESP_MIP (ESP_STAT_PMSG|ESP_STAT_PCD|ESP_STAT_PIO) /* Message In */
172
173 /* HME only: status 2 register */
174 #define ESP_STAT2_SCHBIT 0x01 /* Upper bits 3-7 of sstep enabled */
175 #define ESP_STAT2_FFLAGS 0x02 /* The fifo flags are now latched */
176 #define ESP_STAT2_XCNT 0x04 /* The transfer counter is latched */
177 #define ESP_STAT2_CREGA 0x08 /* The command reg is active now */
178 #define ESP_STAT2_WIDE 0x10 /* Interface on this adapter is wide */
179 #define ESP_STAT2_F1BYTE 0x20 /* There is one byte at top of fifo */
180 #define ESP_STAT2_FMSB 0x40 /* Next byte in fifo is most significant */
181 #define ESP_STAT2_FEMPTY 0x80 /* FIFO is empty */
182
183 /* ESP interrupt register read-only */
184 #define ESP_INTR_S 0x01 /* Select w/o ATN */
185 #define ESP_INTR_SATN 0x02 /* Select w/ATN */
186 #define ESP_INTR_RSEL 0x04 /* Reselected */
187 #define ESP_INTR_FDONE 0x08 /* Function done */
188 #define ESP_INTR_BSERV 0x10 /* Bus service */
189 #define ESP_INTR_DC 0x20 /* Disconnect */
190 #define ESP_INTR_IC 0x40 /* Illegal command given */
191 #define ESP_INTR_SR 0x80 /* SCSI bus reset detected */
192
193 /* ESP sequence step register read-only */
194 #define ESP_STEP_VBITS 0x07 /* Valid bits */
195 #define ESP_STEP_ASEL 0x00 /* Selection&Arbitrate cmplt */
196 #define ESP_STEP_SID 0x01 /* One msg byte sent */
197 #define ESP_STEP_NCMD 0x02 /* Was not in command phase */
198 #define ESP_STEP_PPC 0x03 /* Early phase chg caused cmnd
199 * bytes to be lost
200 */
201 #define ESP_STEP_FINI4 0x04 /* Command was sent ok */
202
203 /* Ho hum, some ESP's set the step register to this as well... */
204 #define ESP_STEP_FINI5 0x05
205 #define ESP_STEP_FINI6 0x06
206 #define ESP_STEP_FINI7 0x07
207
208 /* ESP chip-test register read-write */
209 #define ESP_TEST_TARG 0x01 /* Target test mode */
210 #define ESP_TEST_INI 0x02 /* Initiator test mode */
211 #define ESP_TEST_TS 0x04 /* Tristate test mode */
212
213 /* ESP unique ID register read-only, found on fas236+fas100a only */
214 #define ESP_UID_FAM 0xf8 /* ESP family bitmask */
215
216 #define ESP_FAMILY(uid) (((uid) & ESP_UID_FAM) >> 3)
217
218 /* Values for the ESP family bits */
219 #define ESP_UID_F100A 0x00 /* ESP FAS100A */
220 #define ESP_UID_F236 0x02 /* ESP FAS236 */
221 #define ESP_UID_HME 0x0a /* FAS HME */
222 #define ESP_UID_FSC 0x14 /* NCR/Symbios Logic 53CF9x-2 */
223
224 /* ESP fifo flags register read-only */
225 /* Note that the following implies a 16 byte FIFO on the ESP. */
226 #define ESP_FF_FBYTES 0x1f /* Num bytes in FIFO */
227 #define ESP_FF_ONOTZERO 0x20 /* offset ctr not zero (esp100) */
228 #define ESP_FF_SSTEP 0xe0 /* Sequence step */
229
230 /* ESP clock conversion factor register write-only */
231 #define ESP_CCF_F0 0x00 /* 35.01MHz - 40MHz */
232 #define ESP_CCF_NEVER 0x01 /* Set it to this and die */
233 #define ESP_CCF_F2 0x02 /* 10MHz */
234 #define ESP_CCF_F3 0x03 /* 10.01MHz - 15MHz */
235 #define ESP_CCF_F4 0x04 /* 15.01MHz - 20MHz */
236 #define ESP_CCF_F5 0x05 /* 20.01MHz - 25MHz */
237 #define ESP_CCF_F6 0x06 /* 25.01MHz - 30MHz */
238 #define ESP_CCF_F7 0x07 /* 30.01MHz - 35MHz */
239
240 /* HME only... */
241 #define ESP_BUSID_RESELID 0x10
242 #define ESP_BUSID_CTR32BIT 0x40
243
244 #define ESP_BUS_TIMEOUT 250 /* In milli-seconds */
245 #define ESP_TIMEO_CONST 8192
246 #define ESP_NEG_DEFP(mhz, cfact) \
247 ((ESP_BUS_TIMEOUT * ((mhz) / 1000)) / (8192 * (cfact)))
248 #define ESP_HZ_TO_CYCLE(hertz) ((1000000000) / ((hertz) / 1000))
249 #define ESP_TICK(ccf, cycle) ((7682 * (ccf) * (cycle) / 1000))
250
251 /* For slow to medium speed input clock rates we shoot for 5mb/s, but for high
252 * input clock rates we try to do 10mb/s although I don't think a transfer can
253 * even run that fast with an ESP even with DMA2 scatter gather pipelining.
254 */
255 #define SYNC_DEFP_SLOW 0x32 /* 5mb/s */
256 #define SYNC_DEFP_FAST 0x19 /* 10mb/s */
257
258 struct esp_cmd_priv {
259 int num_sg;
260 int cur_residue;
261 struct scatterlist *prv_sg;
262 struct scatterlist *cur_sg;
263 int tot_residue;
264 };
265 #define ESP_CMD_PRIV(CMD) ((struct esp_cmd_priv *)(&(CMD)->SCp))
266
267 /* NOTE: this enum is ordered based on chip features! */
268 enum esp_rev {
269 ESP100, /* NCR53C90 - very broken */
270 ESP100A, /* NCR53C90A */
271 ESP236,
272 FAS236,
273 PCSCSI, /* AM53c974 */
274 FSC, /* NCR/Symbios Logic 53CF9x-2 */
275 FAS100A,
276 FAST,
277 FASHME,
278 };
279
280 struct esp_cmd_entry {
281 struct list_head list;
282
283 struct scsi_cmnd *cmd;
284
285 unsigned int saved_cur_residue;
286 struct scatterlist *saved_prv_sg;
287 struct scatterlist *saved_cur_sg;
288 unsigned int saved_tot_residue;
289
290 u8 flags;
291 #define ESP_CMD_FLAG_WRITE 0x01 /* DMA is a write */
292 #define ESP_CMD_FLAG_AUTOSENSE 0x04 /* Doing automatic REQUEST_SENSE */
293 #define ESP_CMD_FLAG_RESIDUAL 0x08 /* AM53c974 BLAST residual */
294
295 u8 tag[2];
296 u8 orig_tag[2];
297
298 u8 status;
299 u8 message;
300
301 unsigned char *sense_ptr;
302 unsigned char *saved_sense_ptr;
303 dma_addr_t sense_dma;
304
305 struct completion *eh_done;
306 };
307
308 #define ESP_DEFAULT_TAGS 16
309
310 #define ESP_MAX_TARGET 16
311 #define ESP_MAX_LUN 8
312 #define ESP_MAX_TAG 256
313
314 struct esp_lun_data {
315 struct esp_cmd_entry *non_tagged_cmd;
316 int num_tagged;
317 int hold;
318 struct esp_cmd_entry *tagged_cmds[ESP_MAX_TAG];
319 };
320
321 struct esp_target_data {
322 /* These are the ESP_STP, ESP_SOFF, and ESP_CFG3 register values which
323 * match the currently negotiated settings for this target. The SCSI
324 * protocol values are maintained in spi_{offset,period,wide}(starget).
325 */
326 u8 esp_period;
327 u8 esp_offset;
328 u8 esp_config3;
329
330 u8 flags;
331 #define ESP_TGT_WIDE 0x01
332 #define ESP_TGT_DISCONNECT 0x02
333 #define ESP_TGT_NEGO_WIDE 0x04
334 #define ESP_TGT_NEGO_SYNC 0x08
335 #define ESP_TGT_CHECK_NEGO 0x40
336 #define ESP_TGT_BROKEN 0x80
337
338 /* When ESP_TGT_CHECK_NEGO is set, on the next scsi command to this
339 * device we will try to negotiate the following parameters.
340 */
341 u8 nego_goal_period;
342 u8 nego_goal_offset;
343 u8 nego_goal_width;
344 u8 nego_goal_tags;
345
346 struct scsi_target *starget;
347 };
348
349 struct esp_event_ent {
350 u8 type;
351 #define ESP_EVENT_TYPE_EVENT 0x01
352 #define ESP_EVENT_TYPE_CMD 0x02
353 u8 val;
354
355 u8 sreg;
356 u8 seqreg;
357 u8 sreg2;
358 u8 ireg;
359 u8 select_state;
360 u8 event;
361 u8 __pad;
362 };
363
364 struct esp;
365 struct esp_driver_ops {
366 /* Read and write the ESP 8-bit registers. On some
367 * applications of the ESP chip the registers are at 4-byte
368 * instead of 1-byte intervals.
369 */
370 void (*esp_write8)(struct esp *esp, u8 val, unsigned long reg);
371 u8 (*esp_read8)(struct esp *esp, unsigned long reg);
372
373 /* Return non-zero if there is an IRQ pending. Usually this
374 * status bit lives in the DMA controller sitting in front of
375 * the ESP. This has to be accurate or else the ESP interrupt
376 * handler will not run.
377 */
378 int (*irq_pending)(struct esp *esp);
379
380 /* Return the maximum allowable size of a DMA transfer for a
381 * given buffer.
382 */
383 u32 (*dma_length_limit)(struct esp *esp, u32 dma_addr,
384 u32 dma_len);
385
386 /* Reset the DMA engine entirely. On return, ESP interrupts
387 * should be enabled. Often the interrupt enabling is
388 * controlled in the DMA engine.
389 */
390 void (*reset_dma)(struct esp *esp);
391
392 /* Drain any pending DMA in the DMA engine after a transfer.
393 * This is for writes to memory.
394 */
395 void (*dma_drain)(struct esp *esp);
396
397 /* Invalidate the DMA engine after a DMA transfer. */
398 void (*dma_invalidate)(struct esp *esp);
399
400 /* Setup an ESP command that will use a DMA transfer.
401 * The 'esp_count' specifies what transfer length should be
402 * programmed into the ESP transfer counter registers, whereas
403 * the 'dma_count' is the length that should be programmed into
404 * the DMA controller. Usually they are the same. If 'write'
405 * is non-zero, this transfer is a write into memory. 'cmd'
406 * holds the ESP command that should be issued by calling
407 * scsi_esp_cmd() at the appropriate time while programming
408 * the DMA hardware.
409 */
410 void (*send_dma_cmd)(struct esp *esp, u32 dma_addr, u32 esp_count,
411 u32 dma_count, int write, u8 cmd);
412
413 /* Return non-zero if the DMA engine is reporting an error
414 * currently.
415 */
416 int (*dma_error)(struct esp *esp);
417 };
418
419 #define ESP_MAX_MSG_SZ 8
420 #define ESP_EVENT_LOG_SZ 32
421
422 #define ESP_QUICKIRQ_LIMIT 100
423 #define ESP_RESELECT_TAG_LIMIT 2500
424
425 struct esp {
426 void __iomem *regs;
427 void __iomem *dma_regs;
428
429 const struct esp_driver_ops *ops;
430
431 struct Scsi_Host *host;
432 struct device *dev;
433
434 struct esp_cmd_entry *active_cmd;
435
436 struct list_head queued_cmds;
437 struct list_head active_cmds;
438
439 u8 *command_block;
440 dma_addr_t command_block_dma;
441
442 unsigned int data_dma_len;
443
444 /* The following are used to determine the cause of an IRQ. Upon every
445 * IRQ entry we synchronize these with the hardware registers.
446 */
447 u8 sreg;
448 u8 seqreg;
449 u8 sreg2;
450 u8 ireg;
451
452 u32 prev_hme_dmacsr;
453 u8 prev_soff;
454 u8 prev_stp;
455 u8 prev_cfg3;
456 u8 num_tags;
457
458 struct list_head esp_cmd_pool;
459
460 struct esp_target_data target[ESP_MAX_TARGET];
461
462 int fifo_cnt;
463 u8 fifo[16];
464
465 struct esp_event_ent esp_event_log[ESP_EVENT_LOG_SZ];
466 int esp_event_cur;
467
468 u8 msg_out[ESP_MAX_MSG_SZ];
469 int msg_out_len;
470
471 u8 msg_in[ESP_MAX_MSG_SZ];
472 int msg_in_len;
473
474 u8 bursts;
475 u8 config1;
476 u8 config2;
477 u8 config4;
478
479 u8 scsi_id;
480 u32 scsi_id_mask;
481
482 enum esp_rev rev;
483
484 u32 flags;
485 #define ESP_FLAG_DIFFERENTIAL 0x00000001
486 #define ESP_FLAG_RESETTING 0x00000002
487 #define ESP_FLAG_WIDE_CAPABLE 0x00000008
488 #define ESP_FLAG_QUICKIRQ_CHECK 0x00000010
489 #define ESP_FLAG_DISABLE_SYNC 0x00000020
490 #define ESP_FLAG_USE_FIFO 0x00000040
491 #define ESP_FLAG_NO_DMA_MAP 0x00000080
492
493 u8 select_state;
494 #define ESP_SELECT_NONE 0x00 /* Not selecting */
495 #define ESP_SELECT_BASIC 0x01 /* Select w/o MSGOUT phase */
496 #define ESP_SELECT_MSGOUT 0x02 /* Select with MSGOUT */
497
498 /* When we are not selecting, we are expecting an event. */
499 u8 event;
500 #define ESP_EVENT_NONE 0x00
501 #define ESP_EVENT_CMD_START 0x01
502 #define ESP_EVENT_CMD_DONE 0x02
503 #define ESP_EVENT_DATA_IN 0x03
504 #define ESP_EVENT_DATA_OUT 0x04
505 #define ESP_EVENT_DATA_DONE 0x05
506 #define ESP_EVENT_MSGIN 0x06
507 #define ESP_EVENT_MSGIN_MORE 0x07
508 #define ESP_EVENT_MSGIN_DONE 0x08
509 #define ESP_EVENT_MSGOUT 0x09
510 #define ESP_EVENT_MSGOUT_DONE 0x0a
511 #define ESP_EVENT_STATUS 0x0b
512 #define ESP_EVENT_FREE_BUS 0x0c
513 #define ESP_EVENT_CHECK_PHASE 0x0d
514 #define ESP_EVENT_RESET 0x10
515
516 /* Probed in esp_get_clock_params() */
517 u32 cfact;
518 u32 cfreq;
519 u32 ccycle;
520 u32 ctick;
521 u32 neg_defp;
522 u32 sync_defp;
523
524 /* Computed in esp_reset_esp() */
525 u32 max_period;
526 u32 min_period;
527 u32 radelay;
528
529 /* ESP_CMD_SELAS command state */
530 u8 *cmd_bytes_ptr;
531 int cmd_bytes_left;
532
533 struct completion *eh_reset;
534
535 void *dma;
536 int dmarev;
537
538 /* These are used by esp_send_pio_cmd() */
539 u8 __iomem *fifo_reg;
540 int send_cmd_error;
541 u32 send_cmd_residual;
542 };
543
544 /* A front-end driver for the ESP chip should do the following in
545 * it's device probe routine:
546 * 1) Allocate the host and private area using scsi_host_alloc()
547 * with size 'sizeof(struct esp)'. The first argument to
548 * scsi_host_alloc() should be &scsi_esp_template.
549 * 2) Set host->max_id as appropriate.
550 * 3) Set esp->host to the scsi_host itself, and esp->dev
551 * to the device object pointer.
552 * 4) Hook up esp->ops to the front-end implementation.
553 * 5) If the ESP chip supports wide transfers, set ESP_FLAG_WIDE_CAPABLE
554 * in esp->flags.
555 * 6) Map the DMA and ESP chip registers.
556 * 7) DMA map the ESP command block, store the DMA address
557 * in esp->command_block_dma.
558 * 8) Register the scsi_esp_intr() interrupt handler.
559 * 9) Probe for and provide the following chip properties:
560 * esp->scsi_id (assign to esp->host->this_id too)
561 * esp->scsi_id_mask
562 * If ESP bus is differential, set ESP_FLAG_DIFFERENTIAL
563 * esp->cfreq
564 * DMA burst bit mask in esp->bursts, if necessary
565 * 10) Perform any actions necessary before the ESP device can
566 * be programmed for the first time. On some configs, for
567 * example, the DMA engine has to be reset before ESP can
568 * be programmed.
569 * 11) If necessary, call dev_set_drvdata() as needed.
570 * 12) Call scsi_esp_register() with prepared 'esp' structure.
571 * 13) Check scsi_esp_register() return value, release all resources
572 * if an error was returned.
573 */
574 extern struct scsi_host_template scsi_esp_template;
575 extern int scsi_esp_register(struct esp *);
576
577 extern void scsi_esp_unregister(struct esp *);
578 extern irqreturn_t scsi_esp_intr(int, void *);
579 extern void scsi_esp_cmd(struct esp *, u8);
580
581 extern void esp_send_pio_cmd(struct esp *esp, u32 dma_addr, u32 esp_count,
582 u32 dma_count, int write, u8 cmd);
583
584 #endif /* !(_ESP_SCSI_H) */
Linux with added FPC-III support