sys/dev/raid/twe/twe_compat.h

   1 /*-
   2  * Copyright (c) 2000 Michael Smith
   3  * Copyright (c) 2000 BSDi
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/sys/dev/twe/twe_compat.h,v 1.1.2.3 2002/03/07 09:57:02 msmith Exp $
  28  */
  29 /*
  30  * Portability and compatibility interfaces.
  31  */
  32
  33 #ifdef __FreeBSD__
  34 /******************************************************************************
  35  * FreeBSD
  36  */
  37 #define TWE_SUPPORTED_PLATFORM
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/malloc.h>
  42 #include <sys/kernel.h>
  43
  44 #include <sys/bus.h>
  45 #include <sys/conf.h>
  46 #include <sys/disk.h>
  47 #include <sys/stat.h>
  48
  49 #include <machine/bus_pio.h>
  50 #include <machine/bus.h>
  51 #include <machine/resource.h>
  52 #include <sys/rman.h>
  53
  54 #include <pci/pcireg.h>
  55 #include <pci/pcivar.h>
  56
  57 /*
  58  * These macros allows us to build a version of the driver which can
  59  * safely be loaded into a kernel which already contains a 'twe' driver,
  60  * and which will override it in all things.
  61  *
  62  * All public symbols must be listed here.
  63  */
  64 #ifdef TWE_OVERRIDE
  65 #define twe_setup               Xtwe_setup
  66 #define twe_init                Xtwe_init
  67 #define twe_deinit              Xtwe_deinit
  68 #define twe_intr                Xtwe_intr
  69 #define twe_submit_bio          Xtwe_submit_bio
  70 #define twe_ioctl               Xtwe_ioctl
  71 #define twe_describe_controller Xtwe_describe_controller
  72 #define twe_print_controller    Xtwe_print_controller
  73 #define twe_enable_interrupts   Xtwe_enable_interrupts
  74 #define twe_disable_interrupts  Xtwe_disable_interrupts
  75 #define twe_attach_drive        Xtwe_attach_drive
  76 #define twed_intr               Xtwed_intr
  77 #define twe_allocate_request    Xtwe_allocate_request
  78 #define twe_free_request        Xtwe_free_request
  79 #define twe_map_request         Xtwe_map_request
  80 #define twe_unmap_request       Xtwe_unmap_request
  81 #define twe_describe_code       Xtwe_describe_code
  82 #define twe_table_status        Xtwe_table_status
  83 #define twe_table_unitstate     Xtwe_table_unitstate
  84 #define twe_table_unittype      Xtwe_table_unittype
  85 #define twe_table_aen           Xtwe_table_aen
  86 #define TWE_DRIVER_NAME         Xtwe
  87 #define TWED_DRIVER_NAME        Xtwed
  88 #define TWE_MALLOC_CLASS        M_XTWE
  89 #else
  90 #define TWE_DRIVER_NAME         twe
  91 #define TWED_DRIVER_NAME        twed
  92 #define TWE_MALLOC_CLASS        M_TWE
  93 #endif
  94
  95 /*
  96  * Wrappers for bus-space actions
  97  */
  98 #define TWE_CONTROL(sc, val)            bus_space_write_4(sc->twe_btag, sc->twe_bhandle, 0x0, (u_int32_t)val)
  99 #define TWE_STATUS(sc)                  (u_int32_t)bus_space_read_4(sc->twe_btag, sc->twe_bhandle, 0x4)
 100 #define TWE_COMMAND_QUEUE(sc, val)      bus_space_write_4(sc->twe_btag, sc->twe_bhandle, 0x8, (u_int32_t)val)
 101 #define TWE_RESPONSE_QUEUE(sc)          (TWE_Response_Queue)bus_space_read_4(sc->twe_btag, sc->twe_bhandle, 0xc)
 102
 103 /*
 104  * FreeBSD-specific softc elements
 105  */
 106 #define TWE_PLATFORM_SOFTC                                                              \
 107     device_t                    twe_dev;                /* bus device */                \
 108     dev_t                       twe_dev_t;              /* control device */            \
 109     struct resource             *twe_io;                /* register interface window */ \
 110     bus_space_handle_t          twe_bhandle;            /* bus space handle */          \
 111     bus_space_tag_t             twe_btag;               /* bus space tag */             \
 112     bus_dma_tag_t               twe_parent_dmat;        /* parent DMA tag */            \
 113     bus_dma_tag_t               twe_buffer_dmat;        /* data buffer DMA tag */       \
 114     struct resource             *twe_irq;               /* interrupt */                 \
 115     void                        *twe_intr;              /* interrupt handle */          \
 116     struct intr_config_hook     twe_ich;                /* delayed-startup hook */
 117
 118 /*
 119  * FreeBSD-specific request elements
 120  */
 121 #define TWE_PLATFORM_REQUEST                                                                            \
 122     bus_dmamap_t                tr_cmdmap;      /* DMA map for command */                               \
 123     u_int32_t                   tr_cmdphys;     /* address of command in controller space */            \
 124     bus_dmamap_t                tr_dmamap;      /* DMA map for data */                                  \
 125     u_int32_t                   tr_dataphys;    /* data buffer base address in controller space */
 126
 127 /*
 128  * Output identifying the controller/disk
 129  */
 130 #define twe_printf(sc, fmt, args...)    device_printf(sc->twe_dev, fmt , ##args)
 131 #define twed_printf(twed, fmt, args...) device_printf(twed->twed_dev, fmt , ##args)
 132
 133 #if __FreeBSD_version < 500003
 134 # include <machine/clock.h>
 135 # define INTR_ENTROPY                   0
 136
 137 # include <sys/buf.h>                   /* old buf style */
 138 typedef struct buf                      twe_bio;
 139 typedef struct buf_queue_head           twe_bioq;
 140 # define TWE_BIO_QINIT(bq)              bufq_init(&bq);
 141 # define TWE_BIO_QINSERT(bq, bp)        bufq_insert_tail(&bq, bp)
 142 # define TWE_BIO_QFIRST(bq)             bufq_first(&bq)
 143 # define TWE_BIO_QREMOVE(bq, bp)        bufq_remove(&bq, bp)
 144 # define TWE_BIO_IS_READ(bp)            ((bp)->b_flags & B_READ)
 145 # define TWE_BIO_DATA(bp)               (bp)->b_data
 146 # define TWE_BIO_LENGTH(bp)             (bp)->b_bcount
 147 # define TWE_BIO_LBA(bp)                (bp)->b_pblkno
 148 # define TWE_BIO_SOFTC(bp)              (bp)->b_dev->si_drv1
 149 # define TWE_BIO_UNIT(bp)               *(int *)((bp)->b_dev->si_drv2)
 150 # define TWE_BIO_SET_ERROR(bp, err)     do { (bp)->b_error = err; (bp)->b_flags |= B_ERROR;} while(0)
 151 # define TWE_BIO_HAS_ERROR(bp)          ((bp)->b_flags & B_ERROR)
 152 # define TWE_BIO_RESID(bp)              (bp)->b_resid
 153 # define TWE_BIO_DONE(bp)               biodone(bp)
 154 # define TWE_BIO_STATS_START(bp)        devstat_start_transaction(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats)
 155 # define TWE_BIO_STATS_END(bp)          devstat_end_transaction_buf(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats, bp)
 156 #else
 157 # include <sys/bio.h>
 158 typedef struct bio                      twe_bio;
 159 typedef struct bio_queue_head           twe_bioq;
 160 # define TWE_BIO_QINIT(bq)              bioq_init(&bq);
 161 # define TWE_BIO_QINSERT(bq, bp)        bioq_insert_tail(&bq, bp)
 162 # define TWE_BIO_QFIRST(bq)             bioq_first(&bq)
 163 # define TWE_BIO_QREMOVE(bq, bp)        bioq_remove(&bq, bp)
 164 # define TWE_BIO_IS_READ(bp)            ((bp)->bio_cmd == BIO_READ)
 165 # define TWE_BIO_DATA(bp)               (bp)->bio_data
 166 # define TWE_BIO_LENGTH(bp)             (bp)->bio_bcount
 167 # define TWE_BIO_LBA(bp)                (bp)->bio_pblkno
 168 # define TWE_BIO_SOFTC(bp)              (bp)->bio_dev->si_drv1
 169 # define TWE_BIO_UNIT(bp)               *(int *)((bp)->bio_dev->si_drv2)
 170 # define TWE_BIO_SET_ERROR(bp, err)     do { (bp)->bio_error = err; (bp)->bio_flags |= BIO_ERROR;} while(0)
 171 # define TWE_BIO_HAS_ERROR(bp)          ((bp)->bio_flags & BIO_ERROR)
 172 # define TWE_BIO_RESID(bp)              (bp)->bio_resid
 173 # define TWE_BIO_DONE(bp)               biodone(bp)
 174 # define TWE_BIO_STATS_START(bp)        devstat_start_transaction(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats)
 175 # define TWE_BIO_STATS_END(bp)          devstat_end_transaction_bio(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats, bp)
 176 #endif
 177
 178 #endif /* FreeBSD */
 179
 180 #ifndef TWE_SUPPORTED_PLATFORM
 181 #error platform not supported
 182 #endif