Import SPI with DMA driver.
[bertos.git] / bertos / cpu / arm / drv / spi_dma_at91.h
diff --git a/bertos/cpu/arm/drv/spi_dma_at91.h b/bertos/cpu/arm/drv/spi_dma_at91.h
new file mode 100644 (file)
index 0000000..6ceef4a
--- /dev/null
@@ -0,0 +1,73 @@
+/**
+ * \file
+ * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
+ *
+ * -->
+ *
+ * \brief SPI driver with DMA.
+ *
+ * \note Only one copy of SpiDmaAt91 is allowed for each application.
+ *
+ * \version $Id$
+ * \author Francesco Sacchi <batt@develer.com>
+ * \author Luca Ottaviano <lottaviano@develer.com>
+ */
+
+#ifndef DRV_SPI_DMA_AT91_H
+#define DRV_SPI_DMA_AT91_H
+
+#include <kern/kfile.h>
+
+typedef struct SpiDmaAt91
+{
+       KFile fd;
+} SpiDmaAt91;
+
+#define KFT_SPIDMAAT91 MAKE_ID('S', 'P', 'I', 'A')
+
+INLINE SpiDmaAt91 * SPIDMAAT91_CAST(KFile *fd)
+{
+  ASSERT(fd->_type == KFT_SPIDMAAT91);
+  return (SpiDmaAt91 *)fd;
+}
+
+/**
+ * Init DMA SPI driver.
+ * \param spi A pointer to a SpiDmaAt91 structure.
+ */
+void spi_dma_init(SpiDmaAt91 *spi);
+
+/**
+ * Set the clock rate for SPI bus.
+ *
+ * \param rate The rate you want to set for SPI.
+ */
+void spi_dma_setclock(uint32_t rate);
+
+#endif /* DRV_SPI_DMA_AT91_H */