freebsd-skq/sys/dev/twe/tweio.h
msmith a020bb21aa Major update to the 'twe' driver.
- Layout reorganisation to enhance portability.  The driver now has
   a relatively MI 'core' and a FreeBSD-specific layer over the top.
   Since the NetBSD people have already done their own port, this is
   largely just to help me with the BSD/OS port.

 - Request ID allocation changed to improve performance (I'd been
   considering switching to this approach after having failed to come
   up with a better way to dynamically allocate request IDs, and seeing
   Andy Doran use it in the NetBSD port of the driver convinced me
   that I was wasting my time doing it any other way).  Now we just
   allocate all the requests up front.

 - Maximum request count bumped back to 255 after characterisation
   of a firmware issue (off-by-one causing it to crash with 256
   outstanding commands).

 - Control interface implemented.  This allows 3ware's '3dm' utility to
   talk to the controller.  3dm will be available from 3ware shortly.

 - Controller soft-reset feature added; if the controller signals a
   firmware or protocol error, the controller will be reset and all
   outstanding commands will be retried.
2000-10-25 06:59:06 +00:00

93 lines
2.7 KiB
C

/*-
* Copyright (c) 2000 Michael Smith
* Copyright (c) 2000 BSDi
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
/*
* User-space command
*
* Note that the command's scatter/gather list will be computed by the
* driver, and cannot be filled in by the consumer.
*/
struct twe_usercommand {
TWE_Command tu_command; /* command ready for the controller */
void *tu_data; /* pointer to data in userspace */
size_t tu_size; /* userspace data length */
};
#define TWEIO_COMMAND _IOWR('T', 100, struct twe_usercommand)
/*
* Command queue statistics
*/
#define TWEQ_FREE 0
#define TWEQ_BIO 1
#define TWEQ_READY 2
#define TWEQ_BUSY 3
#define TWEQ_COMPLETE 4
#define TWEQ_COUNT 5 /* total number of queues */
struct twe_qstat {
u_int32_t q_length;
u_int32_t q_max;
};
/*
* Statistics request
*/
union twe_statrequest {
u_int32_t ts_item;
struct twe_qstat ts_qstat;
};
#define TWEIO_STATS _IOWR('T', 101, union twe_statrequest)
/*
* AEN listen
*/
#define TWEIO_AEN_POLL _IOR('T', 102, int)
#define TWEIO_AEN_WAIT _IOR('T', 103, int)
/*
* Controller parameter access
*/
struct twe_paramcommand {
u_int16_t tp_table_id;
u_int8_t tp_param_id;
void *tp_data;
u_int8_t tp_size;
};
#define TWEIO_SET_PARAM _IOW ('T', 104, struct twe_paramcommand)
#define TWEIO_GET_PARAM _IOW ('T', 105, struct twe_paramcommand)
/*
* Request a controller soft-reset
*/
#define TWEIO_RESET _IO ('T', 106)