Home | History | Annotate | Line # | Download | only in pci
twaio.h revision 1.2.2.2
      1 /*	$NetBSD: twaio.h,v 1.2.2.2 2006/06/01 22:36:49 kardel Exp $ */
      2 /*	$wasabi: twaio.h,v 1.8 2006/04/27 17:12:39 wrstuden Exp $ */
      3 /*
      4  * Copyright (c) 2005-2006 Wasabi Systems, Inc.
      5  * All rights reserved.
      6  *
      7  * Your Wasabi Systems License Agreement specifies the terms and
      8  * conditions for use and redistribution.
      9  */
     10 
     11 /*-
     12  * Copyright (c) 2003-04 3ware, Inc.
     13  * All rights reserved.
     14  *
     15  * Redistribution and use in source and binary forms, with or without
     16  * modification, are permitted provided that the following conditions
     17  * are met:
     18  * 1. Redistributions of source code must retain the above copyright
     19  *    notice, this list of conditions and the following disclaimer.
     20  * 2. Redistributions in binary form must reproduce the above copyright
     21  *    notice, this list of conditions and the following disclaimer in the
     22  *    documentation and/or other materials provided with the distribution.
     23  *
     24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     34  * SUCH DAMAGE.
     35  *
     36  *$FreeBSD: src/sys/dev/twa/twa_ioctl.h,v 1.1 2004/03/30 03:45:59 vkashyap Exp $
     37  */
     38 
     39 /*
     40  * 3ware driver for 9000 series storage controllers.
     41  *
     42  * Author: Vinod Kashyap
     43  */
     44 
     45 
     46 #ifndef _DEV_PCI_TWAIO_H_
     47 #define	_DEV_PCI_TWAIO_H_
     48 
     49 #define TWA_AEN_NOT_RETRIEVED	0x1
     50 #define TWA_AEN_RETRIEVED	0x2
     51 
     52 #define TWA_ERROR_AEN_NO_EVENTS	0x1003           /* No more events */
     53 #define TWA_ERROR_AEN_OVERFLOW	0x1004           /* AEN clobber occurred */
     54 
     55 #define TWA_ERROR_IOCTL_LOCK_NOT_HELD		0x1001   /* Not locked */
     56 #define TWA_ERROR_IOCTL_LOCK_ALREADY_HELD	0x1002   /* Already locked */
     57 
     58 
     59 struct twa_scan_bus_packet {
     60 	uint32_t	unit;
     61 } __attribute__ ((packed));
     62 
     63 struct tw_cl_event_packet {
     64 	uint32_t	sequence_id;
     65 	uint32_t	time_stamp_sec;
     66 	uint16_t	aen_code;
     67 	uint8_t		severity;
     68 	uint8_t		retrieved;
     69 	uint8_t		repeat_count;
     70 	uint8_t		parameter_len;
     71 	uint8_t		parameter_data[98];
     72 	uint32_t	event_src;
     73 	uint8_t		severity_str[20];
     74 } __attribute__ ((packed));
     75 
     76 struct tw_cl_lock_packet {
     77 	uint32_t	timeout_msec;
     78 	uint32_t	time_remaining_msec;
     79 	uint32_t	force_flag;
     80 } __attribute__ ((packed));
     81 
     82 
     83 struct tw_cl_compatibility_packet {
     84 	uint8_t		driver_version[32];/* driver version */
     85 	uint16_t	working_srl;	/* driver & firmware negotiated srl */
     86 	uint16_t	working_branch;	/* branch # of the firmware that the driver is compatible with */
     87 	uint16_t	working_build;	/* build # of the firmware that the driver is compatible with */
     88 } __attribute__ ((packed));
     89 
     90 
     91 struct twa_driver_packet {
     92 	uint32_t	control_code;
     93 	uint32_t	status;
     94 	uint32_t	unique_id;
     95 	uint32_t	sequence_id;
     96 	uint32_t	os_status;
     97 	uint32_t	buffer_length;
     98 } __attribute__ ((packed));
     99 
    100 /* Account for differences between 32/64 bit system. Offsets into memory
    101  * are anticipated for driver/firmware command packets and having a
    102  * variable sized pointer depending on architecture add 4 bytes to any offset
    103  * after the pdata declaration
    104  */
    105 #define TW_SIZEOF_VOIDPTR		(sizeof(void *))
    106 
    107 struct twa_ioctl_9k {
    108 	struct twa_driver_packet	twa_drvr_pkt;
    109 	void				*pdata; /* points to data_buf */
    110 	int8_t				padding[488 - TW_SIZEOF_VOIDPTR];
    111 	struct twa_command_packet	twa_cmd_pkt;
    112 	int8_t				data_buf[1];
    113 } __attribute__ ((packed));
    114 
    115 
    116 /*
    117  * We need the structure below to ensure that the first byte of
    118  * data_buf is not overwritten by the kernel, after we return
    119  * from the ioctl call.  Note that twa_cmd_pkt has been reduced
    120  * to an array of 1024 bytes even though it's actually 2048 bytes
    121  * in size.  This is because, we don't expect requests from user
    122  * land requiring 2048 (273 sg elements) byte cmd pkts.
    123  */
    124 typedef struct twa_ioctl_no_data_buf {
    125 	struct twa_driver_packet	twa_drvr_pkt;
    126 	void				*pdata; /* points to data_buf */
    127 	int8_t				padding[484];
    128 	struct twa_command_packet	twa_cmd_pkt;
    129 }  __attribute__ ((packed)) TWA_IOCTL_NO_DATA_BUF;
    130 
    131 /*
    132  * Get the device external name of the specified array unit.
    133  */
    134  /* WASABI */
    135 struct twa_unitname {
    136 	int		tn_unit;
    137 	char		tn_name[16];	/* XXX sizeof(dev->dv_xname) */
    138 };
    139 
    140 #define TW_OSL_IOCTL_SCAN_BUS		_IO ('T', 200)
    141 
    142 #define TW_OSL_IOCTL_FIRMWARE_PASS_THROUGH 	\
    143 	_IOWR('T', 202, TWA_IOCTL_NO_DATA_BUF)
    144 
    145 #define TW_CL_IOCTL_GET_FIRST_EVENT	_IOWR('T', 203, TWA_IOCTL_NO_DATA_BUF)
    146 #define TW_CL_IOCTL_GET_LAST_EVENT	_IOWR('T', 204, TWA_IOCTL_NO_DATA_BUF)
    147 #define TW_CL_IOCTL_GET_NEXT_EVENT	_IOWR('T', 205, TWA_IOCTL_NO_DATA_BUF)
    148 #define TW_CL_IOCTL_GET_PREVIOUS_EVENT	_IOWR('T', 206, TWA_IOCTL_NO_DATA_BUF)
    149 #define TW_CL_IOCTL_GET_LOCK		_IOWR('T', 207, TWA_IOCTL_NO_DATA_BUF)
    150 #define TW_CL_IOCTL_RELEASE_LOCK	_IOWR('T', 208, TWA_IOCTL_NO_DATA_BUF)
    151 #define TW_CL_IOCTL_GET_COMPATIBILITY_INFO 	\
    152 	_IOWR('T', 209, TWA_IOCTL_NO_DATA_BUF)
    153 /* WASABI */
    154 #define	TWA_IOCTL_GET_UNITNAME		_IOWR('T', 220, struct twa_unitname)
    155 
    156 #endif /* _DEV_PCI_TWAIO_H_ */
    157