2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2010, LSI Corp.
6 * Author : Manjunath Ranganathaiah
7 * Support: freebsdraid@lsi.com
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
19 * 3. Neither the name of the <ORGANIZATION> nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
39 #include <dev/tws/tws.h>
40 #include <dev/tws/tws_services.h>
41 #include <dev/tws/tws_hdm.h>
42 #include <dev/tws/tws_user.h>
45 int tws_ioctl(struct cdev *dev, long unsigned int cmd, caddr_t buf, int flags,
47 void tws_passthru_complete(struct tws_request *req);
48 extern void tws_circular_aenq_insert(struct tws_softc *sc,
49 struct tws_circular_q *cq, struct tws_event_packet *aen);
52 static int tws_passthru(struct tws_softc *sc, void *buf);
53 static int tws_ioctl_aen(struct tws_softc *sc, u_long cmd, void *buf);
55 extern int tws_bus_scan(struct tws_softc *sc);
56 extern struct tws_request *tws_get_request(struct tws_softc *sc,
58 extern int32_t tws_map_request(struct tws_softc *sc, struct tws_request *req);
59 extern void tws_unmap_request(struct tws_softc *sc, struct tws_request *req);
60 extern uint8_t tws_get_state(struct tws_softc *sc);
61 extern void tws_timeout(void *arg);
64 tws_ioctl(struct cdev *dev, u_long cmd, caddr_t buf, int flags,
67 struct tws_softc *sc = (struct tws_softc *)(dev->si_drv1);
70 TWS_TRACE_DEBUG(sc, "entry", sc, cmd);
73 case TWS_IOCTL_FIRMWARE_PASS_THROUGH :
74 error = tws_passthru(sc, (void *)buf);
76 case TWS_IOCTL_SCAN_BUS :
77 TWS_TRACE_DEBUG(sc, "scan-bus", 0, 0);
78 error = tws_bus_scan(sc);
81 TWS_TRACE_DEBUG(sc, "ioctl-aen", cmd, buf);
82 error = tws_ioctl_aen(sc, cmd, (void *)buf);
90 tws_passthru(struct tws_softc *sc, void *buf)
92 struct tws_request *req;
93 struct tws_ioctl_no_data_buf *ubuf = (struct tws_ioctl_no_data_buf *)buf;
95 u_int32_t buffer_length;
98 buffer_length = roundup2(ubuf->driver_pkt.buffer_length, 512);
99 if ( buffer_length > TWS_MAX_IO_SIZE ) {
102 if ( tws_get_state(sc) != TWS_ONLINE) {
106 //==============================================================================================
110 req = tws_get_request(sc, TWS_REQ_TYPE_PASSTHRU);
112 error = tsleep(sc, 0, "tws_sleep", TWS_IOCTL_TIMEOUT*hz);
113 if ( error == EWOULDBLOCK ) {
117 // Make sure we are still ready for new commands...
118 if ( tws_get_state(sc) != TWS_ONLINE) {
125 req->length = buffer_length;
126 TWS_TRACE_DEBUG(sc, "datal,rid", req->length, req->request_id);
128 req->data = sc->ioctl_data_mem;
129 req->dma_map = sc->ioctl_data_map;
131 //==========================================================================================
132 // Copy data in from user space
134 error = copyin(ubuf->pdata, req->data, req->length);
137 //==============================================================================================
138 // Set command fields
140 req->flags = TWS_DIR_IN | TWS_DIR_OUT;
141 req->cb = tws_passthru_complete;
143 memcpy(&req->cmd_pkt->cmd, &ubuf->cmd_pkt.cmd,
144 sizeof(struct tws_command_apache));
146 if ( GET_OPCODE(req->cmd_pkt->cmd.pkt_a.res__opcode) ==
147 TWS_FW_CMD_EXECUTE_SCSI ) {
148 lun4 = req->cmd_pkt->cmd.pkt_a.lun_l4__req_id & 0xF000;
149 req->cmd_pkt->cmd.pkt_a.lun_l4__req_id = lun4 | req->request_id;
151 req->cmd_pkt->cmd.pkt_g.generic.request_id = (u_int8_t) req->request_id;
154 //==============================================================================================
155 // Send command to controller
157 error = tws_map_request(sc, req);
159 ubuf->driver_pkt.os_status = error;
163 if ( req->state == TWS_REQ_STATE_COMPLETE ) {
164 ubuf->driver_pkt.os_status = req->error_code;
168 mtx_lock(&sc->gen_lock);
169 error = mtx_sleep(req, &sc->gen_lock, 0, "tws_passthru", TWS_IOCTL_TIMEOUT*hz);
170 mtx_unlock(&sc->gen_lock);
171 if (( req->state != TWS_REQ_STATE_COMPLETE ) && ( error == EWOULDBLOCK )) {
172 TWS_TRACE_DEBUG(sc, "msleep timeout", error, req->request_id);
173 tws_timeout((void*) req);
177 if ( req->error_code == TWS_REQ_RET_RESET ) {
179 req->error_code = EBUSY;
180 TWS_TRACE_DEBUG(sc, "ioctl reset", error, req->request_id);
183 tws_unmap_request(sc, req);
185 //==============================================================================================
186 // Return command status to user space
188 memcpy(&ubuf->cmd_pkt.hdr, &req->cmd_pkt->hdr, sizeof(struct tws_command_apache));
189 memcpy(&ubuf->cmd_pkt.cmd, &req->cmd_pkt->cmd, sizeof(struct tws_command_apache));
193 //==========================================================================================
194 // Copy data out to user space
197 error = copyout(req->data, ubuf->pdata, ubuf->driver_pkt.buffer_length);
201 TWS_TRACE_DEBUG(sc, "errored", error, 0);
203 if ( req->error_code != TWS_REQ_RET_SUBMIT_SUCCESS )
204 ubuf->driver_pkt.os_status = error;
206 //==============================================================================================
209 req->state = TWS_REQ_STATE_FREE;
217 tws_passthru_complete(struct tws_request *req)
219 req->state = TWS_REQ_STATE_COMPLETE;
225 tws_retrive_aen(struct tws_softc *sc, u_long cmd,
226 struct tws_ioctl_packet *ubuf)
229 struct tws_event_packet eventp, *qp;
231 if ( sc->aen_q.head == sc->aen_q.tail ) {
232 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
236 ubuf->driver_pkt.status = 0;
239 * once this flag is set cli will not display alarms
240 * needs a revisit from tools?
242 if ( sc->aen_q.overflow ) {
243 ubuf->driver_pkt.status = TWS_AEN_OVERFLOW;
244 sc->aen_q.overflow = 0; /* reset */
247 qp = (struct tws_event_packet *)sc->aen_q.q;
250 case TWS_IOCTL_GET_FIRST_EVENT :
251 index = sc->aen_q.head;
253 case TWS_IOCTL_GET_LAST_EVENT :
255 index = (sc->aen_q.depth + sc->aen_q.tail - 1) % sc->aen_q.depth;
257 case TWS_IOCTL_GET_NEXT_EVENT :
258 memcpy(&eventp, ubuf->data_buf, sizeof(struct tws_event_packet));
259 index = sc->aen_q.head;
261 if ( qp[index].sequence_id ==
262 (eventp.sequence_id + 1) )
264 index = (index+1) % sc->aen_q.depth;
265 }while ( index != sc->aen_q.tail );
266 if ( index == sc->aen_q.tail ) {
267 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
271 case TWS_IOCTL_GET_PREVIOUS_EVENT :
272 memcpy(&eventp, ubuf->data_buf, sizeof(struct tws_event_packet));
273 index = sc->aen_q.head;
275 if ( qp[index].sequence_id ==
276 (eventp.sequence_id - 1) )
278 index = (index+1) % sc->aen_q.depth;
279 }while ( index != sc->aen_q.tail );
280 if ( index == sc->aen_q.tail ) {
281 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
286 TWS_TRACE_DEBUG(sc, "not a valid event", sc, cmd);
287 ubuf->driver_pkt.status = TWS_AEN_NO_EVENTS;
291 memcpy(ubuf->data_buf, &qp[index],
292 sizeof(struct tws_event_packet));
293 qp[index].retrieved = TWS_AEN_RETRIEVED;
300 tws_ioctl_aen(struct tws_softc *sc, u_long cmd, void *buf)
303 struct tws_ioctl_packet *ubuf = (struct tws_ioctl_packet *)buf;
304 struct tws_compatibility_packet cpkt;
305 struct tws_lock_packet lpkt;
308 mtx_lock(&sc->gen_lock);
309 ubuf->driver_pkt.status = 0;
311 case TWS_IOCTL_GET_FIRST_EVENT :
312 case TWS_IOCTL_GET_LAST_EVENT :
313 case TWS_IOCTL_GET_NEXT_EVENT :
314 case TWS_IOCTL_GET_PREVIOUS_EVENT :
315 tws_retrive_aen(sc,cmd,ubuf);
317 case TWS_IOCTL_GET_LOCK :
318 ctime = TWS_LOCAL_TIME;
319 memcpy(&lpkt, ubuf->data_buf, sizeof(struct tws_lock_packet));
320 if ( (sc->ioctl_lock.lock == TWS_IOCTL_LOCK_FREE) ||
322 (ctime >= sc->ioctl_lock.timeout) ) {
323 sc->ioctl_lock.lock = TWS_IOCTL_LOCK_HELD;
324 sc->ioctl_lock.timeout = ctime + (lpkt.timeout_msec / 1000);
325 lpkt.time_remaining_msec = lpkt.timeout_msec;
327 lpkt.time_remaining_msec = (u_int32_t)
328 ((sc->ioctl_lock.timeout - ctime) * 1000);
329 ubuf->driver_pkt.status = TWS_IOCTL_LOCK_ALREADY_HELD;
333 case TWS_IOCTL_RELEASE_LOCK :
334 if (sc->ioctl_lock.lock == TWS_IOCTL_LOCK_FREE) {
335 ubuf->driver_pkt.status = TWS_IOCTL_LOCK_NOT_HELD;
337 sc->ioctl_lock.lock = TWS_IOCTL_LOCK_FREE;
338 ubuf->driver_pkt.status = 0;
341 case TWS_IOCTL_GET_COMPATIBILITY_INFO :
342 TWS_TRACE_DEBUG(sc, "get comp info", sc, cmd);
344 memcpy( cpkt.driver_version, TWS_DRIVER_VERSION_STRING,
345 sizeof(TWS_DRIVER_VERSION_STRING));
346 cpkt.working_srl = sc->cinfo.working_srl;
347 cpkt.working_branch = sc->cinfo.working_branch;
348 cpkt.working_build = sc->cinfo.working_build;
349 cpkt.driver_srl_high = TWS_CURRENT_FW_SRL;
350 cpkt.driver_branch_high = TWS_CURRENT_FW_BRANCH;
351 cpkt.driver_build_high = TWS_CURRENT_FW_BUILD;
352 cpkt.driver_srl_low = TWS_BASE_FW_SRL;
353 cpkt.driver_branch_low = TWS_BASE_FW_BRANCH;
354 cpkt.driver_build_low = TWS_BASE_FW_BUILD;
355 cpkt.fw_on_ctlr_srl = sc->cinfo.fw_on_ctlr_srl;
356 cpkt.fw_on_ctlr_branch = sc->cinfo.fw_on_ctlr_branch;
357 cpkt.fw_on_ctlr_build = sc->cinfo.fw_on_ctlr_build;
358 ubuf->driver_pkt.status = 0;
359 int len = sizeof(struct tws_compatibility_packet);
360 if ( ubuf->driver_pkt.buffer_length < len )
361 len = ubuf->driver_pkt.buffer_length;
362 memcpy(ubuf->data_buf, &cpkt, len);
366 TWS_TRACE_DEBUG(sc, "not valid cmd", cmd,
367 TWS_IOCTL_GET_COMPATIBILITY_INFO);
371 mtx_unlock(&sc->gen_lock);
377 tws_circular_aenq_insert(struct tws_softc *sc, struct tws_circular_q *cq,
378 struct tws_event_packet *aen)
381 struct tws_event_packet *q = (struct tws_event_packet *)cq->q;
382 volatile u_int16_t head, tail;
384 mtx_assert(&sc->gen_lock, MA_OWNED);
388 retr = q[tail].retrieved;
390 memcpy(&q[tail], aen, sizeof(struct tws_event_packet));
391 tail = (tail+1) % cq->depth;
393 if ( head == tail ) { /* q is full */
394 if ( retr != TWS_AEN_RETRIEVED )
396 cq->head = (head+1) % cq->depth;