NEORV32 - Software Framework Documentation
neorv32_spi.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_spi.h - Serial Peripheral Interface Controller (SPI) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2022, Stephan Nolting. All rights reserved. #
7// # #
8// # Redistribution and use in source and binary forms, with or without modification, are #
9// # permitted provided that the following conditions are met: #
10// # #
11// # 1. Redistributions of source code must retain the above copyright notice, this list of #
12// # conditions and the following disclaimer. #
13// # #
14// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of #
15// # conditions and the following disclaimer in the documentation and/or other materials #
16// # provided with the distribution. #
17// # #
18// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to #
19// # endorse or promote products derived from this software without specific prior written #
20// # permission. #
21// # #
22// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS #
23// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF #
24// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE #
25// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, #
26// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED #
28// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING #
29// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED #
30// # OF THE POSSIBILITY OF SUCH DAMAGE. #
31// # ********************************************************************************************* #
32// # The NEORV32 Processor - https://github.com/stnolting/neorv32 (c) Stephan Nolting #
33// #################################################################################################
34
35
36/**********************************************************************/
43#ifndef neorv32_spi_h
44#define neorv32_spi_h
45
46// prototypes
47int neorv32_spi_available(void);
48void neorv32_spi_setup(uint8_t prsc, uint8_t clk_phase, uint8_t clk_polarity, uint8_t data_size);
49void neorv32_spi_disable(void);
50void neorv32_spi_enable(void);
53void neorv32_spi_cs_en(uint8_t cs);
54void neorv32_spi_cs_dis(uint8_t cs);
55uint32_t neorv32_spi_trans(uint32_t tx_data);
56void neorv32_spi_put_nonblocking(uint32_t tx_data);
57uint32_t neorv32_spi_get_nonblocking(void);
58int neorv32_spi_busy(void);
59
60#endif // neorv32_spi_h
void neorv32_spi_cs_dis(uint8_t cs)
Definition: neorv32_spi.c:156
int neorv32_spi_busy(void)
Definition: neorv32_spi.c:208
uint32_t neorv32_spi_get_nonblocking(void)
Definition: neorv32_spi.c:197
void neorv32_spi_highspeed_disable(void)
Definition: neorv32_spi.c:128
int neorv32_spi_available(void)
Definition: neorv32_spi.c:52
void neorv32_spi_disable(void)
Definition: neorv32_spi.c:97
void neorv32_spi_setup(uint8_t prsc, uint8_t clk_phase, uint8_t clk_polarity, uint8_t data_size)
Definition: neorv32_spi.c:71
void neorv32_spi_enable(void)
Definition: neorv32_spi.c:106
uint32_t neorv32_spi_trans(uint32_t tx_data)
Definition: neorv32_spi.c:172
void neorv32_spi_cs_en(uint8_t cs)
Definition: neorv32_spi.c:141
void neorv32_spi_highspeed_enable(void)
Definition: neorv32_spi.c:117
void neorv32_spi_put_nonblocking(uint32_t tx_data)
Definition: neorv32_spi.c:186