/* * Copyright (c) 2010, LSI Corp. * All rights reserved. * Author : Manjunath Ranganathaiah * Support: freebsdraid@lsi.com * * 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. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * 3. Neither the name of the nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 * COPYRIGHT HOLDER 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. * * $FreeBSD: src/sys/dev/tws/tws.h,v 1.3 2007/05/09 04:16:32 mrangana Exp $ */ #include /* defines used in kernel.h */ #include #include #include #include #include /* types used in module initialization */ #include /* cdevsw struct */ #include /* uio struct */ #include #include /* structs, prototypes for pci bus stuff */ #include #include #include #include /* For pci_get macros! */ #include #include #include #include #define TWS_PULL_MODE_ENABLE 1 MALLOC_DECLARE(M_TWS); /* externs */ extern int tws_queue_depth; #define TWS_DRIVER_VERSION_STRING "10.80.00.001" #define TWS_MAX_NUM_UNITS 65 #define TWS_MAX_NUM_LUNS 16 #define TWS_MAX_IRQS 2 #define TWS_SCSI_INITIATOR_ID 66 #define TWS_MAX_IO_SIZE 0x20000 /* 128kB */ #define TWS_SECTOR_SIZE 0x200 #define TWS_POLL_TIMEOUT 60 #define TWS_IO_TIMEOUT 60 #define TWS_RESET_TIMEOUT 60 #define TWS_PCI_BAR0 0x10 #define TWS_PCI_BAR1 0x14 #define TWS_PCI_BAR2 0x1C #define TWS_VENDOR_ID 0x13C1 #define TWS_DEVICE_ID 0x1010 #define TWS_INVALID_REQID 0xFFFF /* bus tag related */ #define TWS_ALIGNMENT 4 #define TWS_IN_MF_ALIGNMENT 16 #define TWS_OUT_MF_ALIGNMENT 4 #define TWS_MAX_32BIT_SG_ELEMENTS 93 /* max 32-bit sg elements */ #define TWS_MAX_64BIT_SG_ELEMENTS 46 /* max 64-bit sg elements */ #define TWS_MAX_QS 4 #define TWS_MAX_REQS 256 #define TWS_RESERVED_REQS 4 /* Request states */ #define TWS_REQ_STATE_TRAN 0 #define TWS_REQ_STATE_FREE 1 #define TWS_REQ_STATE_PENDING 2 #define TWS_REQ_STATE_BUSY 3 #define TWS_REQ_STATE_COMPLETE 4 /* Request types */ #define TWS_INTERNAL_CMD_REQ 0x0 #define TWS_AEN_FETCH_REQ 0x1 #define TWS_PASSTHRU_REQ 0x2 #define TWS_GETSET_PARAM_REQ 0x3 #define TWS_SCSI_IO_REQ 0x4 /* Driver states */ enum tws_states { TWS_INIT=50, TWS_UNINIT, TWS_OFFLINE, TWS_ONLINE, TWS_RESET, }; /* events */ enum tws_events { TWS_INIT_START=100, TWS_INIT_COMPLETE, TWS_UNINIT_START, TWS_RESET_START, TWS_RESET_COMPLETE, TWS_SCAN_FAILURE, }; enum tws_req_flags { TWS_DIR_UNKNOWN = 0x1, TWS_DIR_IN = 0x2, TWS_DIR_OUT = 0x4, TWS_DIR_NONE = 0x8, }; enum tws_intrs { TWS_INTx, TWS_MSI, TWS_MSIX, }; struct tws_msix_info { int tbl_res_id; bus_space_tag_t tbl_tag; bus_space_handle_t tbl_handle; struct resource *tbl_res; }; struct tws_ioctl_lock { u_int32_t lock; time_t timeout; }; #define TWS_TRACE_FNAME_LEN 10 #define TWS_TRACE_FUNC_LEN 15 #define TWS_TRACE_DESC_LEN 10 struct tws_trace_rec { struct timespec ts; char fname[TWS_TRACE_FNAME_LEN]; char func[TWS_TRACE_FUNC_LEN]; int linenum; char desc[TWS_TRACE_DESC_LEN]; u_int64_t val1; u_int64_t val2; }; struct tws_circular_q { volatile int16_t head; volatile int16_t tail; u_int16_t depth; u_int8_t overflow; void * q; }; struct tws_stats { u_int64_t reqs_in; u_int64_t reqs_out; u_int64_t reqs_errored; u_int64_t spurios_intrs; u_int64_t num_intrs; u_int64_t num_aens; u_int64_t ioctls; u_int64_t scsi_ios; }; struct tws_init_connect_info { u_int16_t working_srl; u_int16_t working_branch; u_int16_t working_build; u_int16_t fw_on_ctlr_srl; u_int16_t fw_on_ctlr_branch; u_int16_t fw_on_ctlr_build; }; /* ------------ boolean types ------------------- */ /* typedef enum _boolean { false, true } boolean; */ #define boolean _Bool enum err { SUCCESS, FAILURE }; /* ----------- per instance data ---------------- */ /* The softc holds our per-instance data. */ struct tws_softc { device_t tws_dev; /* bus device */ struct cdev *tws_cdev; /* controller device */ u_int32_t device_id; /* device id */ u_int32_t subvendor_id; /* device id */ u_int32_t subdevice_id; /* device id */ u_int8_t tws_state; /* driver state */ u_int8_t tws_prev_state; /* driver prev state */ struct sysctl_ctx_list tws_clist; /* sysctl context */ struct sysctl_oid *tws_oidp; /* sysctl context */ struct resource *reg_res; /* register interface window */ struct resource *mfa_res; /* mfa interface window */ int reg_res_id; /* register resource id */ int mfa_res_id; /* register resource id */ bus_space_handle_t bus_handle; /* bus space handle */ bus_space_handle_t bus_mfa_handle; /* bus space handle */ bus_space_tag_t bus_tag; /* bus space tag */ bus_space_tag_t bus_mfa_tag; /* bus space tag for mfa's */ u_int64_t mfa_base; /* mfa base address */ struct resource *irq_res; /* interrupt resource */ int irq_res_id; /* intr resource id */ void *intr_handle; /* interrupt handle */ struct tws_msix_info msix; /* msix info */ struct cam_sim *sim; /* sim for this controller */ struct cam_path *path; /* Ctlr path to CAM */ struct lock q_lock; /* queue lock */ struct lock sim_lock; /* sim lock */ struct lock gen_lock; /* general driver lock */ struct lock io_lock; /* IO lock */ struct tws_ioctl_lock ioctl_lock; /* ioctl lock */ u_int32_t seq_id; /* Sequence id */ int chan; /* wait channel */ struct tws_circular_q aen_q; /* aen q */ struct tws_circular_q trace_q; /* trace q */ struct tws_stats stats; /* I/O stats */ struct tws_init_connect_info cinfo; /* compatibility info */ boolean is64bit; /* True - 64bit else 32bit */ int intr_type; /* Interrupt type used */ bus_dma_tag_t parent_tag; /* parent DMA tag */ bus_dma_tag_t cmd_tag; /* command DMA tag */ bus_dmamap_t cmd_map; /* command map */ void *dma_mem; /* pointer to dmable memory */ u_int64_t dma_mem_phys; /* phy addr */ bus_dma_tag_t data_tag; /* data DMA tag */ struct tws_request *reqs; /* pointer to requests */ struct tws_sense *sense_bufs; /* pointer to sense buffers */ boolean obfl_q_overrun; /* OBFL overrun flag */ union ccb *scan_ccb; /* pointer to a ccb */ struct tws_request *q_head[TWS_MAX_QS]; /* head pointers to q's */ struct tws_request *q_tail[TWS_MAX_QS]; /* tail pointers to q's */ struct callout print_stats_handle; struct callout reset_cb_handle; struct callout reinit_handle; };