source: mainline/uspace/drv/block/ddisk/ddisk.c@ 96323d2

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 96323d2 was 73e894c, checked in by Jakub Jermar <jakub@…>, 11 years ago

Unregister ddisk interrupt in ddisk_dev_remove_common().
  • Property mode set to 100644
File size: 13.2 KB
Line 
1/*
2 * Copyright (c) 2015 Jakub Jermar
3 * Copyright (c) 2013 Jiri Svoboda
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 *
10 * - Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * - 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 * - The name of the author may not be used to endorse or promote products
16 * derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29
30/** @file
31 * MSIM ddisk block device driver
32 */
33
34#include <assert.h>
35#include <stdio.h>
36#include <errno.h>
37#include <str_error.h>
38#include <ddf/driver.h>
39#include <ddf/interrupt.h>
40#include <ddf/log.h>
41#include <device/hw_res_parsed.h>
42#include <ddi.h>
43#include <bd_srv.h>
44#include <fibril_synch.h>
45#include <as.h>
46
47#define NAME "ddisk"
48
49#define DDISK_FUN_NAME "a"
50
51#define DDISK_BLOCK_SIZE 512
52
53#define DDISK_STAT_IRQ_PENDING 0x4
54#define DDISK_CMD_READ 0x1
55#define DDISK_CMD_WRITE 0x2
56#define DDISK_CMD_IRQ_DEASSERT 0x4
57
58static int ddisk_dev_add(ddf_dev_t *);
59static int ddisk_dev_remove(ddf_dev_t *);
60static int ddisk_dev_gone(ddf_dev_t *);
61static int ddisk_fun_online(ddf_fun_t *);
62static int ddisk_fun_offline(ddf_fun_t *);
63
64static void ddisk_bd_connection(ipc_callid_t, ipc_call_t *, void *);
65
66static void ddisk_irq_handler(ipc_callid_t, ipc_call_t *, ddf_dev_t *);
67
68static driver_ops_t driver_ops = {
69 .dev_add = ddisk_dev_add,
70 .dev_remove = ddisk_dev_remove,
71 .dev_gone = ddisk_dev_gone,
72 .fun_online = ddisk_fun_online,
73 .fun_offline = ddisk_fun_offline
74};
75
76static driver_t ddisk_driver = {
77 .name = NAME,
78 .driver_ops = &driver_ops
79};
80
81typedef struct {
82 int irq;
83 uintptr_t base;
84} ddisk_res_t;
85
86typedef struct {
87 ioport32_t dma_buffer;
88 ioport32_t block;
89 union {
90 ioport32_t status;
91 ioport32_t command;
92 };
93 ioport32_t size;
94} ddisk_regs_t;
95
96typedef struct {
97 fibril_mutex_t lock;
98
99 fibril_condvar_t io_cv;
100 bool io_busy;
101
102 ssize_t size;
103 size_t blocks;
104
105 uintptr_t dma_buffer_phys;
106 void *dma_buffer;
107
108 ddf_dev_t *dev;
109 ddf_fun_t *fun;
110
111 ddisk_res_t ddisk_res;
112 ddisk_regs_t *ddisk_regs;
113
114 bd_srvs_t bds;
115} ddisk_t;
116
117static int ddisk_bd_open(bd_srvs_t *, bd_srv_t *);
118static int ddisk_bd_close(bd_srv_t *);
119static int ddisk_bd_read_blocks(bd_srv_t *, aoff64_t, size_t, void *, size_t);
120static int ddisk_bd_write_blocks(bd_srv_t *, aoff64_t, size_t, const void *,
121 size_t);
122static int ddisk_bd_get_block_size(bd_srv_t *, size_t *);
123static int ddisk_bd_get_num_blocks(bd_srv_t *, aoff64_t *);
124
125bd_ops_t ddisk_bd_ops = {
126 .open = ddisk_bd_open,
127 .close = ddisk_bd_close,
128 .read_blocks = ddisk_bd_read_blocks,
129 .write_blocks = ddisk_bd_write_blocks,
130 .get_block_size = ddisk_bd_get_block_size,
131 .get_num_blocks = ddisk_bd_get_num_blocks,
132};
133
134irq_pio_range_t ddisk_irq_pio_ranges[] = {
135 {
136 .base = 0,
137 .size = sizeof(ddisk_regs_t)
138 }
139};
140
141irq_cmd_t ddisk_irq_commands[] = {
142 {
143 .cmd = CMD_PIO_READ_32,
144 .addr = NULL,
145 .dstarg = 1
146 },
147 {
148 .cmd = CMD_AND,
149 .srcarg = 1,
150 .value = DDISK_STAT_IRQ_PENDING,
151 .dstarg = 2
152 },
153 {
154 .cmd = CMD_PREDICATE,
155 .srcarg = 2,
156 .value = 2
157 },
158 {
159 /* Deassert the DMA interrupt. */
160 .cmd = CMD_PIO_WRITE_32,
161 .value = DDISK_CMD_IRQ_DEASSERT,
162 .addr = NULL
163 },
164 {
165 .cmd = CMD_ACCEPT
166 }
167};
168
169irq_code_t ddisk_irq_code = {
170 .rangecount = 1,
171 .ranges = ddisk_irq_pio_ranges,
172 .cmdcount = sizeof(ddisk_irq_commands) / sizeof(irq_cmd_t),
173 .cmds = ddisk_irq_commands,
174};
175
176void ddisk_irq_handler(ipc_callid_t iid, ipc_call_t *icall, ddf_dev_t *dev)
177{
178 ddf_msg(LVL_DEBUG, "ddisk_irq_handler(), status=%" PRIx32,
179 (uint32_t) IPC_GET_ARG1(*icall));
180
181 ddisk_t *ddisk = (ddisk_t *) ddf_dev_data_get(dev);
182
183 fibril_mutex_lock(&ddisk->lock);
184 fibril_condvar_broadcast(&ddisk->io_cv);
185 fibril_mutex_unlock(&ddisk->lock);
186}
187
188int ddisk_bd_open(bd_srvs_t *bds, bd_srv_t *bd)
189{
190 return EOK;
191}
192
193int ddisk_bd_close(bd_srv_t *bd)
194{
195 return EOK;
196}
197
198static
199int ddisk_rw_block(ddisk_t *ddisk, bool read, aoff64_t ba, void *buf)
200{
201 fibril_mutex_lock(&ddisk->lock);
202
203 ddf_msg(LVL_DEBUG, "ddisk_rw_block(): read=%d, ba=%" PRId64 ", buf=%p",
204 read, ba, buf);
205
206 if (ba >= ddisk->blocks)
207 return ELIMIT;
208
209 while (ddisk->io_busy)
210 fibril_condvar_wait(&ddisk->io_cv, &ddisk->lock);
211
212 ddisk->io_busy = true;
213
214 if (!read)
215 memcpy(ddisk->dma_buffer, buf, DDISK_BLOCK_SIZE);
216
217 pio_write_32(&ddisk->ddisk_regs->dma_buffer,
218 ddisk->dma_buffer_phys);
219 pio_write_32(&ddisk->ddisk_regs->block, (uint32_t) ba);
220 pio_write_32(&ddisk->ddisk_regs->command,
221 read ? DDISK_CMD_READ : DDISK_CMD_WRITE);
222
223 fibril_condvar_wait(&ddisk->io_cv, &ddisk->lock);
224
225 if (read)
226 memcpy(buf, ddisk->dma_buffer, DDISK_BLOCK_SIZE);
227
228 ddisk->io_busy = false;
229 fibril_condvar_signal(&ddisk->io_cv);
230 fibril_mutex_unlock(&ddisk->lock);
231
232 return EOK;
233}
234
235static
236int ddisk_bd_rw_blocks(bd_srv_t *bd, aoff64_t ba, size_t cnt, void *buf,
237 size_t size, bool is_read)
238{
239 ddisk_t *ddisk = (ddisk_t *) bd->srvs->sarg;
240 aoff64_t i;
241 int rc;
242
243 if (size < cnt * DDISK_BLOCK_SIZE)
244 return EINVAL;
245
246 for (i = 0; i < cnt; i++) {
247 rc = ddisk_rw_block(ddisk, is_read, ba + i,
248 buf + i * DDISK_BLOCK_SIZE);
249 if (rc != EOK)
250 return rc;
251 }
252
253 return EOK;
254}
255
256int ddisk_bd_read_blocks(bd_srv_t *bd, aoff64_t ba, size_t cnt, void *buf,
257 size_t size)
258{
259 return ddisk_bd_rw_blocks(bd, ba, cnt, buf, size, true);
260}
261
262int ddisk_bd_write_blocks(bd_srv_t *bd, aoff64_t ba, size_t cnt,
263 const void *buf, size_t size)
264{
265 return ddisk_bd_rw_blocks(bd, ba, cnt, (void *) buf, size, false);
266}
267
268int ddisk_bd_get_block_size(bd_srv_t *bd, size_t *rsize)
269{
270 *rsize = DDISK_BLOCK_SIZE;
271 return EOK;
272}
273
274int ddisk_bd_get_num_blocks(bd_srv_t *bd, aoff64_t *rnb)
275{
276 ddisk_t *ddisk = (ddisk_t *) bd->srvs->sarg;
277
278 *rnb = ddisk->blocks;
279 return EOK;
280}
281
282static int ddisk_get_res(ddf_dev_t *dev, ddisk_res_t *ddisk_res)
283{
284 async_sess_t *parent_sess;
285 hw_res_list_parsed_t hw_res;
286 int rc;
287
288 parent_sess = ddf_dev_parent_sess_create(dev, EXCHANGE_SERIALIZE);
289 if (parent_sess == NULL)
290 return ENOMEM;
291
292 hw_res_list_parsed_init(&hw_res);
293 rc = hw_res_get_list_parsed(parent_sess, &hw_res, 0);
294 if (rc != EOK)
295 return rc;
296
297 if ((hw_res.mem_ranges.count != 1) || (hw_res.irqs.count != 1)) {
298 rc = EINVAL;
299 goto error;
300 }
301
302 addr_range_t *regs = &hw_res.mem_ranges.ranges[0];
303 ddisk_res->base = RNGABS(*regs);
304 ddisk_res->irq = hw_res.irqs.irqs[0];
305
306 if (RNGSZ(*regs) < sizeof(ddisk_regs_t)) {
307 rc = EINVAL;
308 goto error;
309 }
310
311 rc = EOK;
312error:
313 hw_res_list_parsed_clean(&hw_res);
314 return rc;
315}
316
317static int ddisk_fun_create(ddisk_t *ddisk)
318{
319 int rc;
320 ddf_fun_t *fun = NULL;
321
322 fun = ddf_fun_create(ddisk->dev, fun_exposed, DDISK_FUN_NAME);
323 if (fun == NULL) {
324 ddf_msg(LVL_ERROR, "Failed creating DDF function.");
325 rc = ENOMEM;
326 goto error;
327 }
328
329 /* Set up a connection handler. */
330 ddf_fun_set_conn_handler(fun, ddisk_bd_connection);
331
332 rc = ddf_fun_bind(fun);
333 if (rc != EOK) {
334 ddf_msg(LVL_ERROR, "Failed binding DDF function %s: %s",
335 DDISK_FUN_NAME, str_error(rc));
336 goto error;
337 }
338
339 ddf_fun_add_to_category(fun, "bd");
340 ddisk->fun = fun;
341
342 return EOK;
343error:
344 if (fun != NULL)
345 ddf_fun_destroy(fun);
346
347 return rc;
348}
349
350static int ddisk_fun_remove(ddisk_t *ddisk)
351{
352 int rc;
353
354 if (ddisk->fun == NULL)
355 return EOK;
356
357 ddf_msg(LVL_DEBUG, "ddisk_fun_remove(%p, '%s')", ddisk,
358 DDISK_FUN_NAME);
359 rc = ddf_fun_offline(ddisk->fun);
360 if (rc != EOK) {
361 ddf_msg(LVL_ERROR, "Error offlining function '%s'.",
362 DDISK_FUN_NAME);
363 goto error;
364 }
365
366 rc = ddf_fun_unbind(ddisk->fun);
367 if (rc != EOK) {
368 ddf_msg(LVL_ERROR, "Failed unbinding function '%s'.",
369 DDISK_FUN_NAME);
370 goto error;
371 }
372
373 ddf_fun_destroy(ddisk->fun);
374 ddisk->fun = NULL;
375 rc = EOK;
376
377error:
378 return rc;
379}
380
381static int ddisk_fun_unbind(ddisk_t *ddisk)
382{
383 int rc;
384
385 if (ddisk->fun == NULL)
386 return EOK;
387
388 ddf_msg(LVL_DEBUG, "ddisk_fun_unbind(%p, '%s')", ddisk,
389 DDISK_FUN_NAME);
390 rc = ddf_fun_unbind(ddisk->fun);
391 if (rc != EOK) {
392 ddf_msg(LVL_ERROR, "Failed unbinding function '%s'.",
393 DDISK_FUN_NAME);
394 goto error;
395 }
396
397 ddf_fun_destroy(ddisk->fun);
398 ddisk->fun = NULL;
399 rc = EOK;
400
401error:
402 return rc;
403}
404
405/** Add new device
406 *
407 * @param dev New device
408 * @return EOK on success or negative error code.
409 */
410static int ddisk_dev_add(ddf_dev_t *dev)
411{
412 ddisk_t *ddisk;
413 ddisk_res_t res;
414 int rc;
415
416 /*
417 * Get our resources.
418 */
419 rc = ddisk_get_res(dev, &res);
420 if (rc != EOK) {
421 ddf_msg(LVL_ERROR, "Invalid HW resource configuration.");
422 return EINVAL;
423 }
424
425 /*
426 * Allocate soft state.
427 */
428 ddisk = ddf_dev_data_alloc(dev, sizeof(ddisk_t));
429 if (!ddisk) {
430 ddf_msg(LVL_ERROR, "Failed allocating soft state.");
431 rc = ENOMEM;
432 goto error;
433 }
434
435 /*
436 * Initialize soft state.
437 */
438 fibril_mutex_initialize(&ddisk->lock);
439 ddisk->dev = dev;
440 ddisk->ddisk_res = res;
441
442 fibril_condvar_initialize(&ddisk->io_cv);
443 ddisk->io_busy = false;
444
445 bd_srvs_init(&ddisk->bds);
446 ddisk->bds.ops = &ddisk_bd_ops;
447 ddisk->bds.sarg = ddisk;
448
449 /*
450 * Enable access to ddisk's PIO registers.
451 */
452 void *vaddr;
453 rc = pio_enable((void *) res.base, sizeof(ddisk_regs_t), &vaddr);
454 if (rc != EOK) {
455 ddf_msg(LVL_ERROR, "Cannot initialize device I/O space.");
456 goto error;
457 }
458 ddisk->ddisk_regs = vaddr;
459
460 ddisk->size = (int32_t) pio_read_32(&ddisk->ddisk_regs->size);
461 ddisk->blocks = ddisk->size / DDISK_BLOCK_SIZE;
462
463 if (ddisk->size <= 0) {
464 ddf_msg(LVL_WARN, "No disk detected.");
465 rc = EIO;
466 goto error;
467 }
468
469 /*
470 * Allocate DMA buffer.
471 */
472 ddisk->dma_buffer = AS_AREA_ANY;
473 rc = dmamem_map_anonymous(DDISK_BLOCK_SIZE, DMAMEM_4GiB,
474 AS_AREA_READ | AS_AREA_WRITE, 0, &ddisk->dma_buffer_phys,
475 &ddisk->dma_buffer);
476 if (rc != EOK) {
477 ddf_msg(LVL_ERROR, "Cannot allocate DMA memory.");
478 goto error;
479 }
480
481 ddf_msg(LVL_NOTE, "Allocated DMA buffer at %p virtual and %p physical.",
482 ddisk->dma_buffer, (void *) ddisk->dma_buffer_phys);
483
484 /*
485 * Create an exposed function.
486 */
487 rc = ddisk_fun_create(ddisk);
488 if (rc != EOK) {
489 ddf_msg(LVL_ERROR, "Failed initializing ddisk controller.");
490 rc = EIO;
491 goto error;
492 }
493
494 /*
495 * Register IRQ handler.
496 */
497 ddisk_regs_t *res_phys = (ddisk_regs_t *) res.base;
498 ddisk_irq_pio_ranges[0].base = res.base;
499 ddisk_irq_commands[0].addr = (void *) &res_phys->status;
500 ddisk_irq_commands[3].addr = (void *) &res_phys->command;
501 rc = register_interrupt_handler(dev, ddisk->ddisk_res.irq,
502 ddisk_irq_handler, &ddisk_irq_code);
503 if (rc != EOK) {
504 ddf_msg(LVL_ERROR, "Failed to register interrupt handler.");
505 goto error;
506 }
507
508 /*
509 * Success, report what we have found.
510 */
511 ddf_msg(LVL_NOTE,
512 "Device at %p with %zd blocks (%zuB) using interrupt %d",
513 (void *) ddisk->ddisk_res.base, ddisk->blocks,
514 ddisk->size, ddisk->ddisk_res.irq);
515
516 return EOK;
517
518error:
519 if (ddisk->ddisk_regs)
520 pio_disable(ddisk->ddisk_regs, sizeof(ddisk_regs_t));
521 if (ddisk->dma_buffer)
522 dmamem_unmap_anonymous(ddisk->dma_buffer);
523
524 return rc;
525}
526
527
528static int ddisk_dev_remove_common(ddisk_t *ddisk, bool surprise)
529{
530 int rc;
531
532 if (!surprise)
533 rc = ddisk_fun_remove(ddisk);
534 else
535 rc = ddisk_fun_unbind(ddisk);
536
537 if (rc != EOK) {
538 ddf_msg(LVL_ERROR, "Unable to cleanup function '%s'.",
539 DDISK_FUN_NAME);
540 return rc;
541 }
542
543 unregister_interrupt_handler(ddisk->dev, ddisk->ddisk_res.irq);
544
545 rc = pio_disable(ddisk->ddisk_regs, sizeof(ddisk_regs_t));
546 if (rc != EOK) {
547 ddf_msg(LVL_ERROR, "Unable to disable PIO.");
548 return rc;
549 }
550
551 dmamem_unmap_anonymous(ddisk->dma_buffer);
552
553 return EOK;
554}
555
556static int ddisk_dev_remove(ddf_dev_t *dev)
557{
558 ddisk_t *ddisk = (ddisk_t *) ddf_dev_data_get(dev);
559
560 ddf_msg(LVL_DEBUG, "ddisk_dev_remove(%p)", dev);
561 return ddisk_dev_remove_common(ddisk, false);
562}
563
564static int ddisk_dev_gone(ddf_dev_t *dev)
565{
566 ddisk_t *ddisk = (ddisk_t *) ddf_dev_data_get(dev);
567
568 ddf_msg(LVL_DEBUG, "ddisk_dev_gone(%p)", dev);
569 return ddisk_dev_remove_common(ddisk, true);
570}
571
572static int ddisk_fun_online(ddf_fun_t *fun)
573{
574 ddf_msg(LVL_DEBUG, "ddisk_fun_online()");
575 return ddf_fun_online(fun);
576}
577
578static int ddisk_fun_offline(ddf_fun_t *fun)
579{
580 ddf_msg(LVL_DEBUG, "ddisk_fun_offline()");
581 return ddf_fun_offline(fun);
582}
583
584/** Block device connection handler */
585static void ddisk_bd_connection(ipc_callid_t iid, ipc_call_t *icall, void *arg)
586{
587 ddisk_t *ddisk;
588 ddf_fun_t *fun = (ddf_fun_t *) arg;
589
590 ddisk = (ddisk_t *) ddf_dev_data_get(ddf_fun_get_dev(fun));
591 bd_conn(iid, icall, &ddisk->bds);
592}
593
594int main(int argc, char *argv[])
595{
596 printf(NAME ": HelenOS MSIM ddisk device driver\n");
597 ddf_log_init(NAME);
598 return ddf_driver_main(&ddisk_driver);
599}
Note: See TracBrowser for help on using the repository browser.