bertos/cpu/arm/drv/spi_dma_at91.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief SPI driver with DMA.
  34  *
  35  * \note Only one copy of SpiDmaAt91 is allowed for each application.
  36  *
  37  * \version $Id$
  38  * \author Francesco Sacchi <batt@develer.com>
  39  * \author Luca Ottaviano <lottaviano@develer.com>
  40  */
  41
  42 #ifndef DRV_SPI_DMA_AT91_H
  43 #define DRV_SPI_DMA_AT91_H
  44
  45 #include <io/kfile.h>
  46
  47 typedef struct SpiDmaAt91
  48 {
  49         KFile fd;
  50 } SpiDmaAt91;
  51
  52 #define KFT_SPIDMAAT91 MAKE_ID('S', 'P', 'I', 'A')
  53
  54 INLINE SpiDmaAt91 * SPIDMAAT91_CAST(KFile *fd)
  55 {
  56   ASSERT(fd->_type == KFT_SPIDMAAT91);
  57   return (SpiDmaAt91 *)fd;
  58 }
  59
  60 /**
  61  * Init DMA SPI driver.
  62  * \param spi A pointer to a SpiDmaAt91 structure.
  63  */
  64 void spi_dma_init(SpiDmaAt91 *spi);
  65
  66 /**
  67  * Set the clock rate for SPI bus.
  68  *
  69  * \param rate The rate you want to set for SPI.
  70  */
  71 void spi_dma_setclock(uint32_t rate);
  72
  73 #endif /* DRV_SPI_DMA_AT91_H */