This commit represents a major revamping of the clock interrupt and timebase
[dragonfly.git] / sys / bus / cam / cam.c
1 /*
2  * Generic utility routines for the Common Access Method layer.
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: src/sys/cam/cam.c,v 1.3 1999/08/28 00:40:38 peter Exp $
29  * $DragonFly: src/sys/bus/cam/cam.c,v 1.5 2003/12/30 01:01:40 dillon Exp $
30  */
31 #include <sys/param.h>
32 #ifdef _KERNEL
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/sysctl.h>
36 #else
37 #include <stdlib.h>
38 #include <stdio.h>
39 #endif
40
41 #include "cam.h"
42 #include "cam_ccb.h"
43 #include "scsi/scsi_all.h"
44 #include <sys/sbuf.h>
45
46 #ifdef _KERNEL
47 #include <sys/libkern.h>
48 #include "cam_xpt.h"
49 #endif
50
51 void
52 cam_strvis(u_int8_t *dst, const u_int8_t *src, int srclen, int dstlen)
53 {
54
55         /* Trim leading/trailing spaces, nulls. */
56         while (srclen > 0 && src[0] == ' ')
57                 src++, srclen--;
58         while (srclen > 0
59             && (src[srclen-1] == ' ' || src[srclen-1] == '\0'))
60                 srclen--;
61
62         while (srclen > 0 && dstlen > 1) {
63                 u_int8_t *cur_pos = dst;
64
65                 if (*src < 0x20 || *src >= 0x80) {
66                         /* SCSI-II Specifies that these should never occur. */
67                         /* non-printable character */
68                         if (dstlen > 4) {
69                                 *cur_pos++ = '\\';
70                                 *cur_pos++ = ((*src & 0300) >> 6) + '0';
71                                 *cur_pos++ = ((*src & 0070) >> 3) + '0';
72                                 *cur_pos++ = ((*src & 0007) >> 0) + '0';
73                         } else {
74                                 *cur_pos++ = '?';
75                         }
76                 } else {
77                         /* normal character */
78                         *cur_pos++ = *src;
79                 }
80                 src++;
81                 srclen--;
82                 dstlen -= cur_pos - dst;
83                 dst = cur_pos;
84         }
85         *dst = '\0';
86 }
87
88 /*
89  * Compare string with pattern, returning 0 on match.
90  * Short pattern matches trailing blanks in name,
91  * wildcard '*' in pattern matches rest of name,
92  * wildcard '?' matches a single non-space character.
93  */
94 int
95 cam_strmatch(const u_int8_t *str, const u_int8_t *pattern, int str_len)
96 {
97
98         while (*pattern != '\0'&& str_len > 0) {  
99
100                 if (*pattern == '*') {
101                         return (0);
102                 }
103                 if ((*pattern != *str)
104                  && (*pattern != '?' || *str == ' ')) {
105                         return (1);
106                 }
107                 pattern++;
108                 str++;
109                 str_len--;
110         }
111         while (str_len > 0 && *str++ == ' ')
112                 str_len--;
113
114         return (str_len);
115 }
116
117 caddr_t
118 cam_quirkmatch(caddr_t target, caddr_t quirk_table, int num_entries,
119                int entry_size, cam_quirkmatch_t *comp_func)
120 {
121         for (; num_entries > 0; num_entries--, quirk_table += entry_size) {
122                 if ((*comp_func)(target, quirk_table) == 0)
123                         return (quirk_table);
124         }
125         return (NULL);
126 }
127
128 /*
129  * Common calculate geometry fuction
130  *
131  * Caller should set ccg->volume_size and block_size.
132  * The extended parameter should be zero if extended translation
133  * should not be used.
134  */
135 void
136 cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended)
137 {
138         uint32_t size_mb, secs_per_cylinder;
139
140         size_mb = ccg->volume_size / ((1024L * 1024L) / ccg->block_size);
141         if (size_mb > 1024 && extended) {
142                 ccg->heads = 255;
143                 ccg->secs_per_track = 63;
144         } else {
145                 ccg->heads = 64;
146                 ccg->secs_per_track = 32;
147         }
148         secs_per_cylinder = ccg->heads * ccg->secs_per_track;
149         ccg->cylinders = ccg->volume_size / secs_per_cylinder;
150         ccg->ccb_h.status = CAM_REQ_CMP;
151 }
152