os_bsd.h revision 331722
1/*-
2 * Copyright (c) 2005-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: stable/11/sys/dev/hpt27xx/os_bsd.h 331722 2018-03-29 02:50:57Z eadler $
27 */
28
29#include <dev/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/mutex.h>
52#include <sys/module.h>
53
54#include <sys/eventhandler.h>
55#include <sys/bus.h>
56#include <sys/taskqueue.h>
57#include <sys/ioccom.h>
58
59#include <machine/resource.h>
60#include <machine/pci_cfgreg.h>
61#include <machine/bus.h>
62#include <machine/stdarg.h>
63#include <sys/rman.h>
64
65#include <vm/vm.h>
66#include <vm/pmap.h>
67
68#include <dev/pci/pcireg.h>
69#include <dev/pci/pcivar.h>
70
71#include <cam/cam.h>
72#include <cam/cam_ccb.h>
73#include <cam/cam_sim.h>
74#include <cam/cam_xpt_sim.h>
75#include <cam/cam_debug.h>
76#include <cam/cam_xpt_periph.h>
77#include <cam/cam_periph.h>
78#include <cam/scsi/scsi_all.h>
79#include <cam/scsi/scsi_message.h>
80
81
82typedef 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))
106INQUIRYDATA, *PINQUIRYDATA;
107
108#endif
109
110/* private headers */
111
112#include <dev/hpt27xx/osm.h>
113#include <dev/hpt27xx/him.h>
114#include <dev/hpt27xx/ldm.h>
115
116/* driver parameters */
117extern const char driver_name[];
118extern const char driver_name_long[];
119extern const char driver_ver[];
120extern 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
130typedef 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}
149HBA, *PHBA;
150
151typedef 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#if (__FreeBSD_version >= 1000510)
157	struct callout     timeout;
158#endif
159	SG                 psg[os_max_sg_descriptors];
160}
161OS_CMDEXT, *POS_CMDEXT;
162
163typedef struct _vbus_ext {
164	int               ext_type;
165	struct _vbus_ext *next;
166	PHBA              hba_list;
167	struct freelist  *freelist_head;
168	struct freelist  *freelist_dma_head;
169
170	struct cam_sim   *sim;    /* sim for this vbus */
171	struct cam_path  *path;   /* peripheral, path, tgt, lun with this vbus */
172	struct mtx        lock; /* general purpose lock */
173	bus_dma_tag_t     io_dmat; /* I/O buffer DMA tag */
174
175	POS_CMDEXT        cmdext_list;
176
177	OSM_TASK         *tasks;
178	struct task       worker;
179#if (__FreeBSD_version >= 1000510)
180	struct callout    timer;
181#else
182	struct callout_handle timer;
183#endif
184	eventhandler_tag  shutdown_eh;
185
186	/* the LDM vbus instance continues */
187	unsigned long vbus[0] __attribute__((aligned(sizeof(unsigned long))));
188}
189VBUS_EXT, *PVBUS_EXT;
190
191#define hpt_lock_vbus(vbus_ext)   mtx_lock(&(vbus_ext)->lock)
192#define hpt_unlock_vbus(vbus_ext) mtx_unlock(&(vbus_ext)->lock)
193#define	hpt_assert_vbus_locked(vbus_ext) mtx_assert(&(vbus_ext)->lock, MA_OWNED)
194
195
196#define HPT_OSM_TIMEOUT (20*hz)  /* timeout value for OS commands */
197
198#define HPT_DO_IOCONTROL	_IOW('H', 0, HPT_IOCTL_PARAM)
199
200#define HPT_SCAN_BUS		_IO('H', 1)
201
202#if __FreeBSD_version < 1000510
203#define TASK_ENQUEUE(task)	taskqueue_enqueue(taskqueue_swi_giant,(task));
204#else
205#define TASK_ENQUEUE(task)	taskqueue_enqueue(taskqueue_swi,(task));
206#endif
207
208static	__inline	int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
209{
210	return	msleep(ident, &vbus_ext->lock, priority, wmesg, timo);
211}
212
213