Home | History | Annotate | Line # | Download | only in pci
twevar.h revision 1.18
      1 /*	$NetBSD: twevar.h,v 1.18 2003/09/22 18:31:11 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 2000, 2001, 2002 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 _PCI_TWEVAR_H_
     40 #define	_PCI_TWEVAR_H_
     41 
     42 #include "locators.h"
     43 
     44 #define	TWE_MAX_QUEUECNT	129
     45 
     46 /* Callbacks from controller to array. */
     47 struct twe_callbacks {
     48 	void	(*tcb_openings)(struct device *, int);
     49 };
     50 
     51 /* Per-array drive information. */
     52 struct twe_drive {
     53 	uint32_t		td_size;
     54 	uint8_t			td_type;
     55 	uint8_t			td_stripe;
     56 
     57 	struct device		*td_dev;
     58 	const struct twe_callbacks *td_callbacks;
     59 };
     60 
     61 /* Per-controller state. */
     62 struct twe_softc {
     63 	struct device		sc_dv;
     64 	bus_space_tag_t		sc_iot;
     65 	bus_space_handle_t	sc_ioh;
     66 	bus_dma_tag_t		sc_dmat;
     67 	bus_dmamap_t		sc_dmamap;
     68 	void			*sc_ih;
     69 	caddr_t			sc_cmds;
     70 	bus_addr_t		sc_cmds_paddr;
     71 	int			sc_nccbs;
     72 	struct twe_ccb		*sc_ccbs;
     73 	SIMPLEQ_HEAD(, twe_ccb)	sc_ccb_queue;
     74 	SLIST_HEAD(, twe_ccb)	sc_ccb_freelist;
     75 	int			sc_flags;
     76 	int			sc_openings;
     77 	int			sc_nunits;
     78 	struct twe_drive	sc_units[TWE_MAX_UNITS];
     79 
     80 	/* Asynchronous event notification queue for management tools. */
     81 #define	TWE_AEN_Q_LENGTH	256
     82 	uint16_t		sc_aen_queue[TWE_AEN_Q_LENGTH];
     83 	int			sc_aen_head;
     84 	int			sc_aen_tail;
     85 };
     86 #define	TWEF_OPEN	0x01	/* control device is opened */
     87 #define	TWEF_AENQ_WAIT	0x02	/* someone waiting for AENs */
     88 
     89 /* Optional per-command context. */
     90 struct twe_context {
     91 	void	(*tx_handler)(struct twe_ccb *, int);
     92 	void 	*tx_context;
     93 	struct	device	*tx_dv;
     94 };
     95 
     96 /* Command control block. */
     97 struct twe_ccb {
     98 	union {
     99 		SIMPLEQ_ENTRY(twe_ccb) simpleq;
    100 		SLIST_ENTRY(twe_ccb) slist;
    101 	} ccb_chain;
    102 	struct twe_cmd	*ccb_cmd;
    103 	int		ccb_cmdid;
    104 	int		ccb_flags;
    105 	void		*ccb_data;
    106 	int		ccb_datasize;
    107 	vaddr_t		ccb_abuf;
    108 	bus_dmamap_t	ccb_dmamap_xfer;
    109 	struct twe_context ccb_tx;
    110 };
    111 #define	TWE_CCB_DATA_IN		0x01	/* Map describes inbound xfer */
    112 #define	TWE_CCB_DATA_OUT	0x02	/* Map describes outbound xfer */
    113 #define	TWE_CCB_COMPLETE	0x04	/* Command completed */
    114 #define	TWE_CCB_ACTIVE		0x08	/* Command active */
    115 #define	TWE_CCB_PARAM		0x10	/* For parameter retrieval */
    116 #define	TWE_CCB_ALLOCED		0x20	/* CCB allocated */
    117 
    118 struct twe_attach_args {
    119 	int		twea_unit;
    120 };
    121 
    122 #define	tweacf_unit	cf_loc[TWECF_UNIT]
    123 
    124 int	twe_ccb_alloc(struct twe_softc *, struct twe_ccb **, int);
    125 void	twe_ccb_enqueue(struct twe_softc *sc, struct twe_ccb *ccb);
    126 void	twe_ccb_free(struct twe_softc *sc, struct twe_ccb *);
    127 int	twe_ccb_map(struct twe_softc *, struct twe_ccb *);
    128 int	twe_ccb_poll(struct twe_softc *, struct twe_ccb *, int);
    129 int	twe_ccb_submit(struct twe_softc *, struct twe_ccb *);
    130 void	twe_ccb_unmap(struct twe_softc *, struct twe_ccb *);
    131 
    132 int	twe_param_get(struct twe_softc *, int, int, size_t,
    133 	    void (*)(struct twe_ccb *, int), struct twe_param **);
    134 int	twe_param_get_1(struct twe_softc *, int, int, uint8_t *);
    135 int	twe_param_get_2(struct twe_softc *, int, int, uint16_t *);
    136 int	twe_param_get_4(struct twe_softc *, int, int, uint32_t *);
    137 
    138 void	twe_register_callbacks(struct twe_softc *, int,
    139 	    const struct twe_callbacks *);
    140 
    141 static __inline__ size_t twe_get_maxsegs(void) {
    142 	size_t max_segs = ((MAXPHYS + PAGE_SIZE - 1) / PAGE_SIZE) + 1;
    143 #ifdef TWE_SG_SIZE
    144 	if (TWE_SG_SIZE < max_segs)
    145 	    max_segs = TWE_SG_SIZE;
    146 #endif
    147 	return max_segs;
    148 }
    149 
    150 static __inline__ size_t twe_get_maxxfer(size_t maxsegs) {
    151 	return (maxsegs - 1) * PAGE_SIZE;
    152 }
    153 
    154 /*
    155  * Structures used to convert numeric codes to strings.
    156  */
    157 struct twe_code_table {
    158 	uint32_t	code;
    159 	const char	*string;
    160 };
    161 extern const struct twe_code_table twe_table_status[];
    162 extern const struct twe_code_table twe_table_unitstate[];
    163 extern const struct twe_code_table twe_table_unittype[];
    164 extern const struct twe_code_table twe_table_stripedepth[];
    165 extern const struct twe_code_table twe_table_aen[];
    166 
    167 const char *twe_describe_code(const struct twe_code_table *, uint32_t);
    168 
    169 #endif	/* !_PCI_TWEVAR_H_ */
    170