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$
27 */
28#include <dev/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#if (__FreeBSD_version >= 500000)
46#include <sys/time.h>
47#include <sys/systm.h>
48#else
49#include <machine/clock.h>	/*to support DELAY function under 4.x BSD versions*/
50#endif
51
52#include <sys/stat.h>
53#include <sys/malloc.h>
54#include <sys/conf.h>
55#include <sys/libkern.h>
56#include <sys/kernel.h>
57
58#if (__FreeBSD_version >= 500000)
59#include <sys/kthread.h>
60#include <sys/mutex.h>
61#include <sys/module.h>
62#endif
63
64#include <sys/eventhandler.h>
65#include <sys/bus.h>
66#include <sys/taskqueue.h>
67#include <sys/ioccom.h>
68
69#include <machine/resource.h>
70#include <machine/bus.h>
71#include <machine/stdarg.h>
72#include <sys/rman.h>
73
74#include <vm/vm.h>
75#include <vm/pmap.h>
76
77#if (__FreeBSD_version >= 500000)
78#include <dev/pci/pcireg.h>
79#include <dev/pci/pcivar.h>
80#else
81#include <pci/pcivar.h>
82#include <pci/pcireg.h>
83#endif
84
85#if (__FreeBSD_version <= 500043)
86#include <sys/devicestat.h>
87#endif
88
89#include <cam/cam.h>
90#include <cam/cam_ccb.h>
91#include <cam/cam_sim.h>
92#include <cam/cam_xpt_sim.h>
93#include <cam/cam_debug.h>
94#include <cam/cam_periph.h>
95#include <cam/scsi/scsi_all.h>
96#include <cam/scsi/scsi_message.h>
97
98#if (__FreeBSD_version < 500043)
99#include <sys/bus_private.h>
100#endif
101
102
103typedef struct _INQUIRYDATA {
104	u_char DeviceType : 5;
105	u_char DeviceTypeQualifier : 3;
106	u_char DeviceTypeModifier : 7;
107	u_char RemovableMedia : 1;
108	u_char Versions;
109	u_char ResponseDataFormat;
110	u_char AdditionalLength;
111	u_char Reserved[2];
112	u_char SoftReset : 1;
113	u_char CommandQueue : 1;
114	u_char Reserved2 : 1;
115	u_char LinkedCommands : 1;
116	u_char Synchronous : 1;
117	u_char Wide16Bit : 1;
118	u_char Wide32Bit : 1;
119	u_char RelativeAddressing : 1;
120	u_char VendorId[8];
121	u_char ProductId[16];
122	u_char ProductRevisionLevel[4];
123	u_char VendorSpecific[20];
124	u_char Reserved3[40];
125}
126__attribute__((packed))
127INQUIRYDATA, *PINQUIRYDATA;
128
129#endif
130
131/* private headers */
132
133#include <dev/hptrr/osm.h>
134#include <dev/hptrr/him.h>
135#include <dev/hptrr/ldm.h>
136
137/* driver parameters */
138extern char driver_name[];
139extern char driver_name_long[];
140extern char driver_ver[];
141extern int  osm_max_targets;
142
143/*
144 * adapter/vbus extensions:
145 * each physical controller has an adapter_ext, passed to him.create_adapter()
146 * each vbus has a vbus_ext passed to ldm_create_vbus().
147 */
148#define EXT_TYPE_HBA  1
149#define EXT_TYPE_VBUS 2
150
151typedef struct _hba {
152	int               ext_type;
153	LDM_ADAPTER       ldm_adapter;
154	device_t          pcidev;
155	PCI_ADDRESS       pciaddr;
156	struct _vbus_ext *vbus_ext;
157	struct _hba      *next;
158
159	struct {
160		struct resource *res;
161		int type;
162		int rid;
163		void *base;
164	}
165	pcibar[6];
166
167	struct resource  *irq_res;
168	void             *irq_handle;
169}
170HBA, *PHBA;
171
172typedef struct _os_cmdext {
173	struct _vbus_ext  *vbus_ext;
174	struct _os_cmdext *next;
175	union ccb         *ccb;
176	bus_dmamap_t       dma_map;
177	struct callout_handle timeout_ch;
178	SG                 psg[os_max_sg_descriptors];
179}
180OS_CMDEXT, *POS_CMDEXT;
181
182typedef struct _vbus_ext {
183	int               ext_type;
184	struct _vbus_ext *next;
185	PHBA              hba_list;
186	struct freelist  *freelist_head;
187	struct freelist  *freelist_dma_head;
188
189	struct cam_sim   *sim;    /* sim for this vbus */
190	struct cam_path  *path;   /* peripheral, path, tgt, lun with this vbus */
191#if (__FreeBSD_version >= 500000)
192	struct mtx        lock; /* general purpose lock */
193#else
194	int  			hpt_splx;
195#endif
196	bus_dma_tag_t     io_dmat; /* I/O buffer DMA tag */
197
198	POS_CMDEXT        cmdext_list;
199
200	OSM_TASK         *tasks;
201	struct task       worker;
202
203	struct callout_handle timer;
204
205	eventhandler_tag  shutdown_eh;
206
207	/* the LDM vbus instance continues */
208	unsigned long vbus[0] __attribute__((aligned(sizeof(unsigned long))));
209}
210VBUS_EXT, *PVBUS_EXT;
211
212#if __FreeBSD_version >= 500000
213#define hpt_lock_vbus(vbus_ext)   mtx_lock(&(vbus_ext)->lock)
214#define hpt_unlock_vbus(vbus_ext) mtx_unlock(&(vbus_ext)->lock)
215#else
216static __inline	void	hpt_lock_vbus(PVBUS_EXT	vbus_ext)
217{
218	vbus_ext->hpt_splx = splcam();
219}
220static __inline	void	hpt_unlock_vbus(PVBUS_EXT vbus_ext)
221{
222	splx(vbus_ext->hpt_splx);
223}
224#endif
225
226
227#define HPT_OSM_TIMEOUT (20*hz)  /* timeout value for OS commands */
228
229#define HPT_DO_IOCONTROL	_IOW('H', 0, HPT_IOCTL_PARAM)
230
231#define HPT_SCAN_BUS		_IO('H', 1)
232
233#if __FreeBSD_version >= 501000
234#define TASK_ENQUEUE(task)	taskqueue_enqueue(taskqueue_swi_giant,(task));
235#else
236#define TASK_ENQUEUE(task)	taskqueue_enqueue(taskqueue_swi,(task));
237#endif
238
239#if __FreeBSD_version >= 500000
240static	__inline	int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
241{
242	return	msleep(ident, &vbus_ext->lock, priority, wmesg, timo);
243}
244#else
245static	__inline	int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
246{
247	int retval = 0;
248
249	asleep(ident, priority, wmesg, timo);
250	hpt_unlock_vbus(vbus_ext);
251	retval = await(priority, timo);
252	hpt_lock_vbus(vbus_ext);
253
254	return retval;
255}
256#endif
257
258#if __FreeBSD_version < 501000
259#define	READ_16				0x88
260#define WRITE_16			0x8a
261#define SERVICE_ACTION_IN	0x9e
262#endif
263
264#define	HPT_DEV_MAJOR	200
265