aic79xx_osm.h revision 102685 
1/*
2 * FreeBSD platform specific driver option settings, data structures,
3 * function declarations and includes.
4 *
5 * Copyright (c) 1994-2001 Justin T. Gibbs.
6 * Copyright (c) 2001-2002 Adaptec Inc.
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions, and the following disclaimer,
14 *    without modification.
15 * 2. The name of the author may not be used to endorse or promote products
16 *    derived from this software without specific prior written permission.
17 *
18 * Alternatively, this software may be distributed under the terms of the
19 * GNU Public License ("GPL").
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic79xx_osm.h#14 $
34 *
35 * $FreeBSD: head/sys/dev/aic7xxx/aic79xx_osm.h 102685 2002-08-31 06:51:51Z gibbs $
36 */
37
38#ifndef _AIC79XX_FREEBSD_H_
39#define _AIC79XX_FREEBSD_H_
40
41#include <opt_aic79xx.h>	/* for config options */
42
43#include <sys/param.h>
44#include <sys/systm.h>
45#include <sys/bus.h>		/* For device_t */
46#if __FreeBSD_version >= 500000
47#include <sys/endian.h>
48#endif
49#include <sys/eventhandler.h>
50#include <sys/kernel.h>
51#include <sys/malloc.h>
52#include <sys/queue.h>
53
54#define AHD_PCI_CONFIG 1
55#include <machine/bus_memio.h>
56#include <machine/bus_pio.h>
57#include <machine/bus.h>
58#include <machine/endian.h>
59#include <machine/clock.h>
60#include <machine/resource.h>
61
62#include <sys/rman.h>
63
64#include <pci/pcireg.h>
65#include <pci/pcivar.h>
66
67#include <cam/cam.h>
68#include <cam/cam_ccb.h>
69#include <cam/cam_debug.h>
70#include <cam/cam_sim.h>
71#include <cam/cam_xpt_sim.h>
72
73#include <cam/scsi/scsi_all.h>
74#include <cam/scsi/scsi_message.h>
75#include <cam/scsi/scsi_iu.h>
76
77#ifdef CAM_NEW_TRAN_CODE
78#define AHD_NEW_TRAN_SETTINGS
79#endif /* CAM_NEW_TRAN_CODE */
80
81/****************************** Platform Macros *******************************/
82#define	SIM_IS_SCSIBUS_B(ahd, sim)	\
83	(0)
84#define	SIM_CHANNEL(ahd, sim)	\
85	('A')
86#define	SIM_SCSI_ID(ahd, sim)	\
87	(ahd->our_id)
88#define	SIM_PATH(ahd, sim)	\
89	(ahd->platform_data->path)
90#define BUILD_SCSIID(ahd, sim, target_id, our_id) \
91        ((((target_id) << TID_SHIFT) & TID) | (our_id))
92
93
94#define SCB_GET_SIM(ahd, scb) \
95	((ahd)->platform_data->sim)
96
97#ifndef offsetof
98#define offsetof(type, member)  ((size_t)(&((type *)0)->member))
99#endif
100/************************* Forward Declarations *******************************/
101typedef device_t ahd_dev_softc_t;
102typedef union ccb *ahd_io_ctx_t;
103
104/***************************** Bus Space/DMA **********************************/
105#define ahd_dma_tag_create(ahd, parent_tag, alignment, boundary,	\
106			   lowaddr, highaddr, filter, filterarg,	\
107			   maxsize, nsegments, maxsegsz, flags,		\
108			   dma_tagp)					\
109	bus_dma_tag_create(parent_tag, alignment, boundary,		\
110			   lowaddr, highaddr, filter, filterarg,	\
111			   maxsize, nsegments, maxsegsz, flags,		\
112			   dma_tagp)
113
114#define ahd_dma_tag_destroy(ahd, tag)					\
115	bus_dma_tag_destroy(tag)
116
117#define ahd_dmamem_alloc(ahd, dmat, vaddr, flags, mapp)			\
118	bus_dmamem_alloc(dmat, vaddr, flags, mapp)
119
120#define ahd_dmamem_free(ahd, dmat, vaddr, map)				\
121	bus_dmamem_free(dmat, vaddr, map)
122
123#define ahd_dmamap_create(ahd, tag, flags, mapp)			\
124	bus_dmamap_create(tag, flags, mapp)
125
126#define ahd_dmamap_destroy(ahd, tag, map)				\
127	bus_dmamap_destroy(tag, map)
128
129#define ahd_dmamap_load(ahd, dmat, map, addr, buflen, callback,		\
130			callback_arg, flags)				\
131	bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags)
132
133#define ahd_dmamap_unload(ahd, tag, map)				\
134	bus_dmamap_unload(tag, map)
135
136/* XXX Need to update Bus DMA for partial map syncs */
137#define ahd_dmamap_sync(ahd, dma_tag, dmamap, offset, len, op)		\
138	bus_dmamap_sync(dma_tag, dmamap, op)
139
140/************************ Tunable Driver Parameters  **************************/
141/*
142 * The number of dma segments supported.  The sequencer can handle any number
143 * of physically contiguous S/G entrys.  To reduce the driver's memory
144 * consumption, we limit the number supported to be sufficient to handle
145 * the largest mapping supported by the kernel, MAXPHYS.  Assuming the
146 * transfer is as fragmented as possible and unaligned, this turns out to
147 * be the number of paged sized transfers in MAXPHYS plus an extra element
148 * to handle any unaligned residual.  The sequencer fetches SG elements
149 * in cacheline sized chucks, so make the number per-transaction an even
150 * multiple of 16 which should align us on even the largest of cacheline
151 * boundaries.
152 */
153#define AHD_NSEG (roundup(btoc(MAXPHYS) + 1, 16))
154
155/* This driver supports target mode */
156#if NOT_YET
157#define AHD_TARGET_MODE 1
158#endif
159
160/************************** Softc/SCB Platform Data ***************************/
161struct ahd_platform_data {
162	/*
163	 * Hooks into the XPT.
164	 */
165	struct	cam_sim		*sim;
166	struct	cam_sim		*sim_b;
167	struct	cam_path	*path;
168	struct	cam_path	*path_b;
169
170	int			 regs_res_type[2];
171	int			 regs_res_id[2];
172	int			 irq_res_type;
173	struct resource		*regs[2];
174	struct resource		*irq;
175	void			*ih;
176	eventhandler_tag	 eh;
177};
178
179struct scb_platform_data {
180};
181
182/********************************* Byte Order *********************************/
183#if __FreeBSD_version >= 500000
184#define ahd_htobe16(x) htobe16(x)
185#define ahd_htobe32(x) htobe32(x)
186#define ahd_htobe64(x) htobe64(x)
187#define ahd_htole16(x) htole16(x)
188#define ahd_htole32(x) htole32(x)
189#define ahd_htole64(x) htole64(x)
190
191#define ahd_be16toh(x) be16toh(x)
192#define ahd_be32toh(x) be32toh(x)
193#define ahd_be64toh(x) be64toh(x)
194#define ahd_le16toh(x) le16toh(x)
195#define ahd_le32toh(x) le32toh(x)
196#define ahd_le64toh(x) le64toh(x)
197#else
198#define ahd_htobe16(x) (x)
199#define ahd_htobe32(x) (x)
200#define ahd_htobe64(x) (x)
201#define ahd_htole16(x) (x)
202#define ahd_htole32(x) (x)
203#define ahd_htole64(x) (x)
204
205#define ahd_be16toh(x) (x)
206#define ahd_be32toh(x) (x)
207#define ahd_be64toh(x) (x)
208#define ahd_le16toh(x) (x)
209#define ahd_le32toh(x) (x)
210#define ahd_le64toh(x) (x)
211#endif
212
213/************************** Timer DataStructures ******************************/
214typedef struct callout ahd_timer_t;
215
216/***************************** Core Includes **********************************/
217#if AHD_REG_PRETTY_PRINT
218#define AIC_DEBUG_REGISTERS 1
219#else
220#define AIC_DEBUG_REGISTERS 0
221#endif
222#include <dev/aic7xxx/aic79xx.h>
223
224/***************************** Timer Facilities *******************************/
225#if __FreeBSD_version >= 500000
226#define ahd_timer_init(timer) callout_init(timer, /*mpsafe*/0)
227#else
228#define ahd_timer_init callout_init
229#endif
230#define ahd_timer_stop callout_stop
231
232static __inline void
233ahd_timer_reset(ahd_timer_t *timer, int usec, ahd_callback_t *func, void *arg)
234{
235	callout_reset(timer, (usec * hz)/1000000, func, arg);
236}
237
238/*************************** Device Access ************************************/
239#define ahd_inb(ahd, port)					\
240	bus_space_read_1((ahd)->tags[(port) >> 8],		\
241			 (ahd)->bshs[(port) >> 8], (port) & 0xFF)
242
243#define ahd_outb(ahd, port, value)				\
244	bus_space_write_1((ahd)->tags[(port) >> 8],		\
245			  (ahd)->bshs[(port) >> 8], (port) & 0xFF, value)
246
247#define ahd_inw_atomic(ahd, port)				\
248	ahd_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8],	\
249				     (ahd)->bshs[(port) >> 8], (port) & 0xFF))
250
251#define ahd_outw_atomic(ahd, port, value)			\
252	bus_space_write_2((ahd)->tags[(port) >> 8],		\
253			  (ahd)->bshs[(port) >> 8],		\
254			  (port & 0xFF), ahd_htole16(value))
255
256#define ahd_outsb(ahd, port, valp, count)			\
257	bus_space_write_multi_1((ahd)->tags[(port) >> 8],	\
258				(ahd)->bshs[(port) >> 8],	\
259				(port & 0xFF), valp, count)
260
261#define ahd_insb(ahd, port, valp, count)			\
262	bus_space_read_multi_1((ahd)->tags[(port) >> 8],	\
263			       (ahd)->bshs[(port) >> 8],	\
264			       (port & 0xFF), valp, count)
265
266static __inline void ahd_flush_device_writes(struct ahd_softc *);
267
268static __inline void
269ahd_flush_device_writes(struct ahd_softc *ahd)
270{
271	/* XXX Is this sufficient for all architectures??? */
272	ahd_inb(ahd, INTSTAT);
273}
274
275/**************************** Locking Primitives ******************************/
276/* Lock protecting internal data structures */
277static __inline void ahd_lockinit(struct ahd_softc *);
278static __inline void ahd_lock(struct ahd_softc *, unsigned long *flags);
279static __inline void ahd_unlock(struct ahd_softc *, unsigned long *flags);
280
281/* Lock held during command compeletion to the upper layer */
282static __inline void ahd_done_lockinit(struct ahd_softc *);
283static __inline void ahd_done_lock(struct ahd_softc *, unsigned long *flags);
284static __inline void ahd_done_unlock(struct ahd_softc *, unsigned long *flags);
285
286/* Lock held during ahd_list manipulation and ahd softc frees */
287static __inline void ahd_list_lockinit(void);
288static __inline void ahd_list_lock(unsigned long *flags);
289static __inline void ahd_list_unlock(unsigned long *flags);
290
291static __inline void
292ahd_lockinit(struct ahd_softc *ahd)
293{
294}
295
296static __inline void
297ahd_lock(struct ahd_softc *ahd, unsigned long *flags)
298{
299	*flags = splcam();
300}
301
302static __inline void
303ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)
304{
305	splx(*flags);
306}
307
308/* Lock held during command compeletion to the upper layer */
309static __inline void
310ahd_done_lockinit(struct ahd_softc *ahd)
311{
312}
313
314static __inline void
315ahd_done_lock(struct ahd_softc *ahd, unsigned long *flags)
316{
317}
318
319static __inline void
320ahd_done_unlock(struct ahd_softc *ahd, unsigned long *flags)
321{
322}
323
324/* Lock held during ahd_list manipulation and ahd softc frees */
325static __inline void
326ahd_list_lockinit()
327{
328}
329
330static __inline void
331ahd_list_lock(unsigned long *flags)
332{
333}
334
335static __inline void
336ahd_list_unlock(unsigned long *flags)
337{
338}
339/****************************** OS Primitives *********************************/
340#define ahd_delay DELAY
341
342/************************** Transaction Operations ****************************/
343static __inline void ahd_set_transaction_status(struct scb *, uint32_t);
344static __inline void ahd_set_scsi_status(struct scb *, uint32_t);
345static __inline uint32_t ahd_get_transaction_status(struct scb *);
346static __inline uint32_t ahd_get_scsi_status(struct scb *);
347static __inline void ahd_set_transaction_tag(struct scb *, int, u_int);
348static __inline u_long ahd_get_transfer_length(struct scb *);
349static __inline int ahd_get_transfer_dir(struct scb *);
350static __inline void ahd_set_residual(struct scb *, u_long);
351static __inline void ahd_set_sense_residual(struct scb *, u_long);
352static __inline u_long ahd_get_residual(struct scb *);
353static __inline int ahd_perform_autosense(struct scb *);
354static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc*, struct scb*);
355static __inline void ahd_freeze_simq(struct ahd_softc *);
356static __inline void ahd_release_simq(struct ahd_softc *);
357static __inline void ahd_freeze_ccb(union ccb *ccb);
358static __inline void ahd_freeze_scb(struct scb *scb);
359static __inline void ahd_platform_freeze_devq(struct ahd_softc *, struct scb *);
360static __inline int  ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
361					     char channel, int lun, u_int tag,
362					     role_t role, uint32_t status);
363
364static __inline
365void ahd_set_transaction_status(struct scb *scb, uint32_t status)
366{
367	scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK;
368	scb->io_ctx->ccb_h.status |= status;
369}
370
371static __inline
372void ahd_set_scsi_status(struct scb *scb, uint32_t status)
373{
374	scb->io_ctx->csio.scsi_status = status;
375}
376
377static __inline
378uint32_t ahd_get_transaction_status(struct scb *scb)
379{
380	return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK);
381}
382
383static __inline
384uint32_t ahd_get_scsi_status(struct scb *scb)
385{
386	return (scb->io_ctx->csio.scsi_status);
387}
388
389static __inline
390void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)
391{
392	scb->io_ctx->csio.tag_action = type;
393	if (enabled)
394		scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID;
395	else
396		scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID;
397}
398
399static __inline
400u_long ahd_get_transfer_length(struct scb *scb)
401{
402	return (scb->io_ctx->csio.dxfer_len);
403}
404
405static __inline
406int ahd_get_transfer_dir(struct scb *scb)
407{
408	return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK);
409}
410
411static __inline
412void ahd_set_residual(struct scb *scb, u_long resid)
413{
414	scb->io_ctx->csio.resid = resid;
415}
416
417static __inline
418void ahd_set_sense_residual(struct scb *scb, u_long resid)
419{
420	scb->io_ctx->csio.sense_resid = resid;
421}
422
423static __inline
424u_long ahd_get_residual(struct scb *scb)
425{
426	return (scb->io_ctx->csio.resid);
427}
428
429static __inline
430int ahd_perform_autosense(struct scb *scb)
431{
432	return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE));
433}
434
435static __inline uint32_t
436ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)
437{
438	return (sizeof(struct scsi_sense_data));
439}
440
441static __inline void
442ahd_freeze_simq(struct ahd_softc *ahd)
443{
444	xpt_freeze_simq(ahd->platform_data->sim, /*count*/1);
445}
446
447static __inline void
448ahd_release_simq(struct ahd_softc *ahd)
449{
450	xpt_release_simq(ahd->platform_data->sim, /*run queue*/TRUE);
451}
452
453static __inline void
454ahd_freeze_ccb(union ccb *ccb)
455{
456	if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
457		ccb->ccb_h.status |= CAM_DEV_QFRZN;
458		xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
459	}
460}
461
462static __inline void
463ahd_freeze_scb(struct scb *scb)
464{
465	ahd_freeze_ccb(scb->io_ctx);
466}
467
468static __inline void
469ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb)
470{
471	/* Nothing to do here for FreeBSD */
472}
473
474static __inline int
475ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
476			char channel, int lun, u_int tag,
477			role_t role, uint32_t status)
478{
479	/* Nothing to do here for FreeBSD */
480	return (0);
481}
482
483static __inline void
484ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)
485{
486	/* What do we do to generically handle driver resource shortages??? */
487	if ((ahd->flags & AHD_RESOURCE_SHORTAGE) != 0
488	 && scb->io_ctx != NULL
489	 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) {
490		scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ;
491		ahd->flags &= ~AHD_RESOURCE_SHORTAGE;
492	}
493	scb->io_ctx = NULL;
494}
495
496/********************************** PCI ***************************************/
497#ifdef AHD_PCI_CONFIG
498static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,
499					     int reg, int width);
500static __inline void	 ahd_pci_write_config(ahd_dev_softc_t pci,
501					      int reg, uint32_t value,
502					      int width);
503static __inline int	 ahd_get_pci_function(ahd_dev_softc_t);
504static __inline int	 ahd_get_pci_slot(ahd_dev_softc_t);
505static __inline int	 ahd_get_pci_bus(ahd_dev_softc_t);
506
507int			 ahd_pci_map_registers(struct ahd_softc *ahd);
508int			 ahd_pci_map_int(struct ahd_softc *ahd);
509
510static __inline uint32_t
511ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width)
512{
513	return (pci_read_config(pci, reg, width));
514}
515
516static __inline void
517ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width)
518{
519	pci_write_config(pci, reg, value, width);
520}
521
522static __inline int
523ahd_get_pci_function(ahd_dev_softc_t pci)
524{
525	return (pci_get_function(pci));
526}
527
528static __inline int
529ahd_get_pci_slot(ahd_dev_softc_t pci)
530{
531	return (pci_get_slot(pci));
532}
533
534static __inline int
535ahd_get_pci_bus(ahd_dev_softc_t pci)
536{
537	return (pci_get_bus(pci));
538}
539
540typedef enum
541{
542	AHD_POWER_STATE_D0,
543	AHD_POWER_STATE_D1,
544	AHD_POWER_STATE_D2,
545	AHD_POWER_STATE_D3
546} ahd_power_state;
547
548void ahd_power_state_change(struct ahd_softc *ahd,
549			    ahd_power_state new_state);
550#endif
551/******************************** VL/EISA *************************************/
552int aic7770_map_registers(struct ahd_softc *ahd);
553int aic7770_map_int(struct ahd_softc *ahd, int irq);
554
555/********************************* Debug **************************************/
556static __inline void	ahd_print_path(struct ahd_softc *, struct scb *);
557static __inline void	ahd_platform_dump_card_state(struct ahd_softc *ahd);
558
559static __inline void
560ahd_print_path(struct ahd_softc *ahd, struct scb *scb)
561{
562	xpt_print_path(scb->io_ctx->ccb_h.path);
563}
564
565static __inline void
566ahd_platform_dump_card_state(struct ahd_softc *ahd)
567{
568	/* Nothing to do here for FreeBSD */
569}
570/**************************** Transfer Settings *******************************/
571void	  ahd_notify_xfer_settings_change(struct ahd_softc *,
572					  struct ahd_devinfo *);
573void	  ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *,
574				int /*enable*/);
575
576/************************* Initialization/Teardown ****************************/
577int	  ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);
578void	  ahd_platform_free(struct ahd_softc *ahd);
579int	  ahd_map_int(struct ahd_softc *ahd);
580int	  ahd_attach(struct ahd_softc *);
581int	  ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd);
582int	  ahd_detach(device_t);
583
584/****************************** Interrupts ************************************/
585void			ahd_platform_intr(void *);
586static __inline void	ahd_platform_flushwork(struct ahd_softc *ahd);
587static __inline void
588ahd_platform_flushwork(struct ahd_softc *ahd)
589{
590}
591
592/************************ Misc Function Declarations **************************/
593timeout_t ahd_timeout;
594void	  ahd_done(struct ahd_softc *ahd, struct scb *scb);
595void	  ahd_send_async(struct ahd_softc *, char /*channel*/,
596			 u_int /*target*/, u_int /*lun*/, ac_code, void *arg);
597#endif  /* _AIC79XX_FREEBSD_H_ */
598