Contiki-Inga 3.x
spi-arch.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, University of Michigan.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the University nor the names of its contributors
14  * may be used to endorse or promote products derived from this software
15  * without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 /**
30  * \addtogroup cc2538
31  * @{
32  *
33  * Implementation of the low-level SPI primitives such as waiting for the TX
34  * FIFO to be ready, inserting into the TX FIFO, etc.
35  * @{
36  */
37 /**
38  * \file
39  * Header file for the cc2538 SPI commands
40  */
41 #ifndef SPI_ARCH_H_
42 #define SPI_ARCH_H_
43 
44 #include "contiki.h"
45 #include "dev/ssi.h"
46 
47 #define SPI_WAITFORTxREADY() do { \
48  while(!(REG(SSI0_BASE + SSI_SR) & SSI_SR_TNF)); \
49 } while (0)
50 
51 #define SPI_TXBUF REG(SSI0_BASE + SSI_DR)
52 #define SPI_RXBUF REG(SSI0_BASE + SSI_DR)
53 
54 #define SPI_WAITFOREOTx() do { \
55  while(REG(SSI0_BASE + SSI_SR) & SSI_SR_BSY); \
56 } while (0)
57 #define SPI_WAITFOREORx() do { \
58  while(!(REG(SSI0_BASE + SSI_SR) & SSI_SR_RNE)); \
59 } while (0)
60 /*---------------------------------------------------------------------------*/
61 /** \name Arch-specific SPI functions
62  * @{
63  */
64 
65 /** \brief Enables the SPI peripheral
66  */
67 void spi_enable(void);
68 
69 /** \brief Disables the SPI peripheral
70  * \note Call this function to save power when the SPI is unused.
71  */
72 void spi_disable(void);
73 
74 /** @} */
75 
76 #endif /* SPI_ARCH_H_ */
77 
78 /**
79  * @}
80  * @}
81  */