sys/dev/raid/hpt27xx/os_bsd.h

   1 /*-
   2  * Copyright (c) 2011 HighPoint Technologies, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/sys/dev/hpt27xx/os_bsd.h,v 1.1 2011/12/28 23:26:58 delphij Exp $
  27  */
  28
  29 #include <dev/raid/hpt27xx/hpt27xx_config.h>
  30
  31 #ifndef _OS_BSD_H
  32 #define _OS_BSD_H
  33
  34 #ifndef DBG
  35 #define  DBG    0
  36 #endif
  37
  38 #include <sys/param.h>
  39 #include <sys/types.h>
  40 #include <sys/cons.h>
  41 #include <sys/time.h>
  42 #include <sys/systm.h>
  43
  44 #include <sys/stat.h>
  45 #include <sys/malloc.h>
  46 #include <sys/conf.h>
  47 #include <sys/libkern.h>
  48 #include <sys/kernel.h>
  49
  50 #include <sys/kthread.h>
  51 #include <sys/module.h>
  52
  53 #include <sys/eventhandler.h>
  54 #include <sys/bus.h>
  55 #include <sys/taskqueue.h>
  56 #include <sys/ioccom.h>
  57 #include <sys/mplock2.h>
  58 #include <sys/device.h>
  59
  60 #include <bus/pci/pci_cfgreg.h>
  61 #include <machine/stdarg.h>
  62 #include <sys/rman.h>
  63
  64 #include <vm/vm.h>
  65 #include <vm/pmap.h>
  66
  67 #include <bus/pci/pcireg.h>
  68 #include <bus/pci/pcivar.h>
  69
  70 #if (__FreeBSD_version <= 500043)
  71 #include <sys/devicestat.h>
  72 #endif
  73
  74 #include <bus/cam/cam.h>
  75 #include <bus/cam/cam_ccb.h>
  76 #include <bus/cam/cam_sim.h>
  77 #include <bus/cam/cam_xpt_sim.h>
  78 #include <bus/cam/cam_debug.h>
  79 #include <bus/cam/cam_xpt_periph.h>
  80 #include <bus/cam/cam_periph.h>
  81 #include <bus/cam/scsi/scsi_all.h>
  82 #include <bus/cam/scsi/scsi_message.h>
  83
  84
  85
  86 typedef struct _INQUIRYDATA {
  87         u_char DeviceType : 5;
  88         u_char DeviceTypeQualifier : 3;
  89         u_char DeviceTypeModifier : 7;
  90         u_char RemovableMedia : 1;
  91         u_char Versions;
  92         u_char ResponseDataFormat;
  93         u_char AdditionalLength;
  94         u_char Reserved[2];
  95         u_char SoftReset : 1;
  96         u_char CommandQueue : 1;
  97         u_char Reserved2 : 1;
  98         u_char LinkedCommands : 1;
  99         u_char Synchronous : 1;
 100         u_char Wide16Bit : 1;
 101         u_char Wide32Bit : 1;
 102         u_char RelativeAddressing : 1;
 103         u_char VendorId[8];
 104         u_char ProductId[16];
 105         u_char ProductRevisionLevel[4];
 106         u_char VendorSpecific[20];
 107         u_char Reserved3[40];
 108 }
 109 __attribute__((packed))
 110 INQUIRYDATA, *PINQUIRYDATA;
 111
 112 #endif
 113
 114 /* private headers */
 115
 116 #include <dev/raid/hpt27xx/osm.h>
 117 #include <dev/raid/hpt27xx/him.h>
 118 #include <dev/raid/hpt27xx/ldm.h>
 119
 120 /* driver parameters */
 121 extern char driver_name[];
 122 extern char driver_name_long[];
 123 extern char driver_ver[];
 124 extern int  osm_max_targets;
 125
 126 /*
 127  * adapter/vbus extensions:
 128  * each physical controller has an adapter_ext, passed to him.create_adapter()
 129  * each vbus has a vbus_ext passed to ldm_create_vbus().
 130  */
 131 #define EXT_TYPE_HBA  1
 132 #define EXT_TYPE_VBUS 2
 133
 134 typedef struct _hba {
 135         int               ext_type;
 136         LDM_ADAPTER       ldm_adapter;
 137         device_t          pcidev;
 138         PCI_ADDRESS       pciaddr;
 139         struct _vbus_ext *vbus_ext;
 140         struct _hba      *next;
 141
 142         struct {
 143                 struct resource *res;
 144                 int type;
 145                 int rid;
 146                 void *base;
 147         }
 148         pcibar[6];
 149
 150         struct resource  *irq_res;
 151         void             *irq_handle;
 152 }
 153 HBA, *PHBA;
 154
 155 typedef struct _os_cmdext {
 156         struct _vbus_ext  *vbus_ext;
 157         struct _os_cmdext *next;
 158         union ccb         *ccb;
 159         bus_dmamap_t       dma_map;
 160         SG                 psg[os_max_sg_descriptors];
 161 }
 162 OS_CMDEXT, *POS_CMDEXT;
 163
 164 typedef struct _vbus_ext {
 165         int               ext_type;
 166         struct _vbus_ext *next;
 167         PHBA              hba_list;
 168         struct freelist  *freelist_head;
 169         struct freelist  *freelist_dma_head;
 170
 171         struct cam_sim   *sim;    /* sim for this vbus */
 172         struct cam_path  *path;   /* peripheral, path, tgt, lun with this vbus */
 173         struct lock       lock; /* general purpose lock */
 174         bus_dma_tag_t     io_dmat; /* I/O buffer DMA tag */
 175
 176         POS_CMDEXT        cmdext_list;
 177
 178         OSM_TASK         *tasks;
 179         struct task       worker;
 180
 181         struct callout    timer;
 182
 183         eventhandler_tag  shutdown_eh;
 184
 185         /* the LDM vbus instance continues */
 186         unsigned long vbus[0] __attribute__((aligned(sizeof(unsigned long))));
 187 }
 188 VBUS_EXT, *PVBUS_EXT;
 189
 190 #define hpt_lock_vbus(vbus_ext)   lockmgr(&(vbus_ext)->lock, LK_EXCLUSIVE)
 191 #define hpt_unlock_vbus(vbus_ext) lockmgr(&(vbus_ext)->lock, LK_RELEASE)
 192
 193 #define HPT27XX_DFLTPHYS  (64 * 1024)
 194
 195 #define HPT_OSM_TIMEOUT (20*hz)  /* timeout value for OS commands */
 196
 197 #define HPT_DO_IOCONTROL        _IOW('H', 0, HPT_IOCTL_PARAM)
 198
 199 #define HPT_SCAN_BUS            _IO('H', 1)
 200
 201 #define TASK_ENQUEUE(task)      taskqueue_enqueue(taskqueue_swi,(task));
 202
 203 static  __inline        int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
 204 {
 205         return  lksleep(ident, &vbus_ext->lock, priority, wmesg, timo);
 206 }