Home | History | Annotate | Line # | Download | only in i2o
iopvar.h revision 1.20
      1 /*	$NetBSD: iopvar.h,v 1.20 2007/07/09 21:00:33 ad Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2000, 2001, 2002, 2007 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Andrew Doran.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  * 3. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *        This product includes software developed by the NetBSD
     21  *        Foundation, Inc. and its contributors.
     22  * 4. Neither the name of The NetBSD Foundation nor the names of its
     23  *    contributors may be used to endorse or promote products derived
     24  *    from this software without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     36  * POSSIBILITY OF SUCH DAMAGE.
     37  */
     38 
     39 #ifndef _I2O_IOPVAR_H_
     40 #define	_I2O_IOPVAR_H_
     41 
     42 #include <sys/mutex.h>
     43 #include <sys/condvar.h>
     44 
     45 /*
     46  * Transfer descriptor.
     47  */
     48 struct iop_xfer {
     49 	bus_dmamap_t	ix_map;
     50 	u_int		ix_size;
     51 	u_int		ix_flags;
     52 };
     53 #define	IX_IN			0x0001	/* Data transfer from IOP */
     54 #define	IX_OUT			0x0002	/* Data transfer to IOP */
     55 
     56 /*
     57  * Message wrapper.
     58  */
     59 struct iop_msg {
     60 	SLIST_ENTRY(iop_msg)	im_chain;	/* Next free message */
     61 	u_int			im_flags;	/* Control flags */
     62 	u_int			im_tctx;	/* Transaction context */
     63 	void			*im_dvcontext;	/* Un*x device context */
     64 	struct i2o_reply	*im_rb;		/* Reply buffer */
     65 	kcondvar_t		im_cv;		/* Notifier */
     66 	u_int			im_reqstatus;	/* Status from reply */
     67 	u_int			im_detstatus;	/* Detailed status code */
     68 	struct iop_xfer		im_xfer[IOP_MAX_MSG_XFERS];
     69 };
     70 #define	IM_SYSMASK		0x00ff
     71 #define	IM_REPLIED		0x0001	/* Message has been replied to */
     72 #define	IM_ALLOCED		0x0002	/* This message wrapper is allocated */
     73 #define	IM_SGLOFFADJ		0x0004	/* S/G list offset adjusted */
     74 #define	IM_FAIL			0x0008	/* Transaction error returned */
     75 
     76 #define	IM_USERMASK		0xff00
     77 #define	IM_WAIT			0x0100	/* Wait (sleep) for completion */
     78 #define	IM_POLL			0x0200	/* Wait (poll) for completion */
     79 #define	IM_NOSTATUS		0x0400	/* Don't check status if waiting */
     80 #define	IM_POLL_INTR		0x0800	/* Do send interrupt when polling */
     81 
     82 struct iop_initiator {
     83 	LIST_ENTRY(iop_initiator) ii_list;
     84 	LIST_ENTRY(iop_initiator) ii_hash;
     85 
     86 	void	(*ii_intr)(struct device *, struct iop_msg *, void *);
     87 	int	(*ii_reconfig)(struct device *);
     88 	void	(*ii_adjqparam)(struct device *, int);
     89 
     90 	struct	device *ii_dv;
     91 	kcondvar_t ii_cv;
     92 	int	ii_flags;
     93 	int	ii_ictx;		/* Initiator context */
     94 	int	ii_tid;
     95 };
     96 #define	II_NOTCTX	0x0001	/* No transaction context */
     97 #define	II_CONFIGURED	0x0002	/* Already configured */
     98 #define	II_UTILITY	0x0004	/* Utility initiator (not a real device) */
     99 
    100 #define	IOP_ICTX	0
    101 #define	IOP_INIT_CODE	0x80
    102 
    103 /*
    104  * Parameter group op (for async parameter retrievals).
    105  */
    106 struct iop_pgop {
    107 	struct	i2o_param_op_list_header olh;
    108 	struct	i2o_param_op_all_template oat;
    109 } __attribute__ ((__packed__));
    110 
    111 /*
    112  * Per-IOP context.
    113  */
    114 struct iop_softc {
    115 	struct device	sc_dv;		/* Generic device data */
    116 	bus_space_handle_t sc_ioh;	/* Bus space handle */
    117 	bus_space_tag_t	sc_iot;		/* Bus space tag */
    118 	bus_dma_tag_t	sc_dmat;	/* Bus DMA tag */
    119 	bus_space_handle_t sc_msg_ioh;	/* Message queue bus space handle */
    120 	bus_space_tag_t	sc_msg_iot;	/* Message queue bus space tag */
    121 	void	 	*sc_ih;		/* Interrupt handler cookie */
    122 
    123 	struct iop_msg	*sc_ims;	/* Message wrappers */
    124 	SLIST_HEAD(, iop_msg) sc_im_freelist; /* Free wrapper list */
    125 	kmutex_t	sc_intrlock;	/* Interrupt level lock */
    126 
    127 	bus_dmamap_t	sc_rep_dmamap;	/* Reply frames DMA map */
    128 	int		sc_rep_size;	/* Reply frames size */
    129 	bus_addr_t	sc_rep_phys;	/* Reply frames PA */
    130 	void *		sc_rep;		/* Reply frames VA */
    131 
    132 	int		sc_maxib;	/* Max inbound (-> IOP) queue depth */
    133 	int		sc_maxob;	/* Max outbound (<- IOP) queue depth */
    134 	int		sc_curib;	/* Current inbound queue depth */
    135 	int		sc_framesize;	/* Max msg frame size in bytes */
    136 
    137 	struct i2o_hrt	*sc_hrt;	/* Hardware resource table */
    138 	struct iop_tidmap *sc_tidmap;	/* TID map (per-LCT-entry flags) */
    139 	struct i2o_lct	*sc_lct;	/* Logical configuration table */
    140 	int		sc_nlctent;	/* Number of LCT entries */
    141 	int		sc_flags;	/* IOP-wide flags */
    142 	u_int32_t	sc_chgind;	/* Configuration change indicator */
    143 	kmutex_t	sc_conflock;	/* Configuration lock */
    144 	kcondvar_t	sc_confcv;	/* Configuration CV */
    145 	lwp_t		*sc_reconf_thread;/* Auto reconfiguration process */
    146 	LIST_HEAD(, iop_initiator) sc_iilist;/* Initiator list */
    147 	int		sc_nii;		/* Total number of initiators */
    148 	int		sc_nuii;	/* Number of utility initiators */
    149 
    150 	struct iop_initiator sc_eventii;/* IOP event handler */
    151 	bus_dmamap_t	sc_scr_dmamap;  /* Scratch DMA map */
    152 	bus_dma_segment_t sc_scr_seg[1];/* Scratch DMA segment */
    153 	void *		sc_scr;		/* Scratch memory VA */
    154 
    155 	bus_space_tag_t	sc_bus_memt;	/* Parent bus memory tag */
    156 	bus_space_tag_t	sc_bus_iot;	/* Parent but I/O tag */
    157 	bus_addr_t	sc_memaddr;	/* Register window address */
    158 	bus_size_t	sc_memsize;	/* Register window size */
    159 	int		sc_pcibus;	/* PCI bus number */
    160 	int		sc_pcidev;	/* PCI device number */
    161 
    162 	struct i2o_status sc_status;	/* Last retrieved status record */
    163 };
    164 #define	IOP_OPEN		0x01	/* Device interface open */
    165 #define	IOP_HAVESTATUS		0x02	/* Successfully retrieved status */
    166 #define	IOP_ONLINE		0x04	/* Can use ioctl interface */
    167 
    168 struct iop_attach_args {
    169 	int	ia_class;		/* device class */
    170 	int	ia_tid;			/* target ID */
    171 };
    172 
    173 void	iop_init(struct iop_softc *, const char *);
    174 int	iop_intr(void *);
    175 int	iop_lct_get(struct iop_softc *);
    176 int	iop_print_ident(struct iop_softc *, int);
    177 int	iop_post(struct iop_softc *, u_int32_t *);
    178 int	iop_reconfigure(struct iop_softc *, u_int);
    179 int	iop_status_get(struct iop_softc *, int);
    180 int	iop_simple_cmd(struct iop_softc *, int, int, int, int, int);
    181 void	iop_strvis(struct iop_softc *, const char *, int, char *, int);
    182 
    183 void	iop_initiator_register(struct iop_softc *, struct iop_initiator *);
    184 void	iop_initiator_unregister(struct iop_softc *, struct iop_initiator *);
    185 
    186 struct	iop_msg *iop_msg_alloc(struct iop_softc *, int);
    187 void	iop_msg_free(struct iop_softc *, struct iop_msg *);
    188 int	iop_msg_map(struct iop_softc *, struct iop_msg *, u_int32_t *, void *,
    189 		    int, int, struct proc *);
    190 int	iop_msg_map_bio(struct iop_softc *, struct iop_msg *, u_int32_t *,
    191 			void *, int, int);
    192 int	iop_msg_post(struct iop_softc *, struct iop_msg *, void *, int);
    193 void	iop_msg_unmap(struct iop_softc *, struct iop_msg *);
    194 
    195 int	iop_field_get_all(struct iop_softc *, int, int, void *, int,
    196 			  struct iop_initiator *);
    197 int	iop_field_set(struct iop_softc *, int, int, void *, int, int);
    198 int	iop_table_add_row(struct iop_softc *, int, int, void *, int, int);
    199 int	iop_table_clear(struct iop_softc *, int, int);
    200 int	iop_table_del_row(struct iop_softc *, int, int, int);
    201 int	iop_table_get_row(struct iop_softc *, int, int, void *, int, int);
    202 
    203 int	iop_util_abort(struct iop_softc *, struct iop_initiator *, int, int,
    204 		      int);
    205 int	iop_util_claim(struct iop_softc *, struct iop_initiator *, int, int);
    206 int	iop_util_eventreg(struct iop_softc *, struct iop_initiator *, int);
    207 
    208 #endif	/* !_I2O_IOPVAR_H_ */
    209