]> CyberLeo.Net >> Repos - FreeBSD/stable/9.git/blob - sys/cam/cam.h
MFC r358694:
[FreeBSD/stable/9.git] / sys / cam / cam.h
1 /*-
2  * Data structures and definitions for the CAM system.
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification, immediately at the beginning of the file.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30
31 #ifndef _CAM_CAM_H
32 #define _CAM_CAM_H 1
33
34 #ifdef _KERNEL
35 #include <opt_cam.h>
36 #endif
37
38 #include <sys/cdefs.h>
39
40 typedef u_int path_id_t;
41 typedef u_int target_id_t;
42 typedef u_int lun_id_t;
43
44 #define CAM_XPT_PATH_ID ((path_id_t)~0)
45 #define CAM_BUS_WILDCARD ((path_id_t)~0)
46 #define CAM_TARGET_WILDCARD ((target_id_t)~0)
47 #define CAM_LUN_WILDCARD ((lun_id_t)~0)
48
49 /*
50  * Maximum length for a CAM CDB.  
51  */
52 #define CAM_MAX_CDBLEN 16
53
54 /*
55  * Definition of a CAM peripheral driver entry.  Peripheral drivers instantiate
56  * one of these for each device they wish to communicate with and pass it into
57  * the xpt layer when they wish to schedule work on that device via the
58  * xpt_schedule API.
59  */
60 struct cam_periph;
61
62 /*
63  * Priority information for a CAM structure. 
64  */
65 typedef enum {
66     CAM_RL_HOST,
67     CAM_RL_BUS,
68     CAM_RL_XPT,
69     CAM_RL_DEV,
70     CAM_RL_NORMAL,
71     CAM_RL_VALUES
72 } cam_rl;
73 /*
74  * The generation number is incremented everytime a new entry is entered into
75  * the queue giving round robin per priority level scheduling.
76  */
77 typedef struct {
78         u_int32_t priority;
79 #define CAM_PRIORITY_HOST       ((CAM_RL_HOST << 8) + 0x80)
80 #define CAM_PRIORITY_BUS        ((CAM_RL_BUS << 8) + 0x80)
81 #define CAM_PRIORITY_XPT        ((CAM_RL_XPT << 8) + 0x80)
82 #define CAM_PRIORITY_DEV        ((CAM_RL_DEV << 8) + 0x80)
83 #define CAM_PRIORITY_OOB        (CAM_RL_DEV << 8)
84 #define CAM_PRIORITY_NORMAL     ((CAM_RL_NORMAL << 8) + 0x80)
85 #define CAM_PRIORITY_NONE       (u_int32_t)-1
86         u_int32_t generation;
87         int       index;
88 #define CAM_UNQUEUED_INDEX      -1
89 #define CAM_ACTIVE_INDEX        -2      
90 #define CAM_DONEQ_INDEX         -3      
91 #define CAM_EXTRAQ_INDEX        INT_MAX
92 } cam_pinfo;
93
94 /*
95  * Macro to compare two generation numbers.  It is used like this:  
96  *
97  *      if (GENERATIONCMP(a, >=, b))
98  *              ...;
99  *
100  * GERERATIONCMP uses modular arithmetic to guard against wraps
101  * wraps in the generation number.
102  */
103 #define GENERATIONCMP(x, op, y) ((int32_t)((x) - (y)) op 0)
104
105 /* CAM flags XXX Move to cam_periph.h ??? */
106 typedef enum {
107         CAM_FLAG_NONE           = 0x00,
108         CAM_EXPECT_INQ_CHANGE   = 0x01,
109         CAM_RETRY_SELTO         = 0x02 /* Retry Selection Timeouts */
110 } cam_flags;
111
112 enum {
113         SF_RETRY_UA             = 0x01, /* Retry UNIT ATTENTION conditions. */
114         SF_NO_PRINT             = 0x02, /* Never print error status. */
115         SF_QUIET_IR             = 0x04, /* Be quiet about Illegal Request reponses */
116         SF_PRINT_ALWAYS         = 0x08, /* Always print error status. */
117         SF_NO_RECOVERY          = 0x10, /* Don't do active error recovery. */
118         SF_NO_RETRY             = 0x20, /* Don't do any retries. */
119         SF_RETRY_BUSY           = 0x40  /* Retry BUSY status. */
120 };
121
122 /* CAM  Status field values */
123 typedef enum {
124         CAM_REQ_INPROG,         /* CCB request is in progress */
125         CAM_REQ_CMP,            /* CCB request completed without error */
126         CAM_REQ_ABORTED,        /* CCB request aborted by the host */
127         CAM_UA_ABORT,           /* Unable to abort CCB request */
128         CAM_REQ_CMP_ERR,        /* CCB request completed with an error */
129         CAM_BUSY,               /* CAM subsystem is busy */
130         CAM_REQ_INVALID,        /* CCB request was invalid */
131         CAM_PATH_INVALID,       /* Supplied Path ID is invalid */
132         CAM_DEV_NOT_THERE,      /* SCSI Device Not Installed/there */
133         CAM_UA_TERMIO,          /* Unable to terminate I/O CCB request */
134         CAM_SEL_TIMEOUT,        /* Target Selection Timeout */
135         CAM_CMD_TIMEOUT,        /* Command timeout */
136         CAM_SCSI_STATUS_ERROR,  /* SCSI error, look at error code in CCB */
137         CAM_MSG_REJECT_REC,     /* Message Reject Received */
138         CAM_SCSI_BUS_RESET,     /* SCSI Bus Reset Sent/Received */
139         CAM_UNCOR_PARITY,       /* Uncorrectable parity error occurred */
140         CAM_AUTOSENSE_FAIL = 0x10,/* Autosense: request sense cmd fail */
141         CAM_NO_HBA,             /* No HBA Detected error */
142         CAM_DATA_RUN_ERR,       /* Data Overrun error */
143         CAM_UNEXP_BUSFREE,      /* Unexpected Bus Free */
144         CAM_SEQUENCE_FAIL,      /* Target Bus Phase Sequence Failure */
145         CAM_CCB_LEN_ERR,        /* CCB length supplied is inadequate */
146         CAM_PROVIDE_FAIL,       /* Unable to provide requested capability */
147         CAM_BDR_SENT,           /* A SCSI BDR msg was sent to target */
148         CAM_REQ_TERMIO,         /* CCB request terminated by the host */
149         CAM_UNREC_HBA_ERROR,    /* Unrecoverable Host Bus Adapter Error */
150         CAM_REQ_TOO_BIG,        /* The request was too large for this host */
151         CAM_REQUEUE_REQ,        /*
152                                  * This request should be requeued to preserve
153                                  * transaction ordering.  This typically occurs
154                                  * when the SIM recognizes an error that should
155                                  * freeze the queue and must place additional
156                                  * requests for the target at the sim level
157                                  * back into the XPT queue.
158                                  */
159         CAM_ATA_STATUS_ERROR,   /* ATA error, look at error code in CCB */
160         CAM_SCSI_IT_NEXUS_LOST, /* Initiator/Target Nexus lost. */
161         CAM_SMP_STATUS_ERROR,   /* SMP error, look at error code in CCB */
162         CAM_IDE = 0x33,         /* Initiator Detected Error */
163         CAM_RESRC_UNAVAIL,      /* Resource Unavailable */
164         CAM_UNACKED_EVENT,      /* Unacknowledged Event by Host */
165         CAM_MESSAGE_RECV,       /* Message Received in Host Target Mode */
166         CAM_INVALID_CDB,        /* Invalid CDB received in Host Target Mode */
167         CAM_LUN_INVALID,        /* Lun supplied is invalid */
168         CAM_TID_INVALID,        /* Target ID supplied is invalid */
169         CAM_FUNC_NOTAVAIL,      /* The requested function is not available */
170         CAM_NO_NEXUS,           /* Nexus is not established */
171         CAM_IID_INVALID,        /* The initiator ID is invalid */
172         CAM_CDB_RECVD,          /* The SCSI CDB has been received */
173         CAM_LUN_ALRDY_ENA,      /* The LUN is already enabled for target mode */
174         CAM_SCSI_BUSY,          /* SCSI Bus Busy */
175
176         CAM_DEV_QFRZN = 0x40,   /* The DEV queue is frozen w/this err */
177
178                                 /* Autosense data valid for target */
179         CAM_AUTOSNS_VALID = 0x80,
180         CAM_RELEASE_SIMQ = 0x100,/* SIM ready to take more commands */
181         CAM_SIM_QUEUED   = 0x200,/* SIM has this command in it's queue */
182
183         CAM_STATUS_MASK = 0x3F, /* Mask bits for just the status # */
184
185                                 /* Target Specific Adjunct Status */
186         CAM_SENT_SENSE = 0x40000000     /* sent sense with status */
187 } cam_status;
188
189 typedef enum {
190         CAM_ESF_NONE            = 0x00,
191         CAM_ESF_COMMAND         = 0x01,
192         CAM_ESF_CAM_STATUS      = 0x02,
193         CAM_ESF_PROTO_STATUS    = 0x04,
194         CAM_ESF_ALL             = 0xff
195 } cam_error_string_flags;
196
197 typedef enum {
198         CAM_EPF_NONE            = 0x00,
199         CAM_EPF_MINIMAL         = 0x01,
200         CAM_EPF_NORMAL          = 0x02,
201         CAM_EPF_ALL             = 0x03,
202         CAM_EPF_LEVEL_MASK      = 0x0f
203         /* All bits above bit 3 are protocol-specific */
204 } cam_error_proto_flags;
205
206 typedef enum {
207         CAM_ESF_PRINT_NONE      = 0x00,
208         CAM_ESF_PRINT_STATUS    = 0x10,
209         CAM_ESF_PRINT_SENSE     = 0x20
210 } cam_error_scsi_flags;
211
212 typedef enum {
213         CAM_ESMF_PRINT_NONE     = 0x00,
214         CAM_ESMF_PRINT_STATUS   = 0x10,
215         CAM_ESMF_PRINT_FULL_CMD = 0x20,
216 } cam_error_smp_flags;
217
218 typedef enum {
219         CAM_EAF_PRINT_NONE      = 0x00,
220         CAM_EAF_PRINT_STATUS    = 0x10,
221         CAM_EAF_PRINT_RESULT    = 0x20
222 } cam_error_ata_flags;
223
224 struct cam_status_entry
225 {
226         cam_status  status_code;
227         const char *status_text;
228 };
229
230 extern const struct cam_status_entry cam_status_table[];
231 extern const int num_cam_status_entries;
232 #ifdef _KERNEL
233 extern int cam_sort_io_queues;
234 #endif
235 union ccb;
236
237 #ifdef SYSCTL_DECL      /* from sysctl.h */
238 SYSCTL_DECL(_kern_cam);
239 #endif
240
241 __BEGIN_DECLS
242 typedef int (cam_quirkmatch_t)(caddr_t, caddr_t);
243
244 caddr_t cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
245                        int entry_size, cam_quirkmatch_t *comp_func);
246
247 void    cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen);
248
249 int     cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len);
250 const struct cam_status_entry*
251         cam_fetch_status_entry(cam_status status);
252 #ifdef _KERNEL
253 char *  cam_error_string(union ccb *ccb, char *str, int str_len,
254                          cam_error_string_flags flags,
255                          cam_error_proto_flags proto_flags);
256 void    cam_error_print(union ccb *ccb, cam_error_string_flags flags,
257                         cam_error_proto_flags proto_flags);
258 #else /* _KERNEL */
259 struct cam_device;
260
261 char *  cam_error_string(struct cam_device *device, union ccb *ccb, char *str,
262                          int str_len, cam_error_string_flags flags,
263                          cam_error_proto_flags proto_flags);
264 void    cam_error_print(struct cam_device *device, union ccb *ccb,
265                         cam_error_string_flags flags,
266                         cam_error_proto_flags proto_flags, FILE *ofile);
267 #endif /* _KERNEL */
268 __END_DECLS
269
270 #ifdef _KERNEL
271 static __inline void cam_init_pinfo(cam_pinfo *pinfo);
272
273 static __inline void cam_init_pinfo(cam_pinfo *pinfo)
274 {
275         pinfo->priority = CAM_PRIORITY_NONE;    
276         pinfo->index = CAM_UNQUEUED_INDEX;
277 }
278 #endif
279
280 #endif /* _CAM_CAM_H */