1 /*
2 * Copyright (c) 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: head/sys/dev/hptrr/os_bsd.h 269615 2014-08-05 23:47:26Z jhb $
27 */
28 #include <dev/raid/hptrr/hptrr_config.h>
29 /* $Id: os_bsd.h,v 1.18 2006/04/11 08:19:02 gmm Exp $
30 *
31 * HighPoint RAID Driver for FreeBSD
32 * Copyright (C) 2005 HighPoint Technologies, Inc. All Rights Reserved.
33 */
34
35 #ifndef _OS_BSD_H
36 #define _OS_BSD_H
37
38 #ifndef DBG
39 #define DBG 0
40 #endif
41
42 #include <sys/param.h>
43 #include <sys/types.h>
44 #include <sys/cons.h>
45 #include <sys/time.h>
46 #include <sys/systm.h>
47
48 #include <sys/stat.h>
49 #include <sys/malloc.h>
50 #include <sys/conf.h>
51 #include <sys/kernel.h>
52
53 #include <sys/kthread.h>
54 #include <sys/module.h>
55
56 #include <sys/eventhandler.h>
57 #include <sys/bus.h>
58 #include <sys/device.h>
59 #include <sys/taskqueue.h>
60 #include <sys/ioccom.h>
61
62 #include <sys/rman.h>
63
64 #include <vm/vm.h>
65 #include <vm/pmap.h>
66
67 #include <bus/pci/pcivar.h>
68 #include <bus/pci/pcireg.h>
69
70 #include <bus/cam/cam.h>
71 #include <bus/cam/cam_ccb.h>
72 #include <bus/cam/cam_sim.h>
73 #include <bus/cam/cam_xpt_periph.h>
74 #include <bus/cam/cam_xpt_sim.h>
75 #include <bus/cam/cam_debug.h>
76 #include <bus/cam/cam_periph.h>
77 #include <bus/cam/scsi/scsi_all.h>
78 #include <bus/cam/scsi/scsi_message.h>
79
80
81
82 typedef struct _INQUIRYDATA {
83 u_char DeviceType : 5;
84 u_char DeviceTypeQualifier : 3;
85 u_char DeviceTypeModifier : 7;
86 u_char RemovableMedia : 1;
87 u_char Versions;
88 u_char ResponseDataFormat;
89 u_char AdditionalLength;
90 u_char Reserved[2];
91 u_char SoftReset : 1;
92 u_char CommandQueue : 1;
93 u_char Reserved2 : 1;
94 u_char LinkedCommands : 1;
95 u_char Synchronous : 1;
96 u_char Wide16Bit : 1;
97 u_char Wide32Bit : 1;
98 u_char RelativeAddressing : 1;
99 u_char VendorId[8];
100 u_char ProductId[16];
101 u_char ProductRevisionLevel[4];
102 u_char VendorSpecific[20];
103 u_char Reserved3[40];
104 }
105 __attribute__((packed))
106 INQUIRYDATA, *PINQUIRYDATA;
107
108 #endif
109
110 /* private headers */
111
112 #include <dev/raid/hptrr/osm.h>
113 #include <dev/raid/hptrr/him.h>
114 #include <dev/raid/hptrr/ldm.h>
115
116 /* driver parameters */
117 extern char driver_name[];
118 extern char driver_name_long[];
119 extern char driver_ver[];
120 extern int osm_max_targets;
121
122 /*
123 * adapter/vbus extensions:
124 * each physical controller has an adapter_ext, passed to him.create_adapter()
125 * each vbus has a vbus_ext passed to ldm_create_vbus().
126 */
127 #define EXT_TYPE_HBA 1
128 #define EXT_TYPE_VBUS 2
129
130 typedef struct _hba {
131 int ext_type;
132 LDM_ADAPTER ldm_adapter;
133 device_t pcidev;
134 PCI_ADDRESS pciaddr;
135 struct _vbus_ext *vbus_ext;
136 struct _hba *next;
137
138 struct {
139 struct resource *res;
140 int type;
141 int rid;
142 void *base;
143 }
144 pcibar[6];
145
146 struct resource *irq_res;
147 void *irq_handle;
148 }
149 HBA, *PHBA;
150
151 typedef struct _os_cmdext {
152 struct _vbus_ext *vbus_ext;
153 struct _os_cmdext *next;
154 union ccb *ccb;
155 bus_dmamap_t dma_map;
156 struct callout timeout;
157 SG psg[os_max_sg_descriptors];
158 }
159 OS_CMDEXT, *POS_CMDEXT;
160
161 typedef struct _vbus_ext {
162 int ext_type;
163 struct _vbus_ext *next;
164 PHBA hba_list;
165 struct freelist *freelist_head;
166 struct freelist *freelist_dma_head;
167
168 struct cam_sim *sim; /* sim for this vbus */
169 struct cam_path *path; /* peripheral, path, tgt, lun with this vbus */
170 struct lock lock; /* general purpose lock */
171 bus_dma_tag_t io_dmat; /* I/O buffer DMA tag */
172
173 POS_CMDEXT cmdext_list;
174
175 OSM_TASK *tasks;
176 struct task worker;
177
178 struct callout timer;
179
180 eventhandler_tag shutdown_eh;
181
182 /* the LDM vbus instance continues */
183 unsigned long vbus[0] __attribute__((aligned(sizeof(unsigned long))));
184 }
185 VBUS_EXT, *PVBUS_EXT;
186
187 #define hpt_lock_vbus(vbus_ext) lockmgr(&(vbus_ext)->lock, LK_EXCLUSIVE)
188 #define hpt_unlock_vbus(vbus_ext) lockmgr(&(vbus_ext)->lock, LK_RELEASE)
189 #define hpt_assert_vbus_locked(vbus_ext) KKASSERT(lockstatus(&(vbus_ext)->lock, curthread) == LK_EXCLUSIVE)
190
191 #define HPTRR_DFLTPHYS (64 * 1024)
192
193 #define HPT_OSM_TIMEOUT (20*hz) /* timeout value for OS commands */
194
195 #define HPT_DO_IOCONTROL _IOW('H', 0, HPT_IOCTL_PARAM)
196
197 #define HPT_SCAN_BUS _IO('H', 1)
198
199 #define TASK_ENQUEUE(task) taskqueue_enqueue(taskqueue_swi,(task));
200
hpt_sleep(PVBUS_EXT vbus_ext,void * ident,int priority,const char * wmesg,int timo)201 static __inline int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
202 {
203 return lksleep(ident, &vbus_ext->lock, priority, wmesg, timo);
204 }
205