aic79xx_osm.h revision 107437 
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#18 $
34 *
35 * $FreeBSD: head/sys/dev/aic7xxx/aic79xx_osm.h 107437 2002-12-01 07:50:56Z scottl $
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 *******************************/
225timeout_t ahd_timeout;
226#if __FreeBSD_version >= 500000
227#define ahd_timer_init(timer) callout_init(timer, /*mpsafe*/0)
228#else
229#define ahd_timer_init callout_init
230#endif
231#define ahd_timer_stop callout_stop
232
233static __inline void
234ahd_timer_reset(ahd_timer_t *timer, u_int usec, ahd_callback_t *func, void *arg)
235{
236	callout_reset(timer, (usec * hz)/1000000, func, arg);
237}
238
239static __inline void
240ahd_scb_timer_reset(struct scb *scb, u_int usec)
241{
242	callout_reset(scb->io_ctx->ccb_h.timeout_ch.callout,
243		      (usec * hz)/1000000, ahd_timeout, scb);
244}
245
246/*************************** Device Access ************************************/
247#define ahd_inb(ahd, port)					\
248	bus_space_read_1((ahd)->tags[(port) >> 8],		\
249			 (ahd)->bshs[(port) >> 8], (port) & 0xFF)
250
251#define ahd_outb(ahd, port, value)				\
252	bus_space_write_1((ahd)->tags[(port) >> 8],		\
253			  (ahd)->bshs[(port) >> 8], (port) & 0xFF, value)
254
255#define ahd_inw_atomic(ahd, port)				\
256	ahd_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8],	\
257				     (ahd)->bshs[(port) >> 8], (port) & 0xFF))
258
259#define ahd_outw_atomic(ahd, port, value)			\
260	bus_space_write_2((ahd)->tags[(port) >> 8],		\
261			  (ahd)->bshs[(port) >> 8],		\
262			  (port & 0xFF), ahd_htole16(value))
263
264#define ahd_outsb(ahd, port, valp, count)			\
265	bus_space_write_multi_1((ahd)->tags[(port) >> 8],	\
266				(ahd)->bshs[(port) >> 8],	\
267				(port & 0xFF), valp, count)
268
269#define ahd_insb(ahd, port, valp, count)			\
270	bus_space_read_multi_1((ahd)->tags[(port) >> 8],	\
271			       (ahd)->bshs[(port) >> 8],	\
272			       (port & 0xFF), valp, count)
273
274static __inline void ahd_flush_device_writes(struct ahd_softc *);
275
276static __inline void
277ahd_flush_device_writes(struct ahd_softc *ahd)
278{
279	/* XXX Is this sufficient for all architectures??? */
280	ahd_inb(ahd, INTSTAT);
281}
282
283/**************************** Locking Primitives ******************************/
284/* Lock protecting internal data structures */
285static __inline void ahd_lockinit(struct ahd_softc *);
286static __inline void ahd_lock(struct ahd_softc *, unsigned long *flags);
287static __inline void ahd_unlock(struct ahd_softc *, unsigned long *flags);
288
289/* Lock held during command compeletion to the upper layer */
290static __inline void ahd_done_lockinit(struct ahd_softc *);
291static __inline void ahd_done_lock(struct ahd_softc *, unsigned long *flags);
292static __inline void ahd_done_unlock(struct ahd_softc *, unsigned long *flags);
293
294/* Lock held during ahd_list manipulation and ahd softc frees */
295static __inline void ahd_list_lockinit(void);
296static __inline void ahd_list_lock(unsigned long *flags);
297static __inline void ahd_list_unlock(unsigned long *flags);
298
299static __inline void
300ahd_lockinit(struct ahd_softc *ahd)
301{
302}
303
304static __inline void
305ahd_lock(struct ahd_softc *ahd, unsigned long *flags)
306{
307	*flags = splcam();
308}
309
310static __inline void
311ahd_unlock(struct ahd_softc *ahd, unsigned long *flags)
312{
313	splx(*flags);
314}
315
316/* Lock held during command compeletion to the upper layer */
317static __inline void
318ahd_done_lockinit(struct ahd_softc *ahd)
319{
320}
321
322static __inline void
323ahd_done_lock(struct ahd_softc *ahd, unsigned long *flags)
324{
325}
326
327static __inline void
328ahd_done_unlock(struct ahd_softc *ahd, unsigned long *flags)
329{
330}
331
332/* Lock held during ahd_list manipulation and ahd softc frees */
333static __inline void
334ahd_list_lockinit()
335{
336}
337
338static __inline void
339ahd_list_lock(unsigned long *flags)
340{
341}
342
343static __inline void
344ahd_list_unlock(unsigned long *flags)
345{
346}
347/****************************** OS Primitives *********************************/
348#define ahd_delay DELAY
349
350/************************** Transaction Operations ****************************/
351static __inline void ahd_set_transaction_status(struct scb *, uint32_t);
352static __inline void ahd_set_scsi_status(struct scb *, uint32_t);
353static __inline uint32_t ahd_get_transaction_status(struct scb *);
354static __inline uint32_t ahd_get_scsi_status(struct scb *);
355static __inline void ahd_set_transaction_tag(struct scb *, int, u_int);
356static __inline u_long ahd_get_transfer_length(struct scb *);
357static __inline int ahd_get_transfer_dir(struct scb *);
358static __inline void ahd_set_residual(struct scb *, u_long);
359static __inline void ahd_set_sense_residual(struct scb *, u_long);
360static __inline u_long ahd_get_residual(struct scb *);
361static __inline int ahd_perform_autosense(struct scb *);
362static __inline uint32_t ahd_get_sense_bufsize(struct ahd_softc*, struct scb*);
363static __inline void ahd_freeze_simq(struct ahd_softc *);
364static __inline void ahd_release_simq(struct ahd_softc *);
365static __inline void ahd_freeze_ccb(union ccb *ccb);
366static __inline void ahd_freeze_scb(struct scb *scb);
367static __inline void ahd_platform_freeze_devq(struct ahd_softc *, struct scb *);
368static __inline int  ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
369					     char channel, int lun, u_int tag,
370					     role_t role, uint32_t status);
371
372static __inline
373void ahd_set_transaction_status(struct scb *scb, uint32_t status)
374{
375	scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK;
376	scb->io_ctx->ccb_h.status |= status;
377}
378
379static __inline
380void ahd_set_scsi_status(struct scb *scb, uint32_t status)
381{
382	scb->io_ctx->csio.scsi_status = status;
383}
384
385static __inline
386uint32_t ahd_get_transaction_status(struct scb *scb)
387{
388	return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK);
389}
390
391static __inline
392uint32_t ahd_get_scsi_status(struct scb *scb)
393{
394	return (scb->io_ctx->csio.scsi_status);
395}
396
397static __inline
398void ahd_set_transaction_tag(struct scb *scb, int enabled, u_int type)
399{
400	scb->io_ctx->csio.tag_action = type;
401	if (enabled)
402		scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID;
403	else
404		scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID;
405}
406
407static __inline
408u_long ahd_get_transfer_length(struct scb *scb)
409{
410	return (scb->io_ctx->csio.dxfer_len);
411}
412
413static __inline
414int ahd_get_transfer_dir(struct scb *scb)
415{
416	return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK);
417}
418
419static __inline
420void ahd_set_residual(struct scb *scb, u_long resid)
421{
422	scb->io_ctx->csio.resid = resid;
423}
424
425static __inline
426void ahd_set_sense_residual(struct scb *scb, u_long resid)
427{
428	scb->io_ctx->csio.sense_resid = resid;
429}
430
431static __inline
432u_long ahd_get_residual(struct scb *scb)
433{
434	return (scb->io_ctx->csio.resid);
435}
436
437static __inline
438int ahd_perform_autosense(struct scb *scb)
439{
440	return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE));
441}
442
443static __inline uint32_t
444ahd_get_sense_bufsize(struct ahd_softc *ahd, struct scb *scb)
445{
446	return (sizeof(struct scsi_sense_data));
447}
448
449static __inline void
450ahd_freeze_simq(struct ahd_softc *ahd)
451{
452	xpt_freeze_simq(ahd->platform_data->sim, /*count*/1);
453}
454
455static __inline void
456ahd_release_simq(struct ahd_softc *ahd)
457{
458	xpt_release_simq(ahd->platform_data->sim, /*run queue*/TRUE);
459}
460
461static __inline void
462ahd_freeze_ccb(union ccb *ccb)
463{
464	if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
465		ccb->ccb_h.status |= CAM_DEV_QFRZN;
466		xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
467	}
468}
469
470static __inline void
471ahd_freeze_scb(struct scb *scb)
472{
473	ahd_freeze_ccb(scb->io_ctx);
474}
475
476static __inline void
477ahd_platform_freeze_devq(struct ahd_softc *ahd, struct scb *scb)
478{
479	/* Nothing to do here for FreeBSD */
480}
481
482static __inline int
483ahd_platform_abort_scbs(struct ahd_softc *ahd, int target,
484			char channel, int lun, u_int tag,
485			role_t role, uint32_t status)
486{
487	/* Nothing to do here for FreeBSD */
488	return (0);
489}
490
491static __inline void
492ahd_platform_scb_free(struct ahd_softc *ahd, struct scb *scb)
493{
494	/* What do we do to generically handle driver resource shortages??? */
495	if ((ahd->flags & AHD_RESOURCE_SHORTAGE) != 0
496	 && scb->io_ctx != NULL
497	 && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) {
498		scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ;
499		ahd->flags &= ~AHD_RESOURCE_SHORTAGE;
500	}
501	scb->io_ctx = NULL;
502}
503
504/********************************** PCI ***************************************/
505#ifdef AHD_PCI_CONFIG
506static __inline uint32_t ahd_pci_read_config(ahd_dev_softc_t pci,
507					     int reg, int width);
508static __inline void	 ahd_pci_write_config(ahd_dev_softc_t pci,
509					      int reg, uint32_t value,
510					      int width);
511static __inline int	 ahd_get_pci_function(ahd_dev_softc_t);
512static __inline int	 ahd_get_pci_slot(ahd_dev_softc_t);
513static __inline int	 ahd_get_pci_bus(ahd_dev_softc_t);
514
515int			 ahd_pci_map_registers(struct ahd_softc *ahd);
516int			 ahd_pci_map_int(struct ahd_softc *ahd);
517
518static __inline uint32_t
519ahd_pci_read_config(ahd_dev_softc_t pci, int reg, int width)
520{
521	return (pci_read_config(pci, reg, width));
522}
523
524static __inline void
525ahd_pci_write_config(ahd_dev_softc_t pci, int reg, uint32_t value, int width)
526{
527	pci_write_config(pci, reg, value, width);
528}
529
530static __inline int
531ahd_get_pci_function(ahd_dev_softc_t pci)
532{
533	return (pci_get_function(pci));
534}
535
536static __inline int
537ahd_get_pci_slot(ahd_dev_softc_t pci)
538{
539	return (pci_get_slot(pci));
540}
541
542static __inline int
543ahd_get_pci_bus(ahd_dev_softc_t pci)
544{
545	return (pci_get_bus(pci));
546}
547
548typedef enum
549{
550	AHD_POWER_STATE_D0,
551	AHD_POWER_STATE_D1,
552	AHD_POWER_STATE_D2,
553	AHD_POWER_STATE_D3
554} ahd_power_state;
555
556void ahd_power_state_change(struct ahd_softc *ahd,
557			    ahd_power_state new_state);
558#endif
559/******************************** VL/EISA *************************************/
560int aic7770_map_registers(struct ahd_softc *ahd);
561int aic7770_map_int(struct ahd_softc *ahd, int irq);
562
563/********************************* Debug **************************************/
564static __inline void	ahd_print_path(struct ahd_softc *, struct scb *);
565static __inline void	ahd_platform_dump_card_state(struct ahd_softc *ahd);
566
567static __inline void
568ahd_print_path(struct ahd_softc *ahd, struct scb *scb)
569{
570	xpt_print_path(scb->io_ctx->ccb_h.path);
571}
572
573static __inline void
574ahd_platform_dump_card_state(struct ahd_softc *ahd)
575{
576	/* Nothing to do here for FreeBSD */
577}
578/**************************** Transfer Settings *******************************/
579void	  ahd_notify_xfer_settings_change(struct ahd_softc *,
580					  struct ahd_devinfo *);
581void	  ahd_platform_set_tags(struct ahd_softc *, struct ahd_devinfo *,
582				int /*enable*/);
583
584/************************* Initialization/Teardown ****************************/
585int	  ahd_platform_alloc(struct ahd_softc *ahd, void *platform_arg);
586void	  ahd_platform_free(struct ahd_softc *ahd);
587int	  ahd_map_int(struct ahd_softc *ahd);
588int	  ahd_attach(struct ahd_softc *);
589int	  ahd_softc_comp(struct ahd_softc *lahd, struct ahd_softc *rahd);
590int	  ahd_detach(device_t);
591#define	ahd_platform_init(arg)
592
593
594/****************************** Interrupts ************************************/
595void			ahd_platform_intr(void *);
596static __inline void	ahd_platform_flushwork(struct ahd_softc *ahd);
597static __inline void
598ahd_platform_flushwork(struct ahd_softc *ahd)
599{
600}
601
602/************************ Misc Function Declarations **************************/
603void	  ahd_done(struct ahd_softc *ahd, struct scb *scb);
604void	  ahd_send_async(struct ahd_softc *, char /*channel*/,
605			 u_int /*target*/, u_int /*lun*/, ac_code, void *arg);
606#endif  /* _AIC79XX_FREEBSD_H_ */
607