xref: /dragonfly/sys/bus/firewire/fwmem.c (revision 8a7bdfea)
1 /*
2  * Copyright (c) 2002-2003
3  * 	Hidetoshi Shimokawa. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *
16  *	This product includes software developed by Hidetoshi Shimokawa.
17  *
18  * 4. Neither the name of the author nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/bus/firewire/fwmem.c,v 1.16 2008/01/06 16:55:49 swildner Exp $
35  */
36 
37 #ifndef __DragonFly__
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD: src/sys/dev/firewire/fwmem.c,v 1.26 2004/01/05 14:21:18 simokawa Exp $");
40 #endif
41 
42 #include <sys/param.h>
43 #include <sys/systm.h>
44 #include <sys/types.h>
45 
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/conf.h>
49 #include <sys/bus.h>
50 #include <sys/sysctl.h>
51 #if defined(__DragonFly__) || __FreeBSD_version < 500000
52 #include <sys/buf.h>
53 #else
54 #include <sys/bio.h>
55 #endif
56 
57 #include <sys/signal.h>
58 #include <sys/mman.h>
59 #include <sys/ioccom.h>
60 #include <sys/fcntl.h>
61 #include <sys/thread2.h>
62 
63 #ifdef __DragonFly__
64 #include "firewire.h"
65 #include "firewirereg.h"
66 #include "fwmem.h"
67 #else
68 #include <dev/firewire/firewire.h>
69 #include <dev/firewire/firewirereg.h>
70 #include <dev/firewire/fwmem.h>
71 #endif
72 
73 static int fwmem_speed=2, fwmem_debug=0;
74 static struct fw_eui64 fwmem_eui64;
75 SYSCTL_DECL(_hw_firewire);
76 SYSCTL_NODE(_hw_firewire, OID_AUTO, fwmem, CTLFLAG_RD, 0,
77 	"FireWire Memory Access");
78 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_hi, CTLFLAG_RW,
79 	&fwmem_eui64.hi, 0, "Fwmem target EUI64 high");
80 SYSCTL_UINT(_hw_firewire_fwmem, OID_AUTO, eui64_lo, CTLFLAG_RW,
81 	&fwmem_eui64.lo, 0, "Fwmem target EUI64 low");
82 SYSCTL_INT(_hw_firewire_fwmem, OID_AUTO, speed, CTLFLAG_RW, &fwmem_speed, 0,
83 	"Fwmem link speed");
84 SYSCTL_INT(_debug, OID_AUTO, fwmem_debug, CTLFLAG_RW, &fwmem_debug, 0,
85 	"Fwmem driver debug flag");
86 
87 MALLOC_DEFINE(M_FWMEM, "fwmem", "fwmem/FireWire");
88 
89 #define MAXLEN (512 << fwmem_speed)
90 
91 struct fwmem_softc {
92 	struct fw_eui64 eui;
93 	int refcount;
94 };
95 
96 static struct fw_xfer *
97 fwmem_xfer_req(
98 	struct fw_device *fwdev,
99 	caddr_t sc,
100 	int spd,
101 	int slen,
102 	int rlen,
103 	void *hand)
104 {
105 	struct fw_xfer *xfer;
106 
107 	xfer = fw_xfer_alloc(M_FWMEM);
108 	if (xfer == NULL)
109 		return NULL;
110 
111 	xfer->fc = fwdev->fc;
112 	xfer->send.hdr.mode.hdr.dst = FWLOCALBUS | fwdev->dst;
113 	if (spd < 0)
114 		xfer->send.spd = fwdev->speed;
115 	else
116 		xfer->send.spd = min(spd, fwdev->speed);
117 	xfer->act.hand = hand;
118 	xfer->retry_req = fw_asybusy;
119 	xfer->sc = sc;
120 	xfer->send.pay_len = slen;
121 	xfer->recv.pay_len = rlen;
122 
123 	return xfer;
124 }
125 
126 struct fw_xfer *
127 fwmem_read_quad(
128 	struct fw_device *fwdev,
129 	caddr_t	sc,
130 	u_int8_t spd,
131 	u_int16_t dst_hi,
132 	u_int32_t dst_lo,
133 	void *data,
134 	void (*hand)(struct fw_xfer *))
135 {
136 	struct fw_xfer *xfer;
137 	struct fw_pkt *fp;
138 
139 	xfer = fwmem_xfer_req(fwdev, (void *)sc, spd, 0, 4, hand);
140 	if (xfer == NULL) {
141 		return NULL;
142 	}
143 
144 	fp = &xfer->send.hdr;
145 	fp->mode.rreqq.tcode = FWTCODE_RREQQ;
146 	fp->mode.rreqq.dest_hi = dst_hi;
147 	fp->mode.rreqq.dest_lo = dst_lo;
148 
149 	xfer->send.payload = NULL;
150 	xfer->recv.payload = (u_int32_t *)data;
151 
152 	if (fwmem_debug)
153 		kprintf("fwmem_read_quad: %d %04x:%08x\n", fwdev->dst,
154 				dst_hi, dst_lo);
155 
156 	if (fw_asyreq(xfer->fc, -1, xfer) == 0)
157 		return xfer;
158 
159 	fw_xfer_free(xfer);
160 	return NULL;
161 }
162 
163 struct fw_xfer *
164 fwmem_write_quad(
165 	struct fw_device *fwdev,
166 	caddr_t	sc,
167 	u_int8_t spd,
168 	u_int16_t dst_hi,
169 	u_int32_t dst_lo,
170 	void *data,
171 	void (*hand)(struct fw_xfer *))
172 {
173 	struct fw_xfer *xfer;
174 	struct fw_pkt *fp;
175 
176 	xfer = fwmem_xfer_req(fwdev, sc, spd, 0, 0, hand);
177 	if (xfer == NULL)
178 		return NULL;
179 
180 	fp = &xfer->send.hdr;
181 	fp->mode.wreqq.tcode = FWTCODE_WREQQ;
182 	fp->mode.wreqq.dest_hi = dst_hi;
183 	fp->mode.wreqq.dest_lo = dst_lo;
184 	fp->mode.wreqq.data = *(u_int32_t *)data;
185 
186 	xfer->send.payload = xfer->recv.payload = NULL;
187 
188 	if (fwmem_debug)
189 		kprintf("fwmem_write_quad: %d %04x:%08x %08x\n", fwdev->dst,
190 			dst_hi, dst_lo, *(u_int32_t *)data);
191 
192 	if (fw_asyreq(xfer->fc, -1, xfer) == 0)
193 		return xfer;
194 
195 	fw_xfer_free(xfer);
196 	return NULL;
197 }
198 
199 struct fw_xfer *
200 fwmem_read_block(
201 	struct fw_device *fwdev,
202 	caddr_t	sc,
203 	u_int8_t spd,
204 	u_int16_t dst_hi,
205 	u_int32_t dst_lo,
206 	int len,
207 	void *data,
208 	void (*hand)(struct fw_xfer *))
209 {
210 	struct fw_xfer *xfer;
211 	struct fw_pkt *fp;
212 
213 	xfer = fwmem_xfer_req(fwdev, sc, spd, 0, roundup2(len, 4), hand);
214 	if (xfer == NULL)
215 		return NULL;
216 
217 	fp = &xfer->send.hdr;
218 	fp->mode.rreqb.tcode = FWTCODE_RREQB;
219 	fp->mode.rreqb.dest_hi = dst_hi;
220 	fp->mode.rreqb.dest_lo = dst_lo;
221 	fp->mode.rreqb.len = len;
222 	fp->mode.rreqb.extcode = 0;
223 
224 	xfer->send.payload = NULL;
225 	xfer->recv.payload = data;
226 
227 	if (fwmem_debug)
228 		kprintf("fwmem_read_block: %d %04x:%08x %d\n", fwdev->dst,
229 				dst_hi, dst_lo, len);
230 	if (fw_asyreq(xfer->fc, -1, xfer) == 0)
231 		return xfer;
232 
233 	fw_xfer_free(xfer);
234 	return NULL;
235 }
236 
237 struct fw_xfer *
238 fwmem_write_block(
239 	struct fw_device *fwdev,
240 	caddr_t	sc,
241 	u_int8_t spd,
242 	u_int16_t dst_hi,
243 	u_int32_t dst_lo,
244 	int len,
245 	void *data,
246 	void (*hand)(struct fw_xfer *))
247 {
248 	struct fw_xfer *xfer;
249 	struct fw_pkt *fp;
250 
251 	xfer = fwmem_xfer_req(fwdev, sc, spd, len, 0, hand);
252 	if (xfer == NULL)
253 		return NULL;
254 
255 	fp = &xfer->send.hdr;
256 	fp->mode.wreqb.tcode = FWTCODE_WREQB;
257 	fp->mode.wreqb.dest_hi = dst_hi;
258 	fp->mode.wreqb.dest_lo = dst_lo;
259 	fp->mode.wreqb.len = len;
260 	fp->mode.wreqb.extcode = 0;
261 
262 	xfer->send.payload = data;
263 	xfer->recv.payload = NULL;
264 
265 	if (fwmem_debug)
266 		kprintf("fwmem_write_block: %d %04x:%08x %d\n", fwdev->dst,
267 				dst_hi, dst_lo, len);
268 	if (fw_asyreq(xfer->fc, -1, xfer) == 0)
269 		return xfer;
270 
271 	fw_xfer_free(xfer);
272 	return NULL;
273 }
274 
275 
276 int
277 fwmem_open (struct dev_open_args *ap)
278 {
279 	cdev_t dev = ap->a_head.a_dev;
280 	struct fwmem_softc *fms;
281 
282 	if (dev->si_drv1 != NULL) {
283 		if ((ap->a_oflags & FWRITE) != 0)
284 			return (EBUSY);
285 		fms = (struct fwmem_softc *)dev->si_drv1;
286 		fms->refcount ++;
287 	} else {
288 		fms = (struct fwmem_softc *)kmalloc(sizeof(struct fwmem_softc),
289 							M_FWMEM, M_WAITOK);
290 		bcopy(&fwmem_eui64, &fms->eui, sizeof(struct fw_eui64));
291 		dev->si_drv1 = (void *)fms;
292 		dev->si_iosize_max = DFLTPHYS;
293 		fms->refcount = 1;
294 	}
295 	if (fwmem_debug)
296 		kprintf("%s: refcount=%d\n", __func__, fms->refcount);
297 
298 	return (0);
299 }
300 
301 int
302 fwmem_close (struct dev_close_args *ap)
303 {
304 	cdev_t dev = ap->a_head.a_dev;
305 	struct fwmem_softc *fms;
306 
307 	fms = (struct fwmem_softc *)dev->si_drv1;
308 	fms->refcount --;
309 	if (fwmem_debug)
310 		kprintf("%s: refcount=%d\n", __func__, fms->refcount);
311 	if (fms->refcount < 1) {
312 		kfree(dev->si_drv1, M_FW);
313 		dev->si_drv1 = NULL;
314 	}
315 
316 	return (0);
317 }
318 
319 
320 static void
321 fwmem_biodone(struct fw_xfer *xfer)
322 {
323 	struct bio *bio;
324 	struct buf *bp;
325 
326 	bio = (struct bio *)xfer->sc;
327 	bp = bio->bio_buf;
328 	bp->b_error = xfer->resp;
329 
330 	if (bp->b_error != 0) {
331 		if (fwmem_debug)
332 			kprintf("%s: err=%d\n", __func__, bp->b_error);
333 		bp->b_flags |= B_ERROR;
334 		bp->b_resid = bp->b_bcount;
335 	}
336 	fw_xfer_free(xfer);
337 	biodone(bio);
338 }
339 
340 int
341 fwmem_strategy(struct dev_strategy_args *ap)
342 {
343 	cdev_t dev = ap->a_head.a_dev;
344 	struct bio *bio = ap->a_bio;
345 	struct buf *bp = bio->bio_buf;
346 	struct firewire_softc *sc;
347 	struct fwmem_softc *fms;
348 	struct fw_device *fwdev;
349 	struct fw_xfer *xfer;
350 	int unit, err=0, iolen;
351 
352 	/* XXX check request length */
353 
354         unit = DEV2UNIT(dev);
355 	sc = devclass_get_softc(firewire_devclass, unit);
356 
357 	crit_enter();
358 	fms = (struct fwmem_softc *)dev->si_drv1;
359 	fwdev = fw_noderesolve_eui64(sc->fc, &fms->eui);
360 	if (fwdev == NULL) {
361 		if (fwmem_debug)
362 			kprintf("fwmem: no such device ID:%08x%08x\n",
363 					fms->eui.hi, fms->eui.lo);
364 		err = EINVAL;
365 		goto error;
366 	}
367 	if (bio->bio_offset == NOOFFSET) {
368 		kprintf("fwmem: offset was not set bp %p\n", bp);
369 		err = EINVAL;
370 		goto error;
371 	}
372 
373 	iolen = MIN(bp->b_bcount, MAXLEN);
374 	if (bp->b_cmd == BUF_CMD_READ) {
375 		if (iolen == 4 && (bio->bio_offset & 3) == 0)
376 			xfer = fwmem_read_quad(fwdev,
377 			    (void *) bio, fwmem_speed,
378 			    bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
379 			    bp->b_data, fwmem_biodone);
380 		else
381 			xfer = fwmem_read_block(fwdev,
382 			    (void *) bio, fwmem_speed,
383 			    bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
384 			    iolen, bp->b_data, fwmem_biodone);
385 	} else {
386 		if (iolen == 4 && (bio->bio_offset & 3) == 0)
387 			xfer = fwmem_write_quad(fwdev,
388 			    (void *)bio, fwmem_speed,
389 			    bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
390 			    bp->b_data, fwmem_biodone);
391 		else
392 			xfer = fwmem_write_block(fwdev,
393 			    (void *)bio, fwmem_speed,
394 			    bio->bio_offset >> 32, bio->bio_offset & 0xffffffff,
395 			    iolen, bp->b_data, fwmem_biodone);
396 	}
397 	if (xfer == NULL) {
398 		err = EIO;
399 		goto error;
400 	}
401 	/* XXX */
402 	bp->b_resid = bp->b_bcount - iolen;
403 error:
404 	crit_exit();
405 	if (err != 0) {
406 		if (fwmem_debug)
407 			kprintf("%s: err=%d\n", __func__, err);
408 		bp->b_error = err;
409 		bp->b_flags |= B_ERROR;
410 		bp->b_resid = bp->b_bcount;
411 		biodone(bio);
412 	}
413 	return(0);
414 }
415 
416 int
417 fwmem_ioctl(struct dev_ioctl_args *ap)
418 {
419 	cdev_t dev = ap->a_head.a_dev;
420 	struct fwmem_softc *fms;
421 	int err = 0;
422 
423 	fms = (struct fwmem_softc *)dev->si_drv1;
424 	switch (ap->a_cmd) {
425 	case FW_SDEUI64:
426 		bcopy(ap->a_data, &fms->eui, sizeof(struct fw_eui64));
427 		break;
428 	case FW_GDEUI64:
429 		bcopy(&fms->eui, ap->a_data, sizeof(struct fw_eui64));
430 		break;
431 	default:
432 		err = EINVAL;
433 	}
434 	return(err);
435 }
436 int
437 fwmem_poll(struct dev_poll_args *ap)
438 {
439 	return EINVAL;
440 }
441 int
442 fwmem_mmap(struct dev_mmap_args *ap)
443 {
444 	return EINVAL;
445 }
446