NEORV32 - Software Framework Documentation
Loading...
Searching...
No Matches
neorv32_sdi.h
Go to the documentation of this file.
1// #################################################################################################
2// # << NEORV32: neorv32_sdi.h - Serial Data Interface Controller (SDI) HW Driver >> #
3// # ********************************************************************************************* #
4// # BSD 3-Clause License #
5// # #
6// # Copyright (c) 2023, 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_sdi_h
44#define neorv32_sdi_h
45
46/**********************************************************************/
51typedef volatile struct __attribute__((packed,aligned(4))) {
52 uint32_t CTRL;
53 uint32_t DATA;
55
57#define NEORV32_SDI ((neorv32_sdi_t*) (NEORV32_SDI_BASE))
58
81/**********************************************************************/
85int neorv32_sdi_available(void);
86void neorv32_sdi_setup(uint32_t irq_mask);
87void neorv32_sdi_rx_clear(void);
88void neorv32_sdi_disable(void);
89void neorv32_sdi_enable(void);
91int neorv32_sdi_put(uint8_t data);
92void neorv32_sdi_put_nonblocking(uint8_t data);
93int neorv32_sdi_get(uint8_t* data);
94uint8_t neorv32_sdi_get_nonblocking(void);
98#endif // neorv32_sdi_h
uint8_t neorv32_sdi_get_nonblocking(void)
Definition neorv32_sdi.c:172
void neorv32_sdi_put_nonblocking(uint8_t data)
Definition neorv32_sdi.c:143
void neorv32_sdi_setup(uint32_t irq_mask)
Definition neorv32_sdi.c:69
int neorv32_sdi_get(uint8_t *data)
Definition neorv32_sdi.c:155
int neorv32_sdi_available(void)
Definition neorv32_sdi.c:52
void neorv32_sdi_enable(void)
Definition neorv32_sdi.c:102
void neorv32_sdi_rx_clear(void)
Definition neorv32_sdi.c:84
int neorv32_sdi_get_fifo_depth(void)
Definition neorv32_sdi.c:113
void neorv32_sdi_disable(void)
Definition neorv32_sdi.c:93
NEORV32_SDI_CTRL_enum
Definition neorv32_sdi.h:60
@ SDI_CTRL_IRQ_RX_FULL
Definition neorv32_sdi.h:69
@ SDI_CTRL_IRQ_RX_AVAIL
Definition neorv32_sdi.h:67
@ SDI_CTRL_RX_FULL
Definition neorv32_sdi.h:74
@ SDI_CTRL_IRQ_TX_EMPTY
Definition neorv32_sdi.h:70
@ SDI_CTRL_CLR_RX
Definition neorv32_sdi.h:62
@ SDI_CTRL_FIFO_LSB
Definition neorv32_sdi.h:64
@ SDI_CTRL_TX_EMPTY
Definition neorv32_sdi.h:75
@ SDI_CTRL_FIFO_MSB
Definition neorv32_sdi.h:65
@ SDI_CTRL_RX_HALF
Definition neorv32_sdi.h:73
@ SDI_CTRL_TX_FULL
Definition neorv32_sdi.h:76
@ SDI_CTRL_RX_AVAIL
Definition neorv32_sdi.h:72
@ SDI_CTRL_IRQ_RX_HALF
Definition neorv32_sdi.h:68
@ SDI_CTRL_EN
Definition neorv32_sdi.h:61
int neorv32_sdi_put(uint8_t data)
Definition neorv32_sdi.c:126
Definition neorv32_sdi.h:51
uint32_t DATA
Definition neorv32_sdi.h:53
uint32_t CTRL
Definition neorv32_sdi.h:52