Modules/Interfaces/EDI/edi/edi_dma_streams.h

   1 #ifndef EDI_DMA_STREAMS_H
   2
   3 /* Copyright (c)  2006  Eli Gottlieb.
   4  * Permission is granted to copy, distribute and/or modify this document
   5  * under the terms of the GNU Free Documentation License, Version 1.2
   6  * or any later version published by the Free Software Foundation;
   7  * with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
   8  * Texts.  A copy of the license is included in the file entitled "COPYING". */
   9
  10 #define EDI_DMA_STREAMS_H
  11
  12 /*! \file edi_dma_streams.h
  13  * \brief EDI's stream subclass for handling Direct Memory Access hardware.
  14  *
  15  * Data structures and algorithms this header represents:
  16  *
  17  *      DATA STRUCTURE: DMA STREAMS - DMA streams are objects of the class EDI-STREAM-DMA used to pass data between a buffer of
  18  * memory and the computer's DMA hardware.  It is the responsibility of the object to allocate memory for its stream memory buffer
  19  * which can be used with DMA hardware and to program the DMA hardware for transmissions.  DMA streams can be bidirectional if the
  20  * correct DMA mode is used. */
  21
  22 #include "edi_objects.h"
  23
  24 #define DMA_STREAM_CLASS        "EDI-STREAM-DMA"
  25
  26 /*! \brief The name of the EDI DMA stream class.
  27  *
  28  * An edi_string_t with the class name "EDI-STREAM-DMA" in it. */
  29 #if defined(EDI_MAIN_FILE) || defined(IMPLEMENTING_EDI)
  30 const edi_string_t dma_stream_class = DMA_STREAM_CLASS;
  31 #else
  32 extern const edi_string_t dma_stream_class;
  33 #endif
  34
  35 #ifndef IMPLEMENTING_EDI
  36 /*! \brief int32_t EDI-STREAM-DMA.init_dma_stream(unsigned int32_t channel,unsigned int32_t mode,unsigned int32_t buffer_pages);
  37  *
  38  * Pointer to the init_dma_stream() method of class EDI-STREAM-DMA, which initializes a DMA stream with a DMA channel, DMA mode, and
  39  * the number of DMA-accessible memory pages to keep as a buffer.  It will only work once per stream object.  It's possible return
  40  * values are 1 for sucess, -1 for invalid DMA channel, -2 for invalid DMA mode, -3 for inability to allocate enough buffer pages and
  41  * 0 for all other errors. */
  42 EDI_DEFVAR  int32_t (*init_dma_stream)(object_pointer stream, uint32_t channel, uint32_t mode, uint32_t buffer_pages);
  43 /*! \brief int32_t EDI-STREAM-DMA.transmit(data_pointer *anchor,unsigned int32 num_bytes,bool sending);
  44  *
  45  * Pointer to the dma_stream_transmit() method of class EDI-STREAM-DMA, which transmits the given number of bytes of data through
  46  * the DMA stream to/from the given anchor (either source or destination), in the given direction.  It returns 1 on success, -1 on
  47  * an uninitialized or invalid DMA stream object, -2 when the anchor was NULL or otherwise invalid, -3 if the DMA stream can't
  48  * transmit in the given direction, and 0 for all other errors. */
  49 EDI_DEFVAR int32_t (*dma_stream_transmit)(object_pointer stream, data_pointer anchor, uint32_t num_bytes, bool sending);
  50 #endif
  51
  52 #endif