1 /* $Id: os_bsd.h,v 1.20 2010/05/11 03:12:11 lcn Exp $ */
3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * HighPoint RAID Driver for FreeBSD
6 * Copyright (C) 2005-2011 HighPoint Technologies, Inc. All Rights Reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include <dev/hptnr/hptnr_config.h>
42 #include <sys/param.h>
43 #include <sys/types.h>
46 #include <sys/systm.h>
49 #include <sys/malloc.h>
51 #include <sys/libkern.h>
52 #include <sys/kernel.h>
54 #include <sys/kthread.h>
55 #include <sys/mutex.h>
56 #include <sys/module.h>
58 #include <sys/eventhandler.h>
60 #include <sys/taskqueue.h>
61 #include <sys/ioccom.h>
63 #include <machine/resource.h>
64 #include <machine/pci_cfgreg.h>
65 #include <machine/bus.h>
66 #include <machine/stdarg.h>
72 #include <dev/pci/pcireg.h>
73 #include <dev/pci/pcivar.h>
76 #include <cam/cam_ccb.h>
77 #include <cam/cam_sim.h>
78 #include <cam/cam_xpt_sim.h>
79 #include <cam/cam_debug.h>
80 #include <cam/cam_xpt_periph.h>
81 #include <cam/cam_periph.h>
82 #include <cam/scsi/scsi_all.h>
83 #include <cam/scsi/scsi_message.h>
86 typedef struct _INQUIRYDATA {
87 u_char DeviceType : 5;
88 u_char DeviceTypeQualifier : 3;
89 u_char DeviceTypeModifier : 7;
90 u_char RemovableMedia : 1;
92 u_char ResponseDataFormat;
93 u_char AdditionalLength;
96 u_char CommandQueue : 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;
104 u_char ProductId[16];
105 u_char ProductRevisionLevel[4];
106 u_char VendorSpecific[20];
107 u_char Reserved3[40];
109 __attribute__((packed))
110 INQUIRYDATA, *PINQUIRYDATA;
114 /* private headers */
116 #include <dev/hptnr/osm.h>
117 #include <dev/hptnr/him.h>
118 #include <dev/hptnr/ldm.h>
120 /* driver parameters */
121 extern const char driver_name[];
122 extern const char driver_name_long[];
123 extern const char driver_ver[];
124 extern int osm_max_targets;
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().
131 #define EXT_TYPE_HBA 1
132 #define EXT_TYPE_VBUS 2
134 typedef struct _hba {
136 LDM_ADAPTER ldm_adapter;
139 struct _vbus_ext *vbus_ext;
143 struct resource *res;
150 struct resource *irq_res;
155 typedef struct _os_cmdext {
156 struct _vbus_ext *vbus_ext;
157 struct _os_cmdext *next;
159 bus_dmamap_t dma_map;
160 struct callout timeout;
161 SG psg[os_max_sg_descriptors];
163 OS_CMDEXT, *POS_CMDEXT;
165 typedef struct _vbus_ext {
167 struct _vbus_ext *next;
169 struct freelist *freelist_head;
170 struct freelist *freelist_dma_head;
172 struct cam_sim *sim; /* sim for this vbus */
173 struct cam_path *path; /* peripheral, path, tgt, lun with this vbus */
174 struct mtx lock; /* general purpose lock */
175 bus_dma_tag_t io_dmat; /* I/O buffer DMA tag */
177 POS_CMDEXT cmdext_list;
182 struct callout timer;
184 eventhandler_tag shutdown_eh;
186 /* the LDM vbus instance continues */
187 unsigned long vbus[0] __attribute__((aligned(sizeof(unsigned long))));
189 VBUS_EXT, *PVBUS_EXT;
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)
196 #define HPT_OSM_TIMEOUT (120*hz) /* timeout value for OS commands */
198 #define HPT_DO_IOCONTROL _IOW('H', 0, HPT_IOCTL_PARAM)
200 #define HPT_SCAN_BUS _IO('H', 1)
202 #define TASK_ENQUEUE(task) taskqueue_enqueue(taskqueue_swi,(task));
204 static __inline int hpt_sleep(PVBUS_EXT vbus_ext, void *ident, int priority, const char *wmesg, int timo)
206 return msleep(ident, &vbus_ext->lock, priority, wmesg, timo);