RTEMS: bsps/arm/atsam/include/libchip/include/spi.h Source File

| RTEMS 5.4-rc2

Loading...
Searching...
No Matches
spi.h
Go to the documentation of this file.
1/* ---------------------------------------------------------------------------- */
2/* Atmel Microcontroller Software Support */
3/* SAM Software Package License */
4/* ---------------------------------------------------------------------------- */
5/* Copyright (c) 2015, Atmel Corporation */
6/* */
7/* All rights reserved. */
8/* */
9/* Redistribution and use in source and binary forms, with or without */
10/* modification, are permitted provided that the following condition is met: */
11/* */
12/* - Redistributions of source code must retain the above copyright notice, */
13/* this list of conditions and the disclaimer below. */
14/* */
15/* Atmel's name may not be used to endorse or promote products derived from */
16/* this software without specific prior written permission. */
17/* */
18/* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */
19/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
20/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */
21/* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */
22/* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
23/* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */
24/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
25/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
26/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
27/* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
28/* ---------------------------------------------------------------------------- */
29
37#ifndef _SPI_
38#define _SPI_
39
40/*----------------------------------------------------------------------------
41 * Headers
42 *----------------------------------------------------------------------------*/
43
44#include "chip.h"
45
46/*----------------------------------------------------------------------------
47 * Macros
48 *----------------------------------------------------------------------------*/
49
63#define SPI_PCS(npcs) SPI_MR_PCS((~(1 << npcs) & 0xF))
64
66#define SPI_SCBR(baudrate, masterClock) \
67 SPI_CSR_SCBR((uint32_t)(masterClock / baudrate))
68
70#define SPI_DLYBS(delay, masterClock) \
71 SPI_CSR_DLYBS((uint32_t) (((masterClock / 1000000) * delay) / 1000)+1)
72
74#define SPI_DLYBCT(delay, masterClock) \
75 SPI_CSR_DLYBCT ((uint32_t) (((masterClock / 1000000) * delay) / 32000)+1)
76
77/*------------------------------------------------------------------------------ */
78
79#ifdef __cplusplus
80extern "C" {
81#endif
82
83/*----------------------------------------------------------------------------
84 * Exported functions
85 *----------------------------------------------------------------------------*/
86
87extern void SPI_Enable(Spi *spi);
88extern void SPI_Disable(Spi *spi);
89
90extern void SPI_EnableIt(Spi *spi, uint32_t dwSources);
91extern void SPI_DisableIt(Spi *spi, uint32_t dwSources);
92
93extern void SPI_Configure(Spi *spi, uint32_t dwId, uint32_t dwConfiguration);
94extern void SPI_SetMode(Spi *spi, uint32_t dwConfiguration);
95
96extern void SPI_ChipSelect(Spi *spi, uint8_t cS);
97extern void SPI_ReleaseCS(Spi *spi);
98
99extern void SPI_ConfigureNPCS(Spi *spi, uint32_t dwNpcs,
100 uint32_t dwConfiguration);
101extern void SPI_ConfigureCSMode(Spi *spi, uint32_t dwNpcs,
102 uint32_t bReleaseOnLast);
103
104extern uint32_t SPI_Read(Spi *spi);
105extern void SPI_Write(Spi *spi, uint32_t dwNpcs, uint16_t wData);
106extern void SPI_WriteLast(Spi *spi, uint32_t dwNpcs, uint16_t wData);
107
108extern uint32_t SPI_GetStatus(Spi *spi);
109extern uint32_t SPI_IsFinished(Spi *pSpi);
110
111#ifdef __cplusplus
112}
113#endif
114
115#endif /* #ifndef _SPI_ */
116
SPI_Configure
void SPI_Configure(Spi *spi, uint32_t dwId, uint32_t dwConfiguration)
Configures a SPI peripheral as specified. The configuration can be computed using several macros (see...
Definition: spi.c:128
SPI_Read
uint32_t SPI_Read(Spi *spi)
Reads and returns the last word of data received by a SPI peripheral. This method must be called afte...
Definition: spi.c:225
SPI_ConfigureNPCS
void SPI_ConfigureNPCS(Spi *spi, uint32_t dwNpcs, uint32_t dwConfiguration)
Configures a chip select of a SPI peripheral. The chip select configuration is computed using several...
Definition: spi.c:184
SPI_ChipSelect
void SPI_ChipSelect(Spi *spi, uint8_t cS)
Configures SPI chip select.
Definition: spi.c:146
SPI_Write
void SPI_Write(Spi *spi, uint32_t dwNpcs, uint16_t wData)
Sends data through a SPI peripheral. If the SPI is configured to use a fixed peripheral select,...
Definition: spi.c:241
SPI_IsFinished
uint32_t SPI_IsFinished(Spi *pSpi)
Check if SPI transfer finish.
Definition: spi.c:278
SPI_EnableIt
void SPI_EnableIt(Spi *spi, uint32_t dwSources)
Enables one or more interrupt sources of a SPI peripheral.
Definition: spi.c:104
SPI_GetStatus
uint32_t SPI_GetStatus(Spi *spi)
Get the current status register of the given SPI peripheral.
Definition: spi.c:212
SPI_WriteLast
void SPI_WriteLast(Spi *spi, uint32_t dwNpcs, uint16_t wData)
Sends last data through a SPI peripheral. If the SPI is configured to use a fixed peripheral select,...
Definition: spi.c:260
SPI_Disable
void SPI_Disable(Spi *spi)
Disables a SPI peripheral.
Definition: spi.c:93
SPI_ConfigureCSMode
void SPI_ConfigureCSMode(Spi *spi, uint32_t dwNpcs, uint32_t bReleaseOnLast)
Configures a chip select active mode of a SPI peripheral.
Definition: spi.c:197
SPI_SetMode
void SPI_SetMode(Spi *spi, uint32_t dwConfiguration)
Configures SPI Mode Register.
Definition: spi.c:158
SPI_Enable
void SPI_Enable(Spi *spi)
Enables a SPI peripheral.
Definition: spi.c:83
SPI_DisableIt
void SPI_DisableIt(Spi *spi, uint32_t dwSources)
Disables one or more interrupt sources of a SPI peripheral.
Definition: spi.c:115
SPI_ReleaseCS
void SPI_ReleaseCS(Spi *spi)
Configures SPI to release last used CS line.
Definition: spi.c:169
Spi
Spi hardware registers.
Definition: component_spi.h:41