xref: /netbsd-src/sys/dev/sdmmc/ld_sdmmc.c (revision 6a493d6bc668897c91594964a732d38505b70cbb)
1 /*	$NetBSD: ld_sdmmc.c,v 1.12 2013/10/12 16:49:01 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 2008 KIYOHARA Takashi
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  * 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 ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
20  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
24  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
25  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  *
28  */
29 
30 #include <sys/cdefs.h>
31 __KERNEL_RCSID(0, "$NetBSD: ld_sdmmc.c,v 1.12 2013/10/12 16:49:01 christos Exp $");
32 
33 #ifdef _KERNEL_OPT
34 #include "opt_sdmmc.h"
35 #endif
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
40 #include <sys/device.h>
41 #include <sys/buf.h>
42 #include <sys/bufq.h>
43 #include <sys/bus.h>
44 #include <sys/callout.h>
45 #include <sys/endian.h>
46 #include <sys/dkio.h>
47 #include <sys/disk.h>
48 #include <sys/kthread.h>
49 #include <sys/rnd.h>
50 
51 #include <dev/ldvar.h>
52 
53 #include <dev/sdmmc/sdmmcvar.h>
54 
55 #ifdef SDMMC_DEBUG
56 #define DPRINTF(s)	printf s
57 #else
58 #define DPRINTF(s)	/**/
59 #endif
60 
61 struct ld_sdmmc_softc;
62 
63 struct ld_sdmmc_task {
64 	struct sdmmc_task task;
65 
66 	struct ld_sdmmc_softc *task_sc;
67 	struct buf *task_bp;
68 	callout_t task_callout;
69 };
70 
71 struct ld_sdmmc_softc {
72 	struct ld_softc sc_ld;
73 	int sc_hwunit;
74 
75 	struct sdmmc_function *sc_sf;
76 	struct ld_sdmmc_task sc_task;
77 };
78 
79 static int ld_sdmmc_match(device_t, cfdata_t, void *);
80 static void ld_sdmmc_attach(device_t, device_t, void *);
81 static int ld_sdmmc_detach(device_t, int);
82 
83 static int ld_sdmmc_dump(struct ld_softc *, void *, int, int);
84 static int ld_sdmmc_start(struct ld_softc *, struct buf *);
85 
86 static void ld_sdmmc_doattach(void *);
87 static void ld_sdmmc_dobio(void *);
88 static void ld_sdmmc_timeout(void *);
89 
90 CFATTACH_DECL_NEW(ld_sdmmc, sizeof(struct ld_sdmmc_softc),
91     ld_sdmmc_match, ld_sdmmc_attach, ld_sdmmc_detach, NULL);
92 
93 
94 /* ARGSUSED */
95 static int
96 ld_sdmmc_match(device_t parent, cfdata_t match, void *aux)
97 {
98 	struct sdmmc_softc *sdmsc = device_private(parent);
99 
100 	if (ISSET(sdmsc->sc_flags, SMF_MEM_MODE))
101 		return 1;
102 	return 0;
103 }
104 
105 /* ARGSUSED */
106 static void
107 ld_sdmmc_attach(device_t parent, device_t self, void *aux)
108 {
109 	struct ld_sdmmc_softc *sc = device_private(self);
110 	struct sdmmc_attach_args *sa = aux;
111 	struct ld_softc *ld = &sc->sc_ld;
112 	struct lwp *lwp;
113 
114 	ld->sc_dv = self;
115 
116 	aprint_normal(": <0x%02x:0x%04x:%s:0x%02x:0x%08x:0x%03x>\n",
117 	    sa->sf->cid.mid, sa->sf->cid.oid, sa->sf->cid.pnm,
118 	    sa->sf->cid.rev, sa->sf->cid.psn, sa->sf->cid.mdt);
119 	aprint_naive("\n");
120 
121 	callout_init(&sc->sc_task.task_callout, CALLOUT_MPSAFE);
122 
123 	sc->sc_hwunit = 0;	/* always 0? */
124 	sc->sc_sf = sa->sf;
125 
126 	ld->sc_flags = LDF_ENABLED;
127 	ld->sc_secperunit = sc->sc_sf->csd.capacity;
128 	ld->sc_secsize = SDMMC_SECTOR_SIZE;
129 	ld->sc_maxxfer = MAXPHYS;
130 	ld->sc_maxqueuecnt = 1;
131 	ld->sc_dump = ld_sdmmc_dump;
132 	ld->sc_start = ld_sdmmc_start;
133 
134 	/*
135 	 * It is avoided that the error occurs when the card attaches it,
136 	 * when wedge is supported.
137 	 */
138 	config_pending_incr(self);
139 	if (kthread_create(PRI_NONE, KTHREAD_MPSAFE, NULL,
140 	    ld_sdmmc_doattach, sc, &lwp, "%sattach", device_xname(self))) {
141 		aprint_error_dev(self, "couldn't create thread\n");
142 	}
143 }
144 
145 static void
146 ld_sdmmc_doattach(void *arg)
147 {
148 	struct ld_sdmmc_softc *sc = (struct ld_sdmmc_softc *)arg;
149 	struct ld_softc *ld = &sc->sc_ld;
150 	struct sdmmc_softc *ssc = device_private(device_parent(ld->sc_dv));
151 
152 	ldattach(ld);
153 	aprint_normal_dev(ld->sc_dv, "%d-bit width, bus clock",
154 	    sc->sc_sf->width);
155 	if ((ssc->sc_busclk / 1000) != 0)
156 		aprint_normal(" %u.%03u MHz\n",
157 		    ssc->sc_busclk / 1000, ssc->sc_busclk % 1000);
158 	else
159 		aprint_normal(" %u KHz\n", ssc->sc_busclk % 1000);
160 	config_pending_decr(ld->sc_dv);
161 	kthread_exit(0);
162 }
163 
164 static int
165 ld_sdmmc_detach(device_t dev, int flags)
166 {
167 	struct ld_sdmmc_softc *sc = device_private(dev);
168 	struct ld_softc *ld = &sc->sc_ld;
169 	int rv;
170 
171 	if ((rv = ldbegindetach(ld, flags)) != 0)
172 		return rv;
173 	ldenddetach(ld);
174 
175 	return 0;
176 }
177 
178 static int
179 ld_sdmmc_start(struct ld_softc *ld, struct buf *bp)
180 {
181 	struct ld_sdmmc_softc *sc = device_private(ld->sc_dv);
182 	struct ld_sdmmc_task *task = &sc->sc_task;
183 
184 	task->task_sc = sc;
185 	task->task_bp = bp;
186 	sdmmc_init_task(&task->task, ld_sdmmc_dobio, task);
187 
188 	callout_reset(&task->task_callout, hz, ld_sdmmc_timeout, task);
189 	sdmmc_add_task(sc->sc_sf->sc, &task->task);
190 
191 	return 0;
192 }
193 
194 static void
195 ld_sdmmc_dobio(void *arg)
196 {
197 	struct ld_sdmmc_task *task = (struct ld_sdmmc_task *)arg;
198 	struct ld_sdmmc_softc *sc = task->task_sc;
199 	struct buf *bp = task->task_bp;
200 	int error, s;
201 
202 	callout_stop(&task->task_callout);
203 
204 	/*
205 	 * I/O operation
206 	 */
207 	DPRINTF(("%s: I/O operation (dir=%s, blkno=0x%jx, bcnt=0x%x)\n",
208 	    device_xname(sc->sc_ld.sc_dv), bp->b_flags & B_READ ? "IN" : "OUT",
209 	    bp->b_rawblkno, bp->b_bcount));
210 
211 	/* is everything done in terms of blocks? */
212 	if (bp->b_rawblkno >= sc->sc_sf->csd.capacity) {
213 		/* trying to read or write past end of device */
214 		DPRINTF(("%s: blkno exceeds capacity 0x%x\n",
215 		    device_xname(sc->sc_ld.sc_dv), sc->sc_sf->csd.capacity));
216 		bp->b_error = EIO; /* XXX  */
217 		bp->b_resid = bp->b_bcount;
218 		lddone(&sc->sc_ld, bp);
219 		return;
220 	}
221 
222 	s = splbio();
223 	if (bp->b_flags & B_READ)
224 		error = sdmmc_mem_read_block(sc->sc_sf, bp->b_rawblkno,
225 		    bp->b_data, bp->b_bcount);
226 	else
227 		error = sdmmc_mem_write_block(sc->sc_sf, bp->b_rawblkno,
228 		    bp->b_data, bp->b_bcount);
229 	if (error) {
230 		DPRINTF(("%s: error %d\n", device_xname(sc->sc_ld.sc_dv),
231 		    error));
232 		bp->b_error = EIO;	/* XXXX */
233 		bp->b_resid = bp->b_bcount;
234 	} else {
235 		bp->b_resid = 0;
236 	}
237 	splx(s);
238 
239 	lddone(&sc->sc_ld, bp);
240 }
241 
242 static void
243 ld_sdmmc_timeout(void *arg)
244 {
245 	struct ld_sdmmc_task *task = (struct ld_sdmmc_task *)arg;
246 	struct ld_sdmmc_softc *sc = task->task_sc;
247 	struct buf *bp = task->task_bp;
248 	int s;
249 
250 	s = splbio();
251 	if (!sdmmc_task_pending(&task->task)) {
252 		splx(s);
253 		return;
254 	}
255 	bp->b_error = EIO;	/* XXXX */
256 	bp->b_resid = bp->b_bcount;
257 	sdmmc_del_task(&task->task);
258 	splx(s);
259 
260 	lddone(&sc->sc_ld, bp);
261 }
262 
263 static int
264 ld_sdmmc_dump(struct ld_softc *ld, void *data, int blkno, int blkcnt)
265 {
266 	struct ld_sdmmc_softc *sc = device_private(ld->sc_dv);
267 
268 	return sdmmc_mem_write_block(sc->sc_sf, blkno, data,
269 	    blkcnt * ld->sc_secsize);
270 }
271