twe_compat.h revision 118508
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: head/sys/dev/twe/twe_compat.h 118508 2003-08-05 19:55:21Z ps $ 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#include <sys/sysctl.h> 44 45#include <sys/bus.h> 46#include <sys/conf.h> 47#include <sys/disk.h> 48#include <sys/stat.h> 49 50#include <machine/bus_pio.h> 51#include <machine/bus.h> 52#include <machine/resource.h> 53#include <sys/rman.h> 54 55#include <pci/pcireg.h> 56#include <pci/pcivar.h> 57 58/* 59 * These macros allows us to build a version of the driver which can 60 * safely be loaded into a kernel which already contains a 'twe' driver, 61 * and which will override it in all things. 62 * 63 * All public symbols must be listed here. 64 */ 65#ifdef TWE_OVERRIDE 66#define twe_setup Xtwe_setup 67#define twe_init Xtwe_init 68#define twe_deinit Xtwe_deinit 69#define twe_intr Xtwe_intr 70#define twe_submit_bio Xtwe_submit_bio 71#define twe_ioctl Xtwe_ioctl 72#define twe_describe_controller Xtwe_describe_controller 73#define twe_print_controller Xtwe_print_controller 74#define twe_enable_interrupts Xtwe_enable_interrupts 75#define twe_disable_interrupts Xtwe_disable_interrupts 76#define twe_attach_drive Xtwe_attach_drive 77#define twed_intr Xtwed_intr 78#define twe_allocate_request Xtwe_allocate_request 79#define twe_free_request Xtwe_free_request 80#define twe_map_request Xtwe_map_request 81#define twe_unmap_request Xtwe_unmap_request 82#define twe_describe_code Xtwe_describe_code 83#define twe_table_status Xtwe_table_status 84#define twe_table_unitstate Xtwe_table_unitstate 85#define twe_table_unittype Xtwe_table_unittype 86#define twe_table_aen Xtwe_table_aen 87#define TWE_DRIVER_NAME Xtwe 88#define TWED_DRIVER_NAME Xtwed 89#define TWE_MALLOC_CLASS M_XTWE 90#else 91#define TWE_DRIVER_NAME twe 92#define TWED_DRIVER_NAME twed 93#define TWE_MALLOC_CLASS M_TWE 94#endif 95 96/* 97 * Wrappers for bus-space actions 98 */ 99#define TWE_CONTROL(sc, val) bus_space_write_4((sc)->twe_btag, (sc)->twe_bhandle, 0x0, (u_int32_t)val) 100#define TWE_STATUS(sc) (u_int32_t)bus_space_read_4((sc)->twe_btag, (sc)->twe_bhandle, 0x4) 101#define TWE_COMMAND_QUEUE(sc, val) bus_space_write_4((sc)->twe_btag, (sc)->twe_bhandle, 0x8, (u_int32_t)val) 102#define TWE_RESPONSE_QUEUE(sc) (TWE_Response_Queue)bus_space_read_4((sc)->twe_btag, (sc)->twe_bhandle, 0xc) 103 104/* 105 * FreeBSD-specific softc elements 106 */ 107#define TWE_PLATFORM_SOFTC \ 108 device_t twe_dev; /* bus device */ \ 109 dev_t twe_dev_t; /* control device */ \ 110 struct resource *twe_io; /* register interface window */ \ 111 bus_space_handle_t twe_bhandle; /* bus space handle */ \ 112 bus_space_tag_t twe_btag; /* bus space tag */ \ 113 bus_dma_tag_t twe_parent_dmat; /* parent DMA tag */ \ 114 bus_dma_tag_t twe_buffer_dmat; /* data buffer DMA tag */ \ 115 struct resource *twe_irq; /* interrupt */ \ 116 void *twe_intr; /* interrupt handle */ \ 117 struct intr_config_hook twe_ich; /* delayed-startup hook */ \ 118 struct sysctl_ctx_list sysctl_ctx; \ 119 struct sysctl_oid *sysctl_tree; 120 121/* 122 * FreeBSD-specific request elements 123 */ 124#define TWE_PLATFORM_REQUEST \ 125 bus_dmamap_t tr_cmdmap; /* DMA map for command */ \ 126 u_int32_t tr_cmdphys; /* address of command in controller space */ \ 127 bus_dmamap_t tr_dmamap; /* DMA map for data */ \ 128 u_int32_t tr_dataphys; /* data buffer base address in controller space */ 129 130/* 131 * Output identifying the controller/disk 132 */ 133#define twe_printf(sc, fmt, args...) device_printf(sc->twe_dev, fmt , ##args) 134#define twed_printf(twed, fmt, args...) device_printf(twed->twed_dev, fmt , ##args) 135 136#if __FreeBSD_version < 500003 137# include <machine/clock.h> 138# define INTR_ENTROPY 0 139 140# include <sys/buf.h> /* old buf style */ 141typedef struct buf twe_bio; 142typedef struct buf_queue_head twe_bioq; 143# define TWE_BIO_QINIT(bq) bufq_init(&bq); 144# define TWE_BIO_QINSERT(bq, bp) bufq_insert_tail(&bq, bp) 145# define TWE_BIO_QFIRST(bq) bufq_first(&bq) 146# define TWE_BIO_QREMOVE(bq, bp) bufq_remove(&bq, bp) 147# define TWE_BIO_IS_READ(bp) ((bp)->b_flags & B_READ) 148# define TWE_BIO_DATA(bp) (bp)->b_data 149# define TWE_BIO_LENGTH(bp) (bp)->b_bcount 150# define TWE_BIO_LBA(bp) (bp)->b_pblkno 151# define TWE_BIO_SOFTC(bp) (bp)->b_dev->si_drv1 152# define TWE_BIO_UNIT(bp) *(int *)((bp)->b_dev->si_drv2) 153# define TWE_BIO_SET_ERROR(bp, err) do { (bp)->b_error = err; (bp)->b_flags |= B_ERROR;} while(0) 154# define TWE_BIO_HAS_ERROR(bp) ((bp)->b_flags & B_ERROR) 155# define TWE_BIO_RESID(bp) (bp)->b_resid 156# define TWE_BIO_DONE(bp) biodone(bp) 157# define TWE_BIO_STATS_START(bp) devstat_start_transaction(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats) 158# define TWE_BIO_STATS_END(bp) devstat_end_transaction_buf(&((struct twed_softc *)TWE_BIO_SOFTC(bp))->twed_stats, bp) 159#else 160# include <sys/bio.h> 161typedef struct bio twe_bio; 162typedef struct bio_queue_head twe_bioq; 163# define TWE_BIO_QINIT(bq) bioq_init(&bq); 164# define TWE_BIO_QINSERT(bq, bp) bioq_insert_tail(&bq, bp) 165# define TWE_BIO_QFIRST(bq) bioq_first(&bq) 166# define TWE_BIO_QREMOVE(bq, bp) bioq_remove(&bq, bp) 167# define TWE_BIO_IS_READ(bp) ((bp)->bio_cmd == BIO_READ) 168# define TWE_BIO_DATA(bp) (bp)->bio_data 169# define TWE_BIO_LENGTH(bp) (bp)->bio_bcount 170# define TWE_BIO_LBA(bp) (bp)->bio_pblkno 171# define TWE_BIO_SOFTC(bp) (bp)->bio_disk->d_drv1 172# define TWE_BIO_UNIT(bp) *(int *)(bp->bio_driver1) 173# define TWE_BIO_SET_ERROR(bp, err) do { (bp)->bio_error = err; (bp)->bio_flags |= BIO_ERROR;} while(0) 174# define TWE_BIO_HAS_ERROR(bp) ((bp)->bio_flags & BIO_ERROR) 175# define TWE_BIO_RESID(bp) (bp)->bio_resid 176# define TWE_BIO_DONE(bp) biodone(bp) 177# define TWE_BIO_STATS_START(bp) 178# define TWE_BIO_STATS_END(bp) 179#endif 180 181#endif /* FreeBSD */ 182 183#ifndef TWE_SUPPORTED_PLATFORM 184#error platform not supported 185#endif 186