Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /* esp_scsi.h: Defines and structures for the ESP driver.
0003  *
0004  * Copyright (C) 2007 David S. Miller (davem@davemloft.net)
0005  */
0006 
0007 #ifndef _ESP_SCSI_H
0008 #define _ESP_SCSI_H
0009 
0010                     /* Access    Description      Offset */
0011 #define ESP_TCLOW   0x00UL      /* rw  Low bits transfer count 0x00  */
0012 #define ESP_TCMED   0x01UL      /* rw  Mid bits transfer count 0x04  */
0013 #define ESP_FDATA   0x02UL      /* rw  FIFO data bits          0x08  */
0014 #define ESP_CMD     0x03UL      /* rw  SCSI command bits       0x0c  */
0015 #define ESP_STATUS  0x04UL      /* ro  ESP status register     0x10  */
0016 #define ESP_BUSID   ESP_STATUS  /* wo  BusID for sel/resel     0x10  */
0017 #define ESP_INTRPT  0x05UL      /* ro  Kind of interrupt       0x14  */
0018 #define ESP_TIMEO   ESP_INTRPT  /* wo  Timeout for sel/resel   0x14  */
0019 #define ESP_SSTEP   0x06UL      /* ro  Sequence step register  0x18  */
0020 #define ESP_STP     ESP_SSTEP   /* wo  Transfer period/sync    0x18  */
0021 #define ESP_FFLAGS  0x07UL      /* ro  Bits current FIFO info  0x1c  */
0022 #define ESP_SOFF    ESP_FFLAGS  /* wo  Sync offset             0x1c  */
0023 #define ESP_CFG1    0x08UL      /* rw  First cfg register      0x20  */
0024 #define ESP_CFACT   0x09UL      /* wo  Clock conv factor       0x24  */
0025 #define ESP_STATUS2 ESP_CFACT   /* ro  HME status2 register    0x24  */
0026 #define ESP_CTEST   0x0aUL      /* wo  Chip test register      0x28  */
0027 #define ESP_CFG2    0x0bUL      /* rw  Second cfg register     0x2c  */
0028 #define ESP_CFG3    0x0cUL      /* rw  Third cfg register      0x30  */
0029 #define ESP_CFG4    0x0dUL      /* rw  Fourth cfg register     0x34  */
0030 #define ESP_TCHI    0x0eUL      /* rw  High bits transf count  0x38  */
0031 #define ESP_UID     ESP_TCHI    /* ro  Unique ID code          0x38  */
0032 #define FAS_RLO     ESP_TCHI    /* rw  HME extended counter    0x38  */
0033 #define ESP_FGRND   0x0fUL      /* rw  Data base for fifo      0x3c  */
0034 #define FAS_RHI     ESP_FGRND   /* rw  HME extended counter    0x3c  */
0035 
0036 #define SBUS_ESP_REG_SIZE   0x40UL
0037 
0038 /* Bitfield meanings for the above registers. */
0039 
0040 /* ESP config reg 1, read-write, found on all ESP chips */
0041 #define ESP_CONFIG1_ID        0x07      /* My BUS ID bits */
0042 #define ESP_CONFIG1_CHTEST    0x08      /* Enable ESP chip tests */
0043 #define ESP_CONFIG1_PENABLE   0x10      /* Enable parity checks */
0044 #define ESP_CONFIG1_PARTEST   0x20      /* Parity test mode enabled? */
0045 #define ESP_CONFIG1_SRRDISAB  0x40      /* Disable SCSI reset reports */
0046 #define ESP_CONFIG1_SLCABLE   0x80      /* Enable slow cable mode */
0047 
0048 /* ESP config reg 2, read-write, found only on esp100a+esp200+esp236 chips */
0049 #define ESP_CONFIG2_DMAPARITY 0x01      /* enable DMA Parity (200,236) */
0050 #define ESP_CONFIG2_REGPARITY 0x02      /* enable reg Parity (200,236) */
0051 #define ESP_CONFIG2_BADPARITY 0x04      /* Bad parity target abort  */
0052 #define ESP_CONFIG2_SCSI2ENAB 0x08      /* Enable SCSI-2 features (tgtmode) */
0053 #define ESP_CONFIG2_HI        0x10      /* High Impedance DREQ ???  */
0054 #define ESP_CONFIG2_HMEFENAB  0x10      /* HME features enable */
0055 #define ESP_CONFIG2_BCM       0x20      /* Enable byte-ctrl (236)   */
0056 #define ESP_CONFIG2_DISPINT   0x20      /* Disable pause irq (hme) */
0057 #define ESP_CONFIG2_FENAB     0x40      /* Enable features (fas100,216) */
0058 #define ESP_CONFIG2_SPL       0x40      /* Enable status-phase latch (236) */
0059 #define ESP_CONFIG2_MKDONE    0x40      /* HME magic feature */
0060 #define ESP_CONFIG2_HME32     0x80      /* HME 32 extended */
0061 #define ESP_CONFIG2_MAGIC     0xe0      /* Invalid bits... */
0062 
0063 /* ESP config register 3 read-write, found only esp236+fas236+fas100a+hme chips */
0064 #define ESP_CONFIG3_FCLOCK    0x01     /* FAST SCSI clock rate (esp100a/hme) */
0065 #define ESP_CONFIG3_TEM       0x01     /* Enable thresh-8 mode (esp/fas236)  */
0066 #define ESP_CONFIG3_FAST      0x02     /* Enable FAST SCSI     (esp100a/hme) */
0067 #define ESP_CONFIG3_ADMA      0x02     /* Enable alternate-dma (esp/fas236)  */
0068 #define ESP_CONFIG3_TENB      0x04     /* group2 SCSI2 support (esp100a/hme) */
0069 #define ESP_CONFIG3_SRB       0x04     /* Save residual byte   (esp/fas236)  */
0070 #define ESP_CONFIG3_TMS       0x08     /* Three-byte msg's ok  (esp100a/hme) */
0071 #define ESP_CONFIG3_FCLK      0x08     /* Fast SCSI clock rate (esp/fas236)  */
0072 #define ESP_CONFIG3_IDMSG     0x10     /* ID message checking  (esp100a/hme) */
0073 #define ESP_CONFIG3_FSCSI     0x10     /* Enable FAST SCSI     (esp/fas236)  */
0074 #define ESP_CONFIG3_GTM       0x20     /* group2 SCSI2 support (esp/fas236)  */
0075 #define ESP_CONFIG3_IDBIT3    0x20     /* Bit 3 of HME SCSI-ID (hme)         */
0076 #define ESP_CONFIG3_TBMS      0x40     /* Three-byte msg's ok  (esp/fas236)  */
0077 #define ESP_CONFIG3_EWIDE     0x40     /* Enable Wide-SCSI     (hme)         */
0078 #define ESP_CONFIG3_IMS       0x80     /* ID msg chk'ng        (esp/fas236)  */
0079 #define ESP_CONFIG3_OBPUSH    0x80     /* Push odd-byte to dma (hme)         */
0080 
0081 /* ESP config register 4 read-write */
0082 #define ESP_CONFIG4_BBTE      0x01     /* Back-to-back transfers     (fsc)   */
0083 #define ESP_CONGIG4_TEST      0x02     /* Transfer counter test mode (fsc)   */
0084 #define ESP_CONFIG4_RADE      0x04     /* Active negation   (am53c974/fsc)   */
0085 #define ESP_CONFIG4_RAE       0x08     /* Act. negation REQ/ACK (am53c974)   */
0086 #define ESP_CONFIG4_PWD       0x20     /* Reduced power feature (am53c974)   */
0087 #define ESP_CONFIG4_GE0       0x40     /* Glitch eater bit 0    (am53c974)   */
0088 #define ESP_CONFIG4_GE1       0x80     /* Glitch eater bit 1    (am53c974)   */
0089 
0090 #define ESP_CONFIG_GE_12NS    (0)
0091 #define ESP_CONFIG_GE_25NS    (ESP_CONFIG_GE1)
0092 #define ESP_CONFIG_GE_35NS    (ESP_CONFIG_GE0)
0093 #define ESP_CONFIG_GE_0NS     (ESP_CONFIG_GE0 | ESP_CONFIG_GE1)
0094 
0095 /* ESP command register read-write */
0096 /* Group 1 commands:  These may be sent at any point in time to the ESP
0097  *                    chip.  None of them can generate interrupts 'cept
0098  *                    the "SCSI bus reset" command if you have not disabled
0099  *                    SCSI reset interrupts in the config1 ESP register.
0100  */
0101 #define ESP_CMD_NULL          0x00     /* Null command, ie. a nop */
0102 #define ESP_CMD_FLUSH         0x01     /* FIFO Flush */
0103 #define ESP_CMD_RC            0x02     /* Chip reset */
0104 #define ESP_CMD_RS            0x03     /* SCSI bus reset */
0105 
0106 /* Group 2 commands:  ESP must be an initiator and connected to a target
0107  *                    for these commands to work.
0108  */
0109 #define ESP_CMD_TI            0x10     /* Transfer Information */
0110 #define ESP_CMD_ICCSEQ        0x11     /* Initiator cmd complete sequence */
0111 #define ESP_CMD_MOK           0x12     /* Message okie-dokie */
0112 #define ESP_CMD_TPAD          0x18     /* Transfer Pad */
0113 #define ESP_CMD_SATN          0x1a     /* Set ATN */
0114 #define ESP_CMD_RATN          0x1b     /* De-assert ATN */
0115 
0116 /* Group 3 commands:  ESP must be in the MSGOUT or MSGIN state and be connected
0117  *                    to a target as the initiator for these commands to work.
0118  */
0119 #define ESP_CMD_SMSG          0x20     /* Send message */
0120 #define ESP_CMD_SSTAT         0x21     /* Send status */
0121 #define ESP_CMD_SDATA         0x22     /* Send data */
0122 #define ESP_CMD_DSEQ          0x23     /* Discontinue Sequence */
0123 #define ESP_CMD_TSEQ          0x24     /* Terminate Sequence */
0124 #define ESP_CMD_TCCSEQ        0x25     /* Target cmd cmplt sequence */
0125 #define ESP_CMD_DCNCT         0x27     /* Disconnect */
0126 #define ESP_CMD_RMSG          0x28     /* Receive Message */
0127 #define ESP_CMD_RCMD          0x29     /* Receive Command */
0128 #define ESP_CMD_RDATA         0x2a     /* Receive Data */
0129 #define ESP_CMD_RCSEQ         0x2b     /* Receive cmd sequence */
0130 
0131 /* Group 4 commands:  The ESP must be in the disconnected state and must
0132  *                    not be connected to any targets as initiator for
0133  *                    these commands to work.
0134  */
0135 #define ESP_CMD_RSEL          0x40     /* Reselect */
0136 #define ESP_CMD_SEL           0x41     /* Select w/o ATN */
0137 #define ESP_CMD_SELA          0x42     /* Select w/ATN */
0138 #define ESP_CMD_SELAS         0x43     /* Select w/ATN & STOP */
0139 #define ESP_CMD_ESEL          0x44     /* Enable selection */
0140 #define ESP_CMD_DSEL          0x45     /* Disable selections */
0141 #define ESP_CMD_SA3           0x46     /* Select w/ATN3 */
0142 #define ESP_CMD_RSEL3         0x47     /* Reselect3 */
0143 
0144 /* This bit enables the ESP's DMA on the SBus */
0145 #define ESP_CMD_DMA           0x80     /* Do DMA? */
0146 
0147 /* ESP status register read-only */
0148 #define ESP_STAT_PIO          0x01     /* IO phase bit */
0149 #define ESP_STAT_PCD          0x02     /* CD phase bit */
0150 #define ESP_STAT_PMSG         0x04     /* MSG phase bit */
0151 #define ESP_STAT_PMASK        0x07     /* Mask of phase bits */
0152 #define ESP_STAT_TDONE        0x08     /* Transfer Completed */
0153 #define ESP_STAT_TCNT         0x10     /* Transfer Counter Is Zero */
0154 #define ESP_STAT_PERR         0x20     /* Parity error */
0155 #define ESP_STAT_SPAM         0x40     /* Real bad error */
0156 /* This indicates the 'interrupt pending' condition on esp236, it is a reserved
0157  * bit on other revs of the ESP.
0158  */
0159 #define ESP_STAT_INTR         0x80             /* Interrupt */
0160 
0161 /* The status register can be masked with ESP_STAT_PMASK and compared
0162  * with the following values to determine the current phase the ESP
0163  * (at least thinks it) is in.  For our purposes we also add our own
0164  * software 'done' bit for our phase management engine.
0165  */
0166 #define ESP_DOP   (0)                                       /* Data Out  */
0167 #define ESP_DIP   (ESP_STAT_PIO)                            /* Data In   */
0168 #define ESP_CMDP  (ESP_STAT_PCD)                            /* Command   */
0169 #define ESP_STATP (ESP_STAT_PCD|ESP_STAT_PIO)               /* Status    */
0170 #define ESP_MOP   (ESP_STAT_PMSG|ESP_STAT_PCD)              /* Message Out */
0171 #define ESP_MIP   (ESP_STAT_PMSG|ESP_STAT_PCD|ESP_STAT_PIO) /* Message In */
0172 
0173 /* HME only: status 2 register */
0174 #define ESP_STAT2_SCHBIT      0x01 /* Upper bits 3-7 of sstep enabled */
0175 #define ESP_STAT2_FFLAGS      0x02 /* The fifo flags are now latched */
0176 #define ESP_STAT2_XCNT        0x04 /* The transfer counter is latched */
0177 #define ESP_STAT2_CREGA       0x08 /* The command reg is active now */
0178 #define ESP_STAT2_WIDE        0x10 /* Interface on this adapter is wide */
0179 #define ESP_STAT2_F1BYTE      0x20 /* There is one byte at top of fifo */
0180 #define ESP_STAT2_FMSB        0x40 /* Next byte in fifo is most significant */
0181 #define ESP_STAT2_FEMPTY      0x80 /* FIFO is empty */
0182 
0183 /* ESP interrupt register read-only */
0184 #define ESP_INTR_S            0x01     /* Select w/o ATN */
0185 #define ESP_INTR_SATN         0x02     /* Select w/ATN */
0186 #define ESP_INTR_RSEL         0x04     /* Reselected */
0187 #define ESP_INTR_FDONE        0x08     /* Function done */
0188 #define ESP_INTR_BSERV        0x10     /* Bus service */
0189 #define ESP_INTR_DC           0x20     /* Disconnect */
0190 #define ESP_INTR_IC           0x40     /* Illegal command given */
0191 #define ESP_INTR_SR           0x80     /* SCSI bus reset detected */
0192 
0193 /* ESP sequence step register read-only */
0194 #define ESP_STEP_VBITS        0x07     /* Valid bits */
0195 #define ESP_STEP_ASEL         0x00     /* Selection&Arbitrate cmplt */
0196 #define ESP_STEP_SID          0x01     /* One msg byte sent */
0197 #define ESP_STEP_NCMD         0x02     /* Was not in command phase */
0198 #define ESP_STEP_PPC          0x03     /* Early phase chg caused cmnd
0199                                         * bytes to be lost
0200                                         */
0201 #define ESP_STEP_FINI4        0x04     /* Command was sent ok */
0202 
0203 /* Ho hum, some ESP's set the step register to this as well... */
0204 #define ESP_STEP_FINI5        0x05
0205 #define ESP_STEP_FINI6        0x06
0206 #define ESP_STEP_FINI7        0x07
0207 
0208 /* ESP chip-test register read-write */
0209 #define ESP_TEST_TARG         0x01     /* Target test mode */
0210 #define ESP_TEST_INI          0x02     /* Initiator test mode */
0211 #define ESP_TEST_TS           0x04     /* Tristate test mode */
0212 
0213 /* ESP unique ID register read-only, found on fas236+fas100a only */
0214 #define ESP_UID_FAM           0xf8     /* ESP family bitmask */
0215 
0216 #define ESP_FAMILY(uid) (((uid) & ESP_UID_FAM) >> 3)
0217 
0218 /* Values for the ESP family bits */
0219 #define ESP_UID_F100A         0x00     /* ESP FAS100A  */
0220 #define ESP_UID_F236          0x02     /* ESP FAS236   */
0221 #define ESP_UID_HME           0x0a     /* FAS HME      */
0222 #define ESP_UID_FSC           0x14     /* NCR/Symbios Logic 53CF9x-2 */
0223 
0224 /* ESP fifo flags register read-only */
0225 /* Note that the following implies a 16 byte FIFO on the ESP. */
0226 #define ESP_FF_FBYTES         0x1f     /* Num bytes in FIFO */
0227 #define ESP_FF_ONOTZERO       0x20     /* offset ctr not zero (esp100) */
0228 #define ESP_FF_SSTEP          0xe0     /* Sequence step */
0229 
0230 /* ESP clock conversion factor register write-only */
0231 #define ESP_CCF_F0            0x00     /* 35.01MHz - 40MHz */
0232 #define ESP_CCF_NEVER         0x01     /* Set it to this and die */
0233 #define ESP_CCF_F2            0x02     /* 10MHz */
0234 #define ESP_CCF_F3            0x03     /* 10.01MHz - 15MHz */
0235 #define ESP_CCF_F4            0x04     /* 15.01MHz - 20MHz */
0236 #define ESP_CCF_F5            0x05     /* 20.01MHz - 25MHz */
0237 #define ESP_CCF_F6            0x06     /* 25.01MHz - 30MHz */
0238 #define ESP_CCF_F7            0x07     /* 30.01MHz - 35MHz */
0239 
0240 /* HME only... */
0241 #define ESP_BUSID_RESELID     0x10
0242 #define ESP_BUSID_CTR32BIT    0x40
0243 
0244 #define ESP_BUS_TIMEOUT        250     /* In milli-seconds */
0245 #define ESP_TIMEO_CONST       8192
0246 #define ESP_NEG_DEFP(mhz, cfact) \
0247         ((ESP_BUS_TIMEOUT * ((mhz) / 1000)) / (8192 * (cfact)))
0248 #define ESP_HZ_TO_CYCLE(hertz)  ((1000000000) / ((hertz) / 1000))
0249 #define ESP_TICK(ccf, cycle)  ((7682 * (ccf) * (cycle) / 1000))
0250 
0251 /* For slow to medium speed input clock rates we shoot for 5mb/s, but for high
0252  * input clock rates we try to do 10mb/s although I don't think a transfer can
0253  * even run that fast with an ESP even with DMA2 scatter gather pipelining.
0254  */
0255 #define SYNC_DEFP_SLOW            0x32   /* 5mb/s  */
0256 #define SYNC_DEFP_FAST            0x19   /* 10mb/s */
0257 
0258 struct esp_cmd_priv {
0259     int         num_sg;
0260     int         cur_residue;
0261     struct scatterlist  *prv_sg;
0262     struct scatterlist  *cur_sg;
0263     int         tot_residue;
0264 };
0265 
0266 #define ESP_CMD_PRIV(cmd)   ((struct esp_cmd_priv *)scsi_cmd_priv(cmd))
0267 
0268 /* NOTE: this enum is ordered based on chip features! */
0269 enum esp_rev {
0270     ESP100,  /* NCR53C90 - very broken */
0271     ESP100A, /* NCR53C90A */
0272     ESP236,
0273     FAS236,
0274     PCSCSI,  /* AM53c974 */
0275     FSC,     /* NCR/Symbios Logic 53CF9x-2 */
0276     FAS100A,
0277     FAST,
0278     FASHME,
0279 };
0280 
0281 struct esp_cmd_entry {
0282     struct list_head    list;
0283 
0284     struct scsi_cmnd    *cmd;
0285 
0286     unsigned int        saved_cur_residue;
0287     struct scatterlist  *saved_prv_sg;
0288     struct scatterlist  *saved_cur_sg;
0289     unsigned int        saved_tot_residue;
0290 
0291     u8          flags;
0292 #define ESP_CMD_FLAG_WRITE  0x01 /* DMA is a write */
0293 #define ESP_CMD_FLAG_AUTOSENSE  0x04 /* Doing automatic REQUEST_SENSE */
0294 #define ESP_CMD_FLAG_RESIDUAL   0x08 /* AM53c974 BLAST residual */
0295 
0296     u8          tag[2];
0297     u8          orig_tag[2];
0298 
0299     u8          status;
0300     u8          message;
0301 
0302     unsigned char       *sense_ptr;
0303     unsigned char       *saved_sense_ptr;
0304     dma_addr_t      sense_dma;
0305 
0306     struct completion   *eh_done;
0307 };
0308 
0309 #define ESP_DEFAULT_TAGS    16
0310 
0311 #define ESP_MAX_TARGET      16
0312 #define ESP_MAX_LUN     8
0313 #define ESP_MAX_TAG     256
0314 
0315 struct esp_lun_data {
0316     struct esp_cmd_entry    *non_tagged_cmd;
0317     int         num_tagged;
0318     int         hold;
0319     struct esp_cmd_entry    *tagged_cmds[ESP_MAX_TAG];
0320 };
0321 
0322 struct esp_target_data {
0323     /* These are the ESP_STP, ESP_SOFF, and ESP_CFG3 register values which
0324      * match the currently negotiated settings for this target.  The SCSI
0325      * protocol values are maintained in spi_{offset,period,wide}(starget).
0326      */
0327     u8          esp_period;
0328     u8          esp_offset;
0329     u8          esp_config3;
0330 
0331     u8          flags;
0332 #define ESP_TGT_WIDE        0x01
0333 #define ESP_TGT_DISCONNECT  0x02
0334 #define ESP_TGT_NEGO_WIDE   0x04
0335 #define ESP_TGT_NEGO_SYNC   0x08
0336 #define ESP_TGT_CHECK_NEGO  0x40
0337 #define ESP_TGT_BROKEN      0x80
0338 
0339     /* When ESP_TGT_CHECK_NEGO is set, on the next scsi command to this
0340      * device we will try to negotiate the following parameters.
0341      */
0342     u8          nego_goal_period;
0343     u8          nego_goal_offset;
0344     u8          nego_goal_width;
0345     u8          nego_goal_tags;
0346 
0347     struct scsi_target  *starget;
0348 };
0349 
0350 struct esp_event_ent {
0351     u8          type;
0352 #define ESP_EVENT_TYPE_EVENT    0x01
0353 #define ESP_EVENT_TYPE_CMD  0x02
0354     u8          val;
0355 
0356     u8          sreg;
0357     u8          seqreg;
0358     u8          sreg2;
0359     u8          ireg;
0360     u8          select_state;
0361     u8          event;
0362     u8          __pad;
0363 };
0364 
0365 struct esp;
0366 struct esp_driver_ops {
0367     /* Read and write the ESP 8-bit registers.  On some
0368      * applications of the ESP chip the registers are at 4-byte
0369      * instead of 1-byte intervals.
0370      */
0371     void (*esp_write8)(struct esp *esp, u8 val, unsigned long reg);
0372     u8 (*esp_read8)(struct esp *esp, unsigned long reg);
0373 
0374     /* Return non-zero if there is an IRQ pending.  Usually this
0375      * status bit lives in the DMA controller sitting in front of
0376      * the ESP.  This has to be accurate or else the ESP interrupt
0377      * handler will not run.
0378      */
0379     int (*irq_pending)(struct esp *esp);
0380 
0381     /* Return the maximum allowable size of a DMA transfer for a
0382      * given buffer.
0383      */
0384     u32 (*dma_length_limit)(struct esp *esp, u32 dma_addr,
0385                 u32 dma_len);
0386 
0387     /* Reset the DMA engine entirely.  On return, ESP interrupts
0388      * should be enabled.  Often the interrupt enabling is
0389      * controlled in the DMA engine.
0390      */
0391     void (*reset_dma)(struct esp *esp);
0392 
0393     /* Drain any pending DMA in the DMA engine after a transfer.
0394      * This is for writes to memory.
0395      */
0396     void (*dma_drain)(struct esp *esp);
0397 
0398     /* Invalidate the DMA engine after a DMA transfer.  */
0399     void (*dma_invalidate)(struct esp *esp);
0400 
0401     /* Setup an ESP command that will use a DMA transfer.
0402      * The 'esp_count' specifies what transfer length should be
0403      * programmed into the ESP transfer counter registers, whereas
0404      * the 'dma_count' is the length that should be programmed into
0405      * the DMA controller.  Usually they are the same.  If 'write'
0406      * is non-zero, this transfer is a write into memory.  'cmd'
0407      * holds the ESP command that should be issued by calling
0408      * scsi_esp_cmd() at the appropriate time while programming
0409      * the DMA hardware.
0410      */
0411     void (*send_dma_cmd)(struct esp *esp, u32 dma_addr, u32 esp_count,
0412                  u32 dma_count, int write, u8 cmd);
0413 
0414     /* Return non-zero if the DMA engine is reporting an error
0415      * currently.
0416      */
0417     int (*dma_error)(struct esp *esp);
0418 };
0419 
0420 #define ESP_MAX_MSG_SZ      8
0421 #define ESP_EVENT_LOG_SZ    32
0422 
0423 #define ESP_QUICKIRQ_LIMIT  100
0424 #define ESP_RESELECT_TAG_LIMIT  2500
0425 
0426 struct esp {
0427     void __iomem        *regs;
0428     void __iomem        *dma_regs;
0429 
0430     const struct esp_driver_ops *ops;
0431 
0432     struct Scsi_Host    *host;
0433     struct device       *dev;
0434 
0435     struct esp_cmd_entry    *active_cmd;
0436 
0437     struct list_head    queued_cmds;
0438     struct list_head    active_cmds;
0439 
0440     u8          *command_block;
0441     dma_addr_t      command_block_dma;
0442 
0443     unsigned int        data_dma_len;
0444 
0445     /* The following are used to determine the cause of an IRQ. Upon every
0446      * IRQ entry we synchronize these with the hardware registers.
0447      */
0448     u8          sreg;
0449     u8          seqreg;
0450     u8          sreg2;
0451     u8          ireg;
0452 
0453     u32         prev_hme_dmacsr;
0454     u8          prev_soff;
0455     u8          prev_stp;
0456     u8          prev_cfg3;
0457     u8          num_tags;
0458 
0459     struct list_head    esp_cmd_pool;
0460 
0461     struct esp_target_data  target[ESP_MAX_TARGET];
0462 
0463     int         fifo_cnt;
0464     u8          fifo[16];
0465 
0466     struct esp_event_ent    esp_event_log[ESP_EVENT_LOG_SZ];
0467     int         esp_event_cur;
0468 
0469     u8          msg_out[ESP_MAX_MSG_SZ];
0470     int         msg_out_len;
0471 
0472     u8          msg_in[ESP_MAX_MSG_SZ];
0473     int         msg_in_len;
0474 
0475     u8          bursts;
0476     u8          config1;
0477     u8          config2;
0478     u8          config4;
0479 
0480     u8          scsi_id;
0481     u32         scsi_id_mask;
0482 
0483     enum esp_rev        rev;
0484 
0485     u32         flags;
0486 #define ESP_FLAG_DIFFERENTIAL   0x00000001
0487 #define ESP_FLAG_RESETTING  0x00000002
0488 #define ESP_FLAG_WIDE_CAPABLE   0x00000008
0489 #define ESP_FLAG_QUICKIRQ_CHECK 0x00000010
0490 #define ESP_FLAG_DISABLE_SYNC   0x00000020
0491 #define ESP_FLAG_USE_FIFO   0x00000040
0492 #define ESP_FLAG_NO_DMA_MAP 0x00000080
0493 
0494     u8          select_state;
0495 #define ESP_SELECT_NONE     0x00 /* Not selecting */
0496 #define ESP_SELECT_BASIC    0x01 /* Select w/o MSGOUT phase */
0497 #define ESP_SELECT_MSGOUT   0x02 /* Select with MSGOUT */
0498 
0499     /* When we are not selecting, we are expecting an event.  */
0500     u8          event;
0501 #define ESP_EVENT_NONE      0x00
0502 #define ESP_EVENT_CMD_START 0x01
0503 #define ESP_EVENT_CMD_DONE  0x02
0504 #define ESP_EVENT_DATA_IN   0x03
0505 #define ESP_EVENT_DATA_OUT  0x04
0506 #define ESP_EVENT_DATA_DONE 0x05
0507 #define ESP_EVENT_MSGIN     0x06
0508 #define ESP_EVENT_MSGIN_MORE    0x07
0509 #define ESP_EVENT_MSGIN_DONE    0x08
0510 #define ESP_EVENT_MSGOUT    0x09
0511 #define ESP_EVENT_MSGOUT_DONE   0x0a
0512 #define ESP_EVENT_STATUS    0x0b
0513 #define ESP_EVENT_FREE_BUS  0x0c
0514 #define ESP_EVENT_CHECK_PHASE   0x0d
0515 #define ESP_EVENT_RESET     0x10
0516 
0517     /* Probed in esp_get_clock_params() */
0518     u32         cfact;
0519     u32         cfreq;
0520     u32         ccycle;
0521     u32         ctick;
0522     u32         neg_defp;
0523     u32         sync_defp;
0524 
0525     /* Computed in esp_reset_esp() */
0526     u32         max_period;
0527     u32         min_period;
0528     u32         radelay;
0529 
0530     /* ESP_CMD_SELAS command state */
0531     u8          *cmd_bytes_ptr;
0532     int         cmd_bytes_left;
0533 
0534     struct completion   *eh_reset;
0535 
0536     void            *dma;
0537     int         dmarev;
0538 
0539     /* These are used by esp_send_pio_cmd() */
0540     u8 __iomem      *fifo_reg;
0541     int         send_cmd_error;
0542     u32         send_cmd_residual;
0543 };
0544 
0545 /* A front-end driver for the ESP chip should do the following in
0546  * it's device probe routine:
0547  * 1) Allocate the host and private area using scsi_host_alloc()
0548  *    with size 'sizeof(struct esp)'.  The first argument to
0549  *    scsi_host_alloc() should be &scsi_esp_template.
0550  * 2) Set host->max_id as appropriate.
0551  * 3) Set esp->host to the scsi_host itself, and esp->dev
0552  *    to the device object pointer.
0553  * 4) Hook up esp->ops to the front-end implementation.
0554  * 5) If the ESP chip supports wide transfers, set ESP_FLAG_WIDE_CAPABLE
0555  *    in esp->flags.
0556  * 6) Map the DMA and ESP chip registers.
0557  * 7) DMA map the ESP command block, store the DMA address
0558  *    in esp->command_block_dma.
0559  * 8) Register the scsi_esp_intr() interrupt handler.
0560  * 9) Probe for and provide the following chip properties:
0561  *    esp->scsi_id (assign to esp->host->this_id too)
0562  *    esp->scsi_id_mask
0563  *    If ESP bus is differential, set ESP_FLAG_DIFFERENTIAL
0564  *    esp->cfreq
0565  *    DMA burst bit mask in esp->bursts, if necessary
0566  * 10) Perform any actions necessary before the ESP device can
0567  *     be programmed for the first time.  On some configs, for
0568  *     example, the DMA engine has to be reset before ESP can
0569  *     be programmed.
0570  * 11) If necessary, call dev_set_drvdata() as needed.
0571  * 12) Call scsi_esp_register() with prepared 'esp' structure.
0572  * 13) Check scsi_esp_register() return value, release all resources
0573  *     if an error was returned.
0574  */
0575 extern struct scsi_host_template scsi_esp_template;
0576 extern int scsi_esp_register(struct esp *);
0577 
0578 extern void scsi_esp_unregister(struct esp *);
0579 extern irqreturn_t scsi_esp_intr(int, void *);
0580 extern void scsi_esp_cmd(struct esp *, u8);
0581 
0582 extern void esp_send_pio_cmd(struct esp *esp, u32 dma_addr, u32 esp_count,
0583                  u32 dma_count, int write, u8 cmd);
0584 
0585 #endif /* !(_ESP_SCSI_H) */