1 /*
2  * Copyright (c) 1998,1999,2000
3  *      Traakan, Inc., Los Altos, CA
4  *      All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice unmodified, this list of conditions, and the following
11  *    disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
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
20  * FOR 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 
29 /*
30  * Project:  NDMJOB
31  * Ident:    $Id: $
32  *
33  * Description:
34  *
35  */
36 
37 
38 #include "ndmlib.h"
39 
40 
41 /*
42  * NAME[,[CNUM,]SID[,LUN]
43  *
44  * The foregoing pattern is ambiguous. Here's the disambiguating rules:
45  * 1) If just a name is given, controller, sid, and lun are all
46  *    set to invalid (-1)
47  * 2) If one number comes after the device name (,sid) it is the
48  *    SID; controller is set to -1, lun is set to 0
49  * 3) If two numbers come after the device name (,sid,lun), they are
50  *    the SID and LUN; controller is set to -1
51  * 4) Three numbers after the device name are all three number fields.
52  */
53 
54 
ndmscsi_target_from_str(struct ndmscsi_target * targ,char * str)55 int ndmscsi_target_from_str(struct ndmscsi_target* targ, char* str)
56 {
57   char* p;
58   int n1, n2, n3;
59 
60   NDMOS_MACRO_ZEROFILL(targ);
61 
62   p = strchr(str, ',');
63   if (p) { *p++ = 0; }
64 
65   if (strlen(str) >= NDMOS_CONST_PATH_MAX) {
66     if (p) p[-1] = ',';
67     return -2;
68   }
69 
70   strcpy(targ->dev_name, str);
71 
72   if (!p) {
73     targ->controller = -1;
74     targ->sid = -1;
75     targ->lun = -1;
76 
77     return 0;
78   }
79 
80   p[-1] = ',';
81 
82   if (*p < '0' || '9' < *p) { return -3; }
83   n1 = strtol(p, &p, 0);
84   if (*p != 0 && *p != ',') { return -4; }
85   if (*p == 0) {
86     targ->controller = -1;
87     targ->sid = n1;
88     targ->lun = 0;
89 
90     return 0;
91   }
92 
93   p++;
94 
95   if (*p < '0' || '9' < *p) { return -5; }
96   n2 = strtol(p, &p, 0);
97 
98   if (*p == 0) {
99     /* SID,LUN */
100     targ->controller = -1;
101     targ->sid = n1;
102     targ->lun = n2;
103   } else {
104     if (*p != ',') { return -6; }
105     p++;
106 
107     if (*p < '0' || '9' < *p) { return -7; }
108     n3 = strtol(p, &p, 0);
109 
110     if (*p != 0) { return -8; }
111 
112     targ->controller = n1;
113     targ->sid = n2;
114     targ->lun = n3;
115   }
116 
117   return 0;
118 }
119 
120 
ndmscsi_open(struct ndmconn * conn,char * dev_name)121 int ndmscsi_open(struct ndmconn* conn, char* dev_name)
122 {
123   int rc;
124 
125   NDMC_WITH(ndmp9_scsi_open, NDMP9VER)
126   request->device = dev_name;
127   rc = NDMC_CALL(conn);
128   NDMC_ENDWITH
129 
130   return rc;
131 }
132 
ndmscsi_close(struct ndmconn * conn)133 int ndmscsi_close(struct ndmconn* conn)
134 {
135   int rc;
136 
137   NDMC_WITH_VOID_REQUEST(ndmp9_scsi_close, NDMP9VER)
138   rc = NDMC_CALL(conn);
139   NDMC_ENDWITH
140 
141   return rc;
142 }
143 
ndmscsi_get_state(struct ndmconn * conn,struct ndmscsi_target * targ)144 int ndmscsi_get_state(struct ndmconn* conn, struct ndmscsi_target* targ)
145 {
146   int rc;
147 
148   NDMOS_MACRO_ZEROFILL(targ);
149 
150   NDMC_WITH_VOID_REQUEST(ndmp9_scsi_get_state, NDMP9VER)
151   rc = NDMC_CALL(conn);
152   targ->controller = reply->target_controller;
153   targ->sid = reply->target_id;
154   targ->lun = reply->target_lun;
155   NDMC_ENDWITH
156 
157   return rc;
158 }
159 
ndmscsi_set_target(struct ndmconn * conn,struct ndmscsi_target * targ)160 int ndmscsi_set_target(struct ndmconn* conn, struct ndmscsi_target* targ)
161 {
162   int rc;
163 
164   NDMC_WITH(ndmp9_scsi_set_target, NDMP9VER)
165   request->device = targ->dev_name;
166   request->target_controller = targ->controller;
167   request->target_id = targ->sid;
168   request->target_lun = targ->lun;
169   rc = NDMC_CALL(conn);
170   NDMC_ENDWITH
171 
172   return rc;
173 }
174 
ndmscsi_use(struct ndmconn * conn,struct ndmscsi_target * targ)175 int ndmscsi_use(struct ndmconn* conn, struct ndmscsi_target* targ)
176 {
177   int rc;
178 
179   rc = ndmscsi_open(conn, targ->dev_name);
180   if (rc) return rc;
181 
182   if (targ->controller != -1 || targ->sid != -1 || targ->lun != -1) {
183 #ifndef NDMOS_OPTION_NO_NDMP4
184     if (conn->protocol_version == NDMP4VER) {
185       return -1; /* can't set target */
186     }
187 #endif /* !NDMOS_OPTION_NO_NDMP4 */
188 
189     rc = ndmscsi_set_target(conn, targ);
190     if (rc) {
191       ndmscsi_close(conn); /* best effort */
192       return rc;
193     }
194   }
195 
196   return 0;
197 }
198 
ndmscsi_execute(struct ndmconn * conn,struct ndmscsi_request * req,struct ndmscsi_target * targ)199 int ndmscsi_execute(struct ndmconn* conn,
200                     struct ndmscsi_request* req,
201                     struct ndmscsi_target* targ)
202 {
203   int rc;
204 
205   if (targ) {
206     rc = ndmscsi_use(conn, targ);
207     if (rc) return rc;
208   }
209 
210   NDMC_WITH(ndmp9_scsi_execute_cdb, NDMP9VER)
211   request->cdb.cdb_len = req->n_cmd;
212   request->cdb.cdb_val = (char*)req->cmd;
213 
214   switch (req->data_dir) {
215     case NDMSCSI_DD_NONE:
216       request->data_dir = NDMP9_SCSI_DATA_DIR_NONE;
217       break;
218 
219     case NDMSCSI_DD_IN:
220       request->data_dir = NDMP9_SCSI_DATA_DIR_IN;
221       request->datain_len = req->n_data_avail;
222       break;
223 
224     case NDMSCSI_DD_OUT:
225       request->data_dir = NDMP9_SCSI_DATA_DIR_OUT;
226       request->dataout.dataout_len = req->n_data_avail;
227       request->dataout.dataout_val = (char*)req->data;
228       break;
229   }
230   request->timeout = 300000; /* five minutes */
231 
232   rc = NDMC_CALL(conn);
233   if (rc) {
234     req->completion_status = NDMSCSI_CS_FAIL;
235     return rc;
236   }
237 
238   req->status_byte = reply->status;
239   req->n_data_done = 0;
240   req->n_sense_data = 0;
241 
242   rc = reply->ext_sense.ext_sense_len;
243   if (rc > 0) {
244     if (rc > NDMSCSI_MAX_SENSE_DATA) rc = NDMSCSI_MAX_SENSE_DATA;
245 
246     req->n_sense_data = rc;
247     NDMOS_API_BCOPY(reply->ext_sense.ext_sense_val, req->sense_data, rc);
248   }
249 
250   switch (req->data_dir) {
251     case NDMSCSI_DD_IN:
252       req->n_data_done = reply->datain.datain_len;
253       if (req->n_data_done > 0) {
254         NDMOS_API_BCOPY(reply->datain.datain_val, req->data, req->n_data_done);
255       }
256       break;
257 
258     case NDMSCSI_DD_OUT:
259       req->n_data_done = reply->dataout_len;
260       break;
261   }
262   req->completion_status = NDMSCSI_CS_GOOD;
263 
264   NDMC_FREE_REPLY();
265   NDMC_ENDWITH
266 
267   return 0;
268 }
269