/* * FreeBSD platform specific driver option settings, data structures, * function declarations and includes. * * Copyright (c) 1994-2001 Justin T. Gibbs. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions, and the following disclaimer, * without modification. * 2. The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * Alternatively, this software may be distributed under the terms of the * GNU Public License ("GPL"). * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic7xxx_osm.h#15 $ * * $FreeBSD: src/sys/dev/aic7xxx/aic7xxx_osm.h,v 1.14.2.6 2003/06/10 03:26:09 gibbs Exp $ * $DragonFly: src/sys/dev/disk/aic7xxx/aic7xxx_osm.h,v 1.7 2005/08/25 23:37:35 dillon Exp $ */ #ifndef _AIC7XXX_FREEBSD_H_ #define _AIC7XXX_FREEBSD_H_ #include /* for config options */ #include #include #include /* For device_t */ #if defined(__FreeBSD__) && __FreeBSD_version >= 500000 #include #endif #include #include #include #include #include #if defined(__DragonFly__) || __FreeBSD_version < 500000 #include #else #define NPCI 1 #endif #if NPCI > 0 #define AHC_PCI_CONFIG 1 #include #endif #include #include #include #include #include #include #if NPCI > 0 #include #include #endif #include #include #include #include #include #include #include #ifdef CAM_NEW_TRAN_CODE #define AHC_NEW_TRAN_SETTINGS #endif /* CAM_NEW_TRAN_CODE */ /*************************** Attachment Bookkeeping ***************************/ extern devclass_t ahc_devclass; /****************************** Platform Macros *******************************/ #define SIM_IS_SCSIBUS_B(ahc, sim) \ ((sim) == ahc->platform_data->sim_b) #define SIM_CHANNEL(ahc, sim) \ (((sim) == ahc->platform_data->sim_b) ? 'B' : 'A') #define SIM_SCSI_ID(ahc, sim) \ (((sim) == ahc->platform_data->sim_b) ? ahc->our_id_b : ahc->our_id) #define SIM_PATH(ahc, sim) \ (((sim) == ahc->platform_data->sim_b) ? ahc->platform_data->path_b \ : ahc->platform_data->path) #define BUILD_SCSIID(ahc, sim, target_id, our_id) \ ((((target_id) << TID_SHIFT) & TID) | (our_id) \ | (SIM_IS_SCSIBUS_B(ahc, sim) ? TWIN_CHNLB : 0)) #define SCB_GET_SIM(ahc, scb) \ (SCB_GET_CHANNEL(ahc, scb) == 'A' ? (ahc)->platform_data->sim \ : (ahc)->platform_data->sim_b) #ifndef offsetof #define offsetof(type, member) ((size_t)(&((type *)0)->member)) #endif /************************* Forward Declarations *******************************/ typedef device_t ahc_dev_softc_t; typedef union ccb *ahc_io_ctx_t; /***************************** Bus Space/DMA **********************************/ #define ahc_dma_tag_create(ahc, parent_tag, alignment, boundary, \ lowaddr, highaddr, filter, filterarg, \ maxsize, nsegments, maxsegsz, flags, \ dma_tagp) \ bus_dma_tag_create(parent_tag, alignment, boundary, \ lowaddr, highaddr, filter, filterarg, \ maxsize, nsegments, maxsegsz, flags, \ dma_tagp) #define ahc_dma_tag_destroy(ahc, tag) \ bus_dma_tag_destroy(tag) #define ahc_dmamem_alloc(ahc, dmat, vaddr, flags, mapp) \ bus_dmamem_alloc(dmat, vaddr, flags, mapp) #define ahc_dmamem_free(ahc, dmat, vaddr, map) \ bus_dmamem_free(dmat, vaddr, map) #define ahc_dmamap_create(ahc, tag, flags, mapp) \ bus_dmamap_create(tag, flags, mapp) #define ahc_dmamap_destroy(ahc, tag, map) \ bus_dmamap_destroy(tag, map) #define ahc_dmamap_load(ahc, dmat, map, addr, buflen, callback, \ callback_arg, flags) \ bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags) #define ahc_dmamap_unload(ahc, tag, map) \ bus_dmamap_unload(tag, map) /* XXX Need to update Bus DMA for partial map syncs */ #define ahc_dmamap_sync(ahc, dma_tag, dmamap, offset, len, op) \ bus_dmamap_sync(dma_tag, dmamap, op) /************************ Tunable Driver Parameters **************************/ /* * The number of dma segments supported. The sequencer can handle any number * of physically contiguous S/G entrys. To reduce the driver's memory * consumption, we limit the number supported to be sufficient to handle * the largest mapping supported by the kernel, MAXPHYS. Assuming the * transfer is as fragmented as possible and unaligned, this turns out to * be the number of paged sized transfers in MAXPHYS plus an extra element * to handle any unaligned residual. The sequencer fetches SG elements * in cacheline sized chucks, so make the number per-transaction an even * multiple of 16 which should align us on even the largest of cacheline * boundaries. */ #define AHC_NSEG (roundup(btoc(MAXPHYS) + 1, 16)) /* This driver supports target mode */ #define AHC_TARGET_MODE 1 /************************** Softc/SCB Platform Data ***************************/ struct ahc_platform_data { /* * Hooks into the XPT. */ struct cam_sim *sim; struct cam_sim *sim_b; struct cam_path *path; struct cam_path *path_b; int regs_res_type; int regs_res_id; int irq_res_type; struct resource *regs; struct resource *irq; void *ih; eventhandler_tag eh; }; struct scb_platform_data { }; /********************************* Byte Order *********************************/ #if defined(__FreeBSD__) && __FreeBSD_version >= 500000 #define ahc_htobe16(x) htobe16(x) #define ahc_htobe32(x) htobe32(x) #define ahc_htobe64(x) htobe64(x) #define ahc_htole16(x) htole16(x) #define ahc_htole32(x) htole32(x) #define ahc_htole64(x) htole64(x) #define ahc_be16toh(x) be16toh(x) #define ahc_be32toh(x) be32toh(x) #define ahc_be64toh(x) be64toh(x) #define ahc_le16toh(x) le16toh(x) #define ahc_le32toh(x) le32toh(x) #define ahc_le64toh(x) le64toh(x) #else #define ahc_htobe16(x) (x) #define ahc_htobe32(x) (x) #define ahc_htobe64(x) (x) #define ahc_htole16(x) (x) #define ahc_htole32(x) (x) #define ahc_htole64(x) (x) #define ahc_be16toh(x) (x) #define ahc_be32toh(x) (x) #define ahc_be64toh(x) (x) #define ahc_le16toh(x) (x) #define ahc_le32toh(x) (x) #define ahc_le64toh(x) (x) #endif /************************** Timer DataStructures ******************************/ typedef struct callout ahc_timer_t; /***************************** Core Includes **********************************/ #if AHC_REG_PRETTY_PRINT #define AIC_DEBUG_REGISTERS 1 #else #define AIC_DEBUG_REGISTERS 0 #endif #include "aic7xxx.h" /***************************** Timer Facilities *******************************/ timeout_t ahc_timeout; #if defined(__FreeBSD__) && __FreeBSD_version >= 500000 #define ahc_timer_init(timer) callout_init(timer, /*mpsafe*/0) #else #define ahc_timer_init callout_init #endif #define ahc_timer_stop callout_stop static __inline void ahc_timer_reset(ahc_timer_t *timer, u_int usec, ahc_callback_t *func, void *arg) { callout_reset(timer, (usec * hz)/1000000, func, arg); } static __inline void ahc_scb_timer_reset(struct scb *scb, u_int usec) { callout_reset(&scb->io_ctx->ccb_h.timeout_ch, (usec * hz)/1000000, ahc_timeout, scb); } /*************************** Device Access ************************************/ #define ahc_inb(ahc, port) \ bus_space_read_1((ahc)->tag, (ahc)->bsh, port) #define ahc_outb(ahc, port, value) \ bus_space_write_1((ahc)->tag, (ahc)->bsh, port, value) #define ahc_outsb(ahc, port, valp, count) \ bus_space_write_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) #define ahc_insb(ahc, port, valp, count) \ bus_space_read_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count) static __inline void ahc_flush_device_writes(struct ahc_softc *); static __inline void ahc_flush_device_writes(struct ahc_softc *ahc) { /* XXX Is this sufficient for all architectures??? */ ahc_inb(ahc, INTSTAT); } /**************************** Locking Primitives ******************************/ /* Lock protecting internal data structures */ static __inline void ahc_lockinit(struct ahc_softc *); static __inline void ahc_lock(struct ahc_softc *, unsigned long *flags); static __inline void ahc_unlock(struct ahc_softc *, unsigned long *flags); /* Lock held during command compeletion to the upper layer */ static __inline void ahc_done_lockinit(struct ahc_softc *); static __inline void ahc_done_lock(struct ahc_softc *, unsigned long *flags); static __inline void ahc_done_unlock(struct ahc_softc *, unsigned long *flags); /* Lock held during ahc_list manipulation and ahc softc frees */ static __inline void ahc_list_lockinit(void); static __inline void ahc_list_lock(unsigned long *flags); static __inline void ahc_list_unlock(unsigned long *flags); static __inline void ahc_lockinit(struct ahc_softc *ahc) { } static __inline void ahc_lock(struct ahc_softc *ahc, unsigned long *flags __unused) { crit_enter_id("ahc"); } static __inline void ahc_unlock(struct ahc_softc *ahc, unsigned long *flags __unused) { crit_exit_id("ahc"); } /* Lock held during command compeletion to the upper layer */ static __inline void ahc_done_lockinit(struct ahc_softc *ahc) { } static __inline void ahc_done_lock(struct ahc_softc *ahc, unsigned long *flags) { } static __inline void ahc_done_unlock(struct ahc_softc *ahc, unsigned long *flags) { } /* Lock held during ahc_list manipulation and ahc softc frees */ static __inline void ahc_list_lockinit(void) { } static __inline void ahc_list_lock(unsigned long *flags) { } static __inline void ahc_list_unlock(unsigned long *flags) { } /****************************** OS Primitives *********************************/ #define ahc_delay DELAY /************************** Transaction Operations ****************************/ static __inline void ahc_set_transaction_status(struct scb *, uint32_t); static __inline void ahc_set_scsi_status(struct scb *, uint32_t); static __inline uint32_t ahc_get_transaction_status(struct scb *); static __inline uint32_t ahc_get_scsi_status(struct scb *); static __inline void ahc_set_transaction_tag(struct scb *, int, u_int); static __inline u_long ahc_get_transfer_length(struct scb *); static __inline int ahc_get_transfer_dir(struct scb *); static __inline void ahc_set_residual(struct scb *, u_long); static __inline void ahc_set_sense_residual(struct scb *, u_long); static __inline u_long ahc_get_residual(struct scb *); static __inline int ahc_perform_autosense(struct scb *); static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc*, struct scb*); static __inline void ahc_freeze_ccb(union ccb *ccb); static __inline void ahc_freeze_scb(struct scb *scb); static __inline void ahc_platform_freeze_devq(struct ahc_softc *, struct scb *); static __inline int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, char channel, int lun, u_int tag, role_t role, uint32_t status); static __inline void ahc_set_transaction_status(struct scb *scb, uint32_t status) { scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK; scb->io_ctx->ccb_h.status |= status; } static __inline void ahc_set_scsi_status(struct scb *scb, uint32_t status) { scb->io_ctx->csio.scsi_status = status; } static __inline uint32_t ahc_get_transaction_status(struct scb *scb) { return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK); } static __inline uint32_t ahc_get_scsi_status(struct scb *scb) { return (scb->io_ctx->csio.scsi_status); } static __inline void ahc_set_transaction_tag(struct scb *scb, int enabled, u_int type) { scb->io_ctx->csio.tag_action = type; if (enabled) scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID; else scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID; } static __inline u_long ahc_get_transfer_length(struct scb *scb) { return (scb->io_ctx->csio.dxfer_len); } static __inline int ahc_get_transfer_dir(struct scb *scb) { return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK); } static __inline void ahc_set_residual(struct scb *scb, u_long resid) { scb->io_ctx->csio.resid = resid; } static __inline void ahc_set_sense_residual(struct scb *scb, u_long resid) { scb->io_ctx->csio.sense_resid = resid; } static __inline u_long ahc_get_residual(struct scb *scb) { return (scb->io_ctx->csio.resid); } static __inline int ahc_perform_autosense(struct scb *scb) { return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE)); } static __inline uint32_t ahc_get_sense_bufsize(struct ahc_softc *ahc, struct scb *scb) { return (sizeof(struct scsi_sense_data)); } static __inline void ahc_freeze_ccb(union ccb *ccb) { if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) { ccb->ccb_h.status |= CAM_DEV_QFRZN; xpt_freeze_devq(ccb->ccb_h.path, /*count*/1); } } static __inline void ahc_freeze_scb(struct scb *scb) { ahc_freeze_ccb(scb->io_ctx); } static __inline void ahc_platform_freeze_devq(struct ahc_softc *ahc, struct scb *scb) { /* Nothing to do here for FreeBSD */ } static __inline int ahc_platform_abort_scbs(struct ahc_softc *ahc, int target, char channel, int lun, u_int tag, role_t role, uint32_t status) { /* Nothing to do here for FreeBSD */ return (0); } static __inline void ahc_platform_scb_free(struct ahc_softc *ahc, struct scb *scb) { /* What do we do to generically handle driver resource shortages??? */ if ((ahc->flags & AHC_RESOURCE_SHORTAGE) != 0 && scb->io_ctx != NULL && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) { scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ; ahc->flags &= ~AHC_RESOURCE_SHORTAGE; } scb->io_ctx = NULL; } /********************************** PCI ***************************************/ #ifdef AHC_PCI_CONFIG static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width); static __inline void ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width); static __inline int ahc_get_pci_function(ahc_dev_softc_t); static __inline int ahc_get_pci_slot(ahc_dev_softc_t); static __inline int ahc_get_pci_bus(ahc_dev_softc_t); int ahc_pci_map_registers(struct ahc_softc *ahc); int ahc_pci_map_int(struct ahc_softc *ahc); static __inline uint32_t ahc_pci_read_config(ahc_dev_softc_t pci, int reg, int width) { return (pci_read_config(pci, reg, width)); } static __inline void ahc_pci_write_config(ahc_dev_softc_t pci, int reg, uint32_t value, int width) { pci_write_config(pci, reg, value, width); } static __inline int ahc_get_pci_function(ahc_dev_softc_t pci) { return (pci_get_function(pci)); } static __inline int ahc_get_pci_slot(ahc_dev_softc_t pci) { return (pci_get_slot(pci)); } static __inline int ahc_get_pci_bus(ahc_dev_softc_t pci) { return (pci_get_bus(pci)); } typedef enum { AHC_POWER_STATE_D0, AHC_POWER_STATE_D1, AHC_POWER_STATE_D2, AHC_POWER_STATE_D3 } ahc_power_state; void ahc_power_state_change(struct ahc_softc *ahc, ahc_power_state new_state); #endif /******************************** VL/EISA *************************************/ int aic7770_map_registers(struct ahc_softc *ahc, u_int port); int aic7770_map_int(struct ahc_softc *ahc, int irq); /********************************* Debug **************************************/ static __inline void ahc_print_path(struct ahc_softc *, struct scb *); static __inline void ahc_platform_dump_card_state(struct ahc_softc *ahc); static __inline void ahc_print_path(struct ahc_softc *ahc, struct scb *scb) { xpt_print_path(scb->io_ctx->ccb_h.path); } static __inline void ahc_platform_dump_card_state(struct ahc_softc *ahc) { /* Nothing to do here for FreeBSD */ } /**************************** Transfer Settings *******************************/ void ahc_notify_xfer_settings_change(struct ahc_softc *, struct ahc_devinfo *); void ahc_platform_set_tags(struct ahc_softc *, struct ahc_devinfo *, int /*enable*/); /************************* Initialization/Teardown ****************************/ int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg); void ahc_platform_free(struct ahc_softc *ahc); int ahc_map_int(struct ahc_softc *ahc); int ahc_attach(struct ahc_softc *); int ahc_softc_comp(struct ahc_softc *lahc, struct ahc_softc *rahc); int ahc_detach(device_t); /****************************** Interrupts ************************************/ void ahc_platform_intr(void *); static __inline void ahc_platform_flushwork(struct ahc_softc *ahc); static __inline void ahc_platform_flushwork(struct ahc_softc *ahc) { } /************************ Misc Function Declarations **************************/ void ahc_done(struct ahc_softc *ahc, struct scb *scb); void ahc_send_async(struct ahc_softc *, char /*channel*/, u_int /*target*/, u_int /*lun*/, ac_code, void *arg); #endif /* _AIC7XXX_FREEBSD_H_ */