Doc fixes.
[bertos.git] / drv / spi_bitbang.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 2003, 2004, 2006 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000 Bernardo Innocenti <bernie@codewiz.org>
31  *
32  * -->
33  *
34  * \brief Emulated SPI Master for DSP firmware download (interface)
35  *
36  * \version $Id: spi.h 15321 2007-03-21 14:45:12Z asterix $
37  *
38  * \author Francesco Sacchi <batt@develer.com>
39  * \author Daniele Basile <asterix@develer.com>
40  */
41
42
43 #ifndef DRV_SPI_EMU_H
44 #define DRV_SPI_EMU_H
45
46 #include <cfg/compiler.h>
47 #include <appconfig.h>
48
49 /**
50  * Define send and receive order bit.
51  * \{
52  */
53 #define SPI_LSB_FIRST 1
54 #define SPI_MSB_FIRST 2
55 /* \} */
56
57 #if CONFIG_SPI_DATAORDER == SPI_LSB_FIRST
58         #define  SPI_DATAORDER_START    1
59         #define  SPI_DATAORDER_SHIFT(i) ((i) <<= 1)
60 #elif CONFIG_SPI_DATAORDER == SPI_MSB_FIRST
61         #define  SPI_DATAORDER_START    0x80
62         #define  SPI_DATAORDER_SHIFT(i) ((i) >>= 1)
63 #endif
64
65 void spi_write(const void *buf, size_t len);
66 void spi_read(void *buf, size_t len);
67 uint8_t spi_sendRecv(uint8_t c);
68 void spi_init(void);
69 void spi_assertSS(void);
70 void spi_deassertSS(void);
71
72 #endif /* DRV_SPI_EMU_H */