programs/include/cdi/dma.h

   1 /*
   2  * Copyright (c) 2007 Antoine Kaufmann
   3  *
   4  * This program is free software. It comes without any warranty, to
   5  * the extent permitted by applicable law. You can redistribute it
   6  * and/or modify it under the terms of the Do What The Fuck You Want
   7  * To Public License, Version 2, as published by Sam Hocevar. See
   8  * http://sam.zoy.org/projects/COPYING.WTFPL for more details.
   9  */
  10
  11 #ifndef CDI_DMA_H_INCLUDED
  12 #define CDI_DMA_H_INCLUDED
  13
  14 #include <stdint.h>
  15 #include <stdio.h>
  16 #include <cdi.h>
  17
  18 struct cdi_dma_handle
  19 {
  20         uint8_t channel;
  21         size_t length;
  22         uint8_t mode;
  23         void *buffer;
  24
  25         // IncOS-specific
  26         int file;
  27 };
  28
  29 // Geraet => Speicher
  30 #define CDI_DMA_MODE_READ           (1 << 2)
  31 // Speicher => Geraet
  32 #define CDI_DMA_MODE_WRITE          (2 << 2)
  33 #define CDI_DMA_MODE_ON_DEMAND      (0 << 6)
  34 #define CDI_DMA_MODE_SINGLE         (1 << 6)
  35 #define CDI_DMA_MODE_BLOCK          (2 << 6)
  36
  37
  38 /**
  39  * Initialisiert einen Transport per DMA
  40  *
  41  * @return 0 bei Erfolg, -1 im Fehlerfall
  42  */
  43 int cdi_dma_open(struct cdi_dma_handle* handle, uint8_t channel, uint8_t mode,
  44     size_t length, void* buffer);
  45
  46 /**
  47  * Liest Daten per DMA ein
  48  *
  49  * @return 0 bei Erfolg, -1 im Fehlerfall
  50  */
  51 int cdi_dma_read(struct cdi_dma_handle* handle);
  52
  53 /**
  54  * Schreibt Daten per DMA
  55  *
  56  * @return 0 bei Erfolg, -1 im Fehlerfall
  57  */
  58 int cdi_dma_write(struct cdi_dma_handle* handle);
  59
  60 /**
  61  * Schliesst das DMA-Handle wieder
  62  *
  63  * @return 0 bei Erfolg, -1 im Fehlerfall
  64  */
  65 int cdi_dma_close(struct cdi_dma_handle* handle);
  66
  67 #endif
  68